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.
Optional
analyticsAllows configuring options related to analytics.
Specifies the unique identifier of the target case assist configuration. See Retrieving a Case Assist ID.
Optional
environmentThe 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
.
Optional
localeThe 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.
Optional
nameThe Engine name (e.g., myEngine). Specifying your Engine name will help in debugging when using an application with multiple Redux stores.
The unique identifier of the target Coveo Cloud organization (e.g., mycoveocloudorganizationg8tp8wu3
)
Optional
preprocessAllows for augmenting a Platform request before it is sent.
Optional
proxyThe 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:
POST
/classify
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/organizations/<organizationId>/caseassists/<caseAssistId>/classify
POST
/documents/suggest
to proxy requests to POST
https://<organizationId>.org<environment|>.coveo.com/rest/organizations/<organizationId>/caseassists/<caseAssistId>/documents/suggest
Optional
renewA function that fetches a new access token. The function must return a Promise that resolves to a string (the new access token).
Optional
searchThe 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 case assist engine configuration.