# 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-classifiers-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: 5
- target: $.paths['/documentClassifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List document classifiers
      effect: read
      questions:
      - Which document classifiers have I built in Document Intelligence?
      - Can I see every custom classifier on my resource?
      instructions:
      - text: List all my document classifiers.
      - text: Show every custom document classifier on this resource using API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentClassifiers/{classifierId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document classifier's details
      effect: read
      questions:
      - What document types can a particular classifier recognize?
      - How do I look up the details of one document classifier?
      instructions:
      - text: Get document classifier {classifierId}.
        slots:
          classifierId: path.classifierId
      - text: Show the document types known to classifier {classifierId}.
        slots:
          classifierId: path.classifierId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentClassifiers/{classifierId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document classifier
      effect: destructive
      questions:
      - Can I remove a document classifier I no longer use?
      - Is deleting a document classifier reversible?
      instructions:
      - text: Delete document classifier {classifierId}.
        slots:
          classifierId: path.classifierId
      - text: Remove classifier {classifierId} from my resource.
        slots:
          classifierId: path.classifierId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentClassifiers/{classifierId}:analyze'].post
  update:
    x-apievangelist-phrasing:
      intent: Classify a document with a classifier
      effect: write
      questions:
      - How do I find out what type of document a file is using my classifier?
      - Can a classifier split a multi-document file into its separate documents?
      instructions:
      - text: Classify this document with classifier {classifierId}.
        slots:
          classifierId: path.classifierId
      - text: Classify the uploaded file with {classifierId} using split mode {split}.
        slots:
          classifierId: path.classifierId
          split: query.split
      method: generated
      generated: '2026-10-01'
- target: $.paths['/documentClassifiers/{classifierId}/analyzeResults/{resultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a document classification
      effect: read
      questions:
      - Is my document classification finished, and which type was detected?
      - Where do I get the output of a classify request?
      instructions:
      - text: Get classification result {resultId} from classifier {classifierId}.
        slots:
          resultId: path.resultId
          classifierId: path.classifierId
      - text: Check the status of classify job {resultId}.
        slots:
          resultId: path.resultId
      method: generated
      generated: '2026-10-01'