Interface InsightEngineSearchConfigurationOptions

The insight engine search configuration options.

interface InsightEngineSearchConfigurationOptions {
    locale?: string;
    proxyBaseUrl?: string;
}

Properties

locale?: string

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.

proxyBaseUrl?: string

The base URL to use to proxy Coveo insight requests (e.g., https://example.com/insight).

This is an advanced option that you should only set if you need to proxy Coveo insight requests through your own server. In most cases, you should not set this option.

By default, no proxy is used and the Coveo insight requests are sent directly to the Coveo platform through the 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 insight engine will not work properly: