Azure AI Document Intelligence DocumentModels API

openapi: 3.2.0
info:
  title: Document Intelligence (formerly Form Recognizer) DocumentClassifiers Document Models API
  version: '2024-11-30'
  description: Extracts content, layout, and structured data from documents.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://<your-resource>.cognitiveservices.azure.com/
security:
- ApiKeyAuth: []
- OAuth2Auth:
  - https://cognitiveservices.azure.com/.default
tags:
- name: DocumentModels
paths:
  /documentModels:
    get:
      operationId: DocumentModels_ListModels
      description: List all document models
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedDocumentModelDetails'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Get Document Models:
          $ref: ./examples/GetDocumentModels.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - DocumentModels
  /documentModels/{modelId}:analyze:
    post:
      operationId: DocumentModels_AnalyzeDocumentFromStream
      description: Analyzes document with document model.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.modelId'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.pages'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.locale'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.stringIndexType'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.features'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.queryFields'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.outputContentFormat'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.output'
      - $ref: '#/components/parameters/AnalyzeFromStreamRequestParams.input'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Operation-Location:
              description: The location of an instance of AnalyzeOperation
              schema:
                type: string
                format: uri
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Analyze Document from Url:
          $ref: ./examples/AnalyzeDocument_Stream.json
      x-ms-long-running-operation: true
      tags:
      - DocumentModels
  /documentModels/{modelId}:analyzeBatch:
    post:
      operationId: DocumentModels_AnalyzeBatchDocuments
      description: Analyzes batch documents with document model.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.modelId'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.pages'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.locale'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.stringIndexType'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.features'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.queryFields'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.outputContentFormat'
      - $ref: '#/components/parameters/DocumentModelAnalyzeRequestParams.output'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Operation-Location:
              description: The location of an instance of AnalyzeBatchOperation
              schema:
                type: string
                format: uri
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Analyze Batch Documents:
          $ref: ./examples/AnalyzeBatchDocuments.json
      x-ms-long-running-operation: true
      tags:
      - DocumentModels
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyzeBatchDocumentsRequest'
        description: Analyze batch request parameters.
        required: true
  /documentModels/{modelId}:
    get:
      operationId: DocumentModels_GetModel
      description: Gets detailed document model information.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentModelDetails'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Get Custom Document Model:
          $ref: ./examples/GetDocumentModel_Custom.json
        Get Prebuilt Document Model:
          $ref: ./examples/GetDocumentModel_Prebuilt.json
      tags:
      - DocumentModels
    delete:
      operationId: DocumentModels_DeleteModel
      description: Deletes document model.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
          headers:
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Delete Document Model:
          $ref: ./examples/DeleteDocumentModel.json
      tags:
      - DocumentModels
  /documentModels/{modelId}:copyTo:
    post:
      operationId: DocumentModels_CopyModelTo
      description: Copies document model to the target resource, region, and modelId.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Operation-Location:
              description: The location of an instance of DocumentModelCopyToOperationDetails
              schema:
                type: string
                format: uri
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Copy Document Model To:
          $ref: ./examples/CopyDocumentModelTo.json
      x-ms-long-running-operation: true
      tags:
      - DocumentModels
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelCopyAuthorization'
        description: Copy to request parameters.
        required: true
  /documentModels/{modelId}/analyzeBatchResults:
    get:
      operationId: DocumentModels_ListAnalyzeBatchResults
      description: List batch document analysis results.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedAnalyzeBatchOperation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        List Analyze Batch Documents Results:
          $ref: ./examples/GetAnalyzeBatchDocumentsResults.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - DocumentModels
  /documentModels/{modelId}/analyzeBatchResults/{resultId}:
    get:
      operationId: DocumentModels_GetAnalyzeBatchResult
      description: Gets the result of batch document analysis.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - name: resultId
        in: path
        description: Analyze batch operation result ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyzeBatchOperation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Get Analyze Batch Documents Result:
          $ref: ./examples/GetAnalyzeBatchDocumentsResult.json
      tags:
      - DocumentModels
    delete:
      operationId: DocumentModels_DeleteAnalyzeBatchResult
      description: Mark the batch document analysis result for deletion.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - name: resultId
        in: path
        description: Analyze batch operation result ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: There is no content to send for this request, but the headers may be useful.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Delete Analyze Batch Documents Result:
          $ref: ./examples/DeleteAnalyzeBatchDocumentsResult.json
      tags:
      - DocumentModels
  /documentModels/{modelId}/analyzeResults/{resultId}:
    get:
      operationId: DocumentModels_GetAnalyzeResult
      description: Gets the result of document analysis.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - name: resultId
        in: path
        description: Analyze operation result ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyzeOperation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Get Analyze Document Result:
          $ref: ./examples/GetAnalyzeDocumentResult.json
      tags:
      - DocumentModels
    delete:
      operationId: DocumentModels_DeleteAnalyzeResult
      description: Mark the result of document analysis for deletion.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - name: resultId
        in: path
        description: Analyze operation result ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: There is no content to send for this request, but the headers may be useful.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Delete Analyze Result:
          $ref: ./examples/DeleteAnalyzeDocumentResult.json
      tags:
      - DocumentModels
  /documentModels/{modelId}/analyzeResults/{resultId}/figures/{figureId}:
    get:
      operationId: DocumentModels_GetAnalyzeResultFigure
      description: Gets the generated cropped image of specified figure from document analysis.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - name: resultId
        in: path
        description: Analyze operation result ID.
        required: true
        schema:
          type: string
          format: uuid
      - name: figureId
        in: path
        description: Figure ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            image/png:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        default:
          description: An unexpected error response.
          content:
            image/png:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Get Analyze Document Result Figure:
          $ref: ./examples/GetAnalyzeDocumentResultFigure.json
      tags:
      - DocumentModels
  /documentModels/{modelId}/analyzeResults/{resultId}/pdf:
    get:
      operationId: DocumentModels_GetAnalyzeResultPdf
      description: Gets the generated searchable PDF output from document analysis.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        schema:
          type: string
          maxLength: 64
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - name: resultId
        in: path
        description: Analyze operation result ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        default:
          description: An unexpected error response.
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Get Analyze Document Result PDF:
          $ref: ./examples/GetAnalyzeDocumentResultFPdf.json
      tags:
      - DocumentModels
components:
  schemas:
    AnalyzeBatchResult:
      type: object
      description: Batch document analysis result.
      properties:
        succeededCount:
          type: integer
          format: int32
          description: Number of documents that completed with status succeeded.
        failedCount:
          type: integer
          format: int32
          description: Number of documents that completed with status failed.
        skippedCount:
          type: integer
          format: int32
          description: Number of documents that completed with status skipped.
        details:
          type: array
          description: Operation detail for each document in the batch.
          items:
            $ref: '#/components/schemas/AnalyzeBatchOperationDetail'
      required:
      - succeededCount
      - failedCount
      - skippedCount
    DocumentSelectionMark:
      type: object
      description: 'A selection mark object representing check boxes, radio buttons, and other

        elements indicating a selection.'
      properties:
        state:
          $ref: '#/components/schemas/DocumentSelectionMarkState'
          description: State of the selection mark.
        polygon:
          type: array
          description: 'Bounding polygon of the selection mark, with coordinates specified relative

            to the top-left of the page. The numbers represent the x, y values of the

            polygon vertices, clockwise from the left (-180 degrees inclusive) relative

            to the element orientation.'
          items:
            type: number
            format: float
        span:
          $ref: '#/components/schemas/DocumentSpan'
          description: Location of the selection mark in the reading order concatenated content.
        confidence:
          type: number
          format: float
          description: Confidence of correctly extracting the selection mark.
          minimum: 0
          maximum: 1
      required:
      - state
      - span
      - confidence
    DocumentTableCell:
      type: object
      description: An object representing the location and content of a table cell.
      properties:
        kind:
          type: string
          description: Table cell kind.
          default: content
          enum:
          - content
          - rowHeader
          - columnHeader
          - stubHead
          - description
          x-ms-enum:
            name: DocumentTableCellKind
            modelAsString: true
            values:
            - name: content
              value: content
              description: Contains the main content/data.
            - name: rowHeader
              value: rowHeader
              description: Describes the content of the row.
            - name: columnHeader
              value: columnHeader
              description: Describes the content of the column.
            - name: stubHead
              value: stubHead
              description: Describes the row headers, usually located at the top left corner of a table.
            - name: description
              value: description
              description: Describes the content in (parts of) the table.
        rowIndex:
          type: integer
          format: int32
          description: Row index of the cell.
        columnIndex:
          type: integer
          format: int32
          description: Column index of the cell.
        rowSpan:
          type: integer
          format: int32
          description: Number of rows spanned by this cell.
          default: 1
          minimum: 1
        columnSpan:
          type: integer
          format: int32
          description: Number of columns spanned by this cell.
          default: 1
          minimum: 1
        content:
          type: string
          description: Concatenated content of the table cell in reading order.
        boundingRegions:
          type: array
          description: Bounding regions covering the table cell.
          items:
            $ref: '#/components/schemas/BoundingRegion'
        spans:
          type: array
          description: Location of the table cell in the reading order concatenated content.
          items:
            $ref: '#/components/schemas/DocumentSpan'
        elements:
          type: array
          description: Child elements of the table cell.
          items:
            $ref: '#/components/schemas/DocumentElement'
      required:
      - rowIndex
      - columnIndex
      - content
      - spans
    DocumentFontStyle:
      type: string
      description: Font style.
      enum:
      - normal
      - italic
      x-ms-enum:
        name: DocumentFontStyle
        modelAsString: true
        values:
        - name: normal
          value: normal
          description: Characters are represented normally.
        - name: italic
          value: italic
          description: Characters are visually slanted to the right.
    DocumentIntelligenceOperationStatus:
      type: string
      description: Operation status.
      enum:
      - notStarted
      - running
      - failed
      - succeeded
      - canceled
      - skipped
      x-ms-enum:
        name: DocumentIntelligenceOperationStatus
        modelAsString: true
        values:
        - name: notStarted
          value: notStarted
          description: The operation has not started yet.
        - name: running
          value: running
          description: The operation is in progress.
        - name: failed
          value: failed
          description: The operation has failed.
        - name: succeeded
          value: succeeded
          description: The operation has succeeded.
        - name: canceled
          value: canceled
          description: The operation has been canceled.
        - name: skipped
          value: skipped
          description: The operation has been skipped.
    AnalyzeBatchOperationDetail:
      type: object
      description: Operation detail for a document in a batch analysis.
      properties:
        status:
          $ref: '#/components/schemas/DocumentIntelligenceOperationStatus'
          description: Analyze status.  succeeded, failed, or skipped
        sourceUrl:
          type: string
          format: uri
          description: URL of the source document.
        resultUrl:
          type: string
          format: uri
          description: URL of the analyze result JSON.
        error:
          $ref: '#/components/schemas/DocumentIntelligenceError'
          description: Encountered error.
      required:
      - status
      - sourceUrl
    DocumentField:
      type: object
      description: An object representing the content and location of a field value.
      properties:
        type:
          $ref: '#/components/schemas/DocumentFieldType'
          description: Data type of the field value.
        valueString:
          type: string
          description: String value.
        valueDate:
          type: string
          format: date
          description: Date value in YYYY-MM-DD format (ISO 8601).
        valueTime:
          type: string
          format: time
          description: Time value in hh:mm:ss format (ISO 8601).
        valuePhoneNumber:
          type: string
          description: Phone number value in E.164 format (ex. +19876543210).
        valueNumber:
          type: number
          format: double
          description: Floating point value.
        valueInteger:
          type: integer
          format: int64
          description: Integer value.
        valueSelectionMark:
          $ref: '#/components/schemas/DocumentSelectionMarkState'
          description: Selection mark value.
        valueSignature:
          $ref: '#/components/schemas/DocumentSignatureType'
          description: Presence of signature.
        valueCountryRegion:
          type: string
          description: 3-letter country code value (ISO 3166-1 alpha-3).
        valueArray:
          type: array
          description: Array of field values.
          items:
            $ref: '#/components/schemas/DocumentField'
        valueObject:
          type: object
          description: Dictionary of named field values.
          additionalProperties:
            $ref: '#/components/schemas/DocumentField'
        valueCurrency:
          $ref: '#/components/schemas/CurrencyValue'
          description: Currency value.
        valueAddress:
          $ref: '#/components/schemas/AddressValue'
          description: Address value.
        valueBoolean:
          type: boolean
          description: Boolean value.
        valueSelectionGroup:
          type: array
          description: Selection group value.
          items:
            type: string
        content:
          type: string
          description: Field content.
        boundingRegions:
          type: array
          description: Bounding regions covering the field.
          items:
            $ref: '#/components/schemas/BoundingRegion'
        spans:
          type: array
          description: Location of the field in the reading order concatenated content.
          items:
            $ref: '#/components/schemas/DocumentSpan'
        confidence:
          type: number
          format: float
          description: Confidence of correctly extracting the field.
          minimum: 0
          maximum: 1
      required:
      - type
    DocumentBarcodeKind:
      type: string
      description: Barcode kind.
      enum:
      - QRCode
      - PDF417
      - UPCA
      - UPCE
      - Code39
      - Code128
      - EAN8
      - EAN13
      - DataBar
      - Code93
      - Codabar
      - DataBarExpanded
      - ITF
      - MicroQRCode
      - Aztec
      - DataMatrix
      - MaxiCode
      x-ms-enum:
        name: DocumentBarcodeKind
        modelAsString: true
        values:
        - name: QRCode
          value: QRCode
          description: QR code, as defined in ISO/IEC 18004:2015.
        - name: PDF417
          value: PDF417
          description: PDF417, as defined in ISO 15438.
        - name: UPCA
          value: UPCA
          description: GS1 12-digit Universal Product Code.
        - name: UPCE
          value: UPCE
          description: GS1 6-digit Universal Product Code.
        - name: Code39
          value: Code39
          description: Code 39 barcode, as defined in ISO/IEC 16388:2007.
        - name: Code128
          value: Code128
          description: Code 128 barcode, as defined in ISO/IEC 15417:2007.
        - name: EAN8
          value: EAN8
          description: GS1 8-digit International Article Number (European Article Number).
        - name: EAN13
          value: EAN13
          description: GS1 13-digit International Article Number (European Article Number).
        - name: DataBar
          value: DataBar
          description: GS1 DataBar barcode.
        - name: Code93
          value: Code93
          description: Code 93 barcode, as defined in ANSI/AIM BC5-1995.
        - name: Codabar
          value: Codabar
          description: Codabar barcode, as defined in ANSI/AIM BC3-1995.
        - name: DataBarExpanded
          value: DataBarExpanded
          description: GS1 DataBar Expanded barcode.
        - name: ITF
          value: ITF
          description: Interleaved 2 of 5 barcode, as defined in ANSI/AIM BC2-1995.
        - name: MicroQRCode
          value: MicroQRCode
          description: Micro QR code, as defined in ISO/IEC 23941:2022.
        - name: Aztec
          value: Aztec
          description: Aztec code, as defined in ISO/IEC 24778:2008.
        - name: DataMatrix
          value: DataMatrix
          description: Data matrix code, as defined in ISO/IEC 16022:2006.
        - name: MaxiCode
          value: MaxiCode
          description: MaxiCode, as defined in ISO/IEC 16023:2000.
    DocumentBuildMode:
      type: string
      description: Custom document model build mode.
      enum:
      - template
      - neural
      x-ms-enum:
        name: DocumentBuildMode
        modelAsString: true
        values:
        - name: template
          value: template
          description: Target documents with similar visual templates.
        - name: neural
          value: neural
          description: Support documents with diverse visual templates.
    DocumentFootnote:
      type: object
      description: A footnote object describing a table or figure.
      properties:
        content:
          type: string
          description: Content of the footnote.
        boundingRegions:
          type: array
          description: Bounding regions covering the footnote.
          items:
            $ref: '#/components/schemas/BoundingRegion'
        spans:
          type: array
          description: Location of the footnote in the reading order concatenated content.
          items:
            $ref: '#/components/schemas/DocumentSpan'
        elements:
          type: array
          description: Child elements of the footnote.
          items:
            $ref: '#/components/schemas/DocumentElement'
      required:
      - content
      - spans
    DocumentTable:
      type: object
      description: A table object consisting table cells arrang

# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-document-intelligence/refs/heads/main/openapi/azure-document-intelligence-documentmodels-api-openapi.yml