Microsoft Azure Batch Document Translation Client — Document Translation

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Batch Document Translation Client — Document Translation
  description: 'Microsoft Azure Batch Document Translation Client — Document Translation. 9 operations. Lead operation: Microsoft
    Azure Submit A Document Translation Request To The Document Translation Service. Self-contained Naftiko capability covering
    one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - Document Translation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: batch-document-translation-client-document-translation
    baseUri: ''
    description: Microsoft Azure Batch Document Translation Client — Document Translation business capability. Self-contained,
      no shared references.
    resources:
    - name: batches
      path: /batches
      operations:
      - name: microsoftazuredocumenttranslationstarttranslation
        method: POST
        description: Microsoft Azure Submit A Document Translation Request To The Document Translation Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          description: request details
          required: true
      - name: microsoftazuredocumenttranslationgettranslationsstatus
        method: GET
        description: Microsoft Azure Returns A List Of Batch Requests Submitted And The Status For Each Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: $top
          in: query
          type: integer
          description: "$top indicates the total number of records the user wants to be returned across all pages.\r"
        - name: $skip
          in: query
          type: integer
          description: $skip indicates the number of records to skip from the list of records held by the server based on
            the sorting method specified.  By default, we sort by descend
        - name: $maxpagesize
          in: query
          type: integer
          description: '$maxpagesize is the maximum items returned in a page.  If more items are requested via $top (or $top
            is not specified and there are more items to be returned), '
        - name: ids
          in: query
          type: array
          description: Ids to use in filtering
        - name: statuses
          in: query
          type: array
          description: Statuses to use in filtering
        - name: createdDateTimeUtcStart
          in: query
          type: string
          description: the start datetime to get items after
        - name: createdDateTimeUtcEnd
          in: query
          type: string
          description: the end datetime to get items before
        - name: $orderBy
          in: query
          type: array
          description: 'the sorting query for the collection (ex: ''CreatedDateTimeUtc asc'', ''CreatedDateTimeUtc desc'')'
    - name: batches-id
      path: /batches/{id}
      operations:
      - name: microsoftazuredocumenttranslationgettranslationstatus
        method: GET
        description: Microsoft Azure Returns The Status For A Document Translation Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Format - uuid.  The operation id
          required: true
      - name: microsoftazuredocumenttranslationcanceltranslation
        method: DELETE
        description: Microsoft Azure Cancel A Currently Processing Or Queued Translation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Format - uuid.  The operation-id
          required: true
    - name: batches-id-documents
      path: /batches/{id}/documents
      operations:
      - name: microsoftazuredocumenttranslationgetdocumentsstatus
        method: GET
        description: Microsoft Azure Returns The Status For All Documents In A Batch Document Translation Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Format - uuid.  The operation id
          required: true
        - name: $top
          in: query
          type: integer
          description: "$top indicates the total number of records the user wants to be returned across all pages.\r"
        - name: $skip
          in: query
          type: integer
          description: $skip indicates the number of records to skip from the list of records held by the server based on
            the sorting method specified.  By default, we sort by descend
        - name: $maxpagesize
          in: query
          type: integer
          description: '$maxpagesize is the maximum items returned in a page.  If more items are requested via $top (or $top
            is not specified and there are more items to be returned), '
        - name: ids
          in: query
          type: array
          description: Ids to use in filtering
        - name: statuses
          in: query
          type: array
          description: Statuses to use in filtering
        - name: createdDateTimeUtcStart
          in: query
          type: string
          description: the start datetime to get items after
        - name: createdDateTimeUtcEnd
          in: query
          type: string
          description: the end datetime to get items before
        - name: $orderBy
          in: query
          type: array
          description: 'the sorting query for the collection (ex: ''CreatedDateTimeUtc asc'', ''CreatedDateTimeUtc desc'')'
    - name: batches-id-documents-documentId
      path: /batches/{id}/documents/{documentId}
      operations:
      - name: microsoftazuredocumenttranslationgetdocumentstatus
        method: GET
        description: Microsoft Azure Returns The Status For A Specific Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Format - uuid.  The batch id
          required: true
        - name: documentId
          in: path
          type: string
          description: Format - uuid.  The document id
          required: true
    - name: documents-formats
      path: /documents/formats
      operations:
      - name: microsoftazuredocumenttranslationgetsupporteddocumentformats
        method: GET
        description: Microsoft Azure Returns A List Of Supported Document Formats
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: glossaries-formats
      path: /glossaries/formats
      operations:
      - name: microsoftazuredocumenttranslationgetsupportedglossaryformats
        method: GET
        description: Microsoft Azure Returns The List Of Supported Glossary Formats
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: storagesources
      path: /storagesources
      operations:
      - name: microsoftazuredocumenttranslationgetsupportedstoragesources
        method: GET
        description: Microsoft Azure Returns A List Of Supported Storage Sources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: batch-document-translation-client-document-translation-rest
    port: 8080
    description: REST adapter for Microsoft Azure Batch Document Translation Client — Document Translation. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/batches
      name: batches
      description: REST surface for batches.
      operations:
      - method: POST
        name: microsoftazuredocumenttranslationstarttranslation
        description: Microsoft Azure Submit A Document Translation Request To The Document Translation Service
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationstarttranslation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: microsoftazuredocumenttranslationgettranslationsstatus
        description: Microsoft Azure Returns A List Of Batch Requests Submitted And The Status For Each Request
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgettranslationsstatus
        with:
          $top: rest.$top
          $skip: rest.$skip
          $maxpagesize: rest.$maxpagesize
          ids: rest.ids
          statuses: rest.statuses
          createdDateTimeUtcStart: rest.createdDateTimeUtcStart
          createdDateTimeUtcEnd: rest.createdDateTimeUtcEnd
          $orderBy: rest.$orderBy
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/batches/{id}
      name: batches-id
      description: REST surface for batches-id.
      operations:
      - method: GET
        name: microsoftazuredocumenttranslationgettranslationstatus
        description: Microsoft Azure Returns The Status For A Document Translation Request
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgettranslationstatus
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazuredocumenttranslationcanceltranslation
        description: Microsoft Azure Cancel A Currently Processing Or Queued Translation
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationcanceltranslation
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/batches/{id}/documents
      name: batches-id-documents
      description: REST surface for batches-id-documents.
      operations:
      - method: GET
        name: microsoftazuredocumenttranslationgetdocumentsstatus
        description: Microsoft Azure Returns The Status For All Documents In A Batch Document Translation Request
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetdocumentsstatus
        with:
          id: rest.id
          $top: rest.$top
          $skip: rest.$skip
          $maxpagesize: rest.$maxpagesize
          ids: rest.ids
          statuses: rest.statuses
          createdDateTimeUtcStart: rest.createdDateTimeUtcStart
          createdDateTimeUtcEnd: rest.createdDateTimeUtcEnd
          $orderBy: rest.$orderBy
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/batches/{id}/documents/{documentid}
      name: batches-id-documents-documentid
      description: REST surface for batches-id-documents-documentId.
      operations:
      - method: GET
        name: microsoftazuredocumenttranslationgetdocumentstatus
        description: Microsoft Azure Returns The Status For A Specific Document
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetdocumentstatus
        with:
          id: rest.id
          documentId: rest.documentId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/formats
      name: documents-formats
      description: REST surface for documents-formats.
      operations:
      - method: GET
        name: microsoftazuredocumenttranslationgetsupporteddocumentformats
        description: Microsoft Azure Returns A List Of Supported Document Formats
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetsupporteddocumentformats
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/glossaries/formats
      name: glossaries-formats
      description: REST surface for glossaries-formats.
      operations:
      - method: GET
        name: microsoftazuredocumenttranslationgetsupportedglossaryformats
        description: Microsoft Azure Returns The List Of Supported Glossary Formats
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetsupportedglossaryformats
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/storagesources
      name: storagesources
      description: REST surface for storagesources.
      operations:
      - method: GET
        name: microsoftazuredocumenttranslationgetsupportedstoragesources
        description: Microsoft Azure Returns A List Of Supported Storage Sources
        call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetsupportedstoragesources
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: batch-document-translation-client-document-translation-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure Batch Document Translation Client — Document Translation. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: microsoft-azure-submit-document-translation
      description: Microsoft Azure Submit A Document Translation Request To The Document Translation Service
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationstarttranslation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-returns-list-batch
      description: Microsoft Azure Returns A List Of Batch Requests Submitted And The Status For Each Request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgettranslationsstatus
      with:
        $top: tools.$top
        $skip: tools.$skip
        $maxpagesize: tools.$maxpagesize
        ids: tools.ids
        statuses: tools.statuses
        createdDateTimeUtcStart: tools.createdDateTimeUtcStart
        createdDateTimeUtcEnd: tools.createdDateTimeUtcEnd
        $orderBy: tools.$orderBy
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-returns-status-document
      description: Microsoft Azure Returns The Status For A Document Translation Request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgettranslationstatus
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-cancel-currently-processing
      description: Microsoft Azure Cancel A Currently Processing Or Queued Translation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationcanceltranslation
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-returns-status-all
      description: Microsoft Azure Returns The Status For All Documents In A Batch Document Translation Request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetdocumentsstatus
      with:
        id: tools.id
        $top: tools.$top
        $skip: tools.$skip
        $maxpagesize: tools.$maxpagesize
        ids: tools.ids
        statuses: tools.statuses
        createdDateTimeUtcStart: tools.createdDateTimeUtcStart
        createdDateTimeUtcEnd: tools.createdDateTimeUtcEnd
        $orderBy: tools.$orderBy
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-returns-status-specific
      description: Microsoft Azure Returns The Status For A Specific Document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetdocumentstatus
      with:
        id: tools.id
        documentId: tools.documentId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-returns-list-supported
      description: Microsoft Azure Returns A List Of Supported Document Formats
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetsupporteddocumentformats
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-returns-list-supported-2
      description: Microsoft Azure Returns The List Of Supported Glossary Formats
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetsupportedglossaryformats
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-returns-list-supported-3
      description: Microsoft Azure Returns A List Of Supported Storage Sources
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: batch-document-translation-client-document-translation.microsoftazuredocumenttranslationgetsupportedstoragesources
      outputParameters:
      - type: object
        mapping: $.