# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Batch Client Document Translation API
  version: 1.0.0
extends: openapi/microsoft-azure-document-translation-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List my document translation batches and status
      effect: read
      questions:
      - Which document translation requests have I submitted, and what state is each in?
      - Can I filter my translation batches by status or creation date?
      - How do I page through older batch translation requests?
      instructions:
      - text: List all my document translation batches.
      - text: List translation batches with status {statuses}.
        slots:
          statuses: query.statuses
      - text: List translation batches created between {start} and {end}.
        slots:
          start: query.createdDateTimeUtcStart
          end: query.createdDateTimeUtcEnd
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch document translation request
      effect: write
      questions:
      - How do I translate a whole container of documents in one request?
      - Can one translation batch include several sources and target languages?
      - What do I need to start a bulk document translation?
      instructions:
      - text: Start a document translation batch with inputs {inputs}.
        slots:
          inputs: requestBody.inputs
      - text: Submit a bulk translation of the documents described by {inputs}.
        slots:
          inputs: requestBody.inputs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batches/{id}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the translation status of one document
      effect: read
      questions:
      - How do I check whether a specific document in my batch finished translating?
      - Where can I see the progress of one file in a translation job?
      instructions:
      - text: Get the status of document {documentId} in translation batch {id}.
        slots:
          documentId: path.documentId
          id: path.id
      - text: Check whether file {documentId} of batch {id} is translated yet.
        slots:
          documentId: path.documentId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of a translation batch
      effect: read
      questions:
      - Is my batch translation request still running or done?
      - What overall status and document counts does a translation job report?
      instructions:
      - text: Get the status of translation batch {id}.
        slots:
          id: path.id
      - text: Show the overall progress of document translation request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a queued or running translation batch
      effect: destructive
      questions:
      - Can I cancel a document translation that is still in progress?
      - What happens to documents already translated when I cancel a batch?
      instructions:
      - text: Cancel translation batch {id}.
        slots:
          id: path.id
      - text: Stop the queued document translation job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{id}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List document statuses in a translation batch
      effect: read
      questions:
      - Which documents in my translation batch failed or succeeded?
      - Can I page through and filter the per-document status of a batch?
      instructions:
      - text: List the status of every document in translation batch {id}.
        slots:
          id: path.id
      - text: Show documents in batch {id} with status {statuses}.
        slots:
          id: path.id
          statuses: query.statuses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documents/formats'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported document formats for translation
      effect: read
      questions:
      - Which file types can the Document Translation service translate?
      - What content types should I use when uploading documents for translation?
      instructions:
      - text: List the document formats supported for translation.
      - text: Show which file extensions document translation accepts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/glossaries/formats'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported glossary formats
      effect: read
      questions:
      - What glossary file formats can I use with document translation?
      - Can I supply a custom glossary as a TSV or other file type?
      instructions:
      - text: Show me every glossary file type I can pair with a translation job.
      - text: Show which glossary file extensions I can upload.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/storagesources'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported storage sources for translation
      effect: read
      questions:
      - Where can my source documents be stored for batch translation?
      - Which storage options does document translation read from?
      instructions:
      - text: List the storage sources document translation supports.
      - text: Show the supported storage options for translation inputs.
      method: generated
      generated: '2026-09-26'