com.databricks.sdk.service.ml.ModelRegistryService Maven / Gradle / Ivy
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.ml;
import com.databricks.sdk.support.Generated;
/**
* 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.
*/
@Generated
public interface ModelRegistryService {
/**
* Approve transition request.
*
*
Approves a model version stage transition request.
*/
ApproveTransitionRequestResponse approveTransitionRequest(
ApproveTransitionRequest approveTransitionRequest);
/**
* 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.
*/
CreateCommentResponse createComment(CreateComment createComment);
/**
* 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.
*/
CreateModelResponse createModel(CreateModelRequest createModelRequest);
/**
* Create a model version.
*
*
Creates a model version.
*/
CreateModelVersionResponse createModelVersion(
CreateModelVersionRequest createModelVersionRequest);
/**
* Make a transition request.
*
*
Creates a model version stage transition request.
*/
CreateTransitionRequestResponse createTransitionRequest(
CreateTransitionRequest createTransitionRequest);
/**
* Create a webhook.
*
*
**NOTE**: This endpoint is in Public Preview.
*
*
Creates a registry webhook.
*/
CreateWebhookResponse createWebhook(CreateRegistryWebhook createRegistryWebhook);
/**
* Delete a comment.
*
*
Deletes a comment on a model version.
*/
void deleteComment(DeleteCommentRequest deleteCommentRequest);
/**
* Delete a model.
*
*
Deletes a registered model.
*/
void deleteModel(DeleteModelRequest deleteModelRequest);
/**
* Delete a model tag.
*
*
Deletes the tag for a registered model.
*/
void deleteModelTag(DeleteModelTagRequest deleteModelTagRequest);
/**
* Delete a model version.
*
*
Deletes a model version.
*/
void deleteModelVersion(DeleteModelVersionRequest deleteModelVersionRequest);
/**
* Delete a model version tag.
*
*
Deletes a model version tag.
*/
void deleteModelVersionTag(DeleteModelVersionTagRequest deleteModelVersionTagRequest);
/**
* Delete a transition request.
*
*
Cancels a model version stage transition request.
*/
void deleteTransitionRequest(DeleteTransitionRequestRequest deleteTransitionRequestRequest);
/**
* Delete a webhook.
*
*
**NOTE:** This endpoint is in Public Preview.
*
*
Deletes a registry webhook.
*/
void deleteWebhook(DeleteWebhookRequest deleteWebhookRequest);
/**
* Get the latest version.
*
*
Gets the latest version of a registered model.
*/
GetLatestVersionsResponse getLatestVersions(GetLatestVersionsRequest getLatestVersionsRequest);
/**
* 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
*/
GetModelResponse getModel(GetModelRequest getModelRequest);
/**
* Get a model version.
*
*
Get a model version.
*/
GetModelVersionResponse getModelVersion(GetModelVersionRequest getModelVersionRequest);
/**
* Get a model version URI.
*
*
Gets a URI to download the model version.
*/
GetModelVersionDownloadUriResponse getModelVersionDownloadUri(
GetModelVersionDownloadUriRequest getModelVersionDownloadUriRequest);
/**
* Get registered model permission levels.
*
*
Gets the permission levels that a user can have on an object.
*/
GetRegisteredModelPermissionLevelsResponse getPermissionLevels(
GetRegisteredModelPermissionLevelsRequest getRegisteredModelPermissionLevelsRequest);
/**
* Get registered model permissions.
*
*
Gets the permissions of a registered model. Registered models can inherit permissions from
* their root object.
*/
RegisteredModelPermissions getPermissions(
GetRegisteredModelPermissionsRequest getRegisteredModelPermissionsRequest);
/**
* List models.
*
*
Lists all available registered models, up to the limit specified in __max_results__.
*/
ListModelsResponse listModels(ListModelsRequest listModelsRequest);
/**
* List transition requests.
*
*
Gets a list of all open stage transition requests for the model version.
*/
ListTransitionRequestsResponse listTransitionRequests(
ListTransitionRequestsRequest listTransitionRequestsRequest);
/**
* List registry webhooks.
*
*
**NOTE:** This endpoint is in Public Preview.
*
*
Lists all registry webhooks.
*/
ListRegistryWebhooks listWebhooks(ListWebhooksRequest listWebhooksRequest);
/**
* Reject a transition request.
*
*
Rejects a model version stage transition request.
*/
RejectTransitionRequestResponse rejectTransitionRequest(
RejectTransitionRequest rejectTransitionRequest);
/**
* Rename a model.
*
*
Renames a registered model.
*/
RenameModelResponse renameModel(RenameModelRequest renameModelRequest);
/**
* Searches model versions.
*
*
Searches for specific model versions based on the supplied __filter__.
*/
SearchModelVersionsResponse searchModelVersions(
SearchModelVersionsRequest searchModelVersionsRequest);
/**
* Search models.
*
*
Search for registered models based on the specified __filter__.
*/
SearchModelsResponse searchModels(SearchModelsRequest searchModelsRequest);
/**
* Set a tag.
*
*
Sets a tag on a registered model.
*/
void setModelTag(SetModelTagRequest setModelTagRequest);
/**
* Set a version tag.
*
*
Sets a model version tag.
*/
void setModelVersionTag(SetModelVersionTagRequest setModelVersionTagRequest);
/**
* Set registered model permissions.
*
*
Sets permissions on a registered model. Registered models can inherit permissions from their
* root object.
*/
RegisteredModelPermissions setPermissions(
RegisteredModelPermissionsRequest registeredModelPermissionsRequest);
/**
* Test a webhook.
*
*
**NOTE:** This endpoint is in Public Preview.
*
*
Tests a registry webhook.
*/
TestRegistryWebhookResponse testRegistryWebhook(
TestRegistryWebhookRequest testRegistryWebhookRequest);
/**
* 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
*/
TransitionStageResponse transitionStage(
TransitionModelVersionStageDatabricks transitionModelVersionStageDatabricks);
/**
* Update a comment.
*
*
Post an edit to a comment on a model version.
*/
UpdateCommentResponse updateComment(UpdateComment updateComment);
/**
* Update model.
*
*
Updates a registered model.
*/
void updateModel(UpdateModelRequest updateModelRequest);
/**
* Update model version.
*
*
Updates the model version.
*/
void updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest);
/**
* Update registered model permissions.
*
*
Updates the permissions on a registered model. Registered models can inherit permissions
* from their root object.
*/
RegisteredModelPermissions updatePermissions(
RegisteredModelPermissionsRequest registeredModelPermissionsRequest);
/**
* Update a webhook.
*
*
**NOTE:** This endpoint is in Public Preview.
*
*
Updates a registry webhook.
*/
void updateWebhook(UpdateRegistryWebhook updateRegistryWebhook);
}