1.
schema:
type: integer
format: Int32
default: 10
- name: filter
in: query
description: A filter that only retrieves matching Insight Panel configurations.
schema:
type: string
- name: order
in: query
description: 'The order in which the configurations are listed. The available values are: asc: items are sorted in ascending order.desc:
items are sorted in descending order.filter parameter.
totalPages:
type: integer
description: The total number of item pages according to the perPage parameter.
deprecated: false
security:
- oauth2:
- full
post:
tags:
- Insight Panel
summary: Create an Insight Panel Configuration
description: Creates a new Insight Panel configuration.
operationId: insight-panel-configuration-create
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).1.
schema:
type: integer
format: Int32
default: 10
- name: filter
in: query
description: A filter that only retrieves matching Insight Panel configurations.
schema:
type: string
- name: order
in: query
description: 'The order in which the configurations are listed. The available values are: asc: items are sorted in ascending order.desc:
items are sorted in descending order.filter parameter.
totalPages:
type: integer
description: The total number of item pages according to the perPage parameter.
deprecated: false
security:
- oauth2:
- full
x-codegen-request-body-name: body
/rest/organizations/{organizationId}/insightconfig/v1/configs/{configId}:
get:
tags:
- Insight Panel
summary: Get an Insight Panel Configuration
description: Gets a single Insight Panel configuration.
operationId: insight-panel-configuration-get
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).The basic query expression, typically the keywords entered by the end user in a query box.
Note:
When logging a Search Usage Analytics event for a query, the queryText field of that
event should be set to the q value of the corresponding query.
0,
meaning that the entire HTML document is requested.
schema:
type: integer
responses:
'200':
description: The item's HTML preview.
content: {}
deprecated: false
security:
- oauth2:
- full
/rest/organizations/{organizationId}/insightconfig/v1/configs/projects/get:
get:
tags:
- Insight Panel
summary: Get Insight Configurations by Project
description: Retrieves insight panel configurations associated with a specific project in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).asc: items are sorted in ascending order.desc:
items are sorted in descending order.A GUID which represents the current user, who can either be authenticated or anonymous.
visitorId
is deprecated and has been replaced by clientId in newer
versions of the Coveo UI libraries. For compatibility, the new first-party cookie and local storage values are still
named coveo_visitorId.
For older versions of the JavaScript Search Framework, the visitor ID is
generated by the Coveo Usage Analytics service and stored in a non-expiring third-party cookie. Note:
Third-party cookies have also been deprecated. This is unrelated
to the deprecation of visitorId.
clientId identifies a user on a browser
of a Coveo-powered search page and provides insight into the events they performed
example: 5cb98953-9c13-42ff-8176-e6fcba6a50bf
locale:
type: string
description: The locale of the current user. Must comply with IETF's BCP 47 definition.
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.
Note: When logging a Search Usage Analytics event, the language field
of that event should match the language part of the locale value of the query (e.g., en-US
in locale becomes en in language).
default and thumbnail.
default: default
conditions:
$ref: '#/components/schemas/RestConditions'
badge:
type: object
properties:
field:
type: string
description: The name of the field from which the value is retrieved.
label:
type: string
description: A specific label to display.
color:
type: string
description: The hexadecimal color code.
example: '#5080F0'
details:
type: array
items:
type: object
properties:
field:
type: string
label:
type: string
resultActions:
type: object
properties:
attachToCase:
type: object
properties:
enabled:
type: boolean
description: Users can attach items to the current CRM object (e.g., an opened case).
copyToClipboard:
type: object
properties:
enabled:
type: boolean
description: Users can copy a result to their clipboard.
quickView:
type: object
properties:
enabled:
type: boolean
description: Users can preview a result without leaving the search page.
sendAsEmail:
type: object
properties:
enabled:
type: boolean
description: Users can insert a link to an item into an email.
sendToFeed:
type: object
properties:
enabled:
type: boolean
description: Users can insert a link to an item into a post.
description: Indicates the actions that are available on each result.
facets:
type: array
description: The facets configured for the Insight Panel interface.
items:
type: object
properties:
field:
type: string
description: The name of the facet field.
label:
type: string
description: The title of the facet.
displayValuesAs:
type: string
description: Whether to display the facet values as checkboxes (multiple selection), links (single selection),
or boxes (multiple selection). Possible values are checkbox, link, and box.
example: link
default: checkbox
tabs:
type: array
description: The tabs configured for the Insight Panel interface.
items:
type: object
properties:
label:
type: string
description: The caption for the tab.
example: People
conditions:
$ref: '#/components/schemas/RestConditions'
settings:
type: object
properties:
createArticle:
type: object
properties:
enabled:
type: boolean
fullSearch:
type: object
properties:
enabled:
type: boolean
description: The settings for the Insight Panel interface.
RestConditions:
type: array
items:
type: object
RestInsightPanelSearchRequest:
type: object
properties:
analytics:
$ref: '#/components/schemas/Analytics'
q:
type: string
description: The basic query expression, typically the keywords entered by the end user in a query box.
cq:
type: string
description: The constant query expression, typically populated with expressions that must apply to all queries sent from a specific search interface (e.g., from a specific tab). Once evaluated, the result sets of those expressions are kept in a special cache.
Tip: Avoid including dynamic content in the constant query expression. Otherwise, you risk filling up the cache with useless data, which can have a negative impact on performance.
facets: type: array description: The facet operations to perform on the query results. items: $ref: '#/components/schemas/ServiceRestFacetRequest' firstResult: type: integer description:The 0-based position of the first result to return in the non-paginated result set.
Along
with the numberOfResults parameter, this allows you to retrieve a specific page of result items.
The number of results to return.
Along with the firstResult parameter, this allows
you to retrieve a specific page of result items.
This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommencations feature.
Note: The maximum numberOfResults
value depends on the index settings of your Coveo organization. By default, a Coveo index can return a maximum
of 5,000 items per query.
The names of the fields to include with each item in the query results. If specified, no other fields will be included.
Note: If you specify both an array of fields to include and an array
of fields to exclude (see the fieldsToExclude parameter), the fieldsToExclude parameter
has no effect at all.
If you do not explicitly specify an array of values for this parameter (or for the
fieldsToExclude parameter), each query result item will include all of its available fields.
Important: This feature is still in an experimental state.
Whether to enable
the Coveo ML query suggestions Did You Mean feature, which populates the queryCorrection property
of a successful response with keyword correction suggestions.
Notes:
q parameter).enableDidYouMean and enableMLDidYouMean parameters are set to true,
the output of both features will appear in the queryCorrections array.The criteria to use for sorting the query results.
Allowed values:
relevancy:
use standard index ranking factors (adjacency, TDIDF, etc.) and custom ranking expressions (QREs and QRFs) to
compute a ranking score for each query result item, and sort the query results by descending score
value.date ascending/date descending: use the @date field to
sort the query results. This field typically contains the last modification date of each item.qre:
use only custom ranking expressions (QREs and QRFs) to compute a ranking score for each query result
item, and sort the query results by descending score value.nosort: do not
sort the query results; the index will return result items in an essentially random order.@[field]
ascending/@[field] descending: sort using the value of a specific sortable field (replace
[field] with the name of the target field).You can specify a list of comma-separated sort criteria. However, this only works when combining:
@views
descending,@likes descending).date
ascending,@views descending).Examples:
date ascending@author
ascendingdate descending,@views descending,@likes descendingThe second level of origin of the request, typically the identifier of the selected tab in the graphical search interface from which the request originates.
Coveo Machine Learning models use this information to provide contextually relevant output.
Note: When logging a Search
usage analytics event for a query, the originLevel2 field of that event should be set to the tab
value of the query (or to the "default" string, if no tab value was specified
in the query).
The total number of items that match the query for the current user (security trimming applied).
Note: When logging a Search Usage Analytics event for a query, the numberOfResults
field of that event should be set to the totalCount value of the query (for reporting purposes).
The total number of items that match the query for the current user (security trimming applied)
after duplicate filtering has been applied (see the duplicateFiltering query parameter).
The requestDuration added to the computing time (in milliseconds) that was required
by the Search API.
The time (in milliseconds) that was required for the index to find the query items.
example: '1175' requestDuration: type: integer description:The indexDuration added to the time (in milliseconds) that was required to establish
a connection between the Search API server and the index server.
The query UUID. Each query
sent to the Search API has its own randomly generated searchUid.
Note: When
logging a Search or Custom Usage Analytics event for a query, or a Click Usage Analytics event for an opened query
result item, the searchQueryUid field of that event should be set to the searchUid value
of the query response.
The name of the query pipeline to use for this request (bypassing its conditions, if it has any).
example: CustomQueryPipeline apiVersion: type: integer description:The version of the Search API that sent the query.
example: 2 exception: type: object properties: code: type: string context: type: string isFallbackToAdmin: type: boolean description:Whether the admin session ID was allowed and used by the Coveo for Salesforce search engine. The
value will be set to true when this is the case, and might be absent or set to false
otherwise.
The errors that did not make the query fail, but should be addressed. These might be security issues, deprecated behaviors, or any other kind of concern.
items: type: string errors: type: array description:The errors that critically changed the query behavior. These should be addressed right away to prevent future errors.
items: type: string index: type: string description:The identifier of the index mirror against which the query was executed (see the indexToken
query parameter).
The Base64 encoded identifier of the index mirror to which the request was forwarded (see the index
parameter).
If you do not specify an indexToken (or index) value, any index mirror
could be used.
Note: Passing an indexToken (or index) value
has no effect when the results of a specific request can be returned from cache (see the maximumAge
query parameter).
The type of Coveo query pipeline Trigger statement (see Manage trigger rules).
example: notify content: type: object properties: {} description:The actions that the client should perform based on the Trigger statements defined in the query
pipelines (see the pipeline query parameter).
Note: A trigger statement must
have a condition. Otherwise, the Search API ignores it and does not include it in the triggers array
of the query response (see Manage trigger rules).
The terms to highlight in each query result item. Includes all basic query expression keywords,
as well as any word that was stemmed from a basic query expression keyword (see the q query parameter),
unless the keyword was preceded by the no stemming Coveo query syntax operator (+).
The phrases to highlight in each query result item. This property is populated when the basic query
expression (see the q query parameter) contains one or more exact phrase match requests (terms between
double quote characters).
The query corrections suggested by the index, if the enableDidYouMean query parameter
was set to true.
The facet results returned by the query. These results are included in the order they were requested
in the facets query parameter.
The path to the suggested facet value (only applies to hierarchical facet value suggestions).
Example: If the suggested hierarchical facet value is Parrot, the returned path could
be ["Animals", "Birds", "Parrot"].
The name of the facet value.
Note: In the case of a hierarchical facet value, this represents a single path segment.
example: Alice Smith state: type: string description: The current state of the facet value in the search interface. default: idle enum: - idle - selected - excluded numberOfResults: type: integer description:The number of query results that can be expected if the facet value is selected in the search interface.
Note: This property only gets populated when the facet currently has no selected or excluded values.
endInclusive: type: boolean description: Whether to include theend value in the range.
default: false
children:
type: array
description: The children of this hierarchical facet value.
Each child is a full-fledged hierarchical facet value that may in turn have its own children and so forth, up to a maximum depth of 50 levels.
items: $ref: '#/components/schemas/RestHierarchicalFacetResponseValue' moreValuesAvailable: type: boolean description: Whether additional values are available for the facet. isSuggested: type: boolean isAutoSelected: type: boolean description: Whether the facet value was automatically selected by Coveo ML. path: type: array items: type: string isLeafValue: type: boolean description: Whether the hierarchical value is a childless node. mlScore: type: number description: The ranking score computed by Coveo ML DNE for this facet. indexScore: type: number description: The ranking score computed by the index for this facet. isFromAutoSelect: type: boolean description: Whether the facet was recommended by Coveo ML. RestQueryResult: type: object properties: title: type: string description:The item title.
Note: When logging a Click Usage Analytics event for an
opened query result item, the documentTitle field of that event should be set to the title
value of the opened query result item.
The item URI.
Notes:
uri value to create hyperlinks
to the item. Use the clickUri value instead.documentUrl field of that event should be set to the uri
value of the opened query result item.The human readable item URI.
Note: Avoid using the printableUri
value to create hyperlinks to the item. Use the clickUri value instead.
The hyperlinkable item URI.
Notes:
clickUri value when you
want to create hyperlinks to the item, rather than the uri or printableUri values.clickUri value is not necessarily unique for each item.The unique item identifier. You should consider the uniqueId value as an opaque string.
The contextual excerpt generated for the item (see the excerptLength query parameter).
retrieveFirstSentences query parameter).
example: Hello, I know Coveo currently hosts organizations in two independent cloud platforms, the new Coveo Cloud
V2 and Coveo Cloud V1, the original Coveo offering in the cloud. I would like to learn the main differences between
the two Coveo Cloud versions ...
summary:
type: string
description: The item summary (see the summaryLength query parameter).
flags:
type: string
description: The flags that are set on the item by the index. Distinct values are separated by semicolons.
example: HasHtmlVersion;HasMobileHtmlVersion
hasHtmlVersion:
type: boolean
description: Whether the index contains an HTML version of this item.
hasMobileHtmlVersion:
type: boolean
description: Whether the index contains a mobile HTML version of this item.
score:
type: integer
description: The total ranking score computed for the item (see the sortCriteria and rankingFunctions
query parameters).
example: 1626
percentScore:
type: number
description: The item ranking score expressed as a percentage (see the sortCriteria and rankingFunctions
query parameters).
example: 90.73539
rankingInfo:
type: string
description: The raw debug information generated by the index to detail how the item was ranked. This property is
null unless the debug query parameter is set to true.
example: 'Document weights: Title: 0; Quality: 180; Date: 596; Adjacency: 0; Source: 500; Custom: 350; Collaborative
rating: 0; QRE: 0; Ranking functions: 0; Total weight: 1626'
rating:
type: number
description: The item rating (see the enableCollaborativeRating query parameter).
Note:
Unless collaborative rating is enabled for your index, the value of this property is always 3.
If applicable, represents the type of ranking modification that was applied to this result.
Note: When logging a Click Usage Analytics event for an opened query result item, the rankingModifier
field of that event should be set to the rankingModifier value of the opened query result item, if
available.
title string.
items:
$ref: '#/components/schemas/RestHighlightResponse'
firstSentencesHighlights:
type: array
description: The length and offset of each word to highlight in the item firstSentences string.
items:
$ref: '#/components/schemas/RestHighlightResponse'
excerptHighlights:
type: array
description: The length and offset of each word to highlight in the item excerpt string.
items:
$ref: '#/components/schemas/RestHighlightResponse'
printableUriHighlights:
type: array
description: The length and offset of each word to highlight in the item printableUri string.
items:
$ref: '#/components/schemas/RestHighlightResponse'
summaryHighlights:
type: array
description: The length and offset of each word to highlight in the item summary string.
items:
$ref: '#/components/schemas/RestHighlightResponse'
parentResult:
$ref: '#/components/schemas/RestQueryResult'
childResults:
type: array
description: An array of references to the children of this item, if result folding was applied (see the filterField
query parameter). The query results contained in this field will have both their parent and child results set
to null.
items:
$ref: '#/components/schemas/RestQueryResult'
totalNumberOfChildResults:
type: integer
description: The total number of children available in the index for this item, if result folding was applied (see
the filterField query parameter).
absentTerms:
type: array
description: The basic query expression terms which this query result item does not match.
Note:
This property is populated by terms from the query pipeline-processed q value (not from the original
q value).
The values of the fields which were retrieved for this item (see the fieldsToInclude
and fieldsToExclude query parameters).
The name of the field on which to base the facet request.
Note: This must reference a field whose Facet option is enabled (see Add or edit a field).
example: author type: type: string description: Request facet values representing specific values (e.g., Alice Smith, Bob Jones, etc.). default: specific RestHighlightResponse: type: object properties: length: type: integer description: The length of the word (in number of characters) to highlight. example: 5 offset: type: integer description: The 0-based index position of the first character of the word to highlight in the string. example: 15 RestDebug: type: boolean description: 'Whether to force a successful response to include debug information.
Notes:
format parameter).true in production, as it has a negative impact on query performance.The custom context information to send along with the request. Must be a dictionary of key-value pairs (JSON) where each key is a string, and each value is either a string or an array of strings.
Coveo
Machine Learning models may use this information to provide contextually relevant output. Moreover, this information
can be referred to in query expressions and QPL statements by using the $context object.
Note:
When logging a Search Usage Analytics event for a query, the customData field of that event should
include the same data as the context parameter of the query. However, each context key
included in customData must be prefixed by context_ (e.g., the userRoles
key in context becomes context_userRoles in customData).
See also the referrer
parameter.
The locale of the current user. Must comply with IETF's BCP 47 definition.
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.
Note: When logging a Search Usage Analytics event, the language field
of that event should match the language part of the locale value of the query (e.g., en-US
in locale becomes en in language).
The tz database identifier of the time zone to use to correctly interpret dates in the query expression and result items.
If not specified, the default time zone of the server hosting the index is used.
Note: While no Coveo Machine Learning models use this information, it can nevertheless affect the ranking scores (and thus, potentially the order) or result items, as ranking expressions may be based on time constants.
example: America/New_York actionsHistory: type: array description:The previous query and page view actions made by the current user.
Coveo Machine Learning Content Recommendation models use this information to provide contextually relevant output.
Note: Page view actions are typically populated by the coveo.analytics.js script.
items: $ref: '#/components/schemas/ActionHistory' visitorId: type: string description:A GUID which represents the current user, who can either be authenticated or anonymous.
visitorId
is deprecated and has been replaced by clientId
in newer versions of the Coveo UI libraries. For compatibility, the new first-party cookie and local storage values
are still named coveo_visitorId.
For older versions of the JavaScript Search Framework, the
visitor ID is generated by the Coveo Usage Analytics service and stored in a non-expiring third-party cookie.
Note: Third-party cookies have also been deprecated.
This is unrelated to the deprecation of visitorId.
The maximum age of cached results, in milliseconds.
If the results of a specific request
are available in the cache, and if those results are no older than the maximumAge value, the service
returns those results rather than forwarding a new query to the index.
Note: This parameter
is automatically overridden when staticQuery is set to true.
debug parameter is set to true.
RestListOfInsightPanelConfigurationsWithProjects:
type: object
properties:
configurations:
type: array
items:
$ref: '#/components/schemas/RestInsightPanelConfigurationWithProjects'
totalEntries:
type: integer
format: int32
description: The total number of configurations
example: 1
totalPages:
type: integer
format: int32
description: The total number of pages
example: 1
RestInsightPanelConfigurationWithProjects:
allOf:
- $ref: '#/components/schemas/RestInsightPanelConfiguration'
- type: object
properties:
projectIds:
type: array
items:
type: string
example: myProjectId
description: Each item is the unique identifier of a project associated with the Insight Panel configuration.
required:
- projectIds
gencasereformulationModelId:
type: string
description: The unique identifier of the case reformulation machine-learning model.
example: myorganization1234_gencasereformulation_00000000_0000_0000_0000_000000000000
gencaseansweringModelId:
type: string
description: The unique identifier of the case answering machine-learning model.
example: myorganization1234_gencaseanswering_00000000_0000_0000_0000_000000000000
prapiModelId:
type: string
description: The unique identifier of the passage retrieval machine-learning model.
example: myorganization1234_chunksretrieval_00000000_0000_0000_0000_000000000000
caseTitleKey:
type: string
description: The case context key used to store the case title. It is used by the case answering model.
example: case-title
caseDescriptionKey:
type: string
description: The case context key used to store the case description. It is used by the case answering model.
example: case-description
LfcaConfiguration:
type: object
required:
- gencasereformulationModelId
- gencaseansweringModelId
- prapiModelId
- caseTitleKey
- caseDescriptionKey
properties:
gencasereformulationModelId:
$ref: '#/components/schemas/gencasereformulationModelId'
gencaseansweringModelId:
$ref: '#/components/schemas/gencaseansweringModelId'
prapiModelId:
$ref: '#/components/schemas/prapiModelId'
caseTitleKey:
$ref: '#/components/schemas/caseTitleKey'
caseDescriptionKey:
$ref: '#/components/schemas/caseDescriptionKey'
LfcaConfigurationPatchRequest:
type: object
properties:
gencasereformulationModelId:
$ref: '#/components/schemas/gencasereformulationModelId'
gencaseansweringModelId:
$ref: '#/components/schemas/gencaseansweringModelId'
prapiModelId:
$ref: '#/components/schemas/prapiModelId'
caseTitleKey:
$ref: '#/components/schemas/caseTitleKey'
caseDescriptionKey:
$ref: '#/components/schemas/caseDescriptionKey'
MaximumAge:
type: integer
nullable: true
description: 'The maximum age of cached results, in milliseconds.
If the results of a specific request are available in the cache, and if those results are no older than the `maximumAge`
value, the service returns those results rather than forwarding a new query to the index.
Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count.
**Note:** This parameter is automatically overridden when `staticQuery` is set to `true`.
**Default:** `-1` (which corresponds to the internal default value (15 minutes)'
format: int32
example: 1800000
default: -1
Pipeline:
type: string
nullable: true
description: 'The name of the query pipeline to use for this request (bypassing its conditions, if it has any).
You can pass an empty `pipeline` value to use an empty query pipeline (i.e., `?pipeline=` or `"pipeline": ""`).
If a query does not contain the `pipeline` parameter, the first query pipeline whose conditions are met by the request
is used (query pipelines without conditions are not evaluated). Should the request fail to meet the conditions of
each evaluated query pipeline, the default query pipeline of the target Coveo Cloud organization is used (bypassing
its conditions, if it has any).
**Notes:**
- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/)
that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional)
that routes queries to a specific `pipeline` via a query pipeline condition.
- For reporting purposes, when logging a **Search** usage analytics event for a query, the `queryPipeline` field of
that event should be set to the `pipeline` value of the query (or to the `"default"` string, if no `pipeline` value
was specified in the query).
See also [Managing Query Pipelines](https://docs.coveo.com/en/1450/).
'
example: CustomerQueryPipeline
SearchHub:
type: string
nullable: true
description: '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](https://docs.coveo.com/en/56/)
that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional)
that routes queries to a specific `pipeline` via a query pipeline condition.
- 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.
See also the `tab` parameter.
'
example: CustomerPortal
Tab:
type: string
nullable: true
description: 'The second level of origin of the request, typically the identifier of the selected tab in the graphical
search interface from which the request originates.
Coveo Machine Learning models use this information to provide contextually relevant output.
**Note:** When logging a **Search** usage analytics event for a query, the `originLevel2` field of that event should
be set to the `tab` value of the query (or to the `"default"` string, if no `tab` value was specified in the query).
See also the `searchHub` parameter.
'
example: ForumTab
Context:
type: object
nullable: true
additionalProperties: true
description: 'The custom context information to send along with the request. Must be a dictionary of key-value pairs
(JSON) where each key is a string, and each value is either a string or an array of strings.
Coveo Machine Learning models may use this information to provide contextually relevant output. Moreover, this information
can be referred to in query expressions and QPL statements by using the `$context` object.
**Note:** When logging a **Search** usage analytics event for a query, the `customData` field of that event should
include the same data as the `context` parameter of the query. However, each `context` key included in `customData`
must be prefixed by `context_` (e.g., the `userRoles` key in `context` becomes `context_userRoles` in `customData`).
See also the `referrer` parameter.
**Example** `{"userAgeRange":"25-35","userRoles":["PremiumCustomer","ProductReviewer"]}`'
Locale:
type: string
nullable: true
description: 'The locale of the current user. Must comply with IETF''s [BCP 47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt)
definition.
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.
**Note:** When logging a **Search** usage analytics event, the `language` field of that event should match the language
part of the `locale` value of the query (e.g., `en-US` in `locale` becomes `en` in `language`).
'
example: en-US
Timezone:
type: string
nullable: true
description: 'The [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifier of the time
zone to use to correctly interpret dates in the query expression and result items.
If not specified, the default time zone of the server hosting the index is used.
**Note:** While no Coveo Machine Learning model uses this information, it can nevertheless affect the ranking scores
(and thus, potentially the order) of result items, as ranking expressions may be based on time constants.
'
example: America/New_York
AnalyticsRequestParameters:
type: object
nullable: true
properties:
capture:
type: boolean
description: 'Whether the search api call should be tracked for analytics and machine learning purposes.
When set to `true`, be sure to set the `actionCause` parameter.
See [Standard actions and Usage Analytics reference](docs.coveo.com/en/1389)).'
trackingId:
type: string
description: A value to identify which web property an event is related to.
userId:
type: string
description: The ID of the user who is currently logged in. If not present, this ID is obtained from the authentication
token.
clientId:
type: string
description: 'A GUID which represents the current client.
If your implementation uses the Atomic or Headless libraries, or newer versions of the JavaScript Search Framework,
then the [client ID](https://docs.coveo.com/en/masb0234/) is generated automatically in client-side code. This
GUID is held in a browser''s local storage as well as a top level domain first-party cookie (`coveo_visitorId`)
that expires after 1 year. **Note:** The cookie takes precedence over the value in the browser''s local storage.
If you have a custom Coveo implementation, you will have to generate a [UUID v4](The previous query and page view actions made by the current user.
Coveo Machine Learning Content Recommendation models use this information to provide contextually relevant output.
Note: Page view actions are typically populated by the coveo.analytics.js script.
items: $ref: '#/components/schemas/ActionHistory' example: - name: Query value: Machine learning powered search time: '2017-08-16T11:33:29.427Z' - name: PageView value: http://www.example.com/ time: '2017-08-15T17:34:08.398Z' mlParameters: $ref: '#/components/schemas/MlParameters' pipelineRuleParameters: $ref: '#/components/schemas/PipelineRuleParameters' GenQAResponse: type: object required: - payloadType - payload properties: payloadType: type: string description: Type of the contained GenQA payload (e.g., genqa.headerMessageType). payload: type: string format: json description: JSON-encoded string containing the actual message payload. finishReason: type: string nullable: true enum: - COMPLETED - ERROR description: Reason for stream termination, if applicable. errorMessage: type: string nullable: true description: Error message if the stream failed. statusCode: type: integer nullable: true description: HTTP status code associated with the message, if applicable. Analytics: type: object nullable: true properties: capture: type: boolean description: 'Whether the search api call should be tracked for analytics and machine learning purposes. When set to `true`, be sure to set the `actionCause` parameter. See [Standard actions and Usage Analytics reference](docs.coveo.com/en/1389)).' trackingId: type: string description: A value to identify which web property an event is related to. userId: type: string description: The ID of the user who is currently logged in. If not present, this ID is obtained from the authentication token. clientId: type: string description: 'A GUID which represents the current client. If your implementation uses the Atomic or Headless libraries, or newer versions of the JavaScript Search Framework, then the [client ID](https://docs.coveo.com/en/masb0234/) is generated automatically in client-side code. This GUID is held in a browser''s local storage as well as a top level domain first-party cookie (`coveo_visitorId`) that expires after 1 year. **Note:** The cookie takes precedence over the value in the browser''s local storage. If you have a custom Coveo implementation, you will have to generate a [UUID v4](