google-cloud-automl-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) 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/v1/annotation_payload_pb.rb +37 -0
  7. data/lib/google/cloud/automl/v1/annotation_spec_pb.rb +26 -0
  8. data/lib/google/cloud/automl/v1/automl/client.rb +1851 -0
  9. data/lib/google/cloud/automl/v1/automl/credentials.rb +51 -0
  10. data/lib/google/cloud/automl/v1/automl/operations.rb +564 -0
  11. data/lib/google/cloud/automl/v1/automl/paths.rb +130 -0
  12. data/lib/google/cloud/automl/v1/automl.rb +63 -0
  13. data/lib/google/cloud/automl/v1/classification_pb.rb +65 -0
  14. data/lib/google/cloud/automl/v1/data_items_pb.rb +87 -0
  15. data/lib/google/cloud/automl/v1/dataset_pb.rb +42 -0
  16. data/lib/google/cloud/automl/v1/detection_pb.rb +45 -0
  17. data/lib/google/cloud/automl/v1/geometry_pb.rb +28 -0
  18. data/lib/google/cloud/automl/v1/image_pb.rb +57 -0
  19. data/lib/google/cloud/automl/v1/io_pb.rb +65 -0
  20. data/lib/google/cloud/automl/v1/model_evaluation_pb.rb +41 -0
  21. data/lib/google/cloud/automl/v1/model_pb.rb +49 -0
  22. data/lib/google/cloud/automl/v1/operations_pb.rb +88 -0
  23. data/lib/google/cloud/automl/v1/prediction_service/client.rb +634 -0
  24. data/lib/google/cloud/automl/v1/prediction_service/credentials.rb +51 -0
  25. data/lib/google/cloud/automl/v1/prediction_service/operations.rb +564 -0
  26. data/lib/google/cloud/automl/v1/prediction_service/paths.rb +52 -0
  27. data/lib/google/cloud/automl/v1/prediction_service.rb +53 -0
  28. data/lib/google/cloud/automl/v1/prediction_service_pb.rb +50 -0
  29. data/lib/google/cloud/automl/v1/prediction_service_services_pb.rb +103 -0
  30. data/lib/google/cloud/automl/v1/service_pb.rb +139 -0
  31. data/lib/google/cloud/automl/v1/service_services_pb.rb +137 -0
  32. data/lib/google/cloud/automl/v1/text_extraction_pb.rb +39 -0
  33. data/lib/google/cloud/automl/v1/text_pb.rb +41 -0
  34. data/lib/google/cloud/automl/v1/text_segment_pb.rb +25 -0
  35. data/lib/google/cloud/automl/v1/text_sentiment_pb.rb +35 -0
  36. data/lib/google/cloud/automl/v1/translation_pb.rb +41 -0
  37. data/lib/google/cloud/automl/v1/version.rb +28 -0
  38. data/lib/google/cloud/automl/v1.rb +36 -0
  39. data/lib/google/cloud/common_resources_pb.rb +15 -0
  40. data/lib/google-cloud-automl-v1.rb +21 -0
  41. data/proto_docs/README.md +4 -0
  42. data/proto_docs/google/api/field_behavior.rb +59 -0
  43. data/proto_docs/google/api/resource.rb +247 -0
  44. data/proto_docs/google/cloud/automl/v1/annotation_payload.rb +60 -0
  45. data/proto_docs/google/cloud/automl/v1/annotation_spec.rb +46 -0
  46. data/proto_docs/google/cloud/automl/v1/classification.rb +191 -0
  47. data/proto_docs/google/cloud/automl/v1/data_items.rb +197 -0
  48. data/proto_docs/google/cloud/automl/v1/dataset.rb +94 -0
  49. data/proto_docs/google/cloud/automl/v1/detection.rb +97 -0
  50. data/proto_docs/google/cloud/automl/v1/geometry.rb +53 -0
  51. data/proto_docs/google/cloud/automl/v1/image.rb +217 -0
  52. data/proto_docs/google/cloud/automl/v1/io.rb +1402 -0
  53. data/proto_docs/google/cloud/automl/v1/model.rb +109 -0
  54. data/proto_docs/google/cloud/automl/v1/model_evaluation.rb +94 -0
  55. data/proto_docs/google/cloud/automl/v1/operations.rb +180 -0
  56. data/proto_docs/google/cloud/automl/v1/prediction_service.rb +271 -0
  57. data/proto_docs/google/cloud/automl/v1/service.rb +322 -0
  58. data/proto_docs/google/cloud/automl/v1/text.rb +76 -0
  59. data/proto_docs/google/cloud/automl/v1/text_extraction.rb +73 -0
  60. data/proto_docs/google/cloud/automl/v1/text_segment.rb +44 -0
  61. data/proto_docs/google/cloud/automl/v1/text_sentiment.rb +82 -0
  62. data/proto_docs/google/cloud/automl/v1/translation.rb +79 -0
  63. data/proto_docs/google/longrunning/operations.rb +150 -0
  64. data/proto_docs/google/protobuf/any.rb +138 -0
  65. data/proto_docs/google/protobuf/duration.rb +98 -0
  66. data/proto_docs/google/protobuf/empty.rb +36 -0
  67. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  68. data/proto_docs/google/protobuf/struct.rb +96 -0
  69. data/proto_docs/google/protobuf/timestamp.rb +120 -0
  70. data/proto_docs/google/rpc/status.rb +46 -0
  71. metadata +227 -0
@@ -0,0 +1,109 @@
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 V1
24
+ # API proto representing a trained machine learning model.
25
+ # @!attribute [rw] translation_model_metadata
26
+ # @return [Google::Cloud::AutoML::V1::TranslationModelMetadata]
27
+ # Metadata for translation models.
28
+ # @!attribute [rw] image_classification_model_metadata
29
+ # @return [Google::Cloud::AutoML::V1::ImageClassificationModelMetadata]
30
+ # Metadata for image classification models.
31
+ # @!attribute [rw] text_classification_model_metadata
32
+ # @return [Google::Cloud::AutoML::V1::TextClassificationModelMetadata]
33
+ # Metadata for text classification models.
34
+ # @!attribute [rw] image_object_detection_model_metadata
35
+ # @return [Google::Cloud::AutoML::V1::ImageObjectDetectionModelMetadata]
36
+ # Metadata for image object detection models.
37
+ # @!attribute [rw] text_extraction_model_metadata
38
+ # @return [Google::Cloud::AutoML::V1::TextExtractionModelMetadata]
39
+ # Metadata for text extraction models.
40
+ # @!attribute [rw] text_sentiment_model_metadata
41
+ # @return [Google::Cloud::AutoML::V1::TextSentimentModelMetadata]
42
+ # Metadata for text sentiment models.
43
+ # @!attribute [rw] name
44
+ # @return [String]
45
+ # Output only. Resource name of the model.
46
+ # Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
47
+ # @!attribute [rw] display_name
48
+ # @return [String]
49
+ # Required. The name of the model to show in the interface. The name can be
50
+ # up to 32 characters long and can consist only of ASCII Latin letters A-Z
51
+ # and a-z, underscores
52
+ # (_), and ASCII digits 0-9. It must start with a letter.
53
+ # @!attribute [rw] dataset_id
54
+ # @return [String]
55
+ # Required. The resource ID of the dataset used to create the model. The dataset must
56
+ # come from the same ancestor project and location.
57
+ # @!attribute [rw] create_time
58
+ # @return [Google::Protobuf::Timestamp]
59
+ # Output only. Timestamp when the model training finished and can be used for prediction.
60
+ # @!attribute [rw] update_time
61
+ # @return [Google::Protobuf::Timestamp]
62
+ # Output only. Timestamp when this model was last updated.
63
+ # @!attribute [rw] deployment_state
64
+ # @return [Google::Cloud::AutoML::V1::Model::DeploymentState]
65
+ # Output only. Deployment state of the model. A model can only serve
66
+ # prediction requests after it gets deployed.
67
+ # @!attribute [rw] etag
68
+ # @return [String]
69
+ # Used to perform a consistent read-modify-write updates. If not set, a blind
70
+ # "overwrite" update happens.
71
+ # @!attribute [rw] labels
72
+ # @return [Google::Protobuf::Map{String => String}]
73
+ # Optional. The labels with user-defined metadata to organize your model.
74
+ #
75
+ # Label keys and values can be no longer than 64 characters
76
+ # (Unicode codepoints), can only contain lowercase letters, numeric
77
+ # characters, underscores and dashes. International characters are allowed.
78
+ # Label values are optional. Label keys must start with a letter.
79
+ #
80
+ # See https://goo.gl/xmQnxf for more information on and examples of labels.
81
+ class Model
82
+ include Google::Protobuf::MessageExts
83
+ extend Google::Protobuf::MessageExts::ClassMethods
84
+
85
+ # @!attribute [rw] key
86
+ # @return [String]
87
+ # @!attribute [rw] value
88
+ # @return [String]
89
+ class LabelsEntry
90
+ include Google::Protobuf::MessageExts
91
+ extend Google::Protobuf::MessageExts::ClassMethods
92
+ end
93
+
94
+ # Deployment state of the model.
95
+ module DeploymentState
96
+ # Should not be used, an un-set enum has this value by default.
97
+ DEPLOYMENT_STATE_UNSPECIFIED = 0
98
+
99
+ # Model is deployed.
100
+ DEPLOYED = 1
101
+
102
+ # Model is not deployed.
103
+ UNDEPLOYED = 2
104
+ end
105
+ end
106
+ end
107
+ end
108
+ end
109
+ end
@@ -0,0 +1,94 @@
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 V1
24
+ # Evaluation results of a model.
25
+ # @!attribute [rw] classification_evaluation_metrics
26
+ # @return [Google::Cloud::AutoML::V1::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] translation_evaluation_metrics
32
+ # @return [Google::Cloud::AutoML::V1::TranslationEvaluationMetrics]
33
+ # Model evaluation metrics for translation.
34
+ # @!attribute [rw] image_object_detection_evaluation_metrics
35
+ # @return [Google::Cloud::AutoML::V1::ImageObjectDetectionEvaluationMetrics]
36
+ # Model evaluation metrics for image object detection.
37
+ # @!attribute [rw] text_sentiment_evaluation_metrics
38
+ # @return [Google::Cloud::AutoML::V1::TextSentimentEvaluationMetrics]
39
+ # Evaluation metrics for text sentiment models.
40
+ # @!attribute [rw] text_extraction_evaluation_metrics
41
+ # @return [Google::Cloud::AutoML::V1::TextExtractionEvaluationMetrics]
42
+ # Evaluation metrics for text extraction models.
43
+ # @!attribute [rw] name
44
+ # @return [String]
45
+ # Output only. Resource name of the model evaluation.
46
+ # Format:
47
+ #
48
+ # `projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}`
49
+ # @!attribute [rw] annotation_spec_id
50
+ # @return [String]
51
+ # Output only. The ID of the annotation spec that the model evaluation applies to. The
52
+ # The ID is empty for the overall model evaluation.
53
+ # For Tables annotation specs in the dataset do not exist and this ID is
54
+ # always not set, but for CLASSIFICATION
55
+ #
56
+ # [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type]
57
+ # the
58
+ # {Google::Cloud::AutoML::V1::ModelEvaluation#display_name display_name}
59
+ # field is used.
60
+ # @!attribute [rw] display_name
61
+ # @return [String]
62
+ # Output only. The value of
63
+ # {Google::Cloud::AutoML::V1::AnnotationSpec#display_name display_name}
64
+ # at the moment when the model was trained. Because this field returns a
65
+ # value at model training time, for different models trained from the same
66
+ # dataset, the values may differ, since display names could had been changed
67
+ # between the two model's trainings. For Tables CLASSIFICATION
68
+ #
69
+ # [prediction_type-s][google.cloud.automl.v1.TablesModelMetadata.prediction_type]
70
+ # distinct values of the target column at the moment of the model evaluation
71
+ # are populated here.
72
+ # The display_name is empty for the overall model evaluation.
73
+ # @!attribute [rw] create_time
74
+ # @return [Google::Protobuf::Timestamp]
75
+ # Output only. Timestamp when this model evaluation was created.
76
+ # @!attribute [rw] evaluated_example_count
77
+ # @return [Integer]
78
+ # Output only. The number of examples used for model evaluation, i.e. for
79
+ # which ground truth from time of model creation is compared against the
80
+ # predicted annotations created by the model.
81
+ # For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is
82
+ # the total number of all examples used for evaluation.
83
+ # Otherwise, this is the count of examples that according to the ground
84
+ # truth were annotated by the
85
+ #
86
+ # {Google::Cloud::AutoML::V1::ModelEvaluation#annotation_spec_id annotation_spec_id}.
87
+ class ModelEvaluation
88
+ include Google::Protobuf::MessageExts
89
+ extend Google::Protobuf::MessageExts::ClassMethods
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,180 @@
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 V1
24
+ # Metadata used across all long running operations returned by AutoML API.
25
+ # @!attribute [rw] delete_details
26
+ # @return [Google::Cloud::AutoML::V1::DeleteOperationMetadata]
27
+ # Details of a Delete operation.
28
+ # @!attribute [rw] deploy_model_details
29
+ # @return [Google::Cloud::AutoML::V1::DeployModelOperationMetadata]
30
+ # Details of a DeployModel operation.
31
+ # @!attribute [rw] undeploy_model_details
32
+ # @return [Google::Cloud::AutoML::V1::UndeployModelOperationMetadata]
33
+ # Details of an UndeployModel operation.
34
+ # @!attribute [rw] create_model_details
35
+ # @return [Google::Cloud::AutoML::V1::CreateModelOperationMetadata]
36
+ # Details of CreateModel operation.
37
+ # @!attribute [rw] create_dataset_details
38
+ # @return [Google::Cloud::AutoML::V1::CreateDatasetOperationMetadata]
39
+ # Details of CreateDataset operation.
40
+ # @!attribute [rw] import_data_details
41
+ # @return [Google::Cloud::AutoML::V1::ImportDataOperationMetadata]
42
+ # Details of ImportData operation.
43
+ # @!attribute [rw] batch_predict_details
44
+ # @return [Google::Cloud::AutoML::V1::BatchPredictOperationMetadata]
45
+ # Details of BatchPredict operation.
46
+ # @!attribute [rw] export_data_details
47
+ # @return [Google::Cloud::AutoML::V1::ExportDataOperationMetadata]
48
+ # Details of ExportData operation.
49
+ # @!attribute [rw] export_model_details
50
+ # @return [Google::Cloud::AutoML::V1::ExportModelOperationMetadata]
51
+ # Details of ExportModel 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 CreateDataset operation.
92
+ class CreateDatasetOperationMetadata
93
+ include Google::Protobuf::MessageExts
94
+ extend Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+
97
+ # Details of CreateModel operation.
98
+ class CreateModelOperationMetadata
99
+ include Google::Protobuf::MessageExts
100
+ extend Google::Protobuf::MessageExts::ClassMethods
101
+ end
102
+
103
+ # Details of ImportData operation.
104
+ class ImportDataOperationMetadata
105
+ include Google::Protobuf::MessageExts
106
+ extend Google::Protobuf::MessageExts::ClassMethods
107
+ end
108
+
109
+ # Details of ExportData operation.
110
+ # @!attribute [rw] output_info
111
+ # @return [Google::Cloud::AutoML::V1::ExportDataOperationMetadata::ExportDataOutputInfo]
112
+ # Output only. Information further describing this export data's output.
113
+ class ExportDataOperationMetadata
114
+ include Google::Protobuf::MessageExts
115
+ extend Google::Protobuf::MessageExts::ClassMethods
116
+
117
+ # Further describes this export data's output.
118
+ # Supplements
119
+ # {Google::Cloud::AutoML::V1::OutputConfig OutputConfig}.
120
+ # @!attribute [rw] gcs_output_directory
121
+ # @return [String]
122
+ # The full path of the Google Cloud Storage directory created, into which
123
+ # the exported data is written.
124
+ class ExportDataOutputInfo
125
+ include Google::Protobuf::MessageExts
126
+ extend Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+ end
129
+
130
+ # Details of BatchPredict operation.
131
+ # @!attribute [rw] input_config
132
+ # @return [Google::Cloud::AutoML::V1::BatchPredictInputConfig]
133
+ # Output only. The input config that was given upon starting this
134
+ # batch predict operation.
135
+ # @!attribute [rw] output_info
136
+ # @return [Google::Cloud::AutoML::V1::BatchPredictOperationMetadata::BatchPredictOutputInfo]
137
+ # Output only. Information further describing this batch predict's output.
138
+ class BatchPredictOperationMetadata
139
+ include Google::Protobuf::MessageExts
140
+ extend Google::Protobuf::MessageExts::ClassMethods
141
+
142
+ # Further describes this batch predict's output.
143
+ # Supplements
144
+ #
145
+ # {Google::Cloud::AutoML::V1::BatchPredictOutputConfig BatchPredictOutputConfig}.
146
+ # @!attribute [rw] gcs_output_directory
147
+ # @return [String]
148
+ # The full path of the Google Cloud Storage directory created, into which
149
+ # the prediction output is written.
150
+ class BatchPredictOutputInfo
151
+ include Google::Protobuf::MessageExts
152
+ extend Google::Protobuf::MessageExts::ClassMethods
153
+ end
154
+ end
155
+
156
+ # Details of ExportModel operation.
157
+ # @!attribute [rw] output_info
158
+ # @return [Google::Cloud::AutoML::V1::ExportModelOperationMetadata::ExportModelOutputInfo]
159
+ # Output only. Information further describing the output of this model
160
+ # export.
161
+ class ExportModelOperationMetadata
162
+ include Google::Protobuf::MessageExts
163
+ extend Google::Protobuf::MessageExts::ClassMethods
164
+
165
+ # Further describes the output of model export.
166
+ # Supplements
167
+ # {Google::Cloud::AutoML::V1::ModelExportOutputConfig ModelExportOutputConfig}.
168
+ # @!attribute [rw] gcs_output_directory
169
+ # @return [String]
170
+ # The full path of the Google Cloud Storage directory created, into which
171
+ # the model will be exported.
172
+ class ExportModelOutputInfo
173
+ include Google::Protobuf::MessageExts
174
+ extend Google::Protobuf::MessageExts::ClassMethods
175
+ end
176
+ end
177
+ end
178
+ end
179
+ end
180
+ end
@@ -0,0 +1,271 @@
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 V1
24
+ # Request message for {Google::Cloud::AutoML::V1::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::V1::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
+ # <h4>AutoML Vision Classification</h4>
38
+ #
39
+ # `score_threshold`
40
+ # : (float) A value from 0.0 to 1.0. When the model
41
+ # makes predictions for an image, it will only produce results that have
42
+ # at least this confidence score. The default is 0.5.
43
+ #
44
+ # <h4>AutoML Vision Object Detection</h4>
45
+ #
46
+ # `score_threshold`
47
+ # : (float) When Model detects objects on the image,
48
+ # it will only produce bounding boxes which have at least this
49
+ # confidence score. Value in 0 to 1 range, default is 0.5.
50
+ #
51
+ # `max_bounding_box_count`
52
+ # : (int64) The maximum number of bounding
53
+ # boxes returned. The default is 100. The
54
+ # number of returned bounding boxes might be limited by the server.
55
+ #
56
+ # <h4>AutoML Tables</h4>
57
+ #
58
+ # `feature_importance`
59
+ # : (boolean) Whether
60
+ #
61
+ # [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
62
+ # is populated in the returned list of
63
+ # [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
64
+ # objects. The default is false.
65
+ class PredictRequest
66
+ include Google::Protobuf::MessageExts
67
+ extend Google::Protobuf::MessageExts::ClassMethods
68
+
69
+ # @!attribute [rw] key
70
+ # @return [String]
71
+ # @!attribute [rw] value
72
+ # @return [String]
73
+ class ParamsEntry
74
+ include Google::Protobuf::MessageExts
75
+ extend Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+ end
78
+
79
+ # Response message for {Google::Cloud::AutoML::V1::PredictionService::Client#predict PredictionService.Predict}.
80
+ # @!attribute [rw] payload
81
+ # @return [Array<Google::Cloud::AutoML::V1::AnnotationPayload>]
82
+ # Prediction result.
83
+ # AutoML Translation and AutoML Natural Language Sentiment Analysis
84
+ # return precisely one payload.
85
+ # @!attribute [rw] preprocessed_input
86
+ # @return [Google::Cloud::AutoML::V1::ExamplePayload]
87
+ # The preprocessed example that AutoML actually makes prediction on.
88
+ # Empty if AutoML does not preprocess the input example.
89
+ #
90
+ # For AutoML Natural Language (Classification, Entity Extraction, and
91
+ # Sentiment Analysis), if the input is a document, the recognized text is
92
+ # returned in the
93
+ # {Google::Cloud::AutoML::V1::Document#document_text document_text}
94
+ # property.
95
+ # @!attribute [rw] metadata
96
+ # @return [Google::Protobuf::Map{String => String}]
97
+ # Additional domain-specific prediction response metadata.
98
+ #
99
+ # <h4>AutoML Vision Object Detection</h4>
100
+ #
101
+ # `max_bounding_box_count`
102
+ # : (int64) The maximum number of bounding boxes to return per image.
103
+ #
104
+ # <h4>AutoML Natural Language Sentiment Analysis</h4>
105
+ #
106
+ # `sentiment_score`
107
+ # : (float, deprecated) A value between -1 and 1,
108
+ # -1 maps to least positive sentiment, while 1 maps to the most positive
109
+ # one and the higher the score, the more positive the sentiment in the
110
+ # document is. Yet these values are relative to the training data, so
111
+ # e.g. if all data was positive then -1 is also positive (though
112
+ # the least).
113
+ # `sentiment_score` is not the same as "score" and "magnitude"
114
+ # from Sentiment Analysis in the Natural Language API.
115
+ class PredictResponse
116
+ include Google::Protobuf::MessageExts
117
+ extend Google::Protobuf::MessageExts::ClassMethods
118
+
119
+ # @!attribute [rw] key
120
+ # @return [String]
121
+ # @!attribute [rw] value
122
+ # @return [String]
123
+ class MetadataEntry
124
+ include Google::Protobuf::MessageExts
125
+ extend Google::Protobuf::MessageExts::ClassMethods
126
+ end
127
+ end
128
+
129
+ # Request message for {Google::Cloud::AutoML::V1::PredictionService::Client#batch_predict PredictionService.BatchPredict}.
130
+ # @!attribute [rw] name
131
+ # @return [String]
132
+ # Required. Name of the model requested to serve the batch prediction.
133
+ # @!attribute [rw] input_config
134
+ # @return [Google::Cloud::AutoML::V1::BatchPredictInputConfig]
135
+ # Required. The input configuration for batch prediction.
136
+ # @!attribute [rw] output_config
137
+ # @return [Google::Cloud::AutoML::V1::BatchPredictOutputConfig]
138
+ # Required. The Configuration specifying where output predictions should
139
+ # be written.
140
+ # @!attribute [rw] params
141
+ # @return [Google::Protobuf::Map{String => String}]
142
+ # Additional domain-specific parameters for the predictions, any string must
143
+ # be up to 25000 characters long.
144
+ #
145
+ # <h4>AutoML Natural Language Classification</h4>
146
+ #
147
+ # `score_threshold`
148
+ # : (float) A value from 0.0 to 1.0. When the model
149
+ # makes predictions for a text snippet, it will only produce results
150
+ # that have at least this confidence score. The default is 0.5.
151
+ #
152
+ #
153
+ # <h4>AutoML Vision Classification</h4>
154
+ #
155
+ # `score_threshold`
156
+ # : (float) A value from 0.0 to 1.0. When the model
157
+ # makes predictions for an image, it will only produce results that
158
+ # have at least this confidence score. The default is 0.5.
159
+ #
160
+ # <h4>AutoML Vision Object Detection</h4>
161
+ #
162
+ # `score_threshold`
163
+ # : (float) When Model detects objects on the image,
164
+ # it will only produce bounding boxes which have at least this
165
+ # confidence score. Value in 0 to 1 range, default is 0.5.
166
+ #
167
+ # `max_bounding_box_count`
168
+ # : (int64) The maximum number of bounding
169
+ # boxes returned per image. The default is 100, the
170
+ # number of bounding boxes returned might be limited by the server.
171
+ # <h4>AutoML Video Intelligence Classification</h4>
172
+ #
173
+ # `score_threshold`
174
+ # : (float) A value from 0.0 to 1.0. When the model
175
+ # makes predictions for a video, it will only produce results that
176
+ # have at least this confidence score. The default is 0.5.
177
+ #
178
+ # `segment_classification`
179
+ # : (boolean) Set to true to request
180
+ # segment-level classification. AutoML Video Intelligence returns
181
+ # labels and their confidence scores for the entire segment of the
182
+ # video that user specified in the request configuration.
183
+ # The default is true.
184
+ #
185
+ # `shot_classification`
186
+ # : (boolean) Set to true to request shot-level
187
+ # classification. AutoML Video Intelligence determines the boundaries
188
+ # for each camera shot in the entire segment of the video that user
189
+ # specified in the request configuration. AutoML Video Intelligence
190
+ # then returns labels and their confidence scores for each detected
191
+ # shot, along with the start and end time of the shot.
192
+ # The default is false.
193
+ #
194
+ # WARNING: Model evaluation is not done for this classification type,
195
+ # the quality of it depends on training data, but there are no metrics
196
+ # provided to describe that quality.
197
+ #
198
+ # `1s_interval_classification`
199
+ # : (boolean) Set to true to request
200
+ # classification for a video at one-second intervals. AutoML Video
201
+ # Intelligence returns labels and their confidence scores for each
202
+ # second of the entire segment of the video that user specified in the
203
+ # request configuration. The default is false.
204
+ #
205
+ # WARNING: Model evaluation is not done for this classification
206
+ # type, the quality of it depends on training data, but there are no
207
+ # metrics provided to describe that quality.
208
+ #
209
+ # <h4>AutoML Video Intelligence Object Tracking</h4>
210
+ #
211
+ # `score_threshold`
212
+ # : (float) When Model detects objects on video frames,
213
+ # it will only produce bounding boxes which have at least this
214
+ # confidence score. Value in 0 to 1 range, default is 0.5.
215
+ #
216
+ # `max_bounding_box_count`
217
+ # : (int64) The maximum number of bounding
218
+ # boxes returned per image. The default is 100, the
219
+ # number of bounding boxes returned might be limited by the server.
220
+ #
221
+ # `min_bounding_box_size`
222
+ # : (float) Only bounding boxes with shortest edge
223
+ # at least that long as a relative value of video frame size are
224
+ # returned. Value in 0 to 1 range. Default is 0.
225
+ class BatchPredictRequest
226
+ include Google::Protobuf::MessageExts
227
+ extend Google::Protobuf::MessageExts::ClassMethods
228
+
229
+ # @!attribute [rw] key
230
+ # @return [String]
231
+ # @!attribute [rw] value
232
+ # @return [String]
233
+ class ParamsEntry
234
+ include Google::Protobuf::MessageExts
235
+ extend Google::Protobuf::MessageExts::ClassMethods
236
+ end
237
+ end
238
+
239
+ # Result of the Batch Predict. This message is returned in
240
+ # {Google::Longrunning::Operation#response response} of the operation returned
241
+ # by the {Google::Cloud::AutoML::V1::PredictionService::Client#batch_predict PredictionService.BatchPredict}.
242
+ # @!attribute [rw] metadata
243
+ # @return [Google::Protobuf::Map{String => String}]
244
+ # Additional domain-specific prediction response metadata.
245
+ #
246
+ # <h4>AutoML Vision Object Detection</h4>
247
+ #
248
+ # `max_bounding_box_count`
249
+ # : (int64) The maximum number of bounding boxes returned per image.
250
+ #
251
+ # <h4>AutoML Video Intelligence Object Tracking</h4>
252
+ #
253
+ # `max_bounding_box_count`
254
+ # : (int64) The maximum number of bounding boxes returned per frame.
255
+ class BatchPredictResult
256
+ include Google::Protobuf::MessageExts
257
+ extend Google::Protobuf::MessageExts::ClassMethods
258
+
259
+ # @!attribute [rw] key
260
+ # @return [String]
261
+ # @!attribute [rw] value
262
+ # @return [String]
263
+ class MetadataEntry
264
+ include Google::Protobuf::MessageExts
265
+ extend Google::Protobuf::MessageExts::ClassMethods
266
+ end
267
+ end
268
+ end
269
+ end
270
+ end
271
+ end