See Performing a Query.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
aq | string (AQ) The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the |
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |
childField | string The Use a field whose value points to the See also the Notes:
|
object | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
cq | string (CQ) 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. Notes:
|
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the | |
disableQuerySyntax | boolean Deprecated Default: false This parameter is exposed for backward compatibility reasons. Use the |
dq | string (DQ) The disjunction query expression, typically populated by Coveo ML Automatic Relevance Tuning (ART) models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an |
enableCollaborativeRating | boolean Default: false Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: |
enableDidYouMean | boolean Default: false Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: |
enableDuplicateFiltering | boolean Default: false Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: |
enableMLDidYouMean | boolean Default: false Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: |
enableQuerySyntax | boolean Default: true Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: |
excerptLength | integer <int32> Default: 200 The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: |
object or null (RestFacetOptions) | |
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the |
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the |
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes::
|
filterFieldRange | integer <int32> Default: 5 The maximum number of items to include in the See also the Notes::
Default: |
firstResult | integer <int32> Default: 0 The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
object Generate facets based on the most relevant fields in the index. | |
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lowercaseOperators | boolean Default: false Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: |
lq | string (LQ) The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the |
lqPartialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: |
lqPartialMatchMaxKeywords | integer <int32> Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default value: |
lqPartialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlDidYouMeanMaxCandidates | integer <int32> Default: 3 The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: |
mlDidYouMeanMinScore | number <double> Default: 1 The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: |
mlDidYouMeanUseFacetCount | boolean Default: false Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
numberOfResults | integer <int32> >= 0 Default: 10 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: |
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
|
partialMatch | boolean Default: false Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: |
partialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: |
partialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: |
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
q | string (Q) 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 |
object This parameter controls the behavior of the Coveo query correction feature. Once enabled, this feature will:
Query corrections are derived from the index's Did You Mean feature and ML query corrections. Correction information will be returned in the If the query was automatically corrected, it will return:
Otherwise, it will return:
This feature is off by default for backward compatiblity reasons. | |
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: |
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
retrieveFirstSentences | boolean Default: false Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: |
searchHub | string or null (SearchHub) 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:
See also the |
sortCriteria | string Default: "Relevancy" The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria. However, this only works when combining:
Examples:
Default: |
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
staticQuery | boolean Default: false Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: |
summaryLength | integer <int32> Default: 0 The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
object (RestUserActionParameter) | |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
wildcards | boolean Default: false Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
{- "aq": "@year==2017",
- "categoryFacets": [
- {
- "delimitingCharacter": ">",
- "field": "@categories",
- "filterFacetCount": true,
- "injectionDepth": 1500,
- "maximumNumberOfValues": 5,
- "path": [
- "Doors",
- "Metal"
]
}
], - "childField": "@foldingparent",
- "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "cq": "@documenttype==forumpost",
- "dictionaryFieldContext": {
- "price": "storeA"
}, - "disableQuerySyntax": false,
- "dq": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "enableCollaborativeRating": false,
- "enableDidYouMean": true,
- "enableDuplicateFiltering": true,
- "enableMLDidYouMean": true,
- "enableQuerySyntax": true,
- "excerptLength": 250,
- "facetOptions": {
- "enableIndexFacetOrdering": true,
- "freezeFacetOrder": false
}, - "facets": [
- {
- "facetId": "author-1",
- "field": "author",
- "filterFacetCount": true,
- "injectionDepth": 1000,
- "isFieldExpanded": false,
- "preventAutoSelect": false,
- "resultsMustMatch": "atLeastOneValue",
- "type": "specific",
- "allowedValues": {
- "type": "simple",
- "values": [
- "Anonymous",
- "Bob Jones"
]
}, - "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "customSort": [
- "Simple",
- "Twin",
- "Queen",
- "King"
], - "freezeCurrentValues": false,
- "numberOfValues": 8,
- "sortCriteria": "string"
}
], - "fieldsToExclude": [
- "documenttype",
- "size",
- "source"
], - "fieldsToInclude": [
- "clickableuri",
- "author",
- "date",
- "filetype",
- "language",
- "conversationid",
- "messageid",
- "childid",
- "adjustednumberoflikes"
], - "filterField": "@foldingcollection",
- "filterFieldRange": 8,
- "firstResult": 2,
- "generateAutomaticFacets": {
- "currentFacets": [
- {
- "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "field": "author",
- "label": "string",
- "type": "specific"
}
], - "desiredCount": 20,
- "fields": {
- "toExclude": [
- "string"
], - "toInclude": [
- "string"
]
}, - "generationStrategy": "mostRelevant",
- "numberOfValues": 8
}, - "groupBy": [
- {
- "advancedQueryOverride": "@year==2017",
- "allowedValues": [
- "Anonymous",
- "Bob Jones",
- "Carrie Green",
- "David Allen"
], - "allowedValuesPatternType": "wildcards",
- "completeFacetWithStandardValues": true,
- "computedFields": [
- {
- "field": "@wordcount",
- "operation": "average"
}
], - "constantQueryOverride": "@filetype==forumpost",
- "disjunctionQueryOverride": "@date=2016-12-01..2016-12-31",
- "field": "@author",
- "filterFacetCount": true,
- "generateAutomaticRanges": false,
- "injectionDepth": 1500,
- "lookupField": "string",
- "maximumNumberOfValues": 5,
- "queryOverride": "Coveo Cloud V2 platform",
- "rangeValues": [ ],
- "sortCriteria": "ComputedFieldDescending",
- "thoroughLookup": false
}
], - "lowercaseOperators": false,
- "lq": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "lqPartialMatchKeywords": 4,
- "lqPartialMatchMaxKeywords": 20,
- "lqPartialMatchThreshold": "75%",
- "mlDidYouMeanMaxCandidates": 5,
- "mlDidYouMeanMinScore": 0.8,
- "mlDidYouMeanUseFacetCount": true,
- "numberOfResults": 5,
- "parentField": "@foldingchild",
- "partialMatch": true,
- "partialMatchKeywords": 4,
- "partialMatchThreshold": "75%",
- "q": "Coveo \"Cloud V2\" platform",
- "queryCorrection": {
- "enabled": true,
- "options": {
- "automaticallyCorrect": "never"
}
}, - "queryFunctions": [
- {
- "allowMissingFields": false,
- "fieldName": "numberoflikesplusone",
- "filter": "@filetype==forumpost",
- "function": "@numberoflikes+1"
}
], - "questionMark": true,
- "rankingFunctions": [
- {
- "expression": "-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))",
- "modifier": 100,
- "normalizeWeight": true
}
], - "retrieveFirstSentences": true,
- "sortCriteria": "DateDescending",
- "sortField": "string",
- "staticQuery": true,
- "summaryLength": 0,
- "userActions": {
- "tagViewsOfUser": "string"
}, - "wildcards": true,
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "apiVersion": 2,
- "categoryFacets": [
- {
- "field": "string",
- "parentValues": [
- {
- "numberOfResults": 0,
- "value": "string"
}
], - "values": [
- {
- "numberOfResults": 0,
- "value": "string"
}
]
}
], - "duration": 1235,
- "errors": [
- "string"
], - "exception": {
- "code": "string",
- "context": "string"
}, - "extendedResults": {
- "generativeQuestionAnsweringId": "queryStream01_coveo_c784a8f6-aa62-4b24-9ca0-d6b483feaa31"
}, - "facets": [
- {
- "domain": {
- "end": "2001-07-20T23:01:05",
- "start": "2001-07-20T23:01:05"
}, - "field": "author",
- "indexScore": 0,
- "isFromAutoSelect": true,
- "label": "string",
- "mlScore": 0,
- "moreValuesAvailable": true,
- "values": [
- {
- "end": "2001-07-20T23:01:05",
- "endInclusive": true,
- "isAutoSelected": true,
- "isSuggested": true,
- "numberOfResults": 0,
- "start": "2001-07-20T23:01:05",
- "state": "idle",
- "value": "Alice Smith"
}
]
}
], - "generateAutomaticFacets": {
- "facets": [
- {
- "domain": {
- "end": "2001-07-20T23:01:05",
- "start": "2001-07-20T23:01:05"
}, - "field": "author",
- "indexScore": 0,
- "isFromAutoSelect": true,
- "label": "string",
- "mlScore": 0,
- "moreValuesAvailable": true,
- "values": [
- {
- "end": "2001-07-20T23:01:05",
- "endInclusive": true,
- "isAutoSelected": true,
- "isSuggested": true,
- "numberOfResults": 0,
- "start": "2001-07-20T23:01:05",
- "state": "idle",
- "value": "Alice Smith"
}
]
}
]
}, - "groupByResults": [
- {
- "Field": "string",
- "GlobalComputedFieldResults": [
- 0
], - "field": "@author",
- "globalComputedFieldResults": [
- 0
], - "values": [
- {
- "computedFieldResults": [
- 243.72
], - "lookupValue": "",
- "numberOfResults": 42,
- "score": 0,
- "value": "Bob Jones",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 201.82
], - "lookupValue": "",
- "numberOfResults": 37,
- "score": 0,
- "value": "Erika Miller",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 177.56
], - "lookupValue": "",
- "numberOfResults": 24,
- "score": 0,
- "value": "David Allen",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 143.92
], - "lookupValue": "",
- "numberOfResults": 11,
- "score": 0,
- "value": "Carrie Green",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 122.85
], - "lookupValue": "",
- "numberOfResults": 77,
- "score": 0,
- "value": "Anonymous",
- "valueType": "Standard"
}
]
}
], - "index": "mycoveocloudv2organizationid-cqjd206sta1xb9qyxfhhnsu294-Indexer-2-9rbfxhp1n07cth80ckzeh3zotc",
- "indexDuration": 1175,
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "isFallbackToAdmin": true,
- "phrasesToHighlight": {
- "cloud v2": {
- "cloud": [ ],
- "v2": [ ]
}
}, - "pipeline": "CustomerQueryPipeline",
- "queryCorrection": {
- "correctedQuery": "string",
- "corrections": [
- {
- "correctedQuery": "Coveo Cloud V2 platform",
- "wordCorrections": [
- {
- "correctedWord": "platform",
- "length": 8,
- "offset": 15,
- "originalWord": "plattfomr"
}
]
}
], - "originalQuery": "string"
}, - "queryCorrections": [ ],
- "questionAnswer": {
- "answerFound": true,
- "answerSnippet": "string",
- "documentId": {
- "contentIdKey": "string",
- "contentIdValue": "string"
}, - "question": "string",
- "raw": { },
- "relatedQuestions": [
- {
- "answerSnippet": "string",
- "documentId": {
- "contentIdKey": "string",
- "contentIdValue": "string"
}, - "question": "string",
- "score": 0
}
], - "score": 0
}, - "refinedKeywords": [
- "v2",
- "platform",
- "cloud",
- "coveo"
], - "requestDuration": 1181,
- "results": [
- {
- "ClickUri": "string",
- "Excerpt": "string",
- "FirstSentences": "string",
- "PrintableUri": "string",
- "Title": "string",
- "UniqueId": "string",
- "Uri": "string",
- "absentTerms": [
- "platform",
- "native",
- "solution"
], - "childResults": [
- { }
], - "excerpt": "... the new Coveo Cloud V2 and Coveo Cloud V1 ... the main differences between the two Coveo Cloud versions ...",
- "excerptHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "firstSentences": "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 ...",
- "firstSentencesHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "flags": "HasHtmlVersion;HasMobileHtmlVersion",
- "hasHtmlVersion": true,
- "hasMobileHtmlVersion": true,
- "isRecommendation": false,
- "isTopResult": false,
- "isUserActionView": false,
- "parentResult": { },
- "percentScore": 90.73539,
- "printableUriHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "rankingInfo": "Document weights:\nTitle: 0; Quality: 180; Date: 596; Adjacency: 0; Source: 500; Custom: 350; Collaborative rating: 0; QRE: 0; Ranking functions: 0;\n\nTotal weight: 1626",
- "rankingModifier": "TopResult",
- "rating": 3,
- "raw": {
- "adjustednumberoflikes": 46,
- "author": "Anonymous",
- "childid": 2,
- "conversationid": 898,
- "date": 1502796809427,
- "filetype": "forumpost",
- "language": [
- "English"
], - "messageid": 2
}, - "score": 1626,
- "summary": "string",
- "summaryHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "title": "Differences between Coveo Cloud V2 and V1",
- "titleHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "totalNumberOfChildResults": 0,
- "uniqueId": "84.72597$https://example.com/Root:0/Topic:898/Post:2",
}
], - "searchUid": "a0e4773c-39c3-423c-90cd-c03a640ecde5",
- "splitTestRun": "CustomerQueryPipeline-mirror-1725560351",
- "suggestedFacets": [
- {
- "field": "author",
- "values": [
- {
- "path": [
- "string"
], - "value": "string"
}
]
}
], - "termsToHighlight": {
- "cloud": [
- "clouds"
], - "coveo": [ ],
- "platform": [
- "platforms"
], - "v2": [ ]
}, - "totalCount": 250,
- "totalCountFiltered": 245,
- "triggers": [
- {
- "content": null,
- "type": "notify"
}
], - "warnings": [
- "string"
]
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
contentType | string The MIME type of the data stream to request. Default: |
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
dataStream required | string The name of the data stream to request. |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
uniqueId required | string The unique ID of the document. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
uniqueId required | string The unique ID of the document. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
{- "ClickUri": "string",
- "Excerpt": "string",
- "FirstSentences": "string",
- "PrintableUri": "string",
- "Title": "string",
- "UniqueId": "string",
- "Uri": "string",
- "absentTerms": [
- "platform",
- "native",
- "solution"
], - "childResults": [
- { }
], - "excerpt": "... the new Coveo Cloud V2 and Coveo Cloud V1 ... the main differences between the two Coveo Cloud versions ...",
- "excerptHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "firstSentences": "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 ...",
- "firstSentencesHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "flags": "HasHtmlVersion;HasMobileHtmlVersion",
- "hasHtmlVersion": true,
- "hasMobileHtmlVersion": true,
- "isRecommendation": false,
- "isTopResult": false,
- "isUserActionView": false,
- "parentResult": { },
- "percentScore": 90.73539,
- "printableUriHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "rankingInfo": "Document weights:\nTitle: 0; Quality: 180; Date: 596; Adjacency: 0; Source: 500; Custom: 350; Collaborative rating: 0; QRE: 0; Ranking functions: 0;\n\nTotal weight: 1626",
- "rankingModifier": "TopResult",
- "rating": 3,
- "raw": {
- "adjustednumberoflikes": 46,
- "author": "Anonymous",
- "childid": 2,
- "conversationid": 898,
- "date": 1502796809427,
- "filetype": "forumpost",
- "language": [
- "English"
], - "messageid": 2
}, - "score": 1626,
- "summary": "string",
- "summaryHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "title": "Differences between Coveo Cloud V2 and V1",
- "titleHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "totalNumberOfChildResults": 0,
- "uniqueId": "84.72597$https://example.com/Root:0/Topic:898/Post:2",
}
Executes a facet search request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
field required | string The name of the field against which to execute the facet search request. |
basePath | Array of strings The shared base path for all values in the facet to search against. If a |
object A dictionary that maps index field values to facet value display names. Note: When specifying display captions for hierarchical facet values, you can use full values (e.g., Examples:
| |
delimitingCharacter | string The character to use to split field values into a hierarchical sequence. Example: For a multi-value field containing the following values:
The delimiting character is For a hierarchical field containing the following values:
The delimiting character is Default: |
filterFacetCount | boolean Whether to exclude folded result parents when estimating the result count for each facet value. Note: The target folding field must be a facet field with the Use cache for nested queries options enabled (see Add or Edit a Field). Default: |
ignorePaths | Array of strings[ items ] A list of paths to filter out from the hierarchical facet search results. |
numberOfValues | integer <int32> Default: 10 The maximum number of values to fetch. **Default: |
query | string The string to match. Note: Typically, this should be set to the text entered by the end-user in the facet search box, to which one or more wildcard characters ( |
object (RestQueryParameters) | |
type | string The kind of facet against which the search request is being made. Allowed values:
Default: |
{- "basePath": [
- "Doors",
- "Metal"
], - "captions": {
- "acme_productA": "ACME Product A",
- "acme_productB": "ACME Product B"
}, - "delimitingCharacter": "string",
- "field": "color",
- "filterFacetCount": [
- [
- "Electronics",
- "Entertainment",
- "Gaming Consoles"
], - [
- "Appliances",
- "Kitchen"
]
], - "ignorePaths": [
- [
- "string"
]
], - "numberOfValues": 10,
- "query": "*oran*",
- "searchContext": {
- "aq": "@year==2017",
- "categoryFacets": [
- {
- "delimitingCharacter": ">",
- "field": "@categories",
- "filterFacetCount": true,
- "injectionDepth": 1500,
- "maximumNumberOfValues": 5,
- "path": [
- "Doors",
- "Metal"
]
}
], - "childField": "@foldingparent",
- "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "cq": "@documenttype==forumpost",
- "dictionaryFieldContext": {
- "price": "storeA"
}, - "disableQuerySyntax": false,
- "dq": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "enableCollaborativeRating": false,
- "enableDidYouMean": true,
- "enableDuplicateFiltering": true,
- "enableMLDidYouMean": true,
- "enableQuerySyntax": true,
- "excerptLength": 250,
- "facetOptions": {
- "enableIndexFacetOrdering": true,
- "freezeFacetOrder": false
}, - "facets": [
- {
- "facetId": "author-1",
- "field": "author",
- "filterFacetCount": true,
- "injectionDepth": 1000,
- "isFieldExpanded": false,
- "preventAutoSelect": false,
- "resultsMustMatch": "atLeastOneValue",
- "type": "specific",
- "allowedValues": {
- "type": "simple",
- "values": [
- "Anonymous",
- "Bob Jones"
]
}, - "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "customSort": [
- "Simple",
- "Twin",
- "Queen",
- "King"
], - "freezeCurrentValues": false,
- "numberOfValues": 8,
- "sortCriteria": "string"
}
], - "fieldsToExclude": [
- "documenttype",
- "size",
- "source"
], - "fieldsToInclude": [
- "clickableuri",
- "author",
- "date",
- "filetype",
- "language",
- "conversationid",
- "messageid",
- "childid",
- "adjustednumberoflikes"
], - "filterField": "@foldingcollection",
- "filterFieldRange": 8,
- "firstResult": 2,
- "generateAutomaticFacets": {
- "currentFacets": [
- {
- "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "field": "author",
- "label": "string",
- "type": "specific"
}
], - "desiredCount": 20,
- "fields": {
- "toExclude": [
- "string"
], - "toInclude": [
- "string"
]
}, - "generationStrategy": "mostRelevant",
- "numberOfValues": 8
}, - "groupBy": [
- {
- "advancedQueryOverride": "@year==2017",
- "allowedValues": [
- "Anonymous",
- "Bob Jones",
- "Carrie Green",
- "David Allen"
], - "allowedValuesPatternType": "wildcards",
- "completeFacetWithStandardValues": true,
- "computedFields": [
- {
- "field": "@wordcount",
- "operation": "average"
}
], - "constantQueryOverride": "@filetype==forumpost",
- "disjunctionQueryOverride": "@date=2016-12-01..2016-12-31",
- "field": "@author",
- "filterFacetCount": true,
- "generateAutomaticRanges": false,
- "injectionDepth": 1500,
- "lookupField": "string",
- "maximumNumberOfValues": 5,
- "queryOverride": "Coveo Cloud V2 platform",
- "rangeValues": [ ],
- "sortCriteria": "ComputedFieldDescending",
- "thoroughLookup": false
}
], - "lowercaseOperators": false,
- "lq": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "lqPartialMatchKeywords": 4,
- "lqPartialMatchMaxKeywords": 20,
- "lqPartialMatchThreshold": "75%",
- "mlDidYouMeanMaxCandidates": 5,
- "mlDidYouMeanMinScore": 0.8,
- "mlDidYouMeanUseFacetCount": true,
- "numberOfResults": 5,
- "parentField": "@foldingchild",
- "partialMatch": true,
- "partialMatchKeywords": 4,
- "partialMatchThreshold": "75%",
- "q": "Coveo \"Cloud V2\" platform",
- "queryCorrection": {
- "enabled": true,
- "options": {
- "automaticallyCorrect": "never"
}
}, - "queryFunctions": [
- {
- "allowMissingFields": false,
- "fieldName": "numberoflikesplusone",
- "filter": "@filetype==forumpost",
- "function": "@numberoflikes+1"
}
], - "questionMark": true,
- "rankingFunctions": [
- {
- "expression": "-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))",
- "modifier": 100,
- "normalizeWeight": true
}
], - "retrieveFirstSentences": true,
- "sortCriteria": "DateDescending",
- "sortField": "string",
- "staticQuery": true,
- "summaryLength": 0,
- "userActions": {
- "tagViewsOfUser": "string"
}, - "wildcards": true,
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}, - "type": "hierarchical"
}
{- "moreValuesAvailable": true,
- "values": [
- {
- "count": 0,
- "displayValue": "Orange",
- "rawValue": "#FF8000"
}
]
}
Gets all fields in the target Coveo Cloud organization.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
{- "fields": [
- {
- "defaultValue": "",
- "description": "",
- "fieldSourceType": "System",
- "fieldType": "LargeString",
- "groupByField": false,
- "includeInQuery": false,
- "includeInResults": false,
- "name": "@author",
- "nativeName": "author",
- "sortByField": false,
- "splitGroupByField": false,
- "type": "text"
}
]
}
Find fields name from results matching the q
expression.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"VIEW_ALL_CONTENT","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The query to get the fields from.
object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the | |
q | string Default: "" The basic query expression, typically the keywords entered by the end user in a query box. |
{- "dictionaryFieldContext": {
- "price": "storeA"
}, - "q": "Coveo \"Cloud V2\" platform"
}
{- "fields": [
- {
- "name": "@author"
}
]
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
enableNavigation | boolean |
findNext | integer <int32> |
findPrevious | integer <int32> |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> |
requestedOutputSize | integer <int32> The approximate number of bytes to request in the HTML response. Default: |
uniqueId required | string The unique ID of the document. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
aq | string (AQ) The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the |
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |
childField | string The Use a field whose value points to the See also the Notes:
|
object | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
cq | string (CQ) 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. Notes:
|
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the | |
disableQuerySyntax | boolean Deprecated Default: false This parameter is exposed for backward compatibility reasons. Use the |
dq | string (DQ) The disjunction query expression, typically populated by Coveo ML Automatic Relevance Tuning (ART) models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an |
enableCollaborativeRating | boolean Default: false Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: |
enableDidYouMean | boolean Default: false Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: |
enableDuplicateFiltering | boolean Default: false Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: |
enableMLDidYouMean | boolean Default: false Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: |
enableQuerySyntax | boolean Default: true Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: |
excerptLength | integer <int32> Default: 200 The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: |
object or null (RestFacetOptions) | |
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the |
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the |
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes::
|
filterFieldRange | integer <int32> Default: 5 The maximum number of items to include in the See also the Notes::
Default: |
firstResult | integer <int32> Default: 0 The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
object Generate facets based on the most relevant fields in the index. | |
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lowercaseOperators | boolean Default: false Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: |
lq | string (LQ) The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the |
lqPartialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: |
lqPartialMatchMaxKeywords | integer <int32> Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default value: |
lqPartialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlDidYouMeanMaxCandidates | integer <int32> Default: 3 The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: |
mlDidYouMeanMinScore | number <double> Default: 1 The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: |
mlDidYouMeanUseFacetCount | boolean Default: false Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
numberOfResults | integer <int32> >= 0 Default: 10 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: |
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
|
partialMatch | boolean Default: false Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: |
partialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: |
partialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: |
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
q | string (Q) 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 |
object This parameter controls the behavior of the Coveo query correction feature. Once enabled, this feature will:
Query corrections are derived from the index's Did You Mean feature and ML query corrections. Correction information will be returned in the If the query was automatically corrected, it will return:
Otherwise, it will return:
This feature is off by default for backward compatiblity reasons. | |
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: |
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
retrieveFirstSentences | boolean Default: false Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: |
searchHub | string or null (SearchHub) 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:
See also the |
sortCriteria | string Default: "Relevancy" The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria. However, this only works when combining:
Examples:
Default: |
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
staticQuery | boolean Default: false Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: |
summaryLength | integer <int32> Default: 0 The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
object (RestUserActionParameter) | |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
wildcards | boolean Default: false Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
{- "aq": "@year==2017",
- "categoryFacets": [
- {
- "delimitingCharacter": ">",
- "field": "@categories",
- "filterFacetCount": true,
- "injectionDepth": 1500,
- "maximumNumberOfValues": 5,
- "path": [
- "Doors",
- "Metal"
]
}
], - "childField": "@foldingparent",
- "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "cq": "@documenttype==forumpost",
- "dictionaryFieldContext": {
- "price": "storeA"
}, - "disableQuerySyntax": false,
- "dq": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "enableCollaborativeRating": false,
- "enableDidYouMean": true,
- "enableDuplicateFiltering": true,
- "enableMLDidYouMean": true,
- "enableQuerySyntax": true,
- "excerptLength": 250,
- "facetOptions": {
- "enableIndexFacetOrdering": true,
- "freezeFacetOrder": false
}, - "facets": [
- {
- "facetId": "author-1",
- "field": "author",
- "filterFacetCount": true,
- "injectionDepth": 1000,
- "isFieldExpanded": false,
- "preventAutoSelect": false,
- "resultsMustMatch": "atLeastOneValue",
- "type": "specific",
- "allowedValues": {
- "type": "simple",
- "values": [
- "Anonymous",
- "Bob Jones"
]
}, - "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "customSort": [
- "Simple",
- "Twin",
- "Queen",
- "King"
], - "freezeCurrentValues": false,
- "numberOfValues": 8,
- "sortCriteria": "string"
}
], - "fieldsToExclude": [
- "documenttype",
- "size",
- "source"
], - "fieldsToInclude": [
- "clickableuri",
- "author",
- "date",
- "filetype",
- "language",
- "conversationid",
- "messageid",
- "childid",
- "adjustednumberoflikes"
], - "filterField": "@foldingcollection",
- "filterFieldRange": 8,
- "firstResult": 2,
- "generateAutomaticFacets": {
- "currentFacets": [
- {
- "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "field": "author",
- "label": "string",
- "type": "specific"
}
], - "desiredCount": 20,
- "fields": {
- "toExclude": [
- "string"
], - "toInclude": [
- "string"
]
}, - "generationStrategy": "mostRelevant",
- "numberOfValues": 8
}, - "groupBy": [
- {
- "advancedQueryOverride": "@year==2017",
- "allowedValues": [
- "Anonymous",
- "Bob Jones",
- "Carrie Green",
- "David Allen"
], - "allowedValuesPatternType": "wildcards",
- "completeFacetWithStandardValues": true,
- "computedFields": [
- {
- "field": "@wordcount",
- "operation": "average"
}
], - "constantQueryOverride": "@filetype==forumpost",
- "disjunctionQueryOverride": "@date=2016-12-01..2016-12-31",
- "field": "@author",
- "filterFacetCount": true,
- "generateAutomaticRanges": false,
- "injectionDepth": 1500,
- "lookupField": "string",
- "maximumNumberOfValues": 5,
- "queryOverride": "Coveo Cloud V2 platform",
- "rangeValues": [ ],
- "sortCriteria": "ComputedFieldDescending",
- "thoroughLookup": false
}
], - "lowercaseOperators": false,
- "lq": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "lqPartialMatchKeywords": 4,
- "lqPartialMatchMaxKeywords": 20,
- "lqPartialMatchThreshold": "75%",
- "mlDidYouMeanMaxCandidates": 5,
- "mlDidYouMeanMinScore": 0.8,
- "mlDidYouMeanUseFacetCount": true,
- "numberOfResults": 5,
- "parentField": "@foldingchild",
- "partialMatch": true,
- "partialMatchKeywords": 4,
- "partialMatchThreshold": "75%",
- "q": "Coveo \"Cloud V2\" platform",
- "queryCorrection": {
- "enabled": true,
- "options": {
- "automaticallyCorrect": "never"
}
}, - "queryFunctions": [
- {
- "allowMissingFields": false,
- "fieldName": "numberoflikesplusone",
- "filter": "@filetype==forumpost",
- "function": "@numberoflikes+1"
}
], - "questionMark": true,
- "rankingFunctions": [
- {
- "expression": "-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))",
- "modifier": 100,
- "normalizeWeight": true
}
], - "retrieveFirstSentences": true,
- "sortCriteria": "DateDescending",
- "sortField": "string",
- "staticQuery": true,
- "summaryLength": 0,
- "userActions": {
- "tagViewsOfUser": "string"
}, - "wildcards": true,
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
Directs the browser to URI of the target Search API authentication provider, and back to the origin search page once the authentication process is complete. This authentication provider must be properly configured in the Coveo Cloud organization.
provider required | string Example: My SharePoint Server The name of the Search API authentication provider to log in to. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
See Performing a Query.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
aq | string (AQ) The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the |
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |
childField | string The Use a field whose value points to the See also the Notes:
|
object | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
cq | string (CQ) 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. Notes:
|
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the | |
disableQuerySyntax | boolean Deprecated Default: false This parameter is exposed for backward compatibility reasons. Use the |
dq | string (DQ) The disjunction query expression, typically populated by Coveo ML Automatic Relevance Tuning (ART) models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an |
enableCollaborativeRating | boolean Default: false Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: |
enableDidYouMean | boolean Default: false Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: |
enableDuplicateFiltering | boolean Default: false Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: |
enableMLDidYouMean | boolean Default: false Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: |
enableQuerySyntax | boolean Default: true Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: |
excerptLength | integer <int32> Default: 200 The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: |
object or null (RestFacetOptions) | |
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the |
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the |
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes::
|
filterFieldRange | integer <int32> Default: 5 The maximum number of items to include in the See also the Notes::
Default: |
firstResult | integer <int32> Default: 0 The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
object Generate facets based on the most relevant fields in the index. | |
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lowercaseOperators | boolean Default: false Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: |
lq | string (LQ) The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the |
lqPartialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: |
lqPartialMatchMaxKeywords | integer <int32> Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default value: |
lqPartialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlDidYouMeanMaxCandidates | integer <int32> Default: 3 The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: |
mlDidYouMeanMinScore | number <double> Default: 1 The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: |
mlDidYouMeanUseFacetCount | boolean Default: false Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
numberOfResults | integer <int32> >= 0 Default: 10 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: |
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
|
partialMatch | boolean Default: false Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: |
partialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: |
partialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: |
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
q | string (Q) 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 |
object This parameter controls the behavior of the Coveo query correction feature. Once enabled, this feature will:
Query corrections are derived from the index's Did You Mean feature and ML query corrections. Correction information will be returned in the If the query was automatically corrected, it will return:
Otherwise, it will return:
This feature is off by default for backward compatiblity reasons. | |
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: |
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
retrieveFirstSentences | boolean Default: false Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: |
searchHub | string or null (SearchHub) 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:
See also the |
sortCriteria | string Default: "Relevancy" The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria. However, this only works when combining:
Examples:
Default: |
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
staticQuery | boolean Default: false Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: |
summaryLength | integer <int32> Default: 0 The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
object (RestUserActionParameter) | |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
wildcards | boolean Default: false Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
{- "aq": "@year==2017",
- "categoryFacets": [
- {
- "delimitingCharacter": ">",
- "field": "@categories",
- "filterFacetCount": true,
- "injectionDepth": 1500,
- "maximumNumberOfValues": 5,
- "path": [
- "Doors",
- "Metal"
]
}
], - "childField": "@foldingparent",
- "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "cq": "@documenttype==forumpost",
- "dictionaryFieldContext": {
- "price": "storeA"
}, - "disableQuerySyntax": false,
- "dq": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "enableCollaborativeRating": false,
- "enableDidYouMean": true,
- "enableDuplicateFiltering": true,
- "enableMLDidYouMean": true,
- "enableQuerySyntax": true,
- "excerptLength": 250,
- "facetOptions": {
- "enableIndexFacetOrdering": true,
- "freezeFacetOrder": false
}, - "facets": [
- {
- "facetId": "author-1",
- "field": "author",
- "filterFacetCount": true,
- "injectionDepth": 1000,
- "isFieldExpanded": false,
- "preventAutoSelect": false,
- "resultsMustMatch": "atLeastOneValue",
- "type": "specific",
- "allowedValues": {
- "type": "simple",
- "values": [
- "Anonymous",
- "Bob Jones"
]
}, - "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "customSort": [
- "Simple",
- "Twin",
- "Queen",
- "King"
], - "freezeCurrentValues": false,
- "numberOfValues": 8,
- "sortCriteria": "string"
}
], - "fieldsToExclude": [
- "documenttype",
- "size",
- "source"
], - "fieldsToInclude": [
- "clickableuri",
- "author",
- "date",
- "filetype",
- "language",
- "conversationid",
- "messageid",
- "childid",
- "adjustednumberoflikes"
], - "filterField": "@foldingcollection",
- "filterFieldRange": 8,
- "firstResult": 2,
- "generateAutomaticFacets": {
- "currentFacets": [
- {
- "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "field": "author",
- "label": "string",
- "type": "specific"
}
], - "desiredCount": 20,
- "fields": {
- "toExclude": [
- "string"
], - "toInclude": [
- "string"
]
}, - "generationStrategy": "mostRelevant",
- "numberOfValues": 8
}, - "groupBy": [
- {
- "advancedQueryOverride": "@year==2017",
- "allowedValues": [
- "Anonymous",
- "Bob Jones",
- "Carrie Green",
- "David Allen"
], - "allowedValuesPatternType": "wildcards",
- "completeFacetWithStandardValues": true,
- "computedFields": [
- {
- "field": "@wordcount",
- "operation": "average"
}
], - "constantQueryOverride": "@filetype==forumpost",
- "disjunctionQueryOverride": "@date=2016-12-01..2016-12-31",
- "field": "@author",
- "filterFacetCount": true,
- "generateAutomaticRanges": false,
- "injectionDepth": 1500,
- "lookupField": "string",
- "maximumNumberOfValues": 5,
- "queryOverride": "Coveo Cloud V2 platform",
- "rangeValues": [ ],
- "sortCriteria": "ComputedFieldDescending",
- "thoroughLookup": false
}
], - "lowercaseOperators": false,
- "lq": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "lqPartialMatchKeywords": 4,
- "lqPartialMatchMaxKeywords": 20,
- "lqPartialMatchThreshold": "75%",
- "mlDidYouMeanMaxCandidates": 5,
- "mlDidYouMeanMinScore": 0.8,
- "mlDidYouMeanUseFacetCount": true,
- "numberOfResults": 5,
- "parentField": "@foldingchild",
- "partialMatch": true,
- "partialMatchKeywords": 4,
- "partialMatchThreshold": "75%",
- "q": "Coveo \"Cloud V2\" platform",
- "queryCorrection": {
- "enabled": true,
- "options": {
- "automaticallyCorrect": "never"
}
}, - "queryFunctions": [
- {
- "allowMissingFields": false,
- "fieldName": "numberoflikesplusone",
- "filter": "@filetype==forumpost",
- "function": "@numberoflikes+1"
}
], - "questionMark": true,
- "rankingFunctions": [
- {
- "expression": "-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))",
- "modifier": 100,
- "normalizeWeight": true
}
], - "retrieveFirstSentences": true,
- "sortCriteria": "DateDescending",
- "sortField": "string",
- "staticQuery": true,
- "summaryLength": 0,
- "userActions": {
- "tagViewsOfUser": "string"
}, - "wildcards": true,
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "parsedInput": {
- "advancedExpression": "@year==2017",
- "basicExpression": "Coveo \"Cloud V2\" platform",
- "constantExpression": "@documenttype==forumpost",
- "disjunctionExpression": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "largeExpression": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "mandatoryExpression": "@source==KnowledgeBase"
}, - "preprocessingOutput": {
- "triggers": [
- {
- "property1": null,
- "property2": null
}
]
}
}
See Getting Query Suggestions.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
autoCompleter | string Deprecated This parameter is exposed for backward compatibility reasons. |
object (RestCommerceParameters) | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
count | integer <int32> The desired number of query suggestions. |
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
enableWordCompletion | boolean Whether to attempt to complete the last word of the current basic query expression (see the |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
q | string The basic query expression, typically the keywords entered by the end user in a query box. |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string or null (SearchHub) 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:
See also the |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "autoCompleter": "string",
- "count": 0,
- "enableWordCompletion": true,
- "q": "Coveo \"Cloud V2\" platform",
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "completions": [
- {
- "executableConfidence": 0.9,
- "expression": "brown boot",
- "highlighted": "(brown) [boot]",
- "objectId": "9919344e-c495-4620-b0c1-ec2cb721f96e",
- "score": 61.04
}
], - "responseId": "e1a4c9dd-71d2-4e68-9589-11bc3e640da0"
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
uniqueId required | string The unique ID of the document. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
Creates a temporary JSON web token which can be used to impersonate one or several security identities when authenticating a query (see Search Token Authentication).
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"IMPERSONATE_SEARCH_API","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The search token information.
required | Array of objects (RestUserId) The security identities to impersonate when authenticating a query with this search token. |
canSeeUserProfileOf | Array of strings The Note: This property is meant to be used when generating search tokens for users requiring contextual information about other users to improve search relevance (e.g., support agents using an insight panel). |
object (CommerceParameters) | |
dictionaryFieldContext | object The dictionary field context to enforce when authenticating a query with this search token.
This value will override the A dictionary field context is a key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. For example, suppose that in your index, the Note: This cannot be used at the same time as |
filter | string The filter query expression to apply when authenticating a query with this search token. This expression will be merged with the constant part of the query expression ( The filter can also be used in query pipeline condition statements (e.g., |
licenseDefinitionKey | string Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
pipeline | string The name of the query pipeline to use when authenticating a query with this search token. This query pipeline will take precedence over the possible output of all other query pipeline routing mechanisms when using this search token (see Query Pipeline Routing Mechanisms and Rules). |
salesforceCommunityUrl | string Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
salesforceFallbackToAdmin | boolean Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
salesforceOrganizationId | string Internal: The ID of Salesforce organization, used to differentiate Salesforce organizations linked to the same Coveo organization. |
salesforceUser | string Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
scope | integer <int32> Deprecated This property is exposed for backward compatibility reasons only. |
searchHub | string The name of the search hub to enforce when authenticating a query with this search token. This value will override the The search hub can also be used in query pipeline condition statements (e.g., |
superUserToken | string Deprecated This property is exposed for backward compatibility reasons only. |
userDisplayName | string The This information is leveraged in the Analytics section of the Coveo Cloud administration console. |
userGroups | Array of strings The This information is leveraged in the Analytics section of the Coveo Cloud administration console. User groups can be also be used in query pipeline condition statements (e.g., |
usertype | string Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
validFor | integer <int32> Default: 86400000 The number of milliseconds the search token will remain valid for once it has been created. Minimum value: Maximum/default: |
{- "canSeeUserProfileOf": [
- "bjones@acme.com",
- "dmoore@acme.com"
], - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "string"
}, - "dictionaryFieldContext": { },
- "filter": "@source==KnowledgeBase",
- "licenseDefinitionKey": "string",
- "pipeline": "InternalSearch",
- "salesforceCommunityUrl": "string",
- "salesforceFallbackToAdmin": true,
- "salesforceOrganizationId": "00Df23090018W5bEAG",
- "salesforceUser": "string",
- "scope": 0,
- "searchHub": "SupportHub",
- "superUserToken": "string",
- "userDisplayName": "Alice Smith",
- "userGroups": [
- "Tech support agents",
- "Employees"
], - "userIds": [
- {
- "authCookie": "",
- "infos": { },
- "name": "asmith@example.com",
- "password": "string",
- "provider": "Email Security Provider",
- "type": "User"
}
], - "usertype": "string",
- "validFor": 3600000
}
{- "token": "string"
}
Lists all values of the target field.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
field required | string The name of the field from which to retrieve values. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
object (RestCommerceParameters) | |
constantQueryOverride | string A different constant query expression (cq) to use. |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
dictionaryFieldContext | object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the Note: This parameter will be overridden if the request is authenticated by a search token that enforces a specific |
disjunctionQueryOverride | string A different disjunction query expression (dq) to use. |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
ignoreAccents | boolean Whether to treat accentuated characters as non-accentuated characters when retrieving field values (e.g., treat Default: |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lookupField | string Deprecated This parameter is exposed for backward compatibility reasons. The name of an additional field from which to retrieve values. |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumNumberOfValues | integer <int32> >= 0 The maximum number of field values to return. Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
pattern | string The pattern that the field values must match. See also the |
patternType | string The type of pattern that is being used to list field values. Use:
Default: |
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
queryOverride | string A different basic query expression (q) use. |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string or null (SearchHub) 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:
See also the |
sortCriteria | string or null The sort criteria to use. Use:
Default: |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "constantQueryOverride": "string",
- "dictionaryFieldContext": { },
- "disjunctionQueryOverride": "string",
- "field": "@author",
- "ignoreAccents": true,
- "lookupField": "string",
- "maximumNumberOfValues": 0,
- "pattern": "string",
- "patternType": "string",
- "queryOverride": "string",
- "sortCriteria": "string",
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "values": [
- {
- "lookupValue": "red",
- "numberOfResults": 182,
- "value": "red"
}, - {
- "lookupValue": "green",
- "numberOfResults": 142,
- "value": "green"
}
]
}
Lists all values of the target field.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
object or null (AnalyticsRequestParameters) | |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
required | Array of objects (RestListFieldValuesParameter) An array of parameters to retrieve field values. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
object (RestCommerceParameters) | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string or null (SearchHub) 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:
See also the |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "batch": [
- {
- "constantQueryOverride": "string",
- "dictionaryFieldContext": { },
- "disjunctionQueryOverride": "string",
- "field": "@author",
- "ignoreAccents": true,
- "lookupField": "string",
- "maximumNumberOfValues": 0,
- "pattern": "string",
- "patternType": "string",
- "queryOverride": "string",
- "sortCriteria": "string",
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
], - "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "batch": [
- [
- {
- "lookupValue": "red",
- "numberOfResults": 182,
- "value": "red"
}, - {
- "lookupValue": "green",
- "numberOfResults": 142,
- "value": "green"
}
]
]
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
required | object Localization parameter. |
query required | string <= 1000 characters The query for which to retrieve the passage(s). |
additionalFields | Array of strings <= 5 items [^([a-z][a-z0-9_]{0,254})$] The fields to include in the response. When omitted, only the identifier of the document will be returned. |
object or null 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 | |
filter | string A filter expression that will be applied during the first stage retrieval. The expression must comply with the Coveo Query Language (CQL) syntax. |
maxPassages | integer <int32> [ 1 .. 20 ] Default: 5 The maximum number of passage(s) to retrieve. |
searchHub | string 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:
|
{- "additionalFields": [
- "clickableuri"
], - "context": {
- "userAgeRange": "25-35",
- "userRoles": [
- "PremiumCustomer",
- "ProductReviewer"
]
}, - "filter": "@source==\"acme\"\n",
- "localization": {
- "locale": "en-CA",
- "timezone": "America/Montreal"
}, - "maxPassages": 5,
- "query": "What are the benefits of using solar energy?",
- "searchHub": "Main"
}
{- "items": [
- {
- "document": {
- "primaryid": "bDMzdA",
- "title": "The Benefits of Solar Energy"
}, - "relevanceScore": 0.85,
- "text": "Solar energy has several benefits including reducing electricity bills, providing a renewable energy source, and lowering carbon footprint.\""
}
], - "responseId": "c0857557-5579-4f5e-8958-9befd7d1d4a8"
}
Parses a query expression written using the Coveo query syntax, and converts it into a structured expression. to a structured expression.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXPRESSION_VALIDATION_RESULT","type":"VIEW","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The query expression to parse and convert
query required | string A query using the Coveo query syntax. |
{- "query": "@altpopulation>=90000 AND @altcapital AND NOT (@source==\"Youtube\" OR @author==\"JohnSmith\")"
}
{- "structured": {
- "expressions": [
- {
- "fieldName": "altpopulation",
- "operator": "greaterThanOrEqual",
- "type": "fieldExpression",
- "value": {
- "type": "unknown",
- "value": "90000"
}
}, - {
- "fieldName": "altcapital",
- "type": "fieldExists"
}, - {
- "expression": {
- "expressions": [
- {
- "fieldName": "source",
- "operator": "isExactly",
- "type": "fieldExpression",
- "value": {
- "type": "string",
- "value": "Youtube"
}
}, - {
- "fieldName": "author",
- "operator": "isExactly",
- "type": "fieldExpression",
- "value": {
- "type": "string",
- "value": "JohnSmith"
}
}
], - "type": "or"
}, - "type": "not"
}
], - "type": "and"
}
}
Replay a query that was already done and get inspection details.
Note: This API call can only be used with an OAuth token. API Keys and Search Token aren't allowed.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"REPLAY_ANY_QUERY","type":"VIEW","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
Inspection parameters
id required | string The SearchUID of the request to replay. |
object The date range within which to look for the request. |
{- "dateRange": {
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}, - "id": "string"
}
{- "execution": [
- {
- "durationInMs": 0,
- "name": "Pipeline selection",
- "selectedPipeline": {
- "condition": {
- "id": "string"
}, - "id": "string",
- "name": "string"
}, - "selectionCause": {
- "abTest": {
- "originalPipeline": {
- "condition": {
- "id": "string"
}, - "id": "string",
- "name": "string"
}, - "targetPipeline": {
- "condition": {
- "id": "string"
}, - "id": "string",
- "name": "string"
}
}, - "type": "AUTHENTICATION_PIPELINE"
}, - "type": "pipelineSelection"
}
], - "requestParameters": {
- "aq": "@author=john",
- "q": "adventure books"
}, - "results": [
- {
- "fields": { },
- "rankingInfo": {
- "documentWeights": {
- "source": 240,
- "title": 1000,
- "uri": 500
}, - "totalWeight": 0,
- "weightComposition": {
- "queryRankingExpressions": [
- {
- "expression": "string",
- "origin": "query_pipeline",
- "rule": {
- "id": "string",
- "type": "ranking_expression"
}, - "score": 0
}
], - "rankingFunctions": [
- {
- "expression": "string",
- "origin": "query_pipeline",
- "rule": {
- "id": "string",
- "type": "ranking_expression"
}, - "score": 0
}
], - "termsWeights": [
- {
- "term": {
- "property1": {
- "source": 240,
- "title": 1000,
- "uri": 500
}, - "property2": {
- "source": 240,
- "title": 1000,
- "uri": 500
}
}, - "weightInfo": {
- "source": 240,
- "title": 1000,
- "uri": 500
}
}
]
}
}, - "title": "string"
}
], - "totalResultsCount": 0
}
See Performing a Query.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
Array of objects (ActionHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (AnalyticsRequestParameters) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
aq | string The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
childField | string The Use a field whose value points to the See also the Notes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (RestCommerceParameters) The parameters for Coveo for Commerce. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
cq | string 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. Notes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
debug | boolean Whether to force a successful response to include debug information. Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
dictionaryFieldContext | object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the Note: This cannot be used at the same time as Note: This parameter will be overridden if the search request is authenticated by a search token that enforces a specific | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
disableQuerySyntax | boolean Deprecated This parameter is exposed for backward compatibility reasons. Use the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
dq | string The disjunction query expression, typically populated by Coveo ML automatic relevance tuning models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableCollaborativeRating | boolean Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableDidYouMean | boolean Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableDuplicateFiltering | boolean Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableMLDidYouMean | boolean Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableQuerySyntax | boolean Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
excerptLength | integer <int32> The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (RestFacetOptions) The global configuration options that apply to all facet requests performed along with the query (see the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
filterFieldRange | integer <int32> The maximum number of items to include in the See also the Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
firstResult | integer <int32> The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
format | string The format of a successful response.
Note: Debug information (see the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexType | string The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
isGuestUser | boolean Whether the current user is anonymous. Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
language | string Deprecated This parameter is exposed for backward compatibility reasons. Use the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
locale | string 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 Note: When logging a Search usage analytics event, the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lowercaseOperators | boolean Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lq | string The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lqPartialMatchKeywords | integer <int32> The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lqPartialMatchMaxKeywords | integer Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lqPartialMatchThreshold | string An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
maximumAge | integer <int32> 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
maximumTimeoutMs | integer <int32> The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
mlDidYouMeanMaxCandidates | integer <int32> The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
mlDidYouMeanMinScore | number <double> The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
mlDidYouMeanUseFacetCount | boolean Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
mlParameters | object A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
numberOfResults | integer <int32> >= 0 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
partialMatch | boolean Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
partialMatchKeywords | integer <int32> The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
partialMatchThreshold | string An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
q | string 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
recommendation | string The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
retrieveFirstSentences | boolean Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
searchHub | string 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:
See also the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortCriteria | string The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria which will be applied sequentially, i.e., if there's a tie on the 1st criterion, the API uses the 2nd criterion to break the tie. However, this only works when combining:
Examples:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
staticQuery | boolean Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
summaryLength | integer <int32> The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
tab | string 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
timezone | string 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 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (RestUserActionParameter) The parameters allowing user actions to be retrieved in query results. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
visitorId | string Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
wildcards | boolean Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
apiVersion required | integer <int32> The version of the Search API that sent the query. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestCategoryFacetResponse) Hierarchical data results corresponding the to hierarchical data in the query. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration required | integer <int32> The | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestFacetResult) The facet results returned by the query. These results are included in the order they were requested in the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestGroupByResult) The Group By results returned by the query. These results are included in the order they were requested in the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
index required | string The identifier of the index mirror against which the query was executed (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexDuration required | integer <int32> The time (in milliseconds) that was required by the index to find the query items. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object The phrases to highlight in each query result item. This property is populated when the basic query expression (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pipeline required | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestQueryCorrection) The query corrections suggested by the index, if the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
refinedKeywords required | Array of strings The refined keywords used by the Coveo ML automatic relevance tuning model. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestDuration required | integer <int32> The | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestQueryResult) The items returned for the query. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
searchUid required | string The query UUID. Each query sent to the Search API has its own randomly generated 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestSuggestedFacet) A DNE facet suggestion. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object The terms to highlight in each query result item. Includes all basic query expression keywords, as well as any word stemmed from a basic query expression keyword (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalCount required | integer <int32> The total number of items matching the query for the current user (security trimming applied). Note: When logging a Search usage analytics event for a query, the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalCountFiltered required | integer <int32> The total number of items matching the query for the current user (security trimming applied) after duplicate filtering has been applied (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestTriggerResponse) The actions to perform by the client based on the Trigger statements defined in query pipelines (see the Note:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
errors | Array of strings The errors that critically changed the query behaviour. These should be addressed right away to prevent future errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (RestException) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional response attributes coming from the execution of query pipeline integrations. Currently supported properties:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Automatically generated facets based on the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isFallbackToAdmin | boolean Whether the admin session ID was allowed and used by the Coveo for Salesforce search engine. The value will be set to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Property returned when the It will either return:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (RestQuestionAnswer) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
splitTestRun | string Whether there is an active A/B test on the query pipeline. If not, this attribute will not appear in the response. It is used to identify and differentiate between A/B tests, and is crucial for tracking and analyzing the performance of different A/B test configurations. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
warnings | Array of strings The errors that did not make the query fail, but should be addressed. They might be security issues, deprecated behaviors, or any other kind of concern. |
{- "apiVersion": 2,
- "categoryFacets": [
- {
- "field": "string",
- "parentValues": [
- {
- "numberOfResults": 0,
- "value": "string"
}
], - "values": [
- {
- "numberOfResults": 0,
- "value": "string"
}
]
}
], - "duration": 1235,
- "errors": [
- "string"
], - "exception": {
- "code": "string",
- "context": "string"
}, - "extendedResults": {
- "generativeQuestionAnsweringId": "queryStream01_coveo_c784a8f6-aa62-4b24-9ca0-d6b483feaa31"
}, - "facets": [
- {
- "domain": {
- "end": "2001-07-20T23:01:05",
- "start": "2001-07-20T23:01:05"
}, - "field": "author",
- "indexScore": 0,
- "isFromAutoSelect": true,
- "label": "string",
- "mlScore": 0,
- "moreValuesAvailable": true,
- "values": [
- {
- "end": "2001-07-20T23:01:05",
- "endInclusive": true,
- "isAutoSelected": true,
- "isSuggested": true,
- "numberOfResults": 0,
- "start": "2001-07-20T23:01:05",
- "state": "idle",
- "value": "Alice Smith"
}
]
}
], - "generateAutomaticFacets": {
- "facets": [
- {
- "domain": {
- "end": "2001-07-20T23:01:05",
- "start": "2001-07-20T23:01:05"
}, - "field": "author",
- "indexScore": 0,
- "isFromAutoSelect": true,
- "label": "string",
- "mlScore": 0,
- "moreValuesAvailable": true,
- "values": [
- {
- "end": "2001-07-20T23:01:05",
- "endInclusive": true,
- "isAutoSelected": true,
- "isSuggested": true,
- "numberOfResults": 0,
- "start": "2001-07-20T23:01:05",
- "state": "idle",
- "value": "Alice Smith"
}
]
}
]
}, - "groupByResults": [
- {
- "Field": "string",
- "GlobalComputedFieldResults": [
- 0
], - "field": "@author",
- "globalComputedFieldResults": [
- 0
], - "values": [
- {
- "computedFieldResults": [
- 243.72
], - "lookupValue": "",
- "numberOfResults": 42,
- "score": 0,
- "value": "Bob Jones",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 201.82
], - "lookupValue": "",
- "numberOfResults": 37,
- "score": 0,
- "value": "Erika Miller",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 177.56
], - "lookupValue": "",
- "numberOfResults": 24,
- "score": 0,
- "value": "David Allen",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 143.92
], - "lookupValue": "",
- "numberOfResults": 11,
- "score": 0,
- "value": "Carrie Green",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 122.85
], - "lookupValue": "",
- "numberOfResults": 77,
- "score": 0,
- "value": "Anonymous",
- "valueType": "Standard"
}
]
}
], - "index": "mycoveocloudv2organizationid-cqjd206sta1xb9qyxfhhnsu294-Indexer-2-9rbfxhp1n07cth80ckzeh3zotc",
- "indexDuration": 1175,
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "isFallbackToAdmin": true,
- "phrasesToHighlight": {
- "cloud v2": {
- "cloud": [ ],
- "v2": [ ]
}
}, - "pipeline": "CustomerQueryPipeline",
- "queryCorrection": {
- "correctedQuery": "string",
- "corrections": [
- {
- "correctedQuery": "Coveo Cloud V2 platform",
- "wordCorrections": [
- {
- "correctedWord": "platform",
- "length": 8,
- "offset": 15,
- "originalWord": "plattfomr"
}
]
}
], - "originalQuery": "string"
}, - "queryCorrections": [ ],
- "questionAnswer": {
- "answerFound": true,
- "answerSnippet": "string",
- "documentId": {
- "contentIdKey": "string",
- "contentIdValue": "string"
}, - "question": "string",
- "raw": { },
- "relatedQuestions": [
- {
- "answerSnippet": "string",
- "documentId": {
- "contentIdKey": "string",
- "contentIdValue": "string"
}, - "question": "string",
- "score": 0
}
], - "score": 0
}, - "refinedKeywords": [
- "v2",
- "platform",
- "cloud",
- "coveo"
], - "requestDuration": 1181,
- "results": [
- {
- "ClickUri": "string",
- "Excerpt": "string",
- "FirstSentences": "string",
- "PrintableUri": "string",
- "Title": "string",
- "UniqueId": "string",
- "Uri": "string",
- "absentTerms": [
- "platform",
- "native",
- "solution"
], - "childResults": [
- { }
], - "excerpt": "... the new Coveo Cloud V2 and Coveo Cloud V1 ... the main differences between the two Coveo Cloud versions ...",
- "excerptHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "firstSentences": "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 ...",
- "firstSentencesHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "flags": "HasHtmlVersion;HasMobileHtmlVersion",
- "hasHtmlVersion": true,
- "hasMobileHtmlVersion": true,
- "isRecommendation": false,
- "isTopResult": false,
- "isUserActionView": false,
- "parentResult": { },
- "percentScore": 90.73539,
- "printableUriHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "rankingInfo": "Document weights:\nTitle: 0; Quality: 180; Date: 596; Adjacency: 0; Source: 500; Custom: 350; Collaborative rating: 0; QRE: 0; Ranking functions: 0;\n\nTotal weight: 1626",
- "rankingModifier": "TopResult",
- "rating": 3,
- "raw": {
- "adjustednumberoflikes": 46,
- "author": "Anonymous",
- "childid": 2,
- "conversationid": 898,
- "date": 1502796809427,
- "filetype": "forumpost",
- "language": [
- "English"
], - "messageid": 2
}, - "score": 1626,
- "summary": "string",
- "summaryHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "title": "Differences between Coveo Cloud V2 and V1",
- "titleHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "totalNumberOfChildResults": 0,
- "uniqueId": "84.72597$https://example.com/Root:0/Topic:898/Post:2",
}
], - "searchUid": "a0e4773c-39c3-423c-90cd-c03a640ecde5",
- "splitTestRun": "CustomerQueryPipeline-mirror-1725560351",
- "suggestedFacets": [
- {
- "field": "author",
- "values": [
- {
- "path": [
- "string"
], - "value": "string"
}
]
}
], - "termsToHighlight": {
- "cloud": [
- "clouds"
], - "coveo": [ ],
- "platform": [
- "platforms"
], - "v2": [ ]
}, - "totalCount": 250,
- "totalCountFiltered": 245,
- "triggers": [
- {
- "content": null,
- "type": "notify"
}
], - "warnings": [
- "string"
]
}
See Performing a Query.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (AnalyticsRequestParameters) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
aq | string (AQ) The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
childField | string The Use a field whose value points to the See also the Notes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
cq | string (CQ) 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. Notes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
disableQuerySyntax | boolean Deprecated Default: false This parameter is exposed for backward compatibility reasons. Use the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
dq | string (DQ) The disjunction query expression, typically populated by Coveo ML Automatic Relevance Tuning (ART) models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableCollaborativeRating | boolean Default: false Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableDidYouMean | boolean Default: false Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableDuplicateFiltering | boolean Default: false Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableMLDidYouMean | boolean Default: false Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
enableQuerySyntax | boolean Default: true Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
excerptLength | integer <int32> Default: 200 The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (RestFacetOptions) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes::
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
filterFieldRange | integer <int32> Default: 5 The maximum number of items to include in the See also the Notes::
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
firstResult | integer <int32> Default: 0 The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Generate facets based on the most relevant fields in the index. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lowercaseOperators | boolean Default: false Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lq | string (LQ) The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lqPartialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lqPartialMatchMaxKeywords | integer <int32> Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default value: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
lqPartialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
mlDidYouMeanMaxCandidates | integer <int32> Default: 3 The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
mlDidYouMeanMinScore | number <double> Default: 1 The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
mlDidYouMeanUseFacetCount | boolean Default: false Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
numberOfResults | integer <int32> >= 0 Default: 10 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
partialMatch | boolean Default: false Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
partialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
partialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
q | string (Q) 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object This parameter controls the behavior of the Coveo query correction feature. Once enabled, this feature will:
Query corrections are derived from the index's Did You Mean feature and ML query corrections. Correction information will be returned in the If the query was automatically corrected, it will return:
Otherwise, it will return:
This feature is off by default for backward compatiblity reasons. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
retrieveFirstSentences | boolean Default: false Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
searchHub | string or null (SearchHub) 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:
See also the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortCriteria | string Default: "Relevancy" The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria. However, this only works when combining:
Examples:
Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
staticQuery | boolean Default: false Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
summaryLength | integer <int32> Default: 0 The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
tab | string or null (Tab) 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 See also the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
timezone | string or null (Timezone) 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 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (RestUserActionParameter) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
wildcards | boolean Default: false Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
apiVersion required | integer <int32> The version of the Search API that sent the query. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestCategoryFacetResponse) Hierarchical data results corresponding the to hierarchical data in the query. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration required | integer <int32> The | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestFacetResult) The facet results returned by the query. These results are included in the order they were requested in the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestGroupByResult) The Group By results returned by the query. These results are included in the order they were requested in the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
index required | string The identifier of the index mirror against which the query was executed (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexDuration required | integer <int32> The time (in milliseconds) that was required by the index to find the query items. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object The phrases to highlight in each query result item. This property is populated when the basic query expression (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pipeline required | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestQueryCorrection) The query corrections suggested by the index, if the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
refinedKeywords required | Array of strings The refined keywords used by the Coveo ML automatic relevance tuning model. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestDuration required | integer <int32> The | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestQueryResult) The items returned for the query. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
searchUid required | string The query UUID. Each query sent to the Search API has its own randomly generated 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestSuggestedFacet) A DNE facet suggestion. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object The terms to highlight in each query result item. Includes all basic query expression keywords, as well as any word stemmed from a basic query expression keyword (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalCount required | integer <int32> The total number of items matching the query for the current user (security trimming applied). Note: When logging a Search usage analytics event for a query, the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalCountFiltered required | integer <int32> The total number of items matching the query for the current user (security trimming applied) after duplicate filtering has been applied (see the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (RestTriggerResponse) The actions to perform by the client based on the Trigger statements defined in query pipelines (see the Note:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
errors | Array of strings The errors that critically changed the query behaviour. These should be addressed right away to prevent future errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (RestException) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Additional response attributes coming from the execution of query pipeline integrations. Currently supported properties:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Automatically generated facets based on the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isFallbackToAdmin | boolean Whether the admin session ID was allowed and used by the Coveo for Salesforce search engine. The value will be set to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Property returned when the It will either return:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (RestQuestionAnswer) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
splitTestRun | string Whether there is an active A/B test on the query pipeline. If not, this attribute will not appear in the response. It is used to identify and differentiate between A/B tests, and is crucial for tracking and analyzing the performance of different A/B test configurations. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
warnings | Array of strings The errors that did not make the query fail, but should be addressed. They might be security issues, deprecated behaviors, or any other kind of concern. |
{- "aq": "@year==2017",
- "categoryFacets": [
- {
- "delimitingCharacter": ">",
- "field": "@categories",
- "filterFacetCount": true,
- "injectionDepth": 1500,
- "maximumNumberOfValues": 5,
- "path": [
- "Doors",
- "Metal"
]
}
], - "childField": "@foldingparent",
- "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "cq": "@documenttype==forumpost",
- "dictionaryFieldContext": {
- "price": "storeA"
}, - "disableQuerySyntax": false,
- "dq": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "enableCollaborativeRating": false,
- "enableDidYouMean": true,
- "enableDuplicateFiltering": true,
- "enableMLDidYouMean": true,
- "enableQuerySyntax": true,
- "excerptLength": 250,
- "facetOptions": {
- "enableIndexFacetOrdering": true,
- "freezeFacetOrder": false
}, - "facets": [
- {
- "facetId": "author-1",
- "field": "author",
- "filterFacetCount": true,
- "injectionDepth": 1000,
- "isFieldExpanded": false,
- "preventAutoSelect": false,
- "resultsMustMatch": "atLeastOneValue",
- "type": "specific",
- "allowedValues": {
- "type": "simple",
- "values": [
- "Anonymous",
- "Bob Jones"
]
}, - "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "customSort": [
- "Simple",
- "Twin",
- "Queen",
- "King"
], - "freezeCurrentValues": false,
- "numberOfValues": 8,
- "sortCriteria": "string"
}
], - "fieldsToExclude": [
- "documenttype",
- "size",
- "source"
], - "fieldsToInclude": [
- "clickableuri",
- "author",
- "date",
- "filetype",
- "language",
- "conversationid",
- "messageid",
- "childid",
- "adjustednumberoflikes"
], - "filterField": "@foldingcollection",
- "filterFieldRange": 8,
- "firstResult": 2,
- "generateAutomaticFacets": {
- "currentFacets": [
- {
- "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "field": "author",
- "label": "string",
- "type": "specific"
}
], - "desiredCount": 20,
- "fields": {
- "toExclude": [
- "string"
], - "toInclude": [
- "string"
]
}, - "generationStrategy": "mostRelevant",
- "numberOfValues": 8
}, - "groupBy": [
- {
- "advancedQueryOverride": "@year==2017",
- "allowedValues": [
- "Anonymous",
- "Bob Jones",
- "Carrie Green",
- "David Allen"
], - "allowedValuesPatternType": "wildcards",
- "completeFacetWithStandardValues": true,
- "computedFields": [
- {
- "field": "@wordcount",
- "operation": "average"
}
], - "constantQueryOverride": "@filetype==forumpost",
- "disjunctionQueryOverride": "@date=2016-12-01..2016-12-31",
- "field": "@author",
- "filterFacetCount": true,
- "generateAutomaticRanges": false,
- "injectionDepth": 1500,
- "lookupField": "string",
- "maximumNumberOfValues": 5,
- "queryOverride": "Coveo Cloud V2 platform",
- "rangeValues": [ ],
- "sortCriteria": "ComputedFieldDescending",
- "thoroughLookup": false
}
], - "lowercaseOperators": false,
- "lq": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "lqPartialMatchKeywords": 4,
- "lqPartialMatchMaxKeywords": 20,
- "lqPartialMatchThreshold": "75%",
- "mlDidYouMeanMaxCandidates": 5,
- "mlDidYouMeanMinScore": 0.8,
- "mlDidYouMeanUseFacetCount": true,
- "numberOfResults": 5,
- "parentField": "@foldingchild",
- "partialMatch": true,
- "partialMatchKeywords": 4,
- "partialMatchThreshold": "75%",
- "q": "Coveo \"Cloud V2\" platform",
- "queryCorrection": {
- "enabled": true,
- "options": {
- "automaticallyCorrect": "never"
}
}, - "queryFunctions": [
- {
- "allowMissingFields": false,
- "fieldName": "numberoflikesplusone",
- "filter": "@filetype==forumpost",
- "function": "@numberoflikes+1"
}
], - "questionMark": true,
- "rankingFunctions": [
- {
- "expression": "-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))",
- "modifier": 100,
- "normalizeWeight": true
}
], - "retrieveFirstSentences": true,
- "sortCriteria": "DateDescending",
- "sortField": "string",
- "staticQuery": true,
- "summaryLength": 0,
- "userActions": {
- "tagViewsOfUser": "string"
}, - "wildcards": true,
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "apiVersion": 2,
- "categoryFacets": [
- {
- "field": "string",
- "parentValues": [
- {
- "numberOfResults": 0,
- "value": "string"
}
], - "values": [
- {
- "numberOfResults": 0,
- "value": "string"
}
]
}
], - "duration": 1235,
- "errors": [
- "string"
], - "exception": {
- "code": "string",
- "context": "string"
}, - "extendedResults": {
- "generativeQuestionAnsweringId": "queryStream01_coveo_c784a8f6-aa62-4b24-9ca0-d6b483feaa31"
}, - "facets": [
- {
- "domain": {
- "end": "2001-07-20T23:01:05",
- "start": "2001-07-20T23:01:05"
}, - "field": "author",
- "indexScore": 0,
- "isFromAutoSelect": true,
- "label": "string",
- "mlScore": 0,
- "moreValuesAvailable": true,
- "values": [
- {
- "end": "2001-07-20T23:01:05",
- "endInclusive": true,
- "isAutoSelected": true,
- "isSuggested": true,
- "numberOfResults": 0,
- "start": "2001-07-20T23:01:05",
- "state": "idle",
- "value": "Alice Smith"
}
]
}
], - "generateAutomaticFacets": {
- "facets": [
- {
- "domain": {
- "end": "2001-07-20T23:01:05",
- "start": "2001-07-20T23:01:05"
}, - "field": "author",
- "indexScore": 0,
- "isFromAutoSelect": true,
- "label": "string",
- "mlScore": 0,
- "moreValuesAvailable": true,
- "values": [
- {
- "end": "2001-07-20T23:01:05",
- "endInclusive": true,
- "isAutoSelected": true,
- "isSuggested": true,
- "numberOfResults": 0,
- "start": "2001-07-20T23:01:05",
- "state": "idle",
- "value": "Alice Smith"
}
]
}
]
}, - "groupByResults": [
- {
- "Field": "string",
- "GlobalComputedFieldResults": [
- 0
], - "field": "@author",
- "globalComputedFieldResults": [
- 0
], - "values": [
- {
- "computedFieldResults": [
- 243.72
], - "lookupValue": "",
- "numberOfResults": 42,
- "score": 0,
- "value": "Bob Jones",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 201.82
], - "lookupValue": "",
- "numberOfResults": 37,
- "score": 0,
- "value": "Erika Miller",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 177.56
], - "lookupValue": "",
- "numberOfResults": 24,
- "score": 0,
- "value": "David Allen",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 143.92
], - "lookupValue": "",
- "numberOfResults": 11,
- "score": 0,
- "value": "Carrie Green",
- "valueType": "Standard"
}, - {
- "computedFieldResults": [
- 122.85
], - "lookupValue": "",
- "numberOfResults": 77,
- "score": 0,
- "value": "Anonymous",
- "valueType": "Standard"
}
]
}
], - "index": "mycoveocloudv2organizationid-cqjd206sta1xb9qyxfhhnsu294-Indexer-2-9rbfxhp1n07cth80ckzeh3zotc",
- "indexDuration": 1175,
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "isFallbackToAdmin": true,
- "phrasesToHighlight": {
- "cloud v2": {
- "cloud": [ ],
- "v2": [ ]
}
}, - "pipeline": "CustomerQueryPipeline",
- "queryCorrection": {
- "correctedQuery": "string",
- "corrections": [
- {
- "correctedQuery": "Coveo Cloud V2 platform",
- "wordCorrections": [
- {
- "correctedWord": "platform",
- "length": 8,
- "offset": 15,
- "originalWord": "plattfomr"
}
]
}
], - "originalQuery": "string"
}, - "queryCorrections": [ ],
- "questionAnswer": {
- "answerFound": true,
- "answerSnippet": "string",
- "documentId": {
- "contentIdKey": "string",
- "contentIdValue": "string"
}, - "question": "string",
- "raw": { },
- "relatedQuestions": [
- {
- "answerSnippet": "string",
- "documentId": {
- "contentIdKey": "string",
- "contentIdValue": "string"
}, - "question": "string",
- "score": 0
}
], - "score": 0
}, - "refinedKeywords": [
- "v2",
- "platform",
- "cloud",
- "coveo"
], - "requestDuration": 1181,
- "results": [
- {
- "ClickUri": "string",
- "Excerpt": "string",
- "FirstSentences": "string",
- "PrintableUri": "string",
- "Title": "string",
- "UniqueId": "string",
- "Uri": "string",
- "absentTerms": [
- "platform",
- "native",
- "solution"
], - "childResults": [
- { }
], - "excerpt": "... the new Coveo Cloud V2 and Coveo Cloud V1 ... the main differences between the two Coveo Cloud versions ...",
- "excerptHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "firstSentences": "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 ...",
- "firstSentencesHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "flags": "HasHtmlVersion;HasMobileHtmlVersion",
- "hasHtmlVersion": true,
- "hasMobileHtmlVersion": true,
- "isRecommendation": false,
- "isTopResult": false,
- "isUserActionView": false,
- "parentResult": { },
- "percentScore": 90.73539,
- "printableUriHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "rankingInfo": "Document weights:\nTitle: 0; Quality: 180; Date: 596; Adjacency: 0; Source: 500; Custom: 350; Collaborative rating: 0; QRE: 0; Ranking functions: 0;\n\nTotal weight: 1626",
- "rankingModifier": "TopResult",
- "rating": 3,
- "raw": {
- "adjustednumberoflikes": 46,
- "author": "Anonymous",
- "childid": 2,
- "conversationid": 898,
- "date": 1502796809427,
- "filetype": "forumpost",
- "language": [
- "English"
], - "messageid": 2
}, - "score": 1626,
- "summary": "string",
- "summaryHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "title": "Differences between Coveo Cloud V2 and V1",
- "titleHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "totalNumberOfChildResults": 0,
- "uniqueId": "84.72597$https://example.com/Root:0/Topic:898/Post:2",
}
], - "searchUid": "a0e4773c-39c3-423c-90cd-c03a640ecde5",
- "splitTestRun": "CustomerQueryPipeline-mirror-1725560351",
- "suggestedFacets": [
- {
- "field": "author",
- "values": [
- {
- "path": [
- "string"
], - "value": "string"
}
]
}
], - "termsToHighlight": {
- "cloud": [
- "clouds"
], - "coveo": [ ],
- "platform": [
- "platforms"
], - "v2": [ ]
}, - "totalCount": 250,
- "totalCountFiltered": 245,
- "triggers": [
- {
- "content": null,
- "type": "notify"
}
], - "warnings": [
- "string"
]
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
contentType | string The MIME type of the data stream to request. Default: |
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
dataStream required | string The name of the data stream to request. |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
uniqueId required | string The unique ID of the document. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
uniqueId required | string The unique ID of the document. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
{- "ClickUri": "string",
- "Excerpt": "string",
- "FirstSentences": "string",
- "PrintableUri": "string",
- "Title": "string",
- "UniqueId": "string",
- "Uri": "string",
- "absentTerms": [
- "platform",
- "native",
- "solution"
], - "childResults": [
- { }
], - "excerpt": "... the new Coveo Cloud V2 and Coveo Cloud V1 ... the main differences between the two Coveo Cloud versions ...",
- "excerptHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "firstSentences": "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 ...",
- "firstSentencesHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "flags": "HasHtmlVersion;HasMobileHtmlVersion",
- "hasHtmlVersion": true,
- "hasMobileHtmlVersion": true,
- "isRecommendation": false,
- "isTopResult": false,
- "isUserActionView": false,
- "parentResult": { },
- "percentScore": 90.73539,
- "printableUriHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "rankingInfo": "Document weights:\nTitle: 0; Quality: 180; Date: 596; Adjacency: 0; Source: 500; Custom: 350; Collaborative rating: 0; QRE: 0; Ranking functions: 0;\n\nTotal weight: 1626",
- "rankingModifier": "TopResult",
- "rating": 3,
- "raw": {
- "adjustednumberoflikes": 46,
- "author": "Anonymous",
- "childid": 2,
- "conversationid": 898,
- "date": 1502796809427,
- "filetype": "forumpost",
- "language": [
- "English"
], - "messageid": 2
}, - "score": 1626,
- "summary": "string",
- "summaryHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "title": "Differences between Coveo Cloud V2 and V1",
- "titleHighlights": [
- {
- "length": 5,
- "offset": 15
}
], - "totalNumberOfChildResults": 0,
- "uniqueId": "84.72597$https://example.com/Root:0/Topic:898/Post:2",
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
Executes a facet search request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
field required | string The name of the field against which to execute the facet search request. |
basePath | Array of strings The shared base path for all values in the facet to search against. If a |
object A dictionary that maps index field values to facet value display names. Note: When specifying display captions for hierarchical facet values, you can use full values (e.g., Examples:
| |
delimitingCharacter | string The character to use to split field values into a hierarchical sequence. Example: For a multi-value field containing the following values:
The delimiting character is For a hierarchical field containing the following values:
The delimiting character is Default: |
filterFacetCount | boolean Whether to exclude folded result parents when estimating the result count for each facet value. Note: The target folding field must be a facet field with the Use cache for nested queries options enabled (see Add or Edit a Field). Default: |
ignorePaths | Array of strings[ items ] A list of paths to filter out from the hierarchical facet search results. |
numberOfValues | integer <int32> Default: 10 The maximum number of values to fetch. **Default: |
query | string The string to match. Note: Typically, this should be set to the text entered by the end-user in the facet search box, to which one or more wildcard characters ( |
object (RestQueryParameters) | |
type | string The kind of facet against which the search request is being made. Allowed values:
Default: |
{- "basePath": [
- "Doors",
- "Metal"
], - "captions": {
- "acme_productA": "ACME Product A",
- "acme_productB": "ACME Product B"
}, - "delimitingCharacter": "string",
- "field": "color",
- "filterFacetCount": [
- [
- "Electronics",
- "Entertainment",
- "Gaming Consoles"
], - [
- "Appliances",
- "Kitchen"
]
], - "ignorePaths": [
- [
- "string"
]
], - "numberOfValues": 10,
- "query": "*oran*",
- "searchContext": {
- "aq": "@year==2017",
- "categoryFacets": [
- {
- "delimitingCharacter": ">",
- "field": "@categories",
- "filterFacetCount": true,
- "injectionDepth": 1500,
- "maximumNumberOfValues": 5,
- "path": [
- "Doors",
- "Metal"
]
}
], - "childField": "@foldingparent",
- "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "cq": "@documenttype==forumpost",
- "dictionaryFieldContext": {
- "price": "storeA"
}, - "disableQuerySyntax": false,
- "dq": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "enableCollaborativeRating": false,
- "enableDidYouMean": true,
- "enableDuplicateFiltering": true,
- "enableMLDidYouMean": true,
- "enableQuerySyntax": true,
- "excerptLength": 250,
- "facetOptions": {
- "enableIndexFacetOrdering": true,
- "freezeFacetOrder": false
}, - "facets": [
- {
- "facetId": "author-1",
- "field": "author",
- "filterFacetCount": true,
- "injectionDepth": 1000,
- "isFieldExpanded": false,
- "preventAutoSelect": false,
- "resultsMustMatch": "atLeastOneValue",
- "type": "specific",
- "allowedValues": {
- "type": "simple",
- "values": [
- "Anonymous",
- "Bob Jones"
]
}, - "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "customSort": [
- "Simple",
- "Twin",
- "Queen",
- "King"
], - "freezeCurrentValues": false,
- "numberOfValues": 8,
- "sortCriteria": "string"
}
], - "fieldsToExclude": [
- "documenttype",
- "size",
- "source"
], - "fieldsToInclude": [
- "clickableuri",
- "author",
- "date",
- "filetype",
- "language",
- "conversationid",
- "messageid",
- "childid",
- "adjustednumberoflikes"
], - "filterField": "@foldingcollection",
- "filterFieldRange": 8,
- "firstResult": 2,
- "generateAutomaticFacets": {
- "currentFacets": [
- {
- "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "field": "author",
- "label": "string",
- "type": "specific"
}
], - "desiredCount": 20,
- "fields": {
- "toExclude": [
- "string"
], - "toInclude": [
- "string"
]
}, - "generationStrategy": "mostRelevant",
- "numberOfValues": 8
}, - "groupBy": [
- {
- "advancedQueryOverride": "@year==2017",
- "allowedValues": [
- "Anonymous",
- "Bob Jones",
- "Carrie Green",
- "David Allen"
], - "allowedValuesPatternType": "wildcards",
- "completeFacetWithStandardValues": true,
- "computedFields": [
- {
- "field": "@wordcount",
- "operation": "average"
}
], - "constantQueryOverride": "@filetype==forumpost",
- "disjunctionQueryOverride": "@date=2016-12-01..2016-12-31",
- "field": "@author",
- "filterFacetCount": true,
- "generateAutomaticRanges": false,
- "injectionDepth": 1500,
- "lookupField": "string",
- "maximumNumberOfValues": 5,
- "queryOverride": "Coveo Cloud V2 platform",
- "rangeValues": [ ],
- "sortCriteria": "ComputedFieldDescending",
- "thoroughLookup": false
}
], - "lowercaseOperators": false,
- "lq": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "lqPartialMatchKeywords": 4,
- "lqPartialMatchMaxKeywords": 20,
- "lqPartialMatchThreshold": "75%",
- "mlDidYouMeanMaxCandidates": 5,
- "mlDidYouMeanMinScore": 0.8,
- "mlDidYouMeanUseFacetCount": true,
- "numberOfResults": 5,
- "parentField": "@foldingchild",
- "partialMatch": true,
- "partialMatchKeywords": 4,
- "partialMatchThreshold": "75%",
- "q": "Coveo \"Cloud V2\" platform",
- "queryCorrection": {
- "enabled": true,
- "options": {
- "automaticallyCorrect": "never"
}
}, - "queryFunctions": [
- {
- "allowMissingFields": false,
- "fieldName": "numberoflikesplusone",
- "filter": "@filetype==forumpost",
- "function": "@numberoflikes+1"
}
], - "questionMark": true,
- "rankingFunctions": [
- {
- "expression": "-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))",
- "modifier": 100,
- "normalizeWeight": true
}
], - "retrieveFirstSentences": true,
- "sortCriteria": "DateDescending",
- "sortField": "string",
- "staticQuery": true,
- "summaryLength": 0,
- "userActions": {
- "tagViewsOfUser": "string"
}, - "wildcards": true,
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}, - "type": "hierarchical"
}
{- "moreValuesAvailable": true,
- "values": [
- {
- "count": 0,
- "displayValue": "Orange",
- "rawValue": "#FF8000"
}
]
}
Gets all fields in the target Coveo Cloud organization.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
{- "fields": [
- {
- "defaultValue": "",
- "description": "",
- "fieldSourceType": "System",
- "fieldType": "LargeString",
- "groupByField": false,
- "includeInQuery": false,
- "includeInResults": false,
- "name": "@author",
- "nativeName": "author",
- "sortByField": false,
- "splitGroupByField": false,
- "type": "text"
}
]
}
Find fields name from results matching the q
expression.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"VIEW_ALL_CONTENT","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The query to get the fields from.
object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the | |
q | string Default: "" The basic query expression, typically the keywords entered by the end user in a query box. |
{- "dictionaryFieldContext": {
- "price": "storeA"
}, - "q": "Coveo \"Cloud V2\" platform"
}
{- "fields": [
- {
- "name": "@author"
}
]
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
Array of objects (ActionHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
aq | string The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the |
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |
childField | string The Use a field whose value points to the See also the Notes:
|
object (RestCommerceParameters) The parameters for Coveo for Commerce. | |
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
cq | string 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. Notes:
|
debug | boolean Whether to force a successful response to include debug information. Notes:
Default: |
dictionaryFieldContext | object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the Note: This cannot be used at the same time as Note: This parameter will be overridden if the search request is authenticated by a search token that enforces a specific |
disableQuerySyntax | boolean Deprecated This parameter is exposed for backward compatibility reasons. Use the |
dq | string The disjunction query expression, typically populated by Coveo ML automatic relevance tuning models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an |
enableCollaborativeRating | boolean Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: |
enableDidYouMean | boolean Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: |
enableDuplicateFiltering | boolean Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: |
enableMLDidYouMean | boolean Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: |
enableNavigation | boolean |
enableQuerySyntax | boolean Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: |
excerptLength | integer <int32> The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: |
object or null (RestFacetOptions) The global configuration options that apply to all facet requests performed along with the query (see the | |
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the |
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the |
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes:
|
filterFieldRange | integer <int32> The maximum number of items to include in the See also the Notes:
Default: |
findNext | integer <int32> |
findPrevious | integer <int32> |
firstResult | integer <int32> The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: |
format | string The format of a successful response.
Note: Debug information (see the Default: |
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
isGuestUser | boolean Whether the current user is anonymous. Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the Default: |
language | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lowercaseOperators | boolean Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: |
lq | string The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the |
lqPartialMatchKeywords | integer <int32> The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: |
lqPartialMatchMaxKeywords | integer Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default: |
lqPartialMatchThreshold | string An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: |
maximumAge | integer <int32> 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer <int32> The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlDidYouMeanMaxCandidates | integer <int32> The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: |
mlDidYouMeanMinScore | number <double> The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: |
mlDidYouMeanUseFacetCount | boolean Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: |
mlParameters | object A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
numberOfResults | integer <int32> >= 0 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> |
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
|
partialMatch | boolean Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: |
partialMatchKeywords | integer <int32> The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: |
partialMatchThreshold | string An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
q | string 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 |
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: |
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |
recommendation | string The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
requestedOutputSize | integer <int32> The approximate number of bytes to request in the HTML response. Default: |
retrieveFirstSentences | boolean Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: |
searchHub | string 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:
See also the |
sortCriteria | string The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria which will be applied sequentially, i.e., if there's a tie on the 1st criterion, the API uses the 2nd criterion to break the tie. However, this only works when combining:
Examples:
Default: |
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
staticQuery | boolean Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: |
summaryLength | integer <int32> The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: |
tab | string 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
|
timezone | string 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 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. |
uniqueId required | string The unique ID of the document. |
object (RestUserActionParameter) The parameters allowing user actions to be retrieved in query results. | |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
visitorId | string Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
wildcards | boolean Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
enableNavigation | boolean |
findNext | integer <int32> |
findPrevious | integer <int32> |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> |
requestedOutputSize | integer <int32> The approximate number of bytes to request in the HTML response. Default: |
uniqueId required | string The unique ID of the document. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
aq | string (AQ) The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the |
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |
childField | string The Use a field whose value points to the See also the Notes:
|
object | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
cq | string (CQ) 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. Notes:
|
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the | |
disableQuerySyntax | boolean Deprecated Default: false This parameter is exposed for backward compatibility reasons. Use the |
dq | string (DQ) The disjunction query expression, typically populated by Coveo ML Automatic Relevance Tuning (ART) models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an |
enableCollaborativeRating | boolean Default: false Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: |
enableDidYouMean | boolean Default: false Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: |
enableDuplicateFiltering | boolean Default: false Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: |
enableMLDidYouMean | boolean Default: false Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: |
enableQuerySyntax | boolean Default: true Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: |
excerptLength | integer <int32> Default: 200 The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: |
object or null (RestFacetOptions) | |
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the |
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the |
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes::
|
filterFieldRange | integer <int32> Default: 5 The maximum number of items to include in the See also the Notes::
Default: |
firstResult | integer <int32> Default: 0 The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
object Generate facets based on the most relevant fields in the index. | |
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lowercaseOperators | boolean Default: false Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: |
lq | string (LQ) The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the |
lqPartialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: |
lqPartialMatchMaxKeywords | integer <int32> Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default value: |
lqPartialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlDidYouMeanMaxCandidates | integer <int32> Default: 3 The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: |
mlDidYouMeanMinScore | number <double> Default: 1 The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: |
mlDidYouMeanUseFacetCount | boolean Default: false Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
numberOfResults | integer <int32> >= 0 Default: 10 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: |
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
|
partialMatch | boolean Default: false Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: |
partialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: |
partialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: |
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
q | string (Q) 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 |
object This parameter controls the behavior of the Coveo query correction feature. Once enabled, this feature will:
Query corrections are derived from the index's Did You Mean feature and ML query corrections. Correction information will be returned in the If the query was automatically corrected, it will return:
Otherwise, it will return:
This feature is off by default for backward compatiblity reasons. | |
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: |
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
retrieveFirstSentences | boolean Default: false Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: |
searchHub | string or null (SearchHub) 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:
See also the |
sortCriteria | string Default: "Relevancy" The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria. However, this only works when combining:
Examples:
Default: |
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
staticQuery | boolean Default: false Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: |
summaryLength | integer <int32> Default: 0 The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
object (RestUserActionParameter) | |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
wildcards | boolean Default: false Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
{- "aq": "@year==2017",
- "categoryFacets": [
- {
- "delimitingCharacter": ">",
- "field": "@categories",
- "filterFacetCount": true,
- "injectionDepth": 1500,
- "maximumNumberOfValues": 5,
- "path": [
- "Doors",
- "Metal"
]
}
], - "childField": "@foldingparent",
- "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "cq": "@documenttype==forumpost",
- "dictionaryFieldContext": {
- "price": "storeA"
}, - "disableQuerySyntax": false,
- "dq": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "enableCollaborativeRating": false,
- "enableDidYouMean": true,
- "enableDuplicateFiltering": true,
- "enableMLDidYouMean": true,
- "enableQuerySyntax": true,
- "excerptLength": 250,
- "facetOptions": {
- "enableIndexFacetOrdering": true,
- "freezeFacetOrder": false
}, - "facets": [
- {
- "facetId": "author-1",
- "field": "author",
- "filterFacetCount": true,
- "injectionDepth": 1000,
- "isFieldExpanded": false,
- "preventAutoSelect": false,
- "resultsMustMatch": "atLeastOneValue",
- "type": "specific",
- "allowedValues": {
- "type": "simple",
- "values": [
- "Anonymous",
- "Bob Jones"
]
}, - "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "customSort": [
- "Simple",
- "Twin",
- "Queen",
- "King"
], - "freezeCurrentValues": false,
- "numberOfValues": 8,
- "sortCriteria": "string"
}
], - "fieldsToExclude": [
- "documenttype",
- "size",
- "source"
], - "fieldsToInclude": [
- "clickableuri",
- "author",
- "date",
- "filetype",
- "language",
- "conversationid",
- "messageid",
- "childid",
- "adjustednumberoflikes"
], - "filterField": "@foldingcollection",
- "filterFieldRange": 8,
- "firstResult": 2,
- "generateAutomaticFacets": {
- "currentFacets": [
- {
- "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "field": "author",
- "label": "string",
- "type": "specific"
}
], - "desiredCount": 20,
- "fields": {
- "toExclude": [
- "string"
], - "toInclude": [
- "string"
]
}, - "generationStrategy": "mostRelevant",
- "numberOfValues": 8
}, - "groupBy": [
- {
- "advancedQueryOverride": "@year==2017",
- "allowedValues": [
- "Anonymous",
- "Bob Jones",
- "Carrie Green",
- "David Allen"
], - "allowedValuesPatternType": "wildcards",
- "completeFacetWithStandardValues": true,
- "computedFields": [
- {
- "field": "@wordcount",
- "operation": "average"
}
], - "constantQueryOverride": "@filetype==forumpost",
- "disjunctionQueryOverride": "@date=2016-12-01..2016-12-31",
- "field": "@author",
- "filterFacetCount": true,
- "generateAutomaticRanges": false,
- "injectionDepth": 1500,
- "lookupField": "string",
- "maximumNumberOfValues": 5,
- "queryOverride": "Coveo Cloud V2 platform",
- "rangeValues": [ ],
- "sortCriteria": "ComputedFieldDescending",
- "thoroughLookup": false
}
], - "lowercaseOperators": false,
- "lq": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "lqPartialMatchKeywords": 4,
- "lqPartialMatchMaxKeywords": 20,
- "lqPartialMatchThreshold": "75%",
- "mlDidYouMeanMaxCandidates": 5,
- "mlDidYouMeanMinScore": 0.8,
- "mlDidYouMeanUseFacetCount": true,
- "numberOfResults": 5,
- "parentField": "@foldingchild",
- "partialMatch": true,
- "partialMatchKeywords": 4,
- "partialMatchThreshold": "75%",
- "q": "Coveo \"Cloud V2\" platform",
- "queryCorrection": {
- "enabled": true,
- "options": {
- "automaticallyCorrect": "never"
}
}, - "queryFunctions": [
- {
- "allowMissingFields": false,
- "fieldName": "numberoflikesplusone",
- "filter": "@filetype==forumpost",
- "function": "@numberoflikes+1"
}
], - "questionMark": true,
- "rankingFunctions": [
- {
- "expression": "-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))",
- "modifier": 100,
- "normalizeWeight": true
}
], - "retrieveFirstSentences": true,
- "sortCriteria": "DateDescending",
- "sortField": "string",
- "staticQuery": true,
- "summaryLength": 0,
- "userActions": {
- "tagViewsOfUser": "string"
}, - "wildcards": true,
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
Directs the browser to URI of the target Search API authentication provider, and back to the origin search page once the authentication process is complete. This authentication provider must be properly configured in the Coveo Cloud organization.
provider required | string The name of the Search API authentication provider to log in to. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
Directs the browser to URI of the target Search API authentication provider, and back to the origin search page once the authentication process is complete. This authentication provider must be properly configured in the Coveo Cloud organization.
provider required | string Example: My SharePoint Server The name of the Search API authentication provider to log in to. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
See Performing a Query.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
Array of objects (ActionHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
aq | string The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the |
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |
childField | string The Use a field whose value points to the See also the Notes:
|
object (RestCommerceParameters) The parameters for Coveo for Commerce. | |
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
cq | string 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. Notes:
|
debug | boolean Whether to force a successful response to include debug information. Notes:
Default: |
dictionaryFieldContext | object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the Note: This cannot be used at the same time as Note: This parameter will be overridden if the search request is authenticated by a search token that enforces a specific |
disableQuerySyntax | boolean Deprecated This parameter is exposed for backward compatibility reasons. Use the |
dq | string The disjunction query expression, typically populated by Coveo ML automatic relevance tuning models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an |
enableCollaborativeRating | boolean Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: |
enableDidYouMean | boolean Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: |
enableDuplicateFiltering | boolean Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: |
enableMLDidYouMean | boolean Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: |
enableQuerySyntax | boolean Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: |
excerptLength | integer <int32> The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: |
object or null (RestFacetOptions) The global configuration options that apply to all facet requests performed along with the query (see the | |
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the |
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the |
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes:
|
filterFieldRange | integer <int32> The maximum number of items to include in the See also the Notes:
Default: |
firstResult | integer <int32> The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: |
format | string The format of a successful response.
Note: Debug information (see the Default: |
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
isGuestUser | boolean Whether the current user is anonymous. Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the Default: |
language | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lowercaseOperators | boolean Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: |
lq | string The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the |
lqPartialMatchKeywords | integer <int32> The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: |
lqPartialMatchMaxKeywords | integer Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default: |
lqPartialMatchThreshold | string An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: |
maximumAge | integer <int32> 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer <int32> The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlDidYouMeanMaxCandidates | integer <int32> The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: |
mlDidYouMeanMinScore | number <double> The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: |
mlDidYouMeanUseFacetCount | boolean Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: |
mlParameters | object A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
numberOfResults | integer <int32> >= 0 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
|
partialMatch | boolean Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: |
partialMatchKeywords | integer <int32> The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: |
partialMatchThreshold | string An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
q | string 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 |
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: |
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |
recommendation | string The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
retrieveFirstSentences | boolean Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: |
searchHub | string 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:
See also the |
sortCriteria | string The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria which will be applied sequentially, i.e., if there's a tie on the 1st criterion, the API uses the 2nd criterion to break the tie. However, this only works when combining:
Examples:
Default: |
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
staticQuery | boolean Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: |
summaryLength | integer <int32> The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: |
tab | string 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
|
timezone | string 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 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. |
object (RestUserActionParameter) The parameters allowing user actions to be retrieved in query results. | |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
visitorId | string Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
wildcards | boolean Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
{- "parsedInput": {
- "advancedExpression": "@year==2017",
- "basicExpression": "Coveo \"Cloud V2\" platform",
- "constantExpression": "@documenttype==forumpost",
- "disjunctionExpression": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "largeExpression": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "mandatoryExpression": "@source==KnowledgeBase"
}, - "preprocessingOutput": {
- "triggers": [
- {
- "property1": null,
- "property2": null
}
]
}
}
See Performing a Query.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
aq | string (AQ) The advanced query expression, typically generated by code (e.g., when toggling facet values). Note: When logging a Search usage analytics event for a query, the |
Array of objects (RestCategoryFacetRequest) Data to easily query a hierarchical field using a path of hierarchical values. | |
childField | string The Use a field whose value points to the See also the Notes:
|
object | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
cq | string (CQ) 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. Notes:
|
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the | |
disableQuerySyntax | boolean Deprecated Default: false This parameter is exposed for backward compatibility reasons. Use the |
dq | string (DQ) The disjunction query expression, typically populated by Coveo ML Automatic Relevance Tuning (ART) models to ensure that relevant items are included in the query results. The disjunction query expression is merged with the other parts of the query expression using an |
enableCollaborativeRating | boolean Default: false Whether to allow the end user to assign an arbitrary 0-5 star rating to each individual query result item. You need to contact Coveo support if you want to enable this feature in your index. Otherwise, setting Tip: Coveo Machine Learning automatic relevance tuning models provides a much more reliable way to boost query result items based on end user interaction. Default: |
enableDidYouMean | boolean Default: false Whether to enable the Did You Mean feature of the index, which populates the Notes:
Default: |
enableDuplicateFiltering | boolean Default: false Whether to filter out duplicates, so that items resembling one another only appear once in the query results. Notes:
Default: |
enableMLDidYouMean | boolean Default: false Important: This feature is still in an experimental state. Whether to enable the Coveo ML query suggestions Did You Mean feature, which populates the Notes:
Default: |
enableQuerySyntax | boolean Default: true Whether to interpret advanced Coveo Cloud query syntax as such in the basic query expression (see the Default: |
excerptLength | integer <int32> Default: 200 The maximum length of result excerpts (in number of characters). An excerpt is a segmented text generated at query time by the index from the body of an item. When a query is performed, the excerpt yields relevant item body sections in which the queried terms are highlighted. An excerpt includes the most relevant sentences in which the queried keywords appear, in the order in which they appear in the item, up to the specified number of characters. Note: The maximum length you set using this parameter also applies to retrieved first sentences, if those are included in the results (see the Default: |
object or null (RestFacetOptions) | |
Array of any (RestFacetRequest) The facet operations to perform on the query results. | |
fieldsToExclude | Array of strings The names of the fields to exclude from the query results. All other fields will be included with each item in the query result. Note: If you specify both an array of fields to include (see the If you do not explicitly specify an array of values for this parameter (or for the |
fieldsToInclude | Array of strings 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 If you do not explicitly specify an array of values for this parameter (or for the |
filterField | string The Use a field whose value is identical for all items to group under the same folded query result. See also the Notes::
|
filterFieldRange | integer <int32> Default: 5 The maximum number of items to include in the See also the Notes::
Default: |
firstResult | integer <int32> Default: 0 The 0-based position of the first result to return in the non-paginated result set. Along with the Note: This can't be greater than the Default: |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
object Generate facets based on the most relevant fields in the index. | |
Array of objects (RestGroupBy) The Group By operations to perform on the query results, typically to extract facets. | |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lowercaseOperators | boolean Default: false Whether to treat the Note: Setting this parameter to Example: If you set this parameter, and the Default: |
lq | string (LQ) The large query expression, typically populated with a case description, long textual query, or any other form of text that can help refine a query. The Coveo ML Intelligent Term Detection (ITD) feature can extract relevant keywords from the large query expression and inject those keywords in the basic query expression (see the |
lqPartialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Default: |
lqPartialMatchMaxKeywords | integer <int32> Default: 100 The maximum number of keywords from the large query expression (see the Note: This parameter applies as a fallback setting when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( Setting this parameter to a high value can negatively impact the performance of queries, while setting it too low can produce less relevant results. See also the Default value: |
lqPartialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number of partial match expression keywords an item must contain to match the large query expression in case the Coveo ML Intelligent Term Detection (ITD) feature cannot extract relevant keywords from the large query expression. If specified, the
The Note: This parameter applies when no Coveo ML automatic relevance tuning model is available in the query pipeline to process a query that contains a non-null large query expression ( See also the Examples:
Default: |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlDidYouMeanMaxCandidates | integer <int32> Default: 3 The maximum number of Coveo ML Did You Mean candidates to request from the query suggestions model. Default: |
mlDidYouMeanMinScore | number <double> Default: 1 The minimum score a query suggestion may have to be allowed as a candidate for the Coveo ML query suggestions Did You Mean feature. For best results, value should typically be in range [ Default: |
mlDidYouMeanUseFacetCount | boolean Default: false Whether to use facet counts for the Coveo ML Did You Mean feature. Can improve results, but requires more processing. Default: |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
numberOfResults | integer <int32> >= 0 Default: 10 The number of results to return. Along with the This parameter also defines the maximum number of results which can be returned by the Coveo ML Recommendations feature. Note: The maximum Default: |
parentField | string The Use a field whose value can uniquely identify each item. All items whose See also the Notes:
|
partialMatch | boolean Default: false Whether to convert a basic expression containing at least If you do not set this parameter to Notes:
Default: |
partialMatchKeywords | integer <int32> Default: 5 The minimum number of keywords that need to be present in a basic expression to convert it to a partial match expression. Notes:
See also the Default: |
partialMatchThreshold | string Default: "50%" An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression. If specified, the
The Notes:
See also the Examples:
Default: |
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
q | string (Q) 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 |
object This parameter controls the behavior of the Coveo query correction feature. Once enabled, this feature will:
Query corrections are derived from the index's Did You Mean feature and ML query corrections. Correction information will be returned in the If the query was automatically corrected, it will return:
Otherwise, it will return:
This feature is off by default for backward compatiblity reasons. | |
Array of objects (RestQueryFunction) The array of query functions to execute on each query result item. The result of a query function is stored in a temporary, dynamic field created at query time. | |
questionMark | boolean Default: false Whether to enable question mark characters ( Note: Setting this parameter to See Using Wildcards in Queries. Default: |
Array of objects (RestRankingFunction) The array of ranking functions to execute on each query result item. The result of a ranking function is added to the result score, which can affect sorting (see the | |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
retrieveFirstSentences | boolean Default: false Whether to include the first sentences of textual items in the query results. First sentences are typically useful when rendering result items such as emails, since the first few sentences of these kinds of items are often more relevant than a contextually generated excerpt (see the Note: The maximum length of the retrieved sentences (in number of characters) is determined by the value of the Default: |
searchHub | string or null (SearchHub) 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:
See also the |
sortCriteria | string Default: "Relevancy" The criteria to use for sorting the query results. Allowed values:
You can specify a list of comma-separated sort criteria. However, this only works when combining:
Examples:
Default: |
sortField | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
staticQuery | boolean Default: false Whether to execute this query in a way that does not count against the allowed number of queries per month of a Coveo Cloud organization (QPM), but may produce cached/outdated query results (see Rendering Static Content Using Persistent Queries). Note: Setting this parameter to Default: |
summaryLength | integer <int32> Default: 0 The length of the automatically generated item summary. The Coveo Platform uses a linguistic algorithm that relies on term frequency and proximity to generate an item summary made of sentences identified to be the most important ones in the item. This summary is generated independently from the query, as opposed to a result item excerpt, which is generated based on query keywords. Default: |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
object (RestUserActionParameter) | |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
wildcards | boolean Default: false Whether to enable the wildcards feature of the index in order to expand basic expression keywords (see the See Using Wildcards in Queries. Default: |
{- "aq": "@year==2017",
- "categoryFacets": [
- {
- "delimitingCharacter": ">",
- "field": "@categories",
- "filterFacetCount": true,
- "injectionDepth": 1500,
- "maximumNumberOfValues": 5,
- "path": [
- "Doors",
- "Metal"
]
}
], - "childField": "@foldingparent",
- "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "cq": "@documenttype==forumpost",
- "dictionaryFieldContext": {
- "price": "storeA"
}, - "disableQuerySyntax": false,
- "dq": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "enableCollaborativeRating": false,
- "enableDidYouMean": true,
- "enableDuplicateFiltering": true,
- "enableMLDidYouMean": true,
- "enableQuerySyntax": true,
- "excerptLength": 250,
- "facetOptions": {
- "enableIndexFacetOrdering": true,
- "freezeFacetOrder": false
}, - "facets": [
- {
- "facetId": "author-1",
- "field": "author",
- "filterFacetCount": true,
- "injectionDepth": 1000,
- "isFieldExpanded": false,
- "preventAutoSelect": false,
- "resultsMustMatch": "atLeastOneValue",
- "type": "specific",
- "allowedValues": {
- "type": "simple",
- "values": [
- "Anonymous",
- "Bob Jones"
]
}, - "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "customSort": [
- "Simple",
- "Twin",
- "Queen",
- "King"
], - "freezeCurrentValues": false,
- "numberOfValues": 8,
- "sortCriteria": "string"
}
], - "fieldsToExclude": [
- "documenttype",
- "size",
- "source"
], - "fieldsToInclude": [
- "clickableuri",
- "author",
- "date",
- "filetype",
- "language",
- "conversationid",
- "messageid",
- "childid",
- "adjustednumberoflikes"
], - "filterField": "@foldingcollection",
- "filterFieldRange": 8,
- "firstResult": 2,
- "generateAutomaticFacets": {
- "currentFacets": [
- {
- "currentValues": [
- {
- "preventAutoSelect": false,
- "state": "idle",
- "value": "Alice Smith"
}
], - "field": "author",
- "label": "string",
- "type": "specific"
}
], - "desiredCount": 20,
- "fields": {
- "toExclude": [
- "string"
], - "toInclude": [
- "string"
]
}, - "generationStrategy": "mostRelevant",
- "numberOfValues": 8
}, - "groupBy": [
- {
- "advancedQueryOverride": "@year==2017",
- "allowedValues": [
- "Anonymous",
- "Bob Jones",
- "Carrie Green",
- "David Allen"
], - "allowedValuesPatternType": "wildcards",
- "completeFacetWithStandardValues": true,
- "computedFields": [
- {
- "field": "@wordcount",
- "operation": "average"
}
], - "constantQueryOverride": "@filetype==forumpost",
- "disjunctionQueryOverride": "@date=2016-12-01..2016-12-31",
- "field": "@author",
- "filterFacetCount": true,
- "generateAutomaticRanges": false,
- "injectionDepth": 1500,
- "lookupField": "string",
- "maximumNumberOfValues": 5,
- "queryOverride": "Coveo Cloud V2 platform",
- "rangeValues": [ ],
- "sortCriteria": "ComputedFieldDescending",
- "thoroughLookup": false
}
], - "lowercaseOperators": false,
- "lq": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "lqPartialMatchKeywords": 4,
- "lqPartialMatchMaxKeywords": 20,
- "lqPartialMatchThreshold": "75%",
- "mlDidYouMeanMaxCandidates": 5,
- "mlDidYouMeanMinScore": 0.8,
- "mlDidYouMeanUseFacetCount": true,
- "numberOfResults": 5,
- "parentField": "@foldingchild",
- "partialMatch": true,
- "partialMatchKeywords": 4,
- "partialMatchThreshold": "75%",
- "q": "Coveo \"Cloud V2\" platform",
- "queryCorrection": {
- "enabled": true,
- "options": {
- "automaticallyCorrect": "never"
}
}, - "queryFunctions": [
- {
- "allowMissingFields": false,
- "fieldName": "numberoflikesplusone",
- "filter": "@filetype==forumpost",
- "function": "@numberoflikes+1"
}
], - "questionMark": true,
- "rankingFunctions": [
- {
- "expression": "-sqrt(dist(@longitude, @latitude, 46.8167, -71.2167))",
- "modifier": 100,
- "normalizeWeight": true
}
], - "retrieveFirstSentences": true,
- "sortCriteria": "DateDescending",
- "sortField": "string",
- "staticQuery": true,
- "summaryLength": 0,
- "userActions": {
- "tagViewsOfUser": "string"
}, - "wildcards": true,
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "parsedInput": {
- "advancedExpression": "@year==2017",
- "basicExpression": "Coveo \"Cloud V2\" platform",
- "constantExpression": "@documenttype==forumpost",
- "disjunctionExpression": "@permanentid=aadd702687c62910d6da8347304ec2cedfd0b06d5b4d2794a555ce5688bd",
- "largeExpression": "I am looking for an enterprise-class native cloud SaaS/PaaS solution that provides a unified and secure way to search for contextually relevant content across multiple enterprise systems.",
- "mandatoryExpression": "@source==KnowledgeBase"
}, - "preprocessingOutput": {
- "triggers": [
- {
- "property1": null,
- "property2": null
}
]
}
}
See Getting Query Suggestions.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
Array of objects (ActionHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
additionalData | object Deprecated This parameter is exposed for backward compatibility reasons. |
object or null (AnalyticsRequestParameters) | |
autoCompleter | string Deprecated This parameter is exposed for backward compatibility reasons. |
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
count | integer <int32> The desired number of query suggestions. |
debug | boolean Whether to force a successful response to include debug information. Notes:
Default: |
enableWordCompletion | boolean Whether to attempt to complete the last word of the current basic query expression (see the |
format | string The format of a successful response.
Note: Debug information (see the Default: |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
isGuestUser | boolean Whether the current user is anonymous. Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the Default: |
language | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
maximumAge | integer <int32> 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer <int32> The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
q | string Example: q=Coveo "Cloud V2" platform The basic query expression, typically the keywords entered by the end user in a query box. |
recommendation | string The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
visitorId | string Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "completions": [
- {
- "executableConfidence": 0.9,
- "expression": "brown boot",
- "highlighted": "(brown) [boot]",
- "objectId": "9919344e-c495-4620-b0c1-ec2cb721f96e",
- "score": 61.04
}
], - "responseId": "e1a4c9dd-71d2-4e68-9589-11bc3e640da0"
}
See Getting Query Suggestions.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
autoCompleter | string Deprecated This parameter is exposed for backward compatibility reasons. |
object (RestCommerceParameters) | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
count | integer <int32> The desired number of query suggestions. |
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
enableWordCompletion | boolean Whether to attempt to complete the last word of the current basic query expression (see the |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
q | string The basic query expression, typically the keywords entered by the end user in a query box. |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string or null (SearchHub) 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:
See also the |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "autoCompleter": "string",
- "count": 0,
- "enableWordCompletion": true,
- "q": "Coveo \"Cloud V2\" platform",
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "completions": [
- {
- "executableConfidence": 0.9,
- "expression": "brown boot",
- "highlighted": "(brown) [boot]",
- "objectId": "9919344e-c495-4620-b0c1-ec2cb721f96e",
- "score": 61.04
}
], - "responseId": "e1a4c9dd-71d2-4e68-9589-11bc3e640da0"
}
The Coveo Cloud V2 platform does not support collaborative rating. Therefore, this operation is obsolete in Coveo Cloud V2.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
rating required | string The rate to be updated. |
uniqueId required | string The unique ID of the document. |
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
uniqueId required | string The unique ID of the document. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
Creates a temporary JSON web token which can be used to impersonate one or several security identities when authenticating a query (see Search Token Authentication).
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"IMPERSONATE_SEARCH_API","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The search token information.
required | Array of objects (RestUserId) The security identities to impersonate when authenticating a query with this search token. |
canSeeUserProfileOf | Array of strings The Note: This property is meant to be used when generating search tokens for users requiring contextual information about other users to improve search relevance (e.g., support agents using an insight panel). |
object (CommerceParameters) | |
dictionaryFieldContext | object The dictionary field context to enforce when authenticating a query with this search token.
This value will override the A dictionary field context is a key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. For example, suppose that in your index, the Note: This cannot be used at the same time as |
filter | string The filter query expression to apply when authenticating a query with this search token. This expression will be merged with the constant part of the query expression ( The filter can also be used in query pipeline condition statements (e.g., |
licenseDefinitionKey | string Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
pipeline | string The name of the query pipeline to use when authenticating a query with this search token. This query pipeline will take precedence over the possible output of all other query pipeline routing mechanisms when using this search token (see Query Pipeline Routing Mechanisms and Rules). |
salesforceCommunityUrl | string Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
salesforceFallbackToAdmin | boolean Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
salesforceOrganizationId | string Internal: The ID of Salesforce organization, used to differentiate Salesforce organizations linked to the same Coveo organization. |
salesforceUser | string Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
scope | integer <int32> Deprecated This property is exposed for backward compatibility reasons only. |
searchHub | string The name of the search hub to enforce when authenticating a query with this search token. This value will override the The search hub can also be used in query pipeline condition statements (e.g., |
superUserToken | string Deprecated This property is exposed for backward compatibility reasons only. |
userDisplayName | string The This information is leveraged in the Analytics section of the Coveo Cloud administration console. |
userGroups | Array of strings The This information is leveraged in the Analytics section of the Coveo Cloud administration console. User groups can be also be used in query pipeline condition statements (e.g., |
usertype | string Internal: This property is exposed for internal use by the Coveo for Salesforce integration. |
validFor | integer <int32> Default: 86400000 The number of milliseconds the search token will remain valid for once it has been created. Minimum value: Maximum/default: |
{- "canSeeUserProfileOf": [
- "bjones@acme.com",
- "dmoore@acme.com"
], - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "string"
}, - "dictionaryFieldContext": { },
- "filter": "@source==KnowledgeBase",
- "licenseDefinitionKey": "string",
- "pipeline": "InternalSearch",
- "salesforceCommunityUrl": "string",
- "salesforceFallbackToAdmin": true,
- "salesforceOrganizationId": "00Df23090018W5bEAG",
- "salesforceUser": "string",
- "scope": 0,
- "searchHub": "SupportHub",
- "superUserToken": "string",
- "userDisplayName": "Alice Smith",
- "userGroups": [
- "Tech support agents",
- "Employees"
], - "userIds": [
- {
- "authCookie": "",
- "infos": { },
- "name": "asmith@example.com",
- "password": "string",
- "provider": "Email Security Provider",
- "type": "User"
}
], - "usertype": "string",
- "validFor": 3600000
}
{- "token": "string"
}
Lists all values of the target field.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
Array of objects (ActionHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
object (RestCommerceParameters) The parameters for Coveo for Commerce. | |
constantQueryOverride | string A different constant query expression (cq) to use. |
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
debug | boolean Whether to force a successful response to include debug information. Notes:
Default: |
dictionaryFieldContext | object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the Note: This cannot be used at the same time as Note: This parameter will be overridden if the search request is authenticated by a search token that enforces a specific |
disjunctionQueryOverride | string A different disjunction query expression (dq) to use. |
field required | string The name of the field from which to retrieve values. |
format | string The format of a successful response.
Note: Debug information (see the Default: |
ignoreAccents | boolean Whether to treat accentuated characters as non-accentuated characters when retrieving field values (e.g., treat Default: |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
isGuestUser | boolean Whether the current user is anonymous. Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the Default: |
language | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lookupField | string Deprecated This parameter is exposed for backward compatibility reasons. The name of an additional field from which to retrieve values. |
maximumAge | integer <int32> 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumNumberOfValues | integer <int32> >= 0 The maximum number of field values to return. Default: |
maximumTimeoutMs | integer <int32> The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pattern | string The pattern that the field values must match. See also the |
patternType | string The type of pattern that is being used to list field values. Use:
Default: |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
queryOverride | string A different basic query expression (q) use. |
recommendation | string The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
sortCriteria | string The sort criteria to use. Use:
Default: |
tab | string 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
|
timezone | string 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 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. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
visitorId | string Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "values": [
- {
- "lookupValue": "red",
- "numberOfResults": 182,
- "value": "red"
}, - {
- "lookupValue": "green",
- "numberOfResults": 142,
- "value": "green"
}
]
}
Lists all values of the target field.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
field required | string The name of the field from which to retrieve values. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
object (RestCommerceParameters) | |
constantQueryOverride | string A different constant query expression (cq) to use. |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
dictionaryFieldContext | object A key-value store where each pair corresponds to the name of a dictionary field to query, along with the key to target within that field. Example: Suppose that in your index, the Note: This parameter will be overridden if the request is authenticated by a search token that enforces a specific |
disjunctionQueryOverride | string A different disjunction query expression (dq) to use. |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
ignoreAccents | boolean Whether to treat accentuated characters as non-accentuated characters when retrieving field values (e.g., treat Default: |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
lookupField | string Deprecated This parameter is exposed for backward compatibility reasons. The name of an additional field from which to retrieve values. |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumNumberOfValues | integer <int32> >= 0 The maximum number of field values to return. Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
pattern | string The pattern that the field values must match. See also the |
patternType | string The type of pattern that is being used to list field values. Use:
Default: |
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
queryOverride | string A different basic query expression (q) use. |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string or null (SearchHub) 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:
See also the |
sortCriteria | string or null The sort criteria to use. Use:
Default: |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "constantQueryOverride": "string",
- "dictionaryFieldContext": { },
- "disjunctionQueryOverride": "string",
- "field": "@author",
- "ignoreAccents": true,
- "lookupField": "string",
- "maximumNumberOfValues": 0,
- "pattern": "string",
- "patternType": "string",
- "queryOverride": "string",
- "sortCriteria": "string",
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "values": [
- {
- "lookupValue": "red",
- "numberOfResults": 182,
- "value": "red"
}, - {
- "lookupValue": "green",
- "numberOfResults": 142,
- "value": "green"
}
]
}
Lists all values of the target field.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
Array of objects (ActionHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
required | Array of objects (RestListFieldValuesBatchParameter) An array of parameters to retrieve field values. |
context | object 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 Note: When logging a Search usage analytics event for a query, the See also the Example |
debug | boolean Whether to force a successful response to include debug information. Notes:
Default: |
format | string The format of a successful response.
Note: Debug information (see the Default: |
index | string The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
isGuestUser | boolean Whether the current user is anonymous. Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the Default: |
language | string Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
maximumAge | integer <int32> 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer <int32> The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
pipeline | string The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
recommendation | string The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string 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:
See also the |
tab | string 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
|
timezone | string 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 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. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
visitorId | string Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "batch": [
- [
- {
- "lookupValue": "red",
- "numberOfResults": 182,
- "value": "red"
}, - {
- "lookupValue": "green",
- "numberOfResults": 142,
- "value": "green"
}
]
]
}
Lists all values of the target field.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
object or null (AnalyticsRequestParameters) | |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
required | Array of objects (RestListFieldValuesParameter) An array of parameters to retrieve field values. |
Array of objects or null (ActionsHistory) The query and page view actions previously made by the current user. Coveo Machine Learning event recommendations models use this information to provide contextually relevant output. Note: Page view actions are typically populated by the coveo.analytics.js script. | |
object or null (AnalyticsRequestParameters) | |
object (RestCommerceParameters) | |
object or null (Context) 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 Note: When logging a Search usage analytics event for a query, the See also the Example | |
debug | boolean or null (Debug) Default: false Whether to force a successful response to include debug information. Notes:
Default: |
format | string or null (Format) Default: "json" The format of a successful response.
Note: Debug information (see the Default: |
index | string or null (Index) The identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexToken | string or null (IndexToken) The Base64 encoded identifier of the index mirror to forward the request to. See also the If you do not specify an Note: Passing an |
indexType | string or null (IndexType) Default: "coveo" The type of index against which to execute the query. Must correspond to an index that has been configured for the target Coveo Cloud organization. Default: |
language | string or null (Language) Deprecated This parameter is exposed for backward compatibility reasons. Use the |
locale | string or null (Locale) 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 Note: When logging a Search usage analytics event, the |
logicalIndex | string or null (LogicalIndex) Default: "default" The identifier for a logical group of indexes that have been configured to include documents from the same sources. If you do not specify a |
maximumAge | integer or null <int32> (MaximumAge) Default: -1 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 Such cache hits improve responsiveness but still count as queries in your queries per month (QPM) count. Note: This parameter is automatically overridden when Default: |
maximumTimeoutMs | integer or null <int32> (MaximumTimeoutMs) Default: 0 The maximum number of milliseconds to allow the request to last before timing out. Maximum: 16000 Minimum/Default: 0, meaning that Coveo determines the most appropriate timeout to use. |
mlParameters | object or null (MlParameters) A map of options to pass to the Coveo ML models associated with the request's target query pipeline. Available parameters:
Examples:
|
pipeline | string or null (Pipeline) The name of the query pipeline to use for this request (bypassing its conditions, if it has any). You can pass an empty If a query does not contain the Notes:
See also Managing Query Pipelines. |
object or null (PipelineRuleParameters) <= 255 properties This defines generic parameters to be used by rules. It defines the "scopes", or in other words, the rules in which the parameters should be used. The generic parameters are defined within a particular scope and are only be accessible inside of it. This is a read-only parameter, so its value will not be overridden.
While using Gen AI, if additional document fields are required for the resulting citations, these fields can be specified through the 'citationsFieldToInclude' property of the 'mlGenerativeQuestionAnswering' scope.
Examples:
Max Size: 1KB | |
recommendation | string or null (Recommendation) The identifier of the recommendation interface from which the request originates (see Coveo Machine Learning event recommendations models may use this information to provide contextually relevant output. |
referrer | string or null (Referrer) The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the Coveo Machine Learning models may use this information to provide contextually relevant output. Note: When logging a Search usage analytics event for a query, the See also the |
searchHub | string or null (SearchHub) 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:
See also the |
tab | string or null (Tab) 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 See also the |
timezone | string or null (Timezone) 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 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. |
visitorId | string or null (VisitorId) Deprecated A GUID which represents the current user, who can either be authenticated or anonymous.
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 |
{- "batch": [
- {
- "constantQueryOverride": "string",
- "dictionaryFieldContext": { },
- "disjunctionQueryOverride": "string",
- "field": "@author",
- "ignoreAccents": true,
- "lookupField": "string",
- "maximumNumberOfValues": 0,
- "pattern": "string",
- "patternType": "string",
- "queryOverride": "string",
- "sortCriteria": "string",
- "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
], - "actionsHistory": [
- {
- "name": "Query",
- "time": "2017-08-16T11:33:29.427Z",
- "value": "Machine learning powered search"
},
], - "analytics": {
- "actionCause": "facetSelect",
- "capture": true,
- "clientId": "string",
- "clientRequestId": "string",
- "clientTimestamp": "string",
- "customData": { },
- "documentLocation": "string",
- "documentReferrer": "string",
- "originContext": "CommunitySearch",
- "pageId": "string",
- "trackingId": "string",
- "userAgent": "string",
- "userId": "string",
- "userIp": "string"
}, - "commerce": {
- "catalogId": "string",
- "filter": "string",
- "operation": "selectCatalogObjects"
}, - "context": { },
- "debug": false,
- "format": "json",
- "index": "myorg-nvoqun-Indexer1-pbi2nbuw",
- "indexToken": "ZXhhbXBsZWluZGV4bWlycm9yLS4uLg==",
- "indexType": "coveo",
- "language": "string",
- "locale": "en-US",
- "logicalIndex": "webcontentonly",
- "maximumAge": 1800000,
- "maximumTimeoutMs": 15000,
- "mlParameters": {
- "num": 3,
- "padding": "trending"
}, - "pipeline": "CustomerQueryPipeline",
- "pipelineRuleParameters": {
- "genqa": {
- "responseFormat": {
- "answerStyle": "bullet"
}
}
}, - "recommendation": "Recommendation",
- "searchHub": "CustomerPortal",
- "tab": "ForumTab",
- "timezone": "America/New_York",
- "visitorId": "5cb98953-9c13-42ff-8176-e6fcba6a50bf"
}
{- "batch": [
- [
- {
- "lookupValue": "red",
- "numberOfResults": 182,
- "value": "red"
}, - {
- "lookupValue": "green",
- "numberOfResults": 142,
- "value": "green"
}
]
]
}
Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
feature | string The query pipeline feature to match. Allowed values: By default, results are not required to match a specific query pipeline feature. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string The sort criteria to apply on the results. Allowed values: Default: |
subFeature | Array of strings (SubFeature) Items Enum: "queryParamOverride" "querySuggestParamOverride" The query pipeline sub-feature to match. Allowed values:
By default, results are not required to match a specific query pipeline sub-feature. |
{- "statements": [
- {
- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Creates a new query pipeline statement in a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The query pipeline statement information.
definition required | string The query pipeline language expression that defines this statement (see Query Pipeline Language (QPL)). |
feature required | string Enum: "filter" "trigger" "ranking" "stop" "thesaurus" … 6 more The query pipeline feature expressed by this statement (see Query Pipeline Language (QPL)). |
description | string The intended purpose of this statement in an actual implementation. |
id | string The unique identifier of this statement. |
parent | string The unique identifier of the condition that must be met for this statement to apply. |
{- "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "feature": "ranking",
- "id": "string",
- "parent": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}
{- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
Delete multiple statements at once for a specific pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The statements to delete
ids required | Array of strings <= 100 items [ items <= 38 characters ] A list of resource identifiers to delete. A maximum of 100 can be sent. |
{- "ids": [
- "string"
]
}
{ }
Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
feature | string The query pipeline feature to match. Allowed values: By default, results are not required to match a specific query pipeline feature. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string The sort criteria to apply on the results. Allowed values: Default: |
A set of parameters to customize the results.
ids | Array of strings[ items <= 1000 items ] A list of resource identifiers to get. A maximum of 1000 can be sent. |
{- "ids": [
- "string"
]
}
{- "statements": [
- {
- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Copies specific statements from an origin to a target query pipeline. Using the same pipeline as origin and target will duplicate the specified statements in that pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The copy operation to perform.
destinationPipelineId required | string The unique identifier of the query pipeline to copy the statements to. |
statementIds required | Array of strings The unique identifiers of the query pipeline statements to copy. |
{- "destinationPipelineId": "120deecf-7822-4d7b-885f-53f184a3a76",
- "statementIds": [
- "4f0a9531-4fab-45fd-a1e3-eb07a5aceccb"
]
}
{- "statements": [
- {
- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Exports the definition, condition, and description of statements from a specific query pipeline to a CSV file.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
feature | string The query pipeline feature to match. Allowed values: By default, results are not required to match a specific query pipeline feature. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "message": "Bad request.",
- "statusCode": 400
}
Import the definition, condition, and description of statements from a CSV file to a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
feature | string The query pipeline feature to match. Allowed values: By default, results are not required to match a specific query pipeline feature. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
fileName required | string <binary> |
"string"
Validate that a specific operation would be accepted by our API and executed.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains an operation to validate.
required | object (RestOperationValidationRequestIncomingStatement) | ||||||
|
{- "operation": {
- "model": {
- "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "feature": "ranking",
- "id": "string",
- "parent": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}, - "operationType": "CREATE",
- "resourceId": "id"
}
}
{- "result": {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
}
Validate that a list of operations would be accepted by our API and executed. A maximum of 15 can be processed per request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains the list of operations to validate.
required | Array of objects (RestOperationValidationRequestIncomingStatement) A list of operations to validate. | ||||||
Array
|
{- "operations": [
- {
- "model": { },
- "operationType": "CREATE"
}, - {
- "model": { },
- "operationType": "UPDATE",
- "resourceId": "resource-id"
}, - {
- "operationType": "DELETE",
- "resourceId": "resource-id"
}
]
}
{- "results": [
- {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
]
}
Deletes a single query pipeline statement from a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
"string"
Gets a single query pipeline statement from a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
Updates a single query pipeline statement in a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The updated query pipeline statement information.
definition required | string The query pipeline language expression that defines this statement (see Query Pipeline Language (QPL)). |
feature required | string Enum: "filter" "trigger" "ranking" "stop" "thesaurus" … 6 more The query pipeline feature expressed by this statement (see Query Pipeline Language (QPL)). |
description | string The intended purpose of this statement in an actual implementation. |
id | string The unique identifier of this statement. |
parent | string The unique identifier of the condition that must be met for this statement to apply. |
{- "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "feature": "ranking",
- "id": "string",
- "parent": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}
{- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
Sets the position of a query pipeline statement in a specific query pipeline and updates other statement positions as appropriate.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The move operation to perform.
after | string The unique identifier of the statement after which to move this statement in the target query pipeline. Use either this property or the |
pageSize | integer <int32> Deprecated
|
position | integer <int32> The 1-based position of this statement relative to other statements in the target query pipeline. Use either this property or the |
{- "after": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "pageSize": 0,
- "position": 0
}
[- {
- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
]
Get a list of result ranking rules
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
associatedGroups | Array of strings or null The group names to allow in the results. Include the |
enabledStatus | boolean Deprecated The enabled status of result ranking rules to allow in the returned list. Set to By default, both enabled and disabled rules are allowed. Deprecated: Use |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
kind | string Deprecated The kind of result ranking rules to allow in the returned list (i.e., By default, both kinds of rules are allowed. Deprecated: Use |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
ruleStatuses | Array of strings (ResultRankingRuleStatus) Default: "active&ruleStatuses=inactive" Items Enum: "active" "inactive" The rule status to allow in the results. Available statuses are: "active", "inactive". If you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array ( |
ruleTypes | Array of strings (ResultRankingRuleType) Default: "featuredResults&ruleTypes=rankingExpressions" Items Enum: "featuredResults" "rankingExpressions" The rule types to allow in the results. Available types are "featuredResults", "rankingExpressions".
If you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array ( |
statementGroupId | string The unique identifier of the statement group. |
{- "groupedBy": {
- "groups": {
- "associated": {
- "property1": 0,
- "property2": 0
}, - "orphaned": 0
}, - "status": {
- "active": 0,
- "inactive": 0
}, - "type": {
- "featuredResults": 0,
- "rankingExpressions": 0
}
}, - "resultRankings": [
- {
- "associatedGroup": {
- "id": "679adb80-444e-11ea-b77f-2e728ce88125",
- "name": "Community",
- "status": "active"
}, - "id": "string",
- "resultRanking": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "isMigrated": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
}
], - "totalCount": 0,
- "totalPages": 0
}
Create a new result ranking rule
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The new result ranking to create
kind required | string The kind of result ranking. |
name required | string The name of the result ranking. |
required | Array of ResultRankingRuleTargetUniqueId (object) or ResultRankingRuleTargetLocalizedContent (object) or ResultRankingRuleTargetQueryExpression (object) (ResultRankingRuleTargetFeaturedResults) Documents that will show up when conditions and predicates are met. |
object (ResultRankingRuleCondition) | |
object (PredicateMatchOperator) | |
description | string The intended purpose of this result ranking. |
enabled | boolean Default: true Whether this result ranking should be used by the query pipeline. |
includeInFacets | boolean Default: true |
matchAdvancedQuery | boolean Default: true When set to true, a featured result item must match the advanced part (aq) of the query expression, meaning it will only appear if it matches the selected filters in the search interface. |
matchQuery | boolean Default: false When set to true, a featured result item must match the basic part (q) of the query expression, meaning it will only appear if it matches the search request provided by the user. |
Array of any (Predicate) The non-QPL conditions under which the rule may apply. The rule will apply when any of these are satisfied. | |
statementGroupId | string The unique identifier of the statement group. |
{- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
{- "id": "string"
}
Delete multiple result rankings rules in batch for a specific pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The rules to delete
ids required | Array of strings <= 100 items [ items <= 38 characters ] A list of resource identifiers to delete. A maximum of 100 can be sent. |
{- "ids": [
- "string"
]
}
{ }
Get a list of result ranking rules
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
enabledStatus | boolean The enabled status of result ranking rules to allow in the returned list. Set to By default, both enabled and disabled rules are allowed. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
kind | string The kind of result ranking rules to allow in the returned list (i.e., By default, both kinds of rules are allowed. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
statementGroupId | string The unique identifier of the statement group. |
A set of parameters to customize the results.
ids | Array of strings[ items <= 1000 items ] A list of resource identifiers to get. A maximum of 1000 can be sent. |
{- "ids": [
- "string"
]
}
{- "groupedBy": {
- "groups": {
- "associated": {
- "property1": 0,
- "property2": 0
}, - "orphaned": 0
}, - "status": {
- "active": 0,
- "inactive": 0
}, - "type": {
- "featuredResults": 0,
- "rankingExpressions": 0
}
}, - "resultRankings": [
- {
- "associatedGroup": {
- "id": "679adb80-444e-11ea-b77f-2e728ce88125",
- "name": "Community",
- "status": "active"
}, - "id": "string",
- "resultRanking": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "isMigrated": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
}
], - "totalCount": 0,
- "totalPages": 0
}
Copies specific result ranking rules from an origin to a target query pipeline. Using the same pipeline as origin and target will duplicate the specified statements in that pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The copy operation to perform.
destinationPipelineId required | string The unique identifier of the query pipeline to copy the statements to. |
resultRankingIds required | Array of strings [ 1 .. 15 ] items The unique identifiers of the result ranking rules to copy. |
{- "destinationPipelineId": "120deecf-7822-4d7b-885f-53f184a3a76",
- "resultRankingIds": [
- "4f0a9531-4fab-45fd-a1e3-eb07a5aceccb"
]
}
{- "resultRankings": [
- {
- "id": "string",
- "resultRanking": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "isMigrated": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
}
]
}
Duplicate a result ranking rule
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
resultRankingId required | string Example: 120deecf-7822-4d7b-885f-53f184a3a76c The unique identifier of the result ranking. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "associatedGroup": {
- "id": "679adb80-444e-11ea-b77f-2e728ce88125",
- "name": "Community",
- "status": "active"
}, - "id": "string",
- "resultRanking": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "isMigrated": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
}
Validate that a specific operation would be accepted by our API and executed.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains an operation to validate.
required | any (ResultRankingValidationRequest) | ||||
|
{- "operation": {
- "model": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}, - "operationType": "CREATE"
}
}
{- "result": {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
}
Validate that a list of operations would be accepted by our API and executed. A maximum of 15 can be processed per request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains the list of operations to validate.
required | Array of any (ResultRankingValidationRequest) A list of operations to validate. | ||||
Array
|
{- "operations": [
- {
- "model": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}, - "operationType": "CREATE"
}
]
}
{- "results": [
- {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
]
}
Deletes a result ranking rule
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
resultRankingId required | string Example: 120deecf-7822-4d7b-885f-53f184a3a76c The unique identifier of the result ranking. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "message": "Bad request.",
- "statusCode": 400
}
Get a result ranking rule
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
resultRankingId required | string The unique identifier of the result ranking. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "isMigrated": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "associatedGroup": {
- "id": "679adb80-444e-11ea-b77f-2e728ce88125",
- "name": "Community",
- "status": "active"
}, - "id": "string",
- "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
Update a result ranking rule
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
resultRankingId required | string Example: 120deecf-7822-4d7b-885f-53f184a3a76c The unique identifier of the result ranking. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The result ranking rule to update
kind required | string The kind of result ranking. |
name required | string The name of the result ranking. |
required | Array of ResultRankingRuleTargetUniqueId (object) or ResultRankingRuleTargetLocalizedContent (object) or ResultRankingRuleTargetQueryExpression (object) (ResultRankingRuleTargetFeaturedResults) Documents that will show up when conditions and predicates are met. |
object (ResultRankingRuleCondition) | |
object (PredicateMatchOperator) | |
description | string The intended purpose of this result ranking. |
enabled | boolean Default: true Whether this result ranking should be used by the query pipeline. |
includeInFacets | boolean Default: true |
matchAdvancedQuery | boolean Default: true When set to true, a featured result item must match the advanced part (aq) of the query expression, meaning it will only appear if it matches the selected filters in the search interface. |
matchQuery | boolean Default: false When set to true, a featured result item must match the basic part (q) of the query expression, meaning it will only appear if it matches the search request provided by the user. |
Array of any (Predicate) The non-QPL conditions under which the rule may apply. The rule will apply when any of these are satisfied. | |
statementGroupId | string The unique identifier of the statement group. |
{- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "kind": "is"
}, - "description": "Back to school promotion.",
- "enabled": true,
- "name": "Back to School",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "kind": "basicExpressionAndLocalePredicate",
- "locale": {
- "kind": "all"
}
}
], - "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "includeInFacets": true,
- "kind": "featured_result",
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
{- "message": "Bad request.",
- "statusCode": 400
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
"string"
Gets a page of Coveo Machine Learning model associations for a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
{- "rules": [
- {
- "associatedGroup": null,
- "condition": "string",
- "conditionDefinition": "string",
- "contentIdKeys": [
- "string"
], - "customQueryParameters": { },
- "description": "string",
- "dynamicNavigationExperience": { },
- "enableWordCompletion": true,
- "exclusive": true,
- "id": "string",
- "intelligentTermDetection": true,
- "intelligentTermDetectionPartialMatchKeywords": 0,
- "intelligentTermDetectionPartialMatchThreshold": "string",
- "matchAdvancedExpression": true,
- "matchBasicExpression": true,
- "maxRecommendations": 0,
- "modelDisplayName": "string",
- "modelEngine": "string",
- "modelId": "string",
- "modelStatus": "string",
- "passageRetrieval": {
- "numberOfDocumentsToConsider": 1
}, - "position": 0,
- "rankingModifier": 0,
- "useAdvancedConfiguration": true
}
], - "totalEntries": 0,
- "totalPages": 0
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The configuration options to apply to the ML model.
The cacheMaximumAge,
condition,
description, and
maxResults`, options apply to all types of models. Other configuration options are only taken into account for specific types of models:
enableWordCompletion
: query suggestionsexclusive
: event recommendationsintelligentTermDetection
, matchAdvancedQuery
, and matchQuery
: automatic relevance tuningrankingModifier
: automatic relevance tuning, event recommendationsmodelId required | string The unique identifier of the ML model to create an association with. |
cacheMaximumAge | string The maximum age of cached query results the ML model should accept, in the ISO - 8601 format only including the seconds and milliseconds part. Default: For each incoming query to be processed by the ML model, if a result set for an identical previously made query is available in cache and this result set is not older than the specified value, the ML model makes recommendations based on that cached query result set. Otherwise, the query is executed against the index. |
condition | string The unique identifier of the condition that must be satisfied for a request to be processed by the ML model. |
contentIdKeys | Array of strings The names of the fields to use to uniquely identify items in the index. Default: |
object The additional parameters to send to Coveo ML. Among other things, this can be used to specify the
| |
description | string The ML model association description. |
object (DynamicNavigationExperienceConfiguration) | |
enableWordCompletion | boolean Whether the ML model should attempt to complete the last word of the basic query expression and increase the ranking score of the resulting expression so that it is returned as the first completion suggestion. Used by the following ML models:
|
exclusive | boolean Whether the Search API should only return items which were recommended by the ML model, even if other items matching the query were found in the index. Used by the following ML models:
|
intelligentTermDetection | boolean Whether the ML model should use the Intelligent Term Detection (ITD) feature to refine queries by extracting relevant keywords from the large query expression and injecting those in the basic query expression. Used by the following ML models:
|
intelligentTermDetectionPartialMatchKeywords | integer <int32> Default: 1 The minimum number of keywords that need to be present in an Intelligent Term Detection (ITD) response to convert it to a partial match expression. Notes:
Used by the following ML model:
|
intelligentTermDetectionPartialMatchThreshold | string Default: "60%" An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression refined by the Intelligent Term Detection (ITD) feature. If specified, the
Examples:
Notes:
Used by the following ML model:
|
matchAdvancedExpression | boolean Whether all items recommended by the ML model should match the advanced query expression (e.g., facet selections). Used by the following ML models:
|
matchBasicExpression | boolean Whether all items recommended by the ML model should match the basic query expression (e.g., end-user input in the search box). Used by the following ML models:
|
maxRecommendations | integer <int32> The maximum number of recommendations the ML model should return. This should be set to a relatively low value (typically well below 50), otherwise some of the recommended items may not actually be relevant. (Automatic relevance tuning default value: 5. Query suggest default value: 10) |
object (PassageRetrievalConfiguration) | |
rankingModifier | integer <int32> The ranking score modifier the ML model should apply to each item it recommends. Used by the following ML models:
|
statementGroupId | string The unique identifier of the statement group. |
useAdvancedConfiguration | boolean Internal: This property is exposed for internal use by the Coveo Cloud administration console. Whether the administration console should show the advanced editor for this association. Note: Properties not supported by the standard editor may not be preserved if managed via direct API calls or the advanced editor. Default: |
{- "cacheMaximumAge": "PT300S",
- "condition": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "contentIdKeys": [
- "string"
], - "customQueryParameters": { },
- "description": "string",
- "dynamicNavigationExperience": {
- "automaticSelection": {
- "isEnabled": true
}
}, - "enableWordCompletion": true,
- "exclusive": true,
- "intelligentTermDetection": true,
- "intelligentTermDetectionPartialMatchKeywords": 4,
- "intelligentTermDetectionPartialMatchThreshold": "75%",
- "matchAdvancedExpression": true,
- "matchBasicExpression": true,
- "maxRecommendations": 0,
- "modelId": "mycoveocloudorganization_topclicks_My_ART_Model",
- "passageRetrieval": {
- "numberOfDocumentsToConsider": 1
}, - "rankingModifier": 500,
- "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "useAdvancedConfiguration": true
}
"string"
Gets a page of Coveo Machine Learning model associations for a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
A set of parameters to customize the results.
ids | Array of strings[ items <= 1000 items ] A list of resource identifiers to get. A maximum of 1000 can be sent. |
{- "ids": [
- "string"
]
}
{- "rules": [
- {
- "associatedGroup": null,
- "condition": "string",
- "conditionDefinition": "string",
- "contentIdKeys": [
- "string"
], - "customQueryParameters": { },
- "description": "string",
- "dynamicNavigationExperience": { },
- "enableWordCompletion": true,
- "exclusive": true,
- "id": "string",
- "intelligentTermDetection": true,
- "intelligentTermDetectionPartialMatchKeywords": 0,
- "intelligentTermDetectionPartialMatchThreshold": "string",
- "matchAdvancedExpression": true,
- "matchBasicExpression": true,
- "maxRecommendations": 0,
- "modelDisplayName": "string",
- "modelEngine": "string",
- "modelId": "string",
- "modelStatus": "string",
- "passageRetrieval": {
- "numberOfDocumentsToConsider": 1
}, - "position": 0,
- "rankingModifier": 0,
- "useAdvancedConfiguration": true
}
], - "totalEntries": 0,
- "totalPages": 0
}
Validate that a specific operation would be accepted by our API and executed.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains an operation to validate.
required | object (AssociationValidationRequest) | ||||||
|
{- "operation": {
- "model": {
- "cacheMaximumAge": "PT300S",
- "condition": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "contentIdKeys": [
- "string"
], - "customQueryParameters": { },
- "description": "string",
- "dynamicNavigationExperience": {
- "automaticSelection": {
- "isEnabled": true
}
}, - "enableWordCompletion": true,
- "exclusive": true,
- "intelligentTermDetection": true,
- "intelligentTermDetectionPartialMatchKeywords": 4,
- "intelligentTermDetectionPartialMatchThreshold": "75%",
- "matchAdvancedExpression": true,
- "matchBasicExpression": true,
- "maxRecommendations": 0,
- "modelId": "mycoveocloudorganization_topclicks_My_ART_Model",
- "passageRetrieval": {
- "numberOfDocumentsToConsider": 1
}, - "rankingModifier": 500,
- "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "useAdvancedConfiguration": true
}, - "operationType": "CREATE",
- "resourceId": "id"
}
}
{- "result": {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
}
Validate that a list of operations would be accepted by our API and executed. A maximum of 15 can be processed per request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains the list of operations to validate.
required | Array of objects (AssociationValidationRequest) A list of operations to validate. | ||||||
Array
|
{- "operations": [
- {
- "model": { },
- "operationType": "CREATE"
}, - {
- "model": { },
- "operationType": "UPDATE",
- "resourceId": "resource-id"
}, - {
- "operationType": "DELETE",
- "resourceId": "resource-id"
}
]
}
{- "results": [
- {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
]
}
Removes a single existing association between a machine learning model and a query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
associationId required | string |
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
"string"
Gets a Coveo Machine Learning model association.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
associationId required | string |
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "associatedGroup": null,
- "condition": "string",
- "conditionDefinition": "string",
- "contentIdKeys": [
- "string"
], - "customQueryParameters": { },
- "description": "string",
- "dynamicNavigationExperience": { },
- "enableWordCompletion": true,
- "exclusive": true,
- "id": "string",
- "intelligentTermDetection": true,
- "intelligentTermDetectionPartialMatchKeywords": 0,
- "intelligentTermDetectionPartialMatchThreshold": "string",
- "matchAdvancedExpression": true,
- "matchBasicExpression": true,
- "maxRecommendations": 0,
- "modelDisplayName": "string",
- "modelEngine": "string",
- "modelId": "string",
- "modelStatus": "string",
- "passageRetrieval": {
- "numberOfDocumentsToConsider": 1
}, - "position": 0,
- "rankingModifier": 0,
- "useAdvancedConfiguration": true
}
Changes the configuration of an association in a pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
associationId required | string |
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The configuration options to apply to the ML model.
The cacheMaximumAge
, condition
, description
, and maxResults
, options apply to all types of models. Other configuration options are only taken into account for specific types of models:
enableWordCompletion
: query suggestionsexclusive
: event recommendationsintelligentTermDetection
, matchAdvancedQuery
, and matchQuery
: automatic relevance tuningrankingModifier
: automatic relevance tuning, event recommendationscacheMaximumAge | string The maximum age of cached query results the ML model should accept, in the ISO - 8601 format only including the seconds and milliseconds part. Default: For each incoming query to be processed by the ML model, if a result set for an identical previously made query is available in cache and this result set is not older than the specified value, the ML model makes recommendations based on that cached query result set. Otherwise, the query is executed against the index. |
condition | string The unique identifier of the condition that must be satisfied for a request to be processed by the ML model. |
contentIdKeys | Array of strings The names of the fields to use to uniquely identify items in the index. Default: |
object The additional parameters to send to Coveo ML. Among other things, this can be used to specify the
| |
description | string The ML model association description. |
object (DynamicNavigationExperienceConfiguration) | |
enableWordCompletion | boolean Whether the ML model should attempt to complete the last word of the basic query expression and increase the ranking score of the resulting expression so that it is returned as the first completion suggestion. Used by the following ML models:
|
exclusive | boolean Whether the Search API should only return items which were recommended by the ML model, even if other items matching the query were found in the index. Used by the following ML models:
|
intelligentTermDetection | boolean Whether the ML model should use the Intelligent Term Detection (ITD) feature to refine queries by extracting relevant keywords from the large query expression and injecting those in the basic query expression. Used by the following ML models:
|
intelligentTermDetectionPartialMatchKeywords | integer <int32> Default: 1 The minimum number of keywords that need to be present in an Intelligent Term Detection (ITD) response to convert it to a partial match expression. Notes:
Used by the following ML model:
|
intelligentTermDetectionPartialMatchThreshold | string Default: "60%" An absolute or relative value indicating the minimum number (rounded up) of partial match expression keywords an item must contain to match the expression refined by the Intelligent Term Detection (ITD) feature. If specified, the
Examples:
Notes:
Used by the following ML model:
|
matchAdvancedExpression | boolean Whether all items recommended by the ML model should match the advanced query expression (e.g., facet selections). Used by the following ML models:
|
matchBasicExpression | boolean Whether all items recommended by the ML model should match the basic query expression (e.g., end-user input in the search box). Used by the following ML models:
|
maxRecommendations | integer <int32> The maximum number of recommendations the ML model should return. This should be set to a relatively low value (typically well below 50), otherwise some of the recommended items may not actually be relevant. (Automatic relevance tuning default value: 5. Query suggest default value: 10) |
object (PassageRetrievalConfiguration) | |
rankingModifier | integer <int32> The ranking score modifier the ML model should apply to each item it recommends. Used by the following ML models:
|
statementGroupId | string The unique identifier of the statement group. |
useAdvancedConfiguration | boolean Internal: This property is exposed for internal use by the Coveo Cloud administration console. Whether the administration console should show the advanced editor for this association. Note: Properties not supported by the standard editor may not be preserved if managed via direct API calls or the advanced editor. Default: |
{- "cacheMaximumAge": "PT300S",
- "condition": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "contentIdKeys": [
- "string"
], - "customQueryParameters": { },
- "description": "string",
- "dynamicNavigationExperience": {
- "automaticSelection": {
- "isEnabled": true
}
}, - "enableWordCompletion": true,
- "exclusive": true,
- "intelligentTermDetection": true,
- "intelligentTermDetectionPartialMatchKeywords": 4,
- "intelligentTermDetectionPartialMatchThreshold": "75%",
- "matchAdvancedExpression": true,
- "matchBasicExpression": true,
- "maxRecommendations": 0,
- "passageRetrieval": {
- "numberOfDocumentsToConsider": 1
}, - "rankingModifier": 500,
- "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "useAdvancedConfiguration": true
}
"string"
Changes the position of an association in a pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
associationId required | string |
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
position required | integer <int32> |
"string"
undefined
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
{- "featureActiveState": [
- {
- "active": true,
- "feature": "string"
}
]
}
List statement groups of a pipeline
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string Default: "status" Enum: "name" "status" The sort criteria to apply on the results.
|
status | Array of strings (StatementGroupStatus) non-empty Items Enum: "active" "inactive" "expired" "notStarted" The status of the statement group. |
types | Array of strings (StatementGroupType) non-empty Items Enum: "campaign" "permanent" The type name of the statement group. |
{- "groupComposition": {
- "activeGroupCount": 0,
- "campaignGroupCount": 0,
- "expiredGroupCount": 0,
- "inactiveGroupCount": 0,
- "notStartedGroupCount": 0,
- "permanentGroupCount": 0
}, - "groups": [
- {
- "conditionDefinition": "string",
- "conditionDetailed": null,
- "conditionId": "string",
- "createdAt": "string",
- "createdBy": "string",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "id": "679adb80-444e-11ea-b77f-2e728ce88125",
- "modifiedAt": "string",
- "modifiedBy": "string",
- "name": "Community",
- "statementComposition": {
- "otherStatementCount": 0,
- "resultRankingStatementCount": 0
}, - "type": "campaign",
- "warnings": [
- "string"
], - "campaignEnd": "2002-09-07T10:07:20-04:00",
- "campaignStart": "2001-07-20T23:01:05-04:00",
- "status": "active"
}
], - "totalCount": 1
}
Create a new statement group
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The new statement group to create
campaignEnd required | string The end date of the campaign. |
campaignStart required | string The start date of the campaign. |
name required | string The name of the statement group. |
type required | string (StatementGroupType) The type name of the statement group. |
conditionId | string The condition that must be met by a query in order to route that query through this query pipeline. Typically, each query pipeline except the default one should have a condition, and you should ensure that the conditions you set on query pipelines are mutually exclusive. Note: A query cannot be routed through a query pipeline that does not have a condition unless:
|
description | string The intended purpose of this statement group. |
{- "conditionId": "string",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "name": "Community",
- "type": "campaign",
- "campaignEnd": "2002-09-07T10:07:20-04:00",
- "campaignStart": "2001-07-20T23:01:05-04:00"
}
{- "campaignEnd": "2002-09-07T10:07:20",
- "campaignStart": "2001-07-20T23:01:05",
- "conditionId": "string",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "id": "679adb80-444e-11ea-b77f-2e728ce88125",
- "isActive": false,
- "name": "Community",
- "type": "campaign"
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
Array of objects (StatementGroupAssociationItem) <= 50 items The rules that should be dissociated from their group, if any. If a rule is not associated to a group, it won't be updated. Note:: Invalid rule IDs will cause the request to fail. | |||||
Array (<= 50 items)
|
{- "associations": [
- {
- "featureType": "resultRankings",
- "ruleId": "493e51a8-bc9b-462d-9534-08a0995ecd55"
}
]
}
{ }
List statement groups of a pipeline
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
A set of parameters to customize the results.
ids | Array of strings[ items <= 1000 items ] A list of resource identifiers to get. A maximum of 1000 can be sent. |
{- "ids": [
- "string"
]
}
{- "groupComposition": {
- "activeGroupCount": 0,
- "campaignGroupCount": 0,
- "expiredGroupCount": 0,
- "inactiveGroupCount": 0,
- "notStartedGroupCount": 0,
- "permanentGroupCount": 0
}, - "groups": [
- {
- "conditionDefinition": "string",
- "conditionDetailed": null,
- "conditionId": "string",
- "createdAt": "string",
- "createdBy": "string",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "id": "679adb80-444e-11ea-b77f-2e728ce88125",
- "modifiedAt": "string",
- "modifiedBy": "string",
- "name": "Community",
- "statementComposition": {
- "otherStatementCount": 0,
- "resultRankingStatementCount": 0
}, - "type": "campaign",
- "warnings": [
- "string"
], - "campaignEnd": "2002-09-07T10:07:20-04:00",
- "campaignStart": "2001-07-20T23:01:05-04:00",
- "status": "active"
}
], - "totalCount": 1
}
Validate that a specific operation would be accepted by our API and executed.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains an operation to validate.
required | object (RestOperationValidationRequestCreateStatementGroupRequest) | ||||||
|
{- "operation": {
- "model": {
- "campaignEnd": "2002-09-07T10:07:20-04:00",
- "campaignStart": "2001-07-20T23:01:05-04:00",
- "description": "Provides contextually relevant query recommendations/results to Community site users.",
- "name": "Community",
- "type": "campaign"
}, - "operationType": "CREATE",
- "resourceId": "id"
}
}
{- "result": {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
}
Validate that a list of operations would be accepted by our API and executed. A maximum of 15 can be processed per request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains the list of operations to validate.
required | Array of objects (RestOperationValidationRequestCreateStatementGroupRequest) A list of operations to validate. | ||||||
Array
|
{- "operations": [
- {
- "model": { },
- "operationType": "CREATE"
}, - {
- "model": { },
- "operationType": "UPDATE",
- "resourceId": "resource-id"
}, - {
- "operationType": "DELETE",
- "resourceId": "resource-id"
}
]
}
{- "results": [
- {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
]
}
Delete a statement group of a pipeline
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementGroupId required | string Example: 679adb80-444e-11ea-b77f-2e728ce88125 The unique identifier of the statement group. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "message": "Bad request.",
- "statusCode": 400
}
Get a statement group of a pipeline
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementGroupId required | string Example: 679adb80-444e-11ea-b77f-2e728ce88125 The unique identifier of the statement group. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "conditionDefinition": "string",
- "conditionDetailed": null,
- "conditionId": "string",
- "createdAt": "string",
- "createdBy": "string",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "id": "679adb80-444e-11ea-b77f-2e728ce88125",
- "modifiedAt": "string",
- "modifiedBy": "string",
- "name": "Community",
- "statementComposition": {
- "otherStatementCount": 0,
- "resultRankingStatementCount": 0
}, - "type": "campaign",
- "warnings": [
- "string"
], - "campaignEnd": "2002-09-07T10:07:20-04:00",
- "campaignStart": "2001-07-20T23:01:05-04:00",
- "status": "active"
}
Toggle a permanent group
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementGroupId required | string Example: 679adb80-444e-11ea-b77f-2e728ce88125 The unique identifier of the statement group. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
isActive | boolean Whether or not the group is active. |
{- "isActive": true
}
{- "message": "Bad request.",
- "statusCode": 400
}
Update a statement group
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementGroupId required | string Example: 679adb80-444e-11ea-b77f-2e728ce88125 The unique identifier of the statement group. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The statement group to update
campaignEnd required | string The end date of the campaign. |
campaignStart required | string The start date of the campaign. |
name required | string The name of the statement group. |
type required | string (StatementGroupType) The type name of the statement group. |
conditionId | string The condition that must be met by a query in order to route that query through this query pipeline. Typically, each query pipeline except the default one should have a condition, and you should ensure that the conditions you set on query pipelines are mutually exclusive. Note: A query cannot be routed through a query pipeline that does not have a condition unless:
|
description | string The intended purpose of this statement group. |
{- "conditionId": "string",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "name": "Community",
- "type": "campaign",
- "campaignEnd": "2002-09-07T10:07:20-04:00",
- "campaignStart": "2001-07-20T23:01:05-04:00"
}
{- "message": "Bad request.",
- "statusCode": 400
}
There are two operations which can update the rules associated with a statement group:
toAdd
parametertoRemove
parameter{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementGroupId required | string Example: 679adb80-444e-11ea-b77f-2e728ce88125 The unique identifier of the statement group. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
Array of objects (StatementGroupAssociationItem) <= 50 items The rules to add to this group. If you specify a rule from another group, it will be removed from the original group and added to this one instead. Note: Invalid rule IDs will cause the request to fail. | |
Array of objects (StatementGroupAssociationItem) <= 50 items The rules to remove from this group. Note: Orphaned rules, rules that are associated with another group, and non-existent rules will be ignored. |
{- "toAdd": [
- {
- "featureType": "resultRankings",
- "ruleId": "493e51a8-bc9b-462d-9534-08a0995ecd55"
}
], - "toRemove": [
- {
- "featureType": "resultRankings",
- "ruleId": "493e51a8-bc9b-462d-9534-08a0995ecd55"
}
]
}
{- "associatedRules": [
- {
- "featureType": "resultRankings",
- "ruleId": "493e51a8-bc9b-462d-9534-08a0995ecd55"
}
]
}
This API is deprecated and will be removed on 2025-02-17. We recommend that you switch to the /resultRankings endpoint before this date to maintain functionality.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
{- "featuredResultRules": [
- {
- "id": "string",
- "rule": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "contains": { },
- "is": { },
- "matches": { }
}, - "description": "string",
- "enabled": true,
- "includeInFacets": true,
- "isMigrated": true,
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "name": "winterPromotion01",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "locale": {
- "all": { }
}
}
], - "qplPredicates": [
- {
- "code": "string"
}
], - "rankingModifier": 1000,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
}
], - "totalCount": 0,
- "totalPages": 0
}
This API is deprecated and will be removed on 2025-02-17. We recommend that you switch to the /resultRankings endpoint before this date to maintain functionality.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The new featured result rule to create
required | object (FeaturedResultRuleMatchOperator) |
name required | string |
required | Array of objects (FeaturedResultRulePredicate) Search queries that will trigger this featured result to be shown. |
required | Array of objects (FeaturedResultRuleTarget) Documents that will be shown as featured results. |
object (FeaturedResultRuleCondition) | |
description | string |
enabled | boolean Whether this featured result should be used by the query pipeline. |
includeInFacets | boolean |
matchAdvancedQuery | boolean |
matchQuery | boolean |
Array of objects (FeaturedResultQPLCodePredicate) | |
rankingModifier | integer <int32> The ranking score modifier to apply. Use a positive value to promote the target, or a negative value to demote it. Note: If you do not specify a value for this parameter, the target will receive a significant boost, causing it to appear at the top of the ranked query result set. |
statementGroupId | string The unique identifier of the statement group. |
{- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "contains": { },
- "is": { },
- "matches": { }
}, - "description": "string",
- "enabled": true,
- "includeInFacets": true,
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "name": "winterPromotion01",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "locale": {
- "all": { }
}
}
], - "qplPredicates": [
- {
- "code": "string"
}
], - "rankingModifier": 1000,
- "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
{- "id": "string"
}
This API is deprecated and will be removed on 2025-02-17. We recommend that you switch to the /resultRankings endpoint before this date to maintain functionality.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
A set of parameters to customize the results.
ids | Array of strings[ items <= 1000 items ] A list of resource identifiers to get. A maximum of 1000 can be sent. |
{- "ids": [
- "string"
]
}
{- "featuredResultRules": [
- {
- "id": "string",
- "rule": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "contains": { },
- "is": { },
- "matches": { }
}, - "description": "string",
- "enabled": true,
- "includeInFacets": true,
- "isMigrated": true,
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "name": "winterPromotion01",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "locale": {
- "all": { }
}
}
], - "qplPredicates": [
- {
- "code": "string"
}
], - "rankingModifier": 1000,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
}
], - "totalCount": 0,
- "totalPages": 0
}
This API is deprecated and will be removed on 2025-02-17. We recommend that you switch to the /resultRankings endpoint before this date to maintain functionality.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains an operation to validate.
required | object (FeaturedResultRuleValidationRequest) | ||||||
|
{- "operation": {
- "model": {
- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "contains": { },
- "is": { },
- "matches": { }
}, - "description": "string",
- "enabled": true,
- "includeInFacets": true,
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "name": "winterPromotion01",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "locale": {
- "all": { }
}
}
], - "qplPredicates": [
- {
- "code": "string"
}
], - "rankingModifier": 1000,
- "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}, - "operationType": "CREATE",
- "resourceId": "id"
}
}
{- "result": {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
}
This API is deprecated and will be removed on 2025-02-17. We recommend that you switch to the /resultRankings endpoint before this date to maintain functionality.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains the list of operations to validate.
required | Array of objects (FeaturedResultRuleValidationRequest) A list of operations to validate. | ||||||
Array
|
{- "operations": [
- {
- "model": { },
- "operationType": "CREATE"
}, - {
- "model": { },
- "operationType": "UPDATE",
- "resourceId": "resource-id"
}, - {
- "operationType": "DELETE",
- "resourceId": "resource-id"
}
]
}
{- "results": [
- {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
]
}
This API is deprecated and will be removed on 2025-02-17. We recommend that you switch to the /resultRankings endpoint before this date to maintain functionality.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
featuredResultId required | string The unique identifier of the featured result. |
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
"string"
This API is deprecated and will be removed on 2025-02-17. We recommend that you switch to the /resultRankings endpoint before this date to maintain functionality.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
featuredResultId required | string The unique identifier of the featured result. |
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "contains": { },
- "is": { },
- "matches": { }
}, - "description": "string",
- "enabled": true,
- "includeInFacets": true,
- "isMigrated": true,
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "name": "winterPromotion01",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "locale": {
- "all": { }
}
}
], - "qplPredicates": [
- {
- "code": "string"
}
], - "rankingModifier": 1000,
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
This API is deprecated and will be removed on 2025-02-17. We recommend that you switch to the /resultRankings endpoint before this date to maintain functionality.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
featuredResultId required | string The unique identifier of the featured result. |
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The featured result rule to update
required | object (FeaturedResultRuleMatchOperator) |
name required | string |
required | Array of objects (FeaturedResultRulePredicate) Search queries that will trigger this featured result to be shown. |
required | Array of objects (FeaturedResultRuleTarget) Documents that will be shown as featured results. |
object (FeaturedResultRuleCondition) | |
description | string |
enabled | boolean Whether this featured result should be used by the query pipeline. |
includeInFacets | boolean |
matchAdvancedQuery | boolean |
matchQuery | boolean |
Array of objects (FeaturedResultQPLCodePredicate) | |
rankingModifier | integer <int32> The ranking score modifier to apply. Use a positive value to promote the target, or a negative value to demote it. Note: If you do not specify a value for this parameter, the target will receive a significant boost, causing it to appear at the top of the ranked query result set. |
statementGroupId | string The unique identifier of the statement group. |
{- "condition": {
- "reference": "3896e64f-2132-463a-81c8-26f2e9f89e0a"
}, - "defaultMatchOperator": {
- "contains": { },
- "is": { },
- "matches": { }
}, - "description": "string",
- "enabled": true,
- "includeInFacets": true,
- "matchAdvancedQuery": true,
- "matchQuery": true,
- "name": "winterPromotion01",
- "predicates": [
- {
- "basicQueryExpression": "video game",
- "locale": {
- "all": { }
}
}
], - "qplPredicates": [
- {
- "code": "string"
}
], - "rankingModifier": 1000,
- "statementGroupId": "679adb80-444e-11ea-b77f-2e728ce88125",
- "targets": [
- {
- "uniqueId": "2228d0a698fd"
}, - {
- "localizedContent": {
- "familyId": "112233",
- "familyIdField": "@sfarticlenumber",
- "locale": {
- "auto": {
- "default": "en-US"
}
}, - "localeField": "@locale"
}
}, - {
- "queryExpression": "@permanentid=\"6cdw9d02d17\""
}
]
}
Gets a sorted page of query pipelines matching certain criteria.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
enablePagination | boolean Whether to receive the pipelines in a paginated format. |
excludeAbTestTargets | boolean Default: false Whether to exclude the A/B test targets from the result. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string The sort criteria to apply on the results. Allowed values: Default: |
{- "items": [
- {
- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "created_by": "asmith@example.com",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "@source==CommunityForum OR @source==CommunityDocumentation",
- "id": "120deecf-7822-4d7b-885f-53f184a3a76c",
- "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "last_modified_by": "bjones@example.com",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "name": "Community",
- "position": 3,
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support"
}
], - "totalEntries": 0
}
Creates a new query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"CREATE","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The query pipeline information.
name required | string The name of this query pipeline. |
object (PipelineAduiConfiguration) | |
Array of objects (IdentifiedResource) | |
object (IncomingConditionReference) | |
description | string The intended purpose of this query pipeline. |
filter | string |
Array of objects (IdentifiedResource) | |
Array of objects (PipelineInterfaceUrls) <= 20 items This option helps better understand the pages where this query pipeline is intended to be used. It won't affect query routing in any way but may be used by Coveo to help you manage your configuration properly. | |
isDefault | boolean Whether this query pipeline is the default query pipeline. Note: There must be one and only one default query pipeline in a Coveo Cloud organization. Therefore, setting |
splitTestEnabled | boolean Whether to enable the A/B test. See also the |
splitTestName | string A name which summarizes the intended purpose of the A/B test. See also the |
splitTestRatio | number <double> [ 0 .. 1 ] The percentage of queries to route through query pipeline B if the A/B test is enabled. Remaining queries will be routed through this query pipeline. See also the |
splitTestTarget | string The unique identifier of query pipeline B in the A/B test. See also the |
useCase | string <= 50 characters The use case for which this query pipeline should apply. This option allows you to categorize your query pipeline and enables Coveo to provide better support and improve the tools we provide. |
{- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "apiKeysThatCanEdit": [
- {
- "id": "string"
}
], - "condition": {
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}, - "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "string",
- "groupsThatCanEdit": [
- {
- "id": "string"
}
], - "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "name": "Community",
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support"
}
{- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "created_by": "asmith@example.com",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "@source==CommunityForum OR @source==CommunityDocumentation",
- "id": "120deecf-7822-4d7b-885f-53f184a3a76c",
- "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "last_modified_by": "bjones@example.com",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "name": "Community",
- "position": 3,
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support"
}
Gets a sorted page of query pipelines matching certain criteria.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string The sort criteria to apply on the results. Allowed values: Default: |
A set of parameters to customize the results.
ids | Array of strings[ items <= 1000 items ] A list of resource identifiers to get. A maximum of 1000 can be sent. |
{- "ids": [
- "string"
]
}
{- "pipelines": [
- {
- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "created_by": "asmith@example.com",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "@source==CommunityForum OR @source==CommunityDocumentation",
- "id": "120deecf-7822-4d7b-885f-53f184a3a76c",
- "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "last_modified_by": "bjones@example.com",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "name": "Community",
- "position": 3,
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support"
}
], - "totalEntries": 0
}
Validate that a specific operation would be accepted by our API and executed.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that describes the operation to validate, the resource to target, and the model payload to use.
required | object (RestOperationValidationRequestIncomingPipeline) | ||||||
|
{- "operation": {
- "model": {
- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "apiKeysThatCanEdit": [
- {
- "id": "string"
}
], - "condition": {
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}, - "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "string",
- "groupsThatCanEdit": [
- {
- "id": "string"
}
], - "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "name": "Community",
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support"
}, - "operationType": "CREATE",
- "resourceId": "id"
}
}
{- "result": {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
}
Validate that a list of operations would be accepted by our API and executed. A maximum of 15 can be processed per request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains the list of operations to validate.
required | Array of objects (RestOperationValidationRequestIncomingPipeline) A list of operations to validate. | ||||||
Array
|
{- "operations": [
- {
- "model": { },
- "operationType": "CREATE"
}, - {
- "model": { },
- "operationType": "UPDATE",
- "resourceId": "resource-id"
}, - {
- "operationType": "DELETE",
- "resourceId": "resource-id"
}
]
}
{- "results": [
- {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
]
}
Deletes a single query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
"string"
Gets a single query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "created_by": "asmith@example.com",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "@source==CommunityForum OR @source==CommunityDocumentation",
- "id": "120deecf-7822-4d7b-885f-53f184a3a76c",
- "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "last_modified_by": "bjones@example.com",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "name": "Community",
- "position": 3,
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support",
- "splitTestOriginalPipeline": "string",
- "statementComposition": {
- "totalCount": 0
}
}
Modifies a single query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The updated query pipeline information.
name required | string The name of this query pipeline. |
object (PipelineAduiConfiguration) | |
Array of objects (IdentifiedResource) | |
object (IncomingConditionReference) | |
description | string The intended purpose of this query pipeline. |
filter | string |
Array of objects (IdentifiedResource) | |
Array of objects (PipelineInterfaceUrls) <= 20 items This option helps better understand the pages where this query pipeline is intended to be used. It won't affect query routing in any way but may be used by Coveo to help you manage your configuration properly. | |
isDefault | boolean Whether this query pipeline is the default query pipeline. Note: There must be one and only one default query pipeline in a Coveo Cloud organization. Therefore, setting |
splitTestEnabled | boolean Whether to enable the A/B test. See also the |
splitTestName | string A name which summarizes the intended purpose of the A/B test. See also the |
splitTestRatio | number <double> [ 0 .. 1 ] The percentage of queries to route through query pipeline B if the A/B test is enabled. Remaining queries will be routed through this query pipeline. See also the |
splitTestTarget | string The unique identifier of query pipeline B in the A/B test. See also the |
useCase | string <= 50 characters The use case for which this query pipeline should apply. This option allows you to categorize your query pipeline and enables Coveo to provide better support and improve the tools we provide. |
{- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "apiKeysThatCanEdit": [
- {
- "id": "string"
}
], - "condition": {
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}, - "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "string",
- "groupsThatCanEdit": [
- {
- "id": "string"
}
], - "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "name": "Community",
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support"
}
{- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "created_by": "asmith@example.com",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "@source==CommunityForum OR @source==CommunityDocumentation",
- "id": "120deecf-7822-4d7b-885f-53f184a3a76c",
- "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "last_modified_by": "bjones@example.com",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "name": "Community",
- "position": 3,
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support"
}
Duplicates a single query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"CREATE","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The permissions to set on the duplicated pipeline
Array of objects (IdentifiedResource) | |
Array of objects (IdentifiedResource) |
{- "apiKeysThatCanEdit": [
- {
- "id": "string"
}
], - "groupsThatCanEdit": [
- {
- "id": "string"
}
]
}
{- "aduiConfig": {
- "tooltipsDismissed": [
- {
- "id": "string"
}
]
}, - "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "created_by": "asmith@example.com",
- "description": "Provide contextually relevant query recommendations/results to Community site users.",
- "filter": "@source==CommunityForum OR @source==CommunityDocumentation",
- "id": "120deecf-7822-4d7b-885f-53f184a3a76c",
- "interfaceUrls": [
- {
- "url": "www.acme.com"
}
], - "isDefault": false,
- "last_modified_by": "bjones@example.com",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "name": "Community",
- "position": 3,
- "splitTestEnabled": true,
- "splitTestName": "Community VS default",
- "splitTestRatio": 0.5,
- "splitTestTarget": "22a3860e-fa6f-4e64-a9f1-ef738af0786e",
- "useCase": "Service & Support"
}
Import the definition, condition, and description of statements from a CSV file to a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
feature | string The query pipeline feature to match. Allowed values: By default, results are not required to match a specific query pipeline feature. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
fileName required | string <binary> |
"string"
Swaps the names of two query pipelines. Doing so will affect the routing of incoming queries whose pipeline
parameter is defined as the name
value of one of the swapped query pipelines.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
other required | string The unique identifier of the query pipeline to swap names with. |
"string"
Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
feature | string The query pipeline feature to match. Allowed values: By default, results are not required to match a specific query pipeline feature. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string The sort criteria to apply on the results. Allowed values: Default: |
{- "statements": [
- {
- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Creates a new query pipeline statement in a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The query pipeline statement information.
definition required | string The query pipeline language expression that defines this statement (see Query Pipeline Language (QPL)). |
feature required | string Enum: "filter" "trigger" "ranking" "stop" "thesaurus" … 6 more The query pipeline feature expressed by this statement (see Query Pipeline Language (QPL)). |
description | string The intended purpose of this statement in an actual implementation. |
id | string The unique identifier of this statement. |
parent | string The unique identifier of the condition that must be met for this statement to apply. |
{- "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "feature": "ranking",
- "id": "string",
- "parent": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}
{- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
feature | string The query pipeline feature to match. Allowed values: By default, results are not required to match a specific query pipeline feature. |
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string The sort criteria to apply on the results. Allowed values: Default: |
A set of parameters to customize the results.
ids | Array of strings[ items <= 1000 items ] A list of resource identifiers to get. A maximum of 1000 can be sent. |
{- "ids": [
- "string"
]
}
{- "statements": [
- {
- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Copies specific statements from an origin to a target query pipeline. Using the same pipeline as origin and target will duplicate the specified statements in that pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The copy operation to perform.
destinationPipelineId required | string The unique identifier of the query pipeline to copy the statements to. |
statementIds required | Array of strings The unique identifiers of the query pipeline statements to copy. |
{- "destinationPipelineId": "120deecf-7822-4d7b-885f-53f184a3a76",
- "statementIds": [
- "4f0a9531-4fab-45fd-a1e3-eb07a5aceccb"
]
}
{- "statements": [
- {
- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Exports the definition, condition, and description of statements from a specific query pipeline to a CSV file.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
feature | string The query pipeline feature to match. Allowed values: By default, results are not required to match a specific query pipeline feature. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "message": "Bad request.",
- "statusCode": 400
}
Validate that a specific operation would be accepted by our API and executed.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains an operation to validate.
required | object (RestOperationValidationRequestIncomingStatement) | ||||||
|
{- "operation": {
- "model": {
- "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "feature": "ranking",
- "id": "string",
- "parent": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}, - "operationType": "CREATE",
- "resourceId": "id"
}
}
{- "result": {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
}
Validate that a list of operations would be accepted by our API and executed. A maximum of 15 can be processed per request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains the list of operations to validate.
required | Array of objects (RestOperationValidationRequestIncomingStatement) A list of operations to validate. | ||||||
Array
|
{- "operations": [
- {
- "model": { },
- "operationType": "CREATE"
}, - {
- "model": { },
- "operationType": "UPDATE",
- "resourceId": "resource-id"
}, - {
- "operationType": "DELETE",
- "resourceId": "resource-id"
}
]
}
{- "results": [
- {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
]
}
Deletes a single query pipeline statement from a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
"string"
Gets a single query pipeline statement from a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
Updates a single query pipeline statement in a specific query pipeline.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"{pipelineId}"},
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The updated query pipeline statement information.
definition required | string The query pipeline language expression that defines this statement (see Query Pipeline Language (QPL)). |
feature required | string Enum: "filter" "trigger" "ranking" "stop" "thesaurus" … 6 more The query pipeline feature expressed by this statement (see Query Pipeline Language (QPL)). |
description | string The intended purpose of this statement in an actual implementation. |
id | string The unique identifier of this statement. |
parent | string The unique identifier of the condition that must be met for this statement to apply. |
{- "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "feature": "ranking",
- "id": "string",
- "parent": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e"
}
{- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
Sets the position of a query pipeline statement in a specific query pipeline and updates other statement positions as appropriate.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"{pipelineId}"}
pipelineId required | string The unique identifier of the target query pipeline. |
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The move operation to perform.
after | string The unique identifier of the statement after which to move this statement in the target query pipeline. Use either this property or the |
pageSize | integer <int32> Deprecated
|
position | integer <int32> The 1-based position of this statement relative to other statements in the target query pipeline. Use either this property or the |
{- "after": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "pageSize": 0,
- "position": 0
}
{- "statements": [
- {
- "childrenCount": 0,
- "condition": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "definition": "boost `coveo` by 100",
- "description": "Spotlight the Coveo brand in query results.",
- "detailed": null,
- "displayName": "",
- "feature": "ranking",
- "id": "0befc717-dfd7-4962-9b85-28f5c26fd23b",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}, - "position": 2,
- "ready": false,
- "statementGroupId": "string",
- "warnings": [
- "The Salesforce index does not support the use of keywords in a ranking expression."
]
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Gets a sorted page of condition statements matching certain criteria.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string The sort criteria to apply on the results. Allowed values: Default: |
{- "statements": [
- {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Creates a new condition statement.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The condition statement information.
definition required | string <= 10000 characters The query pipeline language expression that defines this statement (see Query Pipeline Language (QPL)). |
description | string The intended purpose of this statement in an actual implementation. |
{- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site..."
}
{- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}
Gets a sorted page of condition statements matching certain criteria.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
filter | string The query filter to match. This allows you to search within query pipeline statement definitions and descriptions. By default, results are not required to match a specific query filter. |
isOrderAscending | boolean Default: true Whether to sort the results in ascending order. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
sortBy | string The sort criteria to apply on the results. Allowed values: Default: |
A set of parameters to customize the results.
ids | Array of strings[ items <= 1000 items ] A list of resource identifiers to get. A maximum of 1000 can be sent. |
{- "ids": [
- "string"
]
}
{- "statements": [
- {
- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}
], - "totalCount": 1,
- "totalEntries": 1,
- "totalPages": 1
}
Validate that a specific operation would be accepted by our API and executed.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that describes the operation to validate, the resource to target, and the model payload to use.
required | object (RestOperationValidationRequestIncomingCondition) | ||||||
|
{- "operation": {
- "model": {
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site..."
}, - "operationType": "CREATE",
- "resourceId": "id"
}
}
{- "result": {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
}
Validate that a list of operations would be accepted by our API and executed. A maximum of 15 can be processed per request.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
An object that contains the list of operations to validate.
required | Array of objects (RestOperationValidationRequestIncomingCondition) A list of operations to validate. | ||||||
Array
|
{- "operations": [
- {
- "model": { },
- "operationType": "CREATE"
}, - {
- "model": { },
- "operationType": "UPDATE",
- "resourceId": "resource-id"
}, - {
- "operationType": "DELETE",
- "resourceId": "resource-id"
}
]
}
{- "results": [
- {
- "operationType": "CREATE",
- "operationValid": true,
- "resourceId": "id",
- "validationErrors": "Access Denied. You don't have the required privileges to perform this operation."
}
]
}
Deletes a single condition statement.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"*"}
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
Gets a single condition statement.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
{- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}
Updates a single condition statement.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"EDIT","targetId":"*"}
statementId required | string The unique identifier of the target statement. |
organizationId | string Example: organizationId=mycoveocloudv2organization The unique identifier of the target Coveo Cloud organization. Specifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token. |
The updated condition statement information
definition required | string <= 10000 characters The query pipeline language expression that defines this statement (see Query Pipeline Language (QPL)). |
description | string The intended purpose of this statement in an actual implementation. |
{- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site..."
}
{- "childrenCount": 0,
- "condition": "string",
- "definition": "when $searchhub is \"community\"",
- "description": "If the query originates from the community site...",
- "detailed": {
- "condition": {
- "left": null,
- "operator": "string",
- "right": null
}
}, - "feature": "when",
- "id": "45a7892e-a63f-4c8e-8795-ab38c8c18d7e",
- "modifiedAt": "2021-02-16T15:15:17Z",
- "modifiedBy": "bjones@example.com",
- "parent": "string",
- "position": 0,
- "ready": true
}
API that allows to debug how the passage(s) retrieval was performed for a particular query.
Note: The debug endpoint of the Passage Retrieval API is currently in alpha.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","type":"ENABLE","targetId":"*"}
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
viewAllContent | boolean Whether to bypass document permissions. Only effective if the access token grants the Search - View all content privilege. |
required | object Localization parameter. |
query required | string <= 1000 characters The query for which to retrieve the passage(s). |
additionalFields | Array of strings <= 5 items [^([a-z][a-z0-9_]{0,254})$] The fields to include in the response. When omitted, only the identifier of the document will be returned. |
object or null 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 | |
filter | string A filter expression that will be applied during the first stage retrieval. The expression must comply with the Coveo Query Language (CQL) syntax. |
maxPassages | integer <int32> [ 1 .. 20 ] Default: 5 The maximum number of passage(s) to retrieve. |
searchHub | string 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:
|
{- "additionalFields": [
- "clickableuri"
], - "context": {
- "userAgeRange": "25-35",
- "userRoles": [
- "PremiumCustomer",
- "ProductReviewer"
]
}, - "filter": "@source==\"acme\"\n",
- "localization": {
- "locale": "en-CA",
- "timezone": "America/Montreal"
}, - "maxPassages": 5,
- "query": "What are the benefits of using solar energy?",
- "searchHub": "Main"
}
{- "firstStageRetrievalResults": [
- {
- "primaryid": "#AVUVKMCSIZLEYVLVMNLGQ4JQK4XDMNBQGY4C4ZDFMZQXK3DU",
- "score": 460
}, - {
- "primaryid": "BVUVKMCSIZLEYVLVMNLGQ4JQK4XDMNBQGY4C4ZDFMZQXK3DU",
- "score": 120
}, - {
- "primaryid": "CVUVKMCSIZLEYVLVMNLGQ4JQK4XDMNBQGY4C4ZDFMZQXK3DU",
- "score": 60
}
], - "passages": [
- {
- "document": {
- "primaryid": "bDMzdA",
- "title": "The Benefits of Solar Energy"
}, - "relevanceScore": 0.85,
- "text": "Solar energy has several benefits including reducing electricity bills, providing a renewable energy source, and lowering carbon footprint.\""
}
], - "responseId": "c0857557-5579-4f5e-8958-9befd7d1d4a8",
- "warnings": [
- "No index items matched your query, therefore no passages could be retrieved. Try rephrasing your query or checking whether the query pipeline filters are too restrictive.",
- "No passages were retrieved for the query. Review whether your passage retrieval model is up-to-date and is trained on the documents relevant to your query."
]
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
[- {
- "assertionConsumerServiceUrl": "string",
- "enforceTrustedUris": true,
- "expiration": 0,
- "id": "string",
- "metadata": "string",
- "name": "string",
- "organization": "string",
- "protocol": "SAML",
- "provider": "string",
- "relyingPartyIdentifier": "string",
- "secret": "string"
}
]
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
[- {
- "assertionConsumerServiceUrl": "string",
- "enforceTrustedUris": true,
- "expiration": 0,
- "id": "string",
- "metadata": "string",
- "name": "string",
- "organization": "string",
- "protocol": "SAML",
- "provider": "string",
- "relyingPartyIdentifier": "string",
- "secret": "string"
}
]
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
The SAML authentication data
expiration required | integer <int32> |
metadata required | string |
name required | string |
assertionConsumerServiceUrl | string |
enforceTrustedUris | boolean Default: true |
relyingPartyIdentifier | string |
{- "assertionConsumerServiceUrl": "string",
- "enforceTrustedUris": true,
- "expiration": 0,
- "metadata": "string",
- "name": "string",
- "relyingPartyIdentifier": "string"
}
{- "id": "string"
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
id required | string The SAML authentication ID |
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
id required | string The SAML authentication ID |
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
{- "assertionConsumerServiceUrl": "string",
- "enforceTrustedUris": true,
- "expiration": 0,
- "id": "string",
- "metadata": "string",
- "name": "string",
- "organization": "string",
- "protocol": "SAML",
- "provider": "string",
- "relyingPartyIdentifier": "string",
- "secret": "string"
}
undefined
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
id required | string The SAML authentication ID |
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
The SAML authentication data
expiration required | integer <int32> |
metadata required | string |
name required | string |
assertionConsumerServiceUrl | string |
enforceTrustedUris | boolean Default: true |
relyingPartyIdentifier | string |
{- "assertionConsumerServiceUrl": "string",
- "enforceTrustedUris": true,
- "expiration": 0,
- "metadata": "string",
- "name": "string",
- "relyingPartyIdentifier": "string"
}
Gets all existing trusted search page URI entries in a specific Coveo Cloud organization.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
{- "totalCount": 1
}
Creates a new trusted search page URI entry in a specific Coveo Cloud organization. Any search page whose URI begins with that prefix will be allowed to use the SAML SSO provider of that organization as a means of authentication.
Notes:
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
The trusted search page URI information.
required | object | ||
|
{
}
{
}
Lists URI that were recently seen during SSO but that were not trusted. The last 100 URI are kept for 7 days.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
page | integer <int32> >= 0 Default: 0 The 0-based number of the page of results to get. |
perPage | integer <int32> [ 0 .. 200 ] Default: 20 The number of results to include per page. |
{- "totalCount": 1
}
Removes a trusted search page URI entry from a specific Coveo Cloud organization.
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
id required | string The unique identifier of the trusted search page URI entry to delete. |
organizationId required | string The unique identifier of the target Coveo Cloud organization. |
"string"