swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Custom Speech Model Evaluations: API'
schemes:
- https
tags:
- name: 'Custom Speech Model Evaluations:'
paths:
  /evaluations/locales:
    get:
      tags:
      - 'Custom Speech Model Evaluations:'
      summary: Microsoft Azure Gets A List Of Supported Locales For Evaluations
      operationId: microsoftAzureGetsupportedlocalesforevaluations
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get the supported locales:
          $ref: ./examples/get_supported_evaluations_locales.json
      description: Needs a more full description created.
  /evaluations:
    get:
      tags:
      - 'Custom Speech Model Evaluations:'
      summary: Microsoft Azure Gets The List Of Evaluations For The Authenticated Subscription
      operationId: microsoftAzureGetevaluations
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/skipQueryParameter'
      - $ref: '#/parameters/topQueryParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PaginatedEvaluations'
          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'
      x-ms-pageable:
        itemName: values
        nextLinkName: '@nextLink'
      x-ms-examples:
        Get all evaluations:
          $ref: ./examples/get_evaluations.json
      description: Needs a more full description created.
    post:
      tags:
      - 'Custom Speech Model Evaluations:'
      summary: Microsoft Azure Creates A New Evaluation
      operationId: microsoftAzureCreateevaluation
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: evaluation
        description: The details of the new evaluation.
        required: true
        schema:
          $ref: '#/definitions/Evaluation'
      responses:
        '201':
          description: The response contains information about the entity as payload and its location as header.
          schema:
            $ref: '#/definitions/Evaluation'
          headers:
            Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Create a evaluation:
          $ref: ./examples/create_evaluation.json
      description: Needs a more full description created.
  /evaluations/{id}/files:
    get:
      tags:
      - 'Custom Speech Model Evaluations:'
      summary: Microsoft Azure Gets The Files Of The Evaluation Identified By The Given Id
      operationId: microsoftAzureGetevaluationfiles
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the evaluation.
        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'
      x-ms-pageable:
        itemName: values
        nextLinkName: '@nextLink'
      x-ms-examples:
        Get all files:
          $ref: ./examples/get_evaluation_files.json
      description: Needs a more full description created.
  /evaluations/{id}/files/{fileId}:
    get:
      tags:
      - 'Custom Speech Model Evaluations:'
      summary: Microsoft Azure Gets One Specific File Identified With Fileid From An Evaluation Identified With Id
      operationId: microsoftAzureGetevaluationfile
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the evaluation.
        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'
      x-ms-examples:
        Get a file:
          $ref: ./examples/get_evaluation_file.json
      description: Needs a more full description created.
  /evaluations/{id}:
    get:
      tags:
      - 'Custom Speech Model Evaluations:'
      summary: Microsoft Azure Gets The Evaluation Identified By The Given Id
      operationId: microsoftAzureGetevaluation
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the evaluation.
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Evaluation'
          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'
      x-ms-examples:
        Get a evaluation:
          $ref: ./examples/get_evaluation.json
      description: Needs a more full description created.
    patch:
      tags:
      - 'Custom Speech Model Evaluations:'
      summary: Microsoft Azure Updates The Mutable Details Of The Evaluation Identified By Its Id
      operationId: microsoftAzureUpdateevaluation
      consumes:
      - application/json
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the evaluation.
        required: true
        type: string
        format: uuid
      - in: body
        name: evaluationUpdate
        description: The object containing the updated fields of the evaluation.
        required: true
        schema:
          $ref: '#/definitions/EvaluationUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Evaluation'
          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'
      x-ms-examples:
        Update a evaluation:
          $ref: ./examples/update_evaluation.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Custom Speech Model Evaluations:'
      summary: Microsoft Azure Deletes The Evaluation Identified By The Given Id
      operationId: microsoftAzureDeleteevaluation
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the evaluation.
        required: true
        type: string
        format: uuid
      responses:
        '204':
          description: The evaluation was successfully deleted or did not exist.
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete a evaluation:
          $ref: ./examples/delete_evaluation.json
      description: Needs a more full description created.
definitions:
  EvaluationProperties:
    title: EvaluationProperties
    type: object
    properties:
      wordErrorRate2:
        format: double
        description: The word error rate of recognition with model2.
        type: number
        readOnly: true
      wordErrorRate1:
        format: double
        description: The word error rate of recognition with model1.
        type: number
        readOnly: true
      sentenceErrorRate2:
        format: double
        description: The sentence error rate of recognition with model2.
        type: number
        readOnly: true
      sentenceCount2:
        format: int32
        description: The number of processed sentences by model2.
        type: integer
        readOnly: true
      wordCount2:
        format: int32
        description: The number of processed words by model2.
        type: integer
        readOnly: true
      correctWordCount2:
        format: int32
        description: The number of correctly recognized words by model2.
        type: integer
        readOnly: true
      wordSubstitutionCount2:
        format: int32
        description: The number of recognized words by model2, that are substitutions.
        type: integer
        readOnly: true
      wordDeletionCount2:
        format: int32
        description: The number of recognized words by model2, that are deletions.
        type: integer
        readOnly: true
      wordInsertionCount2:
        format: int32
        description: The number of recognized words by model2, that are insertions.
        type: integer
        readOnly: true
      sentenceErrorRate1:
        format: double
        description: The sentence error rate of recognition with model1.
        type: number
        readOnly: true
      sentenceCount1:
        format: int32
        description: The number of processed sentences by model1.
        type: integer
        readOnly: true
      wordCount1:
        format: int32
        description: The number of processed words by model1.
        type: integer
        readOnly: true
      correctWordCount1:
        format: int32
        description: The number of correctly recognized words by model1.
        type: integer
        readOnly: true
      wordSubstitutionCount1:
        format: int32
        description: The number of recognized words by model1, that are substitutions.
        type: integer
        readOnly: true
      wordDeletionCount1:
        format: int32
        description: The number of recognized words by model1, that are deletions.
        type: integer
        readOnly: true
      wordInsertionCount1:
        format: int32
        description: The number of recognized words by model1, that are insertions.
        type: integer
        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'
  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
  EvaluationUpdate:
    title: EvaluationUpdate
    type: object
    properties:
      project:
        $ref: '#/definitions/EntityReference'
      displayName:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        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
  Evaluation:
    title: Evaluation
    required:
    - dataset
    - displayName
    - locale
    - model1
    - model2
    type: object
    properties:
      model1:
        $ref: '#/definitions/EntityReference'
      model2:
        $ref: '#/definitions/EntityReference'
      transcription1:
        $ref: '#/definitions/EntityReference'
      transcription2:
        $ref: '#/definitions/EntityReference'
      dataset:
        $ref: '#/definitions/EntityReference'
      links:
        $ref: '#/definitions/Links'
      properties:
        $ref: '#/definitions/EvaluationProperties'
      project:
        $ref: '#/definitions/EntityReference'
      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
      displayName:
        description: The display name of the object.
        type: string
      description:
        description: The description of the object.
        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
  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
  Links:
    title: Links
    type: object
    properties:
      files:
        format: uri
        description: The location to get all files of this entity.
        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.
  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
  PaginatedEvaluations:
    title: PaginatedEvaluations
    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/Evaluation'
        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
  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.
  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
  Error:
    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'
      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'
  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.
  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.
  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'