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 <installLocation>/OmniQ/config/dtd/ResultSet.dtd.
In a default installation of Sybase Search, you can find this XML handler and its DTD handler respectively, at:
http://<installLocation>:<container-port>/xml/query
http://<installLocation>:<container-port>/dtd/resultset
The XML query HTTP handler parameters are shown in Table 6-1.
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. |
termHi |
A value used to indicate whether returned terms should be highlighted. The default is bold. The opening and closing tags are:
|
Linking query parameters |
|
linkingDocAddr |
The address of the document to use to
create a |
Linking query with external document parameters |
|
targetDSMID |
The target Document Store Manager ID. The chosen document store is used by Sybase Search to obtain its initial term statistics when calculating the linking query. |
linkingDocPath |
The full path to the external document
(from the Document Store Manager’s perspective) used to
create a |
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. |
metadataOpWithinFields |
Valid values are AND and OR.
|
metadataOpAcrossFields |
Valid values are AND and OR.
|
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 Sybase Search (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, Sybase Search 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. |
categoryIds |
A comma-delimited list of category IDs. When present, only documents that are members of the listed categories are returned. |