Cloud AI Platform v1 API - Class ModelService.ModelServiceBase (2.9.0)

[BindServiceMethod(typeof(ModelService), "BindService")]
public abstract class ModelServiceBase

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

Base class for server-side implementations of ModelService

Inheritance

Object > ModelService.ModelServiceBase

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest, ServerCallContext)

public virtual Task<BatchImportModelEvaluationSlicesResponse> BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request, ServerCallContext context)

Imports a list of externally generated ModelEvaluationSlice.

Parameters
NameDescription
requestBatchImportModelEvaluationSlicesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<BatchImportModelEvaluationSlicesResponse>

The response to send back to the client (wrapped by a task).

DeleteModel(DeleteModelRequest, ServerCallContext)

public virtual Task<Operation> DeleteModel(DeleteModelRequest request, ServerCallContext context)

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 received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

DeleteModelVersion(DeleteModelVersionRequest, ServerCallContext)

public virtual Task<Operation> DeleteModelVersion(DeleteModelVersionRequest request, ServerCallContext context)

Deletes a Model version.

Model version can only be deleted if there are no [DeployedModels][] 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 received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

ExportModel(ExportModelRequest, ServerCallContext)

public virtual Task<Operation> ExportModel(ExportModelRequest request, ServerCallContext context)

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 received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).

GetModel(GetModelRequest, ServerCallContext)

public virtual Task<Model> GetModel(GetModelRequest request, ServerCallContext context)

Gets a Model.

Parameters
NameDescription
requestGetModelRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Model>

The response to send back to the client (wrapped by a task).

GetModelEvaluation(GetModelEvaluationRequest, ServerCallContext)

public virtual Task<ModelEvaluation> GetModelEvaluation(GetModelEvaluationRequest request, ServerCallContext context)

Gets a ModelEvaluation.

Parameters
NameDescription
requestGetModelEvaluationRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ModelEvaluation>

The response to send back to the client (wrapped by a task).

GetModelEvaluationSlice(GetModelEvaluationSliceRequest, ServerCallContext)

public virtual Task<ModelEvaluationSlice> GetModelEvaluationSlice(GetModelEvaluationSliceRequest request, ServerCallContext context)

Gets a ModelEvaluationSlice.

Parameters
NameDescription
requestGetModelEvaluationSliceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ModelEvaluationSlice>

The response to send back to the client (wrapped by a task).

ImportModelEvaluation(ImportModelEvaluationRequest, ServerCallContext)

public virtual Task<ModelEvaluation> ImportModelEvaluation(ImportModelEvaluationRequest request, ServerCallContext context)

Imports an externally generated ModelEvaluation.

Parameters
NameDescription
requestImportModelEvaluationRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ModelEvaluation>

The response to send back to the client (wrapped by a task).

ListModelEvaluations(ListModelEvaluationsRequest, ServerCallContext)

public virtual Task<ListModelEvaluationsResponse> ListModelEvaluations(ListModelEvaluationsRequest request, ServerCallContext context)

Lists ModelEvaluations in a Model.

Parameters
NameDescription
requestListModelEvaluationsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListModelEvaluationsResponse>

The response to send back to the client (wrapped by a task).

ListModelEvaluationSlices(ListModelEvaluationSlicesRequest, ServerCallContext)

public virtual Task<ListModelEvaluationSlicesResponse> ListModelEvaluationSlices(ListModelEvaluationSlicesRequest request, ServerCallContext context)

Lists ModelEvaluationSlices in a ModelEvaluation.

Parameters
NameDescription
requestListModelEvaluationSlicesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListModelEvaluationSlicesResponse>

The response to send back to the client (wrapped by a task).

ListModels(ListModelsRequest, ServerCallContext)

public virtual Task<ListModelsResponse> ListModels(ListModelsRequest request, ServerCallContext context)

Lists Models in a Location.

Parameters
NameDescription
requestListModelsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListModelsResponse>

The response to send back to the client (wrapped by a task).

ListModelVersions(ListModelVersionsRequest, ServerCallContext)

public virtual Task<ListModelVersionsResponse> ListModelVersions(ListModelVersionsRequest request, ServerCallContext context)

Lists versions of the specified model.

Parameters
NameDescription
requestListModelVersionsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<ListModelVersionsResponse>

The response to send back to the client (wrapped by a task).

MergeVersionAliases(MergeVersionAliasesRequest, ServerCallContext)

public virtual Task<Model> MergeVersionAliases(MergeVersionAliasesRequest request, ServerCallContext context)

Merges a set of aliases for a Model version.

Parameters
NameDescription
requestMergeVersionAliasesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Model>

The response to send back to the client (wrapped by a task).

UpdateModel(UpdateModelRequest, ServerCallContext)

public virtual Task<Model> UpdateModel(UpdateModelRequest request, ServerCallContext context)

Updates a Model.

Parameters
NameDescription
requestUpdateModelRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Model>

The response to send back to the client (wrapped by a task).

UploadModel(UploadModelRequest, ServerCallContext)

public virtual Task<Operation> UploadModel(UploadModelRequest request, ServerCallContext context)

Uploads a Model artifact into Vertex AI.

Parameters
NameDescription
requestUploadModelRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
Task<Operation>

The response to send back to the client (wrapped by a task).