v1

google.cloud.automl. v1

Source:

Members

(static) DeploymentState :number

Deployment state of the model.

Properties:
Name Type Description
DEPLOYMENT_STATE_UNSPECIFIED number

Should not be used, an un-set enum has this value by default.

DEPLOYED number

Model is deployed.

UNDEPLOYED number

Model is not deployed.

Source:

Type Definitions

AnnotationPayload

Contains annotation information that is relevant to AutoML.

Properties:
Name Type Description
translation Object

Annotation details for translation.

This object should have the same structure as TranslationAnnotation

Source:
See:

CreateDatasetRequest

Request message for AutoMl.CreateDataset.

Properties:
Name Type Description
parent string

The resource name of the project to create the dataset for.

dataset Object

The dataset to create.

This object should have the same structure as Dataset

Source:
See:

CreateModelRequest

Request message for AutoMl.CreateModel.

Properties:
Name Type Description
parent string

Resource name of the parent project where the model is being created.

model Object

The model to create.

This object should have the same structure as Model

Source:
See:

Dataset

A workspace for solving a single, particular machine learning (ML) problem. A workspace contains examples that may be annotated.

Properties:
Name Type Description
translationDatasetMetadata Object

Metadata for a dataset used for translation.

This object should have the same structure as TranslationDatasetMetadata

name string

Output only. The resource name of the dataset. Form: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}

displayName string

Required. The name of the dataset to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9.

description string

User-provided description of the dataset. The description can be up to 25000 characters long.

exampleCount number

Output only. The number of examples in the dataset.

createTime Object

Output only. Timestamp when this dataset was created.

This object should have the same structure as Timestamp

etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels Object.<string, string>

Optional. The labels with user-defined metadata to organize your dataset.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

See https://goo.gl/xmQnxf for more information on and examples of labels.

Source:
See:

DeleteDatasetRequest

Request message for AutoMl.DeleteDataset.

Properties:
Name Type Description
name string

The resource name of the dataset to delete.

Source:
See:

DeleteModelRequest

Request message for AutoMl.DeleteModel.

Properties:
Name Type Description
name string

Resource name of the model being deleted.

Source:
See:

ExamplePayload

Example data used for training or prediction.

Properties:
Name Type Description
textSnippet Object

Example text.

This object should have the same structure as TextSnippet

Source:
See:

ExportDataRequest

Request message for AutoMl.ExportData.

Properties:
Name Type Description
name string

Required. The resource name of the dataset.

outputConfig Object

Required. The desired output location.

This object should have the same structure as OutputConfig

Source:
See:

GcsDestination

The Google Cloud Storage location where the output is to be written to.

Properties:
Name Type Description
outputUriPrefix string

Required. Google Cloud Storage URI to output directory, up to 2000 characters long. Accepted forms:

  • Prefix path: gs://bucket/directory The requesting user must have write permission to the bucket. The directory is created if it doesn't exist.
Source:
See:

GcsSource

The Google Cloud Storage location for the input content.

Properties:
Name Type Description
inputUris Array.<string>

Required. Google Cloud Storage URIs to input files, up to 2000 characters long. Accepted forms:

  • Full object path, e.g. gs://bucket/directory/object.csv
Source:
See:

GetDatasetRequest

Request message for AutoMl.GetDataset.

Properties:
Name Type Description
name string

The resource name of the dataset to retrieve.

Source:
See:

GetModelEvaluationRequest

Request message for AutoMl.GetModelEvaluation.

Properties:
Name Type Description
name string

Resource name for the model evaluation.

Source:
See:

GetModelRequest

Request message for AutoMl.GetModel.

Properties:
Name Type Description
name string

Resource name of the model.

Source:
See:

ImportDataRequest

Request message for AutoMl.ImportData.

Properties:
Name Type Description
name string

Required. Dataset name. Dataset must already exist. All imported annotations and examples will be added.

inputConfig Object

Required. The desired input location and its domain specific semantics, if any.

This object should have the same structure as InputConfig

Source:
See:

InputConfig

Input configuration for ImportData Action.

The format of input depends on dataset_metadata the Dataset into which the import is happening has. As input source the gcs_source is expected, unless specified otherwise. Additionally any input .CSV file by itself must be 100MB or smaller, unless specified otherwise. If an "example" file (that is, image, video etc.) with identical content (even if it had different GCS_FILE_PATH) is mentioned multiple times, then its label, bounding boxes etc. are appended. The same file should be always provided with the same ML_USE and GCS_FILE_PATH, if it is not, then these values are nondeterministically selected from the given ones.

Errors: If any of the provided CSV files can't be parsed or if more than certain percent of CSV rows cannot be processed then the operation fails and nothing is imported. Regardless of overall success or failure the per-row failures, up to a certain count cap, is listed in Operation.metadata.partial_failures.

Properties:
Name Type Description
gcsSource Object

The Google Cloud Storage location for the input content. In ImportData, the gcs_source points to a csv with structure described in the comment.

This object should have the same structure as GcsSource

params Object.<string, string>

Additional domain-specific parameters describing the semantic of the imported data, any string must be up to 25000 characters long.

Source:
See:

ListDatasetsRequest

Request message for AutoMl.ListDatasets.

Properties:
Name Type Description
parent string

The resource name of the project from which to list datasets.

filter string

An expression for filtering the results of the request.

* `dataset_metadata` - for existence of the case (e.g.
          image_classification_dataset_metadata:*).

Some examples of using the filter are:

* `translation_dataset_metadata:*` --> The dataset has
                                       translation_dataset_metadata.
pageSize number

Requested page size. Server may return fewer results than requested. If unspecified, server will pick a default size.

pageToken string

A token identifying a page of results for the server to return Typically obtained via ListDatasetsResponse.next_page_token of the previous AutoMl.ListDatasets call.

Source:
See:

ListDatasetsResponse

Response message for AutoMl.ListDatasets.

Properties:
Name Type Description
datasets Array.<Object>

The datasets read.

This object should have the same structure as Dataset

nextPageToken string

A token to retrieve next page of results. Pass to ListDatasetsRequest.page_token to obtain that page.

Source:
See:

ListModelEvaluationsRequest

Request message for AutoMl.ListModelEvaluations.

Properties:
Name Type Description
parent string

Resource name of the model to list the model evaluations for. If modelId is set as "-", this will list model evaluations from across all models of the parent location.

filter string

An expression for filtering the results of the request.

* `annotation_spec_id` - for =, !=  or existence. See example below for
                       the last.

Some examples of using the filter are:

* `annotation_spec_id!=4` --> The model evaluation was done for
                          annotation spec with ID different than 4.
* `NOT annotation_spec_id:*` --> The model evaluation was done for
                             aggregate of all annotation specs.
pageSize number

Requested page size.

pageToken string

A token identifying a page of results for the server to return. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous AutoMl.ListModelEvaluations call.

Source:
See:

ListModelEvaluationsResponse

Response message for AutoMl.ListModelEvaluations.

Properties:
Name Type Description
modelEvaluation Array.<Object>

List of model evaluations in the requested page.

This object should have the same structure as ModelEvaluation

nextPageToken string

A token to retrieve next page of results. Pass to the ListModelEvaluationsRequest.page_token field of a new AutoMl.ListModelEvaluations request to obtain that page.

Source:
See:

ListModelsRequest

Request message for AutoMl.ListModels.

Properties:
Name Type Description
parent string

Resource name of the project, from which to list the models.

filter string

An expression for filtering the results of the request.

* `model_metadata` - for existence of the case (e.g.
          video_classification_model_metadata:*).
* `dataset_id` - for = or !=. Some examples of using the filter are:

* `image_classification_model_metadata:*` --> The model has
                                     image_classification_model_metadata.
* `dataset_id=5` --> The model was created from a dataset with ID 5.
pageSize number

Requested page size.

pageToken string

A token identifying a page of results for the server to return Typically obtained via ListModelsResponse.next_page_token of the previous AutoMl.ListModels call.

Source:
See:

ListModelsResponse

Response message for AutoMl.ListModels.

Properties:
Name Type Description
model Array.<Object>

List of models in the requested page.

This object should have the same structure as Model

nextPageToken string

A token to retrieve next page of results. Pass to ListModelsRequest.page_token to obtain that page.

Source:
See:

Model

API proto representing a trained machine learning model.

Properties:
Name Type Description
translationModelMetadata Object

Metadata for translation models.

This object should have the same structure as TranslationModelMetadata

name string

Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}

displayName string

Required. The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9. It must start with a letter.

datasetId string

Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.

createTime Object

Output only. Timestamp when the model training finished and can be used for prediction.

This object should have the same structure as Timestamp

updateTime Object

Output only. Timestamp when this model was last updated.

This object should have the same structure as Timestamp

deploymentState number

Output only. Deployment state of the model. A model can only serve prediction requests after it gets deployed.

The number should be among the values of DeploymentState

labels Object.<string, string>

Optional. The labels with user-defined metadata to organize your model.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

See https://goo.gl/xmQnxf for more information on and examples of labels.

Source:
See:

ModelEvaluation

Evaluation results of a model.

Properties:
Name Type Description
translationEvaluationMetrics Object

Model evaluation metrics for translation.

This object should have the same structure as TranslationEvaluationMetrics

name string

Output only. Resource name of the model evaluation. Format:

projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}

annotationSpecId string

Output only. The ID of the annotation spec that the model evaluation applies to. The The ID is empty for the overall model evaluation.

createTime Object

Output only. Timestamp when this model evaluation was created.

This object should have the same structure as Timestamp

evaluatedExampleCount number

Output only. The number of examples used for model evaluation, i.e. for which ground truth from time of model creation is compared against the predicted annotations created by the model. For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is the total number of all examples used for evaluation. Otherwise, this is the count of examples that according to the ground truth were annotated by the

annotation_spec_id.

Source:
See:

OutputConfig

  • For Translation: CSV file translation.csv, with each line in format: ML_USE,GCS_FILE_PATH GCS_FILE_PATH leads to a .TSV file which describes examples that have given ML_USE, using the following row format per line: TEXT_SNIPPET (in source language) \t TEXT_SNIPPET (in target language)

export_data_<automl-dataset-display-name>_<timestamp-of-export-call> where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores), and timestamp will be in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In that dataset a new table called primary_table will be created, and filled with precisely the same data as this obtained on import.

Properties:
Name Type Description
gcsDestination Object

The Google Cloud Storage location where the output is to be written to. For Image Object Detection, Text Extraction, Video Classification and Tables, in the given directory a new directory will be created with name: export_data-- where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory.

This object should have the same structure as GcsDestination

Source:
See:

PredictRequest

Request message for PredictionService.Predict.

Properties:
Name Type Description
name string

Name of the model requested to serve the prediction.

payload Object

Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve.

This object should have the same structure as ExamplePayload

params Object.<string, string>

Additional domain-specific parameters, any string must be up to 25000 characters long.

Source:
See:

PredictResponse

Response message for PredictionService.Predict.

Properties:
Name Type Description
payload Array.<Object>

Prediction result. Translation and Text Sentiment will return precisely one payload.

This object should have the same structure as AnnotationPayload

metadata Object.<string, string>

Additional domain-specific prediction response metadata.

Source:
See:

TextSnippet

A representation of a text snippet.

Properties:
Name Type Description
content string

Required. The content of the text snippet as a string. Up to 250000 characters long.

mimeType string

Optional. The format of content. Currently the only two allowed values are "text/html" and "text/plain". If left blank, the format is automatically determined from the type of the uploaded content.

contentUri string

Output only. HTTP URI where you can download the content.

Source:
See:

TranslationAnnotation

Annotation details specific to translation.

Properties:
Name Type Description
translatedContent Object

Output only . The translated content.

This object should have the same structure as TextSnippet

Source:
See:

TranslationDatasetMetadata

Dataset metadata that is specific to translation.

Properties:
Name Type Description
sourceLanguageCode string

Required. The BCP-47 language code of the source language.

targetLanguageCode string

Required. The BCP-47 language code of the target language.

Source:
See:

TranslationEvaluationMetrics

Evaluation metrics for the dataset.

Properties:
Name Type Description
bleuScore number

Output only. BLEU score.

baseBleuScore number

Output only. BLEU score for base model.

Source:
See:

TranslationModelMetadata

Model metadata that is specific to translation.

Properties:
Name Type Description
baseModel string

The resource name of the model to use as a baseline to train the custom model. If unset, we use the default base model provided by Google Translate. Format: projects/{project_id}/locations/{location_id}/models/{model_id}

sourceLanguageCode string

Output only. Inferred from the dataset. The source languge (The BCP-47 language code) that is used for training.

targetLanguageCode string

Output only. The target languge (The BCP-47 language code) that is used for training.

Source:
See:

UpdateDatasetRequest

Request message for AutoMl.UpdateDataset

Properties:
Name Type Description
dataset Object

The dataset which replaces the resource on the server.

This object should have the same structure as Dataset

updateMask Object

Required. The update mask applies to the resource.

This object should have the same structure as FieldMask

Source:
See:

UpdateModelRequest

Request message for AutoMl.UpdateModel

Properties:
Name Type Description
model Object

The model which replaces the resource on the server.

This object should have the same structure as Model

updateMask Object

Required. The update mask applies to the resource.

This object should have the same structure as FieldMask

Source:
See: