Cloud AI Platform v1 API - Class ModelService.ModelServiceClient (2.25.0)

Version 2.25.0

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class ModelService.ModelServiceClient : ClientBase<ModelService.ModelServiceClient>

Reference documentation and code samples for the Cloud AI Platform v1 API class ModelService.ModelServiceClient.

Client for ModelService

Inheritance

object > ClientBase > ClientBaseModelServiceModelServiceClient > ModelService.ModelServiceClient

Inherited Members

ClientBase<ModelService.ModelServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ModelServiceClient()

protected ModelServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ModelServiceClient(CallInvoker)

public ModelServiceClient(CallInvoker callInvoker)

Creates a new client for ModelService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ModelServiceClient(ChannelBase)

public ModelServiceClient(ChannelBase channel)

Creates a new client for ModelService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ModelServiceClient(ClientBaseConfiguration)

protected ModelServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest, CallOptions)

public virtual BatchImportEvaluatedAnnotationsResponse BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request, CallOptions options)

Imports a list of externally generated EvaluatedAnnotations.

Parameters
Name	Description
request	BatchImportEvaluatedAnnotationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BatchImportEvaluatedAnnotationsResponse	The response received from the server.

BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchImportEvaluatedAnnotationsResponse BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Imports a list of externally generated EvaluatedAnnotations.

Parameters
Name	Description
request	BatchImportEvaluatedAnnotationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BatchImportEvaluatedAnnotationsResponse	The response received from the server.

BatchImportEvaluatedAnnotationsAsync(BatchImportEvaluatedAnnotationsRequest, CallOptions)

public virtual AsyncUnaryCall<BatchImportEvaluatedAnnotationsResponse> BatchImportEvaluatedAnnotationsAsync(BatchImportEvaluatedAnnotationsRequest request, CallOptions options)

Imports a list of externally generated EvaluatedAnnotations.

Parameters
Name	Description
request	BatchImportEvaluatedAnnotationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBatchImportEvaluatedAnnotationsResponse	The call object.

BatchImportEvaluatedAnnotationsAsync(BatchImportEvaluatedAnnotationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchImportEvaluatedAnnotationsResponse> BatchImportEvaluatedAnnotationsAsync(BatchImportEvaluatedAnnotationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Imports a list of externally generated EvaluatedAnnotations.

Parameters
Name	Description
request	BatchImportEvaluatedAnnotationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBatchImportEvaluatedAnnotationsResponse	The call object.

BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest, CallOptions)

public virtual BatchImportModelEvaluationSlicesResponse BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request, CallOptions options)

Imports a list of externally generated ModelEvaluationSlice.

Parameters
Name	Description
request	BatchImportModelEvaluationSlicesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
BatchImportModelEvaluationSlicesResponse	The response received from the server.

BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchImportModelEvaluationSlicesResponse BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Imports a list of externally generated ModelEvaluationSlice.

Parameters
Name	Description
request	BatchImportModelEvaluationSlicesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
BatchImportModelEvaluationSlicesResponse	The response received from the server.

BatchImportModelEvaluationSlicesAsync(BatchImportModelEvaluationSlicesRequest, CallOptions)

public virtual AsyncUnaryCall<BatchImportModelEvaluationSlicesResponse> BatchImportModelEvaluationSlicesAsync(BatchImportModelEvaluationSlicesRequest request, CallOptions options)

Imports a list of externally generated ModelEvaluationSlice.

Parameters
Name	Description
request	BatchImportModelEvaluationSlicesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBatchImportModelEvaluationSlicesResponse	The call object.

BatchImportModelEvaluationSlicesAsync(BatchImportModelEvaluationSlicesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchImportModelEvaluationSlicesResponse> BatchImportModelEvaluationSlicesAsync(BatchImportModelEvaluationSlicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Imports a list of externally generated ModelEvaluationSlice.

Parameters
Name	Description
request	BatchImportModelEvaluationSlicesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBatchImportModelEvaluationSlicesResponse	The call object.

CopyModel(CopyModelRequest, CallOptions)

public virtual Operation CopyModel(CopyModelRequest request, CallOptions options)

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

Parameters
Name	Description
request	CopyModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CopyModel(CopyModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CopyModel(CopyModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

Parameters
Name	Description
request	CopyModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CopyModelAsync(CopyModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CopyModelAsync(CopyModelRequest request, CallOptions options)

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

Parameters
Name	Description
request	CopyModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CopyModelAsync(CopyModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CopyModelAsync(CopyModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

Parameters
Name	Description
request	CopyModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteModel(DeleteModelRequest, CallOptions)

public virtual Operation DeleteModel(DeleteModelRequest request, CallOptions options)

Deletes a Model.

A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.

Parameters
Name	Description
request	DeleteModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteModel(DeleteModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteModel(DeleteModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Model.

A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.

Parameters
Name	Description
request	DeleteModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteModelAsync(DeleteModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteModelAsync(DeleteModelRequest request, CallOptions options)

Deletes a Model.

A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.

Parameters
Name	Description
request	DeleteModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteModelAsync(DeleteModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteModelAsync(DeleteModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Model.

A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.

Parameters
Name	Description
request	DeleteModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteModelVersion(DeleteModelVersionRequest, CallOptions)

public virtual Operation DeleteModelVersion(DeleteModelVersionRequest request, CallOptions options)

Deletes a Model version.

Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.

Parameters
Name	Description
request	DeleteModelVersionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteModelVersion(DeleteModelVersionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteModelVersion(DeleteModelVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Model version.

Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.

Parameters
Name	Description
request	DeleteModelVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteModelVersionAsync(DeleteModelVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteModelVersionAsync(DeleteModelVersionRequest request, CallOptions options)

Deletes a Model version.

Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.

Parameters
Name	Description
request	DeleteModelVersionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteModelVersionAsync(DeleteModelVersionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteModelVersionAsync(DeleteModelVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Model version.

Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.

Parameters
Name	Description
request	DeleteModelVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportModel(ExportModelRequest, CallOptions)

public virtual Operation ExportModel(ExportModelRequest request, CallOptions options)

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].

Parameters
Name	Description
request	ExportModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportModel(ExportModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportModel(ExportModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].

Parameters
Name	Description
request	ExportModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ExportModelAsync(ExportModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportModelAsync(ExportModelRequest request, CallOptions options)

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].

Parameters
Name	Description
request	ExportModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportModelAsync(ExportModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportModelAsync(ExportModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].

Parameters
Name	Description
request	ExportModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetModel(GetModelRequest, CallOptions)

public virtual Model GetModel(GetModelRequest request, CallOptions options)

Gets a Model.

Parameters
Name	Description
request	GetModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Model	The response received from the server.

GetModel(GetModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Model GetModel(GetModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Model.

Parameters
Name	Description
request	GetModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Model	The response received from the server.

GetModelAsync(GetModelRequest, CallOptions)

public virtual AsyncUnaryCall<Model> GetModelAsync(GetModelRequest request, CallOptions options)

Gets a Model.

Parameters
Name	Description
request	GetModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallModel	The call object.

GetModelAsync(GetModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Model> GetModelAsync(GetModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Model.

Parameters
Name	Description
request	GetModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallModel	The call object.

GetModelEvaluation(GetModelEvaluationRequest, CallOptions)

public virtual ModelEvaluation GetModelEvaluation(GetModelEvaluationRequest request, CallOptions options)

Gets a ModelEvaluation.

Parameters
Name	Description
request	GetModelEvaluationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ModelEvaluation	The response received from the server.

GetModelEvaluation(GetModelEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual ModelEvaluation GetModelEvaluation(GetModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a ModelEvaluation.

Parameters
Name	Description
request	GetModelEvaluationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ModelEvaluation	The response received from the server.

GetModelEvaluationAsync(GetModelEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<ModelEvaluation> GetModelEvaluationAsync(GetModelEvaluationRequest request, CallOptions options)

Gets a ModelEvaluation.

Parameters
Name	Description
request	GetModelEvaluationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallModelEvaluation	The call object.

GetModelEvaluationAsync(GetModelEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ModelEvaluation> GetModelEvaluationAsync(GetModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a ModelEvaluation.

Parameters
Name	Description
request	GetModelEvaluationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallModelEvaluation	The call object.

GetModelEvaluationSlice(GetModelEvaluationSliceRequest, CallOptions)

public virtual ModelEvaluationSlice GetModelEvaluationSlice(GetModelEvaluationSliceRequest request, CallOptions options)

Gets a ModelEvaluationSlice.

Parameters
Name	Description
request	GetModelEvaluationSliceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ModelEvaluationSlice	The response received from the server.

GetModelEvaluationSlice(GetModelEvaluationSliceRequest, Metadata, DateTime?, CancellationToken)

public virtual ModelEvaluationSlice GetModelEvaluationSlice(GetModelEvaluationSliceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a ModelEvaluationSlice.

Parameters
Name	Description
request	GetModelEvaluationSliceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ModelEvaluationSlice	The response received from the server.

GetModelEvaluationSliceAsync(GetModelEvaluationSliceRequest, CallOptions)

public virtual AsyncUnaryCall<ModelEvaluationSlice> GetModelEvaluationSliceAsync(GetModelEvaluationSliceRequest request, CallOptions options)

Gets a ModelEvaluationSlice.

Parameters
Name	Description
request	GetModelEvaluationSliceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallModelEvaluationSlice	The call object.

GetModelEvaluationSliceAsync(GetModelEvaluationSliceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ModelEvaluationSlice> GetModelEvaluationSliceAsync(GetModelEvaluationSliceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a ModelEvaluationSlice.

Parameters
Name	Description
request	GetModelEvaluationSliceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallModelEvaluationSlice	The call object.

ImportModelEvaluation(ImportModelEvaluationRequest, CallOptions)

public virtual ModelEvaluation ImportModelEvaluation(ImportModelEvaluationRequest request, CallOptions options)

Imports an externally generated ModelEvaluation.

Parameters
Name	Description
request	ImportModelEvaluationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ModelEvaluation	The response received from the server.

ImportModelEvaluation(ImportModelEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual ModelEvaluation ImportModelEvaluation(ImportModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Imports an externally generated ModelEvaluation.

Parameters
Name	Description
request	ImportModelEvaluationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ModelEvaluation	The response received from the server.

ImportModelEvaluationAsync(ImportModelEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<ModelEvaluation> ImportModelEvaluationAsync(ImportModelEvaluationRequest request, CallOptions options)

Imports an externally generated ModelEvaluation.

Parameters
Name	Description
request	ImportModelEvaluationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallModelEvaluation	The call object.

ImportModelEvaluationAsync(ImportModelEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ModelEvaluation> ImportModelEvaluationAsync(ImportModelEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Imports an externally generated ModelEvaluation.

Parameters
Name	Description
request	ImportModelEvaluationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallModelEvaluation	The call object.

ListModelEvaluationSlices(ListModelEvaluationSlicesRequest, CallOptions)

public virtual ListModelEvaluationSlicesResponse ListModelEvaluationSlices(ListModelEvaluationSlicesRequest request, CallOptions options)

Lists ModelEvaluationSlices in a ModelEvaluation.

Parameters
Name	Description
request	ListModelEvaluationSlicesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListModelEvaluationSlicesResponse	The response received from the server.

ListModelEvaluationSlices(ListModelEvaluationSlicesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListModelEvaluationSlicesResponse ListModelEvaluationSlices(ListModelEvaluationSlicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ModelEvaluationSlices in a ModelEvaluation.

Parameters
Name	Description
request	ListModelEvaluationSlicesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListModelEvaluationSlicesResponse	The response received from the server.

ListModelEvaluationSlicesAsync(ListModelEvaluationSlicesRequest, CallOptions)

public virtual AsyncUnaryCall<ListModelEvaluationSlicesResponse> ListModelEvaluationSlicesAsync(ListModelEvaluationSlicesRequest request, CallOptions options)

Lists ModelEvaluationSlices in a ModelEvaluation.

Parameters
Name	Description
request	ListModelEvaluationSlicesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListModelEvaluationSlicesResponse	The call object.

ListModelEvaluationSlicesAsync(ListModelEvaluationSlicesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListModelEvaluationSlicesResponse> ListModelEvaluationSlicesAsync(ListModelEvaluationSlicesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ModelEvaluationSlices in a ModelEvaluation.

Parameters
Name	Description
request	ListModelEvaluationSlicesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListModelEvaluationSlicesResponse	The call object.

ListModelEvaluations(ListModelEvaluationsRequest, CallOptions)

public virtual ListModelEvaluationsResponse ListModelEvaluations(ListModelEvaluationsRequest request, CallOptions options)

Lists ModelEvaluations in a Model.

Parameters
Name	Description
request	ListModelEvaluationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListModelEvaluationsResponse	The response received from the server.

ListModelEvaluations(ListModelEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListModelEvaluationsResponse ListModelEvaluations(ListModelEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ModelEvaluations in a Model.

Parameters
Name	Description
request	ListModelEvaluationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListModelEvaluationsResponse	The response received from the server.

ListModelEvaluationsAsync(ListModelEvaluationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListModelEvaluationsResponse> ListModelEvaluationsAsync(ListModelEvaluationsRequest request, CallOptions options)

Lists ModelEvaluations in a Model.

Parameters
Name	Description
request	ListModelEvaluationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListModelEvaluationsResponse	The call object.

ListModelEvaluationsAsync(ListModelEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListModelEvaluationsResponse> ListModelEvaluationsAsync(ListModelEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ModelEvaluations in a Model.

Parameters
Name	Description
request	ListModelEvaluationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListModelEvaluationsResponse	The call object.

ListModelVersions(ListModelVersionsRequest, CallOptions)

public virtual ListModelVersionsResponse ListModelVersions(ListModelVersionsRequest request, CallOptions options)

Lists versions of the specified model.

Parameters
Name	Description
request	ListModelVersionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListModelVersionsResponse	The response received from the server.

ListModelVersions(ListModelVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListModelVersionsResponse ListModelVersions(ListModelVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists versions of the specified model.

Parameters
Name	Description
request	ListModelVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListModelVersionsResponse	The response received from the server.

ListModelVersionsAsync(ListModelVersionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListModelVersionsResponse> ListModelVersionsAsync(ListModelVersionsRequest request, CallOptions options)

Lists versions of the specified model.

Parameters
Name	Description
request	ListModelVersionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListModelVersionsResponse	The call object.

ListModelVersionsAsync(ListModelVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListModelVersionsResponse> ListModelVersionsAsync(ListModelVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists versions of the specified model.

Parameters
Name	Description
request	ListModelVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListModelVersionsResponse	The call object.

ListModels(ListModelsRequest, CallOptions)

public virtual ListModelsResponse ListModels(ListModelsRequest request, CallOptions options)

Lists Models in a Location.

Parameters
Name	Description
request	ListModelsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListModelsResponse	The response received from the server.

ListModels(ListModelsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListModelsResponse ListModels(ListModelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Models in a Location.

Parameters
Name	Description
request	ListModelsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListModelsResponse	The response received from the server.

ListModelsAsync(ListModelsRequest, CallOptions)

public virtual AsyncUnaryCall<ListModelsResponse> ListModelsAsync(ListModelsRequest request, CallOptions options)

Lists Models in a Location.

Parameters
Name	Description
request	ListModelsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListModelsResponse	The call object.

ListModelsAsync(ListModelsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListModelsResponse> ListModelsAsync(ListModelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Models in a Location.

Parameters
Name	Description
request	ListModelsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListModelsResponse	The call object.

MergeVersionAliases(MergeVersionAliasesRequest, CallOptions)

public virtual Model MergeVersionAliases(MergeVersionAliasesRequest request, CallOptions options)

Merges a set of aliases for a Model version.

Parameters
Name	Description
request	MergeVersionAliasesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Model	The response received from the server.

MergeVersionAliases(MergeVersionAliasesRequest, Metadata, DateTime?, CancellationToken)

public virtual Model MergeVersionAliases(MergeVersionAliasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Merges a set of aliases for a Model version.

Parameters
Name	Description
request	MergeVersionAliasesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Model	The response received from the server.

MergeVersionAliasesAsync(MergeVersionAliasesRequest, CallOptions)

public virtual AsyncUnaryCall<Model> MergeVersionAliasesAsync(MergeVersionAliasesRequest request, CallOptions options)

Merges a set of aliases for a Model version.

Parameters
Name	Description
request	MergeVersionAliasesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallModel	The call object.

MergeVersionAliasesAsync(MergeVersionAliasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Model> MergeVersionAliasesAsync(MergeVersionAliasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Merges a set of aliases for a Model version.

Parameters
Name	Description
request	MergeVersionAliasesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallModel	The call object.

NewInstance(ClientBaseConfiguration)

protected override ModelService.ModelServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ModelServiceModelServiceClient

Overrides

ClientBase<ModelService.ModelServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateExplanationDataset(UpdateExplanationDatasetRequest, CallOptions)

public virtual Operation UpdateExplanationDataset(UpdateExplanationDatasetRequest request, CallOptions options)

Incrementally update the dataset used for an examples model.

Parameters
Name	Description
request	UpdateExplanationDatasetRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateExplanationDataset(UpdateExplanationDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateExplanationDataset(UpdateExplanationDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Incrementally update the dataset used for an examples model.

Parameters
Name	Description
request	UpdateExplanationDatasetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateExplanationDatasetAsync(UpdateExplanationDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateExplanationDatasetAsync(UpdateExplanationDatasetRequest request, CallOptions options)

Incrementally update the dataset used for an examples model.

Parameters
Name	Description
request	UpdateExplanationDatasetRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateExplanationDatasetAsync(UpdateExplanationDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateExplanationDatasetAsync(UpdateExplanationDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Incrementally update the dataset used for an examples model.

Parameters
Name	Description
request	UpdateExplanationDatasetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateModel(UpdateModelRequest, CallOptions)

public virtual Model UpdateModel(UpdateModelRequest request, CallOptions options)

Updates a Model.

Parameters
Name	Description
request	UpdateModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Model	The response received from the server.

UpdateModel(UpdateModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Model UpdateModel(UpdateModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Model.

Parameters
Name	Description
request	UpdateModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Model	The response received from the server.

UpdateModelAsync(UpdateModelRequest, CallOptions)

public virtual AsyncUnaryCall<Model> UpdateModelAsync(UpdateModelRequest request, CallOptions options)

Updates a Model.

Parameters
Name	Description
request	UpdateModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallModel	The call object.

UpdateModelAsync(UpdateModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Model> UpdateModelAsync(UpdateModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Model.

Parameters
Name	Description
request	UpdateModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallModel	The call object.

UploadModel(UploadModelRequest, CallOptions)

public virtual Operation UploadModel(UploadModelRequest request, CallOptions options)

Uploads a Model artifact into Vertex AI.

Parameters
Name	Description
request	UploadModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UploadModel(UploadModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UploadModel(UploadModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Uploads a Model artifact into Vertex AI.

Parameters
Name	Description
request	UploadModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UploadModelAsync(UploadModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UploadModelAsync(UploadModelRequest request, CallOptions options)

Uploads a Model artifact into Vertex AI.

Parameters
Name	Description
request	UploadModelRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UploadModelAsync(UploadModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UploadModelAsync(UploadModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Uploads a Model artifact into Vertex AI.

Parameters
Name	Description
request	UploadModelRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.