swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Custom Speech Endpoints: API'
schemes:
- https
tags:
- name: 'Custom Speech Endpoints:'
paths:
  /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.
  /endpoints/{id}/files/logs:
    get:
      tags:
      - 'Custom Speech Endpoints:'
      summary: Microsoft Azure Gets The List Of Audio And Transcription Logs That Have Been Stored For A Given Endpoint
      operationId: microsoftAzureGetendpointlogs
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the endpoint.
        required: true
        type: string
        format: uuid
      - $ref: '#/parameters/sasValidityQueryParameter'
      - in: query
        name: skipToken
        description: Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.
        type: string
      - $ref: '#/parameters/topQueryParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PaginatedFiles'
          headers:
            Retry-After:
              description: The minimum number of seconds to wait for a non terminal operation to complete.
              type: integer
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-pageable:
        itemName: values
        nextLinkName: '@nextLink'
      x-ms-examples:
        Get all endpoint logs:
          $ref: ./examples/get_endpoint_logs.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Custom Speech Endpoints:'
      summary: Microsoft Azure Deletes The Specified Audio And Transcription Logs That Have Been Stored For A Given Endpoint It Deletes All Logs Before And Including A Specific Day
      description: The deletion process is done asynchronously and can take up to one day depending on the amount of log files.
      operationId: microsoftAzureDeleteendpointlogs
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the endpoint.
        required: true
        type: string
        format: uuid
      - in: query
        name: endDate
        description: "The end date of the audio logs deletion (specific day, UTC).\r\n            Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n            Deletes all existing logs when date is not specified."
        type: string
      responses:
        '202':
          description: The logs will be deleted.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Delete all endpoint logs:
          $ref: ./examples/delete_endpoint_logs.json
  /endpoints/{id}/files/logs/{logId}:
    get:
      tags:
      - 'Custom Speech Endpoints:'
      summary: Microsoft Azure Gets A Specific Audio Or Transcription Log For A Given Endpoint
      operationId: microsoftAzureGetendpointlog
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the endpoint.
        required: true
        type: string
        format: uuid
      - in: path
        name: logId
        description: The identifier of the log.
        required: true
        type: string
      - $ref: '#/parameters/sasValidityQueryParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/File'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Get an endpoint log:
          $ref: ./examples/get_endpoint_log.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Custom Speech Endpoints:'
      summary: Microsoft Azure Deletes One Audio Or Transcription Log That Have Been Stored For A Given Endpoint
      operationId: microsoftAzureDeleteendpointlog
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the endpoint.
        required: true
        type: string
        format: uuid
      - in: path
        name: logId
        description: The identifier of the log.
        required: true
        type: string
      responses:
        '204':
          description: The log was successfully deleted.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Delete an endpoint log:
          $ref: ./examples/delete_endpoint_log.json
      description: Needs a more full description created.
  /endpoints/base/{locale}/files/logs:
    get:
      tags:
      - 'Custom Speech Endpoints:'
      summary: Microsoft Azure Gets The List Of Audio And Transcription Logs That Have Been Stored When Using The Default Base Model Of A Given Language
      operationId: microsoftAzureGetbasemodellogs
      produces:
      - application/json
      parameters:
      - in: path
        name: locale
        description: The language used to select the default base model.
        required: true
        type: string
      - $ref: '#/parameters/sasValidityQueryParameter'
      - in: query
        name: skipToken
        description: Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.
        type: string
      - $ref: '#/parameters/topQueryParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PaginatedFiles'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-pageable:
        itemName: values
        nextLinkName: '@nextLink'
      x-ms-examples:
        Get all base model logs:
          $ref: ./examples/get_base_model_logs.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Custom Speech Endpoints:'
      summary: Microsoft Azure Deletes The Specified Audio And Transcription Logs That Have Been Stored When Using The Default Base Model Of A Given Language It Deletes All Logs Before And Including A Specific Day
      description: Deletion process is done asynchronously and can take up to one day depending on the amount of log files.
      operationId: microsoftAzureDeletebasemodellogs
      produces:
      - application/json
      parameters:
      - in: path
        name: locale
        description: The language used to select the default base model.
        required: true
        type: string
      - in: query
        name: endDate
        description: "The end date of the audio logs deletion (specific day, UTC).\r\n            Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.\r\n            Deletes all existing logs when date is not specified."
        type: string
      responses:
        '202':
          description: The logs will be deleted.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Delete all base model logs:
          $ref: ./examples/delete_base_model_logs.json
  /endpoints/base/{locale}/files/logs/{logId}:
    get:
      tags:
      - 'Custom Speech Endpoints:'
      summary: Microsoft Azure Gets A Specific Audio Or Transcription Log For The Default Base Model In A Given Language
      operationId: microsoftAzureGetbasemodellog
      produces:
      - application/json
      parameters:
      - in: path
        name: locale
        description: The language used to select the default base model.
        required: true
        type: string
      - in: path
        name: logId
        description: The identifier of the log.
        required: true
        type: string
      - $ref: '#/parameters/sasValidityQueryParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/File'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Get a base model log:
          $ref: ./examples/get_base_model_log.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Custom Speech Endpoints:'
      summary: Microsoft Azure Deletes One Audio Or Transcription Log That Have Been Stored When Using The Default Base Model Of A Given Language
      operationId: microsoftAzureDeletebasemodellog
      produces:
      - application/json
      parameters:
      - in: path
        name: locale
        description: The language used to select the default base model.
        required: true
        type: string
      - in: path
        name: logId
        description: The identifier of the log.
        required: true
        type: string
      responses:
        '204':
          description: The log was successfully deleted.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Delete a base model log:
          $ref: ./examples/delete_base_model_log.json
      description: Needs a more full description created.
definitions:
  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
  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.
  Error_2:
    title: Error
    description: "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details."
    type: object
    properties:
      code:
        $ref: '#/definitions/ErrorCode'
      details:
        description: Additional supportive details regarding the error and/or expected policies.
        type: array
        items:
          $ref: '#/definitions/Error_2'
      message:
        description: High level error message.
        type: string
      target:
        description: "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document."
        type: string
      innerError:
        $ref: '#/definitions/InnerError'
  File:
    title: File
    type: object
    properties:
      kind:
        $ref: '#/definitions/FileKind'
      links:
        $ref: '#/definitions/FileLinks'
      createdDateTime:
        format: date-time
        description: "The creation time of this file.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/FileProperties'
      name:
        description: The name of this file.
        type: string
        readOnly: true
      self:
        format: uri
        description: The location of this entity.
        type: string
        readOnly: true
  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.\r\n            \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list."
        type: array
        items:
          $ref: '#/definitions/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
  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
  FileKind:
    title: FileKind
    description: Type of data.
    enum:
    - DatasetReport
    - Audio
    - LanguageData
    - PronunciationData
    - AcousticDataArchive
    - AcousticDataTranscriptionV2
    - Transcription
    - TranscriptionReport
    - EvaluationDetails
    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.
  FileLinks:
    title: FileLinks
    type: object
    properties:
      contentUrl:
        format: uri
        description: The url to retrieve the content of this file.
        type: string
        readOnly: true
  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
  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.
  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.
  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
  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\r\nduration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)."
        type: string
        readOnly: true
  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
  ErrorCode:
    title: ErrorCode
    description: High level error codes.
    enum:
    - InvalidRequest
    - InvalidArgument
    - InternalServerError
    - ServiceUnavailable
    - NotFound
    - PipelineError
    - Conflict
    - InternalCommunicationFailed
    - Forbidden
    - NotAllowed
    - Unauthorized
    - UnsupportedMediaType
    - TooManyRequests
    - UnprocessableEntity
    type: string
    x-ms-enum:
      name: ErrorCode
      modelAsString: true
      values:
      - value: InvalidRequest
        description: Representing the invalid request error code.
      - value: InvalidArgument
        description: Representing the invalid argument error code.
      - value: InternalServerError
        description: Representing the internal server error error code.
      - value: ServiceUnavailable
        description: Representing the service unavailable error code.
      - value: NotFound
        description: Representing the not found error code.
      - value: PipelineError
        description: Representing the pipeline error error code.
      - value: Conflict
        description: Representing the conflict error code.
      - value: InternalCommunicationFailed
        description: Representing the internal communication failed error code.
      - value: Forbidden
        description: Representing the forbidden error code.
      - value: NotAllowed
        description: Representing the not allowed error code.
      - value: Unauthorized
        description: Representing the unauthorized error code.
      - value: UnsupportedMediaType
        description: Representing the unsupported media type error code.
      - value: TooManyRequests
        description: Representing the too many requests error code.
      - value: UnprocessableEntity
        description: Representing the unprocessable entity error code.
  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'
  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.
  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
  DetailedErrorCode:
    title: DetailedErrorCode
    description: Detailed error code enum.
    enum:
    - InvalidParameterValue
    - InvalidRequestBodyFormat
    - EmptyRequest
    - MissingInputRecords
    - InvalidDocument
    - ModelVersionIncorrect
    - InvalidDocumentBatch
    - UnsupportedLanguageCode
    - DataImportFailed
    - InUseViolation
    - InvalidLocale
    - InvalidBaseModel
    - InvalidAdaptationMapping
    - InvalidDataset
    - InvalidTest
    - FailedDataset
    - InvalidModel
    - InvalidTranscription
    - InvalidPayload
    - InvalidParameter
    - EndpointWithoutLogging
    - InvalidPermissions
    - InvalidPrerequisite
    - InvalidProductId
    - InvalidSubscription
    - InvalidProject
    - InvalidProjectKind
    - InvalidRecordingsUri
    - OnlyOneOfUrlsOrContainerOrDataset
    - ExceededNumberOfRecordingsUris
    - ModelMismatch
    - ProjectGenderMismatch
    - ModelDeprecated
    - ModelExists
    - ModelNotDeployable
    - EndpointNotUpdatable
    - SingleDefaultEndpoint
    - EndpointCannotBeDefault
    - InvalidModelUri
    - SubscriptionNotFound
    - QuotaViolation
    - UnsupportedDelta
    - UnsupportedFilter
    - UnsupportedPagination
    - UnsupportedDynamicConfiguration
    - UnsupportedOrderBy
    - NoUtf8WithBom
    - ModelDeploymentNotCompleteState
    - SkuLimitsExist
    - DeployingFailedModel
    - UnsupportedTimeRange
    - InvalidLogDate
    - InvalidLogId
    - InvalidLogStartTime
    - InvalidLogEndTime
    - InvalidTopForLogs
    - InvalidSkipTokenForLogs
    - DeleteNotAllowed
    - Forbidden
    - DeployNotAllowed
    - UnexpectedError
    - InvalidCollection
    - InvalidCallbackUri
    - InvalidSasValidityDuration
    - InaccessibleCustomerStorage
    - UnsupportedClassBasedAdaptation
    - InvalidWebHookEventKind
    - InvalidTimeToLive
    type: string
    x-ms-enum:
      name: DetailedErrorCode
      modelAsString: true
      values:
      - value: InvalidParameterValue
        description: Invalid parameter value.
      - value: InvalidRequestBodyFormat
        description: Invalid request body format.
      - value: EmptyRequest
        description: Empty Request.
      - value: MissingInputRecords
        description: Missing Input Records.
      - value: InvalidDocument
        description: Invalid Document.
      - value: ModelVersionIncorrect
        description: Model Version Incorrect.
      - value: InvalidDocumentBatch
        description: Invalid Document Batch.
      - value: UnsupportedLanguageCode
        description: Unsupported language code.
      - value: DataImportFailed
        description: Data import failed.
      - value: InUseViolation
        description: In use violation.
      - value: InvalidLocale
        description: Invalid locale.
      - value: InvalidBaseModel
        description: Invalid base model.
      - value: InvalidAdaptationMapping
        description: Invalid adaptation mapping.
      - value: InvalidDataset
        description: Invalid dataset.
      - value: InvalidTest
        description: Invalid test.
      - value: FailedDataset
        description: Failed dataset.
      - value: InvalidModel
        description: Invalid model.
      - value: InvalidTranscription
        description: Invalid transcription.
      - value: InvalidPayload
        description: Invalid payload.
      - value: InvalidParameter
        description: Invalid parameter.
      - value: EndpointWithoutLogging
        description: Endpoint without logging.
      - value: InvalidPermissions
        description: Invalid permissions.
      - value: InvalidPrerequisite
        description: Invalid prerequisite.
      - value: InvalidProductId
        description: Invalid product id.
      - value: InvalidSubscription
        description: Invalid subscription.
      - value: InvalidProject
        description: Invalid project.
      - value: InvalidProjectKind
        description: Invalid project kind.
      - value: InvalidRecordingsUri
        description: Invalid recordings uri.
      - value: OnlyOneOfUrlsOrContainerOrDataset
        description: Only one of urls or container or dataset.
      - value: ExceededNumberOfRecordingsUris
        description: Exceeded number of recordings uris.
      - value: ModelMismatch
        description: Model mismatch.
      - value: ProjectGenderMismatch
        description: Project gender mismatch.
      - value: ModelDeprecated
        description: Model deprecated.
      - value: ModelExists
        description: Model exists.
      - value: ModelNotDeployable
        description: Model not deployable.
      - value: EndpointNotUpdatable
        description: Endpoint not updatable.
      - value: SingleDefaultEndpoint
        description: Single default endpoint.
      - value: EndpointCannotBeDefault
        description: Endpoint cannot be default.
      - value: InvalidModelUri
        description: Invalid model uri.
      - value: SubscriptionNotFound
        description: Subscription not found.
      - value: QuotaViolation
        description: Quota violation.
      - value: UnsupportedDelta
        description: Unsupported delta.
      - value: UnsupportedFilter
        description: Unsupported filter.
      - value: UnsupportedPagination
        description: Unsupported pagination.
      - value: UnsupportedDynamicConfiguration
        description: Unsupported dynamic configuration.
      - value: UnsupportedOrderBy
        description: Unsupported order by.
      - value: NoUtf8WithBom
        description: No utf8 with bom.
      - value: ModelDeploymentNotCompleteState
        description: Model deployment not complete state.
      - value: SkuLimitsExist
        description: Sku limits exist.
      - value: DeployingFailedModel
        description: Deploying failed model.
      - value: UnsupportedTimeRange
        description: Unsupported time range.
      - value: InvalidLogDate
        description: Invalid log date.
      - value: InvalidLogId
        description: Invalid log id.
      - value: InvalidLogStartTime
        description: Invalid log start time.
      - value: InvalidLogEndTime
        description: Invalid log end time.
      - value: InvalidTopForLogs
        description: Invalid top for logs.
      - value: InvalidSkipTokenForLogs
        description: Invalid skip token for logs.
      - value: DeleteNotAllowed
        description: Delete not allowed.
      - value: Forbidden
        description: Forbidden.
      - value: DeployNotAllowed
        description: Deploy not allowed.
      - value: UnexpectedError
        description: Unexpected error.
      - value: InvalidCollection
        description: Invalid collection.
      - value: InvalidCallbackUri
        description: Invalid callback uri.
      - value: InvalidSasValidityDuration
        description: Invalid sas validity duration.
      - value: InaccessibleCustomerStorage
        description: Inaccessible customer storage.
      - value: UnsupportedClassBasedAdaptation
        description: Unsupported class based adaptation.
      - value: InvalidWebHookEventKind
        description: Invalid web hook event kind.
      - value: InvalidTimeToLive
        description: Invalid time to live.
  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
  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
  InnerError:
    title: InnerError
    description: "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested)."
    type: object
    properties:
      code:
        $ref: '#/definitions/DetailedErrorCode'
      details:
        description: Additional supportive details regarding the error and/or expected policies.
        type: object
        additionalProperties:
          type: string
      message:
        description: High level error message.
        type: string
      target:
        description: "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document."
        type: string
      innerError:
        $ref: '#/definitions/InnerError'
  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
  ModelIdentity:
    title: ModelIdentity
    required:
    - id
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
parameters:
  topQueryParameter:
    in: query
    name: top
    description: Number of datasets that will be included after skipping.
    type: integer
    format: int32
    x-ms-parameter-location: method
  sasValidityQueryParameter:
    in: query
    name: sasValidityInSeconds
    description: "The duration in seconds that an SAS url should be valid. The default duration is 12 hours.\r\n            When using BYOS (https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): A value of 0 means that a plain blob URI without SAS token will be generated."
    type: integer
    format: int32
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'