Options Object

Roles 🔗︎ string[]

Roles

The roles associated with the request. Defaults to "all" if none are provided.

SupressResultList 🔗︎ boolean

SupressResultList

Optional, default: false. If true then no result list is returned. Use for example when only the total result count is needed.

SupressCorrection 🔗︎ boolean

SupressCorrection

Optional, default: false. If true then spelling correction on the input query is skipped. Spelling correction always keeps the original input term and adds the corrected term.

Highlight 🔗︎ boolean

Highlight

Optional, default: false. If set to true the matching keywords will be highlighted in the search response.

SearchAfter 🔗︎ string[]

SearchAfter

Optional parameter used for pagination. Must contain exactly the searchAfter from the response of the previous page query.

ResultOffset 🔗︎ int

ResultOffset

The result item offset used for pagination. Default: 0. For example, a value of 20 will skip the top 20 results and return the subsequent results starting with result 21. ResultOffset is ignored if searchAfter is set. ResultOffset+Pagesize cannot be more than 10000.

PageSize 🔗︎ int

PageSize

Optional parameter to specify the number of result items (max 1500). Default: 20. Only use a high number in case you need a list of results for use in follow-up actions. Do not use a high number when presenting results in a user interface. Therefore, PageSize is limited to 100 when used in combination with pagination parameters (SearchAfter or ResultOffset). And when PageSize is larger than 100, facet counts and search term highlighting are not provided (FacetCounts and Highlight are implicitly set to false).

SynonymLanguages 🔗︎ string[]

SynonymLanguages

Optional list of language codes to use for keyword expansion with synonyms and related terms. Default: en (English)

Available language codes can be found here.

For best response time, keep this list as short as possible. It is recommended to ask your users to specify in which languages they want query expansions.

MergeOverlappingSynonyms 🔗︎ boolean

MergeOverlappingSynonyms

Optional, default: false. If true the content of a query part item of type TEXT or LONG_TEXT (its term plus synonyms) that overlaps more than 75% with a previous query part of the same field and condition will be moved into the synonyms of that previous one.

SynonymExpansionMode 🔗︎ string

SynonymExpansionMode

Optional setting for synonym expansion mode. Allowed values: QUERY, QUERY_AND_QUERYPARTS, QUERY_AND_SYNONYMMAP.

ResultFields 🔗︎ string[]

ResultFields

Optional customization of the fields to be included in the results. Must be a subset of the fields that you have enabled in the Tx Console.

It is not possible to request system fields such as roles or nested sub-fields.

FacetCounts 🔗︎ boolean

FacetCounts

Optional, default: false. If true the search responses will not contain facet counts. Improves query response time.

Sorting 🔗︎ object[]

Sorting

Optional sorting definition. The default sorting is by relevance to the query. Note that when you change the sorting, results will no longer be sorted by relevance.

UseNLQS 🔗︎ boolean

UseNLQS

Optional flag indicating that the backend needs to use the natural language query service (NLQS) to interpret the query string.