Coveo Machine Learning API — Advanced Model Configurations

naftiko: 1.0.0-alpha2
info:
  label: Coveo Machine Learning API — Advanced Model Configurations
  description: 'Coveo Machine Learning API — Advanced Model Configurations. 4 operations. Lead operation: List Advanced Registration
    Configuration Files for the Model. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Machine Learning
  - Advanced Model Configurations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: machine-learning-advanced-model-configurations
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Machine Learning API — Advanced Model Configurations business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-machinelearning-models-modelId-configs-status
      path: /rest/organizations/{organizationId}/machinelearning/models/{modelId}/configs/status
      operations:
      - name: getallconfigfilesstatus
        method: GET
        description: List Advanced Registration Configuration Files for the Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: modelId
          in: path
          type: string
          description: The unique identifier of the target model
          required: true
    - name: rest-organizations-organizationId-machinelearning-models-modelId-configs-configu
      path: /rest/organizations/{organizationId}/machinelearning/models/{modelId}/configs/{configurationType}
      operations:
      - name: download
        method: GET
        description: Download the Specified Configuration File for the Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: modelId
          in: path
          type: string
          description: The unique identifier of the target model
          required: true
        - name: configurationType
          in: path
          type: string
          description: The type of advanced configuration file.
          required: true
        - name: languageCode
          in: query
          type: string
          description: The language of the configuration file to retrieve. It must be an <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO
            639-1 code</a>, or the str
      - name: upload
        method: PUT
        description: 'Upload configuration file for the model. Maximum file size allowed: 10 MB.<br /><br /><details><summary>Privilege
          required</summary>'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: modelId
          in: path
          type: string
          description: The unique identifier of the target model
          required: true
        - name: configurationType
          in: path
          type: string
          description: The type of advanced configuration file.
          required: true
        - name: languageCode
          in: query
          type: string
          description: The language of the configuration file to retrieve. It must be an <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO
            639-1 code</a>, or the str
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletefile
        method: DELETE
        description: Delete Configuration File for the Model.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target Coveo Cloud organization
          required: true
        - name: modelId
          in: path
          type: string
          description: The unique identifier of the target model
          required: true
        - name: configurationType
          in: path
          type: string
          description: The type of advanced configuration file.
          required: true
        - name: languageCode
          in: query
          type: string
          description: The language of the configuration file to retrieve. Only required when the specified modelConfigFileType
            is language-specific (e.g., STOPWORDS), and ignored oth
  exposes:
  - type: rest
    namespace: machine-learning-advanced-model-configurations-rest
    port: 8080
    description: REST adapter for Coveo Machine Learning API — Advanced Model Configurations. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/machinelearning/models/{modelid}/configs/status
      name: rest-organizations-organizationid-machinelearning-models-modelid-configs-status
      description: REST surface for rest-organizations-organizationId-machinelearning-models-modelId-configs-status.
      operations:
      - method: GET
        name: getallconfigfilesstatus
        description: List Advanced Registration Configuration Files for the Model
        call: machine-learning-advanced-model-configurations.getallconfigfilesstatus
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/models/{modelid}/configs/{configurationtype}
      name: rest-organizations-organizationid-machinelearning-models-modelid-configs-configu
      description: REST surface for rest-organizations-organizationId-machinelearning-models-modelId-configs-configu.
      operations:
      - method: GET
        name: download
        description: Download the Specified Configuration File for the Model
        call: machine-learning-advanced-model-configurations.download
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
          configurationType: rest.configurationType
          languageCode: rest.languageCode
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: upload
        description: 'Upload configuration file for the model. Maximum file size allowed: 10 MB.<br /><br /><details><summary>Privilege
          required</summary>'
        call: machine-learning-advanced-model-configurations.upload
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
          configurationType: rest.configurationType
          languageCode: rest.languageCode
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletefile
        description: Delete Configuration File for the Model.
        call: machine-learning-advanced-model-configurations.deletefile
        with:
          organizationId: rest.organizationId
          modelId: rest.modelId
          configurationType: rest.configurationType
          languageCode: rest.languageCode
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: machine-learning-advanced-model-configurations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Machine Learning API — Advanced Model Configurations. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-advanced-registration-configuration-files
      description: List Advanced Registration Configuration Files for the Model
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: machine-learning-advanced-model-configurations.getallconfigfilesstatus
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
      outputParameters:
      - type: object
        mapping: $.
    - name: download-specified-configuration-file-model
      description: Download the Specified Configuration File for the Model
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: machine-learning-advanced-model-configurations.download
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
        configurationType: tools.configurationType
        languageCode: tools.languageCode
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-configuration-file-model-maximum
      description: 'Upload configuration file for the model. Maximum file size allowed: 10 MB.<br /><br /><details><summary>Privilege
        required</summary>'
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: machine-learning-advanced-model-configurations.upload
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
        configurationType: tools.configurationType
        languageCode: tools.languageCode
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-configuration-file-model
      description: Delete Configuration File for the Model.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: machine-learning-advanced-model-configurations.deletefile
      with:
        organizationId: tools.organizationId
        modelId: tools.modelId
        configurationType: tools.configurationType
        languageCode: tools.languageCode
      outputParameters:
      - type: object
        mapping: $.