Class ModelRegistryClient

Constructors

constructor

new ModelRegistryClient(options: ClientOptions): ModelRegistryClient
Parameters
- options: ClientOptions
Returns ModelRegistryClient
- Defined in client.ts:159

Methods

approveTransitionRequest

approveTransitionRequest(
req: ApproveTransitionRequest,
options?: CallOptions,
): Promise<ApproveTransitionResponse>
Approves a model version stage transition request.
Parameters
- req: ApproveTransitionRequest
- Optionaloptions: CallOptions
Returns Promise<ApproveTransitionResponse>
- Defined in client.ts:175

createComment

createComment(
req: CreateCommentRequest,
options?: CallOptions,
): Promise<CreateCommentResponse>
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.
Parameters
- req: CreateCommentRequest
- Optionaloptions: CallOptions
Returns Promise<CreateCommentResponse>
- Defined in client.ts:208

createModelVersion

createModelVersion(
req: CreateModelVersionRequest,
options?: CallOptions,
): Promise<CreateModelVersionResponse>
Creates a model version.
Parameters
- req: CreateModelVersionRequest
- Optionaloptions: CallOptions
Returns Promise<CreateModelVersionResponse>
- Defined in client.ts:746

createRegisteredModel

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

createRegistryWebhook

createRegistryWebhook(
req: CreateRegistryWebhookRequest,
options?: CallOptions,
): Promise<CreateRegistryWebhookResponse>
NOTE: This endpoint is in Public Preview. Creates a registry webhook.
Parameters
- req: CreateRegistryWebhookRequest
- Optionaloptions: CallOptions
Returns Promise<CreateRegistryWebhookResponse>
- Defined in client.ts:241

createTransitionRequest

createTransitionRequest(
req: CreateTransitionRequest,
options?: CallOptions,
): Promise<CreateTransitionResponse>
Creates a model version stage transition request.
Parameters
- req: CreateTransitionRequest
- Optionaloptions: CallOptions
Returns Promise<CreateTransitionResponse>
- Defined in client.ts:274

deleteComment

deleteComment(
req: DeleteCommentRequest,
options?: CallOptions,
): Promise<DeleteCommentResponse>
Deletes a comment on a model version.
Parameters
- req: DeleteCommentRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteCommentResponse>
- Defined in client.ts:304

deleteModelVersion

deleteModelVersion(
req: DeleteModelVersionRequest,
options?: CallOptions,
): Promise<DeleteModelVersionResponse>
Deletes a model version.
Parameters
- req: DeleteModelVersionRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteModelVersionResponse>
- Defined in client.ts:812

deleteModelVersionTag

deleteModelVersionTag(
req: DeleteModelVersionTagRequest,
options?: CallOptions,
): Promise<DeleteModelVersionTagResponse>
Deletes a model version tag.
Parameters
- req: DeleteModelVersionTagRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteModelVersionTagResponse>
- Defined in client.ts:850

deleteRegisteredModel

deleteRegisteredModel(
req: DeleteRegisteredModelRequest,
options?: CallOptions,
): Promise<DeleteRegisteredModelResponse>
Deletes a registered model.
Parameters
- req: DeleteRegisteredModelRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteRegisteredModelResponse>
- Defined in client.ts:894

deleteRegisteredModelTag

deleteRegisteredModelTag(
req: DeleteRegisteredModelTagRequest,
options?: CallOptions,
): Promise<DeleteRegisteredModelTagResponse>
Deletes the tag for a registered model.
Parameters
- req: DeleteRegisteredModelTagRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteRegisteredModelTagResponse>
- Defined in client.ts:932

deleteRegistryWebhook

deleteRegistryWebhook(
req: DeleteRegistryWebhookRequest,
options?: CallOptions,
): Promise<DeleteRegistryWebhookResponse>
NOTE: This endpoint is in Public Preview. Deletes a registry webhook.
Parameters
- req: DeleteRegistryWebhookRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteRegistryWebhookResponse>
- Defined in client.ts:342

deleteTransitionRequest

deleteTransitionRequest(
req: DeleteTransitionRequest,
options?: CallOptions,
): Promise<DeleteTransitionResponse>
Cancels a model version stage transition request.
Parameters
- req: DeleteTransitionRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteTransitionResponse>
- Defined in client.ts:380

getModelVersion

getModelVersion(
req: GetModelVersionRequest,
options?: CallOptions,
): Promise<GetModelVersionResponse>
Get a model version.
Parameters
- req: GetModelVersionRequest
- Optionaloptions: CallOptions
Returns Promise<GetModelVersionResponse>
- Defined in client.ts:973

getModelVersionDownloadUri

getModelVersionDownloadUri(
req: GetModelVersionDownloadUriRequest,
options?: CallOptions,
): Promise<GetModelVersionDownloadUriResponse>
Gets a URI to download the model version.
Parameters
- req: GetModelVersionDownloadUriRequest
- Optionaloptions: CallOptions
Returns Promise<GetModelVersionDownloadUriResponse>
- Defined in client.ts:1011

getRegisteredModelDatabricks

getRegisteredModelDatabricks(
req: GetRegisteredModelDatabricksRequest,
options?: CallOptions,
): Promise<GetRegisteredModelDatabricksResponse>
Get the details of a model. This is a workspace version of the MLflow endpoint that also returns the model's workspace ID and the permission level of the requesting user on the model.
Parameters
- req: GetRegisteredModelDatabricksRequest
- Optionaloptions: CallOptions
Returns Promise<GetRegisteredModelDatabricksResponse>
- Defined in client.ts:431

listLatestVersions

listLatestVersions(
req: ListLatestVersionsRequest,
options?: CallOptions,
): Promise<GetLatestVersionsResponse>
Gets the latest version of a registered model.
Parameters
- req: ListLatestVersionsRequest
- Optionaloptions: CallOptions
Returns Promise<GetLatestVersionsResponse>
- Defined in client.ts:1052

listRegisteredModels

listRegisteredModels(
req: ListRegisteredModelsRequest,
options?: CallOptions,
): Promise<ListRegisteredModelsResponse>
Lists all available registered models, up to the limit specified in max_results.
Parameters
- req: ListRegisteredModelsRequest
- Optionaloptions: CallOptions
Returns Promise<ListRegisteredModelsResponse>
- Defined in client.ts:1082

listRegisteredModelsIter

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

listRegistryWebhooks

listRegistryWebhooks(
req: ListRegistryWebhooksRequest,
options?: CallOptions,
): Promise<ListRegistryWebhooksResponse>
NOTE: This endpoint is in Public Preview. Lists all registry webhooks.
Parameters
- req: ListRegistryWebhooksRequest
- Optionaloptions: CallOptions
Returns Promise<ListRegistryWebhooksResponse>
- Defined in client.ts:472

listRegistryWebhooksIter

listRegistryWebhooksIter(
req: ListRegistryWebhooksRequest,
options?: CallOptions,
): AsyncGenerator<RegistryWebhook>
Parameters
- req: ListRegistryWebhooksRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<RegistryWebhook>
- Defined in client.ts:518

listTransitionRequests

listTransitionRequests(
req: ListTransitionRequest,
options?: CallOptions,
): Promise<ListTransitionResponse>
Gets a list of all open stage transition requests for the model version.
Parameters
- req: ListTransitionRequest
- Optionaloptions: CallOptions
Returns Promise<ListTransitionResponse>
- Defined in client.ts:536

rejectTransitionRequest

rejectTransitionRequest(
req: RejectTransitionRequest,
options?: CallOptions,
): Promise<RejectTransitionResponse>
Rejects a model version stage transition request.
Parameters
- req: RejectTransitionRequest
- Optionaloptions: CallOptions
Returns Promise<RejectTransitionResponse>
- Defined in client.ts:574

renameRegisteredModel

renameRegisteredModel(
req: RenameRegisteredModelRequest,
options?: CallOptions,
): Promise<RenameRegisteredModelResponse>
Renames a registered model.
Parameters
- req: RenameRegisteredModelRequest
- Optionaloptions: CallOptions
Returns Promise<RenameRegisteredModelResponse>
- Defined in client.ts:1140

searchModelVersions

searchModelVersions(
req: SearchModelVersionsRequest,
options?: CallOptions,
): Promise<SearchModelVersionsResponse>
Searches for specific model versions based on the supplied filter.
Parameters
- req: SearchModelVersionsRequest
- Optionaloptions: CallOptions
Returns Promise<SearchModelVersionsResponse>
- Defined in client.ts:1173

searchModelVersionsIter

searchModelVersionsIter(
req: SearchModelVersionsRequest,
options?: CallOptions,
): AsyncGenerator<ModelVersion>
Parameters
- req: SearchModelVersionsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ModelVersion>
- Defined in client.ts:1219

searchRegisteredModels

searchRegisteredModels(
req: SearchRegisteredModelsRequest,
options?: CallOptions,
): Promise<SearchRegisteredModelsResponse>
Search for registered models based on the specified filter.
Parameters
- req: SearchRegisteredModelsRequest
- Optionaloptions: CallOptions
Returns Promise<SearchRegisteredModelsResponse>
- Defined in client.ts:1237

searchRegisteredModelsIter

searchRegisteredModelsIter(
req: SearchRegisteredModelsRequest,
options?: CallOptions,
): AsyncGenerator<RegisteredModel>
Parameters
- req: SearchRegisteredModelsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<RegisteredModel>
- Defined in client.ts:1283

setModelVersionTag

setModelVersionTag(
req: SetModelVersionTagRequest,
options?: CallOptions,
): Promise<SetModelVersionTagResponse>
Sets a model version tag.
Parameters
- req: SetModelVersionTagRequest
- Optionaloptions: CallOptions
Returns Promise<SetModelVersionTagResponse>
- Defined in client.ts:1301

setRegisteredModelTag

setRegisteredModelTag(
req: SetRegisteredModelTagRequest,
options?: CallOptions,
): Promise<SetRegisteredModelTagResponse>
Sets a tag on a registered model.
Parameters
- req: SetRegisteredModelTagRequest
- Optionaloptions: CallOptions
Returns Promise<SetRegisteredModelTagResponse>
- Defined in client.ts:1331

testRegistryWebhook

testRegistryWebhook(
req: TestRegistryWebhookRequest,
options?: CallOptions,
): Promise<TestRegistryWebhookResponse>
NOTE: This endpoint is in Public Preview. Tests a registry webhook.
Parameters
- req: TestRegistryWebhookRequest
- Optionaloptions: CallOptions
Returns Promise<TestRegistryWebhookResponse>
- Defined in client.ts:607

transitionModelVersionStageDatabricks

transitionModelVersionStageDatabricks(
req: TransitionModelVersionStageDatabricksRequest,
options?: CallOptions,
): Promise<TransitionModelVersionStageDatabricksResponse>
Transition a model version's stage. This is a workspace version of the MLflow endpoint that also accepts a comment associated with the transition to be recorded.
Parameters
- req: TransitionModelVersionStageDatabricksRequest
- Optionaloptions: CallOptions
Returns Promise<TransitionModelVersionStageDatabricksResponse>
- Defined in client.ts:644

updateComment

updateComment(
req: UpdateCommentRequest,
options?: CallOptions,
): Promise<UpdateCommentResponse>
Post an edit to a comment on a model version.
Parameters
- req: UpdateCommentRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateCommentResponse>
- Defined in client.ts:680

updateModelVersion

updateModelVersion(
req: UpdateModelVersionRequest,
options?: CallOptions,
): Promise<UpdateModelVersionResponse>
Updates the model version.
Parameters
- req: UpdateModelVersionRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateModelVersionResponse>
- Defined in client.ts:1364

updateRegisteredModel

updateRegisteredModel(
req: UpdateRegisteredModelRequest,
options?: CallOptions,
): Promise<UpdateRegisteredModelResponse>
Updates a registered model.
Parameters
- req: UpdateRegisteredModelRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateRegisteredModelResponse>
- Defined in client.ts:1394

updateRegistryWebhook

updateRegistryWebhook(
req: UpdateRegistryWebhookRequest,
options?: CallOptions,
): Promise<UpdateRegistryWebhookResponse>
NOTE: This endpoint is in Public Preview. Updates a registry webhook.
Parameters
- req: UpdateRegistryWebhookRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateRegistryWebhookResponse>
- Defined in client.ts:713

Class ModelRegistryClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ModelRegistryClient

Methods

approveTransitionRequest

Parameters

Returns Promise<ApproveTransitionResponse>

createComment

Parameters

Returns Promise<CreateCommentResponse>

createModelVersion

Parameters

Returns Promise<CreateModelVersionResponse>

createRegisteredModel

Parameters

Returns Promise<CreateRegisteredModelResponse>

createRegistryWebhook

Parameters

Returns Promise<CreateRegistryWebhookResponse>

createTransitionRequest

Parameters

Returns Promise<CreateTransitionResponse>

deleteComment

Parameters

Returns Promise<DeleteCommentResponse>

deleteModelVersion

Parameters

Returns Promise<DeleteModelVersionResponse>

deleteModelVersionTag

Parameters

Returns Promise<DeleteModelVersionTagResponse>

deleteRegisteredModel

Parameters

Returns Promise<DeleteRegisteredModelResponse>

deleteRegisteredModelTag

Parameters

Returns Promise<DeleteRegisteredModelTagResponse>

deleteRegistryWebhook

Parameters

Returns Promise<DeleteRegistryWebhookResponse>

deleteTransitionRequest

Parameters

Returns Promise<DeleteTransitionResponse>

getModelVersion

Parameters

Returns Promise<GetModelVersionResponse>

getModelVersionDownloadUri

Parameters

Returns Promise<GetModelVersionDownloadUriResponse>

getRegisteredModelDatabricks

Parameters

Returns Promise<GetRegisteredModelDatabricksResponse>

listLatestVersions

Parameters

Returns Promise<GetLatestVersionsResponse>

listRegisteredModels

Parameters

Returns Promise<ListRegisteredModelsResponse>

listRegisteredModelsIter

Parameters

Returns AsyncGenerator<RegisteredModel>

listRegistryWebhooks

Parameters

Returns Promise<ListRegistryWebhooksResponse>

listRegistryWebhooksIter

Parameters

Returns AsyncGenerator<RegistryWebhook>

listTransitionRequests

Parameters

Returns Promise<ListTransitionResponse>

rejectTransitionRequest

Parameters

Returns Promise<RejectTransitionResponse>

renameRegisteredModel

Parameters