Chapter 5: Administration

XML query HTTP handler

This handler takes query parameters over HTTP (GET or POST) and returns a result set in XML compliant with the result set DTD, which can be found at <container-home>/config/dtd/ResultSet.dtd.

In a default installation of OmniQ Enterprise, you can find this XML handler and its DTD handler respectively, at:

http://<container-host>:<container-port>/xml/query, and
http://<container-host>:<container-port>/dtd/resultset

The XML query HTTP handler parameters are shown in Table 5-1.

**Table 5-1: XML query HTTP handler parameters**
Normal query parameters
terms	A natural language query string describing the concepts that all documents should contain.
notTerms	A natural language query string describing the concepts documents should not contain.
Linking query parameters
linkingDocAddr	The address of the document to use to create a `find-similar` query.
Linking query with external document parameters
targetDSA	The target document store address, for example, the exact document store from which OmniQ obtains its initial term statistics.
targetDSMID	The target Document Store Manager ID. The exact document store from which OmniQ obtains its initial term statistics resides here and is chosen by the system.
linkingDocPath	The full path to the external document (from the Document Store Manager’s perspective) used to create a `find-similar` query.
Common parameters
DocumentGroupIds	A comma-delimited list of document group IDs. When present, only documents that are members of these groups are returned.
metadata	A metadata search expression, that takes the form: < name><operator><value> where <name> is the internal name of the metadata field; <operator> is “=,” “>=,” or “<=” (the latter two are only supported by numeric and date types) and <values> is the criteria of the metadata search.
metadataOperatorWithinFields	Valid values are AND and OR. When this parameter is AND and two or more values are presented for any one metadata field, all must match for the query to succeed. When this parameter is OR, only one of any number of values needs to match for the query to succeed.
metadataOperatorAcrossFields	Valid values are AND and OR. When this parameter is AND and two or more metadata parameters are present, all must succeed for the query to succeed. When this parameter is OR, only one of any number of metadata parameters needs to succeed for the query to succeed.
minDocRel	The minimum relevance, expressed as a percentage, a document must achieve to be included within a result set.
numParas	The number of document excerpts to return for each document returned in the page of results.
scoreUnknownTerms	When set to true, terms present in a query yet unknown to OmniQ (for example, terms not present in any indexed document) are represented in the scoring algorithm. When set to false, unknown terms are ignored
resultsOffset	An integer value that represents the place in the result set the page of results should begin. The first document in the result-set (for example, the top scoring document) is at offset zero (0). If the offset is greater than the number of results found, OmniQ Enterprise returns an empty page of results.
resultsLength	An integer value that represents the number of documents to include in the page of results.
maxResultsNeeded	An integer value that represents the maximum number of results required by the caller (the minimum value is implicitly resultsOffset + resultsLength). This yields performance benefits when queries are cached for returning on a page-by-page basis.

View this book as PDF