Coveo Machine Learning Configuration API — Case Classification Configuration

naftiko: 1.0.0-alpha2
info:
  label: Coveo Machine Learning Configuration API — Case Classification Configuration
  description: 'Coveo Machine Learning Configuration API — Case Classification Configuration. 4 operations. Lead operation:
    Get CC Content Fields. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Machine Learning Configuration
  - Case Classification Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: ml-config-case-classification-configuration
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Machine Learning Configuration API — Case Classification Configuration business capability. Self-contained,
      no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-machinelearning-configuration-caseclassif-fiel
      path: /rest/organizations/{organizationId}/machinelearning/configuration/caseclassif/fields
      operations:
      - name: getfields
        method: POST
        description: Get CC Content Fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-machinelearning-configuration-caseclassif-fiel
      path: /rest/organizations/{organizationId}/machinelearning/configuration/caseclassif/fields/{fieldName}/documentCount
      operations:
      - name: getdocumentcountforfield
        method: POST
        description: <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 [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: fieldName
          in: path
          type: string
          description: Name of the field
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-machinelearning-configuration-caseclassif-fiel
      path: /rest/organizations/{organizationId}/machinelearning/configuration/caseclassif/fields/{fieldName}/valueCount
      operations:
      - name: getvaluecountforfield
        method: POST
        description: <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 [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: fieldName
          in: path
          type: string
          description: Name of the field
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-machinelearning-configuration-caseclassif-prev
      path: /rest/organizations/{organizationId}/machinelearning/configuration/caseclassif/preview
      operations:
      - name: getdocumentscountpreview1
        method: POST
        description: Get Preview for Building a CC Model.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: ml-config-case-classification-configuration-rest
    port: 8080
    description: REST adapter for Coveo Machine Learning Configuration API — Case Classification Configuration. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/caseclassif/fields
      name: rest-organizations-organizationid-machinelearning-configuration-caseclassif-fiel
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-caseclassif-fiel.
      operations:
      - method: POST
        name: getfields
        description: Get CC Content Fields
        call: ml-config-case-classification-configuration.getfields
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/caseclassif/fields/{fieldname}/documentcount
      name: rest-organizations-organizationid-machinelearning-configuration-caseclassif-fiel
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-caseclassif-fiel.
      operations:
      - method: POST
        name: getdocumentcountforfield
        description: <details><summary>Privilege required</summary>
        call: ml-config-case-classification-configuration.getdocumentcountforfield
        with:
          organizationId: rest.organizationId
          fieldName: rest.fieldName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/caseclassif/fields/{fieldname}/valuecount
      name: rest-organizations-organizationid-machinelearning-configuration-caseclassif-fiel
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-caseclassif-fiel.
      operations:
      - method: POST
        name: getvaluecountforfield
        description: <details><summary>Privilege required</summary>
        call: ml-config-case-classification-configuration.getvaluecountforfield
        with:
          organizationId: rest.organizationId
          fieldName: rest.fieldName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/machinelearning/configuration/caseclassif/preview
      name: rest-organizations-organizationid-machinelearning-configuration-caseclassif-prev
      description: REST surface for rest-organizations-organizationId-machinelearning-configuration-caseclassif-prev.
      operations:
      - method: POST
        name: getdocumentscountpreview1
        description: Get Preview for Building a CC Model.
        call: ml-config-case-classification-configuration.getdocumentscountpreview1
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ml-config-case-classification-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Machine Learning Configuration API — Case Classification Configuration. One tool per
      consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: get-cc-content-fields
      description: Get CC Content Fields
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ml-config-case-classification-configuration.getfields
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: details-summary-privilege-required-summary
      description: <details><summary>Privilege required</summary>
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ml-config-case-classification-configuration.getdocumentcountforfield
      with:
        organizationId: tools.organizationId
        fieldName: tools.fieldName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: details-summary-privilege-required-summary-2
      description: <details><summary>Privilege required</summary>
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ml-config-case-classification-configuration.getvaluecountforfield
      with:
        organizationId: tools.organizationId
        fieldName: tools.fieldName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-preview-building-cc-model
      description: Get Preview for Building a CC Model.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ml-config-case-classification-configuration.getdocumentscountpreview1
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.