Cloud AI Platform v1 API - Class ModelService.ModelServiceClient (2.25.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

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ModelServiceClient(ChannelBase)

public ModelServiceClient(ChannelBase channel)

Creates a new client for ModelService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ModelServiceClient(ClientBaseConfiguration)

protected ModelServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest, CallOptions)

public virtual BatchImportEvaluatedAnnotationsResponse BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request, CallOptions options)

Imports a list of externally generated EvaluatedAnnotations.

Parameters
NameDescription
requestBatchImportEvaluatedAnnotationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestBatchImportEvaluatedAnnotationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestBatchImportEvaluatedAnnotationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestBatchImportEvaluatedAnnotationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallBatchImportEvaluatedAnnotationsResponse

The call object.

BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest, CallOptions)

public virtual BatchImportModelEvaluationSlicesResponse BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request, CallOptions options)

Imports a list of externally generated ModelEvaluationSlice.

Parameters
NameDescription
requestBatchImportModelEvaluationSlicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestBatchImportModelEvaluationSlicesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestBatchImportModelEvaluationSlicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestBatchImportModelEvaluationSlicesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCopyModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestCopyModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCopyModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestCopyModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestDeleteModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestDeleteModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestDeleteModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteModelVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestDeleteModelVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteModelVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestDeleteModelVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestExportModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestExportModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestExportModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestExportModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetModel(GetModelRequest, CallOptions)

public virtual Model GetModel(GetModelRequest request, CallOptions options)

Gets a Model.

Parameters
NameDescription
requestGetModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestGetModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Model

The response received from the server.

GetModelAsync(GetModelRequest, CallOptions)

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

Gets a Model.

Parameters
NameDescription
requestGetModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestGetModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallModel

The call object.

GetModelEvaluation(GetModelEvaluationRequest, CallOptions)

public virtual ModelEvaluation GetModelEvaluation(GetModelEvaluationRequest request, CallOptions options)

Gets a ModelEvaluation.

Parameters
NameDescription
requestGetModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestGetModelEvaluationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ModelEvaluation

The response received from the server.

GetModelEvaluationAsync(GetModelEvaluationRequest, CallOptions)

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

Gets a ModelEvaluation.

Parameters
NameDescription
requestGetModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestGetModelEvaluationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallModelEvaluation

The call object.

GetModelEvaluationSlice(GetModelEvaluationSliceRequest, CallOptions)

public virtual ModelEvaluationSlice GetModelEvaluationSlice(GetModelEvaluationSliceRequest request, CallOptions options)

Gets a ModelEvaluationSlice.

Parameters
NameDescription
requestGetModelEvaluationSliceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestGetModelEvaluationSliceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ModelEvaluationSlice

The response received from the server.

GetModelEvaluationSliceAsync(GetModelEvaluationSliceRequest, CallOptions)

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

Gets a ModelEvaluationSlice.

Parameters
NameDescription
requestGetModelEvaluationSliceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestGetModelEvaluationSliceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallModelEvaluationSlice

The call object.

ImportModelEvaluation(ImportModelEvaluationRequest, CallOptions)

public virtual ModelEvaluation ImportModelEvaluation(ImportModelEvaluationRequest request, CallOptions options)

Imports an externally generated ModelEvaluation.

Parameters
NameDescription
requestImportModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestImportModelEvaluationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestImportModelEvaluationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestImportModelEvaluationRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallModelEvaluation

The call object.

ListModelEvaluationSlices(ListModelEvaluationSlicesRequest, CallOptions)

public virtual ListModelEvaluationSlicesResponse ListModelEvaluationSlices(ListModelEvaluationSlicesRequest request, CallOptions options)

Lists ModelEvaluationSlices in a ModelEvaluation.

Parameters
NameDescription
requestListModelEvaluationSlicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListModelEvaluationSlicesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListModelEvaluationSlicesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListModelEvaluationSlicesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListModelEvaluationSlicesResponse

The call object.

ListModelEvaluations(ListModelEvaluationsRequest, CallOptions)

public virtual ListModelEvaluationsResponse ListModelEvaluations(ListModelEvaluationsRequest request, CallOptions options)

Lists ModelEvaluations in a Model.

Parameters
NameDescription
requestListModelEvaluationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListModelEvaluationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListModelEvaluationsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListModelEvaluationsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListModelEvaluationsResponse

The call object.

ListModelVersions(ListModelVersionsRequest, CallOptions)

public virtual ListModelVersionsResponse ListModelVersions(ListModelVersionsRequest request, CallOptions options)

Lists versions of the specified model.

Parameters
NameDescription
requestListModelVersionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListModelVersionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListModelVersionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListModelVersionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListModelVersionsResponse

The call object.

ListModels(ListModelsRequest, CallOptions)

public virtual ListModelsResponse ListModels(ListModelsRequest request, CallOptions options)

Lists Models in a Location.

Parameters
NameDescription
requestListModelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListModelsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListModelsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestListModelsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestMergeVersionAliasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestMergeVersionAliasesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestMergeVersionAliasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestMergeVersionAliasesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallModel

The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
ModelServiceModelServiceClient
Overrides

UpdateExplanationDataset(UpdateExplanationDatasetRequest, CallOptions)

public virtual Operation UpdateExplanationDataset(UpdateExplanationDatasetRequest request, CallOptions options)

Incrementally update the dataset used for an examples model.

Parameters
NameDescription
requestUpdateExplanationDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestUpdateExplanationDatasetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpdateExplanationDatasetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestUpdateExplanationDatasetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateModel(UpdateModelRequest, CallOptions)

public virtual Model UpdateModel(UpdateModelRequest request, CallOptions options)

Updates a Model.

Parameters
NameDescription
requestUpdateModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestUpdateModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Model

The response received from the server.

UpdateModelAsync(UpdateModelRequest, CallOptions)

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

Updates a Model.

Parameters
NameDescription
requestUpdateModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestUpdateModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallModel

The call object.

UploadModel(UploadModelRequest, CallOptions)

public virtual Operation UploadModel(UploadModelRequest request, CallOptions options)

Uploads a Model artifact into Vertex AI.

Parameters
NameDescription
requestUploadModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestUploadModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUploadModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestUploadModelRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.