# 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 Document Intelligence (formerly Form…
  version: 1.0.0
extends: openapi/microsoft-azure-document-models-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: 6
- target: $.paths['/documentModels'].get
  update:
    x-apievangelist-phrasing:
      intent: List document intelligence models
      effect: read
      questions:
      - Which document models are available in my Document Intelligence resource?
      - Can I see both prebuilt and custom document models in one list?
      instructions:
      - text: List all document models in my resource.
      - text: Show every document model I can analyze with, using API version {apiVersion}.
        slots:
          apiVersion: query.api-version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentModels/{modelId}:analyze'].post
  update:
    x-apievangelist-phrasing:
      intent: Analyze a document with a document model
      effect: write
      questions:
      - How do I extract fields from an invoice or receipt with a document model?
      - Can I analyze only certain pages of a long document?
      - Can I ask the model to pull out extra fields it does not normally extract?
      instructions:
      - text: Analyze document {input} with model {modelId}.
        slots:
          input: body.input
          modelId: path.modelId
      - text: Analyze pages {pages} of document {input} using model {modelId}.
        slots:
          pages: query.pages
          input: body.input
          modelId: path.modelId
      - text: Run model {modelId} on {input} and also extract fields {queryFields}.
        slots:
          modelId: path.modelId
          input: body.input
          queryFields: query.queryFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentModels/{modelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a document model
      effect: read
      questions:
      - What fields and document types does a specific model support?
      - Can I check when a custom document model was created?
      instructions:
      - text: Get details for document model {modelId}.
        slots:
          modelId: path.modelId
      - text: Show the field schema of model {modelId}.
        slots:
          modelId: path.modelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentModels/{modelId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document model
      effect: destructive
      questions:
      - Can I delete a custom document model I trained and no longer need?
      - What happens to a model id once I delete that model?
      instructions:
      - text: Delete document model {modelId}.
        slots:
          modelId: path.modelId
      - text: Remove the custom model {modelId} from my resource.
        slots:
          modelId: path.modelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentModels/{modelId}:copyTo'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a document model to another resource
      effect: write
      questions:
      - How do I copy a trained document model into another resource or region?
      - What authorization do I need to copy a model to a target resource?
      instructions:
      - text: Copy model {modelId} to resource {targetResourceId} in {targetResourceRegion} as {targetModelId}.
        slots:
          modelId: path.modelId
          targetResourceId: requestBody.targetResourceId
          targetResourceRegion: requestBody.targetResourceRegion
          targetModelId: requestBody.targetModelId
      - text: Start copying document model {modelId} to target model {targetModelId}.
        slots:
          modelId: path.modelId
          targetModelId: requestBody.targetModelId
      - text: Copy {modelId} to {targetModelLocation} authorized with token {accessToken} that expires {expirationDateTime}.
        slots:
          modelId: path.modelId
          targetModelLocation: requestBody.targetModelLocation
          accessToken: requestBody.accessToken
          expirationDateTime: requestBody.expirationDateTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentModels/{modelId}/analyzeResults/{resultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a document analysis
      effect: read
      questions:
      - Is my document analysis finished, and what did it extract?
      - Can I fetch analysis output later using the result id?
      instructions:
      - text: Get analyze result {resultId} for model {modelId}.
        slots:
          resultId: path.resultId
          modelId: path.modelId
      - text: Check the status of analysis {resultId} run with {modelId}.
        slots:
          resultId: path.resultId
          modelId: path.modelId
      method: generated
      generated: '2026-10-01'