Azure AI Document Intelligence DocumentModels API

swagger: '2.0'
info:
  title: Document Intelligence (formerly Form Recognizer) DocumentClassifiers DocumentModels API
  version: '2024-11-30'
  description: Extracts content, layout, and structured data from documents.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- ApiKeyAuth: []
- OAuth2Auth:
  - https://cognitiveservices.azure.com/.default
tags:
- name: DocumentModels
paths:
  /documentModels:
    get:
      operationId: DocumentModels_ListModels
      description: List all document models
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedDocumentModelDetails'
          headers:
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/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.
      consumes:
      - application/octet-stream
      - application/pdf
      - image/jpeg
      - image/png
      - image/tiff
      - image/bmp
      - image/heif
      - text/html
      - application/vnd.openxmlformats-officedocument.wordprocessingml.document
      - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
      - application/vnd.openxmlformats-officedocument.presentationml.presentation
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.modelId'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.pages'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.locale'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.stringIndexType'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.features'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.queryFields'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.outputContentFormat'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.output'
      - $ref: '#/parameters/AnalyzeFromStreamRequestParams.input'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Operation-Location:
              type: string
              format: uri
              description: The location of an instance of AnalyzeOperation
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.modelId'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.pages'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.locale'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.stringIndexType'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.features'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.queryFields'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.outputContentFormat'
      - $ref: '#/parameters/DocumentModelAnalyzeRequestParams.output'
      - name: analyzeBatchRequest
        in: body
        description: Analyze batch request parameters.
        required: true
        schema:
          $ref: '#/definitions/AnalyzeBatchDocumentsRequest'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Operation-Location:
              type: string
              format: uri
              description: The location of an instance of AnalyzeBatchOperation
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Analyze Batch Documents:
          $ref: ./examples/AnalyzeBatchDocuments.json
      x-ms-long-running-operation: true
      tags:
      - DocumentModels
  /documentModels/{modelId}:
    get:
      operationId: DocumentModels_GetModel
      description: Gets detailed document model information.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/DocumentModelDetails'
          headers:
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        type: string
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - $ref: '#/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:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      - name: copyToRequest
        in: body
        description: Copy to request parameters.
        required: true
        schema:
          $ref: '#/definitions/ModelCopyAuthorization'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Operation-Location:
              type: string
              format: uri
              description: The location of an instance of DocumentModelCopyToOperationDetails
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Copy Document Model To:
          $ref: ./examples/CopyDocumentModelTo.json
      x-ms-long-running-operation: true
      tags:
      - DocumentModels
  /documentModels/{modelId}/analyzeBatchResults:
    get:
      operationId: DocumentModels_ListAnalyzeBatchResults
      description: List batch document analysis results.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedAnalyzeBatchOperation'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        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
        type: string
        format: uuid
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AnalyzeBatchOperation'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        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
        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.
          schema:
            $ref: '#/definitions/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: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        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
        type: string
        format: uuid
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AnalyzeOperation'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        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
        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.
          schema:
            $ref: '#/definitions/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.
      produces:
      - image/png
      - application/json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        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
        type: string
        format: uuid
      - name: figureId
        in: path
        description: Figure ID.
        required: true
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            type: file
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/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.
      produces:
      - application/pdf
      - application/json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: modelId
        in: path
        description: Unique document model name.
        required: true
        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
        type: string
        format: uuid
      responses:
        '200':
          description: The request has succeeded.
          schema:
            type: file
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/DocumentIntelligenceErrorResponse'
      x-ms-examples:
        Get Analyze Document Result PDF:
          $ref: ./examples/GetAnalyzeDocumentResultFPdf.json
      tags:
      - DocumentModels
definitions:
  Azure.Core.uuid:
    type: string
    format: uuid
    description: Universally Unique Identifier
  ParagraphRole:
    type: string
    description: Semantic role of the paragraph.
    enum:
    - pageHeader
    - pageFooter
    - pageNumber
    - title
    - sectionHeading
    - footnote
    - formulaBlock
    x-ms-enum:
      name: ParagraphRole
      modelAsString: true
      values:
      - name: pageHeader
        value: pageHeader
        description: Text near the top edge of the page.
      - name: pageFooter
        value: pageFooter
        description: Text near the bottom edge of the page.
      - name: pageNumber
        value: pageNumber
        description: Page number.
      - name: title
        value: title
        description: Top-level title describing the entire document.
      - name: sectionHeading
        value: sectionHeading
        description: Sub heading describing a section of the document.
      - name: footnote
        value: footnote
        description: A note usually placed after the main content on a page.
      - name: formulaBlock
        value: formulaBlock
        description: A block of formulas, often with shared alignment.
  DocumentIntelligenceErrorResponse:
    type: object
    description: Error response object.
    properties:
      error:
        $ref: '#/definitions/DocumentIntelligenceError'
        description: Error info.
    required:
    - error
  DocumentSelectionMarkState:
    type: string
    description: State of the selection mark.
    enum:
    - selected
    - unselected
    x-ms-enum:
      name: DocumentSelectionMarkState
      modelAsString: true
      values:
      - name: selected
        value: selected
        description: 'The selection mark is selected, often indicated by a check ✓ or cross X inside

          the selection mark.'
      - name: unselected
        value: unselected
        description: The selection mark is not selected.
  DocumentKeyValueElement:
    type: object
    description: An object representing the field key or value in a key-value pair.
    properties:
      content:
        type: string
        description: Concatenated content of the key-value element in reading order.
      boundingRegions:
        type: array
        description: Bounding regions covering the key-value element.
        items:
          $ref: '#/definitions/BoundingRegion'
      spans:
        type: array
        description: Location of the key-value element in the reading order concatenated content.
        items:
          $ref: '#/definitions/DocumentSpan'
    required:
    - content
    - spans
  DocumentLine:
    type: object
    description: 'A content line object consisting of an adjacent sequence of content elements,

      such as words and selection marks.'
    properties:
      content:
        type: string
        description: Concatenated content of the contained elements in reading order.
      polygon:
        type: array
        description: 'Bounding polygon of the line, 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
      spans:
        type: array
        description: Location of the line in the reading order concatenated content.
        items:
          $ref: '#/definitions/DocumentSpan'
    required:
    - content
    - spans
  DocumentLanguage:
    type: object
    description: An object representing the detected language for a given text span.
    properties:
      locale:
        type: string
        description: 'Detected language.  Value may an ISO 639-1 language code (ex. "en", "fr")

          or BCP 47 language tag (ex. "zh-Hans").'
      spans:
        type: array
        description: 'Location of the text elements in the concatenated content the language applies

          to.'
        items:
          $ref: '#/definitions/DocumentSpan'
      confidence:
        type: number
        format: float
        description: Confidence of correctly identifying the language.
        minimum: 0
        maximum: 1
    required:
    - locale
    - spans
    - confidence
  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: '#/definitions/BoundingRegion'
      spans:
        type: array
        description: Location of the footnote in the reading order concatenated content.
        items:
          $ref: '#/definitions/DocumentSpan'
      elements:
        type: array
        description: Child elements of the footnote.
        items:
          $ref: '#/definitions/DocumentElement'
    required:
    - content
    - spans
  BoundingRegion:
    type: object
    description: Bounding polygon on a specific page of the input.
    properties:
      pageNumber:
        type: integer
        format: int32
        description: 1-based page number of page containing the bounding region.
        minimum: 1
      polygon:
        type: array
        description: 'Bounding polygon on the page, or the entire page if not specified.

          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
    required:
    - pageNumber
    - polygon
  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: '#/definitions/BoundingRegion'
      spans:
        type: array
        description: Location of the table cell in the reading order concatenated content.
        items:
          $ref: '#/definitions/DocumentSpan'
      elements:
        type: array
        description: Child elements of the table cell.
        items:
          $ref: '#/definitions/DocumentElement'
    required:
    - rowIndex
    - columnIndex
    - content
    - spans
  CurrencyValue:
    type: object
    description: Currency field value.
    properties:
      amount:
        type: number
        format: double
        description: Currency amount.
      currencySymbol:
        type: string
        description: Currency symbol label, if any.
      currencyCode:
        type: string
        description: Resolved currency code (ISO 4217), if any.
    required:
    - amount
  DocumentCaption:
    type: object
    description: A caption object describing a table or figure.
    properties:
      content:
        type: string
        description: Content of the caption.
      boundingRegions:
        type: array
        description: Bounding regions covering the caption.
        items:
          $ref: '#/definitions/BoundingRegion'
      spans:
        type: array
        description: Location of the caption in the reading order concatenated content.
        items:
          $ref: '#/definitions/DocumentSpan'
      elements:
        type: array
        description: Child elements of the caption.
        items:
          $ref: '#/definitions/DocumentElement'
    required:
    - content
    - spans
  AnalyzeBatchOperation:
    type: object
    description: Status and result of the analyze batch operation.
    properties:
      resultId:
        $ref: '#/definitions/Azure.Core.uuid'
        description: Analyze batch operation result ID.
      status:
        $ref: '#/definitions/DocumentIntelligenceOperationStatus'
        description: Operation status.  notStarted, running, succeeded, or failed
      createdDateTime:
        type: string
        format: date-time
        description: Date and time (UTC) when the operation was submitted.
      lastUpdatedDateTime:
        type: string
        format: date-time
        description: Date and time (UTC) when the status was last updated.
      percentCompleted:
        type: integer
        format: int32
        description: Operation progress (0-100).
        minimum: 0
        maximum: 100
      error:
        $ref: '#/definitions/DocumentIntelligenceError'
        description: Encountered error during batch document analysis.
      result:
        $ref: '#/definitions/AnalyzeBatchResult'
        description: Batch document analysis result.
    required:
    - status
    - createdDateTime
    - lastUpdatedDateTime
  PagedAnalyzeBatchOperation:
    type: object
    description: Paged collection of AnalyzeBatchOperation items
    properties:
      value:
        type: array
        description: The AnalyzeBatchOperation items on this page
        items:
          $ref: '#/definitions/AnalyzeBatchOperation'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  DocumentSelectionMark:
    type: object
    description: 'A selection mark object representing check boxes, radio buttons, and other

      elements indicating a selection.'
    properties:
      state:
        $ref: '#/definitions/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: '#/definitions/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
  DocumentIntelligenceWarning:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of warning codes.
      message:
        type: string
        description: A human-readable representation of the warning.
      target:
        type: string
        description: The target of the error.
    required:
    - code
    - message
  DocumentField:
    type: object
    description: An object representing the content and location of a field value.
    properties:
      type:
        $ref: '#/definitions/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: '#/definitions/DocumentSelectionMarkState'
        description: Selection mark value.
      valueSignature:
        $ref: '#/definitions/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: '#/definitions/DocumentField'
      valueObject:
        type: object
        description: Dictionary of named field values.
        additionalProperties:
          $ref: '#/definitions/DocumentField'
      valueCurrency:
        $ref: '#/definitions/CurrencyValue'
        description: Currency value.
      valueAddress:
        $ref: '#/definitions/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: '#/definitions/BoundingRegion'
      spans:
        type: array
        description: Location of the field in the reading order concatenated content.
        items:
          $ref: '#/definitions/DocumentSpan'
      confidence:
        type: number
        format: float
        description: Confidence of correctly extracting the field.
        minimum: 0
        maximum: 1
    required:
    - type
  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.
      de

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