google-cloud-automl 0.1.0 → 0.2.0

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/model.rb

@@ -47,8 +47,7 @@ module Google
         #     Metadata for text sentiment models.
         # @!attribute [rw] name
         #   @return [String]
-        #     Output only.
-        #     Resource name of the model.
+        #     Output only. Resource name of the model.
         #     Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
         # @!attribute [rw] display_name
         #   @return [String]
@@ -58,17 +57,14 @@ module Google
         #     (_), and ASCII digits 0-9. It must start with a letter.
         # @!attribute [rw] dataset_id
         #   @return [String]
-        #     Required.
-        #     The resource ID of the dataset used to create the model. The dataset must
+        #     Required. The resource ID of the dataset used to create the model. The dataset must
         #     come from the same ancestor project and location.
         # @!attribute [rw] create_time
         #   @return [Google::Protobuf::Timestamp]
-        #     Output only.
-        #     Timestamp when the model training finished  and can be used for prediction.
+        #     Output only. Timestamp when the model training finished  and can be used for prediction.
         # @!attribute [rw] update_time
         #   @return [Google::Protobuf::Timestamp]
-        #     Output only.
-        #     Timestamp when this model was last updated.
+        #     Output only. Timestamp when this model was last updated.
         # @!attribute [rw] deployment_state
         #   @return [Google::Cloud::AutoML::V1beta1::Model::DeploymentState]
         #     Output only. Deployment state of the model. A model can only serve

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/model_evaluation.rb

@@ -46,15 +46,13 @@ module Google
         #     Evaluation metrics for text extraction models.
         # @!attribute [rw] name
         #   @return [String]
-        #     Output only.
-        #     Resource name of the model evaluation.
+        #     Output only. Resource name of the model evaluation.
         #     Format:
         #
         #     `projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}`
         # @!attribute [rw] annotation_spec_id
         #   @return [String]
-        #     Output only.
-        #     The ID of the annotation spec that the model evaluation applies to. The
+        #     Output only. The ID of the annotation spec that the model evaluation applies to. The
         #     The ID is empty for the overall model evaluation.
         #     For Tables annotation specs in the dataset do not exist and this ID is
         #     always not set, but for CLASSIFICATION
@@ -66,7 +64,7 @@ module Google
         # @!attribute [rw] display_name
         #   @return [String]
         #     Output only. The value of
-        #     {Google::Cloud::AutoML::V1beta1::AnnotationSpec#dispay_name display_name} at
+        #     {Google::Cloud::AutoML::V1beta1::AnnotationSpec#display_name display_name} at
         #     the moment when the model was trained. Because this field returns a value
         #     at model training time, for different models trained from the same dataset,
         #     the values may differ, since display names could had been changed between
@@ -79,12 +77,10 @@ module Google
         #     The display_name is empty for the overall model evaluation.
         # @!attribute [rw] create_time
         #   @return [Google::Protobuf::Timestamp]
-        #     Output only.
-        #     Timestamp when this model evaluation was created.
+        #     Output only. Timestamp when this model evaluation was created.
         # @!attribute [rw] evaluated_example_count
         #   @return [Integer]
-        #     Output only.
-        #     The number of examples used for model evaluation, i.e. for
+        #     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

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/prediction_service.rb

@@ -17,14 +17,14 @@ module Google
   module Cloud
     module AutoML
       module V1beta1
-        # Request message for {Google::Cloud::AutoML::V1beta1::PredictionService::Predict PredictionService::Predict}.
+        # Request message for
+        # {Google::Cloud::AutoML::V1beta1::PredictionService::Predict PredictionService::Predict}.
         # @!attribute [rw] name
         #   @return [String]
         #     Name of the model requested to serve the prediction.
         # @!attribute [rw] payload
         #   @return [Google::Cloud::AutoML::V1beta1::ExamplePayload]
-        #     Required.
-        #     Payload to perform a prediction on. The payload must match the
+        #     Required. Payload to perform a prediction on. The payload must match the
         #     problem type that the model was trained to solve.
         # @!attribute [rw] params
         #   @return [Hash{String => String}]
@@ -36,6 +36,14 @@ module Google
         #       `score_threshold` - (float) A value from 0.0 to 1.0. When the model
         #       makes predictions for an image, it will only produce results that have
         #       at least this confidence score. The default is 0.5.
+        #
+        #     * For Image Object Detection:
+        #       `score_threshold` - (float) When Model detects objects on the image,
+        #       it will only produce bounding boxes which have at least this
+        #       confidence score. Value in 0 to 1 range, default is 0.5.
+        #       `max_bounding_box_count` - (int64) No more than this number of bounding
+        #       boxes will be returned in the response. Default is 100, the
+        #       requested value may be limited by server.
         #     * For Tables:
         #       `feature_importance` - (boolean) Whether
         #
@@ -46,11 +54,19 @@ module Google
         #            The default is false.
         class PredictRequest; end
 
-        # Response message for {Google::Cloud::AutoML::V1beta1::PredictionService::Predict PredictionService::Predict}.
+        # Response message for
+        # {Google::Cloud::AutoML::V1beta1::PredictionService::Predict PredictionService::Predict}.
         # @!attribute [rw] payload
         #   @return [Array<Google::Cloud::AutoML::V1beta1::AnnotationPayload>]
         #     Prediction result.
         #     Translation and Text Sentiment will return precisely one payload.
+        # @!attribute [rw] preprocessed_input
+        #   @return [Google::Cloud::AutoML::V1beta1::ExamplePayload]
+        #     The preprocessed example that AutoML actually makes prediction on.
+        #     Empty if AutoML does not preprocess the input example.
+        #     * For Text Extraction:
+        #       If the input is a .pdf file, the OCR'ed text will be provided in
+        #       {Google::Cloud::AutoML::V1beta1::Document#document_text document_text}.
         # @!attribute [rw] metadata
         #   @return [Hash{String => String}]
         #     Additional domain-specific prediction response metadata.
@@ -70,7 +86,8 @@ module Google
         #       from the previous Natural Language Sentiment Analysis API.
         class PredictResponse; end
 
-        # Request message for {Google::Cloud::AutoML::V1beta1::PredictionService::BatchPredict PredictionService::BatchPredict}.
+        # Request message for
+        # {Google::Cloud::AutoML::V1beta1::PredictionService::BatchPredict PredictionService::BatchPredict}.
         # @!attribute [rw] name
         #   @return [String]
         #     Name of the model requested to serve the batch prediction.
@@ -86,6 +103,27 @@ module Google
         #     Additional domain-specific parameters for the predictions, any string must
         #     be up to 25000 characters long.
         #
+        #     * For Text Classification:
+        #
+        #       `score_threshold` - (float) A value from 0.0 to 1.0. When the model
+        #       makes predictions for a text snippet, it will only produce results
+        #       that have at least this confidence score. The default is 0.5.
+        #
+        #     * For Image Classification:
+        #
+        #       `score_threshold` - (float) A value from 0.0 to 1.0. When the model
+        #       makes predictions for an image, it will only produce results that
+        #       have at least this confidence score. The default is 0.5.
+        #
+        #     * For Image Object Detection:
+        #
+        #       `score_threshold` - (float) When Model detects objects on the image,
+        #       it will only produce bounding boxes which have at least this
+        #       confidence score. Value in 0 to 1 range, default is 0.5.
+        #       `max_bounding_box_count` - (int64) No more than this number of bounding
+        #       boxes will be produced per image. Default is 100, the
+        #       requested value may be limited by server.
+        #
         #     * For Video Classification :
         #       `score_threshold` - (float) A value from 0.0 to 1.0. When the model
         #       makes predictions for a video, it will only produce results that
@@ -128,7 +166,19 @@ module Google
 
         # Result of the Batch Predict. This message is returned in
         # {Google::Longrunning::Operation#response response} of the operation returned
-        # by the {Google::Cloud::AutoML::V1beta1::PredictionService::BatchPredict PredictionService::BatchPredict}.
+        # by the
+        # {Google::Cloud::AutoML::V1beta1::PredictionService::BatchPredict PredictionService::BatchPredict}.
+        # @!attribute [rw] metadata
+        #   @return [Hash{String => String}]
+        #     Additional domain-specific prediction response metadata.
+        #
+        #     * For Image Object Detection:
+        #       `max_bounding_box_count` - (int64) At most that many bounding boxes per
+        #       image could have been returned.
+        #
+        #     * For Video Object Tracking:
+        #       `max_bounding_box_count` - (int64) At most that many bounding boxes per
+        #       frame could have been returned.
         class BatchPredictResult; end
       end
     end

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/service.rb

@@ -73,12 +73,7 @@ module Google
         #     The dataset which replaces the resource on the server.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
-        #     The update mask applies to the resource. For the `FieldMask` definition,
-        #     see
-        #
-        #     https:
-        #     //developers.google.com/protocol-buffers
-        #     // /docs/reference/google.protobuf#fieldmask
+        #     The update mask applies to the resource.
         class UpdateDatasetRequest; end
 
         # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::DeleteDataset AutoML::DeleteDataset}.
@@ -160,12 +155,7 @@ module Google
         #     The table spec which replaces the resource on the server.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
-        #     The update mask applies to the resource. For the `FieldMask` definition,
-        #     see
-        #
-        #     https:
-        #     //developers.google.com/protocol-buffers
-        #     // /docs/reference/google.protobuf#fieldmask
+        #     The update mask applies to the resource.
         class UpdateTableSpecRequest; end
 
         # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::GetColumnSpec AutoML::GetColumnSpec}.
@@ -215,12 +205,7 @@ module Google
         #     The column spec which replaces the resource on the server.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
-        #     The update mask applies to the resource. For the `FieldMask` definition,
-        #     see
-        #
-        #     https:
-        #     //developers.google.com/protocol-buffers
-        #     // /docs/reference/google.protobuf#fieldmask
+        #     The update mask applies to the resource.
         class UpdateColumnSpecRequest; end
 
         # Request message for {Google::Cloud::AutoML::V1beta1::AutoML::CreateModel AutoML::CreateModel}.

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/table_spec.rb

@@ -45,6 +45,10 @@ module Google
         # @!attribute [rw] row_count
         #   @return [Integer]
         #     Output only. The number of rows (i.e. examples) in the table.
+        # @!attribute [rw] valid_row_count
+        #   @return [Integer]
+        #     Output only. The number of valid rows (i.e. without values that don't match
+        #     DataType-s of their columns).
         # @!attribute [rw] column_count
         #   @return [Integer]
         #     Output only. The number of columns of the table. That is, the number of

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/tables.rb

@@ -27,10 +27,13 @@ module Google
         #     training & prediction target.
         #     This column must be non-nullable and have one of following data types
         #     (otherwise model creation will error):
+        #
         #     * CATEGORY
+        #
         #     * FLOAT64
-        #       Furthermore, if the type is CATEGORY , then only up to
-        #       100 unique values may exist in that column across all rows.
+        #
+        #     If the type is CATEGORY , only up to
+        #     100 unique values may exist in that column across all rows.
         #
         #     NOTE: Updates of this field will instantly affect any other users
         #     concurrently working with the dataset.
@@ -74,11 +77,12 @@ module Google
         #     for the timestamp at which these stats were last updated.
         # @!attribute [rw] stats_update_time
         #   @return [Google::Protobuf::Timestamp]
-        #     The most recent timestamp when target_column_correlations field and all
-        #     descendant ColumnSpec.data_stats and ColumnSpec.top_correlated_columns
-        #     fields were last (re-)generated. Any changes that happened to the dataset
-        #     afterwards are not reflected in these fields values. The regeneration
-        #     happens in the background on a best effort basis.
+        #     Output only. The most recent timestamp when target_column_correlations
+        #     field and all descendant ColumnSpec.data_stats and
+        #     ColumnSpec.top_correlated_columns fields were last (re-)generated. Any
+        #     changes that happened to the dataset afterwards are not reflected in these
+        #     fields values. The regeneration happens in the background on a best effort
+        #     basis.
         class TablesDatasetMetadata; end
 
         # Model metadata specific to AutoML Tables.
@@ -107,12 +111,16 @@ module Google
         #
         #     {Google::Cloud::AutoML::V1beta1::TablesDatasetMetadata#ml_use_column_spec_id ml_use_column}
         #     must never be included here.
+        #
         #     Only 3 fields are used:
-        #     name - May be set on CreateModel, if set only the columns specified are
-        #            used, otherwise all primary table's columns (except the ones listed
-        #            above) are used for the training and prediction input.
-        #     display_name - Output only.
-        #     data_type - Output only.
+        #
+        #     * name - May be set on CreateModel, if set only the columns specified are
+        #       used, otherwise all primary table's columns (except the ones listed
+        #       above) are used for the training and prediction input.
+        #
+        #     * display_name - Output only.
+        #
+        #     * data_type - Output only.
         # @!attribute [rw] optimization_objective
         #   @return [String]
         #     Objective function the model is optimizing towards. The training process
@@ -140,18 +148,6 @@ module Google
         #       "MINIMIZE_RMSE" (default) - Minimize root-mean-squared error (RMSE).
         #       "MINIMIZE_MAE" - Minimize mean-absolute error (MAE).
         #       "MINIMIZE_RMSLE" - Minimize root-mean-squared log error (RMSLE).
-        #
-        #     FORECASTING:
-        #       "MINIMIZE_RMSE" (default) - Minimize root-mean-squared error (RMSE).
-        #       "MINIMIZE_MAE" - Minimize mean-absolute error (MAE).
-        # @!attribute [rw] optimization_objective_recall_value
-        #   @return [Float]
-        #     Required when optimization_objective is "MAXIMIZE_PRECISION_AT_RECALL".
-        #     Must be between 0 and 1, inclusive.
-        # @!attribute [rw] optimization_objective_precision_value
-        #   @return [Float]
-        #     Required when optimization_objective is "MAXIMIZE_RECALL_AT_PRECISION".
-        #     Must be between 0 and 1, inclusive.
         # @!attribute [rw] tables_model_column_info
         #   @return [Array<Google::Cloud::AutoML::V1beta1::TablesModelColumnInfo>]
         #     Output only. Auxiliary information for each of the
@@ -206,9 +202,11 @@ module Google
         #
         #     {Google::Cloud::AutoML::V1beta1::TablesModelMetadata#target_column_spec target_column}.
         #     The value depends on the column's DataType:
-        #     CATEGORY - the predicted (with the above confidence `score`) CATEGORY
-        #                value.
-        #     FLOAT64 - the predicted (with above `prediction_interval`) FLOAT64 value.
+        #
+        #     * CATEGORY - the predicted (with the above confidence `score`) CATEGORY
+        #       value.
+        #
+        #     * FLOAT64 - the predicted (with above `prediction_interval`) FLOAT64 value.
         # @!attribute [rw] tables_model_column_info
         #   @return [Array<Google::Cloud::AutoML::V1beta1::TablesModelColumnInfo>]
         #     Output only. Auxiliary information for each of the model's
@@ -236,9 +234,7 @@ module Google
         #     its ColumnSpec).
         # @!attribute [rw] feature_importance
         #   @return [Float]
-        #     Output only.
-        #
-        #     When given as part of a Model (always populated):
+        #     Output only. When given as part of a Model (always populated):
         #     Measurement of how much model predictions correctness on the TEST data
         #     depend on values in this column. A value between 0 and 1, higher means
         #     higher influence. These values are normalized - for all input feature

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/text.rb

@@ -20,8 +20,7 @@ module Google
         # Dataset metadata for classification.
         # @!attribute [rw] classification_type
         #   @return [Google::Cloud::AutoML::V1beta1::ClassificationType]
-        #     Required.
-        #     Type of the classification problem.
+        #     Required. Type of the classification problem.
         class TextClassificationDatasetMetadata; end
 
         # Model metadata that is specific to text classification.
@@ -36,8 +35,7 @@ module Google
         # Dataset metadata for text sentiment.
         # @!attribute [rw] sentiment_max
         #   @return [Integer]
-        #     Required.
-        #     A sentiment is expressed as an integer ordinal, where higher value
+        #     Required. A sentiment is expressed as an integer ordinal, where higher value
         #     means a more positive sentiment. The range of sentiments that will be used
         #     is between 0 and sentiment_max (inclusive on both ends), and all the values
         #     in the range must be represented in the dataset before a model can be

data/lib/google/cloud/automl/v1beta1/prediction_service_client.rb

@@ -244,12 +244,13 @@ module Google
           #   up to 5MB. Not available for FORECASTING
           #
           # {Google::Cloud::AutoML::V1beta1::TablesModelMetadata#prediction_type prediction_type}.
+          # * Text Sentiment - TextSnippet, content up 500 characters, UTF-8
+          #   encoded.
           #
           # @param name [String]
           #   Name of the model requested to serve the prediction.
           # @param payload [Google::Cloud::AutoML::V1beta1::ExamplePayload | Hash]
-          #   Required.
-          #   Payload to perform a prediction on. The payload must match the
+          #   Required. Payload to perform a prediction on. The payload must match the
           #   problem type that the model was trained to solve.
           #   A hash of the same form as `Google::Cloud::AutoML::V1beta1::ExamplePayload`
           #   can also be provided.
@@ -262,6 +263,14 @@ module Google
           #     `score_threshold` - (float) A value from 0.0 to 1.0. When the model
           #     makes predictions for an image, it will only produce results that have
           #     at least this confidence score. The default is 0.5.
+          #
+          #   * For Image Object Detection:
+          #     `score_threshold` - (float) When Model detects objects on the image,
+          #     it will only produce bounding boxes which have at least this
+          #     confidence score. Value in 0 to 1 range, default is 0.5.
+          #     `max_bounding_box_count` - (int64) No more than this number of bounding
+          #     boxes will be returned in the response. Default is 100, the
+          #     requested value may be limited by server.
           #   * For Tables:
           #     `feature_importance` - (boolean) Whether
           #
@@ -303,16 +312,19 @@ module Google
             @predict.call(req, options, &block)
           end
 
-          # Perform a batch prediction. Unlike the online {Google::Cloud::AutoML::V1beta1::PredictionService::Predict Predict}, batch
+          # Perform a batch prediction. Unlike the online
+          # {Google::Cloud::AutoML::V1beta1::PredictionService::Predict Predict}, batch
           # prediction result won't be immediately available in the response. Instead,
           # a long running operation object is returned. User can poll the operation
           # result via {Google::Longrunning::Operations::GetOperation GetOperation}
-          # method. Once the operation is done, {Google::Cloud::AutoML::V1beta1::BatchPredictResult BatchPredictResult} is returned in
-          # the {Google::Longrunning::Operation#response response} field.
+          # method. Once the operation is done,
+          # {Google::Cloud::AutoML::V1beta1::BatchPredictResult BatchPredictResult} is
+          # returned in the {Google::Longrunning::Operation#response response} field.
           # Available for following ML problems:
+          # * Image Classification
+          # * Image Object Detection
           # * Video Classification
-          # * Video Object Tracking
-          # * Text Extraction
+          # * Video Object Tracking * Text Extraction
           # * Tables
           #
           # @param name [String]
@@ -330,6 +342,27 @@ module Google
           #   Additional domain-specific parameters for the predictions, any string must
           #   be up to 25000 characters long.
           #
+          #   * For Text Classification:
+          #
+          #     `score_threshold` - (float) A value from 0.0 to 1.0. When the model
+          #     makes predictions for a text snippet, it will only produce results
+          #     that have at least this confidence score. The default is 0.5.
+          #
+          #   * For Image Classification:
+          #
+          #     `score_threshold` - (float) A value from 0.0 to 1.0. When the model
+          #     makes predictions for an image, it will only produce results that
+          #     have at least this confidence score. The default is 0.5.
+          #
+          #   * For Image Object Detection:
+          #
+          #     `score_threshold` - (float) When Model detects objects on the image,
+          #     it will only produce bounding boxes which have at least this
+          #     confidence score. Value in 0 to 1 range, default is 0.5.
+          #     `max_bounding_box_count` - (int64) No more than this number of bounding
+          #     boxes will be produced per image. Default is 100, the
+          #     requested value may be limited by server.
+          #
           #   * For Video Classification :
           #     `score_threshold` - (float) A value from 0.0 to 1.0. When the model
           #     makes predictions for a video, it will only produce results that

data/lib/google/cloud/automl/v1beta1/prediction_service_pb.rb

@@ -5,12 +5,12 @@
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'
+require 'google/api/client_pb'
 require 'google/cloud/automl/v1beta1/annotation_payload_pb'
 require 'google/cloud/automl/v1beta1/data_items_pb'
 require 'google/cloud/automl/v1beta1/io_pb'
 require 'google/cloud/automl/v1beta1/operations_pb'
 require 'google/longrunning/operations_pb'
-require 'google/api/client_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.cloud.automl.v1beta1.PredictRequest" do
     optional :name, :string, 1
@@ -19,6 +19,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   end
   add_message "google.cloud.automl.v1beta1.PredictResponse" do
     repeated :payload, :message, 1, "google.cloud.automl.v1beta1.AnnotationPayload"
+    optional :preprocessed_input, :message, 3, "google.cloud.automl.v1beta1.ExamplePayload"
     map :metadata, :string, :string, 2
   end
   add_message "google.cloud.automl.v1beta1.BatchPredictRequest" do
@@ -28,6 +29,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     map :params, :string, :string, 5
   end
   add_message "google.cloud.automl.v1beta1.BatchPredictResult" do
+    map :metadata, :string, :string, 1
   end
 end