Microsoft Azure Custom Speech Accuracy Tests: API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Custom Speech Accuracy Tests: API'
schemes:
- https
tags:
- name: 'Custom Speech Accuracy Tests:'
paths:
  /accuracytests:
    get:
      tags:
      - 'Custom Speech Accuracy Tests:'
      summary: Microsoft Azure Gets The List Of Accuracy Tests For The Authenticated Subscription
      operationId: microsoftAzureGetaccuracytests
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Test'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get all accuracy tests:
          $ref: ./examples/get_accuracy_tests.json
      description: Needs a more full description created.
    post:
      tags:
      - 'Custom Speech Accuracy Tests:'
      summary: Microsoft Azure Creates A New Accuracy Test
      operationId: microsoftAzureCreateaccuracytest
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: testDefinition
        description: The details of the new accuracy test.
        required: true
        schema:
          $ref: '#/definitions/TestDefinition'
      responses:
        '202':
          description: The request was accepted and the response contains the location of the entity.
          headers:
            Retry-After:
              description: The minimum number of seconds to wait before accessing the resource created in this operation.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
            Location:
              description: The location of the created resource.
              type: string
              format: uri
            Operation-Location:
              description: The location of the created resource.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Create an accuracy test:
          $ref: ./examples/create_accuracy_test.json
      description: Needs a more full description created.
  /accuracytests/{id}:
    get:
      tags:
      - 'Custom Speech Accuracy Tests:'
      summary: Microsoft Azure Gets The Accuracy Test Identified By The Given Id
      operationId: microsoftAzureGetaccuracytest
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the accuracy test.
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Test'
          headers:
            Retry-After:
              description: The minimum number of seconds to wait for a non terminal operation to complete.
              type: integer
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Get an accuracy test:
          $ref: ./examples/get_accuracy_test.json
      description: Needs a more full description created.
    patch:
      tags:
      - 'Custom Speech Accuracy Tests:'
      summary: Microsoft Azure Updates The Mutable Details Of The Test Identified By Its Id
      operationId: microsoftAzureUpdateaccuracytest
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the accuracy test.
        required: true
        type: string
        format: uuid
      - in: body
        name: testUpdate
        description: The object containing the updated fields of the test.
        required: true
        schema:
          $ref: '#/definitions/TestUpdate'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Test'
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Update an accuracy test:
          $ref: ./examples/update_accuracy_test.json
      description: Needs a more full description created.
    delete:
      tags:
      - 'Custom Speech Accuracy Tests:'
      summary: Microsoft Azure Deletes The Accuracy Test Identified By The Given Id
      operationId: microsoftAzureDeleteaccuracytest
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: The identifier of the accuracy test.
        required: true
        type: string
        format: uuid
      responses:
        '204':
          description: The test was successfully deleted.
          headers:
            X-RateLimit-Limit:
              description: The limit of requests for the resource.
              type: integer
            X-RateLimit-Remaining:
              description: The remaining number of requests until the rate limit is reached.
              type: integer
            X-RateLimit-Reset:
              description: The timestamp when the rate limit will be reset formatted as ISO 8601 combined date and time in UTC.
              type: string
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Delete an accuracy test:
          $ref: ./examples/delete_accuracy_test.json
      description: Needs a more full description created.
definitions:
  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
  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'
  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
  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
  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.
  DatasetIdentity:
    title: DatasetIdentity
    required:
    - id
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
  Status:
    title: Status
    description: Describe the current state of the API
    enum:
    - NotStarted
    - Running
    - Succeeded
    - Failed
    type: string
    readOnly: true
    x-ms-enum:
      name: Status
      modelAsString: false
      values:
      - value: NotStarted
        description: The long running operation has not yet started.
      - value: Running
        description: The long running operation is currently processing.
      - value: Succeeded
        description: The long running operation has successfully completed.
      - value: Failed
        description: The long running operation has failed.
  TestUpdate:
    title: TestUpdate
    required:
    - name
    type: object
    properties:
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
  TestDefinition:
    title: TestDefinition
    required:
    - models
    - name
    type: object
    properties:
      models:
        description: Information about the models used for this accuracy test.
        type: array
        items:
          $ref: '#/definitions/ModelIdentity'
      dataset:
        $ref: '#/definitions/DatasetIdentity'
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
      properties:
        description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
  DatasetKind:
    title: DatasetKind
    description: Kind of data import.
    enum:
    - Language
    - Acoustic
    - Pronunciation
    type: string
    x-ms-enum:
      name: DatasetKind
      modelAsString: false
      values:
      - value: Language
        description: A language dataset.
      - value: Acoustic
        description: An acoustic dataset.
      - value: Pronunciation
        description: A pronunciation dataset.
  Error:
    title: Error
    description: The interface represents the content of an error response defined in the OneAPI v2.1 documentation.
    required:
    - code
    - message
    type: object
    properties:
      details:
        description: An array of details representing distinct related errors that occurred during the request.
        type: array
        items:
          $ref: '#/definitions/ErrorDetail'
      innererror:
        $ref: '#/definitions/InnerErrorV2'
      code:
        description: "A service-defined error code that should be human-readable.\r\nThis code serves as a more specific indicator of the error than\r\nthe HTTP error code specified in the response."
        type: string
      message:
        description: "A human-readable representation of the error. It is intended as\r\nan aid to developers and is not suitable for exposure to end users."
        type: string
      target:
        description: The target of the particular error (e.g., the name of the property in error).
        type: string
  ModelIdentity:
    title: ModelIdentity
    required:
    - id
    type: object
    properties:
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
  Test:
    title: Test
    required:
    - id
    - models
    - name
    type: object
    properties:
      resultsUrl:
        format: uri
        description: "The URL that can be used to download the test results.\r\nEach line in the file represents a tab separated list of filename, reference transcription and decoder output.\r\n            \r\nThe URL will only be valid, if the test completed successfully."
        type: string
        readOnly: true
      id:
        format: uuid
        description: The identifier of this entity.
        type: string
      wordErrorRate:
        format: double
        description: The word error rate of the tested model.
        type: number
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        format: date-time
        description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)."
        type: string
        readOnly: true
      models:
        description: Information about the models used for this accuracy test.
        type: array
        items:
          $ref: '#/definitions/Model'
      dataset:
        $ref: '#/definitions/Dataset'
      name:
        description: The name of the object.
        type: string
      description:
        description: The description of the object.
        type: string
      properties:
        description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10."
        type: object
        additionalProperties:
          type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'