google-cloud-data_labeling-v1beta1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +203 -0
- data/README.md +75 -0
- data/lib/google-cloud-data_labeling-v1beta1.rb +21 -0
- data/lib/google/cloud/data_labeling/v1beta1.rb +35 -0
- data/lib/google/cloud/data_labeling/v1beta1/data_labeling_service.rb +50 -0
- data/lib/google/cloud/data_labeling/v1beta1/data_labeling_service/client.rb +3294 -0
- data/lib/google/cloud/data_labeling/v1beta1/data_labeling_service/credentials.rb +51 -0
- data/lib/google/cloud/data_labeling/v1beta1/data_labeling_service/operations.rb +570 -0
- data/lib/google/cloud/data_labeling/v1beta1/data_labeling_service/paths.rb +193 -0
- data/lib/google/cloud/data_labeling/v1beta1/version.rb +28 -0
- data/lib/google/cloud/datalabeling/v1beta1/annotation_pb.rb +178 -0
- data/lib/google/cloud/datalabeling/v1beta1/annotation_spec_set_pb.rb +33 -0
- data/lib/google/cloud/datalabeling/v1beta1/data_labeling_service_pb.rb +301 -0
- data/lib/google/cloud/datalabeling/v1beta1/data_labeling_service_services_pb.rb +132 -0
- data/lib/google/cloud/datalabeling/v1beta1/data_payloads_pb.rb +45 -0
- data/lib/google/cloud/datalabeling/v1beta1/dataset_pb.rb +142 -0
- data/lib/google/cloud/datalabeling/v1beta1/evaluation_job_pb.rb +71 -0
- data/lib/google/cloud/datalabeling/v1beta1/evaluation_pb.rb +93 -0
- data/lib/google/cloud/datalabeling/v1beta1/human_annotation_config_pb.rb +98 -0
- data/lib/google/cloud/datalabeling/v1beta1/instruction_pb.rb +42 -0
- data/lib/google/cloud/datalabeling/v1beta1/operations_pb.rb +124 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/annotation.rb +407 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/annotation_spec_set.rb +71 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/data_labeling_service.rb +839 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/data_payloads.rb +87 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/dataset.rb +354 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/evaluation.rb +225 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/evaluation_job.rb +280 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/human_annotation_config.rb +248 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb +88 -0
- data/proto_docs/google/cloud/datalabeling/v1beta1/operations.rb +279 -0
- data/proto_docs/google/longrunning/operations.rb +150 -0
- data/proto_docs/google/protobuf/any.rb +138 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +120 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +227 -0
@@ -0,0 +1,839 @@
|
|
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 DataLabeling
|
23
|
+
module V1beta1
|
24
|
+
# Request message for CreateDataset.
|
25
|
+
# @!attribute [rw] parent
|
26
|
+
# @return [::String]
|
27
|
+
# Required. Dataset resource parent, format:
|
28
|
+
# projects/\\{project_id}
|
29
|
+
# @!attribute [rw] dataset
|
30
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::Dataset]
|
31
|
+
# Required. The dataset to be created.
|
32
|
+
class CreateDatasetRequest
|
33
|
+
include ::Google::Protobuf::MessageExts
|
34
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
35
|
+
end
|
36
|
+
|
37
|
+
# Request message for GetDataSet.
|
38
|
+
# @!attribute [rw] name
|
39
|
+
# @return [::String]
|
40
|
+
# Required. Dataset resource name, format:
|
41
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
42
|
+
class GetDatasetRequest
|
43
|
+
include ::Google::Protobuf::MessageExts
|
44
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
45
|
+
end
|
46
|
+
|
47
|
+
# Request message for ListDataset.
|
48
|
+
# @!attribute [rw] parent
|
49
|
+
# @return [::String]
|
50
|
+
# Required. Dataset resource parent, format:
|
51
|
+
# projects/\\{project_id}
|
52
|
+
# @!attribute [rw] filter
|
53
|
+
# @return [::String]
|
54
|
+
# Optional. Filter on dataset is not supported at this moment.
|
55
|
+
# @!attribute [rw] page_size
|
56
|
+
# @return [::Integer]
|
57
|
+
# Optional. Requested page size. Server may return fewer results than
|
58
|
+
# requested. Default value is 100.
|
59
|
+
# @!attribute [rw] page_token
|
60
|
+
# @return [::String]
|
61
|
+
# Optional. A token identifying a page of results for the server to return.
|
62
|
+
# Typically obtained by
|
63
|
+
# {::Google::Cloud::DataLabeling::V1beta1::ListDatasetsResponse#next_page_token ListDatasetsResponse.next_page_token} of the previous
|
64
|
+
# [DataLabelingService.ListDatasets] call.
|
65
|
+
# Returns the first page if empty.
|
66
|
+
class ListDatasetsRequest
|
67
|
+
include ::Google::Protobuf::MessageExts
|
68
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
69
|
+
end
|
70
|
+
|
71
|
+
# Results of listing datasets within a project.
|
72
|
+
# @!attribute [rw] datasets
|
73
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::Dataset>]
|
74
|
+
# The list of datasets to return.
|
75
|
+
# @!attribute [rw] next_page_token
|
76
|
+
# @return [::String]
|
77
|
+
# A token to retrieve next page of results.
|
78
|
+
class ListDatasetsResponse
|
79
|
+
include ::Google::Protobuf::MessageExts
|
80
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
81
|
+
end
|
82
|
+
|
83
|
+
# Request message for DeleteDataset.
|
84
|
+
# @!attribute [rw] name
|
85
|
+
# @return [::String]
|
86
|
+
# Required. Dataset resource name, format:
|
87
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
88
|
+
class DeleteDatasetRequest
|
89
|
+
include ::Google::Protobuf::MessageExts
|
90
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
91
|
+
end
|
92
|
+
|
93
|
+
# Request message for ImportData API.
|
94
|
+
# @!attribute [rw] name
|
95
|
+
# @return [::String]
|
96
|
+
# Required. Dataset resource name, format:
|
97
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
98
|
+
# @!attribute [rw] input_config
|
99
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::InputConfig]
|
100
|
+
# Required. Specify the input source of the data.
|
101
|
+
# @!attribute [rw] user_email_address
|
102
|
+
# @return [::String]
|
103
|
+
# Email of the user who started the import task and should be notified by
|
104
|
+
# email. If empty no notification will be sent.
|
105
|
+
class ImportDataRequest
|
106
|
+
include ::Google::Protobuf::MessageExts
|
107
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
108
|
+
end
|
109
|
+
|
110
|
+
# Request message for ExportData API.
|
111
|
+
# @!attribute [rw] name
|
112
|
+
# @return [::String]
|
113
|
+
# Required. Dataset resource name, format:
|
114
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
115
|
+
# @!attribute [rw] annotated_dataset
|
116
|
+
# @return [::String]
|
117
|
+
# Required. Annotated dataset resource name. DataItem in
|
118
|
+
# Dataset and their annotations in specified annotated dataset will be
|
119
|
+
# exported. It's in format of
|
120
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}/annotatedDatasets/
|
121
|
+
# \\{annotated_dataset_id}
|
122
|
+
# @!attribute [rw] filter
|
123
|
+
# @return [::String]
|
124
|
+
# Optional. Filter is not supported at this moment.
|
125
|
+
# @!attribute [rw] output_config
|
126
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::OutputConfig]
|
127
|
+
# Required. Specify the output destination.
|
128
|
+
# @!attribute [rw] user_email_address
|
129
|
+
# @return [::String]
|
130
|
+
# Email of the user who started the export task and should be notified by
|
131
|
+
# email. If empty no notification will be sent.
|
132
|
+
class ExportDataRequest
|
133
|
+
include ::Google::Protobuf::MessageExts
|
134
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
135
|
+
end
|
136
|
+
|
137
|
+
# Request message for GetDataItem.
|
138
|
+
# @!attribute [rw] name
|
139
|
+
# @return [::String]
|
140
|
+
# Required. The name of the data item to get, format:
|
141
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}/dataItems/\\{data_item_id}
|
142
|
+
class GetDataItemRequest
|
143
|
+
include ::Google::Protobuf::MessageExts
|
144
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
145
|
+
end
|
146
|
+
|
147
|
+
# Request message for ListDataItems.
|
148
|
+
# @!attribute [rw] parent
|
149
|
+
# @return [::String]
|
150
|
+
# Required. Name of the dataset to list data items, format:
|
151
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
152
|
+
# @!attribute [rw] filter
|
153
|
+
# @return [::String]
|
154
|
+
# Optional. Filter is not supported at this moment.
|
155
|
+
# @!attribute [rw] page_size
|
156
|
+
# @return [::Integer]
|
157
|
+
# Optional. Requested page size. Server may return fewer results than
|
158
|
+
# requested. Default value is 100.
|
159
|
+
# @!attribute [rw] page_token
|
160
|
+
# @return [::String]
|
161
|
+
# Optional. A token identifying a page of results for the server to return.
|
162
|
+
# Typically obtained by
|
163
|
+
# {::Google::Cloud::DataLabeling::V1beta1::ListDataItemsResponse#next_page_token ListDataItemsResponse.next_page_token} of the previous
|
164
|
+
# [DataLabelingService.ListDataItems] call.
|
165
|
+
# Return first page if empty.
|
166
|
+
class ListDataItemsRequest
|
167
|
+
include ::Google::Protobuf::MessageExts
|
168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
169
|
+
end
|
170
|
+
|
171
|
+
# Results of listing data items in a dataset.
|
172
|
+
# @!attribute [rw] data_items
|
173
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::DataItem>]
|
174
|
+
# The list of data items to return.
|
175
|
+
# @!attribute [rw] next_page_token
|
176
|
+
# @return [::String]
|
177
|
+
# A token to retrieve next page of results.
|
178
|
+
class ListDataItemsResponse
|
179
|
+
include ::Google::Protobuf::MessageExts
|
180
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
181
|
+
end
|
182
|
+
|
183
|
+
# Request message for GetAnnotatedDataset.
|
184
|
+
# @!attribute [rw] name
|
185
|
+
# @return [::String]
|
186
|
+
# Required. Name of the annotated dataset to get, format:
|
187
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}/annotatedDatasets/
|
188
|
+
# \\{annotated_dataset_id}
|
189
|
+
class GetAnnotatedDatasetRequest
|
190
|
+
include ::Google::Protobuf::MessageExts
|
191
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
192
|
+
end
|
193
|
+
|
194
|
+
# Request message for ListAnnotatedDatasets.
|
195
|
+
# @!attribute [rw] parent
|
196
|
+
# @return [::String]
|
197
|
+
# Required. Name of the dataset to list annotated datasets, format:
|
198
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
199
|
+
# @!attribute [rw] filter
|
200
|
+
# @return [::String]
|
201
|
+
# Optional. Filter is not supported at this moment.
|
202
|
+
# @!attribute [rw] page_size
|
203
|
+
# @return [::Integer]
|
204
|
+
# Optional. Requested page size. Server may return fewer results than
|
205
|
+
# requested. Default value is 100.
|
206
|
+
# @!attribute [rw] page_token
|
207
|
+
# @return [::String]
|
208
|
+
# Optional. A token identifying a page of results for the server to return.
|
209
|
+
# Typically obtained by
|
210
|
+
# {::Google::Cloud::DataLabeling::V1beta1::ListAnnotatedDatasetsResponse#next_page_token ListAnnotatedDatasetsResponse.next_page_token} of the previous
|
211
|
+
# [DataLabelingService.ListAnnotatedDatasets] call.
|
212
|
+
# Return first page if empty.
|
213
|
+
class ListAnnotatedDatasetsRequest
|
214
|
+
include ::Google::Protobuf::MessageExts
|
215
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
216
|
+
end
|
217
|
+
|
218
|
+
# Results of listing annotated datasets for a dataset.
|
219
|
+
# @!attribute [rw] annotated_datasets
|
220
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::AnnotatedDataset>]
|
221
|
+
# The list of annotated datasets to return.
|
222
|
+
# @!attribute [rw] next_page_token
|
223
|
+
# @return [::String]
|
224
|
+
# A token to retrieve next page of results.
|
225
|
+
class ListAnnotatedDatasetsResponse
|
226
|
+
include ::Google::Protobuf::MessageExts
|
227
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
228
|
+
end
|
229
|
+
|
230
|
+
# Request message for DeleteAnnotatedDataset.
|
231
|
+
# @!attribute [rw] name
|
232
|
+
# @return [::String]
|
233
|
+
# Required. Name of the annotated dataset to delete, format:
|
234
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}/annotatedDatasets/
|
235
|
+
# \\{annotated_dataset_id}
|
236
|
+
class DeleteAnnotatedDatasetRequest
|
237
|
+
include ::Google::Protobuf::MessageExts
|
238
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
239
|
+
end
|
240
|
+
|
241
|
+
# Request message for starting an image labeling task.
|
242
|
+
# @!attribute [rw] image_classification_config
|
243
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::ImageClassificationConfig]
|
244
|
+
# Configuration for image classification task.
|
245
|
+
# One of image_classification_config, bounding_poly_config,
|
246
|
+
# polyline_config and segmentation_config are required.
|
247
|
+
# @!attribute [rw] bounding_poly_config
|
248
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::BoundingPolyConfig]
|
249
|
+
# Configuration for bounding box and bounding poly task.
|
250
|
+
# One of image_classification_config, bounding_poly_config,
|
251
|
+
# polyline_config and segmentation_config are required.
|
252
|
+
# @!attribute [rw] polyline_config
|
253
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::PolylineConfig]
|
254
|
+
# Configuration for polyline task.
|
255
|
+
# One of image_classification_config, bounding_poly_config,
|
256
|
+
# polyline_config and segmentation_config are required.
|
257
|
+
# @!attribute [rw] segmentation_config
|
258
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::SegmentationConfig]
|
259
|
+
# Configuration for segmentation task.
|
260
|
+
# One of image_classification_config, bounding_poly_config,
|
261
|
+
# polyline_config and segmentation_config are required.
|
262
|
+
# @!attribute [rw] parent
|
263
|
+
# @return [::String]
|
264
|
+
# Required. Name of the dataset to request labeling task, format:
|
265
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
266
|
+
# @!attribute [rw] basic_config
|
267
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
|
268
|
+
# Required. Basic human annotation config.
|
269
|
+
# @!attribute [rw] feature
|
270
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::LabelImageRequest::Feature]
|
271
|
+
# Required. The type of image labeling task.
|
272
|
+
class LabelImageRequest
|
273
|
+
include ::Google::Protobuf::MessageExts
|
274
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
275
|
+
|
276
|
+
# Image labeling task feature.
|
277
|
+
module Feature
|
278
|
+
FEATURE_UNSPECIFIED = 0
|
279
|
+
|
280
|
+
# Label whole image with one or more of labels.
|
281
|
+
CLASSIFICATION = 1
|
282
|
+
|
283
|
+
# Label image with bounding boxes for labels.
|
284
|
+
BOUNDING_BOX = 2
|
285
|
+
|
286
|
+
# Label oriented bounding box. The box does not have to be parallel to
|
287
|
+
# horizontal line.
|
288
|
+
ORIENTED_BOUNDING_BOX = 6
|
289
|
+
|
290
|
+
# Label images with bounding poly. A bounding poly is a plane figure that
|
291
|
+
# is bounded by a finite chain of straight line segments closing in a loop.
|
292
|
+
BOUNDING_POLY = 3
|
293
|
+
|
294
|
+
# Label images with polyline. Polyline is formed by connected line segments
|
295
|
+
# which are not in closed form.
|
296
|
+
POLYLINE = 4
|
297
|
+
|
298
|
+
# Label images with segmentation. Segmentation is different from bounding
|
299
|
+
# poly since it is more fine-grained, pixel level annotation.
|
300
|
+
SEGMENTATION = 5
|
301
|
+
end
|
302
|
+
end
|
303
|
+
|
304
|
+
# Request message for LabelVideo.
|
305
|
+
# @!attribute [rw] video_classification_config
|
306
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::VideoClassificationConfig]
|
307
|
+
# Configuration for video classification task.
|
308
|
+
# One of video_classification_config, object_detection_config,
|
309
|
+
# object_tracking_config and event_config is required.
|
310
|
+
# @!attribute [rw] object_detection_config
|
311
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::ObjectDetectionConfig]
|
312
|
+
# Configuration for video object detection task.
|
313
|
+
# One of video_classification_config, object_detection_config,
|
314
|
+
# object_tracking_config and event_config is required.
|
315
|
+
# @!attribute [rw] object_tracking_config
|
316
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::ObjectTrackingConfig]
|
317
|
+
# Configuration for video object tracking task.
|
318
|
+
# One of video_classification_config, object_detection_config,
|
319
|
+
# object_tracking_config and event_config is required.
|
320
|
+
# @!attribute [rw] event_config
|
321
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::EventConfig]
|
322
|
+
# Configuration for video event task.
|
323
|
+
# One of video_classification_config, object_detection_config,
|
324
|
+
# object_tracking_config and event_config is required.
|
325
|
+
# @!attribute [rw] parent
|
326
|
+
# @return [::String]
|
327
|
+
# Required. Name of the dataset to request labeling task, format:
|
328
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
329
|
+
# @!attribute [rw] basic_config
|
330
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
|
331
|
+
# Required. Basic human annotation config.
|
332
|
+
# @!attribute [rw] feature
|
333
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::LabelVideoRequest::Feature]
|
334
|
+
# Required. The type of video labeling task.
|
335
|
+
class LabelVideoRequest
|
336
|
+
include ::Google::Protobuf::MessageExts
|
337
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
338
|
+
|
339
|
+
# Video labeling task feature.
|
340
|
+
module Feature
|
341
|
+
FEATURE_UNSPECIFIED = 0
|
342
|
+
|
343
|
+
# Label whole video or video segment with one or more labels.
|
344
|
+
CLASSIFICATION = 1
|
345
|
+
|
346
|
+
# Label objects with bounding box on image frames extracted from the video.
|
347
|
+
OBJECT_DETECTION = 2
|
348
|
+
|
349
|
+
# Label and track objects in video.
|
350
|
+
OBJECT_TRACKING = 3
|
351
|
+
|
352
|
+
# Label the range of video for the specified events.
|
353
|
+
EVENT = 4
|
354
|
+
end
|
355
|
+
end
|
356
|
+
|
357
|
+
# Request message for LabelText.
|
358
|
+
# @!attribute [rw] text_classification_config
|
359
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::TextClassificationConfig]
|
360
|
+
# Configuration for text classification task.
|
361
|
+
# One of text_classification_config and text_entity_extraction_config
|
362
|
+
# is required.
|
363
|
+
# @!attribute [rw] text_entity_extraction_config
|
364
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::TextEntityExtractionConfig]
|
365
|
+
# Configuration for entity extraction task.
|
366
|
+
# One of text_classification_config and text_entity_extraction_config
|
367
|
+
# is required.
|
368
|
+
# @!attribute [rw] parent
|
369
|
+
# @return [::String]
|
370
|
+
# Required. Name of the data set to request labeling task, format:
|
371
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}
|
372
|
+
# @!attribute [rw] basic_config
|
373
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::HumanAnnotationConfig]
|
374
|
+
# Required. Basic human annotation config.
|
375
|
+
# @!attribute [rw] feature
|
376
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::LabelTextRequest::Feature]
|
377
|
+
# Required. The type of text labeling task.
|
378
|
+
class LabelTextRequest
|
379
|
+
include ::Google::Protobuf::MessageExts
|
380
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
381
|
+
|
382
|
+
# Text labeling task feature.
|
383
|
+
module Feature
|
384
|
+
FEATURE_UNSPECIFIED = 0
|
385
|
+
|
386
|
+
# Label text content to one of more labels.
|
387
|
+
TEXT_CLASSIFICATION = 1
|
388
|
+
|
389
|
+
# Label entities and their span in text.
|
390
|
+
TEXT_ENTITY_EXTRACTION = 2
|
391
|
+
end
|
392
|
+
end
|
393
|
+
|
394
|
+
# Request message for GetExample
|
395
|
+
# @!attribute [rw] name
|
396
|
+
# @return [::String]
|
397
|
+
# Required. Name of example, format:
|
398
|
+
# projects/\\{project_id}/datasets/\\{dataset_id}/annotatedDatasets/
|
399
|
+
# \\{annotated_dataset_id}/examples/\\{example_id}
|
400
|
+
# @!attribute [rw] filter
|
401
|
+
# @return [::String]
|
402
|
+
# Optional. An expression for filtering Examples. Filter by
|
403
|
+
# annotation_spec.display_name is supported. Format
|
404
|
+
# "annotation_spec.display_name = \\{display_name}"
|
405
|
+
class GetExampleRequest
|
406
|
+
include ::Google::Protobuf::MessageExts
|
407
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
408
|
+
end
|
409
|
+
|
410
|
+
# Request message for ListExamples.
|
411
|
+
# @!attribute [rw] parent
|
412
|
+
# @return [::String]
|
413
|
+
# Required. Example resource parent.
|
414
|
+
# @!attribute [rw] filter
|
415
|
+
# @return [::String]
|
416
|
+
# Optional. An expression for filtering Examples. For annotated datasets that
|
417
|
+
# have annotation spec set, filter by
|
418
|
+
# annotation_spec.display_name is supported. Format
|
419
|
+
# "annotation_spec.display_name = \\{display_name}"
|
420
|
+
# @!attribute [rw] page_size
|
421
|
+
# @return [::Integer]
|
422
|
+
# Optional. Requested page size. Server may return fewer results than
|
423
|
+
# requested. Default value is 100.
|
424
|
+
# @!attribute [rw] page_token
|
425
|
+
# @return [::String]
|
426
|
+
# Optional. A token identifying a page of results for the server to return.
|
427
|
+
# Typically obtained by
|
428
|
+
# {::Google::Cloud::DataLabeling::V1beta1::ListExamplesResponse#next_page_token ListExamplesResponse.next_page_token} of the previous
|
429
|
+
# [DataLabelingService.ListExamples] call.
|
430
|
+
# Return first page if empty.
|
431
|
+
class ListExamplesRequest
|
432
|
+
include ::Google::Protobuf::MessageExts
|
433
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
434
|
+
end
|
435
|
+
|
436
|
+
# Results of listing Examples in and annotated dataset.
|
437
|
+
# @!attribute [rw] examples
|
438
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::Example>]
|
439
|
+
# The list of examples to return.
|
440
|
+
# @!attribute [rw] next_page_token
|
441
|
+
# @return [::String]
|
442
|
+
# A token to retrieve next page of results.
|
443
|
+
class ListExamplesResponse
|
444
|
+
include ::Google::Protobuf::MessageExts
|
445
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
446
|
+
end
|
447
|
+
|
448
|
+
# Request message for CreateAnnotationSpecSet.
|
449
|
+
# @!attribute [rw] parent
|
450
|
+
# @return [::String]
|
451
|
+
# Required. AnnotationSpecSet resource parent, format:
|
452
|
+
# projects/\\{project_id}
|
453
|
+
# @!attribute [rw] annotation_spec_set
|
454
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet]
|
455
|
+
# Required. Annotation spec set to create. Annotation specs must be included.
|
456
|
+
# Only one annotation spec will be accepted for annotation specs with same
|
457
|
+
# display_name.
|
458
|
+
class CreateAnnotationSpecSetRequest
|
459
|
+
include ::Google::Protobuf::MessageExts
|
460
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
461
|
+
end
|
462
|
+
|
463
|
+
# Request message for GetAnnotationSpecSet.
|
464
|
+
# @!attribute [rw] name
|
465
|
+
# @return [::String]
|
466
|
+
# Required. AnnotationSpecSet resource name, format:
|
467
|
+
# projects/\\{project_id}/annotationSpecSets/\\{annotation_spec_set_id}
|
468
|
+
class GetAnnotationSpecSetRequest
|
469
|
+
include ::Google::Protobuf::MessageExts
|
470
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
471
|
+
end
|
472
|
+
|
473
|
+
# Request message for ListAnnotationSpecSets.
|
474
|
+
# @!attribute [rw] parent
|
475
|
+
# @return [::String]
|
476
|
+
# Required. Parent of AnnotationSpecSet resource, format:
|
477
|
+
# projects/\\{project_id}
|
478
|
+
# @!attribute [rw] filter
|
479
|
+
# @return [::String]
|
480
|
+
# Optional. Filter is not supported at this moment.
|
481
|
+
# @!attribute [rw] page_size
|
482
|
+
# @return [::Integer]
|
483
|
+
# Optional. Requested page size. Server may return fewer results than
|
484
|
+
# requested. Default value is 100.
|
485
|
+
# @!attribute [rw] page_token
|
486
|
+
# @return [::String]
|
487
|
+
# Optional. A token identifying a page of results for the server to return.
|
488
|
+
# Typically obtained by
|
489
|
+
# {::Google::Cloud::DataLabeling::V1beta1::ListAnnotationSpecSetsResponse#next_page_token ListAnnotationSpecSetsResponse.next_page_token} of the previous
|
490
|
+
# [DataLabelingService.ListAnnotationSpecSets] call.
|
491
|
+
# Return first page if empty.
|
492
|
+
class ListAnnotationSpecSetsRequest
|
493
|
+
include ::Google::Protobuf::MessageExts
|
494
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
495
|
+
end
|
496
|
+
|
497
|
+
# Results of listing annotation spec set under a project.
|
498
|
+
# @!attribute [rw] annotation_spec_sets
|
499
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::AnnotationSpecSet>]
|
500
|
+
# The list of annotation spec sets.
|
501
|
+
# @!attribute [rw] next_page_token
|
502
|
+
# @return [::String]
|
503
|
+
# A token to retrieve next page of results.
|
504
|
+
class ListAnnotationSpecSetsResponse
|
505
|
+
include ::Google::Protobuf::MessageExts
|
506
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
507
|
+
end
|
508
|
+
|
509
|
+
# Request message for DeleteAnnotationSpecSet.
|
510
|
+
# @!attribute [rw] name
|
511
|
+
# @return [::String]
|
512
|
+
# Required. AnnotationSpec resource name, format:
|
513
|
+
# `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.
|
514
|
+
class DeleteAnnotationSpecSetRequest
|
515
|
+
include ::Google::Protobuf::MessageExts
|
516
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
517
|
+
end
|
518
|
+
|
519
|
+
# Request message for CreateInstruction.
|
520
|
+
# @!attribute [rw] parent
|
521
|
+
# @return [::String]
|
522
|
+
# Required. Instruction resource parent, format:
|
523
|
+
# projects/\\{project_id}
|
524
|
+
# @!attribute [rw] instruction
|
525
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::Instruction]
|
526
|
+
# Required. Instruction of how to perform the labeling task.
|
527
|
+
class CreateInstructionRequest
|
528
|
+
include ::Google::Protobuf::MessageExts
|
529
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
530
|
+
end
|
531
|
+
|
532
|
+
# Request message for GetInstruction.
|
533
|
+
# @!attribute [rw] name
|
534
|
+
# @return [::String]
|
535
|
+
# Required. Instruction resource name, format:
|
536
|
+
# projects/\\{project_id}/instructions/\\{instruction_id}
|
537
|
+
class GetInstructionRequest
|
538
|
+
include ::Google::Protobuf::MessageExts
|
539
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
540
|
+
end
|
541
|
+
|
542
|
+
# Request message for DeleteInstruction.
|
543
|
+
# @!attribute [rw] name
|
544
|
+
# @return [::String]
|
545
|
+
# Required. Instruction resource name, format:
|
546
|
+
# projects/\\{project_id}/instructions/\\{instruction_id}
|
547
|
+
class DeleteInstructionRequest
|
548
|
+
include ::Google::Protobuf::MessageExts
|
549
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
550
|
+
end
|
551
|
+
|
552
|
+
# Request message for ListInstructions.
|
553
|
+
# @!attribute [rw] parent
|
554
|
+
# @return [::String]
|
555
|
+
# Required. Instruction resource parent, format:
|
556
|
+
# projects/\\{project_id}
|
557
|
+
# @!attribute [rw] filter
|
558
|
+
# @return [::String]
|
559
|
+
# Optional. Filter is not supported at this moment.
|
560
|
+
# @!attribute [rw] page_size
|
561
|
+
# @return [::Integer]
|
562
|
+
# Optional. Requested page size. Server may return fewer results than
|
563
|
+
# requested. Default value is 100.
|
564
|
+
# @!attribute [rw] page_token
|
565
|
+
# @return [::String]
|
566
|
+
# Optional. A token identifying a page of results for the server to return.
|
567
|
+
# Typically obtained by
|
568
|
+
# {::Google::Cloud::DataLabeling::V1beta1::ListInstructionsResponse#next_page_token ListInstructionsResponse.next_page_token} of the previous
|
569
|
+
# [DataLabelingService.ListInstructions] call.
|
570
|
+
# Return first page if empty.
|
571
|
+
class ListInstructionsRequest
|
572
|
+
include ::Google::Protobuf::MessageExts
|
573
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
574
|
+
end
|
575
|
+
|
576
|
+
# Results of listing instructions under a project.
|
577
|
+
# @!attribute [rw] instructions
|
578
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::Instruction>]
|
579
|
+
# The list of Instructions to return.
|
580
|
+
# @!attribute [rw] next_page_token
|
581
|
+
# @return [::String]
|
582
|
+
# A token to retrieve next page of results.
|
583
|
+
class ListInstructionsResponse
|
584
|
+
include ::Google::Protobuf::MessageExts
|
585
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
586
|
+
end
|
587
|
+
|
588
|
+
# Request message for GetEvaluation.
|
589
|
+
# @!attribute [rw] name
|
590
|
+
# @return [::String]
|
591
|
+
# Required. Name of the evaluation. Format:
|
592
|
+
#
|
593
|
+
# "projects/<var>\\{project_id}</var>/datasets/<var>\\{dataset_id}</var>/evaluations/<var>\\{evaluation_id}</var>'
|
594
|
+
class GetEvaluationRequest
|
595
|
+
include ::Google::Protobuf::MessageExts
|
596
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
597
|
+
end
|
598
|
+
|
599
|
+
# Request message for SearchEvaluation.
|
600
|
+
# @!attribute [rw] parent
|
601
|
+
# @return [::String]
|
602
|
+
# Required. Evaluation search parent (project ID). Format:
|
603
|
+
# "projects/<var>\\{project_id}</var>"
|
604
|
+
# @!attribute [rw] filter
|
605
|
+
# @return [::String]
|
606
|
+
# Optional. To search evaluations, you can filter by the following:
|
607
|
+
#
|
608
|
+
# * evaluation<span>_</span>job.evaluation_job_id (the last part of
|
609
|
+
# {::Google::Cloud::DataLabeling::V1beta1::EvaluationJob#name EvaluationJob.name})
|
610
|
+
# * evaluation<span>_</span>job.model_id (the <var>\\{model_name}</var> portion
|
611
|
+
# of {::Google::Cloud::DataLabeling::V1beta1::EvaluationJob#model_version EvaluationJob.modelVersion})
|
612
|
+
# * evaluation<span>_</span>job.evaluation_job_run_time_start (Minimum
|
613
|
+
# threshold for the
|
614
|
+
# {::Google::Cloud::DataLabeling::V1beta1::Evaluation#evaluation_job_run_time evaluationJobRunTime} that created
|
615
|
+
# the evaluation)
|
616
|
+
# * evaluation<span>_</span>job.evaluation_job_run_time_end (Maximum
|
617
|
+
# threshold for the
|
618
|
+
# {::Google::Cloud::DataLabeling::V1beta1::Evaluation#evaluation_job_run_time evaluationJobRunTime} that created
|
619
|
+
# the evaluation)
|
620
|
+
# * evaluation<span>_</span>job.job_state ({::Google::Cloud::DataLabeling::V1beta1::EvaluationJob#state EvaluationJob.state})
|
621
|
+
# * annotation<span>_</span>spec.display_name (the Evaluation contains a
|
622
|
+
# metric for the annotation spec with this
|
623
|
+
# {::Google::Cloud::DataLabeling::V1beta1::AnnotationSpec#display_name displayName})
|
624
|
+
#
|
625
|
+
# To filter by multiple critiera, use the `AND` operator or the `OR`
|
626
|
+
# operator. The following examples shows a string that filters by several
|
627
|
+
# critiera:
|
628
|
+
#
|
629
|
+
# "evaluation<span>_</span>job.evaluation_job_id =
|
630
|
+
# <var>\\{evaluation_job_id}</var> AND evaluation<span>_</span>job.model_id =
|
631
|
+
# <var>\\{model_name}</var> AND
|
632
|
+
# evaluation<span>_</span>job.evaluation_job_run_time_start =
|
633
|
+
# <var>\\{timestamp_1}</var> AND
|
634
|
+
# evaluation<span>_</span>job.evaluation_job_run_time_end =
|
635
|
+
# <var>\\{timestamp_2}</var> AND annotation<span>_</span>spec.display_name =
|
636
|
+
# <var>\\{display_name}</var>"
|
637
|
+
# @!attribute [rw] page_size
|
638
|
+
# @return [::Integer]
|
639
|
+
# Optional. Requested page size. Server may return fewer results than
|
640
|
+
# requested. Default value is 100.
|
641
|
+
# @!attribute [rw] page_token
|
642
|
+
# @return [::String]
|
643
|
+
# Optional. A token identifying a page of results for the server to return.
|
644
|
+
# Typically obtained by the
|
645
|
+
# {::Google::Cloud::DataLabeling::V1beta1::SearchEvaluationsResponse#next_page_token nextPageToken} of the response
|
646
|
+
# to a previous search request.
|
647
|
+
#
|
648
|
+
# If you don't specify this field, the API call requests the first page of
|
649
|
+
# the search.
|
650
|
+
class SearchEvaluationsRequest
|
651
|
+
include ::Google::Protobuf::MessageExts
|
652
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
653
|
+
end
|
654
|
+
|
655
|
+
# Results of searching evaluations.
|
656
|
+
# @!attribute [rw] evaluations
|
657
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::Evaluation>]
|
658
|
+
# The list of evaluations matching the search.
|
659
|
+
# @!attribute [rw] next_page_token
|
660
|
+
# @return [::String]
|
661
|
+
# A token to retrieve next page of results.
|
662
|
+
class SearchEvaluationsResponse
|
663
|
+
include ::Google::Protobuf::MessageExts
|
664
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
665
|
+
end
|
666
|
+
|
667
|
+
# Request message of SearchExampleComparisons.
|
668
|
+
# @!attribute [rw] parent
|
669
|
+
# @return [::String]
|
670
|
+
# Required. Name of the {::Google::Cloud::DataLabeling::V1beta1::Evaluation Evaluation} resource to search for example
|
671
|
+
# comparisons from. Format:
|
672
|
+
#
|
673
|
+
# "projects/<var>\\{project_id}</var>/datasets/<var>\\{dataset_id}</var>/evaluations/<var>\\{evaluation_id}</var>"
|
674
|
+
# @!attribute [rw] page_size
|
675
|
+
# @return [::Integer]
|
676
|
+
# Optional. Requested page size. Server may return fewer results than
|
677
|
+
# requested. Default value is 100.
|
678
|
+
# @!attribute [rw] page_token
|
679
|
+
# @return [::String]
|
680
|
+
# Optional. A token identifying a page of results for the server to return.
|
681
|
+
# Typically obtained by the
|
682
|
+
# [nextPageToken][SearchExampleComparisons.next_page_token] of the response
|
683
|
+
# to a previous search rquest.
|
684
|
+
#
|
685
|
+
# If you don't specify this field, the API call requests the first page of
|
686
|
+
# the search.
|
687
|
+
class SearchExampleComparisonsRequest
|
688
|
+
include ::Google::Protobuf::MessageExts
|
689
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
690
|
+
end
|
691
|
+
|
692
|
+
# Results of searching example comparisons.
|
693
|
+
# @!attribute [rw] example_comparisons
|
694
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::SearchExampleComparisonsResponse::ExampleComparison>]
|
695
|
+
# A list of example comparisons matching the search criteria.
|
696
|
+
# @!attribute [rw] next_page_token
|
697
|
+
# @return [::String]
|
698
|
+
# A token to retrieve next page of results.
|
699
|
+
class SearchExampleComparisonsResponse
|
700
|
+
include ::Google::Protobuf::MessageExts
|
701
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
702
|
+
|
703
|
+
# Example comparisons comparing ground truth output and predictions for a
|
704
|
+
# specific input.
|
705
|
+
# @!attribute [rw] ground_truth_example
|
706
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::Example]
|
707
|
+
# The ground truth output for the input.
|
708
|
+
# @!attribute [rw] model_created_examples
|
709
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::Example>]
|
710
|
+
# Predictions by the model for the input.
|
711
|
+
class ExampleComparison
|
712
|
+
include ::Google::Protobuf::MessageExts
|
713
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
714
|
+
end
|
715
|
+
end
|
716
|
+
|
717
|
+
# Request message for CreateEvaluationJob.
|
718
|
+
# @!attribute [rw] parent
|
719
|
+
# @return [::String]
|
720
|
+
# Required. Evaluation job resource parent. Format:
|
721
|
+
# "projects/<var>\\{project_id}</var>"
|
722
|
+
# @!attribute [rw] job
|
723
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::EvaluationJob]
|
724
|
+
# Required. The evaluation job to create.
|
725
|
+
class CreateEvaluationJobRequest
|
726
|
+
include ::Google::Protobuf::MessageExts
|
727
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
728
|
+
end
|
729
|
+
|
730
|
+
# Request message for UpdateEvaluationJob.
|
731
|
+
# @!attribute [rw] evaluation_job
|
732
|
+
# @return [::Google::Cloud::DataLabeling::V1beta1::EvaluationJob]
|
733
|
+
# Required. Evaluation job that is going to be updated.
|
734
|
+
# @!attribute [rw] update_mask
|
735
|
+
# @return [::Google::Protobuf::FieldMask]
|
736
|
+
# Optional. Mask for which fields to update. You can only provide the
|
737
|
+
# following fields:
|
738
|
+
#
|
739
|
+
# * `evaluationJobConfig.humanAnnotationConfig.instruction`
|
740
|
+
# * `evaluationJobConfig.exampleCount`
|
741
|
+
# * `evaluationJobConfig.exampleSamplePercentage`
|
742
|
+
#
|
743
|
+
# You can provide more than one of these fields by separating them with
|
744
|
+
# commas.
|
745
|
+
class UpdateEvaluationJobRequest
|
746
|
+
include ::Google::Protobuf::MessageExts
|
747
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
748
|
+
end
|
749
|
+
|
750
|
+
# Request message for GetEvaluationJob.
|
751
|
+
# @!attribute [rw] name
|
752
|
+
# @return [::String]
|
753
|
+
# Required. Name of the evaluation job. Format:
|
754
|
+
#
|
755
|
+
# "projects/<var>\\{project_id}</var>/evaluationJobs/<var>\\{evaluation_job_id}</var>"
|
756
|
+
class GetEvaluationJobRequest
|
757
|
+
include ::Google::Protobuf::MessageExts
|
758
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
759
|
+
end
|
760
|
+
|
761
|
+
# Request message for PauseEvaluationJob.
|
762
|
+
# @!attribute [rw] name
|
763
|
+
# @return [::String]
|
764
|
+
# Required. Name of the evaluation job that is going to be paused. Format:
|
765
|
+
#
|
766
|
+
# "projects/<var>\\{project_id}</var>/evaluationJobs/<var>\\{evaluation_job_id}</var>"
|
767
|
+
class PauseEvaluationJobRequest
|
768
|
+
include ::Google::Protobuf::MessageExts
|
769
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
770
|
+
end
|
771
|
+
|
772
|
+
# Request message ResumeEvaluationJob.
|
773
|
+
# @!attribute [rw] name
|
774
|
+
# @return [::String]
|
775
|
+
# Required. Name of the evaluation job that is going to be resumed. Format:
|
776
|
+
#
|
777
|
+
# "projects/<var>\\{project_id}</var>/evaluationJobs/<var>\\{evaluation_job_id}</var>"
|
778
|
+
class ResumeEvaluationJobRequest
|
779
|
+
include ::Google::Protobuf::MessageExts
|
780
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
781
|
+
end
|
782
|
+
|
783
|
+
# Request message DeleteEvaluationJob.
|
784
|
+
# @!attribute [rw] name
|
785
|
+
# @return [::String]
|
786
|
+
# Required. Name of the evaluation job that is going to be deleted. Format:
|
787
|
+
#
|
788
|
+
# "projects/<var>\\{project_id}</var>/evaluationJobs/<var>\\{evaluation_job_id}</var>"
|
789
|
+
class DeleteEvaluationJobRequest
|
790
|
+
include ::Google::Protobuf::MessageExts
|
791
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
792
|
+
end
|
793
|
+
|
794
|
+
# Request message for ListEvaluationJobs.
|
795
|
+
# @!attribute [rw] parent
|
796
|
+
# @return [::String]
|
797
|
+
# Required. Evaluation job resource parent. Format:
|
798
|
+
# "projects/<var>\\{project_id}</var>"
|
799
|
+
# @!attribute [rw] filter
|
800
|
+
# @return [::String]
|
801
|
+
# Optional. You can filter the jobs to list by model_id (also known as
|
802
|
+
# model_name, as described in
|
803
|
+
# {::Google::Cloud::DataLabeling::V1beta1::EvaluationJob#model_version EvaluationJob.modelVersion}) or by
|
804
|
+
# evaluation job state (as described in {::Google::Cloud::DataLabeling::V1beta1::EvaluationJob#state EvaluationJob.state}). To filter
|
805
|
+
# by both criteria, use the `AND` operator or the `OR` operator. For example,
|
806
|
+
# you can use the following string for your filter:
|
807
|
+
# "evaluation<span>_</span>job.model_id = <var>\\{model_name}</var> AND
|
808
|
+
# evaluation<span>_</span>job.state = <var>\\{evaluation_job_state}</var>"
|
809
|
+
# @!attribute [rw] page_size
|
810
|
+
# @return [::Integer]
|
811
|
+
# Optional. Requested page size. Server may return fewer results than
|
812
|
+
# requested. Default value is 100.
|
813
|
+
# @!attribute [rw] page_token
|
814
|
+
# @return [::String]
|
815
|
+
# Optional. A token identifying a page of results for the server to return.
|
816
|
+
# Typically obtained by the
|
817
|
+
# {::Google::Cloud::DataLabeling::V1beta1::ListEvaluationJobsResponse#next_page_token nextPageToken} in the response
|
818
|
+
# to the previous request. The request returns the first page if this is
|
819
|
+
# empty.
|
820
|
+
class ListEvaluationJobsRequest
|
821
|
+
include ::Google::Protobuf::MessageExts
|
822
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
823
|
+
end
|
824
|
+
|
825
|
+
# Results for listing evaluation jobs.
|
826
|
+
# @!attribute [rw] evaluation_jobs
|
827
|
+
# @return [::Array<::Google::Cloud::DataLabeling::V1beta1::EvaluationJob>]
|
828
|
+
# The list of evaluation jobs to return.
|
829
|
+
# @!attribute [rw] next_page_token
|
830
|
+
# @return [::String]
|
831
|
+
# A token to retrieve next page of results.
|
832
|
+
class ListEvaluationJobsResponse
|
833
|
+
include ::Google::Protobuf::MessageExts
|
834
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
835
|
+
end
|
836
|
+
end
|
837
|
+
end
|
838
|
+
end
|
839
|
+
end
|