Items - Create ML Experiment

Service:

MLExperiment

API Version:

v1

Creates a machine learning experiment in the specified workspace.

This API supports long running operations (LRO).

This API does not support create an machine learning experiment with definition.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

MLExperiment.ReadWrite.All or Item.ReadWrite.All

Limitations

• To create a machine learning experiment the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types.

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mlExperiments

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Required	Type	Description
displayName	True	string	The machine learning experiment display name. The display name must follow naming rules according to item type.
description		string	The machine learning experiment description. Maximum length is 256 characters.

Responses

Name	Type	Description
201 Created	MLExperiment	Successfully created
202 Accepted		Request accepted, machine learning experiment provisioning in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: InvalidItemType - Item type is invalid. ItemDisplayNameAlreadyInUse - Item display name is already used. CorruptedPayload - The provided payload is corrupted.

Examples

Create a machine learning experiment example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/mlExperiments

{
  "displayName": "MLExperiment_1",
  "description": "A machine learning experiment description"
}

Sample response

Status code:

201

{
  "displayName": "MLExperiment_1",
  "description": "A machine learning experiment description",
  "type": "MLExperiment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Status code:

202

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

Definitions

Name	Description
CreateMLExperimentRequest	Create machine learning experiment request payload.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemType	The type of the item. Additional item types may be added over time.
MLExperiment	A machine learning experiment object.

CreateMLExperimentRequest

Create machine learning experiment request payload.

Name	Type	Description
description	string	The machine learning experiment description. Maximum length is 256 characters.
displayName	string	The machine learning experiment display name. The display name must follow naming rules according to item type.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ItemType

The type of the item. Additional item types may be added over time.

Name	Type	Description
Dashboard	string	PowerBI dashboard.
DataPipeline	string	A data pipeline.
Datamart	string	PowerBI datamart.
Environment	string	An environment.
Eventhouse	string	An eventhouse.
Eventstream	string	An eventstream.
KQLDatabase	string	A KQL database.
KQLQueryset	string	A KQL queryset.
Lakehouse	string	A lakehouse.
MLExperiment	string	A machine learning experiment.
MLModel	string	A machine learning model.
MirroredWarehouse	string	A mirrored warehouse.
Notebook	string	A notebook.
PaginatedReport	string	PowerBI paginated report.
Report	string	PowerBI report.
SQLEndpoint	string	An SQL endpoint.
SemanticModel	string	PowerBI semantic model.
SparkJobDefinition	string	A spark job definition.
Warehouse	string	A warehouse.

MLExperiment

A machine learning experiment object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
id	string	The item ID.
type	ItemType	The item type.
workspaceId	string	The workspace ID.