com.databricks.sdk.service.ml

Interface ModelRegistryService

@Generated
public interface ModelRegistryService

Note: This API reference documents APIs for the Workspace Model Registry. Databricks recommends using [Models in Unity Catalog](/api/workspace/registeredmodels) instead. Models in Unity Catalog provides centralized model governance, cross-workspace access, lineage, and deployment. Workspace Model Registry will be deprecated in the future.

The Workspace Model Registry is a centralized model repository and a UI and set of APIs that enable you to manage the full lifecycle of MLflow Models.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
ApproveTransitionRequestResponse	approveTransitionRequest(ApproveTransitionRequest approveTransitionRequest) Approves a model version stage transition request.
CreateCommentResponse	createComment(CreateComment createComment) Posts a comment on a model version.
CreateModelResponse	createModel(CreateModelRequest createModelRequest) Creates a new registered model with the name specified in the request body.
CreateModelVersionResponse	createModelVersion(CreateModelVersionRequest createModelVersionRequest) Creates a model version.
CreateTransitionRequestResponse	createTransitionRequest(CreateTransitionRequest createTransitionRequest) Creates a model version stage transition request.
CreateWebhookResponse	createWebhook(CreateRegistryWebhook createRegistryWebhook) NOTE:** This endpoint is in Public Preview.
void	deleteComment(DeleteCommentRequest deleteCommentRequest) Deletes a comment on a model version.
void	deleteModel(DeleteModelRequest deleteModelRequest) Deletes a registered model.
void	deleteModelTag(DeleteModelTagRequest deleteModelTagRequest) Deletes the tag for a registered model.
void	deleteModelVersion(DeleteModelVersionRequest deleteModelVersionRequest) Deletes a model version.
void	deleteModelVersionTag(DeleteModelVersionTagRequest deleteModelVersionTagRequest) Deletes a model version tag.
DeleteTransitionRequestResponse	deleteTransitionRequest(DeleteTransitionRequestRequest deleteTransitionRequestRequest) Cancels a model version stage transition request.
void	deleteWebhook(DeleteWebhookRequest deleteWebhookRequest) NOTE:** This endpoint is in Public Preview.
GetLatestVersionsResponse	getLatestVersions(GetLatestVersionsRequest getLatestVersionsRequest) Gets the latest version of a registered model.
GetModelResponse	getModel(GetModelRequest getModelRequest) Get the details of a model.
GetModelVersionResponse	getModelVersion(GetModelVersionRequest getModelVersionRequest) Get a model version.
GetModelVersionDownloadUriResponse	getModelVersionDownloadUri(GetModelVersionDownloadUriRequest getModelVersionDownloadUriRequest) Gets a URI to download the model version.
GetRegisteredModelPermissionLevelsResponse	getPermissionLevels(GetRegisteredModelPermissionLevelsRequest getRegisteredModelPermissionLevelsRequest) Gets the permission levels that a user can have on an object.
RegisteredModelPermissions	getPermissions(GetRegisteredModelPermissionsRequest getRegisteredModelPermissionsRequest) Gets the permissions of a registered model.
ListModelsResponse	listModels(ListModelsRequest listModelsRequest) Lists all available registered models, up to the limit specified in __max_results__.
ListTransitionRequestsResponse	listTransitionRequests(ListTransitionRequestsRequest listTransitionRequestsRequest) Gets a list of all open stage transition requests for the model version.
ListRegistryWebhooks	listWebhooks(ListWebhooksRequest listWebhooksRequest) NOTE:** This endpoint is in Public Preview.
RejectTransitionRequestResponse	rejectTransitionRequest(RejectTransitionRequest rejectTransitionRequest) Rejects a model version stage transition request.
RenameModelResponse	renameModel(RenameModelRequest renameModelRequest) Renames a registered model.
SearchModelsResponse	searchModels(SearchModelsRequest searchModelsRequest) Search for registered models based on the specified __filter__.
SearchModelVersionsResponse	searchModelVersions(SearchModelVersionsRequest searchModelVersionsRequest) Searches for specific model versions based on the supplied __filter__.
void	setModelTag(SetModelTagRequest setModelTagRequest) Sets a tag on a registered model.
void	setModelVersionTag(SetModelVersionTagRequest setModelVersionTagRequest) Sets a model version tag.
RegisteredModelPermissions	setPermissions(RegisteredModelPermissionsRequest registeredModelPermissionsRequest) Sets permissions on an object, replacing existing permissions if they exist.
TestRegistryWebhookResponse	testRegistryWebhook(TestRegistryWebhookRequest testRegistryWebhookRequest) NOTE:** This endpoint is in Public Preview.
TransitionStageResponse	transitionStage(TransitionModelVersionStageDatabricks transitionModelVersionStageDatabricks) Transition a model version's stage.
UpdateCommentResponse	updateComment(UpdateComment updateComment) Post an edit to a comment on a model version.
UpdateModelResponse	updateModel(UpdateModelRequest updateModelRequest) Updates a registered model.
UpdateModelVersionResponse	updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest) Updates the model version.
RegisteredModelPermissions	updatePermissions(RegisteredModelPermissionsRequest registeredModelPermissionsRequest) Updates the permissions on a registered model.
UpdateWebhookResponse	updateWebhook(UpdateRegistryWebhook updateRegistryWebhook) NOTE:** This endpoint is in Public Preview.

Method Detail

approveTransitionRequest

ApproveTransitionRequestResponse approveTransitionRequest(ApproveTransitionRequest approveTransitionRequest)

Approves a model version stage transition request.

createComment

CreateCommentResponse createComment(CreateComment createComment)

Posts a comment on a model version. A comment can be submitted either by a user or programmatically to display relevant information about the model. For example, test results or deployment errors.

createModel

CreateModelResponse createModel(CreateModelRequest createModelRequest)

Creates a new registered model with the name specified in the request body. Throws `RESOURCE_ALREADY_EXISTS` if a registered model with the given name exists.

createModelVersion

CreateModelVersionResponse createModelVersion(CreateModelVersionRequest createModelVersionRequest)

Creates a model version.

createTransitionRequest

CreateTransitionRequestResponse createTransitionRequest(CreateTransitionRequest createTransitionRequest)

Creates a model version stage transition request.

createWebhook

CreateWebhookResponse createWebhook(CreateRegistryWebhook createRegistryWebhook)

NOTE:** This endpoint is in Public Preview. Creates a registry webhook.

deleteComment

void deleteComment(DeleteCommentRequest deleteCommentRequest)

Deletes a comment on a model version.

deleteModel

void deleteModel(DeleteModelRequest deleteModelRequest)

Deletes a registered model.

deleteModelTag

void deleteModelTag(DeleteModelTagRequest deleteModelTagRequest)

Deletes the tag for a registered model.

deleteModelVersion

void deleteModelVersion(DeleteModelVersionRequest deleteModelVersionRequest)

Deletes a model version.

deleteModelVersionTag

void deleteModelVersionTag(DeleteModelVersionTagRequest deleteModelVersionTagRequest)

Deletes a model version tag.

deleteTransitionRequest

DeleteTransitionRequestResponse deleteTransitionRequest(DeleteTransitionRequestRequest deleteTransitionRequestRequest)

Cancels a model version stage transition request.

deleteWebhook

void deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)

NOTE:** This endpoint is in Public Preview. Deletes a registry webhook.

getLatestVersions

GetLatestVersionsResponse getLatestVersions(GetLatestVersionsRequest getLatestVersionsRequest)

Gets the latest version of a registered model.

getModel

GetModelResponse getModel(GetModelRequest getModelRequest)

Get the details of a model. This is a Databricks workspace version of the [MLflow endpoint] that also returns the model's Databricks workspace ID and the permission level of the requesting user on the model.

[MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#get-registeredmodel

getModelVersion

GetModelVersionResponse getModelVersion(GetModelVersionRequest getModelVersionRequest)

Get a model version.

getModelVersionDownloadUri

GetModelVersionDownloadUriResponse getModelVersionDownloadUri(GetModelVersionDownloadUriRequest getModelVersionDownloadUriRequest)

Gets a URI to download the model version.

getPermissionLevels

GetRegisteredModelPermissionLevelsResponse getPermissionLevels(GetRegisteredModelPermissionLevelsRequest getRegisteredModelPermissionLevelsRequest)

Gets the permission levels that a user can have on an object.

getPermissions

RegisteredModelPermissions getPermissions(GetRegisteredModelPermissionsRequest getRegisteredModelPermissionsRequest)

Gets the permissions of a registered model. Registered models can inherit permissions from their root object.

listModels

ListModelsResponse listModels(ListModelsRequest listModelsRequest)

Lists all available registered models, up to the limit specified in __max_results__.

listTransitionRequests

ListTransitionRequestsResponse listTransitionRequests(ListTransitionRequestsRequest listTransitionRequestsRequest)

Gets a list of all open stage transition requests for the model version.

listWebhooks

ListRegistryWebhooks listWebhooks(ListWebhooksRequest listWebhooksRequest)

NOTE:** This endpoint is in Public Preview. Lists all registry webhooks.

rejectTransitionRequest

RejectTransitionRequestResponse rejectTransitionRequest(RejectTransitionRequest rejectTransitionRequest)

Rejects a model version stage transition request.

renameModel

RenameModelResponse renameModel(RenameModelRequest renameModelRequest)

Renames a registered model.

searchModelVersions

SearchModelVersionsResponse searchModelVersions(SearchModelVersionsRequest searchModelVersionsRequest)

Searches for specific model versions based on the supplied __filter__.

searchModels

SearchModelsResponse searchModels(SearchModelsRequest searchModelsRequest)

Search for registered models based on the specified __filter__.

setModelTag

void setModelTag(SetModelTagRequest setModelTagRequest)

Sets a tag on a registered model.

setModelVersionTag

void setModelVersionTag(SetModelVersionTagRequest setModelVersionTagRequest)

Sets a model version tag.

setPermissions

RegisteredModelPermissions setPermissions(RegisteredModelPermissionsRequest registeredModelPermissionsRequest)

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.

testRegistryWebhook

TestRegistryWebhookResponse testRegistryWebhook(TestRegistryWebhookRequest testRegistryWebhookRequest)

NOTE:** This endpoint is in Public Preview. Tests a registry webhook.

transitionStage

TransitionStageResponse transitionStage(TransitionModelVersionStageDatabricks transitionModelVersionStageDatabricks)

Transition a model version's stage. This is a Databricks workspace version of the [MLflow endpoint] that also accepts a comment associated with the transition to be recorded.

[MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#transition-modelversion-stage

updateComment

UpdateCommentResponse updateComment(UpdateComment updateComment)

Post an edit to a comment on a model version.

updateModel

UpdateModelResponse updateModel(UpdateModelRequest updateModelRequest)

Updates a registered model.

updateModelVersion

UpdateModelVersionResponse updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest)

Updates the model version.

updatePermissions

RegisteredModelPermissions updatePermissions(RegisteredModelPermissionsRequest registeredModelPermissionsRequest)

Updates the permissions on a registered model. Registered models can inherit permissions from their root object.

updateWebhook

UpdateWebhookResponse updateWebhook(UpdateRegistryWebhook updateRegistryWebhook)

NOTE:** This endpoint is in Public Preview. Updates a registry webhook.