Cloud AutoML V1beta1 API - Class Google::Cloud::AutoML::V1beta1::Model (v0.13.0)

Version latest

• 0.13.0 (latest)
• 0.12.0
• 0.11.1
• 0.10.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.5

Reference documentation and code samples for the Cloud AutoML V1beta1 API class Google::Cloud::AutoML::V1beta1::Model.

API proto representing a trained machine learning model.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when the model training finished and can be used for prediction.

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Output only. Timestamp when the model training finished and can be used for prediction.

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when the model training finished and can be used for prediction.

#dataset_id

def dataset_id() -> ::String

Returns

• (::String) — Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.

#dataset_id=

def dataset_id=(value) -> ::String

Parameter

• value (::String) — Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.

Returns

• (::String) — Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.

#deployment_state

def deployment_state() -> ::Google::Cloud::AutoML::V1beta1::Model::DeploymentState

Returns

• (::Google::Cloud::AutoML::V1beta1::Model::DeploymentState) — Output only. Deployment state of the model. A model can only serve prediction requests after it gets deployed.

#deployment_state=

def deployment_state=(value) -> ::Google::Cloud::AutoML::V1beta1::Model::DeploymentState

Parameter

• value (::Google::Cloud::AutoML::V1beta1::Model::DeploymentState) — Output only. Deployment state of the model. A model can only serve prediction requests after it gets deployed.

Returns

• (::Google::Cloud::AutoML::V1beta1::Model::DeploymentState) — Output only. Deployment state of the model. A model can only serve prediction requests after it gets deployed.

#display_name

def display_name() -> ::String

Returns

• (::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.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#image_classification_model_metadata

def image_classification_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata) — Metadata for image classification models.

  Note: The following fields are mutually exclusive: image_classification_model_metadata, translation_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#image_classification_model_metadata=

def image_classification_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata) — Metadata for image classification models.

  Note: The following fields are mutually exclusive: image_classification_model_metadata, translation_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata) — Metadata for image classification models.

  Note: The following fields are mutually exclusive: image_classification_model_metadata, translation_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#image_object_detection_model_metadata

def image_object_detection_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata) — Metadata for image object detection models.

  Note: The following fields are mutually exclusive: image_object_detection_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#image_object_detection_model_metadata=

def image_object_detection_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata) — Metadata for image object detection models.

  Note: The following fields are mutually exclusive: image_object_detection_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata) — Metadata for image object detection models.

  Note: The following fields are mutually exclusive: image_object_detection_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String

Returns

• (::String) — Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}

Returns

• (::String) — Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}

#tables_model_metadata

def tables_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::TablesModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::TablesModelMetadata) — Metadata for Tables models.

  Note: The following fields are mutually exclusive: tables_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tables_model_metadata=

def tables_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::TablesModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::TablesModelMetadata) — Metadata for Tables models.

  Note: The following fields are mutually exclusive: tables_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::TablesModelMetadata) — Metadata for Tables models.

  Note: The following fields are mutually exclusive: tables_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_classification_model_metadata

def text_classification_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata) — Metadata for text classification models.

  Note: The following fields are mutually exclusive: text_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_classification_model_metadata=

def text_classification_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata) — Metadata for text classification models.

  Note: The following fields are mutually exclusive: text_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata) — Metadata for text classification models.

  Note: The following fields are mutually exclusive: text_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_extraction_model_metadata

def text_extraction_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata) — Metadata for text extraction models.

  Note: The following fields are mutually exclusive: text_extraction_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_extraction_model_metadata=

def text_extraction_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata) — Metadata for text extraction models.

  Note: The following fields are mutually exclusive: text_extraction_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata) — Metadata for text extraction models.

  Note: The following fields are mutually exclusive: text_extraction_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_sentiment_model_metadata

def text_sentiment_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata) — Metadata for text sentiment models.

  Note: The following fields are mutually exclusive: text_sentiment_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_sentiment_model_metadata=

def text_sentiment_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata) — Metadata for text sentiment models.

  Note: The following fields are mutually exclusive: text_sentiment_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata) — Metadata for text sentiment models.

  Note: The following fields are mutually exclusive: text_sentiment_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#translation_model_metadata

def translation_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::TranslationModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::TranslationModelMetadata) — Metadata for translation models.

  Note: The following fields are mutually exclusive: translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#translation_model_metadata=

def translation_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::TranslationModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::TranslationModelMetadata) — Metadata for translation models.

  Note: The following fields are mutually exclusive: translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::TranslationModelMetadata) — Metadata for translation models.

  Note: The following fields are mutually exclusive: translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this model was last updated.

#update_time=

def update_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Output only. Timestamp when this model was last updated.

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp when this model was last updated.

#video_classification_model_metadata

def video_classification_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata) — Metadata for video classification models.

  Note: The following fields are mutually exclusive: video_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#video_classification_model_metadata=

def video_classification_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata) — Metadata for video classification models.

  Note: The following fields are mutually exclusive: video_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata) — Metadata for video classification models.

  Note: The following fields are mutually exclusive: video_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#video_object_tracking_model_metadata

def video_object_tracking_model_metadata() -> ::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata

Returns

• (::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata) — Metadata for video object tracking models.

  Note: The following fields are mutually exclusive: video_object_tracking_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

#video_object_tracking_model_metadata=

def video_object_tracking_model_metadata=(value) -> ::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata

Parameter

• value (::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata) — Metadata for video object tracking models.

  Note: The following fields are mutually exclusive: video_object_tracking_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata) — Metadata for video object tracking models.

  Note: The following fields are mutually exclusive: video_object_tracking_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.