Skip to end of metadata
Go to start of metadata

Through the QueryAPI service, you can perform formalized complex queries both towards the semantic and the document repositories. The QueryAPI service combines the query functionality of the SemanticRepositoryAPI and the DocumentRepositoryAPI. Desired queries are described through SemanticQuery objects. As a result, a complex structure is returned as SemanticQueryResult object. It contains both an entity and a document part. 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 of the service.
getEntities allows retrieval of a semantic result set containing "rows" of entities. The query restrictions are described through a SemanticQuery object. The result is returned as a SemanticQueryResult object. For this method, only part of the returned object, the entity result set, is populated.
getDocuments allows retrieval of a semantic result set containing "rows" of entities. For each row there is a corresponding set of documents (DocumentQueryResult) in which the specified entities co-occur. The query restrictions are described through a SemanticQuery object. The result is returned as a SemanticQueryResult object. For this method – both the entity result set and the document part of the returned object - are populated.
getDocumentIds allows retrieval of a semantic result set containing "rows" of entities. For each row there is a corresponding set of document identifiers in which some of the entities co-occur. This is a reduced version of getDocuments. It delivers only IDs, allowing you to later retrieve the content of the selected documents with loadDocument. The query restrictions are described through a SemanticQuery object. The result is returned as a SemanticQueryResult object. For this method – the entity result set part is populated and the corresponding document IDs in the DocumentQueryResult parts are accessible.
Labels:
web_services_apis web_services_apis Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.