Interface SearchConfigurationOptions

Specifies the name of the authentication providers to use to perform queries.

See SAML Authentication.

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

Specifies the name of the query pipeline to use for the query. If not specified, the default query pipeline will be used.

Allows for augmenting a facet-search response before the state is updated.

Allows for augmenting a query-suggest response before the state is updated.

Allows for augmenting a search response before the state is updated.

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

See Headless proxy: Search.

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

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