Interface AutoMlGrpc.AsyncService (2.42.0)

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 dash-case, either of those cases is accepted.

Methods

createDataset(CreateDatasetRequest request, StreamObserver<Operation> responseObserver)

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

Creates a dataset.

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

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>

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>

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>

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>

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>

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>

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>

updateModel(UpdateModelRequest request, StreamObserver<Model> responseObserver)

public default void updateModel(UpdateModelRequest request, StreamObserver<Model> responseObserver)

Updates a model.

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