swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Custom Speech Datasets for Model Adaptation: API'
schemes:
- https
tags:
- name: 'Custom Speech Datasets for Model Adaptation:'
paths:
  /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.
    post:
      tags:
      - 'Custom Speech Datasets for Model Adaptation:'
      summary: Microsoft Azure Uploads And Creates A New Dataset By Getting The Data From A Specified Url
      operationId: microsoftAzureCreatedataset
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: dataset
        description: Definition for the new dataset.
        required: true
        schema:
          $ref: '#/definitions/Dataset_2'
      responses:
        '201':
          description: The response contains information about the entity as payload and its location as header.
          schema:
            $ref: '#/definitions/Dataset_2'
          headers:
            Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Create a dataset:
          $ref: ./examples/create_dataset.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.
  /datasets/{id}/files:
    get:
      tags:
      - 'Custom Speech Datasets for Model Adaptation:'
      summary: Microsoft Azure Gets The Files Of The Dataset Identified By The Given Id
      operationId: microsoftAzureGetdatasetfiles
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the dataset.
        required: true
        type: string
        format: uuid
      - $ref: '#/parameters/sasValidityQueryParameter'
      - $ref: '#/parameters/skipQueryParameter'
      - $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 files:
          $ref: ./examples/get_dataset_files.json
      description: Needs a more full description created.
  /datasets/{id}/files/{fileId}:
    get:
      tags:
      - 'Custom Speech Datasets for Model Adaptation:'
      summary: Microsoft Azure Gets One Specific File Identified With Fileid From A Dataset Identified With Id
      operationId: microsoftAzureGetdatasetfile
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the dataset.
        required: true
        type: string
        format: uuid
      - in: path
        name: fileId
        description: The identifier of the file.
        required: true
        type: string
        format: uuid
      - $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 file:
          $ref: ./examples/get_dataset_file.json
      description: Needs a more full description created.
  /datasets/{id}/blocks:
    get:
      tags:
      - 'Custom Speech Datasets for Model Adaptation:'
      summary: Microsoft Azure Gets The List Of Uploaded Blocks For This Dataset
      operationId: microsoftAzureDatasetsGetblocks
      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/UploadedBlocks'
          headers:
            Retry-After:
              description: The minimum number of seconds to wait for a non terminal operation to complete.
              type: integer
              format: int32
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_3'
      x-ms-examples:
        Get uploaded blocks for dataset:
          $ref: ./examples/get_dataset_blocks.json
      description: Needs a more full description created.
    put:
      tags:
      - 'Custom Speech Datasets for Model Adaptation:'
      summary: Microsoft Azure Upload A Block Of Data For The Dataset The Maximum Size Of The Block Is 8mib
      operationId: microsoftAzureDatasetsUploadblock
      consumes:
      - application/octet-stream
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the dataset.
        required: true
        type: string
        format: uuid
      - in: query
        name: blockid
        description: A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. Note that the Base64 string must be URL-encoded.
        required: true
        type: string
      - in: body
        name: body
        required: true
        schema:
          format: binary
          type: string
      responses:
        '201':
          description: The data block was uploaded successfully.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_3'
      x-ms-examples:
        Upload a block for a dataset:
          $ref: ./examples/upload_block.json
      description: Needs a more full description created.
  /datasets/{id}/blocks:commit:
    post:
      tags:
      - 'Custom Speech Datasets for Model Adaptation:'
      summary: Microsoft Azure Commit Block List To Complete The Upload Of The Dataset
      operationId: microsoftAzureDatasetsCommitblocks
      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: blockList
        description: The list of blocks that compile the dataset.
        required: true
        schema:
          type: array
          items:
            $ref: '#/definitions/CommitBlocksEntry'
      responses:
        '200':
          description: The block list is accepted and the data import process can continue.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_3'
      x-ms-examples:
        Commit uploaded blocks to dataset:
          $ref: ./examples/commit_block_list.json
      description: Needs a more full description created.
definitions:
  BlockKind:
    title: BlockKind
    description: Type of data block.
    enum:
    - Committed
    - Uncommitted
    - Latest
    type: string
    x-ms-enum:
      name: BlockKind
      modelAsString: true
      values:
      - value: Committed
        description: A data block from the committed block list.
      - value: Uncommitted
        description: A data block from the uncommitted block list.
      - value: Latest
        description: A data block from the uncommitted block list, if present, otherwise from the committed block list.
  CommitBlocksEntry:
    title: CommitBlocksEntry
    description: Entry of the commit block list.
    type: object
    properties:
      kind:
        $ref: '#/definitions/BlockKind'
      id:
        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
  DatasetKind_2:
    title: DatasetKind
    description: Type of data import.
    enum:
    - Language
    - Acoustic
    - Pronunciation
    - AudioFiles
    type: string
    x-ms-enum:
      name: DatasetKind
      modelAsString: false
      values:
      - value: Language
        description: A language data import.
      - value: Acoustic
        description: An acoustic data import.
      - value: Pronunciation
        description: A pronunciation data import.
      - value: AudioFiles
        description: An audio files data import.
  EntityError:
    title: EntityError
    type: object
    properties:
      code:
        description: The code of this error.
        type: string
        readOnly: true
      message:
        description: The message for this error.
        type: string
        readOnly: true
  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
  DatasetProperties:
    title: DatasetProperties
    type: object
    properties:
      acceptedLineCount:
        format: int32
        description: The number of lines accepted for this data set.
        type: integer
        readOnly: true
      rejectedLineCount:
        format: int32
        description: The number of lines rejected for this data set.
        type: integer
        readOnly: true
      duration:
        description: "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)."
        type: string
        readOnly: true
      email:
        description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email."
        type: string
      error:
        $ref: '#/definitions/EntityError'
  Links:
    title: Links
    type: object
    properties:
      files:
        format: uri
        description: The location to get all files of this entity.
        type: string
        readOnly: true
  Dataset_2:
    title: Dataset
    required:
    - displayName
    - kind
    - locale
    type: object
    properties:
      links:
        $ref: '#/definitions/Links'
      properties:
        $ref: '#/definitions/DatasetProperties'
      kind:
        $ref: '#/definitions/DatasetKind_2'
      self:
        format: uri
        description: The location of this entity.
        type: string
        readOnly: true
      displayName:
        description: The display name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
      project:
        $ref: '#/definitions/EntityReference'
      contentUrl:
        format: uri
        description: The URL of the data for the dataset.
        type: string
      customProperties:
        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
  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.
  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
  EntityReference:
    title: EntityReference
    required:
    - self
    type: object
    properties:
      self:
        format: uri
        description: The location of the referenced entity.
        type: string
  FileLinks:
    title: FileLinks
    type: object
    properties:
      contentUrl:
        format: uri
        description: The url to retrieve the content of this file.
        type: string
        readOnly: true
  UploadedBlocks:
    title: UploadedBlocks
    description: List of uploaded blocks.
    type: object
    properties:
      committedBlocks:
        description: The block description of blocks already committed.
        type: array
        items:
          $ref: '#/definitions/ResponseBlock'
      uncommittedBlocks:
        description: The block description of blocks not committed to the blob.
        type: array
        items:
          $ref: '#/definitions/ResponseBlock'
  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.
  Error_3:
    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_3'
      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'
  ResponseBlock:
    title: ResponseBlock
    description: ResponseBlock.
    type: object
    properties:
      name:
        description: The name of the block.
        type: string
      size:
        format: int32
        description: The size of the block.
        type: integer
  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
  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'
  DatasetLocales:
    title: DatasetLocales
    type: object
    properties:
      Language:
        type: array
        items:
          type: string
      Acoustic:
        type: array
        items:
          type: string
      Pronunciation:
        type: array
        items:
          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
  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'
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
  skipQueryParameter:
    in: query
    name: skip
    description: Number of datasets that will be skipped.
    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'