swagger: '2.0'
info:
  title: Microsoft Azure Speech Services API v2.0
  description: Speech Services API v2.0.
  contact:
    name: Cognitive Services - Speech Services
    url: https://docs.microsoft.com/azure/cognitive-services/speech-service/support
  version: v2.0
paths:
  /accuracytests:
    get:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Gets The List Of Accuracy Tests For The Authenticated Subscription'
      operationId: microsoftAzureGetaccuracytests
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Test'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all accuracy tests:
          $ref: ./examples/get_accuracy_tests.json
      description: Needs a more full description created.
    post:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Creates A New Accuracy Test'
      operationId: microsoftAzureCreateaccuracytest
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: testDefinition
          description: The details of the new accuracy test.
          required: true
          schema:
            $ref: '#/definitions/TestDefinition'
      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.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create an accuracy test:
          $ref: ./examples/create_accuracy_test.json
      description: Needs a more full description created.
  /accuracytests/{id}:
    get:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Gets The Accuracy Test Identified By The Given Id'
      operationId: microsoftAzureGetaccuracytest
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the accuracy test.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Test'
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait for a non terminal
                operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get an accuracy test:
          $ref: ./examples/get_accuracy_test.json
      description: Needs a more full description created.
    patch:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Updates The Mutable Details Of The Test Identified By Its Id'
      operationId: microsoftAzureUpdateaccuracytest
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the accuracy test.
          required: true
          type: string
          format: uuid
        - in: body
          name: testUpdate
          description: The object containing the updated fields of the test.
          required: true
          schema:
            $ref: '#/definitions/TestUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Test'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update an accuracy test:
          $ref: ./examples/update_accuracy_test.json
      description: Needs a more full description created.
    delete:
      tags:
        - 'Custom Speech Accuracy Tests:'
      summary: 'Microsoft Azure Deletes The Accuracy Test Identified By The Given Id'
      operationId: microsoftAzureDeleteaccuracytest
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the accuracy test.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The test was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete an accuracy test:
          $ref: ./examples/delete_accuracy_test.json
      description: Needs a more full description created.
  /datasets/locales:
    get:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Gets A List Of Supported Locales For Datasets'
      operationId: microsoftAzureGetsupportedlocalesfordatasets
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DatasetLocales'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get the supported locales:
          $ref: ./examples/get_supported_dataset_locales.json
      description: Needs a more full description created.
  /datasets:
    get:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Gets A List Of Datasets For The Authenticated Subscription'
      operationId: microsoftAzureGetdatasets
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Dataset'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all datasets:
          $ref: ./examples/get_datasets.json
      description: Needs a more full description created.
  /datasets/{id}:
    get:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Gets The Dataset Identified By The Given Id'
      operationId: microsoftAzureGetdataset
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the dataset.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Dataset'
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait for a non terminal
                operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get a dataset:
          $ref: ./examples/get_dataset.json
      description: Needs a more full description created.
    patch:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Updates The Mutable Details Of The Dataset Identified By Its Id'
      operationId: microsoftAzureUpdatedataset
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the dataset.
          required: true
          type: string
          format: uuid
        - in: body
          name: datasetUpdate
          description: The updated values for the dataset.
          required: true
          schema:
            $ref: '#/definitions/DatasetUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Dataset'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update a dataset:
          $ref: ./examples/update_dataset.json
      description: Needs a more full description created.
    delete:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Deletes The Specified Dataset'
      operationId: microsoftAzureDeletedataset
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the dataset.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The dataset was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete a dataset:
          $ref: ./examples/delete_dataset.json
      description: Needs a more full description created.
  /datasets/upload:
    post:
      tags:
        - 'Custom Speech Datasets for Model Adaptation:'
      summary: 'Microsoft Azure Uploads Data And Creates A New Dataset'
      operationId: microsoftAzureUploaddataset
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - in: formData
          name: name
          description: The name of this dataset (always add this string for any dataset).
          type: string
        - in: formData
          name: description
          description: Optional description of this dataset.
          type: string
        - in: formData
          name: locale
          description: The locale of this dataset (always add this string for any dataset).
          type: string
        - in: formData
          name: dataImportKind
          description: >-
            The kind of the dataset (always add this string for any dataset).
            Possible values are "Language", "Acoustic", "Pronunciation".
          type: string
        - in: formData
          name: properties
          description: >-
            Optional properties of this dataset (json serialized object with
            key/values, where all values must be strings)
          type: string
        - in: formData
          name: audiodata
          description: >-
            A zip file containing the audio data (this and the audio archive
            file for acoustic datasets).
          type: file
        - in: formData
          name: transcriptions
          description: >-
            A text file containing the transcriptions for the audio data (this
            and the transcriptions file for acoustic datasets).
          type: file
        - in: formData
          name: languagedata
          description: >-
            A text file containing the language or pronunciation data (only this
            file for language datasets).
          type: file
      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.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Upload a dataset:
          $ref: ./examples/upload_dataset.json
      description: Needs a more full description created.
  /endpoints/locales:
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets A List Of Supported Locales For Endpoint Creations'
      operationId: microsoftAzureGetsupportedlocalesforendpoints
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              type: string
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get the supported locales:
          $ref: ./examples/get_supported_endpoint_locales.json
      description: Needs a more full description created.
  /endpoints:
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets The List Of Endpoints For The Authenticated Subscription'
      operationId: microsoftAzureGetendpoints
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Endpoint'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all endpoints:
          $ref: ./examples/get_endpoints.json
      description: Needs a more full description created.
    post:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Creates A New Endpoint'
      operationId: microsoftAzureCreateendpoint
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: endpointDefinition
          description: The details of the endpoint.
          required: true
          schema:
            $ref: '#/definitions/SpeechEndpointDefinition'
      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.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create an endpoint:
          $ref: ./examples/create_endpoint.json
      description: Needs a more full description created.
  /endpoints/{id}:
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets The Endpoint Identified By The Given Id'
      operationId: microsoftAzureGetendpoint
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Endpoint'
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait for a non terminal
                operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get an endpoint:
          $ref: ./examples/get_endpoint.json
      description: Needs a more full description created.
    delete:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Deletes The Endpoint Identified By The Given Id'
      operationId: microsoftAzureDeleteendpoint
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The model endpoint was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete an endpoint:
          $ref: ./examples/delete_endpoint.json
      description: Needs a more full description created.
    patch:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Updates The Metadata Of The Endpoint Identified By The Given Id'
      operationId: microsoftAzureUpdateendpoint
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
        - in: body
          name: endpointUpdate
          description: The updated values for the endpoint.
          required: true
          schema:
            $ref: '#/definitions/EndpointMetadataUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Endpoint'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update an endpoint:
          $ref: ./examples/update_endpoint.json
      description: Needs a more full description created.
  /endpoints/{endpointId}/data:
    delete:
      tags:
        - 'Custom Speech Endpoints:'
      summary: >-
        Microsoft Azure Deletes The Transcriptions And Captured Audio Files Associated With The Endpoint Identified By The Given Id
      description: Deletion will happen in the background and can take up to a day.
      operationId: microsoftAzureDeleteendpointdata
      produces:
        - application/json
      parameters:
        - in: path
          name: endpointId
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The endpoint data export tasks were successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete the data for an endpoint:
          $ref: ./examples/delete_endpoint_data.json
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets The List Of Endpoint Data Export Tasks For The Authenticated User'
      operationId: microsoftAzureGetendpointdataexports
      produces:
        - application/json
      parameters:
        - in: path
          name: endpointId
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/EndpointData'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all endpoint data exports:
          $ref: ./examples/get_endpoint_data_exports.json
      description: Needs a more full description created.
    post:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Create A New Endpoint Data Export Task'
      operationId: microsoftAzureCreateendpointdataexport
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: endpointId
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
        - in: body
          name: endpointDataDefinition
          description: The details of the new endpoint data export.
          required: true
          schema:
            $ref: '#/definitions/EndpointDataDefinition'
      responses:
        '202':
          description: >-
            The response contains the id of the endpoint data export task in the
            header.
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait before accessing the
                resource created in this operation.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create an endpoint data exports:
          $ref: ./examples/create_endpoint_data_exports.json
      description: Needs a more full description created.
  /endpoints/{endpointId}/data/{id}:
    delete:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Deletes The Endpoint Data Export Task Identified By The Given Id'
      operationId: microsoftAzureDeleteendpointdataexport
      produces:
        - application/json
      parameters:
        - in: path
          name: endpointId
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
        - in: path
          name: id
          description: The identifier of the endpoint data export.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The endpoint data export task was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete a data export for an endpoint:
          $ref: ./examples/delete_endpoint_data_export.json
      description: Needs a more full description created.
    get:
      tags:
        - 'Custom Speech Endpoints:'
      summary: 'Microsoft Azure Gets The Specified Endpoint Data Export Task For The Authenticated User'
      operationId: microsoftAzureGetendpointdataexport
      produces:
        - application/json
      parameters:
        - in: path
          name: endpointId
          description: The identifier of the endpoint.
          required: true
          type: string
          format: uuid
        - in: path
          name: id
          description: The identifier of the data export.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/EndpointData'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get an endpoint data export:
          $ref: ./examples/get_endpoint_data_export.json
      description: Needs a more full description created.
  /models/locales:
    get:
      tags:
        - 'Custom Speech Models:'
      summary: 'Microsoft Azure Gets A List Of Supported Locales For Model Adaptation'
      operationId: microsoftAzureGetsupportedlocalesformodels
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ModelLocales'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/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
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Model'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/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
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: modelDefinition
          description: The details of the new model.
          required: true
          schema:
            $ref: '#/definitions/SpeechModelDefinition'
      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.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/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.
  /models/{id}:
    get:
      tags:
        - 'Custom Speech Models:'
      summary: 'Microsoft Azure Gets The Model Identified By The Given Id'
      operationId: microsoftAzureGetmodel
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the model.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Model'
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait for a non terminal
                operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/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
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the model.
          required: true
          type: string
          format: uuid
        - in: body
          name: modelUpdate
          description: The updated values for the model.
          required: true
          schema:
            $ref: '#/definitions/ModelUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Model'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update a model:
          $ref: ./examples/update_model.json
      description: Needs a more full description created.
    delete:
      tags:
        - 'Custom Speech Models:'
      summary: 'Microsoft Azure Deletes The Model Identified By The Given Id'
      operationId: microsoftAzureDeletemodel
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the model.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The model was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete a model:
          $ref: ./examples/delete_model.json
      description: Needs a more full description created.
  /transcriptions/locales:
    get:
      tags:
        - 'Custom Speech Transcriptions:'
      summary: 'Microsoft Azure Gets A List Of Supported Locales For Offline Transcriptions'
      operationId: microsoftAzureGetsupportedlocalesfortranscriptions
      produces:
        - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              type: string
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get the supported locales:
          $ref: ./examples/get_supported_transcription_locales.json
      description: Needs a more full description created.
  /transcriptions:
    get:
      tags:
        - 'Custom Speech Transcriptions:'
      summary: 'Microsoft Azure Gets A List Of Transcriptions For The Authenticated Subscription'
      operationId: microsoftAzureGettranscriptions
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/skipQueryParameter'
        - $ref: '#/parameters/takeQueryParameter'
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Transcription'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all transcriptions:
          $ref: ./examples/get_transcriptions.json
      description: Needs a more full description created.
    post:
      tags:
        - 'Custom Speech Transcriptions:'
      summary: 'Microsoft Azure Creates A New Transcription'
      operationId: microsoftAzureCreatetranscription
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: transcription
          description: The details of the new transcription.
          required: true
          schema:
            $ref: '#/definitions/TranscriptionDefinition'
      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.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create a transcription for URIs:
          $ref: ./examples/create_uri_transcription.json
      description: Needs a more full description created.
  /transcriptions/{id}:
    get:
      tags:
        - 'Custom Speech Transcriptions:'
      summary: 'Microsoft Azure Gets The Transcription Identified By The Given Id'
      operationId: microsoftAzureGettranscription
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the transcription.
          required: true
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Transcription'
          headers:
            Retry-After:
              description: >-
                The minimum number of seconds to wait for a non terminal
                operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get a transcription:
          $ref: ./examples/get_transcription.json
      description: Needs a more full description created.
    patch:
      tags:
        - 'Custom Speech Transcriptions:'
      summary: 'Microsoft Azure Updates The Mutable Details Of The Transcription Identified By Its Id'
      operationId: microsoftAzureUpdatetranscription
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the transcription.
          required: true
          type: string
          format: uuid
        - in: body
          name: transcriptionUpdate
          description: The updated values for the transcription.
          required: true
          schema:
            $ref: '#/definitions/TranscriptionUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Transcription'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update a transcription:
          $ref: ./examples/update_transcription.json
      description: Needs a more full description created.
    delete:
      tags:
        - 'Custom Speech Transcriptions:'
      summary: 'Microsoft Azure Deletes The Specified Transcription Task'
      operationId: microsoftAzureDeletetranscription
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: The identifier of the transcription.
          required: true
          type: string
          format: uuid
      responses:
        '204':
          description: The transcription task was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: >-
                The remaining number of requests until the rate limit is
                reached.
              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.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete a transcription:
          $ref: ./examples/delete_transcription.json
      description: Needs a more full description created.
definitions:
  Dataset:
    title: Dataset
    required:
      - dataImportKind
      - id
      - locale
      - name
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
      dataImportKind:
        $ref: '#/definitions/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\r\nallowed 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.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        format: date-time
        description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
  DatasetIdentity:
    title: DatasetIdentity
    required:
      - id
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
  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.
  DatasetLocales:
    title: DatasetLocales
    type: object
    properties:
      Language:
        type: array
        items:
          type: string
      Acoustic:
        type: array
        items:
          type: string
      Pronunciation:
        type: array
        items:
          type: string
  DatasetUpdate:
    title: DatasetUpdate
    required:
      - name
    type: object
    properties:
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
  Endpoint:
    title: Endpoint
    required:
      - endpointKind
      - id
      - locale
      - models
      - name
    type: object
    properties:
      concurrentRecognitions:
        format: int32
        description: The number of concurrent recognitions the endpoint supports.
        type: integer
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
      endpointUrls:
        description: The list of endpoint urls.
        type: object
        additionalProperties:
          type: string
        readOnly: true
      endpointKind:
        $ref: '#/definitions/EndpointKind'
      lastActionDateTime:
        format: date-time
        description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        format: date-time
        description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      contentLoggingEnabled:
        description: >-
          A value indicating whether content logging (audio & transcriptions) is
          being used for a deployment.
        type: boolean
      models:
        description: Information about the deployed models.
        type: array
        items:
          $ref: '#/definitions/Model'
      locale:
        description: The locale of the contained data.
        type: string
      properties:
        description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
  EndpointData:
    title: EndpointData
    required:
      - endDate
      - id
      - startDate
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
      dataUrl:
        format: uri
        description: The resulting data Url for the model deployment.
        type: string
      lastActionDateTime:
        format: date-time
        description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        format: date-time
        description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      startDate:
        format: date-time
        description: The start date of the deployment data export.
        type: string
      endDate:
        format: date-time
        description: The end date of the deployment data export.
        type: string
  EndpointDataDefinition:
    title: EndpointDataDefinition
    required:
      - endDate
      - startDate
    type: object
    properties:
      startDate:
        format: date-time
        description: The start date of the deployment data export.
        type: string
      endDate:
        format: date-time
        description: The end date of the deployment data export.
        type: string
  EndpointKind:
    title: EndpointKind
    enum:
      - SpeechRecognition
      - PronunciationScore
    type: string
    x-ms-enum:
      name: EndpointKind
      modelAsString: false
      values:
        - value: SpeechRecognition
          description: A SpeechRecognition model deployment.
        - value: PronunciationScore
          description: A PronunciationScore model deployment.
  EndpointMetadataUpdate:
    title: EndpointMetadataUpdate
    required:
      - name
    type: object
    properties:
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
  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: '#/definitions/ErrorDetail'
      innererror:
        $ref: '#/definitions/InnerErrorV2'
      code:
        description: "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response."
        type: string
      message:
        description: "A human-readable representation of the error. It is intended as\r\nan 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
  ErrorDetail:
    title: ErrorDetail
    description: >-
      An array of implementations of this interface can be used as details for
      an error.
    required:
      - code
      - message
    type: object
    properties:
      code:
        description: "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response."
        type: string
      message:
        description: "A human-readable representation of the error. It is intended as\r\nan 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
  InnerErrorV2:
    title: InnerErrorV2
    description: "An implementation of this interface represents a stage in a stack trace.\r\nIf the error level is the root, the Microsoft.SpeechServices.Http.Dto.IInnerError.Code and the Microsoft.SpeechServices.Http.Dto.IInnerError.InnerError\r\nproperty may be omitted."
    type: object
    properties:
      code:
        description: "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response."
        type: string
      innererror:
        $ref: '#/definitions/InnerErrorV2'
  Model:
    title: Model
    required:
      - id
      - locale
      - modelKind
      - name
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
      modelKind:
        $ref: '#/definitions/ModelKind'
      text:
        description: The text used to adapt this language model.
        type: string
      baseModel:
        $ref: '#/definitions/Model'
      datasets:
        description: Datasets used for adaptation.
        type: array
        items:
          $ref: '#/definitions/Dataset'
      locale:
        description: The locale of the contained data.
        type: string
      properties:
        description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
      lastActionDateTime:
        format: date-time
        description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        format: date-time
        description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
  ModelIdentity:
    title: ModelIdentity
    required:
      - id
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
  ModelKind:
    title: ModelKind
    description: Type of speech model.
    enum:
      - Acoustic
      - Language
      - AcousticAndLanguage
    type: string
    x-ms-enum:
      name: ModelKind
      modelAsString: false
      values:
        - value: Acoustic
          description: An acoustic model.
        - value: Language
          description: A language model.
        - value: AcousticAndLanguage
          description: An acoustic and language model.
  ModelLocales:
    title: ModelLocales
    type: object
    properties:
      Acoustic:
        type: array
        items:
          type: string
      Language:
        type: array
        items:
          type: string
      AcousticAndLanguage:
        type: array
        items:
          type: string
  ModelUpdate:
    title: ModelUpdate
    required:
      - name
    type: object
    properties:
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
  SpeechEndpointDefinition:
    title: SpeechEndpointDefinition
    required:
      - locale
      - models
      - name
    type: object
    properties:
      concurrentRecognitions:
        format: int32
        description: The number of concurrent recognitions the endpoint supports.
        maximum: 20
        minimum: 1
        type: integer
      contentLoggingEnabled:
        description: >-
          A value indicating whether content logging (audio & transcriptions) is
          being used for a deployment.
        type: boolean
      models:
        description: Information about the deployed models.
        type: array
        items:
          $ref: '#/definitions/ModelIdentity'
      description:
        description: The description of the object.
        type: string
      locale:
        description: The locale of the contained data.
        type: string
      properties:
        description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
      name:
        description: The name of the object.
        type: string
  SpeechModelDefinition:
    title: SpeechModelDefinition
    required:
      - locale
      - modelKind
      - name
    type: object
    properties:
      modelKind:
        $ref: '#/definitions/ModelKind'
      text:
        description: The text used to adapt this language model.
        type: string
      baseModel:
        $ref: '#/definitions/ModelIdentity'
      datasets:
        description: Datasets used for adaptation.
        type: array
        items:
          $ref: '#/definitions/DatasetIdentity'
      description:
        description: The description of the object.
        type: string
      locale:
        description: The locale of the contained data.
        type: string
      properties:
        description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
      name:
        description: The name of the object.
        type: string
  Status:
    title: Status
    description: Describe the current state of the API
    enum:
      - NotStarted
      - Running
      - Succeeded
      - Failed
    type: string
    readOnly: true
    x-ms-enum:
      name: Status
      modelAsString: false
      values:
        - value: NotStarted
          description: The long running operation has not yet started.
        - value: Running
          description: The long running operation is currently processing.
        - value: Succeeded
          description: The long running operation has successfully completed.
        - value: Failed
          description: The long running operation has failed.
  Test:
    title: Test
    required:
      - id
      - models
      - name
    type: object
    properties:
      resultsUrl:
        format: uri
        description: "The URL that can be used to download the test results.\r\nEach line in the file represents a tab separated list of filename, reference transcription and decoder output.\r\n            \r\nThe URL will only be valid, if the test completed successfully."
        type: string
        readOnly: true
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
      wordErrorRate:
        format: double
        description: The word error rate of the tested model.
        type: number
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        format: date-time
        description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      models:
        description: Information about the models used for this accuracy test.
        type: array
        items:
          $ref: '#/definitions/Model'
      dataset:
        $ref: '#/definitions/Dataset'
      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\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
  TestDefinition:
    title: TestDefinition
    required:
      - models
      - name
    type: object
    properties:
      models:
        description: Information about the models used for this accuracy test.
        type: array
        items:
          $ref: '#/definitions/ModelIdentity'
      dataset:
        $ref: '#/definitions/DatasetIdentity'
      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\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
  TestUpdate:
    title: TestUpdate
    required:
      - name
    type: object
    properties:
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
  Transcription:
    title: Transcription
    required:
      - id
      - locale
      - name
      - recordingsUrl
    type: object
    properties:
      recordingsUrl:
        format: uri
        type: string
      reportFileUrl:
        format: uri
        type: string
        readOnly: true
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
      models:
        description: The models used in this transcription.
        type: array
        items:
          $ref: '#/definitions/Model'
      locale:
        description: The locale of the contained data.
        type: string
      resultsUrls:
        description: The results Urls for the transcription.
        type: object
        additionalProperties:
          type: string
        readOnly: true
      statusMessage:
        description: The failure reason for the transcription.
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        format: date-time
        description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      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\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
  TranscriptionDefinition:
    title: TranscriptionDefinition
    required:
      - locale
      - name
      - recordingsUrl
    type: object
    properties:
      recordingsUrl:
        format: uri
        type: string
      models:
        description: The models used in this transcription.
        type: array
        items:
          $ref: '#/definitions/ModelIdentity'
      locale:
        description: The locale of the contained data.
        type: string
      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\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
  TranscriptionUpdate:
    title: TranscriptionUpdate
    required:
      - name
    type: object
    properties:
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
parameters:
  Endpoint:
    in: path
    name: Endpoint
    description: >-
      Supported Cognitive Services endpoints (protocol and hostname, for
      example: https://westus.api.cognitive.microsoft.com).
    required: true
    type: string
    x-ms-skip-url-encoding: true
    x-ms-parameter-location: client
  skipQueryParameter:
    in: query
    name: skip
    description: Number of transcriptions that will be skipped.
    type: integer
    format: int32
    x-ms-parameter-location: method
  takeQueryParameter:
    in: query
    name: take
    description: Number of transcriptions that will be included after skipping.
    type: integer
    format: int32
    x-ms-parameter-location: method
securityDefinitions:
  api_key:
    type: apiKey
    name: Ocp-Apim-Subscription-Key
    in: header
    description: Provide your cognitive services account key here.
  token:
    type: apiKey
    name: Authorization
    in: header
    description: >-
      Provide an access token from the JWT returned by the STS of this region.
      Make sure to add the management scope to the token by adding the following
      query string to the STS URL: ?scope=speechservicesmanagement
security:
  - api_key: []
  - token: []
schemes:
  - https
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}/speechtotext/v2.0'
  useSchemePrefix: false
  parameters:
    - $ref: '#/parameters/Endpoint'
tags:
  - name: 'Custom Speech Accuracy Tests:'
  - name: 'Custom Speech Datasets for Model Adaptation:'
  - name: 'Custom Speech Endpoints:'
  - name: 'Custom Speech Models:'
  - name: 'Custom Speech Transcriptions:'