Class RegisteredModelsClient

Index

Constructors

Methods

createRegisteredModel deleteModelVersion deleteRegisteredModel deleteRegisteredModelAlias getModelVersion getModelVersionByAlias getRegisteredModel listModelVersions listModelVersionsIter listRegisteredModels listRegisteredModelsIter setRegisteredModelAlias updateModelVersion updateRegisteredModel

Constructors

constructor

new RegisteredModelsClient(options: ClientOptions): RegisteredModelsClient
Parameters
- options: ClientOptions
Returns RegisteredModelsClient
- Defined in client.ts:74

Methods

createRegisteredModel

createRegisteredModel(
req: CreateRegisteredModelRequest,
options?: CallOptions,
): Promise<RegisteredModelInfo>
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.
Parameters
- req: CreateRegisteredModelRequest
- Optionaloptions: CallOptions
Returns Promise<RegisteredModelInfo>
- Defined in client.ts:102

deleteModelVersion

deleteModelVersion(
req: DeleteModelVersionRequest,
options?: CallOptions,
): Promise<DeleteModelVersionResponse>
Deletes a model version from the specified registered model. Any aliases assigned to the model version will also be deleted.

The caller must be a metastore admin or an owner of the parent 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.
Parameters
- req: DeleteModelVersionRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteModelVersionResponse>
- Defined in client.ts:139

deleteRegisteredModel

deleteRegisteredModel(
req: DeleteRegisteredModelRequest,
options?: CallOptions,
): Promise<DeleteRegisteredModelResponse>
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.
Parameters
- req: DeleteRegisteredModelRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteRegisteredModelResponse>
- Defined in client.ts:174

deleteRegisteredModelAlias

deleteRegisteredModelAlias(
req: DeleteRegisteredModelAliasRequest,
options?: CallOptions,
): Promise<DeleteRegisteredModelAliasResponse>
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.
Parameters
- req: DeleteRegisteredModelAliasRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteRegisteredModelAliasResponse>
- Defined in client.ts:212

getModelVersion

getModelVersion(
req: GetModelVersionRequest,
options?: CallOptions,
): Promise<ModelVersionInfo>
Get a model version.

The caller must be a metastore admin or an owner of (or have the EXECUTE privilege on) the parent 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.
Parameters
- req: GetModelVersionRequest
- Optionaloptions: CallOptions
Returns Promise<ModelVersionInfo>
- Defined in client.ts:251

getModelVersionByAlias

getModelVersionByAlias(
req: GetModelVersionByAliasRequest,
options?: CallOptions,
): Promise<ModelVersionInfo>
Get a model version by alias.

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.
Parameters
- req: GetModelVersionByAliasRequest
- Optionaloptions: CallOptions
Returns Promise<ModelVersionInfo>
- Defined in client.ts:296

getRegisteredModel

getRegisteredModel(
req: GetRegisteredModelRequest,
options?: CallOptions,
): Promise<RegisteredModelInfo>
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.
Parameters
- req: GetRegisteredModelRequest
- Optionaloptions: CallOptions
Returns Promise<RegisteredModelInfo>
- Defined in client.ts:338

listModelVersions

listModelVersions(
req: ListModelVersionsRequest,
options?: CallOptions,
): Promise<ListModelVersionsResponse>
List model versions. You can list model versions under a particular schema, or list all model versions 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 model versions. A regular user needs to be the owner or have the EXECUTE privilege on the parent registered model to receive the model versions 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. The elements in the response will not contain any aliases or tags.

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.
Parameters
- req: ListModelVersionsRequest
- Optionaloptions: CallOptions
Returns Promise<ListModelVersionsResponse>
- Defined in client.ts:392

listModelVersionsIter

listModelVersionsIter(
req: ListModelVersionsRequest,
options?: CallOptions,
): AsyncGenerator<ModelVersionInfo>
Parameters
- req: ListModelVersionsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ModelVersionInfo>
- Defined in client.ts:432

listRegisteredModels

listRegisteredModels(
req: ListRegisteredModelsRequest,
options?: CallOptions,
): Promise<ListRegisteredModelsResponse>
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 receive 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.
Parameters
- req: ListRegisteredModelsRequest
- Optionaloptions: CallOptions
Returns Promise<ListRegisteredModelsResponse>
- Defined in client.ts:465

listRegisteredModelsIter

listRegisteredModelsIter(
req: ListRegisteredModelsRequest,
options?: CallOptions,
): AsyncGenerator<RegisteredModelInfo>
Parameters
- req: ListRegisteredModelsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<RegisteredModelInfo>
- Defined in client.ts:514

setRegisteredModelAlias

setRegisteredModelAlias(
req: SetRegisteredModelAliasRequest,
options?: CallOptions,
): Promise<RegisteredModelAliasInfo>
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.
Parameters
- req: SetRegisteredModelAliasRequest
- Optionaloptions: CallOptions
Returns Promise<RegisteredModelAliasInfo>
- Defined in client.ts:538

updateModelVersion

updateModelVersion(
req: UpdateModelVersionRequest,
options?: CallOptions,
): Promise<ModelVersionInfo>
Updates the specified model version.

The caller must be a metastore admin or an owner of the parent 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 comment of the model version can be updated.
Parameters
- req: UpdateModelVersionRequest
- Optionaloptions: CallOptions
Returns Promise<ModelVersionInfo>
- Defined in client.ts:579

updateRegisteredModel

updateRegisteredModel(
req: UpdateRegisteredModelRequest,
options?: CallOptions,
): Promise<RegisteredModelInfo>
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.
Parameters
- req: UpdateRegisteredModelRequest
- Optionaloptions: CallOptions
Returns Promise<RegisteredModelInfo>
- Defined in client.ts:617

Class RegisteredModelsClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RegisteredModelsClient

Methods

createRegisteredModel

Parameters

Returns Promise<RegisteredModelInfo>

deleteModelVersion

Parameters

Returns Promise<DeleteModelVersionResponse>

deleteRegisteredModel

Parameters

Returns Promise<DeleteRegisteredModelResponse>

deleteRegisteredModelAlias

Parameters

Returns Promise<DeleteRegisteredModelAliasResponse>

getModelVersion

Parameters

Returns Promise<ModelVersionInfo>

getModelVersionByAlias

Parameters

Returns Promise<ModelVersionInfo>

getRegisteredModel

Parameters

Returns Promise<RegisteredModelInfo>

listModelVersions

Parameters

Returns Promise<ListModelVersionsResponse>

listModelVersionsIter

Parameters

Returns AsyncGenerator<ModelVersionInfo>

listRegisteredModels

Parameters

Returns Promise<ListRegisteredModelsResponse>

listRegisteredModelsIter

Parameters

Returns AsyncGenerator<RegisteredModelInfo>

setRegisteredModelAlias

Parameters

Returns Promise<RegisteredModelAliasInfo>

updateModelVersion

Parameters

Returns Promise<ModelVersionInfo>

updateRegisteredModel

Parameters

Returns Promise<RegisteredModelInfo>

Settings

On This Page