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) Approve transition request.
ApproveTransitionRequestResponse	approveTransitionRequest(String name, String version, Stage stage, boolean archiveExistingVersions)
CreateCommentResponse	createComment(CreateComment request) Post a comment.
CreateCommentResponse	createComment(String name, String version, String comment)
CreateModelResponse	createModel(CreateModelRequest request) Create a model.
CreateModelResponse	createModel(String name)
CreateModelVersionResponse	createModelVersion(CreateModelVersionRequest request) Create a model version.
CreateModelVersionResponse	createModelVersion(String name, String source)
CreateTransitionRequestResponse	createTransitionRequest(CreateTransitionRequest request) Make a transition request.
CreateTransitionRequestResponse	createTransitionRequest(String name, String version, Stage stage)
CreateWebhookResponse	createWebhook(Collection<RegistryWebhookEvent> events)
CreateWebhookResponse	createWebhook(CreateRegistryWebhook request) Create a webhook.
void	deleteComment(DeleteCommentRequest request) Delete a comment.
void	deleteComment(String id)
void	deleteModel(DeleteModelRequest request) Delete a model.
void	deleteModel(String name)
void	deleteModelTag(DeleteModelTagRequest request) Delete a model tag.
void	deleteModelTag(String name, String key)
void	deleteModelVersion(DeleteModelVersionRequest request) Delete a model version.
void	deleteModelVersion(String name, String version)
void	deleteModelVersionTag(DeleteModelVersionTagRequest request) Delete a model version tag.
void	deleteModelVersionTag(String name, String version, String key)
void	deleteTransitionRequest(DeleteTransitionRequestRequest request) Delete a transition request.
void	deleteTransitionRequest(String name, String version, DeleteTransitionRequestStage stage, String creator)
void	deleteWebhook(DeleteWebhookRequest request) Delete a webhook.
Iterable<ModelVersion>	getLatestVersions(GetLatestVersionsRequest request) Get the latest version.
Iterable<ModelVersion>	getLatestVersions(String name)
GetModelResponse	getModel(GetModelRequest request) Get model.
GetModelResponse	getModel(String name)
GetModelVersionResponse	getModelVersion(GetModelVersionRequest request) Get a model version.
GetModelVersionResponse	getModelVersion(String name, String version)
GetModelVersionDownloadUriResponse	getModelVersionDownloadUri(GetModelVersionDownloadUriRequest request) Get a model version URI.
GetModelVersionDownloadUriResponse	getModelVersionDownloadUri(String name, String version)
GetRegisteredModelPermissionLevelsResponse	getPermissionLevels(GetRegisteredModelPermissionLevelsRequest request) Get registered model permission levels.
GetRegisteredModelPermissionLevelsResponse	getPermissionLevels(String registeredModelId)
RegisteredModelPermissions	getPermissions(GetRegisteredModelPermissionsRequest request) Get registered model permissions.
RegisteredModelPermissions	getPermissions(String registeredModelId)
ModelRegistryService	impl()
Iterable<Model>	listModels(ListModelsRequest request) List models.
Iterable<Activity>	listTransitionRequests(ListTransitionRequestsRequest request) List transition requests.
Iterable<Activity>	listTransitionRequests(String name, String version)
Iterable<RegistryWebhook>	listWebhooks(ListWebhooksRequest request) List registry webhooks.
RejectTransitionRequestResponse	rejectTransitionRequest(RejectTransitionRequest request) Reject a transition request.
RejectTransitionRequestResponse	rejectTransitionRequest(String name, String version, Stage stage)
RenameModelResponse	renameModel(RenameModelRequest request) Rename a model.
RenameModelResponse	renameModel(String name)
Iterable<Model>	searchModels(SearchModelsRequest request) Search models.
Iterable<ModelVersion>	searchModelVersions(SearchModelVersionsRequest request) Searches model versions.
void	setModelTag(SetModelTagRequest request) Set a tag.
void	setModelTag(String name, String key, String value)
void	setModelVersionTag(SetModelVersionTagRequest request) Set a version tag.
void	setModelVersionTag(String name, String version, String key, String value)
RegisteredModelPermissions	setPermissions(RegisteredModelPermissionsRequest request) Set registered model permissions.
RegisteredModelPermissions	setPermissions(String registeredModelId)
TestRegistryWebhookResponse	testRegistryWebhook(String id)
TestRegistryWebhookResponse	testRegistryWebhook(TestRegistryWebhookRequest request) Test a webhook.
TransitionStageResponse	transitionStage(String name, String version, Stage stage, boolean archiveExistingVersions)
TransitionStageResponse	transitionStage(TransitionModelVersionStageDatabricks request) Transition a stage.
UpdateCommentResponse	updateComment(String id, String comment)
UpdateCommentResponse	updateComment(UpdateComment request) Update a comment.
void	updateModel(String name)
void	updateModel(UpdateModelRequest request) Update model.
void	updateModelVersion(String name, String version)
void	updateModelVersion(UpdateModelVersionRequest request) Update model version.
RegisteredModelPermissions	updatePermissions(RegisteredModelPermissionsRequest request) Update registered model permissions.
RegisteredModelPermissions	updatePermissions(String registeredModelId)
void	updateWebhook(String id)
void	updateWebhook(UpdateRegistryWebhook request) Update a webhook.

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(String name,
                                                                 String version,
                                                                 Stage stage,
                                                                 boolean archiveExistingVersions)

approveTransitionRequest

public ApproveTransitionRequestResponse approveTransitionRequest(ApproveTransitionRequest request)

Approve transition request.

Approves a model version stage transition request.

createComment

public CreateCommentResponse createComment(String name,
                                           String version,
                                           String comment)

createComment

public CreateCommentResponse createComment(CreateComment request)

Post a comment.

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(String name)

createModel

public CreateModelResponse createModel(CreateModelRequest request)

Create a model.

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(String name,
                                                     String source)

createModelVersion

public CreateModelVersionResponse createModelVersion(CreateModelVersionRequest request)

Create a model version.

Creates a model version.

createTransitionRequest

public CreateTransitionRequestResponse createTransitionRequest(String name,
                                                               String version,
                                                               Stage stage)

createTransitionRequest

public CreateTransitionRequestResponse createTransitionRequest(CreateTransitionRequest request)

Make a transition request.

Creates a model version stage transition request.

createWebhook

public CreateWebhookResponse createWebhook(Collection<RegistryWebhookEvent> events)

createWebhook

public CreateWebhookResponse createWebhook(CreateRegistryWebhook request)

Create a webhook.

**NOTE**: This endpoint is in Public Preview.

Creates a registry webhook.

deleteComment

public void deleteComment(String id)

deleteComment

public void deleteComment(DeleteCommentRequest request)

Delete a comment.

Deletes a comment on a model version.

deleteModel

public void deleteModel(String name)

deleteModel

public void deleteModel(DeleteModelRequest request)

Delete a model.

Deletes a registered model.

deleteModelTag

public void deleteModelTag(String name,
                           String key)

deleteModelTag

public void deleteModelTag(DeleteModelTagRequest request)

Delete a model tag.

Deletes the tag for a registered model.

deleteModelVersion

public void deleteModelVersion(String name,
                               String version)

deleteModelVersion

public void deleteModelVersion(DeleteModelVersionRequest request)

Delete a model version.

Deletes a model version.

deleteModelVersionTag

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

deleteModelVersionTag

public void deleteModelVersionTag(DeleteModelVersionTagRequest request)

Delete a model version tag.

Deletes a model version tag.

deleteTransitionRequest

public void deleteTransitionRequest(String name,
                                    String version,
                                    DeleteTransitionRequestStage stage,
                                    String creator)

deleteTransitionRequest

public void deleteTransitionRequest(DeleteTransitionRequestRequest request)

Delete a transition request.

Cancels a model version stage transition request.

deleteWebhook

public void deleteWebhook(DeleteWebhookRequest request)

Delete a webhook.

**NOTE:** This endpoint is in Public Preview.

Deletes a registry webhook.

getLatestVersions

public Iterable<ModelVersion> getLatestVersions(String name)

getLatestVersions

public Iterable<ModelVersion> getLatestVersions(GetLatestVersionsRequest request)

Get the latest version.

Gets the latest version of a registered model.

getModel

public GetModelResponse getModel(String name)

getModel

public GetModelResponse getModel(GetModelRequest request)

Get model.

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.

Get a model version.

getModelVersionDownloadUri

public GetModelVersionDownloadUriResponse getModelVersionDownloadUri(String name,
                                                                     String version)

getModelVersionDownloadUri

public GetModelVersionDownloadUriResponse getModelVersionDownloadUri(GetModelVersionDownloadUriRequest request)

Get a model version URI.

Gets a URI to download the model version.

getPermissionLevels

public GetRegisteredModelPermissionLevelsResponse getPermissionLevels(String registeredModelId)

getPermissionLevels

public GetRegisteredModelPermissionLevelsResponse getPermissionLevels(GetRegisteredModelPermissionLevelsRequest request)

Get registered model permission levels.

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

getPermissions

public RegisteredModelPermissions getPermissions(String registeredModelId)

getPermissions

public RegisteredModelPermissions getPermissions(GetRegisteredModelPermissionsRequest request)

Get registered model permissions.

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

listModels

public Iterable<Model> listModels(ListModelsRequest request)

List models.

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)

List transition requests.

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

listWebhooks

public Iterable<RegistryWebhook> listWebhooks(ListWebhooksRequest request)

List registry webhooks.

**NOTE:** This endpoint is in Public Preview.

Lists all registry webhooks.

rejectTransitionRequest

public RejectTransitionRequestResponse rejectTransitionRequest(String name,
                                                               String version,
                                                               Stage stage)

rejectTransitionRequest

public RejectTransitionRequestResponse rejectTransitionRequest(RejectTransitionRequest request)

Reject a transition request.

Rejects a model version stage transition request.

renameModel

public RenameModelResponse renameModel(String name)

renameModel

public RenameModelResponse renameModel(RenameModelRequest request)

Rename a model.

Renames a registered model.

searchModelVersions

public Iterable<ModelVersion> searchModelVersions(SearchModelVersionsRequest request)

Searches model versions.

Searches for specific model versions based on the supplied __filter__.

searchModels

public Iterable<Model> searchModels(SearchModelsRequest request)

Search models.

Search for registered models based on the specified __filter__.

setModelTag

public void setModelTag(String name,
                        String key,
                        String value)

setModelTag

public void setModelTag(SetModelTagRequest request)

Set a tag.

Sets a tag on a registered model.

setModelVersionTag

public void setModelVersionTag(String name,
                               String version,
                               String key,
                               String value)

setModelVersionTag

public void setModelVersionTag(SetModelVersionTagRequest request)

Set a version tag.

Sets a model version tag.

setPermissions

public RegisteredModelPermissions setPermissions(String registeredModelId)

setPermissions

public RegisteredModelPermissions setPermissions(RegisteredModelPermissionsRequest request)

Set registered model permissions.

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

testRegistryWebhook

public TestRegistryWebhookResponse testRegistryWebhook(String id)

testRegistryWebhook

public TestRegistryWebhookResponse testRegistryWebhook(TestRegistryWebhookRequest request)

Test a webhook.

**NOTE:** This endpoint is in Public Preview.

Tests a registry webhook.

transitionStage

public TransitionStageResponse transitionStage(String name,
                                               String version,
                                               Stage stage,
                                               boolean archiveExistingVersions)

transitionStage

public TransitionStageResponse transitionStage(TransitionModelVersionStageDatabricks request)

Transition a stage.

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(String id,
                                           String comment)

updateComment

public UpdateCommentResponse updateComment(UpdateComment request)

Update a comment.

Post an edit to a comment on a model version.

updateModel

public void updateModel(String name)

updateModel

public void updateModel(UpdateModelRequest request)

Update model.

Updates a registered model.

updateModelVersion

public void updateModelVersion(String name,
                               String version)

updateModelVersion

public void updateModelVersion(UpdateModelVersionRequest request)

Update model version.

Updates the model version.

updatePermissions

public RegisteredModelPermissions updatePermissions(String registeredModelId)

updatePermissions

public RegisteredModelPermissions updatePermissions(RegisteredModelPermissionsRequest request)

Update registered model permissions.

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

updateWebhook

public void updateWebhook(String id)

updateWebhook

public void updateWebhook(UpdateRegistryWebhook request)

Update a webhook.

**NOTE:** This endpoint is in Public Preview.

Updates a registry webhook.

impl

public ModelRegistryService impl()