XML query HTTP handler

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:

• termHiTagOpen

• termHiTagClose

Linking query parameters

linkingDocAddr

The address of the document to use to create a “Find Similar” query.

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 “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:

<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.

• 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.

metadataOpAcrossFields

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, that a document must achieve to be included in 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 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). Adjusting this value 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.

documentStoreAddrs

A comma-delimited list of document store addresses, which are of the form <DSM-ID>-<DS-ID>, where DSM-ID is the document store manager ID and DS-ID is the document store ID. The document store address enables you to specify the document store (or stores) for search query.

localStats

When set to true, the query performed in each document store only uses calculation data obtained from that document store. Cached global statistics are ignored, which changes the relevancy scores of the query results.If you use localStats with documentStoreAddrs, the query runs as an isolated query only on the stores specified in documentStoreAddrs.