swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Custom Speech Models: API'
schemes:
- https
tags:
- name: 'Custom Speech Models:'
paths:
  /models/locales:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets A List Of Supported Locales For Model Adaptation
      operationId: microsoftAzureGetsupportedlocalesformodels
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ModelLocales'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get the supported locales:
          $ref: ./examples/get_supported_model_locales.json
      description: Needs a more full description created.
  /models:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The List Of Models For The Authenticated Subscription
      operationId: microsoftAzureGetmodels
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Model'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all models:
          $ref: ./examples/get_models.json
      description: Needs a more full description created.
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Creates A New Model
      operationId: microsoftAzureCreatemodel
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: modelDefinition
        description: The details of the new model.
        required: true
        schema:
          $ref: '#/definitions/SpeechModelDefinition'
      responses:
        '202':
          description: The request was accepted and the response contains the location of the entity.
          headers:
            Retry-After:
              description: The minimum number of seconds to wait before accessing the resource created in this operation.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create a model:
          $ref: ./examples/create_model.json
      description: Needs a more full description created.
  /models/{id}:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The Model Identified By The Given Id
      operationId: microsoftAzureGetmodel
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Model'
          headers:
            Retry-After:
              description: The minimum number of seconds to wait for a non terminal operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get a model:
          $ref: ./examples/get_model.json
      description: Needs a more full description created.
    patch:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Updates The Metadata Of The Model Identified By The Given Id
      operationId: microsoftAzureUpdatemodel
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        type: string
        format: uuid
      - in: body
        name: modelUpdate
        description: The updated values for the model.
        required: true
        schema:
          $ref: '#/definitions/ModelUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Model'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update a model:
          $ref: ./examples/update_model.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Deletes The Model Identified By The Given Id
      operationId: microsoftAzureDeletemodel
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        type: string
        format: uuid
      responses:
        '204':
          description: The model was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete a model:
          $ref: ./examples/delete_model.json
      description: Needs a more full description created.
  /models/base:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The List Of Base Models For The Authenticated Subscription
      operationId: microsoftAzureGetbasemodels
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/skipQueryParameter'
      - $ref: '#/parameters/topQueryParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PaginatedModels'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-pageable:
        itemName: values
        nextLinkName: '@nextLink'
      x-ms-examples:
        Get all base models:
          $ref: ./examples/get_base_models.json
      description: Needs a more full description created.
  /models/base/{id}:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The Base Model Identified By The Given Id
      operationId: microsoftAzureGetbasemodel
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the base model.
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Model_2'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Get a base model:
          $ref: ./examples/get_base_model.json
      description: Needs a more full description created.
  /models/{id}/copyto:
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Copies A Model From One Subscription To Another
      description: This method can be used to copy a model from one location to another. If the target subscription<br>key belongs to a subscription created for another location, the model will be copied to that location.<br>Only adapted models are allowed to copy to another subscription.
      operationId: microsoftAzureCopymodeltosubscription
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the model that will be copied.
        required: true
        type: string
        format: uuid
      - in: body
        name: modelCopy
        description: The body contains the subscription key of the target subscription.
        required: true
        schema:
          $ref: '#/definitions/ModelCopy'
      responses:
        '201':
          description: The response contains information about the entity as payload and its location as header.
          schema:
            $ref: '#/definitions/Model_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:
        Copy a model:
          $ref: ./examples/copy_model.json
  /models/{id}/manifest:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Returns An Manifest For This Model Which Can Be Used In An On Premise Container
      operationId: microsoftAzureGetmodelmanifest
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The ID of the model to generate a manifest for.
        required: true
        type: string
        format: uuid
      - $ref: '#/parameters/sasValidityQueryParameter'
      responses:
        '200':
          description: Successfully generated a model manifest.
          schema:
            $ref: '#/definitions/ModelManifest'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Get a model manifest:
          $ref: ./examples/get_model_manifest.json
      description: Needs a more full description created.
  /models/base/{id}/manifest:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Returns An Manifest For This Base Model Which Can Be Used In An On Premise Container
      operationId: microsoftAzureGetbasemodelmanifest
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The ID of the model to generate a manifest for.
        required: true
        type: string
        format: uuid
      - $ref: '#/parameters/sasValidityQueryParameter'
      responses:
        '200':
          description: Successfully generated a model manifest.
          schema:
            $ref: '#/definitions/ModelManifest'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_2'
      x-ms-examples:
        Get a base model manifest:
          $ref: ./examples/get_base_model_manifest.json
      description: Needs a more full description created.
  /models/{id}:copyto:
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Copies A Model From One Subscription To Another
      description: This method can be used to copy a model from one location to another. If the target subscription<br>key belongs to a subscription created for another location, the model will be copied to that location.<br>Only adapted models are allowed to copy to another subscription.
      operationId: microsoftAzureModelsCopyto
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the model that will be copied.
        required: true
        type: string
        format: uuid
      - in: body
        name: modelCopy
        description: The body contains the subscription key of the target subscription.
        required: true
        schema:
          $ref: '#/definitions/ModelCopy_2'
      responses:
        '201':
          description: The response contains information about the entity as payload and its location as header.
          schema:
            $ref: '#/definitions/CustomModel'
          headers:
            Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_3'
      x-ms-examples:
        Copy a model:
          $ref: ./examples/copy_model.json
  /models/{id}/files:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets The Files Of The Model Identified By The Given Id
      operationId: microsoftAzureModelsListfiles
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        required: true
        type: string
        format: uuid
      - $ref: '#/parameters/sasValidityQueryParameter_2'
      - $ref: '#/parameters/skipQueryParameter'
      - $ref: '#/parameters/topQueryParameter'
      - in: query
        name: filter
        description: "A filtering expression for selecting a subset of the available files.\r\n            - Supported properties: name, createdDateTime, kind.\r\n            - Operators:\r\n              - eq, ne are supported for all properties.\r\n              - gt, ge, lt, le are supported for createdDateTime.\r\n              - and, or, not are supported.\r\n            - Example:\r\n              filter=name eq 'myaudio.wav' and kind eq 'Audio'"
        type: string
      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
              format: int32
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_3'
      x-ms-pageable:
        itemName: values
        nextLinkName: '@nextLink'
      x-ms-examples:
        Get all files:
          $ref: ./examples/get_model_files.json
      description: Needs a more full description created.
  /models/{id}/files/{fileId}:
    get:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Gets One Specific File Identified With Fileid From A Model Identified With Id
      operationId: microsoftAzureModelsGetfile
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the model.
        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_2'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/File'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_3'
      x-ms-examples:
        Get a file:
          $ref: ./examples/get_model_file.json
      description: Needs a more full description created.
  /models/{id}:copy:
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Copies A Model From One Subscription To Another
      description: This method can be used to copy a model from this speech resource to a target one.<br>The authorization is obtained on the target speech resource.<br>Only custom models can be copied to another speech resource.
      operationId: microsoftAzureModelsCopy
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the model that will be copied.
        required: true
        type: string
        format: uuid
      - in: body
        name: modelCopyAuthorization
        description: The body contains the authorization to copy to the target speech resource.
        required: true
        schema:
          $ref: '#/definitions/ModelCopyAuthorization'
      responses:
        '202':
          description: The response contains information about the entity as payload and its location as header.
          schema:
            $ref: '#/definitions/Operation'
          headers:
            Retry-After:
              description: The minimum number of seconds to wait before accessing the resource created in this operation.
              type: integer
              format: int32
            Operation-Location:
              description: The location of the operation to track progress.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_6'
      x-ms-long-running-operation: true
      x-ms-examples:
        Copy a model from source resource to target resource:
          $ref: ./examples/copy_model_with_authorization.json
  /models:authorizecopy:
    post:
      tags:
      - 'Custom Speech Models:'
      summary: Microsoft Azure Allows Another Speech Resource Source To Copy A Model To This Speech Resource Target
      description: This method can be used to allow copying a model from another speech resource.<br>Only custom models can be copied from another speech resource.
      operationId: microsoftAzureModelsAuthorizecopy
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: modelCopyAuthorizationDefinition
        description: The body contains the Azure Resource ID of the source speech resource.
        required: true
        schema:
          $ref: '#/definitions/ModelCopyAuthorizationDefinition'
      responses:
        '200':
          description: The response contains information about the entity as payload and its location as header.
          schema:
            $ref: '#/definitions/ModelCopyAuthorization'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error_6'
      x-ms-examples:
        Create a copy model authorization on target resource:
          $ref: ./examples/create_copy_model_authorization.json
definitions:
  ModelFile:
    title: ModelFile
    type: object
    properties:
      name:
        description: The name of this file.
        type: string
        readOnly: true
      contentUrl:
        format: uri
        description: The url to retrieve the content of this file.
        type: string
        readOnly: true
  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
  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
  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.
  ModelUpdate:
    title: ModelUpdate
    required:
    - name
    type: object
    properties:
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
  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'
  SpeechModelDefinition:
    title: SpeechModelDefinition
    required:
    - locale
    - modelKind
    - name
    type: object
    properties:
      modelKind:
        $ref: '#/definitions/ModelKind'
      text:
        description: The text used to adapt this language model.
        type: string
      baseModel:
        $ref: '#/definitions/ModelIdentity'
      datasets:
        description: Datasets used for adaptation.
        type: array
        items:
          $ref: '#/definitions/DatasetIdentity'
      description:
        description: The description of the object.
        type: string
      locale:
        description: The locale of the contained data.
        type: string
      properties:
        description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
      name:
        description: The name of the object.
        type: string
  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
  SharedModelFeatures:
    title: SharedModelFeatures
    description: Features supported by the model.
    type: object
    properties:
      supportsTranscriptions:
        description: A value indicating whether batch transcription is supported.
        type: boolean
        readOnly: true
      supportsEndpoints:
        description: A value indicating whether creation of endpoints for live transcription is supported.
        type: boolean
        readOnly: true
      supportsTranscriptionsOnSpeechContainers:
        description: A value indicating whether this model can be used for transcription on speech container. This feature can be added on existing models when it becomes usable on speech container.
        type: boolean
        readOnly: true
  Operation:
    title: Operation
    required:
    - id
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this Operation.
        type: string
      result:
        $ref: '#/definitions/OperationResult'
      error:
        $ref: '#/definitions/EntityError_3'
      self:
        format: uri
        description: The location of this entity.
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: "The time-stamp when the current status was entered.\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
  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
  EntityError_3:
    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
    readOnly: true
  ModelCopy_2:
    title: ModelCopy
    required:
    - targetSubscriptionKey
    type: object
    properties:
      targetSubscriptionKey:
        description: The subscription key of the subscription that is the target of the copy operation.
        minLength: 1
        type: string
  Model_2:
    title: Model
    required:
    - displayName
    - locale
    type: object
    properties:
      project:
        $ref: '#/definitions/EntityReference'
      links:
        $ref: '#/definitions/ModelLinks'
      properties:
        $ref: '#/definitions/ModelProperties'
      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
      text:
        description: The text used to adapt this language model.
        type: string
      baseModel:
        $ref: '#/definitions/EntityReference'
      datasets:
        description: Datasets used for adaptation.
        type: array
        items:
          $ref: '#/definitions/EntityReference'
      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
      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
  CustomModelProperties:
    title: CustomModelProperties
    type: object
    properties:
      customModelWeightPercent:
        format: int32
        description: "The weight of custom model between 1 (1% custom model and 99% base model) and 100 (100% custom model and 0% base model).\r\nWhen this property is not set, the service chooses a suitable value (get the model to retrieve the selected weight).\r\nStart without using this property. If needed, choose a larger (or smaller) weight to increase (or decrease) the impact of the custom model."
        maximum: 100
        minimum: 1
        type: integer
      deprecationDates:
        $ref: '#/definitions/CustomModelDeprecationDates'
      features:
        $ref: '#/definitions/CustomModelFeatures'
      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'
  Error_6:
    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_6'
      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'
  ModelCopyAuthorization:
    title: ModelCopyAuthorization
    required:
    - expirationDateTime
    - id
    - sourceResourceId
    - targetResourceEndpoint
    - targetResourceId
    - targetResourceRegion
    type: object
    properties:
      targetResourceRegion:
        description: The region (aka location) of the target speech resource (e.g., westus2).
        minLength: 1
        type: string
      targetResourceId:
        description: The Azure Resource ID of the target speech resource.
        minLength: 1
        type: string
      targetResourceEndpoint:
        description: The endpoint (base url) of the target resource (with custom domain name when it is used).
        minLength: 1
        type: string
      sourceResourceId:
        description: The Azure Resource ID of the source speech resource.
        minLength: 1
        type: string
      expirationDateTime:
        format: date-time
        description: The expiration date of this copy authorization.
        type: string
      id:
        description: The ID of this copy authorization.
        minLength: 1
        type: string
  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
    - ModelReport
    type: string
    readOnly: true
    x-ms-enum:
      name: FileKind
      modelAsString: true
      values:
      - value: DatasetReport
        description: Type of data is dataset report.
      - value: Audio
        description: Type of data is audio.
      - value: LanguageData
        description: Type of data is language data.
      - value: PronunciationData
        description: Type of data is pronunciation data.
      - value: AcousticDataArchive
        description: Type of data is acoustic data archive.
      - value: AcousticDataTranscriptionV2
        description: Type of data is acoustic data transcription v2.
      - value: Transcription
        description: Type of data is transcription.
      - value: TranscriptionReport
        description: Type of data is transcription report.
      - value: EvaluationDetails
        description: Type of data is evaluation details.
      - value: ModelReport
        description: Type of data is model report.
  EntityReference:
    title: EntityReference
    required:
    - self
    type: object
    properties:
      self:
        format: uri
        description: The location of the referenced entity.
        type: string
  ModelProperties:
    title: ModelProperties
    type: object
    properties:
      deprecationDates:
        $ref: '#/definitions/ModelDeprecationDates'
      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'
  ModelManifest:
    title: ModelManifest
    required:
    - model
    - modelFiles
    - properties
    type: object
    properties:
      model:
        $ref: '#/definitions/EntityReference'
      modelFiles:
        description: The model files of this model.
        type: array
        items:
          $ref: '#/definitions/ModelFile'
      properties:
        description: The configuration for running this model in a container.
        type: object
        additionalProperties:
          type: object
  ModelCopy:
    title: ModelCopy
    required:
    - targetSubscriptionKey
    type: object
    properties:
      targetSubscriptionKey:
        description: The subscription key of the subscription that is the target of the copy operation.
        type: string
  ModelLocales:
    title: ModelLocales
    type: object
    properties:
      Acoustic:
        type: array
        items:
          type: string
      Language:
        type: array
        items:
          type: string
      AcousticAndLanguage:
        type: array
        items:
          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
  SharedModel:
    title: SharedModel
    required:
    - displayName
    - locale
    type: object
    properties:
      self:
        format: uri
        description: The location of this entity.
        type: string
        readOnly: true
      locale:
        description: The locale of the contained data.
        minLength: 1
        type: string
      displayName:
        description: The display name of the object.
        minLength: 1
        type: string
      description:
        description: The description of the object.
        type: string
      lastActionDateTime:
        format: date-time
        description: "The time-stamp when the current status was entered.\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
  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'
  CustomModel:
    title: CustomModel
    required:
    - displayName
    - locale
    type: object
    allOf:
    - $ref: '#/definitions/SharedModel'
    properties:
      project:
        $ref: '#/definitions/EntityReference'
      links:
        $ref: '#/definitions/CustomModelLinks'
      properties:
        $ref: '#/definitions/CustomModelProperties'
      text:
        description: The text used to adapt this language model.
        type: string
      baseModel:
        $ref: '#/definitions/EntityReference'
      datasets:
        description: Datasets used for adaptation.
        type: array
        items:
          $ref: '#/definitions/EntityReference'
      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
  CustomModelFeatures:
    title: CustomModelFeatures
    description: Features supported by the model.
    type: object
    allOf:
    - $ref: '#/definitions/SharedModelFeatures'
  CustomModelDeprecationDates:
    title: CustomModelDeprecationDates
    type: object
    properties:
      transcriptionDateTime:
        format: date-time
        description: The date when transcription becomes deprecated.
        type: string
        readOnly: true
  Error:
    title: Error
    description: The interface represents the content of an error response defined in the OneAPI v2.1 documentation.
    required:
    - code
    - message
    type: object
    properties:
      details:
        description: An array of details representing distinct related errors that occurred during the request.
        type: array
        items:
          $ref: '#/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
  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.
  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
  ModelLinks:
    title: ModelLinks
    type: object
    properties:
      manifest:
        format: uri
        description: The location to get a manifest for this model to be used in the on-prem container.
        type: string
        readOnly: true
      copyTo:
        format: uri
        description: The location to the model copy action.
        type: string
        readOnly: true
  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.
  OperationResult:
    title: OperationResult
    type: object
    properties:
      link:
        format: uri
        description: The link to the result of the operation.
        type: string
        readOnly: true
    readOnly: true
  PaginatedModels:
    title: PaginatedModels
    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/Model_2'
        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
  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'
  ModelDeprecationDates:
    title: ModelDeprecationDates
    type: object
    properties:
      adaptationDateTime:
        format: date-time
        type: string
        readOnly: true
      transcriptionDateTime:
        format: date-time
        type: string
        readOnly: true
  ModelCopyAuthorizationDefinition:
    title: ModelCopyAuthorizationDefinition
    required:
    - sourceResourceId
    type: object
    properties:
      sourceResourceId:
        description: The Azure Resource ID of the source speech resource.
        minLength: 1
        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'
  ModelIdentity:
    title: ModelIdentity
    required:
    - id
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
  CustomModelLinks:
    title: CustomModelLinks
    type: object
    properties:
      copyTo:
        format: uri
        description: The location to the model copy action. See operation "Models_CopyTo" for more details.
        type: string
        readOnly: true
      files:
        format: uri
        description: The location to get all files of this entity. See operation "Models_ListFiles" for more details.
        type: string
        readOnly: true
      manifest:
        format: uri
        description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details.
        type: string
        readOnly: true
  DatasetIdentity:
    title: DatasetIdentity
    required:
    - id
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
parameters:
  sasValidityQueryParameter_2:
    in: query
    name: sasValidityInSeconds
    description: 'The duration in seconds that an SAS url should be valid. The default duration is 12 hours. 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
  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'