Class protos.google.cloud.aiplatform.v1.ModelService (3.9.0)

Represents a ModelService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1.ModelService

Package

@google-cloud/aiplatform

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ModelService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchImportEvaluatedAnnotations(request, callback)

public batchImportEvaluatedAnnotations(request: google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsRequest, callback: google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotationsCallback): void;

Calls BatchImportEvaluatedAnnotations.

Parameters
Name Description
request IBatchImportEvaluatedAnnotationsRequest

BatchImportEvaluatedAnnotationsRequest message or plain object
callback BatchImportEvaluatedAnnotationsCallback

Node-style callback called with the error, if any, and BatchImportEvaluatedAnnotationsResponse
Returns
Type Description
void

batchImportEvaluatedAnnotations(request)

public batchImportEvaluatedAnnotations(request: google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsRequest): Promise<google.cloud.aiplatform.v1.BatchImportEvaluatedAnnotationsResponse>;

Calls BatchImportEvaluatedAnnotations.

Parameter
Name Description
request IBatchImportEvaluatedAnnotationsRequest

BatchImportEvaluatedAnnotationsRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.BatchImportEvaluatedAnnotationsResponse>

Promise

batchImportModelEvaluationSlices(request, callback)

public batchImportModelEvaluationSlices(request: google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesRequest, callback: google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlicesCallback): void;

Calls BatchImportModelEvaluationSlices.

Parameters
Name Description
request IBatchImportModelEvaluationSlicesRequest

BatchImportModelEvaluationSlicesRequest message or plain object
callback BatchImportModelEvaluationSlicesCallback

Node-style callback called with the error, if any, and BatchImportModelEvaluationSlicesResponse
Returns
Type Description
void

batchImportModelEvaluationSlices(request)

public batchImportModelEvaluationSlices(request: google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesRequest): Promise<google.cloud.aiplatform.v1.BatchImportModelEvaluationSlicesResponse>;

Calls BatchImportModelEvaluationSlices.

Parameter
Name Description
request IBatchImportModelEvaluationSlicesRequest

BatchImportModelEvaluationSlicesRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.BatchImportModelEvaluationSlicesResponse>

Promise

copyModel(request, callback)

public copyModel(request: google.cloud.aiplatform.v1.ICopyModelRequest, callback: google.cloud.aiplatform.v1.ModelService.CopyModelCallback): void;

Calls CopyModel.

Parameters
Name Description
request ICopyModelRequest

CopyModelRequest message or plain object
callback CopyModelCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

copyModel(request)

public copyModel(request: google.cloud.aiplatform.v1.ICopyModelRequest): Promise<google.longrunning.Operation>;

Calls CopyModel.

Parameter
Name Description
request ICopyModelRequest

CopyModelRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ModelService;

Creates new ModelService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
ModelService

RPC service. Useful where requests and/or responses are streamed.

deleteModel(request, callback)

public deleteModel(request: google.cloud.aiplatform.v1.IDeleteModelRequest, callback: google.cloud.aiplatform.v1.ModelService.DeleteModelCallback): void;

Calls DeleteModel.

Parameters
Name Description
request IDeleteModelRequest

DeleteModelRequest message or plain object
callback DeleteModelCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteModel(request)

public deleteModel(request: google.cloud.aiplatform.v1.IDeleteModelRequest): Promise<google.longrunning.Operation>;

Calls DeleteModel.

Parameter
Name Description
request IDeleteModelRequest

DeleteModelRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteModelVersion(request, callback)

public deleteModelVersion(request: google.cloud.aiplatform.v1.IDeleteModelVersionRequest, callback: google.cloud.aiplatform.v1.ModelService.DeleteModelVersionCallback): void;

Calls DeleteModelVersion.

Parameters
Name Description
request IDeleteModelVersionRequest

DeleteModelVersionRequest message or plain object
callback DeleteModelVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteModelVersion(request)

public deleteModelVersion(request: google.cloud.aiplatform.v1.IDeleteModelVersionRequest): Promise<google.longrunning.Operation>;

Calls DeleteModelVersion.

Parameter
Name Description
request IDeleteModelVersionRequest

DeleteModelVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

exportModel(request, callback)

public exportModel(request: google.cloud.aiplatform.v1.IExportModelRequest, callback: google.cloud.aiplatform.v1.ModelService.ExportModelCallback): void;

Calls ExportModel.

Parameters
Name Description
request IExportModelRequest

ExportModelRequest message or plain object
callback ExportModelCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

exportModel(request)

public exportModel(request: google.cloud.aiplatform.v1.IExportModelRequest): Promise<google.longrunning.Operation>;

Calls ExportModel.

Parameter
Name Description
request IExportModelRequest

ExportModelRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getModel(request, callback)

public getModel(request: google.cloud.aiplatform.v1.IGetModelRequest, callback: google.cloud.aiplatform.v1.ModelService.GetModelCallback): void;

Calls GetModel.

Parameters
Name Description
request IGetModelRequest

GetModelRequest message or plain object
callback GetModelCallback

Node-style callback called with the error, if any, and Model
Returns
Type Description
void

getModel(request)

public getModel(request: google.cloud.aiplatform.v1.IGetModelRequest): Promise<google.cloud.aiplatform.v1.Model>;

Calls GetModel.

Parameter
Name Description
request IGetModelRequest

GetModelRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.Model>

Promise

getModelEvaluation(request, callback)

public getModelEvaluation(request: google.cloud.aiplatform.v1.IGetModelEvaluationRequest, callback: google.cloud.aiplatform.v1.ModelService.GetModelEvaluationCallback): void;

Calls GetModelEvaluation.

Parameters
Name Description
request IGetModelEvaluationRequest

GetModelEvaluationRequest message or plain object
callback GetModelEvaluationCallback

Node-style callback called with the error, if any, and ModelEvaluation
Returns
Type Description
void

getModelEvaluation(request)

public getModelEvaluation(request: google.cloud.aiplatform.v1.IGetModelEvaluationRequest): Promise<google.cloud.aiplatform.v1.ModelEvaluation>;

Calls GetModelEvaluation.

Parameter
Name Description
request IGetModelEvaluationRequest

GetModelEvaluationRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.ModelEvaluation>

Promise

getModelEvaluationSlice(request, callback)

public getModelEvaluationSlice(request: google.cloud.aiplatform.v1.IGetModelEvaluationSliceRequest, callback: google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSliceCallback): void;

Calls GetModelEvaluationSlice.

Parameters
Name Description
request IGetModelEvaluationSliceRequest

GetModelEvaluationSliceRequest message or plain object
callback GetModelEvaluationSliceCallback

Node-style callback called with the error, if any, and ModelEvaluationSlice
Returns
Type Description
void

getModelEvaluationSlice(request)

public getModelEvaluationSlice(request: google.cloud.aiplatform.v1.IGetModelEvaluationSliceRequest): Promise<google.cloud.aiplatform.v1.ModelEvaluationSlice>;

Calls GetModelEvaluationSlice.

Parameter
Name Description
request IGetModelEvaluationSliceRequest

GetModelEvaluationSliceRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.ModelEvaluationSlice>

Promise

importModelEvaluation(request, callback)

public importModelEvaluation(request: google.cloud.aiplatform.v1.IImportModelEvaluationRequest, callback: google.cloud.aiplatform.v1.ModelService.ImportModelEvaluationCallback): void;

Calls ImportModelEvaluation.

Parameters
Name Description
request IImportModelEvaluationRequest

ImportModelEvaluationRequest message or plain object
callback ImportModelEvaluationCallback

Node-style callback called with the error, if any, and ModelEvaluation
Returns
Type Description
void

importModelEvaluation(request)

public importModelEvaluation(request: google.cloud.aiplatform.v1.IImportModelEvaluationRequest): Promise<google.cloud.aiplatform.v1.ModelEvaluation>;

Calls ImportModelEvaluation.

Parameter
Name Description
request IImportModelEvaluationRequest

ImportModelEvaluationRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.ModelEvaluation>

Promise

listModelEvaluations(request, callback)

public listModelEvaluations(request: google.cloud.aiplatform.v1.IListModelEvaluationsRequest, callback: google.cloud.aiplatform.v1.ModelService.ListModelEvaluationsCallback): void;

Calls ListModelEvaluations.

Parameters
Name Description
request IListModelEvaluationsRequest

ListModelEvaluationsRequest message or plain object
callback ListModelEvaluationsCallback

Node-style callback called with the error, if any, and ListModelEvaluationsResponse
Returns
Type Description
void

listModelEvaluations(request)

public listModelEvaluations(request: google.cloud.aiplatform.v1.IListModelEvaluationsRequest): Promise<google.cloud.aiplatform.v1.ListModelEvaluationsResponse>;

Calls ListModelEvaluations.

Parameter
Name Description
request IListModelEvaluationsRequest

ListModelEvaluationsRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.ListModelEvaluationsResponse>

Promise

listModelEvaluationSlices(request, callback)

public listModelEvaluationSlices(request: google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, callback: google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlicesCallback): void;

Calls ListModelEvaluationSlices.

Parameters
Name Description
request IListModelEvaluationSlicesRequest

ListModelEvaluationSlicesRequest message or plain object
callback ListModelEvaluationSlicesCallback

Node-style callback called with the error, if any, and ListModelEvaluationSlicesResponse
Returns
Type Description
void

listModelEvaluationSlices(request)

public listModelEvaluationSlices(request: google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest): Promise<google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse>;

Calls ListModelEvaluationSlices.

Parameter
Name Description
request IListModelEvaluationSlicesRequest

ListModelEvaluationSlicesRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse>

Promise

listModels(request, callback)

public listModels(request: google.cloud.aiplatform.v1.IListModelsRequest, callback: google.cloud.aiplatform.v1.ModelService.ListModelsCallback): void;

Calls ListModels.

Parameters
Name Description
request IListModelsRequest

ListModelsRequest message or plain object
callback ListModelsCallback

Node-style callback called with the error, if any, and ListModelsResponse
Returns
Type Description
void

listModels(request)

public listModels(request: google.cloud.aiplatform.v1.IListModelsRequest): Promise<google.cloud.aiplatform.v1.ListModelsResponse>;

Calls ListModels.

Parameter
Name Description
request IListModelsRequest

ListModelsRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.ListModelsResponse>

Promise

listModelVersions(request, callback)

public listModelVersions(request: google.cloud.aiplatform.v1.IListModelVersionsRequest, callback: google.cloud.aiplatform.v1.ModelService.ListModelVersionsCallback): void;

Calls ListModelVersions.

Parameters
Name Description
request IListModelVersionsRequest

ListModelVersionsRequest message or plain object
callback ListModelVersionsCallback

Node-style callback called with the error, if any, and ListModelVersionsResponse
Returns
Type Description
void

listModelVersions(request)

public listModelVersions(request: google.cloud.aiplatform.v1.IListModelVersionsRequest): Promise<google.cloud.aiplatform.v1.ListModelVersionsResponse>;

Calls ListModelVersions.

Parameter
Name Description
request IListModelVersionsRequest

ListModelVersionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.ListModelVersionsResponse>

Promise

mergeVersionAliases(request, callback)

public mergeVersionAliases(request: google.cloud.aiplatform.v1.IMergeVersionAliasesRequest, callback: google.cloud.aiplatform.v1.ModelService.MergeVersionAliasesCallback): void;

Calls MergeVersionAliases.

Parameters
Name Description
request IMergeVersionAliasesRequest

MergeVersionAliasesRequest message or plain object
callback MergeVersionAliasesCallback

Node-style callback called with the error, if any, and Model
Returns
Type Description
void

mergeVersionAliases(request)

public mergeVersionAliases(request: google.cloud.aiplatform.v1.IMergeVersionAliasesRequest): Promise<google.cloud.aiplatform.v1.Model>;

Calls MergeVersionAliases.

Parameter
Name Description
request IMergeVersionAliasesRequest

MergeVersionAliasesRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.Model>

Promise

updateExplanationDataset(request, callback)

public updateExplanationDataset(request: google.cloud.aiplatform.v1.IUpdateExplanationDatasetRequest, callback: google.cloud.aiplatform.v1.ModelService.UpdateExplanationDatasetCallback): void;

Calls UpdateExplanationDataset.

Parameters
Name Description
request IUpdateExplanationDatasetRequest

UpdateExplanationDatasetRequest message or plain object
callback UpdateExplanationDatasetCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateExplanationDataset(request)

public updateExplanationDataset(request: google.cloud.aiplatform.v1.IUpdateExplanationDatasetRequest): Promise<google.longrunning.Operation>;

Calls UpdateExplanationDataset.

Parameter
Name Description
request IUpdateExplanationDatasetRequest

UpdateExplanationDatasetRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateModel(request, callback)

public updateModel(request: google.cloud.aiplatform.v1.IUpdateModelRequest, callback: google.cloud.aiplatform.v1.ModelService.UpdateModelCallback): void;

Calls UpdateModel.

Parameters
Name Description
request IUpdateModelRequest

UpdateModelRequest message or plain object
callback UpdateModelCallback

Node-style callback called with the error, if any, and Model
Returns
Type Description
void

updateModel(request)

public updateModel(request: google.cloud.aiplatform.v1.IUpdateModelRequest): Promise<google.cloud.aiplatform.v1.Model>;

Calls UpdateModel.

Parameter
Name Description
request IUpdateModelRequest

UpdateModelRequest message or plain object
Returns
Type Description
Promise<google.cloud.aiplatform.v1.Model>

Promise

uploadModel(request, callback)

public uploadModel(request: google.cloud.aiplatform.v1.IUploadModelRequest, callback: google.cloud.aiplatform.v1.ModelService.UploadModelCallback): void;

Calls UploadModel.

Parameters
Name Description
request IUploadModelRequest

UploadModelRequest message or plain object
callback UploadModelCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

uploadModel(request)

public uploadModel(request: google.cloud.aiplatform.v1.IUploadModelRequest): Promise<google.longrunning.Operation>;

Calls UploadModel.

Parameter
Name Description
request IUploadModelRequest

UploadModelRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise