API docs by Redocly

Machine Learning Configuration API (v1)

Case Classification Configuration

Get CC content fields

Get the content fields that a model can use for the specified parameters.

Privilege required

{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

object (CaseExtractionPeriodModel)

The period during which the cases will be extracted.

Array of objects (CaseFilterConditionModel)

The custom filter conditions for the cases.

Array
field
required
string

The field to use for the filter.
Example: author

operator
required
string
Enum: "EQUALS" "NOT_EQUALS" "EQUALS, NOT_EQUALS"

The operator to use for the condition.
Example: EQUALS

value
required
string

The value to use for the filter.
Example: John Smith

languageField
string

The field used to identify the language.
Example: language

sources
Array of strings

The names of the sources that contain the cases.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "caseExtractionPeriod": {
    },
  • "caseFilterConditions": [
    ],
  • "languageField": "language",
  • "sources": [
    ]
}

getDocumentCountForField

Privilege required ``` {"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"} ```
Authorizations:
oauth2
path Parameters
fieldName
required
string
Example: author

Name of the field

organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

object (CaseExtractionPeriodModel)

The period during which the cases will be extracted.

Array of objects (CaseFilterConditionModel)

The custom filter conditions for the cases.

Array
field
required
string

The field to use for the filter.
Example: author

operator
required
string
Enum: "EQUALS" "NOT_EQUALS" "EQUALS, NOT_EQUALS"

The operator to use for the condition.
Example: EQUALS

value
required
string

The value to use for the filter.
Example: John Smith

languageField
string

The field used to identify the language.
Example: language

sources
Array of strings

The names of the sources that contain the cases.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "caseExtractionPeriod": {
    },
  • "caseFilterConditions": [
    ],
  • "languageField": "language",
  • "sources": [
    ]
}

getValueCountForField

Privilege required ``` {"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"} ```
Authorizations:
oauth2
path Parameters
fieldName
required
string
Example: author

Name of the field

organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

object (CaseExtractionPeriodModel)

The period during which the cases will be extracted.

Array of objects (CaseFilterConditionModel)

The custom filter conditions for the cases.

Array
field
required
string

The field to use for the filter.
Example: author

operator
required
string
Enum: "EQUALS" "NOT_EQUALS" "EQUALS, NOT_EQUALS"

The operator to use for the condition.
Example: EQUALS

value
required
string

The value to use for the filter.
Example: John Smith

languageField
string

The field used to identify the language.
Example: language

sources
Array of strings

The names of the sources that contain the cases.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "caseExtractionPeriod": {
    },
  • "caseFilterConditions": [
    ],
  • "languageField": "language",
  • "sources": [
    ]
}

Get preview for building a CC model.

Shows the number of support cases that match the Case Classification (CC) requirements in the targeted sources.

Privilege required

{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

object (CaseExtractionPeriodModel)

The period during which the cases will be extracted.

Array of objects (CaseFilterConditionModel)

The custom filter conditions for the cases.

Array
field
required
string

The field to use for the filter.
Example: author

operator
required
string
Enum: "EQUALS" "NOT_EQUALS" "EQUALS, NOT_EQUALS"

The operator to use for the condition.
Example: EQUALS

value
required
string

The value to use for the filter.
Example: John Smith

languageField
string

The field used to identify the language.
Example: language

sources
Array of strings

The names of the sources that contain the cases.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "caseExtractionPeriod": {
    },
  • "caseFilterConditions": [
    ],
  • "languageField": "language",
  • "sources": [
    ]
}

Dynamic Navigation Experience Configuration

List fields

Retrieves a filtered and paginated list of fields from the index of the target Coveo Cloud organization.

Required privilege: Fields - View

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
filter
string
Default: ""

A substring that must appear in the name property of a field in order for this field to be included in the results.
Example: author

page
integer <int32>
Default: 0

The 0-based number of the page of results to list.
Minimum: 0
Default: 0

perPage
integer <int32>
Default: 100

The maximum number of results to include per page.
Must be in range: [1, 1000]
Default: 100

Responses

Show document extraction preview

Shows information about the documents to be extracted.

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
AND
{"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}
AND
{"owner":"SEARCH_API","targetDomain":"VIEW_ALL_CONTENT","type":"ENABLE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
fields
required
Array of strings
Example: fields=filetype,category

The names of the fields to consider for the document extraction preview. Documents for which at least one of these fields is defined will be included in the preview.
Example: filetype,category

maximumNumberOfSources
integer <int32>
Default: 10

The maximum number of sources to return.
Example: 10

viewAllContent
required
boolean

Whether to allow the preview to include secured documents.

Responses

Show document extraction query

Shows the query that determines the documents to extract.

Privilege required

{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
fields
Array of strings

The names of the fields to consider for the document extraction query. Documents for which at least one of these fields is defined will be included in the preview.
Example: ["filetype","category"]

sources
Array of strings

The names of the sources to consider for the document extraction query. If unspecified, documents from any sources may be included in the preview.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "fields": [
    ],
  • "sources": [
    ]
}

Parse a document extraction query

Parses the query that determines the documents to extract.

Privilege required

{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
query
required
string
Example: query=(@filetype OR @category) AND @source==("My source")

The query that determines the documents to extract. Use the POST /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery endpoint to generate the proper query.
Example: (@filetype OR @category) AND @source==("My source")

Responses

Create DNE model resources

Creates resources for a Dynamic Navigation Experience (DNE) model.

Privilege required

{"owner":"COVEO_ML","targetDomain":"MODELS","type":"CREATE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
modelDisplayName
required
string

The model display name in the Coveo Administration console.
Example: MyModelDisplayName

commonFilter
string

The filter to apply to the ’Common’ event dimensions (shared by all event types) of the UA data to learn from when rebuilding the model.

See Usge Analytics Read Filter Syntax.
Example: (originlevel1 == "My Hub")

documentExtractionQuery
string

The query that determines the documents to extract. Use the POST /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery endpoint to generate the proper query. Note: Once set, this property cannot be updated.
Example: (@filetype OR @category) AND @source==("My source")

exportPeriod
string

The period of UA data to learn from when rebuilding the model. The exportPeriod uses the moment when the model was last generated as a base. Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
Example: P1M

fieldsToAutoSelect
Array of strings

The names of the fields to consider for automatic selection. Note: Once set, this property cannot be updated.
Example: ["filetype", "category"]

intervalTime
integer <int32>
Value: null

The number of intervalUnit to wait between each rebuild of the model.

Must be greater than or equal to 1.
Example: 1

intervalUnit
string
Value: "DAY,WEEK,MONTH"

The duration unit to use when interpreting the rebuild intervalTime for the model.
Example: WEEK

searchEventFilter
string

The filter to apply to the ‘Click’ and ‘Search’ event dimensions of the UA data to learn from when rebuilding the model.

See Usge Analytics Read Filter Syntax.
Example: (originlevel1 == "My Hub")

viewAllContent
boolean

Whether to allow the model to extract secured documents. Note: Once set, this property cannot be updated.

Responses

Request samples

Content type
application/json
{
  • "commonFilter": "(originlevel1 == \"My Hub\")",
  • "documentExtractionQuery": "(@filetype OR @category) AND @source==(\"My source\")",
  • "exportPeriod": "P1M",
  • "fieldsToAutoSelect": [
    ],
  • "intervalTime": 1,
  • "intervalUnit": "WEEK",
  • "modelDisplayName": "MyModelDisplayName",
  • "searchEventFilter": "(originlevel1 == \"My Hub\")",
  • "viewAllContent": true
}

Delete DNE model resources

Deletes resources for a Dynamic Navigation Experience (DNE) model.

Privilege required

{"owner":"COVEO_ML","targetDomain":"MODELS","type":"EDIT","targetId":"*"}
Authorizations:
oauth2
path Parameters
modelId
required
string
Example: My_Model_ID

The unique identifier of the target machine learning model.
Example: My_Model_ID

organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Show DNE model resources

Shows resources for a Dynamic Navigation Experience (DNE) model.

Privilege required

{"owner":"COVEO_ML","targetDomain":"MODELS","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
modelId
required
string
Example: My_Model_ID

The unique identifier of the target machine learning model.
Example: My_Model_ID

organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Update DNE model resources

Updates the configuration of the resources for a Dynamic Navigation Experience (DNE) model.

Privilege required

{"owner":"COVEO_ML","targetDomain":"MODELS","type":"EDIT","targetId":"*"}
Authorizations:
oauth2
path Parameters
modelId
required
string
Example: My_Model_ID

The unique identifier of the target machine learning model.
Example: My_Model_ID

organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
modelDisplayName
required
string

The model display name in the Coveo Administration console.
Example: MyModelDisplayName

commonFilter
string

The filter to apply to the ’Common’ event dimensions (shared by all event types) of the UA data to learn from when rebuilding the model.

See Usge Analytics Read Filter Syntax.
Example: (originlevel1 == "My Hub")

documentExtractionQuery
string

The query that determines the documents to extract. Use the POST /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery endpoint to generate the proper query. Note: Once set, this property cannot be updated.
Example: (@filetype OR @category) AND @source==("My source")

exportPeriod
string

The period of UA data to learn from when rebuilding the model. The exportPeriod uses the moment when the model was last generated as a base. Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
Example: P1M

fieldsToAutoSelect
Array of strings

The names of the fields to consider for automatic selection. Note: Once set, this property cannot be updated.
Example: ["filetype", "category"]

intervalTime
integer <int32>
Value: null

The number of intervalUnit to wait between each rebuild of the model.

Must be greater than or equal to 1.
Example: 1

intervalUnit
string
Value: "DAY,WEEK,MONTH"

The duration unit to use when interpreting the rebuild intervalTime for the model.
Example: WEEK

modelId
string

The unique identifier of the target machine learning model.
Example: My_Model_ID

searchEventFilter
string

The filter to apply to the ‘Click’ and ‘Search’ event dimensions of the UA data to learn from when rebuilding the model.

See Usge Analytics Read Filter Syntax.
Example: (originlevel1 == "My Hub")

viewAllContent
boolean

Whether to allow the model to extract secured documents. Note: Once set, this property cannot be updated.

Responses

Request samples

Content type
application/json
{
  • "commonFilter": "(originlevel1 == \"My Hub\")",
  • "documentExtractionQuery": "(@filetype OR @category) AND @source==(\"My source\")",
  • "exportPeriod": "P1M",
  • "fieldsToAutoSelect": [
    ],
  • "intervalTime": 1,
  • "intervalUnit": "WEEK",
  • "modelDisplayName": "MyModelDisplayName",
  • "modelId": "My_Model_ID",
  • "searchEventFilter": "(originlevel1 == \"My Hub\")",
  • "viewAllContent": true
}

Parse a document extraction query

Parses the query that determines the documents to extract.

Privilege required

{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
string

The query that determines the documents to extract. Use the POST /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery endpoint to generate the proper query.
Example: (@filetype OR @category) AND @source==("My source")

Responses

Request samples

Content type
application/json
"string"

Model Detailed Info

Fetch model

Fetch the model corresponding to the specified model ID.

Privilege required

{"owner":"COVEO_ML","targetDomain":"MODELS","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
modelId
required
string
Example: My_Model_ID

The unique identifier of the target machine learning model.
Example: My_Model_ID

organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Model Listing

List models

Lists the organization models corresponding to the specified engine IDs.

Privilege required

{"owner":"COVEO_ML","targetDomain":"MODELS","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
engineIds
Array of strings
Example: engineIds=topclicks, querysuggest

The engine identifiers of the machine learning models to request.

Responses

List models

Lists the organization models corresponding to the specified IDs.

Privilege required

{"owner":"COVEO_ML","targetDomain":"MODELS","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
displayNameAndRegistrationIdFilter
string
engineIds
Array of strings
projectId
string
registrationIds
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "displayNameAndRegistrationIdFilter": "string",
  • "engineIds": [
    ],
  • "projectId": "string",
  • "registrationIds": [
    ]
}

Predictive Query Suggest Configuration

Create PQS model resources

Creates resources for a Predictive Query Suggest (PQS) model.

Privilege required

{"owner":"COVEO_ML","targetDomain":"MODELS","type":"CREATE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
catalogId
required
string

The unique identifier of the catalog to be used by the model to infer personalized suggestions based on product vectors.
Example: catalogId

modelDisplayName
required
string

The model display name in the Coveo Administration console.
Example: MyModelDisplayName

trackingIds
required
Array of strings

The trackingIds that usage analytics events must contain for the model to use those events in its learning process. The model will use an event if it contains at least one of the specified IDs

commonFilter
string

The filter to apply to the ’Common’ event dimensions (shared by all event types) of the UA data to learn from when rebuilding the model.

See Usge Analytics Read Filter Syntax.
Example: (originlevel1 == "My Hub")

exportPeriod
string

The period of UA data to learn from when rebuilding the model. The exportPeriod uses the moment when the model was last generated as a base. Must be in the ISO8601 period format (i.e., PyYmMwWdDThHmMsS).
Example: P1M

intervalTime
integer <int32>
Value: null

The number of intervalUnit to wait between each rebuild of the model.

Must be greater than or equal to 1.
Example: 1

intervalUnit
string
Value: "DAY,WEEK,MONTH"

The duration unit to use when interpreting the rebuild intervalTime for the model.
Example: WEEK

modelId
string

The unique identifier of the target machine learning model.
Example: My_Model_ID

searchEventFilter
string

The filter to apply to the ‘Click’ and ‘Search’ event dimensions of the UA data to learn from when rebuilding the model.

See Usge Analytics Read Filter Syntax.
Example: (originlevel1 == "My Hub")

Responses

Request samples

Content type
application/json
{
  • "catalogId": "catalogId",
  • "commonFilter": "(originlevel1 == \"My Hub\")",
  • "exportPeriod": "P1M",
  • "intervalTime": 1,
  • "intervalUnit": "WEEK",
  • "modelDisplayName": "MyModelDisplayName",
  • "modelId": "My_Model_ID",
  • "searchEventFilter": "(originlevel1 == \"My Hub\")",
  • "trackingIds": [
    ]
}

Model Associations

Lists associations

Lists the organization associations corresponding to the specified pipelineId.

Privilege required

{"owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

pipelineId
required
string
query Parameters
page
integer <int32>
Default: 0

The 0-based number of the page of results to list.
Minimum: 0
Default: 0

pageSize
integer <int32>
Default: 100

The maximum number of results to include per page.
Must be in range: [1, 1000]
Default: 100

Responses

Relevance Generative Answering Configuration

Get preview for building an RGA model

Show how many documents matching various RGA requirements are in the selection.

Privilege required

{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

Array of objects (FilterConditionModel)

The custom filter conditions to target specific documents.

sources
Array of strings

The names of the sources containing the items that the model should use to extract chunks.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "filterConditions": [
    ],
  • "sources": [
    ]
}

Semantic Encoder Configuration

Get preview for building an SE model

Show how many documents matching various SE requirements are in the selection.

Privilege required

{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

Array of objects (FilterConditionModel)

The custom filter conditions to target specific documents.

sources
Array of strings

The names of the sources containing the items that the model should use to extract chunks.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "filterConditions": [
    ],
  • "sources": [
    ]
}

Smart Snippets Configuration

Get SS content fields

Get the content fields that a model can use for a given document type.

Privilege required

{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

documentType
string

The document types for which content is in custom index fields.
Example: SupportArticle

Array of objects (FilterConditionModel)

The custom filter conditions to target specific documents.

sources
Array of strings

The names of the sources containing the items that the model should use to extract snippets.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "documentType": "SupportArticle",
  • "filterConditions": [
    ],
  • "sources": [
    ]
}

Get SS document types

Get the document types available for a Smart Snippets (SS) model to use.

Privilege required

{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

Array of objects (FilterConditionModel)

The custom filter conditions to target specific documents.

sources
Array of strings

The names of the sources containing the items that the model should use to extract snippets.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "filterConditions": [
    ],
  • "sources": [
    ]
}

Get preview for building an SS model.

Show how many documents matching SS requirements are in the sources.

Privilege required

{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
advancedQuery
string

The query that determines the documents to extract. Cannot be used with other document extraction parameters, e.g. sources, filter conditions, etc.
Example: @source==("My source") AND @permanentid AND @language="English"

Array of objects (FilterConditionModel)

The custom filter conditions to target specific documents.

sources
Array of strings

The names of the sources containing the items that the model should use to extract snippets.
Example: ["CommunityArticles","SalesforceCatalog"]

Responses

Request samples

Content type
application/json
{
  • "advancedQuery": "@source==(\"My source\") AND @permanentid AND @language=\"English\"",
  • "filterConditions": [
    ],
  • "sources": [
    ]
}