Machine Learning

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.ml module.

class databricks.sdk.service.ml.Activity

Activity recorded for the action.

activity_type: ActivityType | None = None

Type of activity. Valid values are: * APPLIED_TRANSITION: User applied the corresponding stage transition.

• REQUESTED_TRANSITION: User requested the corresponding stage transition.

• CANCELLED_REQUEST: User cancelled an existing transition request.

• APPROVED_REQUEST: User approved the corresponding stage transition.

• REJECTED_REQUEST: User rejected the coressponding stage transition.

• SYSTEM_TRANSITION: For events performed as a side effect, such as archiving existing model

versions in a stage.

comment: str | None = None

User-provided comment associated with the activity.

creation_timestamp: int | None = None

Creation time of the object, as a Unix timestamp in milliseconds.

from_stage: Stage | None = None

Source stage of the transition (if the activity is stage transition related). Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

id: str | None = None

Unique identifier for the object.

last_updated_timestamp: int | None = None

Time of the object at last update, as a Unix timestamp in milliseconds.

system_comment: str | None = None

Comment made by system, for example explaining an activity of type SYSTEM_TRANSITION. It usually describes a side effect, such as a version being archived as part of another version’s stage transition, and may not be returned for some activity types.

to_stage: Stage | None = None

Target stage of the transition (if the activity is stage transition related). Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

user_id: str | None = None

The username of the user that created the object.

as_dict() → dict

Serializes the Activity into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Activity

Deserializes the Activity from a dictionary.

class databricks.sdk.service.ml.ActivityAction

An action that a user (with sufficient permissions) could take on an activity. Valid values are: * APPROVE_TRANSITION_REQUEST: Approve a transition request * REJECT_TRANSITION_REQUEST: Reject a transition request * CANCEL_TRANSITION_REQUEST: Cancel (delete) a transition request

APPROVE_TRANSITION_REQUEST = "APPROVE_TRANSITION_REQUEST"

CANCEL_TRANSITION_REQUEST = "CANCEL_TRANSITION_REQUEST"

REJECT_TRANSITION_REQUEST = "REJECT_TRANSITION_REQUEST"

class databricks.sdk.service.ml.ActivityType

Type of activity. Valid values are: * APPLIED_TRANSITION: User applied the corresponding stage transition. * REQUESTED_TRANSITION: User requested the corresponding stage transition. * CANCELLED_REQUEST: User cancelled an existing transition request. * APPROVED_REQUEST: User approved the corresponding stage transition. * REJECTED_REQUEST: User rejected the coressponding stage transition. * SYSTEM_TRANSITION: For events performed as a side effect, such as archiving existing model versions in a stage.

APPLIED_TRANSITION = "APPLIED_TRANSITION"

APPROVED_REQUEST = "APPROVED_REQUEST"

CANCELLED_REQUEST = "CANCELLED_REQUEST"

NEW_COMMENT = "NEW_COMMENT"

REJECTED_REQUEST = "REJECTED_REQUEST"

REQUESTED_TRANSITION = "REQUESTED_TRANSITION"

SYSTEM_TRANSITION = "SYSTEM_TRANSITION"

class databricks.sdk.service.ml.ApproveTransitionRequest

name: str

Name of the model.

version: str

Version of the model.

stage: Stage

Target stage of the transition. Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

archive_existing_versions: bool

Specifies whether to archive all current model versions in the target stage.

comment: str | None = None

User-provided comment on the action.

as_dict() → dict

Serializes the ApproveTransitionRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ApproveTransitionRequest

Deserializes the ApproveTransitionRequest from a dictionary.

class databricks.sdk.service.ml.ApproveTransitionRequestResponse

activity: Activity | None = None

Activity recorded for the action.

as_dict() → dict

Serializes the ApproveTransitionRequestResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ApproveTransitionRequestResponse

Deserializes the ApproveTransitionRequestResponse from a dictionary.

class databricks.sdk.service.ml.CommentActivityAction

An action that a user (with sufficient permissions) could take on a comment. Valid values are: * EDIT_COMMENT: Edit the comment * DELETE_COMMENT: Delete the comment

DELETE_COMMENT = "DELETE_COMMENT"

EDIT_COMMENT = "EDIT_COMMENT"

class databricks.sdk.service.ml.CommentObject

Comment details.

available_actions: List[CommentActivityAction] | None = None

Array of actions on the activity allowed for the current viewer.

comment: str | None = None

User-provided comment on the action.

creation_timestamp: int | None = None

Creation time of the object, as a Unix timestamp in milliseconds.

id: str | None = None

Comment ID

last_updated_timestamp: int | None = None

Time of the object at last update, as a Unix timestamp in milliseconds.

user_id: str | None = None

The username of the user that created the object.

as_dict() → dict

Serializes the CommentObject into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CommentObject

Deserializes the CommentObject from a dictionary.

class databricks.sdk.service.ml.CreateComment

name: str

Name of the model.

version: str

Version of the model.

comment: str

User-provided comment on the action.

as_dict() → dict

Serializes the CreateComment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateComment

Deserializes the CreateComment from a dictionary.

class databricks.sdk.service.ml.CreateCommentResponse

comment: CommentObject | None = None

Comment details.

as_dict() → dict

Serializes the CreateCommentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateCommentResponse

Deserializes the CreateCommentResponse from a dictionary.

class databricks.sdk.service.ml.CreateExperiment

name: str

Experiment name.

artifact_location: str | None = None

Location where all artifacts for the experiment are stored. If not provided, the remote server will select an appropriate default.

tags: List[ExperimentTag] | None = None

A collection of tags to set on the experiment. Maximum tag size and number of tags per request depends on the storage backend. All storage backends are guaranteed to support tag keys up to 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also guaranteed to support up to 20 tags per request.

as_dict() → dict

Serializes the CreateExperiment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateExperiment

Deserializes the CreateExperiment from a dictionary.

class databricks.sdk.service.ml.CreateExperimentResponse

experiment_id: str | None = None

Unique identifier for the experiment.

as_dict() → dict

Serializes the CreateExperimentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateExperimentResponse

Deserializes the CreateExperimentResponse from a dictionary.

class databricks.sdk.service.ml.CreateModelRequest

name: str

Register models under this name

description: str | None = None

Optional description for registered model.

tags: List[ModelTag] | None = None

Additional metadata for registered model.

as_dict() → dict

Serializes the CreateModelRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateModelRequest

Deserializes the CreateModelRequest from a dictionary.

class databricks.sdk.service.ml.CreateModelResponse

registered_model: Model | None = None

as_dict() → dict

Serializes the CreateModelResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateModelResponse

Deserializes the CreateModelResponse from a dictionary.

class databricks.sdk.service.ml.CreateModelVersionRequest

name: str

Register model under this name

source: str

URI indicating the location of the model artifacts.

description: str | None = None

Optional description for model version.

run_id: str | None = None

MLflow run ID for correlation, if source was generated by an experiment run in MLflow tracking server

run_link: str | None = None

MLflow run link - this is the exact link of the run that generated this model version, potentially hosted at another instance of MLflow.

tags: List[ModelVersionTag] | None = None

Additional metadata for model version.

as_dict() → dict

Serializes the CreateModelVersionRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateModelVersionRequest

Deserializes the CreateModelVersionRequest from a dictionary.

class databricks.sdk.service.ml.CreateModelVersionResponse

model_version: ModelVersion | None = None

Return new version number generated for this model in registry.

as_dict() → dict

Serializes the CreateModelVersionResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateModelVersionResponse

Deserializes the CreateModelVersionResponse from a dictionary.

class databricks.sdk.service.ml.CreateRegistryWebhook

events: List[RegistryWebhookEvent]

Events that can trigger a registry webhook: * MODEL_VERSION_CREATED: A new model version was created for the associated model.

• MODEL_VERSION_TRANSITIONED_STAGE: A model version’s stage was changed.

• TRANSITION_REQUEST_CREATED: A user requested a model version’s stage be transitioned.

• COMMENT_CREATED: A user wrote a comment on a registered model.

• REGISTERED_MODEL_CREATED: A new registered model was created. This event type can only be

specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.

• MODEL_VERSION_TAG_SET: A user set a tag on the model version.

• MODEL_VERSION_TRANSITIONED_TO_STAGING: A model version was transitioned to staging.

• MODEL_VERSION_TRANSITIONED_TO_PRODUCTION: A model version was transitioned to production.

• MODEL_VERSION_TRANSITIONED_TO_ARCHIVED: A model version was archived.

• TRANSITION_REQUEST_TO_STAGING_CREATED: A user requested a model version be transitioned to

staging.

• TRANSITION_REQUEST_TO_PRODUCTION_CREATED: A user requested a model version be transitioned

to production.

• TRANSITION_REQUEST_TO_ARCHIVED_CREATED: A user requested a model version be archived.

description: str | None = None

User-specified description for the webhook.

http_url_spec: HttpUrlSpec | None = None

job_spec: JobSpec | None = None

model_name: str | None = None

Name of the model whose events would trigger this webhook.

status: RegistryWebhookStatus | None = None

Enable or disable triggering the webhook, or put the webhook into test mode. The default is ACTIVE: * ACTIVE: Webhook is triggered when an associated event happens.

• DISABLED: Webhook is not triggered.

• TEST_MODE: Webhook can be triggered through the test endpoint, but is not triggered on a

real event.

as_dict() → dict

Serializes the CreateRegistryWebhook into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateRegistryWebhook

Deserializes the CreateRegistryWebhook from a dictionary.

class databricks.sdk.service.ml.CreateRun

experiment_id: str | None = None

ID of the associated experiment.

start_time: int | None = None

Unix timestamp in milliseconds of when the run started.

tags: List[RunTag] | None = None

Additional metadata for run.

user_id: str | None = None

ID of the user executing the run. This field is deprecated as of MLflow 1.0, and will be removed in a future MLflow release. Use ‘mlflow.user’ tag instead.

as_dict() → dict

Serializes the CreateRun into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateRun

Deserializes the CreateRun from a dictionary.

class databricks.sdk.service.ml.CreateRunResponse

run: Run | None = None

The newly created run.

as_dict() → dict

Serializes the CreateRunResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateRunResponse

Deserializes the CreateRunResponse from a dictionary.

class databricks.sdk.service.ml.CreateTransitionRequest

name: str

Name of the model.

version: str

Version of the model.

stage: Stage

Target stage of the transition. Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

comment: str | None = None

User-provided comment on the action.

as_dict() → dict

Serializes the CreateTransitionRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateTransitionRequest

Deserializes the CreateTransitionRequest from a dictionary.

class databricks.sdk.service.ml.CreateTransitionRequestResponse

request: TransitionRequest | None = None

Transition request details.

as_dict() → dict

Serializes the CreateTransitionRequestResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateTransitionRequestResponse

Deserializes the CreateTransitionRequestResponse from a dictionary.

class databricks.sdk.service.ml.CreateWebhookResponse

webhook: RegistryWebhook | None = None

as_dict() → dict

Serializes the CreateWebhookResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateWebhookResponse

Deserializes the CreateWebhookResponse from a dictionary.

class databricks.sdk.service.ml.Dataset

digest: str | None = None

Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies it within datasets of the same name.

name: str | None = None

The name of the dataset. E.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”

profile: str | None = None

The profile of the dataset. Summary statistics for the dataset, such as the number of rows in a table, the mean / std / mode of each column in a table, or the number of elements in an array.

schema: str | None = None

The schema of the dataset. E.g., MLflow ColSpec JSON for a dataframe, MLflow TensorSpec JSON for an ndarray, or another schema format.

source: str | None = None

The type of the dataset source, e.g. ‘databricks-uc-table’, ‘DBFS’, ‘S3’, …

source_type: str | None = None

Source information for the dataset. Note that the source may not exactly reproduce the dataset if it was transformed / modified before use with MLflow.

as_dict() → dict

Serializes the Dataset into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Dataset

Deserializes the Dataset from a dictionary.

class databricks.sdk.service.ml.DatasetInput

dataset: Dataset | None = None

The dataset being used as a Run input.

tags: List[InputTag] | None = None

A list of tags for the dataset input, e.g. a “context” tag with value “training”

as_dict() → dict

Serializes the DatasetInput into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DatasetInput

Deserializes the DatasetInput from a dictionary.

class databricks.sdk.service.ml.DeleteCommentResponse

as_dict() → dict

Serializes the DeleteCommentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteCommentResponse

Deserializes the DeleteCommentResponse from a dictionary.

class databricks.sdk.service.ml.DeleteExperiment

experiment_id: str

ID of the associated experiment.

as_dict() → dict

Serializes the DeleteExperiment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteExperiment

Deserializes the DeleteExperiment from a dictionary.

class databricks.sdk.service.ml.DeleteExperimentResponse

as_dict() → dict

Serializes the DeleteExperimentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteExperimentResponse

Deserializes the DeleteExperimentResponse from a dictionary.

class databricks.sdk.service.ml.DeleteModelResponse

as_dict() → dict

Serializes the DeleteModelResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteModelResponse

Deserializes the DeleteModelResponse from a dictionary.

class databricks.sdk.service.ml.DeleteModelTagResponse

as_dict() → dict

Serializes the DeleteModelTagResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteModelTagResponse

Deserializes the DeleteModelTagResponse from a dictionary.

class databricks.sdk.service.ml.DeleteModelVersionResponse

as_dict() → dict

Serializes the DeleteModelVersionResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteModelVersionResponse

Deserializes the DeleteModelVersionResponse from a dictionary.

class databricks.sdk.service.ml.DeleteModelVersionTagResponse

as_dict() → dict

Serializes the DeleteModelVersionTagResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteModelVersionTagResponse

Deserializes the DeleteModelVersionTagResponse from a dictionary.

class databricks.sdk.service.ml.DeleteRun

run_id: str

ID of the run to delete.

as_dict() → dict

Serializes the DeleteRun into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteRun

Deserializes the DeleteRun from a dictionary.

class databricks.sdk.service.ml.DeleteRunResponse

as_dict() → dict

Serializes the DeleteRunResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteRunResponse

Deserializes the DeleteRunResponse from a dictionary.

class databricks.sdk.service.ml.DeleteRuns

experiment_id: str

The ID of the experiment containing the runs to delete.

max_timestamp_millis: int

The maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to or at this timestamp are deleted.

max_runs: int | None = None

An optional positive integer indicating the maximum number of runs to delete. The maximum allowed value for max_runs is 10000.

as_dict() → dict

Serializes the DeleteRuns into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteRuns

Deserializes the DeleteRuns from a dictionary.

class databricks.sdk.service.ml.DeleteRunsResponse

runs_deleted: int | None = None

The number of runs deleted.

as_dict() → dict

Serializes the DeleteRunsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteRunsResponse

Deserializes the DeleteRunsResponse from a dictionary.

class databricks.sdk.service.ml.DeleteTag

run_id: str

ID of the run that the tag was logged under. Must be provided.

key: str

Name of the tag. Maximum size is 255 bytes. Must be provided.

as_dict() → dict

Serializes the DeleteTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteTag

Deserializes the DeleteTag from a dictionary.

class databricks.sdk.service.ml.DeleteTagResponse

as_dict() → dict

Serializes the DeleteTagResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteTagResponse

Deserializes the DeleteTagResponse from a dictionary.

class databricks.sdk.service.ml.DeleteTransitionRequestResponse

as_dict() → dict

Serializes the DeleteTransitionRequestResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteTransitionRequestResponse

Deserializes the DeleteTransitionRequestResponse from a dictionary.

class databricks.sdk.service.ml.DeleteTransitionRequestStage

ARCHIVED = "ARCHIVED"

NONE = "NONE"

PRODUCTION = "PRODUCTION"

STAGING = "STAGING"

class databricks.sdk.service.ml.DeleteWebhookResponse

as_dict() → dict

Serializes the DeleteWebhookResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteWebhookResponse

Deserializes the DeleteWebhookResponse from a dictionary.

class databricks.sdk.service.ml.Experiment

artifact_location: str | None = None

Location where artifacts for the experiment are stored.

creation_time: int | None = None

Creation time

experiment_id: str | None = None

Unique identifier for the experiment.

last_update_time: int | None = None

Last update time

lifecycle_stage: str | None = None

Current life cycle stage of the experiment: “active” or “deleted”. Deleted experiments are not returned by APIs.

name: str | None = None

Human readable name that identifies the experiment.

tags: List[ExperimentTag] | None = None

Tags: Additional metadata key-value pairs.

as_dict() → dict

Serializes the Experiment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Experiment

Deserializes the Experiment from a dictionary.

class databricks.sdk.service.ml.ExperimentAccessControlRequest

group_name: str | None = None

name of the group

permission_level: ExperimentPermissionLevel | None = None

Permission level

service_principal_name: str | None = None

application ID of a service principal

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the ExperimentAccessControlRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExperimentAccessControlRequest

Deserializes the ExperimentAccessControlRequest from a dictionary.

class databricks.sdk.service.ml.ExperimentAccessControlResponse

all_permissions: List[ExperimentPermission] | None = None

All permissions.

display_name: str | None = None

Display name of the user or service principal.

group_name: str | None = None

name of the group

service_principal_name: str | None = None

Name of the service principal.

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the ExperimentAccessControlResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExperimentAccessControlResponse

Deserializes the ExperimentAccessControlResponse from a dictionary.

class databricks.sdk.service.ml.ExperimentPermission

inherited: bool | None = None

inherited_from_object: List[str] | None = None

permission_level: ExperimentPermissionLevel | None = None

Permission level

as_dict() → dict

Serializes the ExperimentPermission into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExperimentPermission

Deserializes the ExperimentPermission from a dictionary.

class databricks.sdk.service.ml.ExperimentPermissionLevel

Permission level

CAN_EDIT = "CAN_EDIT"

CAN_MANAGE = "CAN_MANAGE"

CAN_READ = "CAN_READ"

class databricks.sdk.service.ml.ExperimentPermissions

access_control_list: List[ExperimentAccessControlResponse] | None = None

object_id: str | None = None

object_type: str | None = None

as_dict() → dict

Serializes the ExperimentPermissions into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExperimentPermissions

Deserializes the ExperimentPermissions from a dictionary.

class databricks.sdk.service.ml.ExperimentPermissionsDescription

description: str | None = None

permission_level: ExperimentPermissionLevel | None = None

Permission level

as_dict() → dict

Serializes the ExperimentPermissionsDescription into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExperimentPermissionsDescription

Deserializes the ExperimentPermissionsDescription from a dictionary.

class databricks.sdk.service.ml.ExperimentPermissionsRequest

access_control_list: List[ExperimentAccessControlRequest] | None = None

experiment_id: str | None = None

The experiment for which to get or manage permissions.

as_dict() → dict

Serializes the ExperimentPermissionsRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExperimentPermissionsRequest

Deserializes the ExperimentPermissionsRequest from a dictionary.

class databricks.sdk.service.ml.ExperimentTag

key: str | None = None

The tag key.

value: str | None = None

The tag value.

as_dict() → dict

Serializes the ExperimentTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExperimentTag

Deserializes the ExperimentTag from a dictionary.

class databricks.sdk.service.ml.FileInfo

file_size: int | None = None

Size in bytes. Unset for directories.

is_dir: bool | None = None

Whether the path is a directory.

path: str | None = None

Path relative to the root artifact directory run.

as_dict() → dict

Serializes the FileInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FileInfo

Deserializes the FileInfo from a dictionary.

class databricks.sdk.service.ml.GetExperimentPermissionLevelsResponse

permission_levels: List[ExperimentPermissionsDescription] | None = None

Specific permission levels

as_dict() → dict

Serializes the GetExperimentPermissionLevelsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetExperimentPermissionLevelsResponse

Deserializes the GetExperimentPermissionLevelsResponse from a dictionary.

class databricks.sdk.service.ml.GetExperimentResponse

experiment: Experiment | None = None

Experiment details.

as_dict() → dict

Serializes the GetExperimentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetExperimentResponse

Deserializes the GetExperimentResponse from a dictionary.

class databricks.sdk.service.ml.GetLatestVersionsRequest

name: str

Registered model unique name identifier.

stages: List[str] | None = None

List of stages.

as_dict() → dict

Serializes the GetLatestVersionsRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetLatestVersionsRequest

Deserializes the GetLatestVersionsRequest from a dictionary.

class databricks.sdk.service.ml.GetLatestVersionsResponse

model_versions: List[ModelVersion] | None = None

Latest version models for each requests stage. Only return models with current READY status. If no stages provided, returns the latest version for each stage, including “None”.

as_dict() → dict

Serializes the GetLatestVersionsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetLatestVersionsResponse

Deserializes the GetLatestVersionsResponse from a dictionary.

class databricks.sdk.service.ml.GetMetricHistoryResponse

metrics: List[Metric] | None = None

All logged values for this metric.

next_page_token: str | None = None

Token that can be used to retrieve the next page of metric history results

as_dict() → dict

Serializes the GetMetricHistoryResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetMetricHistoryResponse

Deserializes the GetMetricHistoryResponse from a dictionary.

class databricks.sdk.service.ml.GetModelResponse

registered_model_databricks: ModelDatabricks | None = None

as_dict() → dict

Serializes the GetModelResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetModelResponse

Deserializes the GetModelResponse from a dictionary.

class databricks.sdk.service.ml.GetModelVersionDownloadUriResponse

artifact_uri: str | None = None

URI corresponding to where artifacts for this model version are stored.

as_dict() → dict

Serializes the GetModelVersionDownloadUriResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetModelVersionDownloadUriResponse

Deserializes the GetModelVersionDownloadUriResponse from a dictionary.

class databricks.sdk.service.ml.GetModelVersionResponse

model_version: ModelVersion | None = None

as_dict() → dict

Serializes the GetModelVersionResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetModelVersionResponse

Deserializes the GetModelVersionResponse from a dictionary.

class databricks.sdk.service.ml.GetRegisteredModelPermissionLevelsResponse

permission_levels: List[RegisteredModelPermissionsDescription] | None = None

Specific permission levels

as_dict() → dict

Serializes the GetRegisteredModelPermissionLevelsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetRegisteredModelPermissionLevelsResponse

Deserializes the GetRegisteredModelPermissionLevelsResponse from a dictionary.

class databricks.sdk.service.ml.GetRunResponse

run: Run | None = None

Run metadata (name, start time, etc) and data (metrics, params, and tags).

as_dict() → dict

Serializes the GetRunResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetRunResponse

Deserializes the GetRunResponse from a dictionary.

class databricks.sdk.service.ml.HttpUrlSpec

url: str

External HTTPS URL called on event trigger (by using a POST request).

authorization: str | None = None

Value of the authorization header that should be sent in the request sent by the wehbook. It should be of the form “<auth type> <credentials>”. If set to an empty string, no authorization header will be included in the request.

enable_ssl_verification: bool | None = None

Enable/disable SSL certificate validation. Default is true. For self-signed certificates, this field must be false AND the destination server must disable certificate validation as well. For security purposes, it is encouraged to perform secret validation with the HMAC-encoded portion of the payload and acknowledge the risk associated with disabling hostname validation whereby it becomes more likely that requests can be maliciously routed to an unintended host.

secret: str | None = None

Shared secret required for HMAC encoding payload. The HMAC-encoded payload will be sent in the header as: { “X-Databricks-Signature”: $encoded_payload }.

as_dict() → dict

Serializes the HttpUrlSpec into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → HttpUrlSpec

Deserializes the HttpUrlSpec from a dictionary.

class databricks.sdk.service.ml.HttpUrlSpecWithoutSecret

enable_ssl_verification: bool | None = None

Enable/disable SSL certificate validation. Default is true. For self-signed certificates, this field must be false AND the destination server must disable certificate validation as well. For security purposes, it is encouraged to perform secret validation with the HMAC-encoded portion of the payload and acknowledge the risk associated with disabling hostname validation whereby it becomes more likely that requests can be maliciously routed to an unintended host.

url: str | None = None

External HTTPS URL called on event trigger (by using a POST request).

as_dict() → dict

Serializes the HttpUrlSpecWithoutSecret into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → HttpUrlSpecWithoutSecret

Deserializes the HttpUrlSpecWithoutSecret from a dictionary.

class databricks.sdk.service.ml.InputTag

key: str | None = None

The tag key.

value: str | None = None

The tag value.

as_dict() → dict

Serializes the InputTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → InputTag

Deserializes the InputTag from a dictionary.

class databricks.sdk.service.ml.JobSpec

job_id: str

ID of the job that the webhook runs.

access_token: str

The personal access token used to authorize webhook’s job runs.

workspace_url: str | None = None

URL of the workspace containing the job that this webhook runs. If not specified, the job’s workspace URL is assumed to be the same as the workspace where the webhook is created.

as_dict() → dict

Serializes the JobSpec into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → JobSpec

Deserializes the JobSpec from a dictionary.

class databricks.sdk.service.ml.JobSpecWithoutSecret

job_id: str | None = None

ID of the job that the webhook runs.

workspace_url: str | None = None

URL of the workspace containing the job that this webhook runs. Defaults to the workspace URL in which the webhook is created. If not specified, the job’s workspace is assumed to be the same as the webhook’s.

as_dict() → dict

Serializes the JobSpecWithoutSecret into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → JobSpecWithoutSecret

Deserializes the JobSpecWithoutSecret from a dictionary.

class databricks.sdk.service.ml.ListArtifactsResponse

files: List[FileInfo] | None = None

File location and metadata for artifacts.

next_page_token: str | None = None

Token that can be used to retrieve the next page of artifact results

root_uri: str | None = None

Root artifact directory for the run.

as_dict() → dict

Serializes the ListArtifactsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListArtifactsResponse

Deserializes the ListArtifactsResponse from a dictionary.

class databricks.sdk.service.ml.ListExperimentsResponse

experiments: List[Experiment] | None = None

Paginated Experiments beginning with the first item on the requested page.

next_page_token: str | None = None

Token that can be used to retrieve the next page of experiments. Empty token means no more experiment is available for retrieval.

as_dict() → dict

Serializes the ListExperimentsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListExperimentsResponse

Deserializes the ListExperimentsResponse from a dictionary.

class databricks.sdk.service.ml.ListModelsResponse

next_page_token: str | None = None

Pagination token to request next page of models for the same query.

registered_models: List[Model] | None = None

as_dict() → dict

Serializes the ListModelsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListModelsResponse

Deserializes the ListModelsResponse from a dictionary.

class databricks.sdk.service.ml.ListRegistryWebhooks

next_page_token: str | None = None

Token that can be used to retrieve the next page of artifact results

webhooks: List[RegistryWebhook] | None = None

Array of registry webhooks.

as_dict() → dict

Serializes the ListRegistryWebhooks into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListRegistryWebhooks

Deserializes the ListRegistryWebhooks from a dictionary.

class databricks.sdk.service.ml.ListTransitionRequestsResponse

requests: List[Activity] | None = None

Array of open transition requests.

as_dict() → dict

Serializes the ListTransitionRequestsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListTransitionRequestsResponse

Deserializes the ListTransitionRequestsResponse from a dictionary.

class databricks.sdk.service.ml.LogBatch

metrics: List[Metric] | None = None

Metrics to log. A single request can contain up to 1000 metrics, and up to 1000 metrics, params, and tags in total.

params: List[Param] | None = None

Params to log. A single request can contain up to 100 params, and up to 1000 metrics, params, and tags in total.

run_id: str | None = None

ID of the run to log under

tags: List[RunTag] | None = None

Tags to log. A single request can contain up to 100 tags, and up to 1000 metrics, params, and tags in total.

as_dict() → dict

Serializes the LogBatch into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogBatch

Deserializes the LogBatch from a dictionary.

class databricks.sdk.service.ml.LogBatchResponse

as_dict() → dict

Serializes the LogBatchResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogBatchResponse

Deserializes the LogBatchResponse from a dictionary.

class databricks.sdk.service.ml.LogInputs

datasets: List[DatasetInput] | None = None

Dataset inputs

run_id: str | None = None

ID of the run to log under

as_dict() → dict

Serializes the LogInputs into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogInputs

Deserializes the LogInputs from a dictionary.

class databricks.sdk.service.ml.LogInputsResponse

as_dict() → dict

Serializes the LogInputsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogInputsResponse

Deserializes the LogInputsResponse from a dictionary.

class databricks.sdk.service.ml.LogMetric

key: str

Name of the metric.

value: float

Double value of the metric being logged.

timestamp: int

Unix timestamp in milliseconds at the time metric was logged.

run_id: str | None = None

ID of the run under which to log the metric. Must be provided.

run_uuid: str | None = None

[Deprecated, use run_id instead] ID of the run under which to log the metric. This field will be removed in a future MLflow version.

step: int | None = None

Step at which to log the metric

as_dict() → dict

Serializes the LogMetric into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogMetric

Deserializes the LogMetric from a dictionary.

class databricks.sdk.service.ml.LogMetricResponse

as_dict() → dict

Serializes the LogMetricResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogMetricResponse

Deserializes the LogMetricResponse from a dictionary.

class databricks.sdk.service.ml.LogModel

model_json: str | None = None

MLmodel file in json format.

run_id: str | None = None

ID of the run to log under

as_dict() → dict

Serializes the LogModel into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogModel

Deserializes the LogModel from a dictionary.

class databricks.sdk.service.ml.LogModelResponse

as_dict() → dict

Serializes the LogModelResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogModelResponse

Deserializes the LogModelResponse from a dictionary.

class databricks.sdk.service.ml.LogParam

key: str

Name of the param. Maximum size is 255 bytes.

value: str

String value of the param being logged. Maximum size is 500 bytes.

run_id: str | None = None

ID of the run under which to log the param. Must be provided.

run_uuid: str | None = None

[Deprecated, use run_id instead] ID of the run under which to log the param. This field will be removed in a future MLflow version.

as_dict() → dict

Serializes the LogParam into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogParam

Deserializes the LogParam from a dictionary.

class databricks.sdk.service.ml.LogParamResponse

as_dict() → dict

Serializes the LogParamResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → LogParamResponse

Deserializes the LogParamResponse from a dictionary.

class databricks.sdk.service.ml.Metric

key: str | None = None

Key identifying this metric.

step: int | None = None

Step at which to log the metric.

timestamp: int | None = None

The timestamp at which this metric was recorded.

value: float | None = None

Value associated with this metric.

as_dict() → dict

Serializes the Metric into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Metric

Deserializes the Metric from a dictionary.

class databricks.sdk.service.ml.Model

creation_timestamp: int | None = None

Timestamp recorded when this registered_model was created.

description: str | None = None

Description of this registered_model.

last_updated_timestamp: int | None = None

Timestamp recorded when metadata for this registered_model was last updated.

latest_versions: List[ModelVersion] | None = None

Collection of latest model versions for each stage. Only contains models with current READY status.

name: str | None = None

Unique name for the model.

tags: List[ModelTag] | None = None

Tags: Additional metadata key-value pairs for this registered_model.

user_id: str | None = None

User that created this registered_model

as_dict() → dict

Serializes the Model into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Model

Deserializes the Model from a dictionary.

class databricks.sdk.service.ml.ModelDatabricks

creation_timestamp: int | None = None

Creation time of the object, as a Unix timestamp in milliseconds.

description: str | None = None

User-specified description for the object.

id: str | None = None

Unique identifier for the object.

last_updated_timestamp: int | None = None

Time of the object at last update, as a Unix timestamp in milliseconds.

latest_versions: List[ModelVersion] | None = None

Array of model versions, each the latest version for its stage.

name: str | None = None

Name of the model.

permission_level: PermissionLevel | None = None

Permission level of the requesting user on the object. For what is allowed at each level, see [MLflow Model permissions](..).

tags: List[ModelTag] | None = None

Array of tags associated with the model.

user_id: str | None = None

The username of the user that created the object.

as_dict() → dict

Serializes the ModelDatabricks into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ModelDatabricks

Deserializes the ModelDatabricks from a dictionary.

class databricks.sdk.service.ml.ModelTag

key: str | None = None

The tag key.

value: str | None = None

The tag value.

as_dict() → dict

Serializes the ModelTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ModelTag

Deserializes the ModelTag from a dictionary.

class databricks.sdk.service.ml.ModelVersion

creation_timestamp: int | None = None

Timestamp recorded when this model_version was created.

current_stage: str | None = None

Current stage for this model_version.

description: str | None = None

Description of this model_version.

last_updated_timestamp: int | None = None

Timestamp recorded when metadata for this model_version was last updated.

name: str | None = None

Unique name of the model

run_id: str | None = None

MLflow run ID used when creating model_version, if source was generated by an experiment run stored in MLflow tracking server.

run_link: str | None = None

Run Link: Direct link to the run that generated this version

source: str | None = None

URI indicating the location of the source model artifacts, used when creating model_version

status: ModelVersionStatus | None = None

Current status of model_version

status_message: str | None = None

Details on current status, if it is pending or failed.

tags: List[ModelVersionTag] | None = None

Tags: Additional metadata key-value pairs for this model_version.

user_id: str | None = None

User that created this model_version.

version: str | None = None

Model’s version number.

as_dict() → dict

Serializes the ModelVersion into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ModelVersion

Deserializes the ModelVersion from a dictionary.

class databricks.sdk.service.ml.ModelVersionDatabricks

creation_timestamp: int | None = None

Creation time of the object, as a Unix timestamp in milliseconds.

current_stage: Stage | None = None

Stage of the model version. Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

description: str | None = None

User-specified description for the object.

last_updated_timestamp: int | None = None

Time of the object at last update, as a Unix timestamp in milliseconds.

name: str | None = None

Name of the model.

permission_level: PermissionLevel | None = None

Permission level of the requesting user on the object. For what is allowed at each level, see [MLflow Model permissions](..).

run_id: str | None = None

Unique identifier for the MLflow tracking run associated with the source model artifacts.

run_link: str | None = None

URL of the run associated with the model artifacts. This field is set at model version creation time only for model versions whose source run is from a tracking server that is different from the registry server.

source: str | None = None

URI that indicates the location of the source model artifacts. This is used when creating the model version.

status: Status | None = None

The status of the model version. Valid values are: * PENDING_REGISTRATION: Request to register a new model version is pending as server performs background tasks.

• FAILED_REGISTRATION: Request to register a new model version has failed.

• READY: Model version is ready for use.

status_message: str | None = None

Details on the current status, for example why registration failed.

tags: List[ModelVersionTag] | None = None

Array of tags that are associated with the model version.

user_id: str | None = None

The username of the user that created the object.

version: str | None = None

Version of the model.

as_dict() → dict

Serializes the ModelVersionDatabricks into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ModelVersionDatabricks

Deserializes the ModelVersionDatabricks from a dictionary.

class databricks.sdk.service.ml.ModelVersionStatus

Current status of model_version

FAILED_REGISTRATION = "FAILED_REGISTRATION"

PENDING_REGISTRATION = "PENDING_REGISTRATION"

READY = "READY"

class databricks.sdk.service.ml.ModelVersionTag

key: str | None = None

The tag key.

value: str | None = None

The tag value.

as_dict() → dict

Serializes the ModelVersionTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ModelVersionTag

Deserializes the ModelVersionTag from a dictionary.

class databricks.sdk.service.ml.Param

key: str | None = None

Key identifying this param.

value: str | None = None

Value associated with this param.

as_dict() → dict

Serializes the Param into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Param

Deserializes the Param from a dictionary.

class databricks.sdk.service.ml.PermissionLevel

Permission level of the requesting user on the object. For what is allowed at each level, see [MLflow Model permissions](..).

CAN_EDIT = "CAN_EDIT"

CAN_MANAGE = "CAN_MANAGE"

CAN_MANAGE_PRODUCTION_VERSIONS = "CAN_MANAGE_PRODUCTION_VERSIONS"

CAN_MANAGE_STAGING_VERSIONS = "CAN_MANAGE_STAGING_VERSIONS"

CAN_READ = "CAN_READ"

class databricks.sdk.service.ml.RegisteredModelAccessControlRequest

group_name: str | None = None

name of the group

permission_level: RegisteredModelPermissionLevel | None = None

Permission level

service_principal_name: str | None = None

application ID of a service principal

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the RegisteredModelAccessControlRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegisteredModelAccessControlRequest

Deserializes the RegisteredModelAccessControlRequest from a dictionary.

class databricks.sdk.service.ml.RegisteredModelAccessControlResponse

all_permissions: List[RegisteredModelPermission] | None = None

All permissions.

display_name: str | None = None

Display name of the user or service principal.

group_name: str | None = None

name of the group

service_principal_name: str | None = None

Name of the service principal.

user_name: str | None = None

name of the user

as_dict() → dict

Serializes the RegisteredModelAccessControlResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegisteredModelAccessControlResponse

Deserializes the RegisteredModelAccessControlResponse from a dictionary.

class databricks.sdk.service.ml.RegisteredModelPermission

inherited: bool | None = None

inherited_from_object: List[str] | None = None

permission_level: RegisteredModelPermissionLevel | None = None

Permission level

as_dict() → dict

Serializes the RegisteredModelPermission into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegisteredModelPermission

Deserializes the RegisteredModelPermission from a dictionary.

class databricks.sdk.service.ml.RegisteredModelPermissionLevel

Permission level

CAN_EDIT = "CAN_EDIT"

CAN_MANAGE = "CAN_MANAGE"

CAN_MANAGE_PRODUCTION_VERSIONS = "CAN_MANAGE_PRODUCTION_VERSIONS"

CAN_MANAGE_STAGING_VERSIONS = "CAN_MANAGE_STAGING_VERSIONS"

CAN_READ = "CAN_READ"

class databricks.sdk.service.ml.RegisteredModelPermissions

access_control_list: List[RegisteredModelAccessControlResponse] | None = None

object_id: str | None = None

object_type: str | None = None

as_dict() → dict

Serializes the RegisteredModelPermissions into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegisteredModelPermissions

Deserializes the RegisteredModelPermissions from a dictionary.

class databricks.sdk.service.ml.RegisteredModelPermissionsDescription

description: str | None = None

permission_level: RegisteredModelPermissionLevel | None = None

Permission level

as_dict() → dict

Serializes the RegisteredModelPermissionsDescription into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegisteredModelPermissionsDescription

Deserializes the RegisteredModelPermissionsDescription from a dictionary.

class databricks.sdk.service.ml.RegisteredModelPermissionsRequest

access_control_list: List[RegisteredModelAccessControlRequest] | None = None

registered_model_id: str | None = None

The registered model for which to get or manage permissions.

as_dict() → dict

Serializes the RegisteredModelPermissionsRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegisteredModelPermissionsRequest

Deserializes the RegisteredModelPermissionsRequest from a dictionary.

class databricks.sdk.service.ml.RegistryWebhook

creation_timestamp: int | None = None

Creation time of the object, as a Unix timestamp in milliseconds.

description: str | None = None

User-specified description for the webhook.

events: List[RegistryWebhookEvent] | None = None

Events that can trigger a registry webhook: * MODEL_VERSION_CREATED: A new model version was created for the associated model.

• MODEL_VERSION_TRANSITIONED_STAGE: A model version’s stage was changed.

• TRANSITION_REQUEST_CREATED: A user requested a model version’s stage be transitioned.

• COMMENT_CREATED: A user wrote a comment on a registered model.

• REGISTERED_MODEL_CREATED: A new registered model was created. This event type can only be

specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.

• MODEL_VERSION_TAG_SET: A user set a tag on the model version.

• MODEL_VERSION_TRANSITIONED_TO_STAGING: A model version was transitioned to staging.

• MODEL_VERSION_TRANSITIONED_TO_PRODUCTION: A model version was transitioned to production.

• MODEL_VERSION_TRANSITIONED_TO_ARCHIVED: A model version was archived.

• TRANSITION_REQUEST_TO_STAGING_CREATED: A user requested a model version be transitioned to

staging.

• TRANSITION_REQUEST_TO_PRODUCTION_CREATED: A user requested a model version be transitioned

to production.

• TRANSITION_REQUEST_TO_ARCHIVED_CREATED: A user requested a model version be archived.

http_url_spec: HttpUrlSpecWithoutSecret | None = None

id: str | None = None

Webhook ID

job_spec: JobSpecWithoutSecret | None = None

last_updated_timestamp: int | None = None

Time of the object at last update, as a Unix timestamp in milliseconds.

model_name: str | None = None

Name of the model whose events would trigger this webhook.

status: RegistryWebhookStatus | None = None

Enable or disable triggering the webhook, or put the webhook into test mode. The default is ACTIVE: * ACTIVE: Webhook is triggered when an associated event happens.

• DISABLED: Webhook is not triggered.

• TEST_MODE: Webhook can be triggered through the test endpoint, but is not triggered on a

real event.

as_dict() → dict

Serializes the RegistryWebhook into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegistryWebhook

Deserializes the RegistryWebhook from a dictionary.

class databricks.sdk.service.ml.RegistryWebhookEvent

COMMENT_CREATED = "COMMENT_CREATED"

MODEL_VERSION_CREATED = "MODEL_VERSION_CREATED"

MODEL_VERSION_TAG_SET = "MODEL_VERSION_TAG_SET"

MODEL_VERSION_TRANSITIONED_STAGE = "MODEL_VERSION_TRANSITIONED_STAGE"

MODEL_VERSION_TRANSITIONED_TO_ARCHIVED = "MODEL_VERSION_TRANSITIONED_TO_ARCHIVED"

MODEL_VERSION_TRANSITIONED_TO_PRODUCTION = "MODEL_VERSION_TRANSITIONED_TO_PRODUCTION"

MODEL_VERSION_TRANSITIONED_TO_STAGING = "MODEL_VERSION_TRANSITIONED_TO_STAGING"

REGISTERED_MODEL_CREATED = "REGISTERED_MODEL_CREATED"

TRANSITION_REQUEST_CREATED = "TRANSITION_REQUEST_CREATED"

TRANSITION_REQUEST_TO_ARCHIVED_CREATED = "TRANSITION_REQUEST_TO_ARCHIVED_CREATED"

TRANSITION_REQUEST_TO_PRODUCTION_CREATED = "TRANSITION_REQUEST_TO_PRODUCTION_CREATED"

TRANSITION_REQUEST_TO_STAGING_CREATED = "TRANSITION_REQUEST_TO_STAGING_CREATED"

class databricks.sdk.service.ml.RegistryWebhookStatus

Enable or disable triggering the webhook, or put the webhook into test mode. The default is ACTIVE: * ACTIVE: Webhook is triggered when an associated event happens. * DISABLED: Webhook is not triggered. * TEST_MODE: Webhook can be triggered through the test endpoint, but is not triggered on a real event.

ACTIVE = "ACTIVE"

DISABLED = "DISABLED"

TEST_MODE = "TEST_MODE"

class databricks.sdk.service.ml.RejectTransitionRequest

name: str

Name of the model.

version: str

Version of the model.

stage: Stage

Target stage of the transition. Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

comment: str | None = None

User-provided comment on the action.

as_dict() → dict

Serializes the RejectTransitionRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RejectTransitionRequest

Deserializes the RejectTransitionRequest from a dictionary.

class databricks.sdk.service.ml.RejectTransitionRequestResponse

activity: Activity | None = None

Activity recorded for the action.

as_dict() → dict

Serializes the RejectTransitionRequestResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RejectTransitionRequestResponse

Deserializes the RejectTransitionRequestResponse from a dictionary.

class databricks.sdk.service.ml.RenameModelRequest

name: str

Registered model unique name identifier.

new_name: str | None = None

If provided, updates the name for this registered_model.

as_dict() → dict

Serializes the RenameModelRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RenameModelRequest

Deserializes the RenameModelRequest from a dictionary.

class databricks.sdk.service.ml.RenameModelResponse

registered_model: Model | None = None

as_dict() → dict

Serializes the RenameModelResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RenameModelResponse

Deserializes the RenameModelResponse from a dictionary.

class databricks.sdk.service.ml.RestoreExperiment

experiment_id: str

ID of the associated experiment.

as_dict() → dict

Serializes the RestoreExperiment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RestoreExperiment

Deserializes the RestoreExperiment from a dictionary.

class databricks.sdk.service.ml.RestoreExperimentResponse

as_dict() → dict

Serializes the RestoreExperimentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RestoreExperimentResponse

Deserializes the RestoreExperimentResponse from a dictionary.

class databricks.sdk.service.ml.RestoreRun

run_id: str

ID of the run to restore.

as_dict() → dict

Serializes the RestoreRun into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RestoreRun

Deserializes the RestoreRun from a dictionary.

class databricks.sdk.service.ml.RestoreRunResponse

as_dict() → dict

Serializes the RestoreRunResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RestoreRunResponse

Deserializes the RestoreRunResponse from a dictionary.

class databricks.sdk.service.ml.RestoreRuns

experiment_id: str

The ID of the experiment containing the runs to restore.

min_timestamp_millis: int

The minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted no earlier than this timestamp are restored.

max_runs: int | None = None

An optional positive integer indicating the maximum number of runs to restore. The maximum allowed value for max_runs is 10000.

as_dict() → dict

Serializes the RestoreRuns into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RestoreRuns

Deserializes the RestoreRuns from a dictionary.

class databricks.sdk.service.ml.RestoreRunsResponse

runs_restored: int | None = None

The number of runs restored.

as_dict() → dict

Serializes the RestoreRunsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RestoreRunsResponse

Deserializes the RestoreRunsResponse from a dictionary.

class databricks.sdk.service.ml.Run

data: RunData | None = None

Run data.

info: RunInfo | None = None

Run metadata.

inputs: RunInputs | None = None

Run inputs.

as_dict() → dict

Serializes the Run into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Run

Deserializes the Run from a dictionary.

class databricks.sdk.service.ml.RunData

metrics: List[Metric] | None = None

Run metrics.

params: List[Param] | None = None

Run parameters.

tags: List[RunTag] | None = None

Additional metadata key-value pairs.

as_dict() → dict

Serializes the RunData into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RunData

Deserializes the RunData from a dictionary.

class databricks.sdk.service.ml.RunInfo

artifact_uri: str | None = None

URI of the directory where artifacts should be uploaded. This can be a local path (starting with “/”), or a distributed file system (DFS) path, like s3://bucket/directory or dbfs:/my/directory. If not set, the local ./mlruns directory is chosen.

end_time: int | None = None

Unix timestamp of when the run ended in milliseconds.

experiment_id: str | None = None

The experiment ID.

lifecycle_stage: str | None = None

Current life cycle stage of the experiment : OneOf(“active”, “deleted”)

run_id: str | None = None

Unique identifier for the run.

run_uuid: str | None = None

[Deprecated, use run_id instead] Unique identifier for the run. This field will be removed in a future MLflow version.

start_time: int | None = None

Unix timestamp of when the run started in milliseconds.

status: RunInfoStatus | None = None

Current status of the run.

user_id: str | None = None

User who initiated the run. This field is deprecated as of MLflow 1.0, and will be removed in a future MLflow release. Use ‘mlflow.user’ tag instead.

as_dict() → dict

Serializes the RunInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RunInfo

Deserializes the RunInfo from a dictionary.

class databricks.sdk.service.ml.RunInfoStatus

Current status of the run.

FAILED = "FAILED"

FINISHED = "FINISHED"

KILLED = "KILLED"

RUNNING = "RUNNING"

SCHEDULED = "SCHEDULED"

class databricks.sdk.service.ml.RunInputs

dataset_inputs: List[DatasetInput] | None = None

Run metrics.

as_dict() → dict

Serializes the RunInputs into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RunInputs

Deserializes the RunInputs from a dictionary.

class databricks.sdk.service.ml.RunTag

key: str | None = None

The tag key.

value: str | None = None

The tag value.

as_dict() → dict

Serializes the RunTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RunTag

Deserializes the RunTag from a dictionary.

class databricks.sdk.service.ml.SearchExperiments

filter: str | None = None

String representing a SQL filter condition (e.g. “name ILIKE ‘my-experiment%’”)

max_results: int | None = None

Maximum number of experiments desired. Max threshold is 3000.

order_by: List[str] | None = None

List of columns for ordering search results, which can include experiment name and last updated timestamp with an optional “DESC” or “ASC” annotation, where “ASC” is the default. Tiebreaks are done by experiment id DESC.

page_token: str | None = None

Token indicating the page of experiments to fetch

view_type: SearchExperimentsViewType | None = None

Qualifier for type of experiments to be returned. If unspecified, return only active experiments.

as_dict() → dict

Serializes the SearchExperiments into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SearchExperiments

Deserializes the SearchExperiments from a dictionary.

class databricks.sdk.service.ml.SearchExperimentsResponse

experiments: List[Experiment] | None = None

Experiments that match the search criteria

next_page_token: str | None = None

Token that can be used to retrieve the next page of experiments. An empty token means that no more experiments are available for retrieval.

as_dict() → dict

Serializes the SearchExperimentsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SearchExperimentsResponse

Deserializes the SearchExperimentsResponse from a dictionary.

class databricks.sdk.service.ml.SearchExperimentsViewType

Qualifier for type of experiments to be returned. If unspecified, return only active experiments.

ACTIVE_ONLY = "ACTIVE_ONLY"

ALL = "ALL"

DELETED_ONLY = "DELETED_ONLY"

class databricks.sdk.service.ml.SearchModelVersionsResponse

model_versions: List[ModelVersion] | None = None

Models that match the search criteria

next_page_token: str | None = None

Pagination token to request next page of models for the same search query.

as_dict() → dict

Serializes the SearchModelVersionsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SearchModelVersionsResponse

Deserializes the SearchModelVersionsResponse from a dictionary.

class databricks.sdk.service.ml.SearchModelsResponse

next_page_token: str | None = None

Pagination token to request the next page of models.

registered_models: List[Model] | None = None

Registered Models that match the search criteria.

as_dict() → dict

Serializes the SearchModelsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SearchModelsResponse

Deserializes the SearchModelsResponse from a dictionary.

class databricks.sdk.service.ml.SearchRuns

experiment_ids: List[str] | None = None

List of experiment IDs to search over.

filter: str | None = None

A filter expression over params, metrics, and tags, that allows returning a subset of runs. The syntax is a subset of SQL that supports ANDing together binary operations between a param, metric, or tag and a constant.

Example: metrics.rmse < 1 and params.model_class = ‘LogisticRegression’

You can select columns with special characters (hyphen, space, period, etc.) by using double quotes: metrics.”model class” = ‘LinearRegression’ and tags.”user-name” = ‘Tomas’

Supported operators are =, !=, >, >=, <, and <=.

max_results: int | None = None

Maximum number of runs desired. Max threshold is 50000

order_by: List[str] | None = None

List of columns to be ordered by, including attributes, params, metrics, and tags with an optional “DESC” or “ASC” annotation, where “ASC” is the default. Example: [“params.input DESC”, “metrics.alpha ASC”, “metrics.rmse”] Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time (and this is the default ordering criterion if order_by is not provided).

page_token: str | None = None

Token for the current page of runs.

run_view_type: SearchRunsRunViewType | None = None

Whether to display only active, only deleted, or all runs. Defaults to only active runs.

as_dict() → dict

Serializes the SearchRuns into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SearchRuns

Deserializes the SearchRuns from a dictionary.

class databricks.sdk.service.ml.SearchRunsResponse

next_page_token: str | None = None

Token for the next page of runs.

runs: List[Run] | None = None

Runs that match the search criteria.

as_dict() → dict

Serializes the SearchRunsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SearchRunsResponse

Deserializes the SearchRunsResponse from a dictionary.

class databricks.sdk.service.ml.SearchRunsRunViewType

Whether to display only active, only deleted, or all runs. Defaults to only active runs.

ACTIVE_ONLY = "ACTIVE_ONLY"

ALL = "ALL"

DELETED_ONLY = "DELETED_ONLY"

class databricks.sdk.service.ml.SetExperimentTag

experiment_id: str

ID of the experiment under which to log the tag. Must be provided.

key: str

Name of the tag. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 250 bytes in size.

value: str

String value of the tag being logged. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 5000 bytes in size.

as_dict() → dict

Serializes the SetExperimentTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetExperimentTag

Deserializes the SetExperimentTag from a dictionary.

class databricks.sdk.service.ml.SetExperimentTagResponse

as_dict() → dict

Serializes the SetExperimentTagResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetExperimentTagResponse

Deserializes the SetExperimentTagResponse from a dictionary.

class databricks.sdk.service.ml.SetModelTagRequest

name: str

Unique name of the model.

key: str

Name of the tag. Maximum size depends on storage backend. If a tag with this name already exists, its preexisting value will be replaced by the specified value. All storage backends are guaranteed to support key values up to 250 bytes in size.

value: str

String value of the tag being logged. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 5000 bytes in size.

as_dict() → dict

Serializes the SetModelTagRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetModelTagRequest

Deserializes the SetModelTagRequest from a dictionary.

class databricks.sdk.service.ml.SetModelTagResponse

as_dict() → dict

Serializes the SetModelTagResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetModelTagResponse

Deserializes the SetModelTagResponse from a dictionary.

class databricks.sdk.service.ml.SetModelVersionTagRequest

name: str

Unique name of the model.

version: str

Model version number.

key: str

Name of the tag. Maximum size depends on storage backend. If a tag with this name already exists, its preexisting value will be replaced by the specified value. All storage backends are guaranteed to support key values up to 250 bytes in size.

value: str

String value of the tag being logged. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 5000 bytes in size.

as_dict() → dict

Serializes the SetModelVersionTagRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetModelVersionTagRequest

Deserializes the SetModelVersionTagRequest from a dictionary.

class databricks.sdk.service.ml.SetModelVersionTagResponse

as_dict() → dict

Serializes the SetModelVersionTagResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetModelVersionTagResponse

Deserializes the SetModelVersionTagResponse from a dictionary.

class databricks.sdk.service.ml.SetTag

key: str

Name of the tag. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 250 bytes in size.

value: str

String value of the tag being logged. Maximum size depends on storage backend. All storage backends are guaranteed to support key values up to 5000 bytes in size.

run_id: str | None = None

ID of the run under which to log the tag. Must be provided.

run_uuid: str | None = None

[Deprecated, use run_id instead] ID of the run under which to log the tag. This field will be removed in a future MLflow version.

as_dict() → dict

Serializes the SetTag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetTag

Deserializes the SetTag from a dictionary.

class databricks.sdk.service.ml.SetTagResponse

as_dict() → dict

Serializes the SetTagResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetTagResponse

Deserializes the SetTagResponse from a dictionary.

class databricks.sdk.service.ml.Stage

Stage of the model version. Valid values are: * None: The initial stage of a model version. * Staging: Staging or pre-production stage. * Production: Production stage. * Archived: Archived stage.

ARCHIVED = "ARCHIVED"

NONE = "NONE"

PRODUCTION = "PRODUCTION"

STAGING = "STAGING"

class databricks.sdk.service.ml.Status

The status of the model version. Valid values are: * PENDING_REGISTRATION: Request to register a new model version is pending as server performs background tasks. * FAILED_REGISTRATION: Request to register a new model version has failed. * READY: Model version is ready for use.

FAILED_REGISTRATION = "FAILED_REGISTRATION"

PENDING_REGISTRATION = "PENDING_REGISTRATION"

READY = "READY"

class databricks.sdk.service.ml.TestRegistryWebhook

Test webhook response object.

body: str | None = None

Body of the response from the webhook URL

status_code: int | None = None

Status code returned by the webhook URL

as_dict() → dict

Serializes the TestRegistryWebhook into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TestRegistryWebhook

Deserializes the TestRegistryWebhook from a dictionary.

class databricks.sdk.service.ml.TestRegistryWebhookRequest

id: str

Webhook ID

event: RegistryWebhookEvent | None = None

If event is specified, the test trigger uses the specified event. If event is not specified, the test trigger uses a randomly chosen event associated with the webhook.

as_dict() → dict

Serializes the TestRegistryWebhookRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TestRegistryWebhookRequest

Deserializes the TestRegistryWebhookRequest from a dictionary.

class databricks.sdk.service.ml.TestRegistryWebhookResponse

webhook: TestRegistryWebhook | None = None

Test webhook response object.

as_dict() → dict

Serializes the TestRegistryWebhookResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TestRegistryWebhookResponse

Deserializes the TestRegistryWebhookResponse from a dictionary.

class databricks.sdk.service.ml.TransitionModelVersionStageDatabricks

name: str

Name of the model.

version: str

Version of the model.

stage: Stage

Target stage of the transition. Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

archive_existing_versions: bool

Specifies whether to archive all current model versions in the target stage.

comment: str | None = None

User-provided comment on the action.

as_dict() → dict

Serializes the TransitionModelVersionStageDatabricks into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TransitionModelVersionStageDatabricks

Deserializes the TransitionModelVersionStageDatabricks from a dictionary.

class databricks.sdk.service.ml.TransitionRequest

Transition request details.

available_actions: List[ActivityAction] | None = None

Array of actions on the activity allowed for the current viewer.

comment: str | None = None

User-provided comment associated with the transition request.

creation_timestamp: int | None = None

Creation time of the object, as a Unix timestamp in milliseconds.

to_stage: Stage | None = None

Target stage of the transition (if the activity is stage transition related). Valid values are:

• None: The initial stage of a model version.

• Staging: Staging or pre-production stage.

• Production: Production stage.

• Archived: Archived stage.

user_id: str | None = None

The username of the user that created the object.

as_dict() → dict

Serializes the TransitionRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TransitionRequest

Deserializes the TransitionRequest from a dictionary.

class databricks.sdk.service.ml.TransitionStageResponse

model_version: ModelVersionDatabricks | None = None

as_dict() → dict

Serializes the TransitionStageResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TransitionStageResponse

Deserializes the TransitionStageResponse from a dictionary.

class databricks.sdk.service.ml.UpdateComment

id: str

Unique identifier of an activity

comment: str

User-provided comment on the action.

as_dict() → dict

Serializes the UpdateComment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateComment

Deserializes the UpdateComment from a dictionary.

class databricks.sdk.service.ml.UpdateCommentResponse

comment: CommentObject | None = None

Comment details.

as_dict() → dict

Serializes the UpdateCommentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateCommentResponse

Deserializes the UpdateCommentResponse from a dictionary.

class databricks.sdk.service.ml.UpdateExperiment

experiment_id: str

ID of the associated experiment.

new_name: str | None = None

If provided, the experiment’s name is changed to the new name. The new name must be unique.

as_dict() → dict

Serializes the UpdateExperiment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateExperiment

Deserializes the UpdateExperiment from a dictionary.

class databricks.sdk.service.ml.UpdateExperimentResponse

as_dict() → dict

Serializes the UpdateExperimentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateExperimentResponse

Deserializes the UpdateExperimentResponse from a dictionary.

class databricks.sdk.service.ml.UpdateModelRequest

name: str

Registered model unique name identifier.

description: str | None = None

If provided, updates the description for this registered_model.

as_dict() → dict

Serializes the UpdateModelRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateModelRequest

Deserializes the UpdateModelRequest from a dictionary.

class databricks.sdk.service.ml.UpdateModelResponse

as_dict() → dict

Serializes the UpdateModelResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateModelResponse

Deserializes the UpdateModelResponse from a dictionary.

class databricks.sdk.service.ml.UpdateModelVersionRequest

name: str

Name of the registered model

version: str

Model version number

description: str | None = None

If provided, updates the description for this registered_model.

as_dict() → dict

Serializes the UpdateModelVersionRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateModelVersionRequest

Deserializes the UpdateModelVersionRequest from a dictionary.

class databricks.sdk.service.ml.UpdateModelVersionResponse

as_dict() → dict

Serializes the UpdateModelVersionResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateModelVersionResponse

Deserializes the UpdateModelVersionResponse from a dictionary.

class databricks.sdk.service.ml.UpdateRegistryWebhook

id: str

Webhook ID

description: str | None = None

User-specified description for the webhook.

events: List[RegistryWebhookEvent] | None = None

Events that can trigger a registry webhook: * MODEL_VERSION_CREATED: A new model version was created for the associated model.

• MODEL_VERSION_TRANSITIONED_STAGE: A model version’s stage was changed.

• TRANSITION_REQUEST_CREATED: A user requested a model version’s stage be transitioned.

• COMMENT_CREATED: A user wrote a comment on a registered model.

• REGISTERED_MODEL_CREATED: A new registered model was created. This event type can only be

specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.

• MODEL_VERSION_TAG_SET: A user set a tag on the model version.

• MODEL_VERSION_TRANSITIONED_TO_STAGING: A model version was transitioned to staging.

• MODEL_VERSION_TRANSITIONED_TO_PRODUCTION: A model version was transitioned to production.

• MODEL_VERSION_TRANSITIONED_TO_ARCHIVED: A model version was archived.

• TRANSITION_REQUEST_TO_STAGING_CREATED: A user requested a model version be transitioned to

staging.

• TRANSITION_REQUEST_TO_PRODUCTION_CREATED: A user requested a model version be transitioned

to production.

• TRANSITION_REQUEST_TO_ARCHIVED_CREATED: A user requested a model version be archived.

http_url_spec: HttpUrlSpec | None = None

job_spec: JobSpec | None = None

status: RegistryWebhookStatus | None = None

Enable or disable triggering the webhook, or put the webhook into test mode. The default is ACTIVE: * ACTIVE: Webhook is triggered when an associated event happens.

• DISABLED: Webhook is not triggered.

• TEST_MODE: Webhook can be triggered through the test endpoint, but is not triggered on a

real event.

as_dict() → dict

Serializes the UpdateRegistryWebhook into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateRegistryWebhook

Deserializes the UpdateRegistryWebhook from a dictionary.

class databricks.sdk.service.ml.UpdateRun

end_time: int | None = None

Unix timestamp in milliseconds of when the run ended.

run_id: str | None = None

ID of the run to update. Must be provided.

run_uuid: str | None = None

[Deprecated, use run_id instead] ID of the run to update.. This field will be removed in a future MLflow version.

status: UpdateRunStatus | None = None

Updated status of the run.

as_dict() → dict

Serializes the UpdateRun into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateRun

Deserializes the UpdateRun from a dictionary.

class databricks.sdk.service.ml.UpdateRunResponse

run_info: RunInfo | None = None

Updated metadata of the run.

as_dict() → dict

Serializes the UpdateRunResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateRunResponse

Deserializes the UpdateRunResponse from a dictionary.

class databricks.sdk.service.ml.UpdateRunStatus

Updated status of the run.

FAILED = "FAILED"

FINISHED = "FINISHED"

KILLED = "KILLED"

RUNNING = "RUNNING"

SCHEDULED = "SCHEDULED"

class databricks.sdk.service.ml.UpdateWebhookResponse

as_dict() → dict

Serializes the UpdateWebhookResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateWebhookResponse

Deserializes the UpdateWebhookResponse from a dictionary.