com.databricks.sdk.service.catalog

Interface RegisteredModelsService

@Generated
public interface RegisteredModelsService

Databricks provides a hosted version of MLflow Model Registry in Unity Catalog. Models in Unity Catalog provide centralized access control, auditing, lineage, and discovery of ML models across Databricks workspaces.

An MLflow registered model resides in the third layer of Unity Catalog’s three-level namespace. Registered models contain model versions, which correspond to actual ML models (MLflow models). Creating new model versions currently requires use of the MLflow Python client. Once model versions are created, you can load them for batch inference using MLflow Python client APIs, or deploy them for real-time serving using Databricks Model Serving.

All operations on registered models and model versions require USE_CATALOG permissions on the enclosing catalog and USE_SCHEMA permissions on the enclosing schema. In addition, the following additional privileges are required for various operations:

* To create a registered model, users must additionally have the CREATE_MODEL permission on the target schema. * To view registered model or model version metadata, model version data files, or invoke a model version, users must additionally have the EXECUTE permission on the registered model * To update registered model or model version tags, users must additionally have APPLY TAG permissions on the registered model * To update other registered model or model version metadata (comments, aliases) create a new model version, or update permissions on the registered model, users must be owners of the registered model.

Note: The securable type for models is FUNCTION. When using REST APIs (e.g. tagging, grants) that specify a securable type, use FUNCTION as the securable type.

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
RegisteredModelInfo	create(CreateRegisteredModelRequest createRegisteredModelRequest) Creates a new registered model in Unity Catalog.
void	delete(DeleteRegisteredModelRequest deleteRegisteredModelRequest) Deletes a registered model and all its model versions from the specified parent catalog and schema.
void	deleteAlias(DeleteAliasRequest deleteAliasRequest) Deletes a registered model alias.
RegisteredModelInfo	get(GetRegisteredModelRequest getRegisteredModelRequest) Get a registered model.
ListRegisteredModelsResponse	list(ListRegisteredModelsRequest listRegisteredModelsRequest) List registered models.
RegisteredModelAlias	setAlias(SetRegisteredModelAliasRequest setRegisteredModelAliasRequest) Set an alias on the specified registered model.
RegisteredModelInfo	update(UpdateRegisteredModelRequest updateRegisteredModelRequest) Updates the specified registered model.

Method Detail

create

RegisteredModelInfo create(CreateRegisteredModelRequest createRegisteredModelRequest)

Creates a new registered model in Unity Catalog.

File storage for model versions in the registered model will be located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.

For registered model creation to succeed, the user must satisfy the following conditions: - The caller must be a metastore admin, or be the owner of the parent catalog and schema, or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - The caller must have the **CREATE MODEL** or **CREATE FUNCTION** privilege on the parent schema.

delete

void delete(DeleteRegisteredModelRequest deleteRegisteredModelRequest)

Deletes a registered model and all its model versions from the specified parent catalog and schema.

The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

deleteAlias

void deleteAlias(DeleteAliasRequest deleteAliasRequest)

Deletes a registered model alias.

The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

get

RegisteredModelInfo get(GetRegisteredModelRequest getRegisteredModelRequest)

Get a registered model.

The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

list

ListRegisteredModelsResponse list(ListRegisteredModelsRequest listRegisteredModelsRequest)

List registered models. You can list registered models under a particular schema, or list all registered models in the current metastore.

The returned models are filtered based on the privileges of the calling user. For example, the metastore admin is able to list all the registered models. A regular user needs to be the owner or have the **EXECUTE** privilege on the registered model to recieve the registered models in the response. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

There is no guarantee of a specific ordering of the elements in the response.

PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

setAlias

RegisteredModelAlias setAlias(SetRegisteredModelAliasRequest setRegisteredModelAliasRequest)

Set an alias on the specified registered model.

The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

update

RegisteredModelInfo update(UpdateRegisteredModelRequest updateRegisteredModelRequest)

Updates the specified registered model.

The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

Currently only the name, the owner or the comment of the registered model can be updated.