Case Assist engine

The case assist engine options.

The case assist engine configuration options.

The logger options.

List of additional middlewares. A middleware is a higher-order function that composes a dispatch function to return a new dispatch function. It is useful for logging actions, performing side effects like routing, or turning an asynchronous API call into a series of synchronous actions.

An optional function returning navigation context. (referer, location, UserAgent)

The initial headless state. You may optionally specify it to hydrate the state from the server in universal apps, or to restore a previously serialized user session.

Specifies the unique identifier of the target case assist configuration. See Retrieving a Case Assist ID.

The locale of the current user. Must comply with IETF’s BCP 47 definition.

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.

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

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

By default, no proxy is used and the Coveo case assist 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 case assist engine will not work properly:

The first level of origin of the request, typically the identifier of the graphical case assist interface from which the request originates. This value is used for analytics reporting purposes.

The access token to use to authenticate requests against the Coveo Cloud endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo Cloud organization.

The unique identifier of the target Coveo Cloud organization (e.g., mycoveocloudorganizationg8tp8wu3)

Allows configuring options related to analytics.

The environment in which the organization is hosted.

The dev and stg environments are only available internally for Coveo employees (e.g., Professional Services).

Defaults to prod.

The Engine name (e.g., myEngine). Specifying your Engine name will help in debugging when using an application with multiple Redux stores.

Default: 'coveo-headless'

Allows for augmenting a Platform request before it is sent.

A function that fetches a new access token. The function must return a Promise that resolves to a string (the new access token).

By default, is set to warn.

Changes the shape of the log object. This function will be called every time one of the log methods (such as .info) is called. All arguments passed to the log method, except the message, will be pass to this function. By default it does not change the shape of the log object.

analyticsClientMiddleware allows to hook into an analytics event payload before it is sent to the Coveo platform.

The analytics client to use. - legacy: The legacy analytics client, i.e., the Coveo Analytics.js library. - next: The next analytics client, i.e., the Coveo Event Protocol with the Relay library.

The default value is next.

Whether analytics events should be logged anonymously. If set to true, the Usage Analytics Write API will not extract the name and userDisplayName, if present, from the search token

The name of the device that the end user is using. It should be explicitly configured in the context of a native mobile app.

Specifies the URL of the current page or component.

Specifies if usage analytics tracking should be enabled.

By default, all analytics events will be logged.

Sets the Origin Context dimension on the analytics events.

You can use this dimension to specify the context of your application. The possible values are "Search", "InternalSearch", and "CommunitySearch".

The default value is Search.

Sets the value of the Origin Level 2 dimension on the analytics events.

Origin level 2 is a usage analytics event metadata whose value should typically be the name/identifier of the tab from which the usage analytics event originates.

In the context of product listing, the value should match the breadcrumb of the product listing page from which the usage analytics event originates (for example, canoes-kayaks/kayaks/sea-kayaks).

When logging a usage analytics event, originLevel2 should always be set to the same value as the corresponding tab (parameter) Search API query parameter so Coveo Machine Learning models function properly, and usage analytics reports and dashboards are coherent.

If left unspecified, this value will automatically try to resolve itself from the tab Search API query parameter.

Origin level 3 is a usage analytics event metadata whose value should typically be the URL of the page that linked to the search interface that’s making the request.

When logging a Search usage analytics event, originLevel3 should always be set to the same value as the corresponding referrer Search API query parameter so usage analytics reports and dashboards are coherent.

This value is optional, and will automatically try to resolve itself from the referrer search parameter.

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

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

By default, no proxy is used and the Coveo analytics requests are sent directly to the Coveo platform through the analytics organization endpoint resolved from the organizationId and environment values provided in your engine configuration (i.e., https://<organizationId>.analytics.org.coveo.com or https://<organizationId>.analytics.org<environment>.coveo.com, if the environment values is specified and different from prod).

If you set this option, you must also implement the correct proxy endpoints on your server, depending on the analyticsMode you are using.

If you are using the next analytics mode, you must implement the following proxy endpoints:

Optional analytics runtime environment, this is needed for analytics to work correctly if you’re running outside of a browser. See https://github.com/coveo/coveo.analytics.js for more info.

The unique identifier of the tracking target.

Specifies the user display name for the usage analytics logs.

An object containing the reducers to attach to the engine.

A callback to be invoked on every dispatch.