From aaf668d60c03a515268bbf8e166b6a33fe44dd7a Mon Sep 17 00:00:00 2001 From: Fabric-APIs-Publish-Specification-Pipeline Date: Tue, 15 Jul 2025 22:04:41 +0000 Subject: [PATCH] Updating swagger files. --- mlModel/definitions.json | 555 +++++++++++---- .../ActivateMLModelEndpointVersion.json | 19 + .../examples/DeactivateMLModelEndpoint.json | 18 + .../DeactivateMLModelEndpointVersion.json | 19 + mlModel/examples/GetMLModelEndpoint.json | 78 +++ .../examples/GetMLModelEndpointVersion.json | 75 ++ .../examples/ListMLModelEndpointVersions.json | 82 +++ mlModel/examples/ScoreMLModelEndpoint.json | 69 ++ .../examples/ScoreMLModelEndpointVersion.json | 70 ++ mlModel/examples/UpdateMLModelEndpoint.json | 82 +++ .../UpdateMLModelEndpointVersion.json | 78 +++ mlModel/swagger.json | 650 +++++++++++++++++- platform/definitions/externaldatasharing.json | 2 +- platform/swagger.json | 4 +- 14 files changed, 1679 insertions(+), 122 deletions(-) create mode 100644 mlModel/examples/ActivateMLModelEndpointVersion.json create mode 100644 mlModel/examples/DeactivateMLModelEndpoint.json create mode 100644 mlModel/examples/DeactivateMLModelEndpointVersion.json create mode 100644 mlModel/examples/GetMLModelEndpoint.json create mode 100644 mlModel/examples/GetMLModelEndpointVersion.json create mode 100644 mlModel/examples/ListMLModelEndpointVersions.json create mode 100644 mlModel/examples/ScoreMLModelEndpoint.json create mode 100644 mlModel/examples/ScoreMLModelEndpointVersion.json create mode 100644 mlModel/examples/UpdateMLModelEndpoint.json create mode 100644 mlModel/examples/UpdateMLModelEndpointVersion.json diff --git a/mlModel/definitions.json b/mlModel/definitions.json index efca5e9..77f6a10 100644 --- a/mlModel/definitions.json +++ b/mlModel/definitions.json @@ -1,131 +1,450 @@ { "swagger": "2.0", "info": { - "version": "v1", - "title": "MLModel data types" + "version": "v1", + "title": "MLModel data types" }, "paths": {}, "definitions": { - "MLModels": { - "description": "A list of machine learning models.", + "MLModels": { + "description": "A list of machine learning models.", "required": ["value"], - "type": "object", - "properties": { - "value": { - "description": "A list of machine learning models.", - "type": "array", - "items": { - "$ref": "#/definitions/MLModel" - } - } - }, - "allOf": [ - { - "$ref": "../common/definitions.json#/definitions/PaginatedResponse" - } - ] + "type": "object", + "properties": { + "value": { + "description": "A list of machine learning models.", + "type": "array", + "items": { + "$ref": "#/definitions/MLModel" + } + } }, - "MLModel": { - "description": "A machine learning model object.", - "type": "object", + "allOf": [ + { + "$ref": "../common/definitions.json#/definitions/PaginatedResponse" + } + ] + }, + "MLModel": { + "description": "A machine learning model object.", + "type": "object", "required": ["type"], - "allOf": [ - { - "$ref": "../common/definitions.json#/definitions/Item" - } - ] - }, - "CreateMLModelRequest": { - "description": "Create machine learning model request payload.", + "allOf": [ + { + "$ref": "../common/definitions.json#/definitions/Item" + } + ] + }, + "CreateMLModelRequest": { + "description": "Create machine learning model request payload.", "required": ["displayName"], - "properties": { - "displayName": { - "description": "The machine learning model display name. The display name must follow naming rules according to item type.", - "type": "string", - "readOnly": false - }, - "description": { - "description": "The machine learning model description. Maximum length is 256 characters.", - "type": "string", - "readOnly": false - }, - "folderId": { - "description": "The folder ID. If not specified or null, the machine learning model is created with the workspace as its folder.", - "type": "string", - "format": "uuid", - "readOnly": false - } - } - }, - "UpdateMLModelDefinitionRequest": { - "description": "Update machine learning model public definition request payload.", - "required": ["definition"], - "properties": { - "definition": { - "$ref": "#/definitions/MLModelDefinition" - } - } - }, - "MLModelDefinitionResponse": { - "description": "Machine learning model public definition response.", - "required": ["definition"], - "properties": { - "definition": { - "$ref": "#/definitions/MLModelDefinition", - "readOnly": true - } - } - }, - "MLModelDefinition" : { - "description": "Machine learning model public definition object.", - "type": "object", - "required": ["parts"], - "properties": { - "format": { - "description": "The format of the item definition.", - "type": "string", - "readOnly": false - }, - "parts": { - "description": "A list of definition parts.", - "type": "array", - "items": { - "$ref": "#/definitions/MLModelDefinitionPart" - }, - "readOnly": false - } - } - }, - "MLModelDefinitionPart": { - "description": "Machine learning model definition part object.", - "type": "object", - "properties": { - "path": { - "description": "The machine learning model part path.", - "type": "string", - "readOnly": false - }, - "payload": { - "description": "The machine learning model part payload.", - "type": "string", - "readOnly": false - }, - "payloadType":{ - "description": "The payload type.", - "$ref": "../common/definitions.json#/definitions/PayloadType", - "readOnly": false - } - } - }, - "UpdateMLModelRequest": { - "description": "Update machine learning model request.", - "properties": { - "description": { - "description": "The machine learning model description. Maximum length is 256 characters.", - "type": "string", - "readOnly": false - } - } + "properties": { + "displayName": { + "description": "The machine learning model display name. The display name must follow naming rules according to item type.", + "type": "string", + "readOnly": false + }, + "description": { + "description": "The machine learning model description. Maximum length is 256 characters.", + "type": "string", + "readOnly": false + }, + "folderId": { + "description": "The folder ID. If not specified or null, the machine learning model is created with the workspace as its folder.", + "type": "string", + "format": "uuid", + "readOnly": false + } } + }, + "UpdateMLModelDefinitionRequest": { + "description": "Update machine learning model public definition request payload.", + "required": ["definition"], + "properties": { + "definition": { + "$ref": "#/definitions/MLModelDefinition" + } + } + }, + "MLModelDefinitionResponse": { + "description": "Machine learning model public definition response.", + "required": ["definition"], + "properties": { + "definition": { + "$ref": "#/definitions/MLModelDefinition", + "readOnly": true + } + } + }, + "MLModelDefinition" : { + "description": "Machine learning model public definition object.", + "type": "object", + "required": ["parts"], + "properties": { + "format": { + "description": "The format of the item definition.", + "type": "string", + "readOnly": false + }, + "parts": { + "description": "A list of definition parts.", + "type": "array", + "items": { + "$ref": "#/definitions/MLModelDefinitionPart" + }, + "readOnly": false + } + } + }, + "MLModelDefinitionPart": { + "description": "Machine learning model definition part object.", + "type": "object", + "properties": { + "path": { + "description": "The machine learning model part path.", + "type": "string", + "readOnly": false + }, + "payload": { + "description": "The machine learning model part payload.", + "type": "string", + "readOnly": false + }, + "payloadType":{ + "description": "The payload type.", + "$ref": "../common/definitions.json#/definitions/PayloadType", + "readOnly": false + } + } + }, + "UpdateMLModelRequest": { + "description": "Update machine learning model request.", + "properties": { + "description": { + "description": "The machine learning model description. Maximum length is 256 characters.", + "type": "string", + "readOnly": false + } + } + }, + "MLModelEndpoint": { + "description": "A machine learning model endpoint object.", + "required": [ + "defaultVersionAssignmentBehavior", + "defaultVersionName", + "defaultVersionInfo" + ], + "type": "object", + "properties": { + "defaultVersionAssignmentBehavior": { + "$ref": "#/definitions/EndpointDefaultVersionConfigurationPolicy" + }, + "defaultVersionName": { + "type": "string", + "description": "Default machine learning model endpoint version name." + }, + "defaultVersionInfo": { + "$ref": "#/definitions/MLModelEndpointVersionInfo" + } + } + }, + "EndpointDefaultVersionConfigurationPolicy": { + "type": "string", + "description": "The default version assignment behavior of a given machine learning model endpoint. Additional EndpointDefaultVersionConfigurationPolicy types may be added over time.", + "enum": [ + "StaticallyConfigured", + "NotConfigured" + ], + "x-ms-enum": { + "name": "EndpointDefaultVersionConfigurationPolicy", + "modelAsString": true, + "values": [ + { + "value": "StaticallyConfigured", + "description": "The default version is statically configured." + }, + { + "value": "NotConfigured", + "description": "No default version has been configured." + } + ] + } + }, + "MLModelEndpointVersions": { + "description": "All MLModel Versions Endpoints info.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The information about all versions available as endpoint for this MLModel.", + "items": { + "$ref": "#/definitions/MLModelEndpointVersionInfo" + } + } + }, + "allOf": [ + { + "$ref": "../common/definitions.json#/definitions/PaginatedResponse" + } + ] + }, + "MLModelEndpointVersionInfo": { + "description": "Machine Learning Model Endpoint version information.", + "required": [ + "versionName", + "status" + ], + "type": "object", + "properties": { + "versionName": { + "type": "string", + "description": "The machine learning model version name", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/MLModelEndpointVersionStatus", + "readOnly": true + }, + "inputSignature": { + "type": "array", + "description": "The input signature for this version of the machine learning model.", + "readOnly": true, + "items": { + "$ref": "#/definitions/MLModelDataSchema" + } + }, + "outputSignature": { + "type": "array", + "description": "The output signature for this version of the machine learning model.", + "readOnly": true, + "items": { + "$ref": "#/definitions/MLModelDataSchema" + } + }, + "scaleRule": { + "$ref": "#/definitions/ScaleRule" + } + } + }, + "MLModelDataSchema": { + "description": "Machine learning model data schema.", + "required": [ + "type", + "name", + "required" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the signature." + }, + "name": { + "type": "string", + "description": "The name of the signature." + }, + "required": { + "type": "boolean", + "description": "The boolean value to indicate if the signature is required or no. True - Required, False - Not Required." + } + } + }, + "MLModelEndpointVersionStatus": { + "type": "string", + "description": "The status of a given machine learning model endpoint version. Additional ModelEndpointVersionStatus types may be added over time.", + "enum": [ + "Deactivated", + "Activating", + "Deactivating", + "Active", + "Failed" + ], + "x-ms-enum": { + "name": "ModelEndpointVersionStatus", + "modelAsString": true, + "values": [ + { + "value": "Deactivated", + "description": "All resources are deactivated." + }, + { + "value": "Activating", + "description": "Machine learning model endpoint activation is under progress." + }, + { + "value": "Deactivating", + "description": "Machine learning model endpoint deactivation is in progress." + }, + { + "value": "Active", + "description": "Machine learning model endpoint is available to serve score requests." + }, + { + "value": "Failed", + "description": "Machine learning model endpoint is in failed state." + } + ] + } + }, + "ScoreDataRequest": { + "description": "Machine learning model endpoint request to score the given input data.", + "type": "object", + "required": [ + "inputs" + ], + "properties": { + "formatType": { + "$ref": "#/definitions/FormatType" + }, + "orientation": { + "$ref": "#/definitions/Orientation" + }, + "inputs": { + "type": "array", + "description": "Machine learning inputs to score in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.", + "items": { + "type": "array", + "description": "Machine learning inputs to score in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.", + "items": { + "type": "object", + "description": "Machine learning inputs to score in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans." + } + }, + "readOnly": false + } + } + }, + "ScoreDataResponse": { + "description": "Machine learning model endpoint response to score the given input data.", + "type": "object", + "required": [ + "formatType", + "orientation", + "predictions" + ], + "properties": { + "formatType": { + "$ref": "#/definitions/FormatType" + }, + "orientation": { + "$ref": "#/definitions/Orientation" + }, + "predictions": { + "type": "array", + "description": "Machine learning predictions represented in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.", + "items": { + "type": "array", + "description": "Machine learning predictions represented in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.", + "items": { + "type": "object", + "description": "Machine learning predictions represented in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans." + } + }, + "readOnly": true + } + } + }, + "UpdateMLModelEndpointRequest": { + "description": "Machine learning model endpoint request body to update Model Endpoint properties.", + "type": "object", + "properties": { + "defaultVersionName": { + "description": "Default machine learning model endpoint version name.", + "type": "string", + "readOnly": false + }, + "defaultVersionAssignmentBehavior": { + "$ref": "#/definitions/EndpointDefaultVersionConfigurationPolicy" + } + } + }, + "UpdateMLModelEndpointVersionRequest": { + "description": "Machine learning model endpoint version configuration info.", + "type": "object", + "properties": { + "scaleRule": { + "$ref": "#/definitions/ScaleRule" + } + } + }, + "ScaleRule": { + "description": "Machine learning model endpoint scale rule. Additional ScaleRule types may be added over time.", + "type": "string", + "enum": [ + "AlwaysOn", + "AllowScaleToZero" + ], + "x-ms-enum": { + "name": "ScaleRule", + "modelAsString": true, + "values": [ + { + "value": "AlwaysOn", + "description": "Machine learning model endpoint should be AlwaysOn." + }, + { + "value": "AllowScaleToZero", + "description": "Machine learning model endpoint can be scaled to zero after a period of inactivity." + } + ] + } + }, + "FormatType": { + "type": "string", + "description": "Format type of data. Additional Format types may be added over time.", + "enum": [ + "dataframe" + ], + "x-ms-enum": { + "name": "FormatType", + "modelAsString": true, + "values": [ + { + "value": "dataframe", + "description": "Dataframe format type." + } + ] + } + }, + "Orientation": { + "type": "string", + "description": "Orientation of data. Additional Orientation types may be added over time.", + "enum": [ + "split", + "values", + "record", + "index", + "table" + ], + "x-ms-enum": { + "name": "Orientation", + "modelAsString": true, + "values": [ + { + "value": "split", + "description": "Split orientation." + }, + { + "value": "values", + "description": "Values orientation." + }, + { + "value": "record", + "description": "Record orientation." + }, + { + "value": "index", + "description": "Index orientation." + }, + { + "value": "table", + "description": "Table orientation." + } + ] + } + } } } diff --git a/mlModel/examples/ActivateMLModelEndpointVersion.json b/mlModel/examples/ActivateMLModelEndpointVersion.json new file mode 100644 index 0000000..17afebb --- /dev/null +++ b/mlModel/examples/ActivateMLModelEndpointVersion.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313", + "name": "1" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + }, + "200": { + "description": "Provisioning completed successfully." + } + } +} diff --git a/mlModel/examples/DeactivateMLModelEndpoint.json b/mlModel/examples/DeactivateMLModelEndpoint.json new file mode 100644 index 0000000..78a25d7 --- /dev/null +++ b/mlModel/examples/DeactivateMLModelEndpoint.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313" + }, + "responses": { + "200": { + "description": "Deactivation completed successfully." + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + } + } +} diff --git a/mlModel/examples/DeactivateMLModelEndpointVersion.json b/mlModel/examples/DeactivateMLModelEndpointVersion.json new file mode 100644 index 0000000..2da1060 --- /dev/null +++ b/mlModel/examples/DeactivateMLModelEndpointVersion.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313", + "name": "1" + }, + "responses": { + "200": { + "description": "Deactivation completed successfully." + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + } + } +} diff --git a/mlModel/examples/GetMLModelEndpoint.json b/mlModel/examples/GetMLModelEndpoint.json new file mode 100644 index 0000000..3b3b9a1 --- /dev/null +++ b/mlModel/examples/GetMLModelEndpoint.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313" + }, + "responses": { + "200": { + "body": { + "defaultVersionAssignmentBehavior": "StaticallyConfigured", + "defaultVersionName": "1", + "defaultVersionInfo": { + "versionName": "1", + "status": "Running", + "inputSignature": [ + { + "type": "double", + "name": "age", + "required": true + }, + { + "type": "double", + "name": "sex", + "required": true + }, + { + "type": "double", + "name": "bmi", + "required": true + }, + { + "type": "double", + "name": "bp", + "required": true + }, + { + "type": "double", + "name": "s1", + "required": true + }, + { + "type": "double", + "name": "s2", + "required": true + }, + { + "type": "double", + "name": "s3", + "required": true + }, + { + "type": "double", + "name": "s4", + "required": true + }, + { + "type": "double", + "name": "s5", + "required": true + }, + { + "type": "double", + "name": "s6", + "required": true + } + ], + "outputSignature": [ + { + "type": "double", + "name": "target", + "required": true + } + ], + "scaleRule": "AlwaysOn" + } + } + } + } + } diff --git a/mlModel/examples/GetMLModelEndpointVersion.json b/mlModel/examples/GetMLModelEndpointVersion.json new file mode 100644 index 0000000..a014ed1 --- /dev/null +++ b/mlModel/examples/GetMLModelEndpointVersion.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313", + "name": "1" + }, + "responses": { + "200": { + "body": { + "versionName": "1", + "status": "Running", + "inputSignature": [ + { + "type": "double", + "name": "age", + "required": true + }, + { + "type": "double", + "name": "sex", + "required": true + }, + { + "type": "double", + "name": "bmi", + "required": true + }, + { + "type": "double", + "name": "bp", + "required": true + }, + { + "type": "double", + "name": "s1", + "required": true + }, + { + "type": "double", + "name": "s2", + "required": true + }, + { + "type": "double", + "name": "s3", + "required": true + }, + { + "type": "double", + "name": "s4", + "required": true + }, + { + "type": "double", + "name": "s5", + "required": true + }, + { + "type": "double", + "name": "s6", + "required": true + } + ], + "outputSignature": [ + { + "type": "double", + "name": "target", + "required": true + } + ], + "scaleRule": "AlwaysOn" + } + } + } +} diff --git a/mlModel/examples/ListMLModelEndpointVersions.json b/mlModel/examples/ListMLModelEndpointVersions.json new file mode 100644 index 0000000..f267870 --- /dev/null +++ b/mlModel/examples/ListMLModelEndpointVersions.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "versionName": "1", + "status": "Active", + "inputSignature": [ + { + "type": "double", + "name": "age", + "required": true + }, + { + "type": "double", + "name": "sex", + "required": true + }, + { + "type": "double", + "name": "bmi", + "required": true + }, + { + "type": "double", + "name": "bp", + "required": true + }, + { + "type": "double", + "name": "s1", + "required": true + }, + { + "type": "double", + "name": "s2", + "required": true + }, + { + "type": "double", + "name": "s3", + "required": true + }, + { + "type": "double", + "name": "s4", + "required": true + }, + { + "type": "double", + "name": "s5", + "required": true + }, + { + "type": "double", + "name": "s6", + "required": true + } + ], + "outputSignature": [ + { + "type": "double", + "name": "target", + "required": true + } + ], + "scaleRule": "AlwaysOn" + }, + { + "versionName": "2", + "status": "Deactivated" + } + ] + } + } + } +} diff --git a/mlModel/examples/ScoreMLModelEndpoint.json b/mlModel/examples/ScoreMLModelEndpoint.json new file mode 100644 index 0000000..4d4daad --- /dev/null +++ b/mlModel/examples/ScoreMLModelEndpoint.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313", + "scoreDataRequest": { + "formatType": "dataframe", + "orientation": "values", + "inputs": [ + [ -0.00188201652779, -0.04464163650698, -0.05147406123880, -0.0263275281478529, -0.00844872411121, -0.01916333974822, 0.07441156407875721, -0.03949338287409329, -0.0683315470939731, -0.092204049626824 ], + [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 0 ], + [ 11, 2, 3, 4, 5, 6, 77, 8, 9, 0 ], + [ 1, 22, 3, 47, 5, 6, 7, 0, 9, 0 ], + [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 0 ], + [ 1, 2, 3, 4, 5, 86, 7, 8, 9, 0 ], + [ 1, 25, 3, 4, 5, 6, 7, 98, 9, 0 ], + [ 1, 2, 3, 4, 5, 6, 7, 8, 99, 0 ], + [ 1, 205, 3, 4, 5, 96, 7, 8, 9, 0 ], + [ 1, 2, 35, 4, 5, 6, 7, 18, 19, 0 ] + ] + } + }, + "responses": { + "200": { + "body": { + "formatType": "dataframe", + "orientation": "values", + "predictions": [ + [ + 72.0 + ], + [ + 248.0 + ], + [ + 87.0 + ], + [ + 217.0 + ], + [ + 248.0 + ], + [ + 84.0 + ], + [ + 248.0 + ], + [ + 220.0 + ], + [ + 139.0 + ], + [ + 242.0 + ] + ] + } + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + } + } +} diff --git a/mlModel/examples/ScoreMLModelEndpointVersion.json b/mlModel/examples/ScoreMLModelEndpointVersion.json new file mode 100644 index 0000000..9eb01be --- /dev/null +++ b/mlModel/examples/ScoreMLModelEndpointVersion.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313", + "name": "1", + "scoreDataRequest": { + "formatType": "dataframe", + "orientation": "values", + "inputs": [ + [ -0.00188201652779, -0.04464163650698, -0.05147406123880, -0.0263275281478529, -0.00844872411121, -0.01916333974822, 0.07441156407875721, -0.03949338287409329, -0.0683315470939731, -0.092204049626824 ], + [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 0 ], + [ 11, 2, 3, 4, 5, 6, 77, 8, 9, 0 ], + [ 1, 22, 3, 47, 5, 6, 7, 0, 9, 0 ], + [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 0 ], + [ 1, 2, 3, 4, 5, 86, 7, 8, 9, 0 ], + [ 1, 25, 3, 4, 5, 6, 7, 98, 9, 0 ], + [ 1, 2, 3, 4, 5, 6, 7, 8, 99, 0 ], + [ 1, 205, 3, 4, 5, 96, 7, 8, 9, 0 ], + [ 1, 2, 35, 4, 5, 6, 7, 18, 19, 0 ] + ] + } + }, + "responses": { + "200": { + "body": { + "formatType": "dataframe", + "orientation": "values", + "predictions": [ + [ + 72.0 + ], + [ + 248.0 + ], + [ + 87.0 + ], + [ + 217.0 + ], + [ + 248.0 + ], + [ + 84.0 + ], + [ + 248.0 + ], + [ + 220.0 + ], + [ + 139.0 + ], + [ + 242.0 + ] + ] + } + }, + "202": { + "headers": { + "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6", + "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6", + "Retry-After": 30 + } + } + } +} diff --git a/mlModel/examples/UpdateMLModelEndpoint.json b/mlModel/examples/UpdateMLModelEndpoint.json new file mode 100644 index 0000000..fc746c8 --- /dev/null +++ b/mlModel/examples/UpdateMLModelEndpoint.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313", + "updateMLModelEndpointRequest": { + "defaultVersionAssignmentBehavior": "StaticallyConfigured", + "defaultVersionName": "1" + } + }, + "responses": { + "200": { + "body": { + "defaultVersionAssignmentBehavior": "StaticallyConfigured", + "defaultVersionName": "1", + "defaultVersionInfo": { + "versionName": "1", + "status": "Running", + "inputSignature": [ + { + "type": "double", + "name": "age", + "required": true + }, + { + "type": "double", + "name": "sex", + "required": true + }, + { + "type": "double", + "name": "bmi", + "required": true + }, + { + "type": "double", + "name": "bp", + "required": true + }, + { + "type": "double", + "name": "s1", + "required": true + }, + { + "type": "double", + "name": "s2", + "required": true + }, + { + "type": "double", + "name": "s3", + "required": true + }, + { + "type": "double", + "name": "s4", + "required": true + }, + { + "type": "double", + "name": "s5", + "required": true + }, + { + "type": "double", + "name": "s6", + "required": true + } + ], + "outputSignature": [ + { + "type": "double", + "name": "target", + "required": true + } + ], + "scaleRule": "AlwaysOn" + } + } + } + } +} diff --git a/mlModel/examples/UpdateMLModelEndpointVersion.json b/mlModel/examples/UpdateMLModelEndpointVersion.json new file mode 100644 index 0000000..42c2965 --- /dev/null +++ b/mlModel/examples/UpdateMLModelEndpointVersion.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "workspaceId": "cf5fef71-f7f3-43f3-ae7f-3c427922bef1", + "modelId": "7e92a6fc-3ef5-40bf-96df-ddae3fcde313", + "name": "1", + "updateMLModelEndpointVersionRequest": { + "scaleRule": "AllowScaleToZero" + } + }, + "responses": { + "200": { + "body": { + "versionName": "1", + "status": "Running", + "inputSignature": [ + { + "type": "double", + "name": "age", + "required": true + }, + { + "type": "double", + "name": "sex", + "required": true + }, + { + "type": "double", + "name": "bmi", + "required": true + }, + { + "type": "double", + "name": "bp", + "required": true + }, + { + "type": "double", + "name": "s1", + "required": true + }, + { + "type": "double", + "name": "s2", + "required": true + }, + { + "type": "double", + "name": "s3", + "required": true + }, + { + "type": "double", + "name": "s4", + "required": true + }, + { + "type": "double", + "name": "s5", + "required": true + }, + { + "type": "double", + "name": "s6", + "required": true + } + ], + "outputSignature": [ + { + "type": "double", + "name": "target", + "required": true + } + ], + "scaleRule": "AllowScaleToZero" + } + } + } +} diff --git a/mlModel/swagger.json b/mlModel/swagger.json index f34b085..b6c0c75 100644 --- a/mlModel/swagger.json +++ b/mlModel/swagger.json @@ -287,9 +287,657 @@ } } } + }, + "/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" + } + }, + "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/GetMLModelEndpoint.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" + } + }, + "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": { + "$ref": "./examples/UpdateMLModelEndpoint.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." + } + } + }, + "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" + } + }, + "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" + } + }, + "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/GetMLModelEndpointVersion.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" + } + }, + "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": { + "$ref": "./examples/UpdateMLModelEndpointVersion.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." + }, + "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." + } + } + }, + "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." + } + } + }, + "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." + } + } + }, + "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": [] -} \ No newline at end of file +} diff --git a/platform/definitions/externaldatasharing.json b/platform/definitions/externaldatasharing.json index 7d7bf98..38885ae 100644 --- a/platform/definitions/externaldatasharing.json +++ b/platform/definitions/externaldatasharing.json @@ -13,7 +13,7 @@ "properties": { "paths": { "type": "array", - "description": "The path or list of paths that are to be externally shared. You can share up to 100 paths in each share. A valid path to an external data share must start with \"Files/\" or \"Tables/\". You can't share the root folder itself (Files or Tables).\n\nFor example, these paths are valid:\n\n* \"Files/MyFolder1\"\n\n* \"Tables/MyTable1\"", + "description": "The path or list of paths that are to be externally shared. You can share up to 100 paths in each share. A valid path to an external data share must start with \"Files/\" or \"Tables/\". You can't share the root folder itself (Files or Tables).\n\nFor example, these paths are valid:\n\n* \"Files/MyFolder1\"\n\n* \"Tables/MySchema\"\n\n* \"Tables/MyTable1\"", "items": { "type": "string" }, diff --git a/platform/swagger.json b/platform/swagger.json index 796a54c..8e43b8f 100644 --- a/platform/swagger.json +++ b/platform/swagger.json @@ -1823,7 +1823,7 @@ "/workspaces/{workspaceId}/git/initializeConnection": { "post": { "summary": "Initialize a connection for a workspace that's connected to Git.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo use this API, the caller's Git credentials must be configured using [Update My Git Credentials](/rest/api/fabric/core/git/update-my-git-credentials) API. You can use the [Get My Git Credentials](/rest/api/fabric/core/git/get-my-git-credentials) API to check the Git credentials configuration.\n\nThis API should be called after a successful call to the [Connect](/rest/api/fabric/core/git/connect) API. To complete a full sync of the workspace, use the [Required Action](initialize-connection#requiredaction) operation to call the relevant sync operation, either [Commit To Git](/rest/api/fabric/core/git/commit-to-git) or [Update From Git](/rest/api/fabric/core/git/update-from-git).\n\n## Permissions\n\nThe caller must have an *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.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) |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nTo use this API, the caller's Git credentials must be configured using [Update My Git Credentials](/rest/api/fabric/core/git/update-my-git-credentials) API. You can use the [Get My Git Credentials](/rest/api/fabric/core/git/get-my-git-credentials) API to check the Git credentials configuration.\n\nThis API should be called after a successful call to the [Connect](/rest/api/fabric/core/git/connect) API. To complete a full sync of the workspace, use the [Required Action](initialize-connection#requiredaction) operation to call the relevant sync operation, either [Commit To Git](/rest/api/fabric/core/git/commit-to-git) or [Update From Git](/rest/api/fabric/core/git/update-from-git).\n\n## Permissions\n\nThe caller must have an *admin* workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.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": [ "Git" ], @@ -1965,7 +1965,7 @@ "/workspaces/{workspaceId}/git/status": { "get": { "summary": "Returns the `Git status` of items in the workspace, that can be committed to Git.", - "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nThe status indicates changes to items since the last workspace and remote branch sync. If the remote and workspace items were both modified, the API flags a conflict.\n\nTo use this API, the caller's Git credentials must be configured using [Update My Git Credentials](/rest/api/fabric/core/git/update-my-git-credentials) API. You can use the [Get My Git Credentials](/rest/api/fabric/core/git/get-my-git-credentials) API to check the Git credentials configuration.\n\n## Permissions\n\nThe caller must have a *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.GitUpdate.All or Workspace.GitCommit.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) |\n\n## Interface", + "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nThe status indicates changes to items since the last workspace and remote branch sync. If the remote and workspace items were both modified, the API flags a conflict.\n\nTo use this API, the caller's Git credentials must be configured using [Update My Git Credentials](/rest/api/fabric/core/git/update-my-git-credentials) API. You can use the [Get My Git Credentials](/rest/api/fabric/core/git/get-my-git-credentials) API to check the Git credentials configuration.\n\n## Permissions\n\nThe caller must have a *contributor* or higher workspace role.\n\n## Required Delegated Scopes\n\nWorkspace.GitUpdate.All or Workspace.GitCommit.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": [ "Git" ],