Options Object🔗︎
Roles 🔗︎ string[]
Roles🔗︎
The roles associated with the request. Defaults to "All" if none are provided.
SupressResultList 🔗︎ boolean
SupressResultList🔗︎
If true then no result list is returned. Used for example when only the cloud is needed.
SupressCorrection 🔗︎ boolean
SupressCorrection🔗︎
If true then spelling correction on the input query is skipped.
Highlight 🔗︎ boolean
Highlight🔗︎
The roles associated with the request. Defaults to "All" if none are provided.
PageSize 🔗︎ int
PageSize🔗︎
Optional parameter to specify the number of result items (max 1500). 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 (suppressFacetCounts and suppressHighlighting are implicitly set to true). If pageSize is not provided, the pre-configured page size of the searcher will be used. The pageSize parameter is ignored for external searchers.
SynonymLanguages 🔗︎ string[]
SynonymLanguages🔗︎
Optional List of language codes preferred by the user to filter synonyms by languages.
MergeOverlappingSynonyms 🔗︎ boolean
MergeOverlappingSynonyms🔗︎
Optional. 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. If it consists of a single wildcard field marked by "*" (star) then all available fields will be returned. If empty then the default result field set will be returned. Remark: Reducing the returned fields this way, will not in general improve performance, since Search is optimized to return the standard configured field set. It is not possible to request system fields such as 'roles' or nested sub-fields.