Skip to end of metadata
Go to start of metadata

The document repository stores all annotated documents that can be retrieved later, with methods such as loadDocument and getDocuments. All methods available from the Java API are implemented as web service methods:

Web service method Description
getConstants allows access to predefined KIM named constants, required as parameters to some method calls.
addDocument allows adding a single KIM document passed as structured content. It accepts a KIMDocument class object as input and returns the document ID received after being indexed. The document should be annotated prior to storage, because it is not possible to change already stored documents. The annotation can be performed through the "execute" method of the SemanticAnnotationAPI web service.
getDocuments allows access to the structured content of multiple annotated documents, determined through structured queries. It accepts a query object of class DocumentQuery as input and returns data as a result set of class DocumentQueryResult.
getDocumentIds is a reduced version of the method getDocuments, which delivers only the IDs of the matching documents. It accepts a query object of class DocumentQuery as input and returns the result set as a structure of class DocumentQueryResult, in which only the DocumentId property of class DocumentQueryResultRow is filled in.
The typical use case for this method is when you want to display a list of retrieved documents page by page. Then you can use getDocumentIds to retrieve just a list of IDs. Afterwards, you can only retrieve the content and annotations of the documents through the method loadDocument, as needed.
loadDocument allows access to the structured content of a single annotated document. It accepts an ID as input and returns KIMDocument object as result. This identifier is the unique internal identifier of the document in the document repository.
getDocumentFeatures allows access to the features of a single document. It accepts an ID as input and returns an array of Feature objects as result. This identifier is the unique internal identifier of the document in the document repository.
getDocumentCount returns the count of documents that are compliant with a given document query. It accepts a query object of class DocumentQuery as input and returns integer count.
getEntities allows access to the list of entities found in a document set, determined by a DocumentQuery. It accepts a query object of class CoreDbQuery as input, which extends the DocumentQuery, allowing to specify additional restrictions to the entities of interest. The method returns an array of elements of class CoreDbEntity. The array contains the unique list of occurring entities.
getEntitiesCount functions exactly as the getEntities method, but returns only the unique count of the resulting entities.

Example:

Labels:
web_services_apis web_services_apis Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.