Optional
authenticationOptional
localeThe locale of the current user. Must comply with IETF’s BCP 47 definition: https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
Notes: Coveo Machine Learning models use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the $locale object.
Optional
pipelineSpecifies the name of the query pipeline to use for the query. If not specified, the default query pipeline will be used.
Optional
preprocessAllows for augmenting a facet-search response before the state is updated.
Optional
preprocessAllows for augmenting a query-suggest response before the state is updated.
Optional
preprocessAllows for augmenting a search response before the state is updated.
Optional
proxyThe base URL to use to proxy Coveo search requests (e.g., https://example.com/search
).
This is an advanced option that you should only set if you need to proxy Coveo searchrequests through your own server. In most cases, you should not set this option.
By default, no proxy is used and the Coveo Search API requests are sent directly to the Coveo platform through the
search organization endpoint resolved from the organizationId
and
environment
values provided in your engine configuration (i.e., https://<organizationId>.org.coveo.com
or
https://<organizationId>.org<environment>.coveo.com
, if the environment
values is specified and different from
prod
).
If you set this option, you must also implement the following proxy endpoints on your server, otherwise the search engine will not work properly:
POST
/
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2
POST
/plan
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/plan
POST
/querySuggest
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/querySuggest
POST
/facet
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/facet
POST
/html
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/html
GET
/fields
to proxy requests to GET
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/fields
Optional
searchThe first level of origin of the request, typically the identifier of the graphical search interface from which the request originates. Coveo Machine Learning models use this information to provide contextually relevant output. Notes: This parameter will be overridden if the search request is authenticated by a search token that enforces a specific searchHub. When logging a Search usage analytics event for a query, the originLevel1 field of that event should be set to the value of the searchHub search request parameter.
Optional
timezoneThe tz database identifier of the time zone to use to correctly interpret dates in the query expression, facets, and result items. By default, the timezone will be guessed.
Specifies the name of the authentication providers to use to perform queries.
See SAML Authentication.