Microsoft Azure Open Ai API

swagger: '2.0'
info:
  title: Microsoft Azure Azure OpenAI API
  version: 2024-03-01-preview
  description: Azure OpenAI APIs for completions and search
  x-typespec-generated:
    - emitter: '@azure-tools/typespec-autorest'
schemes:
  - https
x-ms-parameterized-host:
  hostTemplate: '{endpoint}/openai'
  useSchemePrefix: false
  parameters:
    - name: endpoint
      in: path
      description: >-
        Supported Cognitive Services endpoints (protocol and hostname, for
        example:

        https://westus.api.cognitive.microsoft.com).
      required: true
      type: string
produces:
  - application/json
consumes:
  - application/json
security:
  - ApiKeyAuth: []
  - OAuth2Auth:
      - https://cognitiveservices.azure.com/.default
securityDefinitions:
  ApiKeyAuth:
    type: apiKey
    name: api-key
    in: header
  OAuth2Auth:
    type: oauth2
    flow: implicit
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
    scopes:
      https://cognitiveservices.azure.com/.default: ''
tags:
  - name: Deployments
paths:
  /deployments/{deploymentId}/audio/speech:
    post:
      operationId: microsoftAzureGeneratespeechfromtext
      description: Generates text-to-speech audio from the input text.
      produces:
        - application/octet-stream
        - application/json
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/SpeechGenerationOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            type: file
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Generates text-to-speech audio from the input text.:
          $ref: ./examples/generated_audio_speech.json
      summary: Microsoft Azure Post Deployments Deploymentid Audio Speech
      tags:
        - Deployments
  /deployments/{deploymentId}/audio/transcriptions:
    post:
      operationId: microsoftAzureGetaudiotranscriptionasplaintext
      description: >-
        Gets transcribed text and associated metadata from provided spoken audio
        data. Audio will be transcribed in the<br>written language corresponding
        to the language it was spoken in.
      produces:
        - text/plain
        - application/json
      consumes:
        - multipart/form-data
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - $ref: '#/parameters/AudioTranscriptionOptions.file'
        - $ref: '#/parameters/AudioTranscriptionOptions.filename'
        - $ref: '#/parameters/AudioTranscriptionOptions.responseFormat'
        - $ref: '#/parameters/AudioTranscriptionOptions.language'
        - $ref: '#/parameters/AudioTranscriptionOptions.prompt'
        - $ref: '#/parameters/AudioTranscriptionOptions.temperature'
        - $ref: '#/parameters/AudioTranscriptionOptions.model'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            type: string
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Gets transcribed text and associated metadata from provided spoken audio data.:
          $ref: ./examples/generated_audio_transcription_text.json
      summary: Microsoft Azure Post Deployments Deploymentid Audio Transcriptions
      tags:
        - Deployments
  /deployments/{deploymentId}/audio/translations:
    post:
      operationId: microsoftAzureGetaudiotranslationasplaintext
      description: >-
        Gets English language transcribed text and associated metadata from
        provided spoken audio data.
      produces:
        - text/plain
        - application/json
      consumes:
        - multipart/form-data
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - $ref: '#/parameters/AudioTranslationOptions.file'
        - $ref: '#/parameters/AudioTranslationOptions.filename'
        - $ref: '#/parameters/AudioTranslationOptions.responseFormat'
        - $ref: '#/parameters/AudioTranslationOptions.prompt'
        - $ref: '#/parameters/AudioTranslationOptions.temperature'
        - $ref: '#/parameters/AudioTranslationOptions.model'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            type: string
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Gets English language transcribed text and associated metadata from provided spoken audio data.:
          $ref: ./examples/generated_audio_translation_text.json
      summary: Microsoft Azure Post Deployments Deploymentid Audio Translations
      tags:
        - Deployments
  /deployments/{deploymentId}/chat/completions:
    post:
      operationId: microsoftAzureGetchatcompletions
      description: >-
        Gets chat completions for the provided chat messages.<br>Completions
        support a wide variety of tasks and generate text that continues from or
        "completes"<br>provided prompt data.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/ChatCompletionsOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ChatCompletions'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        ? Creates a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions.
        : $ref: >-
            ./examples/generated_extensions_chat_completions_azure_search_minimum.json
        Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.:
          $ref: >-
            ./examples/generated_extensions_chat_completions_azure_search_image_vector.json
        ? Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions.
        : $ref: >-
            ./examples/generated_extensions_chat_completions_azure_search_advanced.json
        Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.:
          $ref: ./examples/generated_extensions_chat_completions_aml_index.json
        Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.:
          $ref: ./examples/generated_extensions_chat_completions_cosmos_db.json
        Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.:
          $ref: ./examples/generated_extensions_chat_completions_elasticsearch.json
        Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.:
          $ref: ./examples/generated_extensions_chat_completions_pinecone.json
        Creates a completion for the provided prompt, parameters and chosen model.:
          $ref: ./examples/generated_chat_completions.json
      summary: Microsoft Azure Post Deployments Deploymentid Chat Completions
      tags:
        - Deployments
  /deployments/{deploymentId}/completions:
    post:
      operationId: microsoftAzureGetcompletions
      description: >-
        Gets completions for the provided input prompts.<br>Completions support
        a wide variety of tasks and generate text that continues from or
        "completes"<br>provided prompt data.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/CompletionsOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Completions'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Creates a completion for the provided prompt, parameters and chosen model.:
          $ref: ./examples/generated_completions.json
      summary: Microsoft Azure Post Deployments Deploymentid Completions
      tags:
        - Deployments
  /deployments/{deploymentId}/embeddings:
    post:
      operationId: microsoftAzureGetembeddings
      description: Return the embeddings for a given prompt.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/EmbeddingsOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Embeddings'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Return the embeddings for a given prompt.:
          $ref: ./examples/generated_embeddings.json
      summary: Microsoft Azure Post Deployments Deploymentid Embeddings
      tags:
        - Deployments
  /deployments/{deploymentId}/images/generations:
    post:
      operationId: microsoftAzureGetimagegenerations
      description: Creates an image given a prompt.
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/ImageGenerationOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ImageGenerations'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Creates images given a prompt.:
          $ref: ./examples/generated_image_generation.json
      summary: Microsoft Azure Post Deployments Deploymentid Images Generations
      tags:
        - Deployments
x-ms-paths:
  /deployments/{deploymentId}/audio/transcriptions?_overload=getAudioTranscriptionAsResponseObject:
    post:
      operationId: GetAudioTranscriptionAsResponseObject
      description: >-
        Gets transcribed text and associated metadata from provided spoken audio
        data. Audio will be transcribed in the

        written language corresponding to the language it was spoken in.
      consumes:
        - multipart/form-data
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - $ref: '#/parameters/AudioTranscriptionOptions.file'
        - $ref: '#/parameters/AudioTranscriptionOptions.filename'
        - $ref: '#/parameters/AudioTranscriptionOptions.responseFormat'
        - $ref: '#/parameters/AudioTranscriptionOptions.language'
        - $ref: '#/parameters/AudioTranscriptionOptions.prompt'
        - $ref: '#/parameters/AudioTranscriptionOptions.temperature'
        - $ref: '#/parameters/AudioTranscriptionOptions.model'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AudioTranscription'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Gets transcribed text and associated metadata from provided spoken audio data.:
          $ref: ./examples/generated_audio_transcription_object.json
  /deployments/{deploymentId}/audio/translations?_overload=getAudioTranslationAsResponseObject:
    post:
      operationId: GetAudioTranslationAsResponseObject
      description: >-
        Gets English language transcribed text and associated metadata from
        provided spoken audio data.
      consumes:
        - multipart/form-data
      parameters:
        - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
        - name: deploymentId
          in: path
          description: >-
            Specifies either the model deployment name (when using Azure OpenAI)
            or model name (when using non-Azure OpenAI) to use for this request.
          required: true
          type: string
        - $ref: '#/parameters/AudioTranslationOptions.file'
        - $ref: '#/parameters/AudioTranslationOptions.filename'
        - $ref: '#/parameters/AudioTranslationOptions.responseFormat'
        - $ref: '#/parameters/AudioTranslationOptions.prompt'
        - $ref: '#/parameters/AudioTranslationOptions.temperature'
        - $ref: '#/parameters/AudioTranslationOptions.model'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AudioTranslation'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Gets English language transcribed text and associated metadata from provided spoken audio data.:
          $ref: ./examples/generated_audio_translation_object.json
definitions:
  AudioTaskLabel:
    type: string
    description: Defines the possible descriptors for available audio operation responses.
    enum:
      - transcribe
      - translate
    x-ms-enum:
      name: AudioTaskLabel
      modelAsString: true
      values:
        - name: transcribe
          value: transcribe
          description: >-
            Accompanying response data resulted from an audio transcription
            task.
        - name: translate
          value: translate
          description: Accompanying response data resulted from an audio translation task.
  AudioTranscription:
    type: object
    description: >-
      Result information for an operation that transcribed spoken audio into
      written text.
    properties:
      text:
        type: string
        description: The transcribed text for the provided audio data.
      task:
        $ref: '#/definitions/AudioTaskLabel'
        description: >-
          The label that describes which operation type generated the
          accompanying response data.
      language:
        type: string
        description: >-
          The spoken language that was detected in the transcribed audio data.

          This is expressed as a two-letter ISO-639-1 language code like 'en' or
          'fr'.
      duration:
        type: number
        format: float
        description: >-
          The total duration of the audio processed to produce accompanying
          transcription information.
      segments:
        type: array
        description: >-
          A collection of information about the timing, probabilities, and other
          detail of each processed audio segment.
        items:
          $ref: '#/definitions/AudioTranscriptionSegment'
    required:
      - text
  AudioTranscriptionFormat:
    type: string
    description: >-
      Defines available options for the underlying response format of output
      transcription information.
    enum:
      - json
      - verbose_json
      - text
      - srt
      - vtt
    x-ms-enum:
      name: AudioTranscriptionFormat
      modelAsString: true
      values:
        - name: json
          value: json
          description: >-
            Use a response body that is a JSON object containing a single 'text'
            field for the transcription.
        - name: verbose_json
          value: verbose_json
          description: >-
            Use a response body that is a JSON object containing transcription
            text along with timing, segments, and other

            metadata.
        - name: text
          value: text
          description: >-
            Use a response body that is plain text containing the raw,
            unannotated transcription.
        - name: srt
          value: srt
          description: >-
            Use a response body that is plain text in SubRip (SRT) format that
            also includes timing information.
        - name: vtt
          value: vtt
          description: >-
            Use a response body that is plain text in Web Video Text Tracks
            (VTT) format that also includes timing information.
  AudioTranscriptionOptions:
    type: object
    description: The configuration information for an audio transcription request.
    properties:
      file:
        type: string
        format: byte
        description: >-
          The audio data to transcribe. This must be the binary content of a
          file in one of the supported media formats:
           flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.
      filename:
        type: string
        description: >-
          The optional filename or descriptive identifier to associate with with
          the audio data.
      response_format:
        $ref: '#/definitions/AudioTranscriptionFormat'
        description: >-
          The requested format of the transcription response data, which will
          influence the content and detail of the result.
        x-ms-client-name: responseFormat
      language:
        type: string
        description: >-
          The primary spoken language of the audio data to be transcribed,
          supplied as a two-letter ISO-639-1 language code

          such as 'en' or 'fr'.

          Providing this known input language is optional but may improve the
          accuracy and/or latency of transcription.
      prompt:
        type: string
        description: >-
          An optional hint to guide the model's style or continue from a prior
          audio segment. The written language of the

          prompt should match the primary spoken language of the audio data.
      temperature:
        type: number
        format: float
        description: >-
          The sampling temperature, between 0 and 1.

          Higher values like 0.8 will make the output more random, while lower
          values like 0.2 will make it more focused and deterministic.

          If set to 0, the model will use log probability to automatically
          increase the temperature until certain thresholds are hit.
      model:
        type: string
        description: The model to use for this transcription request.
    required:
      - file
  AudioTranscriptionSegment:
    type: object
    description: >-
      Extended information about a single segment of transcribed audio data.

      Segments generally represent roughly 5-10 seconds of speech. Segment
      boundaries typically occur between words but not

      necessarily sentences.
    properties:
      id:
        type: integer
        format: int32
        description: The 0-based index of this segment within a transcription.
      start:
        type: number
        format: float
        description: >-
          The time at which this segment started relative to the beginning of
          the transcribed audio.
      end:
        type: number
        format: float
        description: >-
          The time at which this segment ended relative to the beginning of the
          transcribed audio.
      text:
        type: string
        description: The transcribed text that was part of this audio segment.
      temperature:
        type: number
        format: float
        description: The temperature score associated with this audio segment.
      avg_logprob:
        type: number
        format: float
        description: The average log probability associated with this audio segment.
        x-ms-client-name: avgLogprob
      compression_ratio:
        type: number
        format: float
        description: The compression ratio of this audio segment.
        x-ms-client-name: compressionRatio
      no_speech_prob:
        type: number
        format: float
        description: The probability of no speech detection within this audio segment.
        x-ms-client-name: noSpeechProb
      tokens:
        type: array
        description: The token IDs matching the transcribed text in this audio segment.
        items:
          type: integer
          format: int32
      seek:
        type: integer
        format: int32
        description: >-
          The seek position associated with the processing of this audio
          segment.

          Seek positions are expressed as hundredths of seconds.

          The model may process several segments from a single seek position, so
          while the seek position will never represent

          a later time than the segment's start, the segment's start may
          represent a significantly later time than the

          segment's associated seek position.
    required:
      - id
      - start
      - end
      - text
      - temperature
      - avg_logprob
      - compression_ratio
      - no_speech_prob
      - tokens
      - seek
  AudioTranslation:
    type: object
    description: >-
      Result information for an operation that translated spoken audio into
      written text.
    properties:
      text:
        type: string
        description: The translated text for the provided audio data.
      task:
        $ref: '#/definitions/AudioTaskLabel'
        description: >-
          The label that describes which operation type generated the
          accompanying response data.
      language:
        type: string
        description: >-
          The spoken language that was detected in the translated audio data.

          This is expressed as a two-letter ISO-639-1 language code like 'en' or
          'fr'.
      duration:
        type: number
        format: float
        description: >-
          The total duration of the audio processed to produce accompanying
          translation information.
      segments:
        type: array
        description: >-
          A collection of information about the timing, probabilities, and other
          detail of each processed audio segment.
        items:
          $ref: '#/definitions/AudioTranslationSegment'
    required:
      - text
  AudioTranslationFormat:
    type: string
    description: >-
      Defines available options for the underlying response format of output
      translation information.
    enum:
      - json
      - verbose_json
      - text
      - srt
      - vtt
    x-ms-enum:
      name: AudioTranslationFormat
      modelAsString: true
      values:
        - name: json
          value: json
          description: >-
            Use a response body that is a JSON object containing a single 'text'
            field for the translation.
        - name: verbose_json
          value: verbose_json
          description: >-
            Use a response body that is a JSON object containing translation
            text along with timing, segments, and other

            metadata.
        - name: text
          value: text
          description: >-
            Use a response body that is plain text containing the raw,
            unannotated translation.
        - name: srt
          value: srt
          description: >-
            Use a response body that is plain text in SubRip (SRT) format that
            also includes timing information.
        - name: vtt
          value: vtt
          description: >-
            Use a response body that is plain text in Web Video Text Tracks
            (VTT) format that also includes timing information.
  AudioTranslationOptions:
    type: object
    description: The configuration information for an audio translation request.
    properties:
      file:
        type: string
        format: byte
        description: >-
          The audio data to translate. This must be the binary content of a file
          in one of the supported media formats:
           flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.
      filename:
        type: string
        description: >-
          The optional filename or descriptive identifier to associate with with
          the audio data.
      response_format:
        $ref: '#/definitions/AudioTranslationFormat'
        description: >-
          The requested format of the translation response data, which will
          influence the content and detail of the result.
        x-ms-client-name: responseFormat
      prompt:
        type: string
        description: >-
          An optional hint to guide the model's style or continue from a prior
          audio segment. The written language of the

          prompt should match the primary spoken language of the audio data.
      temperature:
        type: number
        format: float
        description: >-
          The sampling temperature, between 0 and 1.

          Higher values like 0.8 will make the output more random, while lower
          values like 0.2 will make it more focused and deterministic.

          If set to 0, the model will use log probability to automatically
          increase the temperature until certain thresholds are hit.
      model:
        type: string
        description: The model to use for this translation request.
    required:
      - file
  AudioTranslationSegment:
    type: object
    description: >-
      Extended information about a single segment of translated audio data.

      Segments generally represent roughly 5-10 seconds of speech. Segment
      boundaries typically occur between words but not

      necessarily sentences.
    properties:
      id:
        type: integer
        format: int32
        description: The 0-based index of this segment within a translation.
      start:
        type: number
        format: float
        description: >-
          The time at which this segment started relative to the beginning of
          the translated audio.
      end:
        type: number
        format: float
        description: >-
          The time at which this segment ended relative to the beginning of the
          translated audio.
      text:
        type: string
        description: The translated text that was part of this audio segment.
      temperature:
        type: number
        format: float
        description: The temperature score associated with this audio segment.
      avg_logprob:
        type: number
        format: float
        description: The average log probability associated with this audio segment.
        x-ms-client-name: avgLogprob
      compression_ratio:
        type: number
        format: float
        description: The compression ratio of this audio segment.
        x-ms-client-name: compressionRatio
      no_speech_prob:
        type: number
        format: float
        description: The probability of no speech detection within this audio segment.
        x-ms-client-name: noSpeechProb
      tokens:
        type: array
        description: The token IDs matching the translated text in this audio segment.
        items:
          type: integer
          format: int32
      seek:
        type: integer
        format: int32
        description: >-
          The seek position associated with the processing of this audio
          segment.

          Seek positions are expressed as hundredths of seconds.

          The model may process several segments from a single seek position, so
          while the seek position will never represent

          a later time than the segment's start, the segment's start may
          represent a significantly later time than the

          segment's associated seek position.
    required:
      - id
      - start
      - end
      - text
      - temperature
      - avg_logprob
      - compression_ratio
      - no_speech_prob
      - tokens
      - seek
  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: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: >-
          An object containing more specific information than the current object
          about the error.
    requir

# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-openai-api-openapi-original.yml