Interface AutoMlGrpc.AsyncService (2.36.0)

Version 2.36.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.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.18
• 2.2.3
• 2.1.23

public static interface AutoMlGrpc.AsyncService

AutoML Server API. The resource names are assigned by the server. The server never reuses names that it has created after the resources with those names are deleted. An ID of a resource is the last element of the item's resource name. For projects/{project_id}/locations/{location_id}/datasets/{dataset_id}, then the id for the item is {dataset_id}. Currently the only supported location_id is "us-central1". On any input that is documented to expect a string parameter in snake_case or kebab-case, either of those cases is accepted.

Methods

createDataset(CreateDatasetRequest request, StreamObserver<Dataset> responseObserver)

public default void createDataset(CreateDatasetRequest request, StreamObserver<Dataset> responseObserver)

Creates a dataset.

Parameters
Name	Description
request	CreateDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<Dataset>

createModel(CreateModelRequest request, StreamObserver<Operation> responseObserver)

public default void createModel(CreateModelRequest request, StreamObserver<Operation> responseObserver)

Creates a model. Returns a Model in the 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
responseObserver	io.grpc.stub.StreamObserver<Operation>

deleteDataset(DeleteDatasetRequest request, StreamObserver<Operation> responseObserver)

public default void deleteDataset(DeleteDatasetRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	DeleteDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

deleteModel(DeleteModelRequest request, StreamObserver<Operation> responseObserver)

public default void deleteModel(DeleteModelRequest request, StreamObserver<Operation> responseObserver)

Deletes a model. Returns google.protobuf.Empty in the response field when it completes, and delete_details in the metadata field.

Parameters
Name	Description
request	DeleteModelRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

deployModel(DeployModelRequest request, StreamObserver<Operation> responseObserver)

public default void deployModel(DeployModelRequest request, StreamObserver<Operation> responseObserver)

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) 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 field when it completes.

Parameters
Name	Description
request	DeployModelRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

exportData(ExportDataRequest request, StreamObserver<Operation> responseObserver)

public default void exportData(ExportDataRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	ExportDataRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

exportEvaluatedExamples(ExportEvaluatedExamplesRequest request, StreamObserver<Operation> responseObserver)

public default void exportEvaluatedExamples(ExportEvaluatedExamplesRequest request, StreamObserver<Operation> responseObserver)

Exports examples on which the model was evaluated (i.e. which were in the TEST set of the dataset the model was created from), together with their ground truth annotations and the annotations created (predicted) by the model. The examples, ground truth and predictions are exported in the state they were at the moment the model was evaluated. This export is available only for 30 days since the model evaluation is created. Currently only available for Tables. Returns an empty response in the response field when it completes.

Parameters
Name	Description
request	ExportEvaluatedExamplesRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

exportModel(ExportModelRequest request, StreamObserver<Operation> responseObserver)

public default void exportModel(ExportModelRequest request, StreamObserver<Operation> responseObserver)

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. Returns an empty response in the response field when it completes.

Parameters
Name	Description
request	ExportModelRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

getAnnotationSpec(GetAnnotationSpecRequest request, StreamObserver<AnnotationSpec> responseObserver)

public default void getAnnotationSpec(GetAnnotationSpecRequest request, StreamObserver<AnnotationSpec> responseObserver)

Gets an annotation spec.

Parameters
Name	Description
request	GetAnnotationSpecRequest
responseObserver	io.grpc.stub.StreamObserver<AnnotationSpec>

getColumnSpec(GetColumnSpecRequest request, StreamObserver<ColumnSpec> responseObserver)

public default void getColumnSpec(GetColumnSpecRequest request, StreamObserver<ColumnSpec> responseObserver)

Gets a column spec.

Parameters
Name	Description
request	GetColumnSpecRequest
responseObserver	io.grpc.stub.StreamObserver<ColumnSpec>

getDataset(GetDatasetRequest request, StreamObserver<Dataset> responseObserver)

public default void getDataset(GetDatasetRequest request, StreamObserver<Dataset> responseObserver)

Gets a dataset.

Parameters
Name	Description
request	GetDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<Dataset>

getModel(GetModelRequest request, StreamObserver<Model> responseObserver)

public default void getModel(GetModelRequest request, StreamObserver<Model> responseObserver)

Gets a model.

Parameters
Name	Description
request	GetModelRequest
responseObserver	io.grpc.stub.StreamObserver<Model>

getModelEvaluation(GetModelEvaluationRequest request, StreamObserver<ModelEvaluation> responseObserver)

public default void getModelEvaluation(GetModelEvaluationRequest request, StreamObserver<ModelEvaluation> responseObserver)

Gets a model evaluation.

Parameters
Name	Description
request	GetModelEvaluationRequest
responseObserver	io.grpc.stub.StreamObserver<ModelEvaluation>

getTableSpec(GetTableSpecRequest request, StreamObserver<TableSpec> responseObserver)

public default void getTableSpec(GetTableSpecRequest request, StreamObserver<TableSpec> responseObserver)

Gets a table spec.

Parameters
Name	Description
request	GetTableSpecRequest
responseObserver	io.grpc.stub.StreamObserver<TableSpec>

importData(ImportDataRequest request, StreamObserver<Operation> responseObserver)

public default void importData(ImportDataRequest request, StreamObserver<Operation> responseObserver)

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

• A schema_inference_version parameter must be explicitly set. Returns an empty response in the response field when it completes.

Parameters
Name	Description
request	ImportDataRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

listColumnSpecs(ListColumnSpecsRequest request, StreamObserver<ListColumnSpecsResponse> responseObserver)

public default void listColumnSpecs(ListColumnSpecsRequest request, StreamObserver<ListColumnSpecsResponse> responseObserver)

Lists column specs in a table spec.

Parameters
Name	Description
request	ListColumnSpecsRequest
responseObserver	io.grpc.stub.StreamObserver<ListColumnSpecsResponse>

listDatasets(ListDatasetsRequest request, StreamObserver<ListDatasetsResponse> responseObserver)

public default void listDatasets(ListDatasetsRequest request, StreamObserver<ListDatasetsResponse> responseObserver)

Lists datasets in a project.

Parameters
Name	Description
request	ListDatasetsRequest
responseObserver	io.grpc.stub.StreamObserver<ListDatasetsResponse>

listModelEvaluations(ListModelEvaluationsRequest request, StreamObserver<ListModelEvaluationsResponse> responseObserver)

public default void listModelEvaluations(ListModelEvaluationsRequest request, StreamObserver<ListModelEvaluationsResponse> responseObserver)

Lists model evaluations.

Parameters
Name	Description
request	ListModelEvaluationsRequest
responseObserver	io.grpc.stub.StreamObserver<ListModelEvaluationsResponse>

listModels(ListModelsRequest request, StreamObserver<ListModelsResponse> responseObserver)

public default void listModels(ListModelsRequest request, StreamObserver<ListModelsResponse> responseObserver)

Lists models.

Parameters
Name	Description
request	ListModelsRequest
responseObserver	io.grpc.stub.StreamObserver<ListModelsResponse>

listTableSpecs(ListTableSpecsRequest request, StreamObserver<ListTableSpecsResponse> responseObserver)

public default void listTableSpecs(ListTableSpecsRequest request, StreamObserver<ListTableSpecsResponse> responseObserver)

Lists table specs in a dataset.

Parameters
Name	Description
request	ListTableSpecsRequest
responseObserver	io.grpc.stub.StreamObserver<ListTableSpecsResponse>

undeployModel(UndeployModelRequest request, StreamObserver<Operation> responseObserver)

public default void undeployModel(UndeployModelRequest request, StreamObserver<Operation> responseObserver)

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 field when it completes.

Parameters
Name	Description
request	UndeployModelRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

updateColumnSpec(UpdateColumnSpecRequest request, StreamObserver<ColumnSpec> responseObserver)

public default void updateColumnSpec(UpdateColumnSpecRequest request, StreamObserver<ColumnSpec> responseObserver)

Updates a column spec.

Parameters
Name	Description
request	UpdateColumnSpecRequest
responseObserver	io.grpc.stub.StreamObserver<ColumnSpec>

updateDataset(UpdateDatasetRequest request, StreamObserver<Dataset> responseObserver)

public default void updateDataset(UpdateDatasetRequest request, StreamObserver<Dataset> responseObserver)

Updates a dataset.

Parameters
Name	Description
request	UpdateDatasetRequest
responseObserver	io.grpc.stub.StreamObserver<Dataset>

updateTableSpec(UpdateTableSpecRequest request, StreamObserver<TableSpec> responseObserver)

public default void updateTableSpec(UpdateTableSpecRequest request, StreamObserver<TableSpec> responseObserver)

Updates a table spec.

Parameters
Name	Description
request	UpdateTableSpecRequest
responseObserver	io.grpc.stub.StreamObserver<TableSpec>