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

Version 3.8.0

• 3.10.0 (latest)
• 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

[BindServiceMethod(typeof(ModelService), "BindService")]
public abstract class ModelService.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

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest, ServerCallContext)

public virtual Task<BatchImportEvaluatedAnnotationsResponse> BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request, ServerCallContext context)

Imports a list of externally generated EvaluatedAnnotations.

Parameters
Name	Description
request	BatchImportEvaluatedAnnotationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBatchImportEvaluatedAnnotationsResponse	The response to send back to the client (wrapped by a task).

BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest, ServerCallContext)

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

Imports a list of externally generated ModelEvaluationSlice.

Parameters
Name	Description
request	BatchImportModelEvaluationSlicesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBatchImportModelEvaluationSlicesResponse	The response to send back to the client (wrapped by a task).

CopyModel(CopyModelRequest, ServerCallContext)

public virtual Task<Operation> CopyModel(CopyModelRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	DeleteModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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][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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	ExportModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	GetModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskModel	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
Name	Description
request	GetModelEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskModelEvaluation	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
Name	Description
request	GetModelEvaluationSliceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskModelEvaluationSlice	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
Name	Description
request	ImportModelEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskModelEvaluation	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
Name	Description
request	ListModelEvaluationSlicesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListModelEvaluationSlicesResponse	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
Name	Description
request	ListModelEvaluationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListModelEvaluationsResponse	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
Name	Description
request	ListModelVersionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListModelVersionsResponse	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
Name	Description
request	ListModelsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListModelsResponse	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
Name	Description
request	MergeVersionAliasesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskModel	The response to send back to the client (wrapped by a task).

UpdateExplanationDataset(UpdateExplanationDatasetRequest, ServerCallContext)

public virtual Task<Operation> UpdateExplanationDataset(UpdateExplanationDatasetRequest request, ServerCallContext context)

Incrementally update the dataset used for an examples model.

Parameters
Name	Description
request	UpdateExplanationDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	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
Name	Description
request	UpdateModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskModel	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
Name	Description
request	UploadModelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).