openapi: 3.0.1
info:
title: Coveo Machine Learning Configuration API
description: API for Coveo Platform
termsOfService: https://www.coveo.com/en/support/terms-agreements
contact:
name: Coveo
url: https://connect.coveo.com/s/discussions
version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
security:
- oauth2:
- full
paths:
/rest/organizations/{organizationId}/machinelearning/configuration/dne/model/{modelId}:
get:
tags:
- Dynamic Navigation Experience Configuration
summary: Show DNE Model Resources
description: 'Shows resources for a Dynamic Navigation Experience (DNE) model.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"MODELS","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getModel
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
- name: modelId
in: path
description: The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`
required: true
schema:
type: string
example: My_Model_ID
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DneConfigurationModel'
x-pretty-name: getModel
x-required-privilege:
owner: COVEO_ML
targetDomain: MODELS
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: MODELS
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/dne/model/paramId_get
put:
tags:
- Dynamic Navigation Experience Configuration
summary: Update DNE Model Resources
description: 'Updates the configuration of the resources for a Dynamic Navigation Experience (DNE) model.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"MODELS","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateModel
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
- name: modelId
in: path
description: The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`
required: true
schema:
type: string
example: My_Model_ID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DneConfigurationModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DneConfigurationModel'
x-pretty-name: updateModel
x-required-privilege:
owner: COVEO_ML
targetDomain: MODELS
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: MODELS
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/dne/model/paramId_put
delete:
tags:
- Dynamic Navigation Experience Configuration
summary: Delete DNE Model Resources
description: 'Deletes resources for a Dynamic Navigation Experience (DNE) model.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"MODELS","type":"EDIT","targetId":"*"}
```
</details>'
operationId: deleteModel
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
- name: modelId
in: path
description: The unique identifier of the target machine learning model.<br />**Example:** `My_Model_ID`
required: true
schema:
type: string
example: My_Model_ID
responses:
'204':
description: No Content
x-pretty-name: deleteModel
x-required-privilege:
owner: COVEO_ML
targetDomain: MODELS
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: MODELS
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/dne/model/paramId_delete
/rest/organizations/{organizationId}/machinelearning/configuration/smartsnippets/preview:
post:
tags:
- Smart Snippets Configuration
summary: Get Preview for Building an SS Model.
description: 'Show how many documents matching SS requirements are in the sources.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getDocumentsCountPreview
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SmartSnippetsPreviewRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SmartSnippetsPreviewResponse'
x-pretty-name: getDocumentsCountPreview
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/smartsnippets/preview_post
/rest/organizations/{organizationId}/machinelearning/configuration/smartsnippets/documenttypes:
post:
tags:
- Smart Snippets Configuration
summary: Get SS Document Types
description: 'Get the document types available for a Smart Snippets (SS) model to use.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getDocumentTypes
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SmartSnippetsPreviewRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SmartSnippetsDocumentTypesResponse'
x-pretty-name: getDocumentTypes
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/smartsnippets/documenttypes_post
/rest/organizations/{organizationId}/machinelearning/configuration/smartsnippets/contentfields:
post:
tags:
- Smart Snippets Configuration
summary: Get SS Content Fields
description: 'Get the content fields that a model can use for a given document type.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getContentFields
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SmartSnippetsContentFieldsRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ContentFieldsResponse'
x-pretty-name: getContentFields
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/smartsnippets/contentfields_post
/rest/organizations/{organizationId}/machinelearning/configuration/semanticencoder/preview:
post:
tags:
- Semantic Encoder Configuration
summary: Get Preview for Building an SE Model
description: 'Show how many documents matching various SE requirements are in the selection.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getSemanticEncoderPreview
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticEncoderPreviewRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SemanticEncoderPreviewResponse'
x-pretty-name: getSemanticEncoderPreview
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/semanticencoder/preview_post
/rest/organizations/{organizationId}/machinelearning/configuration/rga/preview:
post:
tags:
- Relevance Generative Answering Configuration
summary: Get Preview for Building an RGA Model
description: 'Show how many documents matching various RGA requirements are in the selection.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getRelevanceGenerativeAnsweringPreview
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RelevanceGenerativeAnsweringPreviewRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RelevanceGenerativeAnsweringPreviewResponse'
x-pretty-name: getRelevanceGenerativeAnsweringPreview
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/rga/preview_post
/rest/organizations/{organizationId}/machinelearning/configuration/pqs/model:
post:
tags:
- Predictive Query Suggest Configuration
summary: Create PQS Model Resources
description: 'Creates resources for a Predictive Query Suggest (PQS) model.<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COVEO_ML","targetDomain":"MODELS","type":"CREATE","targetId":"*"}
```
</details>'
operationId: createModel
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PqsConfigurationModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/PqsConfigurationModel'
x-pretty-name: createModel
x-required-privilege:
owner: COVEO_ML
targetDomain: MODELS
type: CREATE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: MODELS
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/pqs/model_post
/rest/organizations/{organizationId}/machinelearning/configuration/modellisting:
get:
tags:
- Model Listing
summary: List Models
description: 'Lists the organization models corresponding to the specified engine IDs.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"MODELS","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getModels
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
- name: engineIds
in: query
description: The engine identifiers of the machine learning models to request.
required: false
schema:
type: array
items:
type: string
example: topclicks, querysuggest
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/ModelListingModel'
x-pretty-name: getModels
x-required-privilege:
owner: COVEO_ML
targetDomain: MODELS
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: MODELS
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/modellisting_get
post:
tags:
- Model Listing
summary: List Models
description: 'Lists the organization models corresponding to the specified IDs.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"MODELS","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getModels_1
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelListingModelsRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/ModelListingModel'
x-pretty-name: getModels
x-required-privilege:
owner: COVEO_ML
targetDomain: MODELS
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: MODELS
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/modellisting_post
/rest/organizations/{organizationId}/machinelearning/configuration/dne/parsedocumentextractionquerymodel:
post:
tags:
- Dynamic Navigation Experience Configuration
summary: Parse a Document Extraction Query
description: 'Parses the query that determines the documents to extract.<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: parseDocumentExtractionQuery
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
type: string
description: The query that determines the documents to extract. Use the `POST /rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery`
endpoint to generate the proper query.<br />**Example:** `(@filetype OR @category) AND @source==("My source")`
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DocumentExtractionQueryModel'
x-pretty-name: parseDocumentExtractionQuery
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/dne/parsedocumentextractionquerymodel_post
/rest/organizations/{organizationId}/machinelearning/configuration/dne/model:
post:
tags:
- Dynamic Navigation Experience Configuration
summary: Create DNE Model Resources
description: 'Creates resources for a Dynamic Navigation Experience (DNE) model.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"MODELS","type":"CREATE","targetId":"*"}
```
</details>'
operationId: createModel_1
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DneNewConfigurationModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/DneConfigurationModel'
x-pretty-name: createModel
x-required-privilege:
owner: COVEO_ML
targetDomain: MODELS
type: CREATE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: MODELS
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/dne/model_post
/rest/organizations/{organizationId}/machinelearning/configuration/dne/documentextractionquery:
post:
tags:
- Dynamic Navigation Experience Configuration
summary: Show Document Extraction Query
description: 'Shows the query that determines the documents to extract.<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getDocumentExtractionQuery
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentExtractionQueryModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: string
x-pretty-name: getDocumentExtractionQuery
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/dne/documentextractionquery_post
/rest/organizations/{organizationId}/machinelearning/configuration/caseclassif/preview:
post:
tags:
- Case Classification Configuration
summary: Get Preview for Building a CC Model.
description: 'Shows the number of support cases that match the Case Classification (CC) requirements in the targeted
sources.<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getDocumentsCountPreview_1
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseClassificationPreviewRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CaseClassificationPreviewResponse'
x-pretty-name: getDocumentsCountPreview
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/caseclassif/preview_post
/rest/organizations/{organizationId}/machinelearning/configuration/caseclassif/fields:
post:
tags:
- Case Classification Configuration
summary: Get CC Content Fields
description: 'Get the content fields that a model can use for the specified parameters.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getFields
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseClassificationPreviewRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ContentFieldsResponse'
x-pretty-name: getFields
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/caseclassif/fields_post
/rest/organizations/{organizationId}/machinelearning/configuration/caseclassif/fields/{fieldName}/valueCount:
post:
tags:
- Case Classification Configuration
description: '<details><summary>Privilege required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getValueCountForField
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
- name: fieldName
in: path
description: Name of the field
required: true
schema:
type: string
example: author
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseClassificationPreviewRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CaseClassificationValueCountResponse'
x-pretty-name: getValueCountForField
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/caseclassif/fields/paramId/valueCount_post
/rest/organizations/{organizationId}/machinelearning/configuration/caseclassif/fields/{fieldName}/documentCount:
post:
tags:
- Case Classification Configuration
description: '<details><summary>Privilege required</summary>
```
{"owner":"COVEO_ML","targetDomain":"ALLOW_CONTENT_PREVIEW","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getDocumentCountForField
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
- name: fieldName
in: path
description: Name of the field
required: true
schema:
type: string
example: author
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseClassificationPreviewRequest'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CaseClassificationDocumentCountResponse'
x-pretty-name: getDocumentCountForField
x-required-privilege:
owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-required-privileges:
- owner: COVEO_ML
targetDomain: ALLOW_CONTENT_PREVIEW
type: ENABLE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/machinelearning/configuration/caseclassif/fields/paramId/documentCount_post
/rest/organizations/{organizationId}/machinelearning/configuration/querypipelines/{pipelineId}/associations:
get:
tags:
- Model Associations
summary: Lists Associations
description: 'Lists the organization associations corresponding to the specified pipelineId.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"SEARCH_API","targetDomain":"QUERY_PIPELINE","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getAssociations
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
example: mycoveocloudv2organizationg8tp8wu3
- name: pipelineId
in: path
required: true
schema:
type: string
- name: page
in: query
description: 'The 0-based number of the page of results to list.<br />Minimum: `0`<br />**Default:** `0`'
required: false
schema:
type: integer
format: int32
default: 0
- name: pageSize
in: query
description: The maximum number of results to include per page.<br />**Must be in range:** `[1, 1000]`<br />**Default:**
`100`
required: false
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelQueryPipelineMLAssociationModel'
x-pretty-name: getAssociations
x-required-privilege:
owner: SEARCH_API
targetDomain: QUERY_PIPE
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-ml-config-openapi-original.yml