Struct google_api_proto::google::cloud::automl::v1beta1::auto_ml_client::AutoMlClient

pub struct AutoMlClient<T> { /* private fields */ }

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.

Implementations

impl<T> AutoMlClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> AutoMlClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn create_dataset( &mut self, request: impl IntoRequest<CreateDatasetRequest>, ) -> Result<Response<Dataset>, Status>

Creates a dataset.

pub async fn get_dataset( &mut self, request: impl IntoRequest<GetDatasetRequest>, ) -> Result<Response<Dataset>, Status>

Gets a dataset.

pub async fn list_datasets( &mut self, request: impl IntoRequest<ListDatasetsRequest>, ) -> Result<Response<ListDatasetsResponse>, Status>

Lists datasets in a project.

pub async fn update_dataset( &mut self, request: impl IntoRequest<UpdateDatasetRequest>, ) -> Result<Response<Dataset>, Status>

Updates a dataset.

pub async fn delete_dataset( &mut self, request: impl IntoRequest<DeleteDatasetRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn import_data( &mut self, request: impl IntoRequest<ImportDataRequest>, ) -> Result<Response<Operation>, Status>

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.v1beta1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.

pub async fn export_data( &mut self, request: impl IntoRequest<ExportDataRequest>, ) -> Result<Response<Operation>, Status>

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

pub async fn get_annotation_spec( &mut self, request: impl IntoRequest<GetAnnotationSpecRequest>, ) -> Result<Response<AnnotationSpec>, Status>

Gets an annotation spec.

pub async fn get_table_spec( &mut self, request: impl IntoRequest<GetTableSpecRequest>, ) -> Result<Response<TableSpec>, Status>

Gets a table spec.

pub async fn list_table_specs( &mut self, request: impl IntoRequest<ListTableSpecsRequest>, ) -> Result<Response<ListTableSpecsResponse>, Status>

Lists table specs in a dataset.

pub async fn update_table_spec( &mut self, request: impl IntoRequest<UpdateTableSpecRequest>, ) -> Result<Response<TableSpec>, Status>

Updates a table spec.

pub async fn get_column_spec( &mut self, request: impl IntoRequest<GetColumnSpecRequest>, ) -> Result<Response<ColumnSpec>, Status>

Gets a column spec.

pub async fn list_column_specs( &mut self, request: impl IntoRequest<ListColumnSpecsRequest>, ) -> Result<Response<ListColumnSpecsResponse>, Status>

Lists column specs in a table spec.

pub async fn update_column_spec( &mut self, request: impl IntoRequest<UpdateColumnSpecRequest>, ) -> Result<Response<ColumnSpec>, Status>

Updates a column spec.

pub async fn create_model( &mut self, request: impl IntoRequest<CreateModelRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn get_model( &mut self, request: impl IntoRequest<GetModelRequest>, ) -> Result<Response<Model>, Status>

Gets a model.

pub async fn list_models( &mut self, request: impl IntoRequest<ListModelsRequest>, ) -> Result<Response<ListModelsResponse>, Status>

Lists models.

pub async fn delete_model( &mut self, request: impl IntoRequest<DeleteModelRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn deploy_model( &mut self, request: impl IntoRequest<DeployModelRequest>, ) -> Result<Response<Operation>, Status>

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

pub async fn undeploy_model( &mut self, request: impl IntoRequest<UndeployModelRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn export_model( &mut self, request: impl IntoRequest<ExportModelRequest>, ) -> Result<Response<Operation>, Status>

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.v1beta1.ModelExportOutputConfig].

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

pub async fn export_evaluated_examples( &mut self, request: impl IntoRequest<ExportEvaluatedExamplesRequest>, ) -> Result<Response<Operation>, Status>

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][google.longrunning.Operation.response] field when it completes.

pub async fn get_model_evaluation( &mut self, request: impl IntoRequest<GetModelEvaluationRequest>, ) -> Result<Response<ModelEvaluation>, Status>

Gets a model evaluation.

pub async fn list_model_evaluations( &mut self, request: impl IntoRequest<ListModelEvaluationsRequest>, ) -> Result<Response<ListModelEvaluationsResponse>, Status>

Lists model evaluations.

Trait Implementations

impl<T: Clone> Clone for AutoMlClient<T>

fn clone(&self) -> AutoMlClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for AutoMlClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.