google-cloud-automl-v1beta1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +203 -0
  5. data/README.md +71 -0
  6. data/lib/google-cloud-automl-v1beta1.rb +21 -0
  7. data/lib/google/cloud/automl/v1beta1.rb +36 -0
  8. data/lib/google/cloud/automl/v1beta1/annotation_payload_pb.rb +41 -0
  9. data/lib/google/cloud/automl/v1beta1/annotation_spec_pb.rb +26 -0
  10. data/lib/google/cloud/automl/v1beta1/automl.rb +63 -0
  11. data/lib/google/cloud/automl/v1beta1/automl/client.rb +2368 -0
  12. data/lib/google/cloud/automl/v1beta1/automl/credentials.rb +51 -0
  13. data/lib/google/cloud/automl/v1beta1/automl/operations.rb +564 -0
  14. data/lib/google/cloud/automl/v1beta1/automl/paths.rb +174 -0
  15. data/lib/google/cloud/automl/v1beta1/classification_pb.rb +73 -0
  16. data/lib/google/cloud/automl/v1beta1/column_spec_pb.rb +36 -0
  17. data/lib/google/cloud/automl/v1beta1/data_items_pb.rb +95 -0
  18. data/lib/google/cloud/automl/v1beta1/data_stats_pb.rb +84 -0
  19. data/lib/google/cloud/automl/v1beta1/data_types_pb.rb +43 -0
  20. data/lib/google/cloud/automl/v1beta1/dataset_pb.rb +46 -0
  21. data/lib/google/cloud/automl/v1beta1/detection_pb.rb +59 -0
  22. data/lib/google/cloud/automl/v1beta1/geometry_pb.rb +28 -0
  23. data/lib/google/cloud/automl/v1beta1/image_pb.rb +57 -0
  24. data/lib/google/cloud/automl/v1beta1/io_pb.rb +87 -0
  25. data/lib/google/cloud/automl/v1beta1/model_evaluation_pb.rb +45 -0
  26. data/lib/google/cloud/automl/v1beta1/model_pb.rb +52 -0
  27. data/lib/google/cloud/automl/v1beta1/operations_pb.rb +97 -0
  28. data/lib/google/cloud/automl/v1beta1/prediction_service.rb +53 -0
  29. data/lib/google/cloud/automl/v1beta1/prediction_service/client.rb +586 -0
  30. data/lib/google/cloud/automl/v1beta1/prediction_service/credentials.rb +51 -0
  31. data/lib/google/cloud/automl/v1beta1/prediction_service/operations.rb +564 -0
  32. data/lib/google/cloud/automl/v1beta1/prediction_service/paths.rb +52 -0
  33. data/lib/google/cloud/automl/v1beta1/prediction_service_pb.rb +50 -0
  34. data/lib/google/cloud/automl/v1beta1/prediction_service_services_pb.rb +79 -0
  35. data/lib/google/cloud/automl/v1beta1/ranges_pb.rb +24 -0
  36. data/lib/google/cloud/automl/v1beta1/regression_pb.rb +27 -0
  37. data/lib/google/cloud/automl/v1beta1/service_pb.rb +187 -0
  38. data/lib/google/cloud/automl/v1beta1/service_services_pb.rb +163 -0
  39. data/lib/google/cloud/automl/v1beta1/table_spec_pb.rb +31 -0
  40. data/lib/google/cloud/automl/v1beta1/tables_pb.rb +65 -0
  41. data/lib/google/cloud/automl/v1beta1/temporal_pb.rb +25 -0
  42. data/lib/google/cloud/automl/v1beta1/text_extraction_pb.rb +39 -0
  43. data/lib/google/cloud/automl/v1beta1/text_pb.rb +41 -0
  44. data/lib/google/cloud/automl/v1beta1/text_segment_pb.rb +25 -0
  45. data/lib/google/cloud/automl/v1beta1/text_sentiment_pb.rb +36 -0
  46. data/lib/google/cloud/automl/v1beta1/translation_pb.rb +41 -0
  47. data/lib/google/cloud/automl/v1beta1/version.rb +28 -0
  48. data/lib/google/cloud/automl/v1beta1/video_pb.rb +32 -0
  49. data/lib/google/cloud/common_resources_pb.rb +15 -0
  50. data/proto_docs/README.md +4 -0
  51. data/proto_docs/google/api/field_behavior.rb +59 -0
  52. data/proto_docs/google/api/resource.rb +247 -0
  53. data/proto_docs/google/cloud/automl/v1beta1/annotation_payload.rb +70 -0
  54. data/proto_docs/google/cloud/automl/v1beta1/annotation_spec.rb +46 -0
  55. data/proto_docs/google/cloud/automl/v1beta1/classification.rb +234 -0
  56. data/proto_docs/google/cloud/automl/v1beta1/column_spec.rb +77 -0
  57. data/proto_docs/google/cloud/automl/v1beta1/data_items.rb +227 -0
  58. data/proto_docs/google/cloud/automl/v1beta1/data_stats.rb +227 -0
  59. data/proto_docs/google/cloud/automl/v1beta1/data_types.rb +118 -0
  60. data/proto_docs/google/cloud/automl/v1beta1/dataset.rb +84 -0
  61. data/proto_docs/google/cloud/automl/v1beta1/detection.rb +152 -0
  62. data/proto_docs/google/cloud/automl/v1beta1/geometry.rb +53 -0
  63. data/proto_docs/google/cloud/automl/v1beta1/image.rb +205 -0
  64. data/proto_docs/google/cloud/automl/v1beta1/io.rb +1168 -0
  65. data/proto_docs/google/cloud/automl/v1beta1/model.rb +95 -0
  66. data/proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb +103 -0
  67. data/proto_docs/google/cloud/automl/v1beta1/operations.rb +206 -0
  68. data/proto_docs/google/cloud/automl/v1beta1/prediction_service.rb +238 -0
  69. data/proto_docs/google/cloud/automl/v1beta1/ranges.rb +38 -0
  70. data/proto_docs/google/cloud/automl/v1beta1/regression.rb +48 -0
  71. data/proto_docs/google/cloud/automl/v1beta1/service.rb +447 -0
  72. data/proto_docs/google/cloud/automl/v1beta1/table_spec.rb +75 -0
  73. data/proto_docs/google/cloud/automl/v1beta1/tables.rb +300 -0
  74. data/proto_docs/google/cloud/automl/v1beta1/temporal.rb +40 -0
  75. data/proto_docs/google/cloud/automl/v1beta1/text.rb +76 -0
  76. data/proto_docs/google/cloud/automl/v1beta1/text_extraction.rb +73 -0
  77. data/proto_docs/google/cloud/automl/v1beta1/text_segment.rb +44 -0
  78. data/proto_docs/google/cloud/automl/v1beta1/text_sentiment.rb +86 -0
  79. data/proto_docs/google/cloud/automl/v1beta1/translation.rb +79 -0
  80. data/proto_docs/google/cloud/automl/v1beta1/video.rb +51 -0
  81. data/proto_docs/google/longrunning/operations.rb +150 -0
  82. data/proto_docs/google/protobuf/any.rb +138 -0
  83. data/proto_docs/google/protobuf/duration.rb +98 -0
  84. data/proto_docs/google/protobuf/empty.rb +36 -0
  85. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  86. data/proto_docs/google/protobuf/struct.rb +96 -0
  87. data/proto_docs/google/protobuf/timestamp.rb +120 -0
  88. data/proto_docs/google/rpc/status.rb +46 -0
  89. metadata +245 -0
@@ -0,0 +1,95 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AutoML
23
+ module V1beta1
24
+ # API proto representing a trained machine learning model.
25
+ # @!attribute [rw] translation_model_metadata
26
+ # @return [Google::Cloud::AutoML::V1beta1::TranslationModelMetadata]
27
+ # Metadata for translation models.
28
+ # @!attribute [rw] image_classification_model_metadata
29
+ # @return [Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata]
30
+ # Metadata for image classification models.
31
+ # @!attribute [rw] text_classification_model_metadata
32
+ # @return [Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata]
33
+ # Metadata for text classification models.
34
+ # @!attribute [rw] image_object_detection_model_metadata
35
+ # @return [Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata]
36
+ # Metadata for image object detection models.
37
+ # @!attribute [rw] video_classification_model_metadata
38
+ # @return [Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata]
39
+ # Metadata for video classification models.
40
+ # @!attribute [rw] video_object_tracking_model_metadata
41
+ # @return [Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata]
42
+ # Metadata for video object tracking models.
43
+ # @!attribute [rw] text_extraction_model_metadata
44
+ # @return [Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata]
45
+ # Metadata for text extraction models.
46
+ # @!attribute [rw] tables_model_metadata
47
+ # @return [Google::Cloud::AutoML::V1beta1::TablesModelMetadata]
48
+ # Metadata for Tables models.
49
+ # @!attribute [rw] text_sentiment_model_metadata
50
+ # @return [Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata]
51
+ # Metadata for text sentiment models.
52
+ # @!attribute [rw] name
53
+ # @return [String]
54
+ # Output only. Resource name of the model.
55
+ # Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
56
+ # @!attribute [rw] display_name
57
+ # @return [String]
58
+ # Required. The name of the model to show in the interface. The name can be
59
+ # up to 32 characters long and can consist only of ASCII Latin letters A-Z
60
+ # and a-z, underscores
61
+ # (_), and ASCII digits 0-9. It must start with a letter.
62
+ # @!attribute [rw] dataset_id
63
+ # @return [String]
64
+ # Required. The resource ID of the dataset used to create the model. The dataset must
65
+ # come from the same ancestor project and location.
66
+ # @!attribute [rw] create_time
67
+ # @return [Google::Protobuf::Timestamp]
68
+ # Output only. Timestamp when the model training finished and can be used for prediction.
69
+ # @!attribute [rw] update_time
70
+ # @return [Google::Protobuf::Timestamp]
71
+ # Output only. Timestamp when this model was last updated.
72
+ # @!attribute [rw] deployment_state
73
+ # @return [Google::Cloud::AutoML::V1beta1::Model::DeploymentState]
74
+ # Output only. Deployment state of the model. A model can only serve
75
+ # prediction requests after it gets deployed.
76
+ class Model
77
+ include Google::Protobuf::MessageExts
78
+ extend Google::Protobuf::MessageExts::ClassMethods
79
+
80
+ # Deployment state of the model.
81
+ module DeploymentState
82
+ # Should not be used, an un-set enum has this value by default.
83
+ DEPLOYMENT_STATE_UNSPECIFIED = 0
84
+
85
+ # Model is deployed.
86
+ DEPLOYED = 1
87
+
88
+ # Model is not deployed.
89
+ UNDEPLOYED = 2
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
95
+ end
@@ -0,0 +1,103 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AutoML
23
+ module V1beta1
24
+ # Evaluation results of a model.
25
+ # @!attribute [rw] classification_evaluation_metrics
26
+ # @return [Google::Cloud::AutoML::V1beta1::ClassificationEvaluationMetrics]
27
+ # Model evaluation metrics for image, text, video and tables
28
+ # classification.
29
+ # Tables problem is considered a classification when the target column
30
+ # is CATEGORY DataType.
31
+ # @!attribute [rw] regression_evaluation_metrics
32
+ # @return [Google::Cloud::AutoML::V1beta1::RegressionEvaluationMetrics]
33
+ # Model evaluation metrics for Tables regression.
34
+ # Tables problem is considered a regression when the target column
35
+ # has FLOAT64 DataType.
36
+ # @!attribute [rw] translation_evaluation_metrics
37
+ # @return [Google::Cloud::AutoML::V1beta1::TranslationEvaluationMetrics]
38
+ # Model evaluation metrics for translation.
39
+ # @!attribute [rw] image_object_detection_evaluation_metrics
40
+ # @return [Google::Cloud::AutoML::V1beta1::ImageObjectDetectionEvaluationMetrics]
41
+ # Model evaluation metrics for image object detection.
42
+ # @!attribute [rw] video_object_tracking_evaluation_metrics
43
+ # @return [Google::Cloud::AutoML::V1beta1::VideoObjectTrackingEvaluationMetrics]
44
+ # Model evaluation metrics for video object tracking.
45
+ # @!attribute [rw] text_sentiment_evaluation_metrics
46
+ # @return [Google::Cloud::AutoML::V1beta1::TextSentimentEvaluationMetrics]
47
+ # Evaluation metrics for text sentiment models.
48
+ # @!attribute [rw] text_extraction_evaluation_metrics
49
+ # @return [Google::Cloud::AutoML::V1beta1::TextExtractionEvaluationMetrics]
50
+ # Evaluation metrics for text extraction models.
51
+ # @!attribute [rw] name
52
+ # @return [String]
53
+ # Output only. Resource name of the model evaluation.
54
+ # Format:
55
+ #
56
+ # `projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}`
57
+ # @!attribute [rw] annotation_spec_id
58
+ # @return [String]
59
+ # Output only. The ID of the annotation spec that the model evaluation applies to. The
60
+ # The ID is empty for the overall model evaluation.
61
+ # For Tables annotation specs in the dataset do not exist and this ID is
62
+ # always not set, but for CLASSIFICATION
63
+ #
64
+ # [prediction_type-s][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type]
65
+ # the
66
+ # {Google::Cloud::AutoML::V1beta1::ModelEvaluation#display_name display_name}
67
+ # field is used.
68
+ # @!attribute [rw] display_name
69
+ # @return [String]
70
+ # Output only. The value of
71
+ # {Google::Cloud::AutoML::V1beta1::AnnotationSpec#display_name display_name} at
72
+ # the moment when the model was trained. Because this field returns a value
73
+ # at model training time, for different models trained from the same dataset,
74
+ # the values may differ, since display names could had been changed between
75
+ # the two model's trainings.
76
+ # For Tables CLASSIFICATION
77
+ #
78
+ # [prediction_type-s][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type]
79
+ # distinct values of the target column at the moment of the model evaluation
80
+ # are populated here.
81
+ # The display_name is empty for the overall model evaluation.
82
+ # @!attribute [rw] create_time
83
+ # @return [Google::Protobuf::Timestamp]
84
+ # Output only. Timestamp when this model evaluation was created.
85
+ # @!attribute [rw] evaluated_example_count
86
+ # @return [Integer]
87
+ # Output only. The number of examples used for model evaluation, i.e. for
88
+ # which ground truth from time of model creation is compared against the
89
+ # predicted annotations created by the model.
90
+ # For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is
91
+ # the total number of all examples used for evaluation.
92
+ # Otherwise, this is the count of examples that according to the ground
93
+ # truth were annotated by the
94
+ #
95
+ # {Google::Cloud::AutoML::V1beta1::ModelEvaluation#annotation_spec_id annotation_spec_id}.
96
+ class ModelEvaluation
97
+ include Google::Protobuf::MessageExts
98
+ extend Google::Protobuf::MessageExts::ClassMethods
99
+ end
100
+ end
101
+ end
102
+ end
103
+ end
@@ -0,0 +1,206 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AutoML
23
+ module V1beta1
24
+ # Metadata used across all long running operations returned by AutoML API.
25
+ # @!attribute [rw] delete_details
26
+ # @return [Google::Cloud::AutoML::V1beta1::DeleteOperationMetadata]
27
+ # Details of a Delete operation.
28
+ # @!attribute [rw] deploy_model_details
29
+ # @return [Google::Cloud::AutoML::V1beta1::DeployModelOperationMetadata]
30
+ # Details of a DeployModel operation.
31
+ # @!attribute [rw] undeploy_model_details
32
+ # @return [Google::Cloud::AutoML::V1beta1::UndeployModelOperationMetadata]
33
+ # Details of an UndeployModel operation.
34
+ # @!attribute [rw] create_model_details
35
+ # @return [Google::Cloud::AutoML::V1beta1::CreateModelOperationMetadata]
36
+ # Details of CreateModel operation.
37
+ # @!attribute [rw] import_data_details
38
+ # @return [Google::Cloud::AutoML::V1beta1::ImportDataOperationMetadata]
39
+ # Details of ImportData operation.
40
+ # @!attribute [rw] batch_predict_details
41
+ # @return [Google::Cloud::AutoML::V1beta1::BatchPredictOperationMetadata]
42
+ # Details of BatchPredict operation.
43
+ # @!attribute [rw] export_data_details
44
+ # @return [Google::Cloud::AutoML::V1beta1::ExportDataOperationMetadata]
45
+ # Details of ExportData operation.
46
+ # @!attribute [rw] export_model_details
47
+ # @return [Google::Cloud::AutoML::V1beta1::ExportModelOperationMetadata]
48
+ # Details of ExportModel operation.
49
+ # @!attribute [rw] export_evaluated_examples_details
50
+ # @return [Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesOperationMetadata]
51
+ # Details of ExportEvaluatedExamples operation.
52
+ # @!attribute [rw] progress_percent
53
+ # @return [Integer]
54
+ # Output only. Progress of operation. Range: [0, 100].
55
+ # Not used currently.
56
+ # @!attribute [rw] partial_failures
57
+ # @return [Array<Google::Rpc::Status>]
58
+ # Output only. Partial failures encountered.
59
+ # E.g. single files that couldn't be read.
60
+ # This field should never exceed 20 entries.
61
+ # Status details field will contain standard GCP error details.
62
+ # @!attribute [rw] create_time
63
+ # @return [Google::Protobuf::Timestamp]
64
+ # Output only. Time when the operation was created.
65
+ # @!attribute [rw] update_time
66
+ # @return [Google::Protobuf::Timestamp]
67
+ # Output only. Time when the operation was updated for the last time.
68
+ class OperationMetadata
69
+ include Google::Protobuf::MessageExts
70
+ extend Google::Protobuf::MessageExts::ClassMethods
71
+ end
72
+
73
+ # Details of operations that perform deletes of any entities.
74
+ class DeleteOperationMetadata
75
+ include Google::Protobuf::MessageExts
76
+ extend Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+
79
+ # Details of DeployModel operation.
80
+ class DeployModelOperationMetadata
81
+ include Google::Protobuf::MessageExts
82
+ extend Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # Details of UndeployModel operation.
86
+ class UndeployModelOperationMetadata
87
+ include Google::Protobuf::MessageExts
88
+ extend Google::Protobuf::MessageExts::ClassMethods
89
+ end
90
+
91
+ # Details of CreateModel operation.
92
+ class CreateModelOperationMetadata
93
+ include Google::Protobuf::MessageExts
94
+ extend Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+
97
+ # Details of ImportData operation.
98
+ class ImportDataOperationMetadata
99
+ include Google::Protobuf::MessageExts
100
+ extend Google::Protobuf::MessageExts::ClassMethods
101
+ end
102
+
103
+ # Details of ExportData operation.
104
+ # @!attribute [rw] output_info
105
+ # @return [Google::Cloud::AutoML::V1beta1::ExportDataOperationMetadata::ExportDataOutputInfo]
106
+ # Output only. Information further describing this export data's output.
107
+ class ExportDataOperationMetadata
108
+ include Google::Protobuf::MessageExts
109
+ extend Google::Protobuf::MessageExts::ClassMethods
110
+
111
+ # Further describes this export data's output.
112
+ # Supplements
113
+ # {Google::Cloud::AutoML::V1beta1::OutputConfig OutputConfig}.
114
+ # @!attribute [rw] gcs_output_directory
115
+ # @return [String]
116
+ # The full path of the Google Cloud Storage directory created, into which
117
+ # the exported data is written.
118
+ # @!attribute [rw] bigquery_output_dataset
119
+ # @return [String]
120
+ # The path of the BigQuery dataset created, in bq://projectId.bqDatasetId
121
+ # format, into which the exported data is written.
122
+ class ExportDataOutputInfo
123
+ include Google::Protobuf::MessageExts
124
+ extend Google::Protobuf::MessageExts::ClassMethods
125
+ end
126
+ end
127
+
128
+ # Details of BatchPredict operation.
129
+ # @!attribute [rw] input_config
130
+ # @return [Google::Cloud::AutoML::V1beta1::BatchPredictInputConfig]
131
+ # Output only. The input config that was given upon starting this
132
+ # batch predict operation.
133
+ # @!attribute [rw] output_info
134
+ # @return [Google::Cloud::AutoML::V1beta1::BatchPredictOperationMetadata::BatchPredictOutputInfo]
135
+ # Output only. Information further describing this batch predict's output.
136
+ class BatchPredictOperationMetadata
137
+ include Google::Protobuf::MessageExts
138
+ extend Google::Protobuf::MessageExts::ClassMethods
139
+
140
+ # Further describes this batch predict's output.
141
+ # Supplements
142
+ #
143
+ # {Google::Cloud::AutoML::V1beta1::BatchPredictOutputConfig BatchPredictOutputConfig}.
144
+ # @!attribute [rw] gcs_output_directory
145
+ # @return [String]
146
+ # The full path of the Google Cloud Storage directory created, into which
147
+ # the prediction output is written.
148
+ # @!attribute [rw] bigquery_output_dataset
149
+ # @return [String]
150
+ # The path of the BigQuery dataset created, in bq://projectId.bqDatasetId
151
+ # format, into which the prediction output is written.
152
+ class BatchPredictOutputInfo
153
+ include Google::Protobuf::MessageExts
154
+ extend Google::Protobuf::MessageExts::ClassMethods
155
+ end
156
+ end
157
+
158
+ # Details of ExportModel operation.
159
+ # @!attribute [rw] output_info
160
+ # @return [Google::Cloud::AutoML::V1beta1::ExportModelOperationMetadata::ExportModelOutputInfo]
161
+ # Output only. Information further describing the output of this model
162
+ # export.
163
+ class ExportModelOperationMetadata
164
+ include Google::Protobuf::MessageExts
165
+ extend Google::Protobuf::MessageExts::ClassMethods
166
+
167
+ # Further describes the output of model export.
168
+ # Supplements
169
+ #
170
+ # {Google::Cloud::AutoML::V1beta1::ModelExportOutputConfig ModelExportOutputConfig}.
171
+ # @!attribute [rw] gcs_output_directory
172
+ # @return [String]
173
+ # The full path of the Google Cloud Storage directory created, into which
174
+ # the model will be exported.
175
+ class ExportModelOutputInfo
176
+ include Google::Protobuf::MessageExts
177
+ extend Google::Protobuf::MessageExts::ClassMethods
178
+ end
179
+ end
180
+
181
+ # Details of EvaluatedExamples operation.
182
+ # @!attribute [rw] output_info
183
+ # @return [Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesOperationMetadata::ExportEvaluatedExamplesOutputInfo]
184
+ # Output only. Information further describing the output of this evaluated
185
+ # examples export.
186
+ class ExportEvaluatedExamplesOperationMetadata
187
+ include Google::Protobuf::MessageExts
188
+ extend Google::Protobuf::MessageExts::ClassMethods
189
+
190
+ # Further describes the output of the evaluated examples export.
191
+ # Supplements
192
+ #
193
+ # {Google::Cloud::AutoML::V1beta1::ExportEvaluatedExamplesOutputConfig ExportEvaluatedExamplesOutputConfig}.
194
+ # @!attribute [rw] bigquery_output_dataset
195
+ # @return [String]
196
+ # The path of the BigQuery dataset created, in bq://projectId.bqDatasetId
197
+ # format, into which the output of export evaluated examples is written.
198
+ class ExportEvaluatedExamplesOutputInfo
199
+ include Google::Protobuf::MessageExts
200
+ extend Google::Protobuf::MessageExts::ClassMethods
201
+ end
202
+ end
203
+ end
204
+ end
205
+ end
206
+ end
@@ -0,0 +1,238 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module AutoML
23
+ module V1beta1
24
+ # Request message for {Google::Cloud::AutoML::V1beta1::PredictionService::Client#predict PredictionService.Predict}.
25
+ # @!attribute [rw] name
26
+ # @return [String]
27
+ # Required. Name of the model requested to serve the prediction.
28
+ # @!attribute [rw] payload
29
+ # @return [Google::Cloud::AutoML::V1beta1::ExamplePayload]
30
+ # Required. Payload to perform a prediction on. The payload must match the
31
+ # problem type that the model was trained to solve.
32
+ # @!attribute [rw] params
33
+ # @return [Google::Protobuf::Map{String => String}]
34
+ # Additional domain-specific parameters, any string must be up to 25000
35
+ # characters long.
36
+ #
37
+ # * For Image Classification:
38
+ #
39
+ # `score_threshold` - (float) A value from 0.0 to 1.0. When the model
40
+ # makes predictions for an image, it will only produce results that have
41
+ # at least this confidence score. The default is 0.5.
42
+ #
43
+ # * For Image Object Detection:
44
+ # `score_threshold` - (float) When Model detects objects on the image,
45
+ # it will only produce bounding boxes which have at least this
46
+ # confidence score. Value in 0 to 1 range, default is 0.5.
47
+ # `max_bounding_box_count` - (int64) No more than this number of bounding
48
+ # boxes will be returned in the response. Default is 100, the
49
+ # requested value may be limited by server.
50
+ # * For Tables:
51
+ # feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
52
+ # should be populated in the returned TablesAnnotation.
53
+ # The default is false.
54
+ class PredictRequest
55
+ include Google::Protobuf::MessageExts
56
+ extend Google::Protobuf::MessageExts::ClassMethods
57
+
58
+ # @!attribute [rw] key
59
+ # @return [String]
60
+ # @!attribute [rw] value
61
+ # @return [String]
62
+ class ParamsEntry
63
+ include Google::Protobuf::MessageExts
64
+ extend Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+ end
67
+
68
+ # Response message for {Google::Cloud::AutoML::V1beta1::PredictionService::Client#predict PredictionService.Predict}.
69
+ # @!attribute [rw] payload
70
+ # @return [Array<Google::Cloud::AutoML::V1beta1::AnnotationPayload>]
71
+ # Prediction result.
72
+ # Translation and Text Sentiment will return precisely one payload.
73
+ # @!attribute [rw] preprocessed_input
74
+ # @return [Google::Cloud::AutoML::V1beta1::ExamplePayload]
75
+ # The preprocessed example that AutoML actually makes prediction on.
76
+ # Empty if AutoML does not preprocess the input example.
77
+ # * For Text Extraction:
78
+ # If the input is a .pdf file, the OCR'ed text will be provided in
79
+ # {Google::Cloud::AutoML::V1beta1::Document#document_text document_text}.
80
+ # @!attribute [rw] metadata
81
+ # @return [Google::Protobuf::Map{String => String}]
82
+ # Additional domain-specific prediction response metadata.
83
+ #
84
+ # * For Image Object Detection:
85
+ # `max_bounding_box_count` - (int64) At most that many bounding boxes per
86
+ # image could have been returned.
87
+ #
88
+ # * For Text Sentiment:
89
+ # `sentiment_score` - (float, deprecated) A value between -1 and 1,
90
+ # -1 maps to least positive sentiment, while 1 maps to the most positive
91
+ # one and the higher the score, the more positive the sentiment in the
92
+ # document is. Yet these values are relative to the training data, so
93
+ # e.g. if all data was positive then -1 will be also positive (though
94
+ # the least).
95
+ # The sentiment_score shouldn't be confused with "score" or "magnitude"
96
+ # from the previous Natural Language Sentiment Analysis API.
97
+ class PredictResponse
98
+ include Google::Protobuf::MessageExts
99
+ extend Google::Protobuf::MessageExts::ClassMethods
100
+
101
+ # @!attribute [rw] key
102
+ # @return [String]
103
+ # @!attribute [rw] value
104
+ # @return [String]
105
+ class MetadataEntry
106
+ include Google::Protobuf::MessageExts
107
+ extend Google::Protobuf::MessageExts::ClassMethods
108
+ end
109
+ end
110
+
111
+ # Request message for {Google::Cloud::AutoML::V1beta1::PredictionService::Client#batch_predict PredictionService.BatchPredict}.
112
+ # @!attribute [rw] name
113
+ # @return [String]
114
+ # Required. Name of the model requested to serve the batch prediction.
115
+ # @!attribute [rw] input_config
116
+ # @return [Google::Cloud::AutoML::V1beta1::BatchPredictInputConfig]
117
+ # Required. The input configuration for batch prediction.
118
+ # @!attribute [rw] output_config
119
+ # @return [Google::Cloud::AutoML::V1beta1::BatchPredictOutputConfig]
120
+ # Required. The Configuration specifying where output predictions should
121
+ # be written.
122
+ # @!attribute [rw] params
123
+ # @return [Google::Protobuf::Map{String => String}]
124
+ # Required. Additional domain-specific parameters for the predictions, any string must
125
+ # be up to 25000 characters long.
126
+ #
127
+ # * For Text Classification:
128
+ #
129
+ # `score_threshold` - (float) A value from 0.0 to 1.0. When the model
130
+ # makes predictions for a text snippet, it will only produce results
131
+ # that have at least this confidence score. The default is 0.5.
132
+ #
133
+ # * For Image Classification:
134
+ #
135
+ # `score_threshold` - (float) A value from 0.0 to 1.0. When the model
136
+ # makes predictions for an image, it will only produce results that
137
+ # have at least this confidence score. The default is 0.5.
138
+ #
139
+ # * For Image Object Detection:
140
+ #
141
+ # `score_threshold` - (float) When Model detects objects on the image,
142
+ # it will only produce bounding boxes which have at least this
143
+ # confidence score. Value in 0 to 1 range, default is 0.5.
144
+ # `max_bounding_box_count` - (int64) No more than this number of bounding
145
+ # boxes will be produced per image. Default is 100, the
146
+ # requested value may be limited by server.
147
+ #
148
+ # * For Video Classification :
149
+ #
150
+ # `score_threshold` - (float) A value from 0.0 to 1.0. When the model
151
+ # makes predictions for a video, it will only produce results that
152
+ # have at least this confidence score. The default is 0.5.
153
+ # `segment_classification` - (boolean) Set to true to request
154
+ # segment-level classification. AutoML Video Intelligence returns
155
+ # labels and their confidence scores for the entire segment of the
156
+ # video that user specified in the request configuration.
157
+ # The default is "true".
158
+ # `shot_classification` - (boolean) Set to true to request shot-level
159
+ # classification. AutoML Video Intelligence determines the boundaries
160
+ # for each camera shot in the entire segment of the video that user
161
+ # specified in the request configuration. AutoML Video Intelligence
162
+ # then returns labels and their confidence scores for each detected
163
+ # shot, along with the start and end time of the shot.
164
+ # WARNING: Model evaluation is not done for this classification type,
165
+ # the quality of it depends on training data, but there are no metrics
166
+ # provided to describe that quality. The default is "false".
167
+ # `1s_interval_classification` - (boolean) Set to true to request
168
+ # classification for a video at one-second intervals. AutoML Video
169
+ # Intelligence returns labels and their confidence scores for each
170
+ # second of the entire segment of the video that user specified in the
171
+ # request configuration.
172
+ # WARNING: Model evaluation is not done for this classification
173
+ # type, the quality of it depends on training data, but there are no
174
+ # metrics provided to describe that quality. The default is
175
+ # "false".
176
+ #
177
+ # * For Tables:
178
+ #
179
+ # feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
180
+ # should be populated in the returned TablesAnnotations. The
181
+ # default is false.
182
+ #
183
+ # * For Video Object Tracking:
184
+ #
185
+ # `score_threshold` - (float) When Model detects objects on video frames,
186
+ # it will only produce bounding boxes which have at least this
187
+ # confidence score. Value in 0 to 1 range, default is 0.5.
188
+ # `max_bounding_box_count` - (int64) No more than this number of bounding
189
+ # boxes will be returned per frame. Default is 100, the requested
190
+ # value may be limited by server.
191
+ # `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
192
+ # at least that long as a relative value of video frame size will be
193
+ # returned. Value in 0 to 1 range. Default is 0.
194
+ class BatchPredictRequest
195
+ include Google::Protobuf::MessageExts
196
+ extend Google::Protobuf::MessageExts::ClassMethods
197
+
198
+ # @!attribute [rw] key
199
+ # @return [String]
200
+ # @!attribute [rw] value
201
+ # @return [String]
202
+ class ParamsEntry
203
+ include Google::Protobuf::MessageExts
204
+ extend Google::Protobuf::MessageExts::ClassMethods
205
+ end
206
+ end
207
+
208
+ # Result of the Batch Predict. This message is returned in
209
+ # {Google::Longrunning::Operation#response response} of the operation returned
210
+ # by the {Google::Cloud::AutoML::V1beta1::PredictionService::Client#batch_predict PredictionService.BatchPredict}.
211
+ # @!attribute [rw] metadata
212
+ # @return [Google::Protobuf::Map{String => String}]
213
+ # Additional domain-specific prediction response metadata.
214
+ #
215
+ # * For Image Object Detection:
216
+ # `max_bounding_box_count` - (int64) At most that many bounding boxes per
217
+ # image could have been returned.
218
+ #
219
+ # * For Video Object Tracking:
220
+ # `max_bounding_box_count` - (int64) At most that many bounding boxes per
221
+ # frame could have been returned.
222
+ class BatchPredictResult
223
+ include Google::Protobuf::MessageExts
224
+ extend Google::Protobuf::MessageExts::ClassMethods
225
+
226
+ # @!attribute [rw] key
227
+ # @return [String]
228
+ # @!attribute [rw] value
229
+ # @return [String]
230
+ class MetadataEntry
231
+ include Google::Protobuf::MessageExts
232
+ extend Google::Protobuf::MessageExts::ClassMethods
233
+ end
234
+ end
235
+ end
236
+ end
237
+ end
238
+ end