Microsoft Azure AI Foundry Analyzer Results API

openapi: 3.2.0
info:
  title: Content Understanding Analyzer Results API
  version: '2025-11-01'
  description: The Content Understanding service extracts content and fields from multimodal input.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- AzureKey: []
- EntraIdToken:
  - https://cognitiveservices.azure.com/.default
tags:
- name: AnalyzerResults
paths:
  /analyzerResults/{operationId}:
    get:
      operationId: ContentAnalyzers_GetResult
      description: Get the result of an analysis operation.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: operationId
        in: path
        description: The unique ID of the operation.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentAnalyzerAnalyzeOperationStatus'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - AnalyzerResults
      summary: Content analyzers get result
      x-summary-source: derived
    delete:
      operationId: ContentAnalyzers_DeleteResult
      description: Mark the result of an analysis operation for deletion.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: operationId
        in: path
        description: Operation identifier.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: There is no content to send for this request, but the headers may be useful.
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - AnalyzerResults
      summary: Content analyzers delete result
      x-summary-source: derived
  /analyzerResults/{operationId}/files/{path}:
    get:
      operationId: ContentAnalyzers_GetResultFile
      description: Get a file associated with the result of an analysis operation.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: operationId
        in: path
        description: Operation identifier.
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: File path.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            '*/*':
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - AnalyzerResults
      summary: Content analyzers get result file
      x-summary-source: derived
components:
  schemas:
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    AnalysisContent:
      type: object
      description: Media content base class.
      properties:
        kind:
          $ref: '#/components/schemas/AnalysisContentKind'
          description: Content kind.
        mimeType:
          type: string
          description: Detected MIME type of the content.  Ex. application/pdf, image/jpeg, etc.
        analyzerId:
          type: string
          description: The analyzer that generated this content.
          minLength: 1
          maxLength: 64
          pattern: ^[a-zA-Z0-9._-]{1,64}$
        category:
          type: string
          description: Classified content category.
        path:
          type: string
          description: The path of the content in the input.
        markdown:
          type: string
          description: Markdown representation of the content.
        fields:
          type: object
          description: Extracted fields from the content.
          additionalProperties:
            $ref: '#/components/schemas/ContentField'
      discriminator:
        propertyName: kind
      required:
      - kind
      - mimeType
    UsageDetails:
      type: object
      description: Usage details.
      properties:
        documentPagesMinimal:
          type: integer
          format: int32
          description: 'The number of document pages processed at the minimal level.

            For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.'
        documentPagesBasic:
          type: integer
          format: int32
          description: 'The number of document pages processed at the basic level.

            For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.'
        documentPagesStandard:
          type: integer
          format: int32
          description: 'The number of document pages processed at the standard level.

            For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page.'
        audioHours:
          type: number
          format: float
          description: The hours of audio processed.
        videoHours:
          type: number
          format: float
          description: The hours of video processed.
        contextualizationTokens:
          type: integer
          format: int32
          description: The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting.
        tokens:
          type: object
          description: The number of LLM and embedding tokens consumed, grouped by model (ex. GTP 4.1) and type (ex. input, cached input, output).
          additionalProperties:
            format: int32
            type: integer
    ContentSpan:
      type: object
      description: Position of the element in markdown, specified as a character offset and length.
      properties:
        offset:
          type: integer
          format: int32
          description: Starting position (0-indexed) of the element in markdown, specified in characters.
        length:
          type: integer
          format: int32
          description: Length of the element in markdown, specified in characters.
      required:
      - offset
      - length
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    ContentField:
      type: object
      description: Field extracted from the content.
      properties:
        type:
          $ref: '#/components/schemas/ContentFieldType'
          description: Semantic data type of the field value.
        spans:
          type: array
          description: Span(s) associated with the field value in the markdown content.
          items:
            $ref: '#/components/schemas/ContentSpan'
        confidence:
          type: number
          format: float
          description: Confidence of predicting the field value.
          minimum: 0
          maximum: 1
        source:
          $ref: '#/components/schemas/SourceExpression'
          description: Encoded source that identifies the position of the field value in the content.
      discriminator:
        propertyName: type
      required:
      - type
    Azure.Core.Foundations.OperationState:
      type: string
      description: Enum describing allowed operation states.
      enum:
      - NotStarted
      - Running
      - Succeeded
      - Failed
      - Canceled
      x-ms-enum:
        name: OperationState
        modelAsString: true
        values:
        - name: NotStarted
          value: NotStarted
          description: The operation has not started.
        - name: Running
          value: Running
          description: The operation is in progress.
        - name: Succeeded
          value: Succeeded
          description: The operation has completed successfully.
        - name: Failed
          value: Failed
          description: The operation has failed.
        - name: Canceled
          value: Canceled
          description: The operation has been canceled by the user.
    ContentAnalyzerAnalyzeOperationStatus:
      type: object
      description: Provides status details for analyze operations.
      properties:
        id:
          type: string
          description: The unique ID of the operation.
        status:
          $ref: '#/components/schemas/Azure.Core.Foundations.OperationState'
          description: The status of the operation
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: Error object that describes the error when status is "Failed".
        result:
          $ref: '#/components/schemas/AnalysisResult'
          description: The result of the operation.
        usage:
          $ref: '#/components/schemas/UsageDetails'
          description: Usage details of the analyze operation.
      required:
      - id
      - status
    ContentFieldType:
      type: string
      description: Semantic data type of the field value.
      enum:
      - string
      - date
      - time
      - number
      - integer
      - boolean
      - array
      - object
      - json
      x-ms-enum:
        name: ContentFieldType
        modelAsString: true
        values:
        - name: string
          value: string
          description: Plain text.
        - name: date
          value: date
          description: Date, normalized to ISO 8601 (YYYY-MM-DD) format.
        - name: time
          value: time
          description: Time, normalized to ISO 8601 (hh:mm:ss) format.
        - name: number
          value: number
          description: Number as double precision floating point.
        - name: integer
          value: integer
          description: Integer as 64-bit signed integer.
        - name: boolean
          value: boolean
          description: Boolean value.
        - name: array
          value: array
          description: List of subfields of the same type.
        - name: object
          value: object
          description: Named list of subfields.
        - name: json
          value: json
          description: JSON object.
    AnalysisContentKind:
      type: string
      description: Kind of media content.
      enum:
      - document
      - audioVisual
      x-ms-enum:
        name: AnalysisContentKind
        modelAsString: true
        values:
        - name: document
          value: document
          description: Document content, such as pdf, image, txt, etc.
        - name: audioVisual
          value: audioVisual
          description: Audio visual content, such as mp3, mp4, etc.
    AnalysisResult:
      type: object
      description: Analyze operation result.
      properties:
        analyzerId:
          type: string
          description: The unique identifier of the analyzer.
          minLength: 1
          maxLength: 64
          pattern: ^[a-zA-Z0-9._-]{1,64}$
        apiVersion:
          type: string
          description: The version of the API used to analyze the document.
        createdAt:
          type: string
          format: date-time
          description: The date and time when the result was created.
        warnings:
          type: array
          description: Warnings encountered while analyzing the document.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
        stringEncoding:
          type: string
          description: "  The string encoding format for content spans in the response.\n  Possible values are 'codePoint', 'utf16', and `utf8`.  Default is `codePoint`.\")"
          default: codePoint
        contents:
          type: array
          description: The extracted content.
          items:
            $ref: '#/components/schemas/AnalysisContent'
      required:
      - contents
    SourceExpression:
      type: string
      description: Encoded string expression that describes positions in the content.
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    AzureKey:
      type: apiKey
      description: Key-based authentication using the access key of the Azure resource.
      name: Ocp-Apim-Subscription-Key
      in: header
    EntraIdToken:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            https://cognitiveservices.azure.com/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/token
      description: Microsoft Entra ID OAuth2 authentication using an access token.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}/contentunderstanding'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: Content Understanding service endpoint.
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true