mirror of
https://github.com/microsoft/fabric-rest-api-specs.git
synced 2026-11-04 12:04:23 +00:00
1206 lines
52 KiB
JSON
1206 lines
52 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "MLModel REST APIs",
|
|
"version": "v1"
|
|
},
|
|
"schemes": [
|
|
"https"
|
|
],
|
|
"host": "api.fabric.microsoft.com",
|
|
"basePath": "/v1",
|
|
"paths": {
|
|
"/workspaces/{workspaceId}/mlModels": {
|
|
"get": {
|
|
"summary": "Returns a list of machine learning models from the specified workspace.",
|
|
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have a *viewer* workspace role. \n\n## Required Delegated Scopes \n\nWorkspace.Read.All or Workspace.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
|
"tags": [
|
|
"Items"
|
|
],
|
|
"operationId": "Items_ListMLModels",
|
|
"x-ms-pageable": {
|
|
"nextLinkName": "continuationUri"
|
|
},
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "recursive",
|
|
"description": "Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed, False - Only items in the folder are listed. The default value is true.",
|
|
"type": "boolean",
|
|
"required": false
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "rootFolderId",
|
|
"description": "This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": false
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "continuationToken",
|
|
"description": "A token for retrieving the next page of results.",
|
|
"type": "string",
|
|
"required": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModels"
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"List machine learning models in workspace example": {
|
|
"$ref": "./examples/ListMLModelsInWorkspace.json"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"summary": "Creates a machine learning model in the specified workspace.",
|
|
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API does not support create an machine learning model with definition.\n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a machine learning model the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
|
"tags": [
|
|
"Items"
|
|
],
|
|
"operationId": "Items_CreateMLModel",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"x-ms-fabric-sdk-long-running-operation": true,
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "createMLModelRequest",
|
|
"description": "Create item request payload.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/CreateMLModelRequest"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Successfully created",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModel"
|
|
}
|
|
},
|
|
"202": {
|
|
"description": "Request accepted, machine learning model provisioning in progress.",
|
|
"headers": {
|
|
"Location": {
|
|
"description": "The URL of the operation status, which can be used to track the operation state.",
|
|
"type": "string"
|
|
},
|
|
"x-ms-operation-id": {
|
|
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* InvalidItemType - Item type is invalid. \n\n* ItemDisplayNameAlreadyInUse - Item display name is already used. \n\n* CorruptedPayload - The provided payload is corrupted. \n\n* WorkspaceItemsLimitExceeded - Workspace item limit exceeded.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Create a machine learning model example": {
|
|
"$ref": "./examples/CreateMLModel.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlModels/{mlModelId}": {
|
|
"get": {
|
|
"summary": "Returns properties of the specified machine learning model.",
|
|
"description": "## Permissions\n\n The caller must have *read* permissions for the ML model. \n\n## Required Delegated Scopes \n\n MLModel.Read.All or MLModel.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
|
"tags": [
|
|
"Items"
|
|
],
|
|
"operationId": "Items_GetMLModel",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "mlModelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModel"
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Get a machine learning model example": {
|
|
"$ref": "./examples/GetMLModel.json"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Updates the properties of the specified machine learning model.",
|
|
"description": "## Permissions\n\n The caller must have *read and write* permissions for the ML model. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- MLModel display name cannot be changed.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
|
"tags": [
|
|
"Items"
|
|
],
|
|
"operationId": "Items_UpdateMLModel",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "mlModelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "updateMLModelRequest",
|
|
"description": "Update machine learning model request payload.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/UpdateMLModelRequest"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModel"
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidRequest - Invalid update request",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Update a machine learning model example": {
|
|
"$ref": "./examples/UpdateMLModel.json"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes the specified machine learning model.",
|
|
"description": "## Permissions\n\n The caller must have *write* permissions for the ML model. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | No |\n\n## Interface",
|
|
"tags": [
|
|
"Items"
|
|
],
|
|
"operationId": "Items_DeleteMLModel",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "mlModelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hardDelete",
|
|
"description": "Specifies whether to perform a hard delete. When set to `true`, the item is permanently deleted and cannot be recovered. When set to `false` or not specified, the item is soft-deleted if the item type supports it.",
|
|
"type": "boolean",
|
|
"required": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully."
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InsufficientWorkspaceRole - User doesn't have sufficient workspace role.\n\n* FeatureNotAvailable - This could be due to the soft deletion feature not being available.\n\n* UnsupportedItemType - This could be due to the soft deletion feature not supported by the requested item type.\n\n* TenantSwitchDisabled - This could be due to the soft deletion feature being disabled by the tenant admin.\n\n* InvalidTargetItemStateForSoftDeletion - The item is in invalid states for soft deletion.\n\n* InvalidParentItemStateForSoftDeletion - The item's parent item is not in Active state.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Delete a machine learning model example": {
|
|
"$ref": "./examples/DeleteMLModel.json"
|
|
},
|
|
"Hard delete a machine learning model example": {
|
|
"$ref": "./examples/HardDeleteMLModel.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlmodels/{modelId}/endpoint": {
|
|
"get": {
|
|
"summary": "Returns properties of the specified machine learning model's endpoint.",
|
|
"description": "## Permissions\n\n The caller must have read permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.Read.All or MLModel.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_GetMLModelEndpoint",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModelEndpoint"
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Could not retrieve endpoint metadata. \n\n* UnknownError - An error occurred.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example of Get ML Model Endpoint": {
|
|
"$ref": "./examples/GetMLModelEndpoint.json"
|
|
},
|
|
"Example of Get ML Model Endpoint with an Activation Failure": {
|
|
"$ref": "./examples/GetMLModelEndpointWithFailureDetails.json"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Updates the default version of the specified model.",
|
|
"description": "## Permissions \n The caller must have write permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_UpdateMLModelEndpoint",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "updateMLModelEndpointRequest",
|
|
"description": "Update MLModel endpoint request payload.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/UpdateMLModelEndpointRequest"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Endpoint updated.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModelEndpoint"
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Version not found. \n\n* UnknownError - An error occurred. \n\n* Conflict - An operation is already is proress. \n\n* BadInput - User Input is invalid.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example of Update ML Model Endpoint": {
|
|
"$ref": "./examples/UpdateMLModelEndpoint.json"
|
|
},
|
|
"Example of Update ML Model Endpoint with an Activation Failure": {
|
|
"$ref": "./examples/UpdateMLModelEndpointWithFailureDetails.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlmodels/{modelId}/endpoint/versions/deactivateAll": {
|
|
"post": {
|
|
"summary": "Deactivates the specified machine learning model and its version's endpoints.",
|
|
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). \n\n ## Permissions \n The caller must have write permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_DeactivateAllMLModelEndpointVersions",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"x-ms-fabric-sdk-long-running-operation": true,
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully."
|
|
},
|
|
"202": {
|
|
"description": "Request accepted, model activation in progress.",
|
|
"headers": {
|
|
"Location": {
|
|
"description": "The URL of the operation status, which can be used to track the operation state.",
|
|
"type": "string"
|
|
},
|
|
"x-ms-operation-id": {
|
|
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* UnknownError - An error occurred. \n\n* Conflict - An operation is already is proress. \n\n* BadInput - User Input is invalid. \n\n* BadInput - User Input is invalid.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example": {
|
|
"$ref": "./examples/DeactivateMLModelEndpoint.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlmodels/{modelId}/endpoint/versions": {
|
|
"get": {
|
|
"summary": "Returns a list of all machine learning model endpoint versions.",
|
|
"description": "This API supports [pagination](/rest/api/fabric/articles/pagination). \n\n## Permissions\n\n The caller must have read permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.Read.All or MLModel.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_ListMLModelEndpointVersions",
|
|
"x-ms-pageable": {
|
|
"nextLinkName": "continuationUri"
|
|
},
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "continuationToken",
|
|
"description": "A token for retrieving the next page of results.",
|
|
"type": "string",
|
|
"required": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModelEndpointVersions"
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Could not retrieve endpoint metadata. \n\n* UnknownError - An error occurred.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example": {
|
|
"$ref": "./examples/ListMLModelEndpointVersions.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlmodels/{modelId}/endpoint/versions/{name}": {
|
|
"get": {
|
|
"summary": "Returns information about the specified MLModel endpoint version.",
|
|
"description": "For machine learning model versions where endpoints have never been enabled, or have been disabled after enabling, the status would be 'deactivated'.\n\n## Permissions\n\n The caller must have read permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.Read.All or MLModel.ReadWrite.All or Item.Read.All or Item.ReadWrite.All\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_GetMLModelEndpointVersion",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"description": "The MLModel version name.",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModelEndpointVersionInfo"
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Could not retrieve endpoint metadata. \n\n* UnknownError - An error occurred.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example of Get ML Model Endpoint Version": {
|
|
"$ref": "./examples/GetMLModelEndpointVersion.json"
|
|
},
|
|
"Example of Get ML Model Endpoint Version with an Activation Failure": {
|
|
"$ref": "./examples/GetMLModelEndpointVersionWithFailureDetails.json"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Update machine learning model endpoint version configuration.",
|
|
"description": "## Permissions \n The caller must have write permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- Only machine learning model endpoint versions which are enabled can be updated.\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_UpdateMLModelEndpointVersion",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"description": "The MLModel version name.",
|
|
"type": "string",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "updateMLModelEndpointVersionRequest",
|
|
"description": "MLModel endpoint configuration update request payload.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/UpdateMLModelEndpointVersionRequest"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Endpoint version configuration details.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/MLModelEndpointVersionInfo"
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Version not found. \n\n* UnknownError - An error occurred. \n\n* Conflict - An operation is already is proress. \n\n* BadInput - User Input is invalid.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example of Update ML Model Endpoint Version": {
|
|
"$ref": "./examples/UpdateMLModelEndpointVersion.json"
|
|
},
|
|
"Example of Update ML Model Endpoint Version with an Activation Failure": {
|
|
"$ref": "./examples/UpdateMLModelEndpointVersionWithFailureDetails.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlmodels/{modelId}/endpoint/versions/{name}/activate": {
|
|
"post": {
|
|
"summary": "Activates the specified model version endpoint.",
|
|
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). \n\n ## Permissions \n The caller must have write permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_ActivateMLModelEndpointVersion",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"x-ms-fabric-sdk-long-running-operation": true,
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"description": "The MLModel version name.",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"202": {
|
|
"description": "Request accepted, model activation in progress.",
|
|
"headers": {
|
|
"Location": {
|
|
"description": "The URL of the operation status, which can be used to track the operation state.",
|
|
"type": "string"
|
|
},
|
|
"x-ms-operation-id": {
|
|
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
}
|
|
},
|
|
"200": {
|
|
"description": "Machine learning model endpoint activation completed successfully."
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Version not found. \n\n* UnknownError - An error occurred. \n\n* Conflict - Model endpoint version is already activating. \n\n* BadInput - User Input is invalid.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example": {
|
|
"$ref": "./examples/ActivateMLModelEndpointVersion.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlmodels/{modelId}/endpoint/versions/{name}/deactivate": {
|
|
"post": {
|
|
"summary": "Deactivates the specified model version version.",
|
|
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). \n\n ## Permissions \n The caller must have write permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_DeactivateMLModelEndpointVersion",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"x-ms-fabric-sdk-long-running-operation": true,
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"description": "The MLModel version name.",
|
|
"type": "string",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Machine learning model endpoint deactivation completed successfully."
|
|
},
|
|
"202": {
|
|
"description": "Request accepted, model activation in progress.",
|
|
"headers": {
|
|
"Location": {
|
|
"description": "The URL of the operation status, which can be used to track the operation state.",
|
|
"type": "string"
|
|
},
|
|
"x-ms-operation-id": {
|
|
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Version not found. \n\n* UnknownError - An error occurred. \n\n* Conflict - Model endpoint version is already deactivating. \n\n* BadInput - User Input is invalid.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example": {
|
|
"$ref": "./examples/DeactivateMLModelEndpointVersion.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlModels/{modelId}/endpoint/score": {
|
|
"post": {
|
|
"summary": "Scores input data using the default version of the endpoint and returns results.",
|
|
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). \n\n ## Permissions \n The caller must have write permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_ScoreMLModelEndpoint",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"x-ms-fabric-sdk-long-running-operation": true,
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "scoreDataRequest",
|
|
"description": "The data to score with the model.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/ScoreDataRequest"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/ScoreDataResponse"
|
|
}
|
|
},
|
|
"202": {
|
|
"description": "Request accepted, scoring in progress.",
|
|
"headers": {
|
|
"Location": {
|
|
"description": "The URL of the operation status, which can be used to track the operation state.",
|
|
"type": "string"
|
|
},
|
|
"x-ms-operation-id": {
|
|
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Version not found. \n\n* UnknownError - An error occurred. \n\n* BadInput - User Input is invalid.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Score data using the default model version": {
|
|
"$ref": "./examples/ScoreMLModelEndpoint.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/workspaces/{workspaceId}/mlmodels/{modelId}/endpoint/versions/{name}/score": {
|
|
"post": {
|
|
"summary": "Scores input data for the specific version of the endpoint and returns results.",
|
|
"description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation). \n\n ## Permissions \n The caller must have write permission on the MLModel. \n\n## Required Delegated Scopes \n\n MLModel.ReadWrite.All or Item.ReadWrite.All \n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
|
|
"tags": [
|
|
"Endpoint"
|
|
],
|
|
"operationId": "Endpoint_ScoreMLModelEndpointVersion",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"x-ms-fabric-sdk-long-running-operation": true,
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "The workspace ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "modelId",
|
|
"description": "The machine learning model ID.",
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"description": "The MLModel version name.",
|
|
"type": "string",
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "scoreDataRequest",
|
|
"description": "The data to score with the model.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/ScoreDataRequest"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Request completed successfully.",
|
|
"schema": {
|
|
"$ref": "./definitions.json#/definitions/ScoreDataResponse"
|
|
}
|
|
},
|
|
"202": {
|
|
"description": "Request accepted, scoring in progress.",
|
|
"headers": {
|
|
"Location": {
|
|
"description": "The URL of the operation status, which can be used to track the operation state.",
|
|
"type": "string"
|
|
},
|
|
"x-ms-operation-id": {
|
|
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
|
|
"type": "string",
|
|
"format": "uuid"
|
|
},
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
}
|
|
},
|
|
"429": {
|
|
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
|
|
"x-ms-error-response": true,
|
|
"headers": {
|
|
"Retry-After": {
|
|
"type": "integer",
|
|
"description": "The number of seconds to wait before retrying the request."
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "Common error codes:\n\n* NotFound - Version not found. \n\n* UnknownError - An error occurred.",
|
|
"schema": {
|
|
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"x-ms-examples": {
|
|
"Example": {
|
|
"$ref": "./examples/ScoreMLModelEndpointVersion.json"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {},
|
|
"security": [],
|
|
"tags": []
|
|
}
|