com.databricks.sdk.service.ml

Class ModelRegistryAPI

java.lang.Object

com.databricks.sdk.service.ml.ModelRegistryAPI

@Generated
public class ModelRegistryAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
ModelRegistryAPI(ApiClient apiClient) Regular-use constructor
ModelRegistryAPI(ModelRegistryService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
ApproveTransitionRequestResponse	approveTransitionRequest(ApproveTransitionRequest request) Approves a model version stage transition request.
CreateCommentResponse	createComment(CreateComment request) Posts a comment on a model version.
CreateModelResponse	createModel(CreateModelRequest request) Creates a new registered model with the name specified in the request body.
CreateModelVersionResponse	createModelVersion(CreateModelVersionRequest request) Creates a model version.
CreateTransitionRequestResponse	createTransitionRequest(CreateTransitionRequest request) Creates a model version stage transition request.
CreateWebhookResponse	createWebhook(CreateRegistryWebhook request) NOTE:** This endpoint is in Public Preview.
void	deleteComment(DeleteCommentRequest request) Deletes a comment on a model version.
void	deleteComment(String id)
void	deleteModel(DeleteModelRequest request) Deletes a registered model.
void	deleteModel(String name)
void	deleteModelTag(DeleteModelTagRequest request) Deletes the tag for a registered model.
void	deleteModelTag(String name, String key)
void	deleteModelVersion(DeleteModelVersionRequest request) Deletes a model version.
void	deleteModelVersion(String name, String version)
void	deleteModelVersionTag(DeleteModelVersionTagRequest request) Deletes a model version tag.
void	deleteModelVersionTag(String name, String version, String key)
DeleteTransitionRequestResponse	deleteTransitionRequest(DeleteTransitionRequestRequest request) Cancels a model version stage transition request.
DeleteTransitionRequestResponse	deleteTransitionRequest(String name, String version, String stage, String creator)
void	deleteWebhook(DeleteWebhookRequest request) NOTE:** This endpoint is in Public Preview.
void	deleteWebhook(String id)
Iterable<ModelVersion>	getLatestVersions(GetLatestVersionsRequest request) Gets the latest version of a registered model.
GetModelResponse	getModel(GetModelRequest request) Get the details of a model.
GetModelResponse	getModel(String name)
GetModelVersionResponse	getModelVersion(GetModelVersionRequest request) Get a model version.
GetModelVersionResponse	getModelVersion(String name, String version)
GetModelVersionDownloadUriResponse	getModelVersionDownloadUri(GetModelVersionDownloadUriRequest request) Gets a URI to download the model version.
GetModelVersionDownloadUriResponse	getModelVersionDownloadUri(String name, String version)
GetRegisteredModelPermissionLevelsResponse	getPermissionLevels(GetRegisteredModelPermissionLevelsRequest request) Gets the permission levels that a user can have on an object.
GetRegisteredModelPermissionLevelsResponse	getPermissionLevels(String registeredModelId)
RegisteredModelPermissions	getPermissions(GetRegisteredModelPermissionsRequest request) Gets the permissions of a registered model.
RegisteredModelPermissions	getPermissions(String registeredModelId)
ModelRegistryService	impl()
Iterable<Model>	listModels(ListModelsRequest request) Lists all available registered models, up to the limit specified in __max_results__.
Iterable<Activity>	listTransitionRequests(ListTransitionRequestsRequest request) Gets a list of all open stage transition requests for the model version.
Iterable<Activity>	listTransitionRequests(String name, String version)
Iterable<RegistryWebhook>	listWebhooks(ListWebhooksRequest request) NOTE:** This endpoint is in Public Preview.
RejectTransitionRequestResponse	rejectTransitionRequest(RejectTransitionRequest request) Rejects a model version stage transition request.
RenameModelResponse	renameModel(RenameModelRequest request) Renames a registered model.
Iterable<Model>	searchModels(SearchModelsRequest request) Search for registered models based on the specified __filter__.
Iterable<ModelVersion>	searchModelVersions(SearchModelVersionsRequest request) Searches for specific model versions based on the supplied __filter__.
void	setModelTag(SetModelTagRequest request) Sets a tag on a registered model.
void	setModelVersionTag(SetModelVersionTagRequest request) Sets a model version tag.
RegisteredModelPermissions	setPermissions(RegisteredModelPermissionsRequest request) Sets permissions on an object, replacing existing permissions if they exist.
TestRegistryWebhookResponse	testRegistryWebhook(TestRegistryWebhookRequest request) NOTE:** This endpoint is in Public Preview.
TransitionStageResponse	transitionStage(TransitionModelVersionStageDatabricks request) Transition a model version's stage.
UpdateCommentResponse	updateComment(UpdateComment request) Post an edit to a comment on a model version.
UpdateModelResponse	updateModel(UpdateModelRequest request) Updates a registered model.
UpdateModelVersionResponse	updateModelVersion(UpdateModelVersionRequest request) Updates the model version.
RegisteredModelPermissions	updatePermissions(RegisteredModelPermissionsRequest request) Updates the permissions on a registered model.
UpdateWebhookResponse	updateWebhook(UpdateRegistryWebhook request) NOTE:** This endpoint is in Public Preview.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelRegistryAPI

public ModelRegistryAPI(ApiClient apiClient)

Regular-use constructor

ModelRegistryAPI

public ModelRegistryAPI(ModelRegistryService mock)

Constructor for mocks

Method Detail

approveTransitionRequest

public ApproveTransitionRequestResponse approveTransitionRequest(ApproveTransitionRequest request)

Approves a model version stage transition request.

createComment

public CreateCommentResponse createComment(CreateComment request)

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

public CreateModelResponse createModel(CreateModelRequest request)

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

public CreateModelVersionResponse createModelVersion(CreateModelVersionRequest request)

Creates a model version.

createTransitionRequest

public CreateTransitionRequestResponse createTransitionRequest(CreateTransitionRequest request)

Creates a model version stage transition request.

createWebhook

public CreateWebhookResponse createWebhook(CreateRegistryWebhook request)

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

deleteComment

public void deleteComment(String id)

deleteComment

public void deleteComment(DeleteCommentRequest request)

Deletes a comment on a model version.

deleteModel

public void deleteModel(String name)

deleteModel

public void deleteModel(DeleteModelRequest request)

Deletes a registered model.

deleteModelTag

public void deleteModelTag(String name,
                           String key)

deleteModelTag

public void deleteModelTag(DeleteModelTagRequest request)

Deletes the tag for a registered model.

deleteModelVersion

public void deleteModelVersion(String name,
                               String version)

deleteModelVersion

public void deleteModelVersion(DeleteModelVersionRequest request)

Deletes a model version.

deleteModelVersionTag

public void deleteModelVersionTag(String name,
                                  String version,
                                  String key)

deleteModelVersionTag

public void deleteModelVersionTag(DeleteModelVersionTagRequest request)

Deletes a model version tag.

deleteTransitionRequest

public DeleteTransitionRequestResponse deleteTransitionRequest(String name,
                                                               String version,
                                                               String stage,
                                                               String creator)

deleteTransitionRequest

public DeleteTransitionRequestResponse deleteTransitionRequest(DeleteTransitionRequestRequest request)

Cancels a model version stage transition request.

deleteWebhook

public void deleteWebhook(String id)

deleteWebhook

public void deleteWebhook(DeleteWebhookRequest request)

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

getLatestVersions

public Iterable<ModelVersion> getLatestVersions(GetLatestVersionsRequest request)

Gets the latest version of a registered model.

getModel

public GetModelResponse getModel(String name)

getModel

public GetModelResponse getModel(GetModelRequest request)

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

public GetModelVersionResponse getModelVersion(String name,
                                               String version)

getModelVersion

public GetModelVersionResponse getModelVersion(GetModelVersionRequest request)

Get a model version.

getModelVersionDownloadUri

public GetModelVersionDownloadUriResponse getModelVersionDownloadUri(String name,
                                                                     String version)

getModelVersionDownloadUri

public GetModelVersionDownloadUriResponse getModelVersionDownloadUri(GetModelVersionDownloadUriRequest request)

Gets a URI to download the model version.

getPermissionLevels

public GetRegisteredModelPermissionLevelsResponse getPermissionLevels(String registeredModelId)

getPermissionLevels

public GetRegisteredModelPermissionLevelsResponse getPermissionLevels(GetRegisteredModelPermissionLevelsRequest request)

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

getPermissions

public RegisteredModelPermissions getPermissions(String registeredModelId)

getPermissions

public RegisteredModelPermissions getPermissions(GetRegisteredModelPermissionsRequest request)

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

listModels

public Iterable<Model> listModels(ListModelsRequest request)

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

listTransitionRequests

public Iterable<Activity> listTransitionRequests(String name,
                                                 String version)

listTransitionRequests

public Iterable<Activity> listTransitionRequests(ListTransitionRequestsRequest request)

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

listWebhooks

public Iterable<RegistryWebhook> listWebhooks(ListWebhooksRequest request)

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

rejectTransitionRequest

public RejectTransitionRequestResponse rejectTransitionRequest(RejectTransitionRequest request)

Rejects a model version stage transition request.

renameModel

public RenameModelResponse renameModel(RenameModelRequest request)

Renames a registered model.

searchModelVersions

public Iterable<ModelVersion> searchModelVersions(SearchModelVersionsRequest request)

Searches for specific model versions based on the supplied __filter__.

searchModels

public Iterable<Model> searchModels(SearchModelsRequest request)

Search for registered models based on the specified __filter__.

setModelTag

public void setModelTag(SetModelTagRequest request)

Sets a tag on a registered model.

setModelVersionTag

public void setModelVersionTag(SetModelVersionTagRequest request)

Sets a model version tag.

setPermissions

public RegisteredModelPermissions setPermissions(RegisteredModelPermissionsRequest request)

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

public TestRegistryWebhookResponse testRegistryWebhook(TestRegistryWebhookRequest request)

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

transitionStage

public TransitionStageResponse transitionStage(TransitionModelVersionStageDatabricks request)

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

public UpdateCommentResponse updateComment(UpdateComment request)

Post an edit to a comment on a model version.

updateModel

public UpdateModelResponse updateModel(UpdateModelRequest request)

Updates a registered model.

updateModelVersion

public UpdateModelVersionResponse updateModelVersion(UpdateModelVersionRequest request)

Updates the model version.

updatePermissions

public RegisteredModelPermissions updatePermissions(RegisteredModelPermissionsRequest request)

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

updateWebhook

public UpdateWebhookResponse updateWebhook(UpdateRegistryWebhook request)

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

impl

public ModelRegistryService impl()