Package | Description |
---|---|
com.attivio.sdk.client |
Interfaces for client side AIE development.
|
com.attivio.sdk.client.audit |
Modifier and Type | Method and Description |
---|---|
void |
RelevancyModelApi.addFeature(RelevancyFeatureDef feature)
Add a
RelevancyFeatureDef . |
long |
RelevancyModelApi.addRelevancyModel(RelevancyModel model)
Create a new relevancy model.
|
void |
SignalTrackingApi.addSignal(Signal signal)
Add a signal
|
DictionaryInfo |
DictionaryClient.approveDictionary(DictionaryInfo info)
Approve pending changes to dictionary identified by
info . |
DictionaryInfo |
DictionaryClient.cloneDictionary(DictionaryInfo source,
DictionaryInfo dest)
Clone dictionary
source to dest . |
DictionaryInfo |
DictionaryClient.createDictionary(DictionaryInfo info)
Create dictionary
info . |
DictionaryInfo |
DictionaryClient.createDictionaryEntries(DictionaryInfo info,
String contentStoreId)
Add all entries from
contentStorId in csv format to dictionary identified by info . |
DictionaryEntry |
DictionaryClient.createDictionaryEntry(DictionaryEntry entry)
Create a dictionary entry.
|
List<IngestDocument> |
ConnectorControlApi.debugConnector(String connectorName,
int numDocs)
A method to help with debugging connectors.
|
DictionaryInfo |
DictionaryClient.deleteDictionary(DictionaryInfo info)
Delete dictionary
info . |
DictionaryEntry |
DictionaryClient.deleteDictionaryEntry(DictionaryEntry entry)
Delete a dictionary entry.
|
void |
DictionaryClient.deleteDictionaryFromContentStore(String contentStoreId)
Deprecated.
|
void |
RelevancyModelApi.deleteFeature(String name)
Delete a
RelevancyFeatureDef with the specified name. |
void |
RelevancyModelApi.deleteRelevancyModel(String name,
long version)
Delete a relevancy model.
|
void |
SignalTrackingApi.deleteSignals(String signalType)
Delete all signals for
signalType . |
String |
DictionaryClient.exportDictionary(DictionaryInfo info)
Export published form of dictionary.
|
RelevancyModel |
RelevancyModelApi.findRelevancyModel(String... query)
Find a relevancy model given a query.
|
AdminQueryResult<DictionaryInfo> |
DictionaryClient.getDictionaries(AdminQuery query,
int offset,
int rows)
Get all matching dictionaries.
|
DictionaryInfo |
DictionaryClient.getDictionary(RevisionStatus view,
DictionaryType type,
String name,
String group)
Get a dictionary info based on the (type, name, group).
|
AdminQueryResult<DictionaryEntry> |
DictionaryClient.getDictionaryEntries(AdminQuery query,
int offset,
int rows)
Get dictionary entries.
|
DictionaryEntry |
DictionaryClient.getDictionaryEntry(RevisionStatus view,
String entryId)
Get a dictionary entry based on its entryId.
|
String |
DictionaryClient.getDictionaryUri(DictionaryInfo info) |
ConnectorExecutionRecord |
ConnectorControlApi.getExecutionInfo(String connectorName)
Gets execution information for the connector.
|
RelevancyFeatureDef |
RelevancyModelApi.getFeature(String name)
Get a
RelevancyFeatureDef by name . |
String |
DictionaryClient.getIndexFeature() |
Map<Long,Long> |
SignalTrackingApi.getModelHistogram(String relevancyModelName,
long relevancyModelVersion)
Get histogram data for a relevancy model
|
AdminQueryResult<DictionaryEntry> |
DictionaryClient.getPublishedEntities(String name,
String group,
String query,
int offset,
int rows)
Get a list of published entries for an entity dictionary.
|
RelevancyModel |
RelevancyModelApi.getRelevancyModel(String name,
long version)
Get a specified version of a relevancy model.
|
long |
RelevancyModelApi.getRelevancyModelPublishTime(String name,
long version)
Returns the time the specified relevancy model was published.
|
List<RelevancyModel> |
RelevancyModelApi.getRelevancyModels(String name)
Get all versions available for a relevancy model.
|
CloseableIterable<Signal> |
SignalTrackingApi.getSignals(String modelName,
Date startTime,
Date endTime,
Set<String> signalTypes)
Get all signals currently being tracked
|
List<AutoCompleteSuggestion> |
AutoCompleteApi.getSuggestions(String providerName,
QueryRequest req)
Get all suggestions from a certain
autocomplete provider given its name and
a query request |
void |
DictionaryClient.importDictionary(String contentStoreId) |
void |
SignalTrackingApi.importSignals(Iterable<Signal> signals)
Import signals to be tracked
|
boolean |
RelevancyModelApi.isFeatureStatic(String name)
Returns
true if feature is statically defined. |
void |
ConnectorControlApi.pause(String connectorName)
Pauses the named connector
|
DictionaryInfo |
DictionaryClient.publishDictionary(DictionaryInfo info)
Publish approved changes to dictionary identified by
info . |
void |
RelevancyModelApi.publishRelevancyModel(String name,
long version)
Publish a relevancy model.
|
DictionaryInfo |
DictionaryClient.refreshDictionary(DictionaryInfo info)
Refresh dictionary identified by
info . |
DictionaryInfo |
DictionaryClient.registerDictionary(DictionaryInfo info,
String contentStoreId)
Create dictionary defined by
info and import all dictionary entries at contentStoreId in csv format. |
void |
DictionaryClient.replaceDictionary(String contentStoreId)
Replace dictionary with import.
|
DictionaryInfo |
DictionaryClient.replaceDictionaryEntries(DictionaryInfo info,
String contentStoreId)
Add all entries from
contentStorId in csv format to dictionary identified by info . |
void |
ConnectorControlApi.reset(String connectorName)
Resets the incremental state of the named connector
|
void |
AutoCompleteApi.resourceModified(String uri)
Notifies all
autocomplete providers that share resources
that their resource has been modified. |
void |
ConnectorControlApi.resume(String connectorName)
Resumes the named connector if paused
|
DictionaryInfo |
DictionaryClient.revertDictionary(DictionaryInfo info,
boolean recursive)
Revert pending changes to dictionary.
|
DictionaryInfo |
DictionaryClient.revertDictionaryApproval(DictionaryInfo info,
boolean recursive)
Revert approved changes to dictionary.
|
DictionaryEntry |
DictionaryClient.revertDictionaryEntry(DictionaryEntry entry)
Revert pending changes to dictionary entry.
|
DictionaryEntry |
DictionaryClient.revertDictionaryEntryApproval(DictionaryEntry entry)
Revert approved changes to dictionary entry.
|
UUID |
ConnectorControlApi.start(String connectorName)
Starts the named connector
|
void |
ConnectorControlApi.stop(String connectorName)
Stops the connector
|
void |
ConnectorControlApi.stop(String connectorName,
long shutdownWaitTimeout)
Stops the connector
|
void |
DictionaryClient.storeDictionaryInContentStore(String contentStoreId,
byte[] bytes)
Deprecated.
|
RelevancyModel |
RelevancyModelApi.testRelevancyModel(RelevancyModel model)
Test a relevancy model's accuracy according to stored signal data's expected output.
|
long |
RelevancyModelApi.trainRelevancyModel(RelevancyModel model)
Train a relevancy model according to signal data as specified by
model |
DictionaryInfo |
DictionaryClient.updateDictionary(DictionaryInfo info)
Update dictionary
info . |
DictionaryEntry |
DictionaryClient.updateDictionaryEntry(DictionaryEntry entry)
Update a dictionary entry.
|
void |
RelevancyModelApi.updateFeature(RelevancyFeatureDef feature)
Update a
RelevancyFeatureDef . |
void |
RelevancyModelApi.updateRelevancyModel(RelevancyModel model)
Update an existing relevancy model.
|
boolean |
ConnectorControlApi.waitForCompletion(UUID clientId,
long timeout)
Wait for the connector to complete with an optional timeout.
|
Modifier and Type | Method and Description |
---|---|
long |
AuditWriterApi.audit(AuditDetail audit)
Writes the audit information to the store.
|
long |
AuditWriterApi.audit(List<AuditDetail> audit)
Writes a batch of audit information to the store.
|
void |
AuditWriterApi.clientHeartbeat(UUID clientId)
Updates the audit information to show that the client is still active so that the client will continue to be returned by
AuditReaderApi.getActiveClients() . |
void |
AuditWriterApi.clientName(UUID clientId,
String name)
Sets a name to be associated with the client.
|
CloseableIterable<AuditDetail> |
AuditReaderApi.getAll(UUID clientId,
long startSeq,
long count) |
Iterable<AuditDetail> |
AuditReaderApi.getAuditDetails(String docId,
Date start,
Date end)
Returns an
Iterable of AuditDetail s associated with the document. |
Iterable<AuditDetail> |
AuditReaderApi.getAuditDetails(String docId,
UUID clientId)
Returns an
Iterable of AuditDetail s associated with the document. |
Iterable<AuditDetail> |
AuditReaderApi.getByCorrelationId(UUID clientId,
UUID correlationId)
Get all audit details for a document via its
correlationId . |
Iterable<String> |
AuditReaderApi.getCreatedDocuments(Date start,
Date end)
Returns a list of IDs for all documents which were received by the system or created within the system during the specified
date range.
|
Iterable<String> |
AuditReaderApi.getCreatedDocuments(UUID clientId)
Returns a list of IDs for all documents which were received by the system or created within the system by the specified
clientId.
|
Iterable<String> |
AuditReaderApi.getDocuments(EnumSet<ProcessingResultCode> codeSet,
Date start,
Date end)
Returns a list of IDs for all documents for which a
resultCode in codeSet was received at some point during
content processing. |
Iterable<String> |
AuditReaderApi.getDocuments(EnumSet<ProcessingResultCode> codeSet,
UUID clientId)
Returns a list of IDs for all documents for which a
resultCode in codeSet was received at some point during
content processing. |
Iterable<AuditDetail> |
AuditReaderApi.getLostDetails(long startSeq,
long endSeq)
Returns all audit detail events that have been flagged as LOST and have a sequence id >=
startSeq and <
endSeq . |
Iterable<String> |
AuditReaderApi.getProcessedDocuments(Date start,
Date end)
Returns a list of IDs for all documents which have completed processing during the specified date range.
|
Iterable<String> |
AuditReaderApi.getProcessedDocuments(UUID clientId)
Returns a list of IDs for all documents which have completed processing which were sent by the specified client.
|
Iterable<String> |
AuditReaderApi.getSearchableDocuments(String indexName,
Date start,
Date end)
Returns an
Iterable of IDs for all documents which became searchable during the specified date range. |
Iterable<String> |
AuditReaderApi.getSearchableDocuments(String indexName,
UUID clientId)
Returns an
Iterable of IDs for all documents that are searchable and were fed by the specified client. |
AuditClientSummary |
AuditReaderApi.getSummary(UUID clientId) |
void |
AuditWriterApi.makeInactive(UUID clientId)
Marks the clientId as inactive.
|
void |
AuditWriterApi.purge(Date start,
Date end)
Purges all audit data within the time range.
|
void |
AuditWriterApi.purge(UUID clientId)
Purges all audit data associated with the client ID.
|
AuditClientSummary |
AuditReaderApi.waitForCompletion(UUID clientId)
Waits until all documents and messages created by this client have completed processing.
|
AuditClientSummary |
AuditReaderApi.waitForCompletion(UUID clientId,
long timeout)
Waits until all documents and messages created by this client have completed processing.
|
Date |
AuditReaderApi.whenSearchable(String indexName,
UUID clientId)
Returns the earliest date an index commit was received after all documents for the client were indexed.
|
Date |
AuditReaderApi.whenSearchable(String indexName,
UUID clientId,
String docId)
Returns the earliest date an index commit was received after the document was indexed.
|
Copyright © 2018 Attivio, Inc. All Rights Reserved.
PATENT NOTICE: Attivio, Inc. Software Related Patents. With respect to the Attivio software product(s) being used, the following patents apply: Querying Joined Data Within A Search Engine Index: United States Patent No.(s): 8,073,840. Ordered Processing of Groups of Messages: U.S. Patent No.(s) 8,495,656. Signal processing approach to sentiment analysis for entities in documents: U.S. Patent No.(s) 8,725,494. Other U.S. and International Patents Pending.