swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Model API
schemes:
- https
tags:
- name: Model
paths:
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models/{id}
  : get:
      tags:
      - Model
      summary: Microsoft Azure Gets A Model
      description: Gets a model by model id.
      operationId: microsoftAzureMlmodelsQuerybyid
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The model id.
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Model'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
    delete:
      tags:
      - Model
      summary: Microsoft Azure Delete The Specified Model
      description: Deletes a model if it exists.
      operationId: microsoftAzureMlmodelsDelete
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The model id.
        required: true
        type: string
      responses:
        '200':
          description: The resource exists and was deleted successfully.
        '204':
          description: The resource does not exist and the request was well formed.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
    patch:
      tags:
      - Model
      summary: Microsoft Azure Patch A Specific Model
      description: Updates an existing model with the specified patch.
      operationId: microsoftAzureMlmodelsPatch
      consumes:
      - application/json-patch+json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The model id.
        required: true
        type: string
      - name: patch
        in: body
        description: The payload that is used to patch the model.
        required: true
        schema:
          uniqueItems: false
          type: array
          items:
            $ref: '#/definitions/JsonPatchOperation'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Model'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models
  : get:
      tags:
      - Model
      summary: Microsoft Azure Query The List Of Models In A Workspace
      description: The result list can be filtered using tag and name. If no filter is passed, the query lists all the Models in the given workspace. The returned list is paginated and the count of items in each page is an optional parameter.
      operationId: microsoftAzureMlmodelsListquery
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: name
        in: query
        description: The object name.
        required: false
        type: string
      - name: framework
        in: query
        description: The framework.
        required: false
        type: string
      - name: description
        in: query
        description: The object description.
        required: false
        type: string
      - name: count
        in: query
        description: The number of items to retrieve in a page.
        required: false
        type: integer
        format: int32
      - name: $skipToken
        in: query
        description: The continuation token to retrieve the next page.
        required: false
        type: string
      - name: tags
        in: query
        description: "A set of tags with which to filter the returned models.\r\n            It is a comma separated string of tags key or tags key=value\r\n            Example: tagKey1,tagKey2,tagKey3=value3"
        required: false
        type: string
      - name: properties
        in: query
        description: "A set of properties with which to filter the returned models.\r\n            It is a comma separated string of properties key and/or properties key=value\r\n            Example: propKey1,propKey2,propKey3=value3"
        required: false
        type: string
      - name: runId
        in: query
        description: The runId which created the model.
        required: false
        type: string
      - name: orderBy
        in: query
        description: An option to specify how the models are ordered in the response.
        required: false
        type: string
        default: CreatedAtDesc
        enum:
        - CreatedAtDesc
        - CreatedAtAsc
        - UpdatedAtDesc
        - UpdatedAtAsc
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaginatedModelList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
    post:
      tags:
      - Model
      summary: Microsoft Azure Register A Model
      description: Register the model provided.
      operationId: microsoftAzureMlmodelsRegister
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: model
        in: body
        description: The payload that is used to register the model.
        required: true
        schema:
          $ref: '#/definitions/Model'
      responses:
        '200':
          description: The model registration was successful.
          schema:
            $ref: '#/definitions/Model'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
  ? /modelmanagement/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.MachineLearningServices/workspaces/{workspace}/models/{id}/metrics
  : get:
      tags:
      - Model
      summary: Microsoft Azure Retrieve The Metrics For A Model
      description: The operational events collected for the Model are returned.
      operationId: microsoftAzureMlmodelsGetmetrics
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupParameter'
      - $ref: '#/parameters/workspaceParameter'
      - name: id
        in: path
        description: The Model Id.
        required: true
        type: string
      - name: startDate
        in: query
        description: The start date from which to retrieve metrics, ISO 8601 literal format.
        required: false
        type: string
      - name: endDate
        in: query
        description: The end date from which to retrieve metrics, ISO 8601 literal format.
        required: false
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ModelOperationalState'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ModelErrorResponse'
  /modelrecipes:
    get:
      tags:
      - Model
      description: Get a list of supported recipes for model building. Different recipes have different capabilities such as support for multi-style voice models.
      operationId: microsoftAzureModelsListrecipes
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              $ref: '#/definitions/Recipe'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get all recipes:
          $ref: ./examples/get_recipes.json
      summary: Microsoft Azure Get Modelrecipes
  /models:
    get:
      tags:
      - Model
      description: Gets the list of models for the authenticated Speech service resource.
      operationId: microsoftAzureModelsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/QuerySkip'
      - $ref: '#/parameters/QueryMaxPageSize'
      - $ref: '#/parameters/QueryFilter'
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaginatedModels'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      x-ms-examples:
        Get all models:
          $ref: ./examples/get_models.json
      summary: Microsoft Azure Get Models
  /models/{id}:
    get:
      tags:
      - Model
      description: Gets the model identified by the given ID.
      operationId: microsoftAzureModelsGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/PathId'
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Model_2'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get a model:
          $ref: ./examples/get_model.json
      summary: Microsoft Azure Get Models Id
    delete:
      tags:
      - Model
      description: Deletes the model identified by the given ID.
      operationId: microsoftAzureModelsDelete
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/PathId'
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '204':
          description: No Content
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Delete a model:
          $ref: ./examples/delete_model.json
      summary: Microsoft Azure Delete Models Id
    put:
      tags:
      - Model
      description: Creates a new voice model.
      operationId: microsoftAzureModelsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/HeaderOperationId'
      - $ref: '#/parameters/PathId'
      - $ref: '#/parameters/QueryApiVersion'
      - in: body
        name: model
        description: Model definition
        required: true
        schema:
          $ref: '#/definitions/Model_2'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Model_2'
          headers:
            Operation-Id:
              type: string
              description: ID of the operation.
            Operation-Location:
              description: The location of the operation job. Use this URL to monitor operation status.
              type: string
              format: uri
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Create a model:
          $ref: ./examples/create_model.json
        Create a multi style model:
          $ref: ./examples/create_multi_style_model.json
      summary: Microsoft Azure Put Models Id
  /model:
    get:
      tags:
      - Model
      summary: Microsoft Azure Get Model
      description: Get the model file generated by Personalizer service.
      operationId: microsoftAzureModelGet
      consumes: []
      produces:
      - application/octet-stream
      parameters: []
      responses:
        '200':
          description: Success
          schema:
            type: file
      x-ms-examples:
        Successful Model_Get request:
          $ref: ./examples/Model_Get.json
    delete:
      tags:
      - Model
      summary: Microsoft Azure Reset Model
      description: Resets the model file generated by Personalizer service.
      operationId: microsoftAzureModelReset
      consumes: []
      produces:
      - application/json
      parameters: []
      responses:
        '204':
          description: Success
        default:
          description: Model reset failed.
          schema:
            $ref: '#/definitions/ErrorResponse_2'
      x-ms-examples:
        Successful Model_Reset request:
          $ref: ./examples/Model_Reset.json
  /model/properties:
    get:
      tags:
      - Model
      summary: Microsoft Azure Get Model Properties
      description: Get properties of the model file generated by Personalizer service.
      operationId: microsoftAzureModelGetproperties
      consumes: []
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ModelProperties_2'
      x-ms-examples:
        Successful Model_GetProperties request:
          $ref: ./examples/Model_GetProperties.json
definitions:
  ErrorDetails:
    description: The error details.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      message:
        description: The error message.
        type: string
      target:
        description: The target of the error (e.g., the name of the property in error).
        type: string
  PersonalizerError:
    description: The error object.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Error Codes returned by Personalizer
        enum:
        - BadRequest
        - InvalidServiceConfiguration
        - InvalidLearningModeServiceConfiguration
        - InvalidPolicyConfiguration
        - InvalidPolicyContract
        - InvalidEvaluationContract
        - DuplicateCustomPolicyNames
        - NoLogsExistInDateRange
        - LogsSizeExceedAllowedLimit
        - InvalidRewardRequest
        - InvalidEventIdToActivate
        - InvalidRankRequest
        - InvalidExportLogsRequest
        - InvalidRequest
        - InvalidContainer
        - InvalidModelMetadata
        - ApprenticeModeNeverTurnedOn
        - MissingAppId
        - InvalidRewardWaitTime
        - InvalidMultiSlotApiAccess
        - ModelFileAccessDenied
        - ProblemTypeIncompatibleWithAutoOptimization
        - ResourceNotFound
        - FrontEndNotFound
        - EvaluationNotFound
        - LearningSettingsNotFound
        - EvaluationModelNotFound
        - LogsPropertiesNotFound
        - ModelRankingError
        - InternalServerError
        - RankNullResponse
        - UpdateConfigurationFailed
        - ModelResetFailed
        - ModelPublishFailed
        - ModelMetadataUpdateFailed
        - OperationNotAllowed
        type: string
        x-ms-enum:
          name: PersonalizerErrorCode
          modelAsString: true
          values:
          - value: BadRequest
            description: Request could not be understood by the server.
          - value: InvalidServiceConfiguration
            description: Invalid service configuration.
          - value: InvalidLearningModeServiceConfiguration
            description: Updating defaultReward, rewardWaitTime and rewardAggregation when changing learning mode from Online to Apprentice mode and vice versa is not allowed. Make the mode change and then change the additional settings with an additional API call.
          - value: InvalidPolicyConfiguration
            description: Invalid policy configuration.
          - value: InvalidPolicyContract
            description: Invalid policy contract.
          - value: InvalidEvaluationContract
            description: Invalid evaluation contract.
          - value: DuplicateCustomPolicyNames
            description: Custom policy names should be unique.
          - value: NoLogsExistInDateRange
            description: No logs exist in date range.
          - value: LogsSizeExceedAllowedLimit
            description: Total size of logs exceed allowed limit.
          - value: InvalidRewardRequest
            description: Invalid reward request.
          - value: InvalidEventIdToActivate
            description: Invalid activate event request.
          - value: InvalidRankRequest
            description: Invalid request.
          - value: InvalidExportLogsRequest
            description: Invalid request.
          - value: InvalidRequest
            description: Invalid request.
          - value: InvalidContainer
            description: SAS Uri must be the Uri to a container that has write permissions.
          - value: InvalidModelMetadata
            description: Invalid model metadata.
          - value: ApprenticeModeNeverTurnedOn
            description: Apprentice mode never turned on.
          - value: MissingAppId
            description: AppId is missing in the header.
          - value: InvalidRewardWaitTime
            description: Reward wait time should be between 5 seconds and 2 days
          - value: InvalidMultiSlotApiAccess
            description: Multi-slot feature is currently disabled. Please follow multi-slot Personalizer documentation to update your loop settings to enable multi-slot functionality.
          - value: ModelFileAccessDenied
            description: Key vault Key used for customer managed key cannot be accessed.
          - value: ProblemTypeIncompatibleWithAutoOptimization
            description: Auto-optimization is not compatible with multi-slot personalization.
          - value: ResourceNotFound
            description: Requested resource does not exist on the server.
          - value: FrontEndNotFound
            description: Front end not found.
          - value: EvaluationNotFound
            description: Offline Evaluation not found.
          - value: LearningSettingsNotFound
            description: Learning Settings not found in evaluation.
          - value: EvaluationModelNotFound
            description: Model not found in evaluation.
          - value: LogsPropertiesNotFound
            description: Log properties not found.
          - value: ModelRankingError
            description: Error while ranking actions using model. Please verify the learning settings are valid.
          - value: InternalServerError
            description: A generic error has occurred on the server.
          - value: RankNullResponse
            description: Rank call returned null response.
          - value: UpdateConfigurationFailed
            description: Failed to update configuration.
          - value: ModelResetFailed
            description: Model reset failed.
          - value: ModelPublishFailed
            description: Model publish failed.
          - value: ModelMetadataUpdateFailed
            description: Model metadata update failed.
          - value: OperationNotAllowed
            description: This operation is not allowed at this time.
      message:
        description: A message explaining the error reported by the service.
        type: string
      target:
        description: Error source element.
        type: string
      details:
        description: An array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/PersonalizerError'
      innerError:
        $ref: '#/definitions/InternalError'
  PresetStyleItem:
    description: Preset styles supported by the recipe. The voice model can support these styles without any style training set.
    type: object
    properties:
      male:
        description: Preset styles supported on male voice model.
        type: array
        items:
          type: string
      female:
        description: Preset styles supported on female voice model.
        type: array
        items:
          type: string
  ModelProperties_2:
    description: Properties related to the trained model.
    type: object
    properties:
      creationTime:
        format: date-time
        description: Creation time of the model.
        type: string
        readOnly: true
      lastModifiedTime:
        format: date-time
        description: Last time the model was modified.
        type: string
        readOnly: true
  ErrorResponse_2:
    description: Used to return an error to the client
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PersonalizerError'
  Model_2:
    description: Model object
    required:
    - recipe
    - projectId
    - consentId
    - trainingSetId
    type: object
    properties:
      id:
        $ref: '#/definitions/ResourceId'
      voiceName:
        description: Voice name
        minLength: 1
        type: string
      description:
        description: Model description
        type: string
      recipe:
        $ref: '#/definitions/Recipe'
      locale:
        description: The locale of this model. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
        type: string
        example: en-US
      projectId:
        $ref: '#/definitions/ResourceId'
      consentId:
        $ref: '#/definitions/ResourceId'
      trainingSetId:
        $ref: '#/definitions/ResourceId'
      engineVersion:
        description: Engine version. Update this version can get the latest pronunciation bug fixing.
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/ModelProperties'
      status:
        $ref: '#/definitions/Status'
      createdDateTime:
        description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
        format: date-time
        type: string
        readOnly: true
      lastActionDateTime:
        description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
        format: date-time
        type: string
        readOnly: true
  Model:
    description: An Azure Machine Learning Model.
    required:
    - name
    - url
    - mimeType
    type: object
    properties:
      id:
        description: The Model Id.
        type: string
        example: sklearn_mnist:1
      name:
        description: The Model name.
        type: string
        example: sklearn_mnist
      framework:
        description: The Model framework.
        type: string
      frameworkVersion:
        description: The Model framework version.
        type: string
      version:
        format: int64
        description: The Model version assigned by Model Management Service.
        type: integer
        example: '1'
      datasets:
        description: The list of datasets associated with the model.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/DatasetReference'
      url:
        description: The URL of the Model. Usually a SAS URL.
        type: string
      mimeType:
        description: The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml
        type: string
      description:
        description: The Model description text.
        type: string
        example: A mnist model, first version.
      createdTime:
        format: date-time
        description: The Model creation time (UTC).
        type: string
        readOnly: true
      modifiedTime:
        format: date-time
        description: The Model last modified time (UTC).
        type: string
        readOnly: true
      unpack:
        description: Indicates whether we need to unpack the Model during docker Image creation.
        type: boolean
      parentModelId:
        description: The Parent Model Id.
        type: string
        example: sklearn_mnist_root:1
      runId:
        description: The RunId that created this model.
        type: string
      experimentName:
        description: The name of the experiment where this model was created.
        type: string
      kvTags:
        description: The Model tag dictionary. Items are mutable.
        type: object
        additionalProperties:
          type: string
      properties:
        description: The Model property dictionary. Properties are immutable.
        type: object
        additionalProperties:
          type: string
  ModelErrorResponse:
    description: The Model Management Service Error object.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      statusCode:
        format: int32
        description: The HTTP status code.
        type: integer
      message:
        description: The error message.
        type: string
      details:
        description: An array of error detail objects.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ErrorDetails'
  Recipe:
    description: Recipe for model building. Different recipes have different capability.
    type: object
    properties:
      kind:
        description: Recipe kind
        type: string
      version:
        description: Recipe version
        type: string
      description:
        description: Recipe description
        type: string
        readOnly: true
      minUtteranceCount:
        description: Minimum utterance count required to train a voice model with this recipe.
        format: int32
        type: integer
        readOnly: true
      minStyleUtteranceCount:
        description: Minimum utterance count required to train each customized style.
        format: int32
        type: integer
        readOnly: true
      maxCustomStyleNum:
        description: Maximum customized style number supported in one voice model.
        format: int32
        type: integer
        readOnly: true
      datasetLocales:
        description: The locale of the training dataset. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
        type: array
        items:
          type: string
          example: en-US
        readOnly: true
      modelLocales:
        description: The locale that a voice model can speak with this recipe. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
        type: array
        items:
          type: string
          example: en-US
        readOnly: true
      presetStyles:
        description: Preset styles supported by this recipe per locale. You can get these styles without any style training set.
        type: object
        additionalProperties:
          $ref: '#/definitions/PresetStyleItem'
        readOnly: true
  ResourceId:
    description: Resource id
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
    minLength: 3
    maxLength: 64
  ModelProperties:
    description: Model properties
    type: object
    properties:
      presetStyles:
        description: Preset styles of this model.
        type: array
        items:
          type: string
      styleTrainingSetIds:
        description: Customized styles and associated training sets.
        type: object
        additionalProperties:
          $ref: '#/definitions/ResourceId'
      voiceStyles:
        description: All styles supported by this model.
        type: array
        items:
          type: string
        readOnly: true
      failureReason:
        $ref: '#/definitions/ModelFailureReason'
  Status:
    description: Status of a resource.
    enum:
    - NotStarted
    - Running
    - Succeeded
    - Failed
    - Disabling
    - Disabled
    type: string
    x-ms-enum:
      name: Status
      modelAsString: true
  Error:
    description: Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.
    required:
    - code
    - message
    type: object
    properties:
      code:
        $ref: '#/definitions/ErrorCode'
      target:
        description: The source of the error. For example it would be "model" or "model id" in case of invalid model.
        type: string
      message:
        description: Top-level error message.
        type: string
      details:
        description: Additional supportive details regarding the error and/or expected policies.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
  ErrorResponse:
    description: Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
  ModelOperationalState:
    description: The operational state of the Model.
    type: object
    properties:
      deploymentSummary:
        $ref: '#/definitions/DeploymentSummary'
        description: The summary of the deployment.
      endTime:
        description: The deployment end time.
        type: string
      startTime:
        description: The deployment start time.
        type: string
  ModelFailureReason:
    description: Model training failure reason
    enum:
    - None
    - InaccessibleCustomerStorage
    - SpeakerVerificationFailed
    - TerminateByUser
    - Internal
    type: string
    x-ms-enum:
      name: ModelFailureReason
      modelAsString: true
  ErrorCode:
    description: Top-level error code
    enum:
    - BadRequest
    - BadArgument
    - Unauthorized
    - Forbidden
    - NotFound
    - UnsupportedMediaType
    - TooManyRequests
    - InternalServerError
    - ServiceUnavailable
    type: string
    x-ms-enum:
      name: ErrorCode
      modelAsString: true
  PaginatedModels:
    description: Paginated model list
    required:
    - value
    type: object
    properties:
      value:
        description: Model list
        type: array
        items:
          $ref: '#/definitions/Model_2'
      nextLink:
        description: Link to next page.
        format: uri
        type: string
  InternalError:
    description: An object containing more specific information than the parent object about the error.
    type: object
    properties:
      code:
        description: Detailed error code.
        type: string
      innererror:
        $ref: '#/definitions/InternalError'
  JsonPatchOperation:
    description: The Json Patch definition.
    type: object
    properties:
      value:
        description: The value.
        type: object
      path:
        description: The target location.
        type: string
      op:
        description: The operation.
        type: string
      from:
        description: The source location.
        type: string
  InnerError:
    description: Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
    type: object
    properties:
      code:
        description: Detailed error code to help diagnostic.
        type: string
      target:
        description: The source of the error. For example it would be "model" or "model id" in case of invalid model.
        type: string
      message:
        description: Detailed error message.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
  DeploymentSummary:
    description: The deployment summary.
    type: object
    properties:
      successfulDeployments:
        format: int32
        description: The number of successful deployments.
        type: integer
      unsuccessfulDeployments:
        format: int32
        description: The number of unsuccessful deployments.
        type: integer
  PaginatedModelList:
    description: A paginated list of Models.
    type: object
    properties:
      value:
        description: An array of objects of type Model.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/Model'
      nextLink:
        description: A continuation link (absolute URI) to the next page of results in the list.
        type: string
  DatasetReference:
    description: The dataset reference object.
    type: object
    properties:
      name:
        description: The name of the dataset reference.
        type: string
      id:
        description: The id of the dataset reference.
        type: string
parameters:
  QueryMaxPageSize:
    name: maxpagesize
    in: query
    description: The maximum number of items to include in a single response.
    required: false
    type: integer
    format: int32
    default: 100
    x-ms-parameter-location: method
  workspaceParameter:
    name: workspace
    in: path
    description: The name of the workspace.
    required: true
    type: string
    x-ms-parameter-location: method
  HeaderOperationId:
    name: Operation-Id
    in: header
    description: ID of the status monitor for the operation. If the Operation-Id header matches an existing operation and the request is not identical to the prior request, it will fail with a 400 Bad Request.
    required: false
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
    minLength: 3
    maxLength: 64
    x-ms-parameter-location: method
  QueryFilter:
    name: filter
    in: query
    description: "Filter condition.\r\n  - **Supported properties:** projectId, createdDateTime, locale, 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  - **Example:**\r\n    - ```filter=projectId eq 'Jessica'``` (filter by project ID)\r\n    - ```filter=kind eq 'ProfessionalVoice'``` (filter project by kind)\r\n    - ```filter=locale eq 'en-US'``` (filter training set and model by locale)\r\n    - ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource created time after 2023-11-01)"
    required: false
    type: string
    x-ms-parameter-location: method
  resourceGroupParameter:
    name: resourceGroup
    in: path
    description: The Name of the resource group in which the workspace is located.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The Azure Subscription ID.
    required: true
    type: string
    format: uuid
    x-ms-parameter-location: method
  PathId:
    name: id
    in: path
    description: The ID of the resource.
    required: true
    type: string
    pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
    minLength: 3
    maxLength: 64
    x-ms-parameter-location: method
  QueryApiVersion:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
  QuerySkip:
    name: skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    default: 0
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'