Google AutoML v1 API - Class AutoMl.AutoMlBase (3.4.0)

[BindServiceMethod(typeof(AutoMl), "BindService")]
public abstract class AutoMl.AutoMlBase

Reference documentation and code samples for the Google AutoML v1 API class AutoMl.AutoMlBase.

Base class for server-side implementations of AutoMl

Inheritance

object > AutoMl.AutoMlBase

Namespace

Google.Cloud.AutoML.V1

Assembly

Google.Cloud.AutoML.V1.dll

Methods

CreateDataset(CreateDatasetRequest, ServerCallContext)

public virtual Task<Operation> CreateDataset(CreateDatasetRequest request, ServerCallContext context)

Creates a dataset.

Parameters
Name Description
request CreateDatasetRequest

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).

CreateModel(CreateModelRequest, ServerCallContext)

public virtual Task<Operation> CreateModel(CreateModelRequest request, ServerCallContext context)

Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.

Parameters
Name Description
request CreateModelRequest

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).

DeleteDataset(DeleteDatasetRequest, ServerCallContext)

public virtual Task<Operation> DeleteDataset(DeleteDatasetRequest request, ServerCallContext context)

Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] field.

Parameters
Name Description
request DeleteDatasetRequest

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. Returns google.protobuf.Empty in the [response][google.longrunning.Operation.response] field when it completes, and delete_details in the [metadata][google.longrunning.Operation.metadata] 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).

DeployModel(DeployModelRequest, ServerCallContext)

public virtual Task<Operation> DeployModel(DeployModelRequest request, ServerCallContext context)

Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing [node_number][google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number]) will reset the deployment state without pausing the model's availability.

Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
Name Description
request DeployModelRequest

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).

ExportData(ExportDataRequest, ServerCallContext)

public virtual Task<Operation> ExportData(ExportDataRequest request, ServerCallContext context)

Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
Name Description
request ExportDataRequest

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, "export-able", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in [ModelExportOutputConfig][google.cloud.automl.v1.ModelExportOutputConfig].

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

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).

GetAnnotationSpec(GetAnnotationSpecRequest, ServerCallContext)

public virtual Task<AnnotationSpec> GetAnnotationSpec(GetAnnotationSpecRequest request, ServerCallContext context)

Gets an annotation spec.

Parameters
Name Description
request GetAnnotationSpecRequest

The request received from the client.

context ServerCallContext

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

Returns
Type Description
TaskAnnotationSpec

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

GetDataset(GetDatasetRequest, ServerCallContext)

public virtual Task<Dataset> GetDataset(GetDatasetRequest request, ServerCallContext context)

Gets a dataset.

Parameters
Name Description
request GetDatasetRequest

The request received from the client.

context ServerCallContext

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

Returns
Type Description
TaskDataset

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 model evaluation.

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).

ImportData(ImportDataRequest, ServerCallContext)

public virtual Task<Operation> ImportData(ImportDataRequest request, ServerCallContext context)

Imports data into a dataset. For Tables this method can only be called on an empty Dataset.

For Tables:

  • A [schema_inference_version][google.cloud.automl.v1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.
Parameters
Name Description
request ImportDataRequest

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).

ListDatasets(ListDatasetsRequest, ServerCallContext)

public virtual Task<ListDatasetsResponse> ListDatasets(ListDatasetsRequest request, ServerCallContext context)

Lists datasets in a project.

Parameters
Name Description
request ListDatasetsRequest

The request received from the client.

context ServerCallContext

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

Returns
Type Description
TaskListDatasetsResponse

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 model evaluations.

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).

ListModels(ListModelsRequest, ServerCallContext)

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

Lists models.

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).

UndeployModel(UndeployModelRequest, ServerCallContext)

public virtual Task<Operation> UndeployModel(UndeployModelRequest request, ServerCallContext context)

Undeploys a model. If the model is not deployed this method has no effect.

Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically.

Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

Parameters
Name Description
request UndeployModelRequest

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).

UpdateDataset(UpdateDatasetRequest, ServerCallContext)

public virtual Task<Dataset> UpdateDataset(UpdateDatasetRequest request, ServerCallContext context)

Updates a dataset.

Parameters
Name Description
request UpdateDatasetRequest

The request received from the client.

context ServerCallContext

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

Returns
Type Description
TaskDataset

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).