Microsoft Azure Custom Speech Models: API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Custom Speech Models: Custom Speech Models: API'
tags:
- name: 'Custom Speech Models:'
paths:
  /models/locales:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets A List Of Supported Locales For Model Adaptation
      operationId: microsoftAzureGetsupportedlocalesformodels
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelLocales'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        Get the supported locales:
          $ref: ./examples/get_supported_model_locales.json
      description: Needs a more full description created.
  /models:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The List Of Models For The Authenticated Subscription
      operationId: microsoftAzureGetmodels
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Model'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        Get all models:
          $ref: ./examples/get_models.json
      description: Needs a more full description created.
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Creates A New Model
      operationId: microsoftAzureCreatemodel
      responses:
        '202':
          description: The request was accepted and the response contains the location of the entity.
          headers:
            Retry-After:
              description: The minimum number of seconds to wait before accessing the resource created in this operation.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              schema:
                type: string
            Location:
              description: The location of the created resource.
              schema:
                type: string
                format: uri
            Operation-Location:
              description: The location of the created resource.
              schema:
                type: string
                format: uri
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create a model:
          $ref: ./examples/create_model.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpeechModelDefinition'
        description: The details of the new model.
        required: true
  /models/{id}:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The Model Identified By The Given Id
      operationId: microsoftAzureGetmodel
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          headers:
            Retry-After:
              description: The minimum number of seconds to wait for a non terminal operation to complete.
              schema:
                type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        Get a model:
          $ref: ./examples/get_model.json
      description: Needs a more full description created.
    patch:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Updates The Metadata Of The Model Identified By The Given Id
      operationId: microsoftAzureUpdatemodel
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        Update a model:
          $ref: ./examples/update_model.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelUpdate'
        description: The updated values for the model.
        required: true
    delete:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Deletes The Model Identified By The Given Id
      operationId: microsoftAzureDeletemodel
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: The model was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              schema:
                type: string
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        Delete a model:
          $ref: ./examples/delete_model.json
      description: Needs a more full description created.
  /models/base:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The List Of Base Models For The Authenticated Subscription
      operationId: microsoftAzureGetbasemodels
      parameters:
      - $ref: '#/components/parameters/skipQueryParameter'
      - $ref: '#/components/parameters/topQueryParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedModels'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
      x-ms-pageable:
        itemName: values
        nextLinkName: '@nextLink'
      x-ms-examples:
        Get all base models:
          $ref: ./examples/get_base_models.json
      description: Needs a more full description created.
  /models/base/{id}:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The Base Model Identified By The Given Id
      operationId: microsoftAzureGetbasemodel
      parameters:
      - in: path
        name: id
        description: The identifier of the base model.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model_2'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
      x-ms-examples:
        Get a base model:
          $ref: ./examples/get_base_model.json
      description: Needs a more full description created.
  /models/{id}/copyto:
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Copies A Model From One Subscription To Another
      description: This method can be used to copy a model from one location to another. If the target subscription<br>key belongs to a subscription created for another location, the model will be copied to that location.<br>Only adapted models are allowed to copy to another subscription.
      operationId: microsoftAzureCopymodeltosubscription
      parameters:
      - in: path
        name: id
        description: The identifier of the model that will be copied.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: The response contains information about the entity as payload and its location as header.
          headers:
            Location:
              description: The location of the created resource.
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model_2'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
      x-ms-examples:
        Copy a model:
          $ref: ./examples/copy_model.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelCopy'
        description: The body contains the subscription key of the target subscription.
        required: true
  /models/{id}/manifest:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Returns An Manifest For This Model Which Can Be Used In An On Premise Container
      operationId: microsoftAzureGetmodelmanifest
      parameters:
      - in: path
        name: id
        description: The ID of the model to generate a manifest for.
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/sasValidityQueryParameter'
      responses:
        '200':
          description: Successfully generated a model manifest.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelManifest'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
      x-ms-examples:
        Get a model manifest:
          $ref: ./examples/get_model_manifest.json
      description: Needs a more full description created.
  /models/base/{id}/manifest:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Returns An Manifest For This Base Model Which Can Be Used In An On Premise Container
      operationId: microsoftAzureGetbasemodelmanifest
      parameters:
      - in: path
        name: id
        description: The ID of the model to generate a manifest for.
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/sasValidityQueryParameter'
      responses:
        '200':
          description: Successfully generated a model manifest.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelManifest'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_2'
      x-ms-examples:
        Get a base model manifest:
          $ref: ./examples/get_base_model_manifest.json
      description: Needs a more full description created.
  /models/{id}:copyto:
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Copies A Model From One Subscription To Another
      description: This method can be used to copy a model from one location to another. If the target subscription<br>key belongs to a subscription created for another location, the model will be copied to that location.<br>Only adapted models are allowed to copy to another subscription.
      operationId: microsoftAzureModelsCopyto
      parameters:
      - in: path
        name: id
        description: The identifier of the model that will be copied.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: The response contains information about the entity as payload and its location as header.
          headers:
            Location:
              description: The location of the created resource.
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModel'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_3'
      x-ms-examples:
        Copy a model:
          $ref: ./examples/copy_model.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelCopy_2'
        description: The body contains the subscription key of the target subscription.
        required: true
  /models/{id}/files:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The Files Of The Model Identified By The Given Id
      operationId: microsoftAzureModelsListfiles
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/sasValidityQueryParameter_2'
      - $ref: '#/components/parameters/skipQueryParameter'
      - $ref: '#/components/parameters/topQueryParameter'
      - in: query
        name: filter
        description: "A filtering expression for selecting a subset of the available files.\n            - Supported properties: name, createdDateTime, kind.\n            - Operators:\n              - eq, ne are supported for all properties.\n              - gt, ge, lt, le are supported for createdDateTime.\n              - and, or, not are supported.\n            - Example:\n              filter=name eq 'myaudio.wav' and kind eq 'Audio'"
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            Retry-After:
              description: The minimum number of seconds to wait for a non terminal operation to complete.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFiles'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_3'
      x-ms-pageable:
        itemName: values
        nextLinkName: '@nextLink'
      x-ms-examples:
        Get all files:
          $ref: ./examples/get_model_files.json
      description: Needs a more full description created.
  /models/{id}/files/{fileId}:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets One Specific File Identified With Fileid From A Model Identified With Id
      operationId: microsoftAzureModelsGetfile
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: fileId
        description: The identifier of the file.
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/sasValidityQueryParameter_2'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_3'
      x-ms-examples:
        Get a file:
          $ref: ./examples/get_model_file.json
      description: Needs a more full description created.
  /models/{id}:copy:
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Copies A Model From One Subscription To Another
      description: This method can be used to copy a model from this speech resource to a target one.<br>The authorization is obtained on the target speech resource.<br>Only custom models can be copied to another speech resource.
      operationId: microsoftAzureModelsCopy
      parameters:
      - in: path
        name: id
        description: The identifier of the model that will be copied.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '202':
          description: The response contains information about the entity as payload and its location as header.
          headers:
            Retry-After:
              description: The minimum number of seconds to wait before accessing the resource created in this operation.
              schema:
                type: integer
                format: int32
            Operation-Location:
              description: The location of the operation to track progress.
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_6'
      x-ms-long-running-operation: true
      x-ms-examples:
        Copy a model from source resource to target resource:
          $ref: ./examples/copy_model_with_authorization.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelCopyAuthorization'
        description: The body contains the authorization to copy to the target speech resource.
        required: true
  /models:authorizecopy:
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Allows Another Speech Resource Source To Copy A Model To This Speech Resource Target
      description: This method can be used to allow copying a model from another speech resource.<br>Only custom models can be copied from another speech resource.
      operationId: microsoftAzureModelsAuthorizecopy
      responses:
        '200':
          description: The response contains information about the entity as payload and its location as header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelCopyAuthorization'
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_6'
      x-ms-examples:
        Create a copy model authorization on target resource:
          $ref: ./examples/create_copy_model_authorization.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelCopyAuthorizationDefinition'
        description: The body contains the Azure Resource ID of the source speech resource.
        required: true
components:
  schemas:
    FileKind:
      title: FileKind
      description: Type of data.
      enum:
      - DatasetReport
      - Audio
      - LanguageData
      - PronunciationData
      - AcousticDataArchive
      - AcousticDataTranscriptionV2
      - Transcription
      - TranscriptionReport
      - EvaluationDetails
      - ModelReport
      type: string
      readOnly: true
      x-ms-enum:
        name: FileKind
        modelAsString: true
        values:
        - value: DatasetReport
          description: Type of data is dataset report.
        - value: Audio
          description: Type of data is audio.
        - value: LanguageData
          description: Type of data is language data.
        - value: PronunciationData
          description: Type of data is pronunciation data.
        - value: AcousticDataArchive
          description: Type of data is acoustic data archive.
        - value: AcousticDataTranscriptionV2
          description: Type of data is acoustic data transcription v2.
        - value: Transcription
          description: Type of data is transcription.
        - value: TranscriptionReport
          description: Type of data is transcription report.
        - value: EvaluationDetails
          description: Type of data is evaluation details.
        - value: ModelReport
          description: Type of data is model report.
    ModelLinks:
      title: ModelLinks
      type: object
      properties:
        manifest:
          format: uri
          description: The location to get a manifest for this model to be used in the on-prem container.
          type: string
          readOnly: true
        copyTo:
          format: uri
          description: The location to the model copy action.
          type: string
          readOnly: true
    DatasetKind:
      title: DatasetKind
      description: Kind of data import.
      enum:
      - Language
      - Acoustic
      - Pronunciation
      type: string
      x-ms-enum:
        name: DatasetKind
        modelAsString: false
        values:
        - value: Language
          description: A language dataset.
        - value: Acoustic
          description: An acoustic dataset.
        - value: Pronunciation
          description: A pronunciation dataset.
    PaginatedFiles:
      title: PaginatedFiles
      type: object
      properties:
        values:
          description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\n            \nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\nIt's recommended to build a list on the client and delete after the fetching of the complete list."
          type: array
          items:
            $ref: '#/components/schemas/File'
          readOnly: true
        '@nextLink':
          format: uri
          description: A link to the next set of paginated results if there are more entities available; otherwise null.
          type: string
          readOnly: true
    Error:
      title: Error
      description: The interface represents the content of an error response defined in the OneAPI v2.1 documentation.
      required:
      - code
      - message
      type: object
      properties:
        details:
          description: An array of details representing distinct related errors that occurred during the request.
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        innererror:
          $ref: '#/components/schemas/InnerErrorV2'
        code:
          description: 'A service-defined error code that should be human-readable.

            This code serves as a more specific indicator of the error than

            the HTTP error code specified in the response.'
          type: string
        message:
          description: 'A human-readable representation of the error. It is intended as

            an aid to developers and is not suitable for exposure to end users.'
          type: string
        target:
          description: The target of the particular error (e.g., the name of the property in error).
          type: string
    ModelDeprecationDates:
      title: ModelDeprecationDates
      type: object
      properties:
        adaptationDateTime:
          format: date-time
          type: string
          readOnly: true
        transcriptionDateTime:
          format: date-time
          type: string
          readOnly: true
    SharedModel:
      title: SharedModel
      required:
      - displayName
      - locale
      type: object
      properties:
        self:
          format: uri
          description: The location of this entity.
          type: string
          readOnly: true
        locale:
          description: The locale of the contained data.
          minLength: 1
          type: string
        displayName:
          description: The display name of the object.
          minLength: 1
          type: string
        description:
          description: The description of the object.
          type: string
        lastActionDateTime:
          format: date-time
          description: 'The time-stamp when the current status was entered.

            The time stamp is encoded as ISO 8601 date and time format

            ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).'
          type: string
          readOnly: true
        status:
          $ref: '#/components/schemas/Status'
        createdDateTime:
          format: date-time
          description: 'The time-stamp when the object was created.

            The time stamp is encoded as ISO 8601 date and time format

            ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).'
          type: string
          readOnly: true
    FileProperties:
      title: FileProperties
      type: object
      properties:
        size:
          format: int64
          description: The size of the data in bytes.
          type: integer
          readOnly: true
        duration:
          description: 'The duration in case this file is an audio file. The duration is encoded as ISO 8601

            duration ("PnYnMnDTnHnMnS", see https://en.wikipedia.org/wiki/ISO_8601#Durations).'
          type: string
          readOnly: true
    Dataset:
      title: Dataset
      required:
      - dataImportKind
      - id
      - locale
      - name
      type: object
      properties:
        id:
          format: uuid
          description: The identifier of this entity.
          type: string
        dataImportKind:
          $ref: '#/components/schemas/DatasetKind'
        name:
          description: The name of the object.
          type: string
        description:
          description: The description of the object.
          type: string
        properties:
          description: 'The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum

            allowed value length is 256 characters and the count of allowed entries is 10.'
          type: object
          additionalProperties:
            type: string
        locale:
          description: The locale of the contained data.
          type: string
        lastActionDateTime:
          format: date-time
          description: 'The time-stamp when the current status was entered.

            The time stamp is encoded as ISO 8601 date and time format

            ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).'
          type: string
          readOnly: true
        status:
          $ref: '#/components/schemas/Status'
        createdDateTime:
          format: date-time
          description: 'The time-stamp when the object was created.

            The time stamp is encoded as ISO 8601 date and time format

            ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).'
          type: string
          readOnly: true
    Operation:
      title: Operation
      required:
      - id
      type: object
      properties:
        id:
          format: uuid
          description: The identifier of this Operation.
          type: string
        result:
          $ref: '#/components/schemas/OperationResult'
        error:
          $ref: '#/components/schemas/EntityError_3'
        self:
          format: uri
          description: The location of this entity.
          type: string
          readOnly: true
        lastActionDateTime:
          format: date-time
          description: 'The time-stamp when the current status was entered.

            The time stamp is encoded as ISO 8601 date and time format

            ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).'
          type: string
          readOnly: true
        status:
          $ref: '#/components/schemas/Status'
        createdDateTime:
          format: date-time
          description: 'The time-stamp when the object was created.

            The time stamp is encoded as ISO 8601 date and time format

            ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).'
          type: string
          readOnly: true
    ModelI

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-custom-speech-models-api-openapi.yml