swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Models API description: Operations for listing available models schemes: - https tags: - name: Models description: Operations for listing available models paths: /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/models: get: operationId: Models_List summary: Microsoft Azure List Available Models description: List available models for the subscription. tags: - Models parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: Successfully returned available models. content: application/json: schema: $ref: '#/components/schemas/ModelListResult' examples: ModelsList200Example: summary: Default Models_List 200 response x-microcks-default: true value: value: - format: example_value name: Example Title version: example_value source: example_value maxCapacity: 10 capabilities: example_value deprecation: {} lifecycleStatus: GenerallyAvailable systemData: {} nextLink: example_value default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: ModelsListdefaultExample: summary: Default Models_List default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value additionalInfo: - type: example_value info: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /models: parameters: - $ref: '#/parameters/traceparent' - $ref: '#/parameters/tracestate' post: tags: - Models description: Uploads one or more models. When any error occurs, no models are uploaded.
Status codes:
* 201 Created
* 400 Bad Request
* DTDLParserError - The models provided are not valid DTDL.
* InvalidArgument - The model id is invalid.
* LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.
* ModelVersionNotSupported - The version of DTDL used is not supported.
* 409 Conflict
* ModelAlreadyExists - The model provided already exists. operationId: microsoftAzureDigitaltwinmodelsAdd x-ms-examples: Add models: $ref: ./examples/ModelAdd.json parameters: - name: models in: body description: An array of models to add. required: true schema: type: array minItems: 1 uniqueItems: true items: type: object - $ref: '#/parameters/api-version' responses: '201': description: Success schema: $ref: '#/definitions/NonPagedDigitalTwinsModelDataCollection' default: description: Default response. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Models get: tags: - Models description: Retrieves model metadata and, optionally, model definitions.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.
* 404 Not Found
* ModelNotFound - The model was not found. x-ms-pageable: nextLinkName: nextLink operationId: microsoftAzureDigitaltwinmodelsList x-ms-examples: List models: $ref: ./examples/ModelsGet.json List models (include dependencies and definitions): $ref: ./examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json parameters: - name: dependenciesFor in: query description: If specified, only return the set of the specified models along with their dependencies. If omitted, all models are retrieved. required: false type: array collectionFormat: multi items: type: string - $ref: '#/parameters/includeModelDefinition' - $ref: '#/parameters/max-items-per-page' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/PagedDigitalTwinsModelDataCollection' default: description: Default response. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Models /models/{id}: parameters: - $ref: '#/parameters/traceparent' - $ref: '#/parameters/tracestate' get: tags: - Models description: Retrieves model metadata and optionally the model definition.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* MissingArgument - The model id was not provided.
* 404 Not Found
* ModelNotFound - The model was not found. operationId: microsoftAzureDigitaltwinmodelsGetbyid x-ms-examples: Get a model by id: $ref: ./examples/ModelGetById.json Get a model by id (with definition): $ref: ./examples/ModelGetByIdWithIncludeModelDefinition.json parameters: - $ref: '#/parameters/modelId' - $ref: '#/parameters/includeModelDefinition' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/DigitalTwinsModelData' default: description: Default response. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Models Id patch: tags: - Models description: Updates the metadata for a model.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* JsonPatchInvalid - The JSON Patch provided is invalid.
* MissingArgument - The model id was not provided.
* 404 Not Found
* ModelNotFound - The model was not found.
* 409 Conflict
* ModelReferencesNotDecommissioned - The model refers to models that are not decommissioned. operationId: microsoftAzureDigitaltwinmodelsUpdate consumes: - application/json-patch+json x-ms-examples: Decommission a model: $ref: ./examples/ModelUpdateDecommissioned.json parameters: - $ref: '#/parameters/modelId' - name: updateModel description: An update specification described by JSON Patch. Only the decommissioned property can be replaced. in: body required: true schema: type: array items: type: object - $ref: '#/parameters/api-version' responses: '204': description: Success default: description: Default response. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Patch Models Id delete: tags: - Models operationId: microsoftAzureDigitaltwinmodelsDelete description: Deletes a model. A model can only be deleted if no other models reference it.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* MissingArgument - The model id was not provided.
* 404 Not Found
* ModelNotFound - The model was not found.
* 409 Conflict
* ModelReferencesNotDeleted - The model refers to models that are not deleted. x-ms-examples: Delete a model: $ref: ./examples/DeleteModel.json parameters: - $ref: '#/parameters/modelId' - $ref: '#/parameters/api-version' responses: '204': description: Success default: description: Default response. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Delete Models Id /models/{model_id}: get: tags: - Models summary: Microsoft Azure Gets Details For The Model Specified By The Given Modelid operationId: microsoftAzureModelsGet produces: - application/json parameters: - in: path name: model_id description: The identifier of the model. required: true type: string - $ref: '#/parameters/apiVersionQueryParameter' responses: '200': description: Success schema: $ref: '#/definitions/Model' default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Getting a base model.: $ref: ./examples/get_model_base.json Getting a fine-tuned model.: $ref: ./examples/get_model_finetune.json description: Needs a more full description created. /models/{model-id}: get: tags: - Models summary: Microsoft Azure Gets Details For The Model Specified By The Given Modelid operationId: microsoftAzureModelsGet produces: - application/json parameters: - in: path name: model-id description: The identifier of the model. required: true type: string - $ref: '#/parameters/apiVersionQueryParameter_3' responses: '200': description: Success schema: $ref: '#/definitions/Model_2' default: description: An error occurred. schema: $ref: '#/definitions/ErrorResponse_4' x-ms-examples: Getting a base model.: $ref: ./examples/get_model_base.json Getting a fine-tuned model.: $ref: ./examples/get_model_finetune.json description: Needs a more full description created. /models/{model}/analyze: post: description: 'This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.' operationId: microsoftAzureAnalyzeimagebydomain consumes: - application/json produces: - application/json parameters: - name: model in: path description: The domain-specific content to recognize. required: true type: string - $ref: '#/parameters/ServiceLanguage' - $ref: ../../../Common/Parameters.json#/parameters/ImageUrl responses: '200': description: Analysis result based on the domain model schema: $ref: '#/definitions/DomainModelResults' default: description: Error response. schema: $ref: '#/definitions/ComputerVisionError' x-ms-examples: Successful Domain Model analysis request: $ref: ./examples/SuccessfulDomainModelWithUrl.json summary: Microsoft Azure Post Models Model Analyze tags: - Models /models/{name}: put: tags: - Models summary: "Microsoft Azure Start Training A Custom Model \r\n \r\nstatus Codes Returned:\r\n 201: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 409: A Model With The Specified Name Already Exists" operationId: microsoftAzureModelsCreate consumes: - application/json-patch+json produces: - application/json parameters: - in: path name: name description: A name that can be used to uniquely identify the model after it has been created. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion' - in: body name: body description: Properties for the model, such as the name of the dataset to use to train the model. required: true schema: $ref: '#/definitions/Model_14' responses: '201': description: Created schema: $ref: '#/definitions/Model_14' default: description: Error schema: $ref: '#/definitions/ErrorResponse_16' headers: x-ms-error-code: type: string x-ms-examples: Models_Create: $ref: ./examples/Models_Create.json description: Needs a more full description created. get: tags: - Models summary: "Microsoft Azure Get Information About A Specific Model \r\n \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found" operationId: microsoftAzureModelsGet produces: - application/json parameters: - in: path name: name description: The name of the model to get. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion' responses: '200': description: Success schema: $ref: '#/definitions/Model_14' default: description: Error schema: $ref: '#/definitions/ErrorResponse_16' headers: x-ms-error-code: type: string x-ms-examples: Models_Get: $ref: ./examples/Models_Get.json description: Needs a more full description created. delete: tags: - Models summary: "Microsoft Azure Delete A Custom Model A Model Can Be Deleted If It Is In One Of The Succeeded , Failed , Or Canceled States \r\nif A Model Is In The Notstarted Or Training State, Cancel Training And Wait For Cancellation To Finish Before Deleting The Model \r\n \r\nstatus Codes Returned:\r\n 204: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found" operationId: microsoftAzureModelsDelete produces: - application/json parameters: - in: path name: name description: The name of the model to delete. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion' responses: '204': description: No Content default: description: Error schema: $ref: '#/definitions/ErrorResponse_16' headers: x-ms-error-code: type: string x-ms-examples: Models_Delete: $ref: ./examples/Models_Delete.json description: Needs a more full description created. /models/{name}:cancel: post: tags: - Models summary: "Microsoft Azure Cancel Model Training \r\n \r\nstatus Codes Returned:\r\n 202: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found" operationId: microsoftAzureModelsCanceltraining produces: - application/json parameters: - in: path name: name description: The name of the model to cancel training. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion' responses: '202': description: Accepted default: description: Error schema: $ref: '#/definitions/ErrorResponse_16' headers: x-ms-error-code: type: string x-ms-examples: Models_CancelTraining: $ref: ./examples/Models_CancelTraining.json description: Needs a more full description created. /models/{name}/evaluations/{evaluationName}: put: tags: - Models summary: "Microsoft Azure Evaluate An Existing Model \r\n \r\nstatus Codes Returned:\r\n 201: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 409: An Evaluation With The Specified Name Already Exists" operationId: microsoftAzureModelevaluationsCreate consumes: - application/json-patch+json produces: - application/json parameters: - in: path name: name description: The name of the model to evaluate. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - in: path name: evaluationName description: A name that can be used to uniquely identify the evaluation after it has been created. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion' - in: body name: body description: Properties for the evaluation, such as the name of the dataset to use to test the model. required: true schema: $ref: '#/definitions/ModelEvaluation' responses: '201': description: Created schema: $ref: '#/definitions/ModelEvaluation' default: description: Error schema: $ref: '#/definitions/ErrorResponse_16' headers: x-ms-error-code: type: string x-ms-examples: ModelEvaluations_Create: $ref: ./examples/ModelEvaluations_Create.json description: Needs a more full description created. get: tags: - Models summary: "Microsoft Azure Get Information About A Specific Model Evaluation \r\n \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model Evaluation With The Specified Name Was Not Found" operationId: microsoftAzureModelevaluationsGet produces: - application/json parameters: - in: path name: name description: The name of the model to get the evaluation for. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - in: path name: evaluationName description: The name of the model evaluation to get. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion' responses: '200': description: Success schema: $ref: '#/definitions/ModelEvaluation' default: description: Error schema: $ref: '#/definitions/ErrorResponse_16' headers: x-ms-error-code: type: string x-ms-examples: ModelEvaluations_Get: $ref: ./examples/ModelEvaluations_Get.json description: Needs a more full description created. delete: tags: - Models summary: "Microsoft Azure Delete A Model Evaluation A Model Evaluation Can Be Deleted If It Is In The Succeeded Or Failed States \r\n \r\nstatus Codes Returned:\r\n 204: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model Evaluation With The Specified Name Was Not Found" operationId: microsoftAzureModelevaluationsDelete produces: - application/json parameters: - in: path name: name description: The name of the model to delete the evaluation for. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - in: path name: evaluationName description: The name of the model evaluation to delete. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion' responses: '204': description: No Content default: description: Error schema: $ref: '#/definitions/ErrorResponse_16' headers: x-ms-error-code: type: string x-ms-examples: ModelEvaluations_Delete: $ref: ./examples/ModelEvaluations_Delete.json description: Needs a more full description created. /models/{name}/evaluations: get: tags: - Models summary: "Microsoft Azure Get A List Of The Available Evaluations For A Model \r\n \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed" operationId: microsoftAzureModelevaluationsList produces: - application/json parameters: - in: path name: name description: The name of the model to get evaluations for. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - in: query name: skip description: Number of evaluations to be skipped. type: integer format: int32 default: 0 maximum: 2147483647 minimum: 0 - in: query name: top description: Number of evaluations to be returned after skipping. The maximum allowed value is 30. type: integer format: int32 default: 10 maximum: 30 minimum: 1 - $ref: '#/parameters/ApiVersion' responses: '200': description: Success schema: $ref: '#/definitions/ModelEvaluationApiModelCollectionApiModel' default: description: Error schema: $ref: '#/definitions/ErrorResponse_16' headers: x-ms-error-code: type: string x-ms-examples: ModelEvaluations_List: $ref: ./examples/ModelEvaluations_List.json x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. components: schemas: ErrorResponse: type: object description: Error response. properties: error: type: object description: The error object. properties: code: type: string message: type: string target: type: string details: type: array items: type: object properties: code: type: string message: type: string target: type: string additionalInfo: type: array items: type: object properties: type: type: string info: type: object example: example_value AccountModel: type: object description: Cognitive Services account model. properties: format: type: string description: Model format. example: example_value name: type: string description: Model name. example: Example Title version: type: string description: Model version. example: example_value source: type: string description: Source of the model. example: example_value maxCapacity: type: integer description: The maximum capacity. example: 10 capabilities: type: object additionalProperties: type: string description: Model capabilities. example: example_value deprecation: type: object description: Deprecation information. properties: fineTune: type: string format: date-time inference: type: string format: date-time example: example_value lifecycleStatus: type: string enum: - GenerallyAvailable - Preview description: Model lifecycle status. example: GenerallyAvailable systemData: type: object readOnly: true properties: createdBy: type: string createdByType: type: string createdAt: type: string format: date-time lastModifiedBy: type: string lastModifiedByType: type: string lastModifiedAt: type: string format: date-time example: example_value ModelListResult: type: object description: The list of cognitive services models. properties: value: type: array items: $ref: '#/components/schemas/AccountModel' description: An array of models. example: [] nextLink: type: string description: The link used to get the next page of models. example: example_value parameters: ApiVersionParameter: name: api-version in: query required: true description: The API version to use for this operation. schema: type: string default: 2024-04-01-preview SubscriptionIdParameter: name: subscriptionId in: path required: true description: The ID of the target subscription. schema: type: string format: uuid definitions: ModelPerformance: description: Performance metrics for a custom trained model. required: - tagPerformance type: object properties: accuracyTop1: format: double description: Read only. For multiclass classification models. The proportion of test samples where the ground truth class matches the predicted class. type: number readOnly: true accuracyTop5: format: double description: Read only. For multiclass classification models. The proportion of test samples where the ground truth class is in the top five predicted classes. type: number readOnly: true averagePrecision: format: double description: Read only. A measure of the model performance, it summarizes the precision and recall at different confidence thresholds. type: number readOnly: true calibrationECE: format: double description: Read only. For multiclass classification models. Expected calibration error. type: number readOnly: true meanAveragePrecision30: format: double description: Read only. For object detection models. Mean average precision at a threshold of 30%. type: number readOnly: true meanAveragePrecision50: format: double description: Read only. For object detection models. Mean average precision at a threshold of 50%. type: number readOnly: true meanAveragePrecision75: format: double description: Read only. For object detection models. Mean average precision at a threshold of 75%. type: number readOnly: true tagPerformance: description: Read only. Performance metrics for each tag recognized by the model. type: object additionalProperties: $ref: '#/definitions/ModelTagPerformance' ErrorResponse_16: description: Response returned when an error occurs. required: - error type: object properties: error: $ref: '#/definitions/ErrorResponseDetails' Model_14: description: Describes a training run for training a custom model. required: - trainingParameters type: object properties: trainingParameters: $ref: '#/definitions/TrainingParameters' name: description: Read only. The name that is used to uniquely identify the training run. maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ type: string createdDateTime: format: date-time description: Read only. The date and time when the training run was first created, in UTC. type: string updatedDateTime: format: date-time description: Read only. The date and time when the training run was last updated, in UTC. type: string status: description: Read only. The current state of the training run. enum: - notStarted - training - succeeded - failed - cancelling - cancelled type: string x-ms-enum: name: ModelState modelAsString: true trainingCostInMinutes: format: int32 description: Read only. Actual training cost consumed, in minutes. Present only if the training run as completed. type: integer readOnly: true error: $ref: '#/definitions/ErrorResponseDetails' modelPerformance: $ref: '#/definitions/ModelPerformance' evaluationParameters: $ref: '#/definitions/ModelEvaluationParameters' Deprecation_2: title: Deprecation description: "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties." required: - inference type: object properties: fine_tune: format: unixtime description: The end date of fine tune support of this model. Will be `null` for fine tune models. type: integer inference: format: unixtime description: The end date of inference support of this model. type: integer ErrorCode_2: title: ErrorCode description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." enum: - conflict - invalidPayload - forbidden - notFound - unexpectedEntityState - itemDoesAlreadyExist - serviceUnavailable - internalFailure - quotaExceeded - jsonlValidationFailed - fileImportFailed type: string x-ms-enum: name: ErrorCode modelAsString: true values: - value: conflict description: The requested operation conflicts with the current resource state. - value: invalidPayload description: The request data is invalid for this operation. - value: forbidden description: The operation is forbidden for the current user/api key. - value: notFound description: The resource is not found. - value: unexpectedEntityState description: The operation cannot be executed in the current resource's state. - value: itemDoesAlreadyExist description: The item does already exist. - value: serviceUnavailable description: The service is currently not available. - value: internalFailure description: Internal error. Please retry. - value: quotaExceeded description: Quota exceeded. - value: jsonlValidationFailed description: Validation of jsonl data failed. - value: fileImportFailed description: Import of file failed. Error_2: title: Error description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." required: - code - message type: object properties: code: $ref: '#/definitions/ErrorCode' message: description: The message of this error. minLength: 1 type: string target: description: The location where the error happened if available. type: string details: description: The error details if available. type: array items: $ref: '#/definitions/Error_2' innererror: $ref: '#/definitions/InnerError_2' Error_4: title: Error description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." required: - code - message type: object properties: code: $ref: '#/definitions/ErrorCode_2' message: description: The message of this error. minLength: 1 type: string target: description: The location where the error happened if available. type: string details: description: The error details if available. type: array items: $ref: '#/definitions/Error_4' innererror: $ref: '#/definitions/InnerError_4' ScaleType: title: ScaleType description: Defines how scaling operations will be executed. enum: - manual - standard type: string x-ms-enum: name: ScaleType modelAsString: true values: - value: manual description: Scaling of a deployment will happen by manually specifying the capacity of a model. - value: standard description: Scaling of a deployment will happen automatically based on usage. InnerError_4: title: InnerError description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." type: object properties: code: $ref: '#/definitions/InnerErrorCode' innererror: $ref: '#/definitions/InnerError_4' Deprecation: title: Deprecation description: "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties." type: object properties: fine_tune: format: int32 description: The end date of fine tune support of this model. Will be `null` for fine tune models. type: integer readOnly: true inference: format: int32 description: The end date of inference support of this model. type: integer readOnly: true ImageMetadata: type: object description: Image metadata properties: width: type: integer format: int32 description: Image width height: type: integer format: int32 description: Image height format: type: string description: Image format ModelEvaluation: description: Describes an evaluation run for evaluating the accuracy of a model using a test set. required: - evaluationParameters type: object properties: name: description: Read only. The name that is used to uniquely identify the evaluation run. maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ type: string modelName: description: Read only. The model to evaluate. maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ type: string createdDateTime: format: date-time description: Read only. The date and time when the evaluation run was first created, in UTC. type: string updatedDateTime: format: date-time description: Read only. The date and time when the evaluation run was last updated, in UTC. type: string status: description: Read only. The current state of the evaluation run. enum: - notStarted - running - succeeded - failed type: string x-ms-enum: name: ModelEvaluationState modelAsString: true evaluationParameters: $ref: '#/definitions/ModelEvaluationParameters' error: $ref: '#/definitions/ErrorResponseDetails' modelPerformance: $ref: '#/definitions/ModelPerformance' State: title: State description: The state of a job or item. enum: - notRunning - running - succeeded - canceled - failed - deleted type: string readOnly: true x-ms-enum: name: State modelAsString: false values: - value: notRunning description: The operation was created and is not queued to be processed in the future. - value: running description: The operation has started to be processed. - value: succeeded description: The operation has successfully be processed and is ready for consumption. - value: canceled description: The operation has been canceled and is incomplete. - value: failed description: The operation has completed processing with a failure and cannot be further consumed. - value: deleted description: The entity has been deleted but may still be referenced by other entities predating the deletion. ErrorResponse_2: title: ErrorResponse description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." type: object properties: error: $ref: '#/definitions/Error_2' Capabilities: title: Capabilities description: The capabilities of a base or fine tune model. type: object properties: fine_tune: description: A value indicating whether a model can be used for fine tuning. type: boolean readOnly: true ModelTagPerformance: description: Performance metrics for each tag recognized by a custom trained model. type: object properties: accuracy: format: double description: Read only. For multiclass models. Tag accuracy. type: number readOnly: true averagePrecision50: format: double description: Read only. For object detection models. Average precision at a threshold of 50%. type: number readOnly: true ComputerVisionError: type: object required: - code - message properties: code: type: string description: The error code. enum: - InvalidImageUrl - InvalidImageFormat - InvalidImageSize - NotSupportedVisualFeature - NotSupportedImage - InvalidDetails - NotSupportedLanguage - BadArgument - FailedToProcess - Timeout - InternalServerError - Unspecified - StorageException x-ms-enum: name: ComputerVisionErrorCodes modelAsString: false message: type: string description: A message explaining the error reported by the service. requestId: type: string description: A unique request identifier. InnerError: description: A more specific error description than was provided by the containing error. properties: code: description: A more specific error code than was provided by the containing error. type: string innererror: description: An object containing more specific information than the current object about the error. $ref: '#/definitions/InnerError' Model_2: title: Model description: A model is either a base model or the result of a successful fine tune job. required: - capabilities - deprecation - lifecycle_status type: object properties: object: $ref: '#/definitions/TypeDiscriminator' status: $ref: '#/definitions/State_2' created_at: format: unixtime description: A timestamp when this job or item was created (in unix epochs). type: integer readOnly: true updated_at: format: unixtime description: A timestamp when this job or item was modified last (in unix epochs). type: integer readOnly: true id: description: The identity of this item. type: string readOnly: true model: description: The base model identity (model-id) if this is a fine tune model; otherwise `null`. type: string fine_tune: description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`. type: string capabilities: $ref: '#/definitions/Capabilities_3' lifecycle_status: $ref: '#/definitions/LifeCycleStatus' deprecation: $ref: '#/definitions/Deprecation_2' LifeCycleStatus: title: LifeCycleStatus description: "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\"." enum: - preview - generally-available type: string x-ms-enum: name: LifeCycleStatus modelAsString: true values: - value: preview description: Model is in preview and covered by the service preview terms. - value: generally-available description: Model is generally available. TrainingParameters: description: Parameters for specifying how a training run trains a custom model. required: - timeBudgetInHours - trainingDatasetName type: object properties: trainingDatasetName: description: The dataset name used for training. maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ type: string timeBudgetInHours: format: int32 description: "Time budget for training, in hours. The minimum allowed value is 1, and the maximum allowed value is 336 hours for GenericClassifier, 1344 hours for GenericDetector.\r\nThis is the maximum amount of compute time that will be spent to train the model." maximum: 1344 minimum: 1 type: integer modelKind: description: Model kind. enum: - Product-Recognizer - Generic-Classifier - Generic-Detector type: string x-ms-enum: name: ModelKind modelAsString: true Model: title: Model description: A model is either a base model or the result of a successful fine tune job. type: object properties: object: $ref: '#/definitions/TypeDiscriminator' status: $ref: '#/definitions/State' created_at: format: int32 description: A timestamp when this job or item was created (in unix epochs). type: integer readOnly: true updated_at: format: int32 description: A timestamp when this job or item was modified last (in unix epochs). type: integer readOnly: true id: description: The identity of this item. type: string readOnly: true model: description: The base model ID if this is a fine tune model; otherwise `null`. type: string readOnly: true fine_tune: description: The fine tune job ID if this is a fine tune model; otherwise `null`. type: string readOnly: true capabilities: $ref: '#/definitions/Capabilities' deprecation: $ref: '#/definitions/Deprecation' TypeDiscriminator: title: TypeDiscriminator description: Defines the type of an object. enum: - list - fine-tune - file - fine-tune-event - model - deployment type: string readOnly: true x-ms-enum: name: TypeDiscriminator modelAsString: true values: - value: list description: This object represents a list of other objects. - value: fine-tune description: This object represents a fine tune job. - value: file description: This object represents a file. - value: fine-tune-event description: This object represents an event of a fine tune job. - value: model description: This object represents a model (can be a base models or fine tune job result). - value: deployment description: This object represents a deployment. PagedDigitalTwinsModelDataCollection: description: A collection of DigitalTwinsModelData objects. type: object required: - value properties: value: description: The DigitalTwinsModelData objects. type: array items: $ref: '#/definitions/DigitalTwinsModelData' nextLink: description: A URI to retrieve the next page of objects. type: string DomainModelResults: type: object description: Result of image analysis using a specific domain model including additional metadata. properties: result: x-ms-client-flatten: true type: object description: Model-specific response requestId: type: string description: Id of the REST API request. metadata: $ref: '#/definitions/ImageMetadata' ErrorResponseInnerError: description: Detailed error. required: - code - message type: object properties: code: description: Error code. type: string message: description: Error message. type: string innererror: $ref: '#/definitions/ErrorResponseInnerError' State_2: title: State description: The state of a job or item. enum: - notRunning - running - succeeded - canceled - failed - deleted type: string readOnly: true x-ms-enum: name: State modelAsString: true values: - value: notRunning description: The operation was created and is not queued to be processed in the future. - value: running description: The operation has started to be processed. - value: succeeded description: The operation has successfully be processed and is ready for consumption. - value: canceled description: The operation has been canceled and is incomplete. - value: failed description: The operation has completed processing with a failure and cannot be further consumed. - value: deleted description: The entity has been deleted but may still be referenced by other entities predating the deletion. DigitalTwinsModelData: description: A model definition and metadata for that model. required: - id type: object properties: displayName: description: A language map that contains the localized display names as specified in the model definition. type: object additionalProperties: type: string description: description: A language map that contains the localized descriptions as specified in the model definition. type: object additionalProperties: type: string id: description: The id of the model as specified in the model definition. type: string uploadTime: description: The time the model was uploaded to the service. format: date-time type: string decommissioned: description: Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. type: boolean default: false model: description: The model definition. type: object Error: description: Error definition. properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: A human-readable representation of the error. type: string readOnly: true details: description: Internal error details. type: array items: $ref: '#/definitions/Error' readOnly: true innererror: description: An object containing more specific information than the current object about the error. $ref: '#/definitions/InnerError' ErrorResponse: description: Error response. required: - error properties: error: $ref: '#/definitions/Error' description: The error details. ModelEvaluationParameters: description: Parameters for specifying how a model is evaluated. type: object properties: testDatasetName: description: The dataset name used for testing. maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ type: string Capabilities_3: title: Capabilities description: The capabilities of a base or fine tune model. required: - completion - embeddings - fine_tune - inference - scale_types type: object properties: fine_tune: description: A value indicating whether a model can be used for fine tuning. type: boolean inference: description: A value indicating whether a model can be deployed. type: boolean completion: description: A value indicating whether a model supports completion. type: boolean embeddings: description: A value indicating whether a model supports embeddings. type: boolean scale_types: description: The supported scale types for deployments of this model. type: array items: $ref: '#/definitions/ScaleType' ErrorCode: title: ErrorCode description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." enum: - conflict - invalidPayload - forbidden - notFound - unexpectedEntityState - itemDoesAlreadyExist - serviceUnavailable - internalFailure - quotaExceeded type: string x-ms-enum: name: ErrorCode modelAsString: true values: - value: conflict description: The requested operation conflicts with the current resource state. - value: invalidPayload description: The request data is invalid for this operation. - value: forbidden description: The operation is forbidden for the current user/api key. - value: notFound description: The resource is not found. - value: unexpectedEntityState description: The operation cannot be executed in the current resource's state. - value: itemDoesAlreadyExist description: The item does already exist. - value: serviceUnavailable description: The service is currently not available. - value: internalFailure description: Internal error. Please retry. - value: quotaExceeded description: Quota exceeded. ErrorResponseDetails: description: Error info. required: - code - message type: object properties: code: description: Error code. type: string message: description: Error message. type: string target: description: Target of the error. type: string details: description: List of detailed errors. type: array items: $ref: '#/definitions/ErrorResponseDetails' innererror: $ref: '#/definitions/ErrorResponseInnerError' InnerError_2: title: InnerError description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." type: object properties: code: $ref: '#/definitions/InnerErrorCode' innererror: $ref: '#/definitions/InnerError_2' NonPagedDigitalTwinsModelDataCollection: description: A collection of DigitalTwinsModelData objects. type: array items: $ref: '#/definitions/DigitalTwinsModelData' ErrorResponse_4: title: ErrorResponse description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." required: - error type: object properties: error: $ref: '#/definitions/Error_4' ModelEvaluationApiModelCollectionApiModel: description: Contains an array of results that may be paginated. required: - value type: object properties: value: description: The array of results. type: array items: $ref: '#/definitions/ModelEvaluation' nextLink: description: A link to the next set of paginated results, if there are more results available; not present otherwise. type: string InnerErrorCode: title: InnerErrorCode description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." enum: - invalidPayload type: string x-ms-enum: name: InnerErrorCode modelAsString: true values: - value: invalidPayload description: The request data is invalid for this operation. parameters: max-items-per-page: name: max-items-per-page in: header description: The maximum number of items to retrieve per request. The server may choose to return less than the requested number. required: false type: integer x-ms-client-name: MaxItemsPerPage x-ms-parameter-location: method x-ms-parameter-grouping: postfix: Options api-version: name: api-version in: query description: The requested API version. required: true type: string minLength: 1 modelId: name: id in: path description: The id for the model. The id is globally unique and case sensitive. required: true type: string x-ms-parameter-location: method apiVersionQueryParameter_3: in: query name: api-version description: The requested API version. required: true type: string x-ms-client-default: '2022-12-01' x-ms-parameter-location: client ApiVersion: in: query name: api-version description: Requested API version. required: true type: string x-ms-parameter-location: client apiVersionQueryParameter: in: query name: api-version description: The requested API version. required: true type: string default: 2022-03-01-preview x-ms-parameter-location: client ServiceLanguage: name: language in: query description: The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. type: string required: false x-ms-parameter-location: method x-nullable: false default: en enum: - en - es - ja - pt - zh tracestate: name: tracestate in: header description: Provides vendor-specific trace identification information and is a companion to traceparent. required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: postfix: Options traceparent: name: traceparent in: header description: Identifies the request in a distributed tracing system. required: false type: string x-ms-parameter-location: method x-ms-parameter-grouping: postfix: Options includeModelDefinition: name: includeModelDefinition description: When true the model definition will be returned as part of the result. in: query required: false type: boolean default: false x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'