1"""Generated message classes for aiplatform version v1.
2
3Train high-quality custom machine learning models with minimal machine
4learning expertise and effort.
5"""
6# NOTE: This file is autogenerated and should not be edited by hand.
7
8from __future__ import absolute_import
9
10from apitools.base.protorpclite import messages as _messages
11from apitools.base.py import encoding
12from apitools.base.py import extra_types
13
14
15package = 'aiplatform'
16
17
18class AiplatformProjectsLocationsBatchPredictionJobsCancelRequest(_messages.Message):
19  r"""A AiplatformProjectsLocationsBatchPredictionJobsCancelRequest object.
20
21  Fields:
22    googleCloudAiplatformV1CancelBatchPredictionJobRequest: A
23      GoogleCloudAiplatformV1CancelBatchPredictionJobRequest resource to be
24      passed as the request body.
25    name: Required. The name of the BatchPredictionJob to cancel. Format: `pro
26      jects/{project}/locations/{location}/batchPredictionJobs/{batch_predicti
27      on_job}`
28  """
29
30  googleCloudAiplatformV1CancelBatchPredictionJobRequest = _messages.MessageField('GoogleCloudAiplatformV1CancelBatchPredictionJobRequest', 1)
31  name = _messages.StringField(2, required=True)
32
33
34class AiplatformProjectsLocationsBatchPredictionJobsCreateRequest(_messages.Message):
35  r"""A AiplatformProjectsLocationsBatchPredictionJobsCreateRequest object.
36
37  Fields:
38    googleCloudAiplatformV1BatchPredictionJob: A
39      GoogleCloudAiplatformV1BatchPredictionJob resource to be passed as the
40      request body.
41    parent: Required. The resource name of the Location to create the
42      BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
43  """
44
45  googleCloudAiplatformV1BatchPredictionJob = _messages.MessageField('GoogleCloudAiplatformV1BatchPredictionJob', 1)
46  parent = _messages.StringField(2, required=True)
47
48
49class AiplatformProjectsLocationsBatchPredictionJobsDeleteRequest(_messages.Message):
50  r"""A AiplatformProjectsLocationsBatchPredictionJobsDeleteRequest object.
51
52  Fields:
53    name: Required. The name of the BatchPredictionJob resource to be deleted.
54      Format: `projects/{project}/locations/{location}/batchPredictionJobs/{ba
55      tch_prediction_job}`
56  """
57
58  name = _messages.StringField(1, required=True)
59
60
61class AiplatformProjectsLocationsBatchPredictionJobsGetRequest(_messages.Message):
62  r"""A AiplatformProjectsLocationsBatchPredictionJobsGetRequest object.
63
64  Fields:
65    name: Required. The name of the BatchPredictionJob resource. Format: `proj
66      ects/{project}/locations/{location}/batchPredictionJobs/{batch_predictio
67      n_job}`
68  """
69
70  name = _messages.StringField(1, required=True)
71
72
73class AiplatformProjectsLocationsBatchPredictionJobsListRequest(_messages.Message):
74  r"""A AiplatformProjectsLocationsBatchPredictionJobsListRequest object.
75
76  Fields:
77    filter: The standard list filter. Supported fields: * `display_name`
78      supports = and !=. * `state` supports = and !=. * `model_display_name`
79      supports = and != Some examples of using the filter are: *
80      `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"` *
81      `state="JOB_STATE_RUNNING" OR display_name="my_job"` * `NOT
82      display_name="my_job"` * `state="JOB_STATE_FAILED"`
83    pageSize: The standard list page size.
84    pageToken: The standard list page token. Typically obtained via
85      ListBatchPredictionJobsResponse.next_page_token of the previous
86      JobService.ListBatchPredictionJobs call.
87    parent: Required. The resource name of the Location to list the
88      BatchPredictionJobs from. Format:
89      `projects/{project}/locations/{location}`
90    readMask: Mask specifying which fields to read.
91  """
92
93  filter = _messages.StringField(1)
94  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
95  pageToken = _messages.StringField(3)
96  parent = _messages.StringField(4, required=True)
97  readMask = _messages.StringField(5)
98
99
100class AiplatformProjectsLocationsCustomJobsCancelRequest(_messages.Message):
101  r"""A AiplatformProjectsLocationsCustomJobsCancelRequest object.
102
103  Fields:
104    googleCloudAiplatformV1CancelCustomJobRequest: A
105      GoogleCloudAiplatformV1CancelCustomJobRequest resource to be passed as
106      the request body.
107    name: Required. The name of the CustomJob to cancel. Format:
108      `projects/{project}/locations/{location}/customJobs/{custom_job}`
109  """
110
111  googleCloudAiplatformV1CancelCustomJobRequest = _messages.MessageField('GoogleCloudAiplatformV1CancelCustomJobRequest', 1)
112  name = _messages.StringField(2, required=True)
113
114
115class AiplatformProjectsLocationsCustomJobsCreateRequest(_messages.Message):
116  r"""A AiplatformProjectsLocationsCustomJobsCreateRequest object.
117
118  Fields:
119    googleCloudAiplatformV1CustomJob: A GoogleCloudAiplatformV1CustomJob
120      resource to be passed as the request body.
121    parent: Required. The resource name of the Location to create the
122      CustomJob in. Format: `projects/{project}/locations/{location}`
123  """
124
125  googleCloudAiplatformV1CustomJob = _messages.MessageField('GoogleCloudAiplatformV1CustomJob', 1)
126  parent = _messages.StringField(2, required=True)
127
128
129class AiplatformProjectsLocationsCustomJobsDeleteRequest(_messages.Message):
130  r"""A AiplatformProjectsLocationsCustomJobsDeleteRequest object.
131
132  Fields:
133    name: Required. The name of the CustomJob resource to be deleted. Format:
134      `projects/{project}/locations/{location}/customJobs/{custom_job}`
135  """
136
137  name = _messages.StringField(1, required=True)
138
139
140class AiplatformProjectsLocationsCustomJobsGetRequest(_messages.Message):
141  r"""A AiplatformProjectsLocationsCustomJobsGetRequest object.
142
143  Fields:
144    name: Required. The name of the CustomJob resource. Format:
145      `projects/{project}/locations/{location}/customJobs/{custom_job}`
146  """
147
148  name = _messages.StringField(1, required=True)
149
150
151class AiplatformProjectsLocationsCustomJobsListRequest(_messages.Message):
152  r"""A AiplatformProjectsLocationsCustomJobsListRequest object.
153
154  Fields:
155    filter: The standard list filter. Supported fields: * `display_name`
156      supports = and !=. * `state` supports = and !=. Some examples of using
157      the filter are: * `state="JOB_STATE_SUCCEEDED" AND
158      display_name="my_job"` * `state="JOB_STATE_RUNNING" OR
159      display_name="my_job"` * `NOT display_name="my_job"` *
160      `state="JOB_STATE_FAILED"`
161    pageSize: The standard list page size.
162    pageToken: The standard list page token. Typically obtained via
163      ListCustomJobsResponse.next_page_token of the previous
164      JobService.ListCustomJobs call.
165    parent: Required. The resource name of the Location to list the CustomJobs
166      from. Format: `projects/{project}/locations/{location}`
167    readMask: Mask specifying which fields to read.
168  """
169
170  filter = _messages.StringField(1)
171  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
172  pageToken = _messages.StringField(3)
173  parent = _messages.StringField(4, required=True)
174  readMask = _messages.StringField(5)
175
176
177class AiplatformProjectsLocationsDataLabelingJobsCancelRequest(_messages.Message):
178  r"""A AiplatformProjectsLocationsDataLabelingJobsCancelRequest object.
179
180  Fields:
181    googleCloudAiplatformV1CancelDataLabelingJobRequest: A
182      GoogleCloudAiplatformV1CancelDataLabelingJobRequest resource to be
183      passed as the request body.
184    name: Required. The name of the DataLabelingJob. Format: `projects/{projec
185      t}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
186  """
187
188  googleCloudAiplatformV1CancelDataLabelingJobRequest = _messages.MessageField('GoogleCloudAiplatformV1CancelDataLabelingJobRequest', 1)
189  name = _messages.StringField(2, required=True)
190
191
192class AiplatformProjectsLocationsDataLabelingJobsCreateRequest(_messages.Message):
193  r"""A AiplatformProjectsLocationsDataLabelingJobsCreateRequest object.
194
195  Fields:
196    googleCloudAiplatformV1DataLabelingJob: A
197      GoogleCloudAiplatformV1DataLabelingJob resource to be passed as the
198      request body.
199    parent: Required. The parent of the DataLabelingJob. Format:
200      `projects/{project}/locations/{location}`
201  """
202
203  googleCloudAiplatformV1DataLabelingJob = _messages.MessageField('GoogleCloudAiplatformV1DataLabelingJob', 1)
204  parent = _messages.StringField(2, required=True)
205
206
207class AiplatformProjectsLocationsDataLabelingJobsDeleteRequest(_messages.Message):
208  r"""A AiplatformProjectsLocationsDataLabelingJobsDeleteRequest object.
209
210  Fields:
211    name: Required. The name of the DataLabelingJob to be deleted. Format: `pr
212      ojects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_jo
213      b}`
214  """
215
216  name = _messages.StringField(1, required=True)
217
218
219class AiplatformProjectsLocationsDataLabelingJobsGetRequest(_messages.Message):
220  r"""A AiplatformProjectsLocationsDataLabelingJobsGetRequest object.
221
222  Fields:
223    name: Required. The name of the DataLabelingJob. Format: `projects/{projec
224      t}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
225  """
226
227  name = _messages.StringField(1, required=True)
228
229
230class AiplatformProjectsLocationsDataLabelingJobsListRequest(_messages.Message):
231  r"""A AiplatformProjectsLocationsDataLabelingJobsListRequest object.
232
233  Fields:
234    filter: The standard list filter. Supported fields: * `display_name`
235      supports = and !=. * `state` supports = and !=. Some examples of using
236      the filter are: * `state="JOB_STATE_SUCCEEDED" AND
237      display_name="my_job"` * `state="JOB_STATE_RUNNING" OR
238      display_name="my_job"` * `NOT display_name="my_job"` *
239      `state="JOB_STATE_FAILED"`
240    orderBy: A comma-separated list of fields to order by, sorted in ascending
241      order by default. Use `desc` after a field name for descending.
242    pageSize: The standard list page size.
243    pageToken: The standard list page token.
244    parent: Required. The parent of the DataLabelingJob. Format:
245      `projects/{project}/locations/{location}`
246    readMask: Mask specifying which fields to read. FieldMask represents a set
247      of symbolic field paths. For example, the mask can be `paths: "name"`.
248      The "name" here is a field in DataLabelingJob. If this field is not set,
249      all fields of the DataLabelingJob are returned.
250  """
251
252  filter = _messages.StringField(1)
253  orderBy = _messages.StringField(2)
254  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
255  pageToken = _messages.StringField(4)
256  parent = _messages.StringField(5, required=True)
257  readMask = _messages.StringField(6)
258
259
260class AiplatformProjectsLocationsDatasetsAnnotationSpecsGetRequest(_messages.Message):
261  r"""A AiplatformProjectsLocationsDatasetsAnnotationSpecsGetRequest object.
262
263  Fields:
264    name: Required. The name of the AnnotationSpec resource. Format: `projects
265      /{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{anno
266      tation_spec}`
267    readMask: Mask specifying which fields to read.
268  """
269
270  name = _messages.StringField(1, required=True)
271  readMask = _messages.StringField(2)
272
273
274class AiplatformProjectsLocationsDatasetsCreateRequest(_messages.Message):
275  r"""A AiplatformProjectsLocationsDatasetsCreateRequest object.
276
277  Fields:
278    googleCloudAiplatformV1Dataset: A GoogleCloudAiplatformV1Dataset resource
279      to be passed as the request body.
280    parent: Required. The resource name of the Location to create the Dataset
281      in. Format: `projects/{project}/locations/{location}`
282  """
283
284  googleCloudAiplatformV1Dataset = _messages.MessageField('GoogleCloudAiplatformV1Dataset', 1)
285  parent = _messages.StringField(2, required=True)
286
287
288class AiplatformProjectsLocationsDatasetsDataItemsAnnotationsListRequest(_messages.Message):
289  r"""A AiplatformProjectsLocationsDatasetsDataItemsAnnotationsListRequest
290  object.
291
292  Fields:
293    filter: The standard list filter.
294    orderBy: A comma-separated list of fields to order by, sorted in ascending
295      order. Use "desc" after a field name for descending.
296    pageSize: The standard list page size.
297    pageToken: The standard list page token.
298    parent: Required. The resource name of the DataItem to list Annotations
299      from. Format: `projects/{project}/locations/{location}/datasets/{dataset
300      }/dataItems/{data_item}`
301    readMask: Mask specifying which fields to read.
302  """
303
304  filter = _messages.StringField(1)
305  orderBy = _messages.StringField(2)
306  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
307  pageToken = _messages.StringField(4)
308  parent = _messages.StringField(5, required=True)
309  readMask = _messages.StringField(6)
310
311
312class AiplatformProjectsLocationsDatasetsDataItemsListRequest(_messages.Message):
313  r"""A AiplatformProjectsLocationsDatasetsDataItemsListRequest object.
314
315  Fields:
316    filter: The standard list filter.
317    orderBy: A comma-separated list of fields to order by, sorted in ascending
318      order. Use "desc" after a field name for descending.
319    pageSize: The standard list page size.
320    pageToken: The standard list page token.
321    parent: Required. The resource name of the Dataset to list DataItems from.
322      Format: `projects/{project}/locations/{location}/datasets/{dataset}`
323    readMask: Mask specifying which fields to read.
324  """
325
326  filter = _messages.StringField(1)
327  orderBy = _messages.StringField(2)
328  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
329  pageToken = _messages.StringField(4)
330  parent = _messages.StringField(5, required=True)
331  readMask = _messages.StringField(6)
332
333
334class AiplatformProjectsLocationsDatasetsDeleteRequest(_messages.Message):
335  r"""A AiplatformProjectsLocationsDatasetsDeleteRequest object.
336
337  Fields:
338    name: Required. The resource name of the Dataset to delete. Format:
339      `projects/{project}/locations/{location}/datasets/{dataset}`
340  """
341
342  name = _messages.StringField(1, required=True)
343
344
345class AiplatformProjectsLocationsDatasetsExportRequest(_messages.Message):
346  r"""A AiplatformProjectsLocationsDatasetsExportRequest object.
347
348  Fields:
349    googleCloudAiplatformV1ExportDataRequest: A
350      GoogleCloudAiplatformV1ExportDataRequest resource to be passed as the
351      request body.
352    name: Required. The name of the Dataset resource. Format:
353      `projects/{project}/locations/{location}/datasets/{dataset}`
354  """
355
356  googleCloudAiplatformV1ExportDataRequest = _messages.MessageField('GoogleCloudAiplatformV1ExportDataRequest', 1)
357  name = _messages.StringField(2, required=True)
358
359
360class AiplatformProjectsLocationsDatasetsGetRequest(_messages.Message):
361  r"""A AiplatformProjectsLocationsDatasetsGetRequest object.
362
363  Fields:
364    name: Required. The name of the Dataset resource.
365    readMask: Mask specifying which fields to read.
366  """
367
368  name = _messages.StringField(1, required=True)
369  readMask = _messages.StringField(2)
370
371
372class AiplatformProjectsLocationsDatasetsImportRequest(_messages.Message):
373  r"""A AiplatformProjectsLocationsDatasetsImportRequest object.
374
375  Fields:
376    googleCloudAiplatformV1ImportDataRequest: A
377      GoogleCloudAiplatformV1ImportDataRequest resource to be passed as the
378      request body.
379    name: Required. The name of the Dataset resource. Format:
380      `projects/{project}/locations/{location}/datasets/{dataset}`
381  """
382
383  googleCloudAiplatformV1ImportDataRequest = _messages.MessageField('GoogleCloudAiplatformV1ImportDataRequest', 1)
384  name = _messages.StringField(2, required=True)
385
386
387class AiplatformProjectsLocationsDatasetsListRequest(_messages.Message):
388  r"""A AiplatformProjectsLocationsDatasetsListRequest object.
389
390  Fields:
391    filter: An expression for filtering the results of the request. For field
392      names both snake_case and camelCase are supported. * `display_name`:
393      supports = and != * `metadata_schema_uri`: supports = and != * `labels`
394      supports general map functions that is: * `labels.key=value` - key:value
395      equality * `labels.key:* or labels:key - key existence * A key including
396      a space must be quoted. `labels."a key"`. Some examples: *
397      `displayName="myDisplayName"` * `labels.myKey="myValue"`
398    orderBy: A comma-separated list of fields to order by, sorted in ascending
399      order. Use "desc" after a field name for descending. Supported fields: *
400      `display_name` * `create_time` * `update_time`
401    pageSize: The standard list page size.
402    pageToken: The standard list page token.
403    parent: Required. The name of the Dataset's parent resource. Format:
404      `projects/{project}/locations/{location}`
405    readMask: Mask specifying which fields to read.
406  """
407
408  filter = _messages.StringField(1)
409  orderBy = _messages.StringField(2)
410  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
411  pageToken = _messages.StringField(4)
412  parent = _messages.StringField(5, required=True)
413  readMask = _messages.StringField(6)
414
415
416class AiplatformProjectsLocationsDatasetsPatchRequest(_messages.Message):
417  r"""A AiplatformProjectsLocationsDatasetsPatchRequest object.
418
419  Fields:
420    googleCloudAiplatformV1Dataset: A GoogleCloudAiplatformV1Dataset resource
421      to be passed as the request body.
422    name: Output only. The resource name of the Dataset.
423    updateMask: Required. The update mask applies to the resource. For the
424      `FieldMask` definition, see
425      [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask).
426      Updatable fields: * `display_name` * `description` * `labels`
427  """
428
429  googleCloudAiplatformV1Dataset = _messages.MessageField('GoogleCloudAiplatformV1Dataset', 1)
430  name = _messages.StringField(2, required=True)
431  updateMask = _messages.StringField(3)
432
433
434class AiplatformProjectsLocationsEndpointsCreateRequest(_messages.Message):
435  r"""A AiplatformProjectsLocationsEndpointsCreateRequest object.
436
437  Fields:
438    googleCloudAiplatformV1Endpoint: A GoogleCloudAiplatformV1Endpoint
439      resource to be passed as the request body.
440    parent: Required. The resource name of the Location to create the Endpoint
441      in. Format: `projects/{project}/locations/{location}`
442  """
443
444  googleCloudAiplatformV1Endpoint = _messages.MessageField('GoogleCloudAiplatformV1Endpoint', 1)
445  parent = _messages.StringField(2, required=True)
446
447
448class AiplatformProjectsLocationsEndpointsDeleteRequest(_messages.Message):
449  r"""A AiplatformProjectsLocationsEndpointsDeleteRequest object.
450
451  Fields:
452    name: Required. The name of the Endpoint resource to be deleted. Format:
453      `projects/{project}/locations/{location}/endpoints/{endpoint}`
454  """
455
456  name = _messages.StringField(1, required=True)
457
458
459class AiplatformProjectsLocationsEndpointsDeployModelRequest(_messages.Message):
460  r"""A AiplatformProjectsLocationsEndpointsDeployModelRequest object.
461
462  Fields:
463    endpoint: Required. The name of the Endpoint resource into which to deploy
464      a Model. Format:
465      `projects/{project}/locations/{location}/endpoints/{endpoint}`
466    googleCloudAiplatformV1DeployModelRequest: A
467      GoogleCloudAiplatformV1DeployModelRequest resource to be passed as the
468      request body.
469  """
470
471  endpoint = _messages.StringField(1, required=True)
472  googleCloudAiplatformV1DeployModelRequest = _messages.MessageField('GoogleCloudAiplatformV1DeployModelRequest', 2)
473
474
475class AiplatformProjectsLocationsEndpointsGetRequest(_messages.Message):
476  r"""A AiplatformProjectsLocationsEndpointsGetRequest object.
477
478  Fields:
479    name: Required. The name of the Endpoint resource. Format:
480      `projects/{project}/locations/{location}/endpoints/{endpoint}`
481  """
482
483  name = _messages.StringField(1, required=True)
484
485
486class AiplatformProjectsLocationsEndpointsListRequest(_messages.Message):
487  r"""A AiplatformProjectsLocationsEndpointsListRequest object.
488
489  Fields:
490    filter: Optional. An expression for filtering the results of the request.
491      For field names both snake_case and camelCase are supported. *
492      `endpoint` supports = and !=. `endpoint` represents the Endpoint ID,
493      i.e. the last segment of the Endpoint's resource name. * `display_name`
494      supports = and, != * `labels` supports general map functions that is: *
495      `labels.key=value` - key:value equality * `labels.key:* or labels:key -
496      key existence * A key including a space must be quoted. `labels."a
497      key"`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` *
498      `labels.myKey="myValue"`
499    orderBy: A comma-separated list of fields to order by, sorted in ascending
500      order. Use "desc" after a field name for descending. Supported fields: *
501      `display_name` * `create_time` * `update_time` Example: `display_name,
502      create_time desc`.
503    pageSize: Optional. The standard list page size.
504    pageToken: Optional. The standard list page token. Typically obtained via
505      ListEndpointsResponse.next_page_token of the previous
506      EndpointService.ListEndpoints call.
507    parent: Required. The resource name of the Location from which to list the
508      Endpoints. Format: `projects/{project}/locations/{location}`
509    readMask: Optional. Mask specifying which fields to read.
510  """
511
512  filter = _messages.StringField(1)
513  orderBy = _messages.StringField(2)
514  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
515  pageToken = _messages.StringField(4)
516  parent = _messages.StringField(5, required=True)
517  readMask = _messages.StringField(6)
518
519
520class AiplatformProjectsLocationsEndpointsPatchRequest(_messages.Message):
521  r"""A AiplatformProjectsLocationsEndpointsPatchRequest object.
522
523  Fields:
524    googleCloudAiplatformV1Endpoint: A GoogleCloudAiplatformV1Endpoint
525      resource to be passed as the request body.
526    name: Output only. The resource name of the Endpoint.
527    updateMask: Required. The update mask applies to the resource. See
528      [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask).
529  """
530
531  googleCloudAiplatformV1Endpoint = _messages.MessageField('GoogleCloudAiplatformV1Endpoint', 1)
532  name = _messages.StringField(2, required=True)
533  updateMask = _messages.StringField(3)
534
535
536class AiplatformProjectsLocationsEndpointsPredictRequest(_messages.Message):
537  r"""A AiplatformProjectsLocationsEndpointsPredictRequest object.
538
539  Fields:
540    endpoint: Required. The name of the Endpoint requested to serve the
541      prediction. Format:
542      `projects/{project}/locations/{location}/endpoints/{endpoint}`
543    googleCloudAiplatformV1PredictRequest: A
544      GoogleCloudAiplatformV1PredictRequest resource to be passed as the
545      request body.
546  """
547
548  endpoint = _messages.StringField(1, required=True)
549  googleCloudAiplatformV1PredictRequest = _messages.MessageField('GoogleCloudAiplatformV1PredictRequest', 2)
550
551
552class AiplatformProjectsLocationsEndpointsUndeployModelRequest(_messages.Message):
553  r"""A AiplatformProjectsLocationsEndpointsUndeployModelRequest object.
554
555  Fields:
556    endpoint: Required. The name of the Endpoint resource from which to
557      undeploy a Model. Format:
558      `projects/{project}/locations/{location}/endpoints/{endpoint}`
559    googleCloudAiplatformV1UndeployModelRequest: A
560      GoogleCloudAiplatformV1UndeployModelRequest resource to be passed as the
561      request body.
562  """
563
564  endpoint = _messages.StringField(1, required=True)
565  googleCloudAiplatformV1UndeployModelRequest = _messages.MessageField('GoogleCloudAiplatformV1UndeployModelRequest', 2)
566
567
568class AiplatformProjectsLocationsHyperparameterTuningJobsCancelRequest(_messages.Message):
569  r"""A AiplatformProjectsLocationsHyperparameterTuningJobsCancelRequest
570  object.
571
572  Fields:
573    googleCloudAiplatformV1CancelHyperparameterTuningJobRequest: A
574      GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest resource to
575      be passed as the request body.
576    name: Required. The name of the HyperparameterTuningJob to cancel. Format:
577      `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyper
578      parameter_tuning_job}`
579  """
580
581  googleCloudAiplatformV1CancelHyperparameterTuningJobRequest = _messages.MessageField('GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest', 1)
582  name = _messages.StringField(2, required=True)
583
584
585class AiplatformProjectsLocationsHyperparameterTuningJobsCreateRequest(_messages.Message):
586  r"""A AiplatformProjectsLocationsHyperparameterTuningJobsCreateRequest
587  object.
588
589  Fields:
590    googleCloudAiplatformV1HyperparameterTuningJob: A
591      GoogleCloudAiplatformV1HyperparameterTuningJob resource to be passed as
592      the request body.
593    parent: Required. The resource name of the Location to create the
594      HyperparameterTuningJob in. Format:
595      `projects/{project}/locations/{location}`
596  """
597
598  googleCloudAiplatformV1HyperparameterTuningJob = _messages.MessageField('GoogleCloudAiplatformV1HyperparameterTuningJob', 1)
599  parent = _messages.StringField(2, required=True)
600
601
602class AiplatformProjectsLocationsHyperparameterTuningJobsDeleteRequest(_messages.Message):
603  r"""A AiplatformProjectsLocationsHyperparameterTuningJobsDeleteRequest
604  object.
605
606  Fields:
607    name: Required. The name of the HyperparameterTuningJob resource to be
608      deleted. Format: `projects/{project}/locations/{location}/hyperparameter
609      TuningJobs/{hyperparameter_tuning_job}`
610  """
611
612  name = _messages.StringField(1, required=True)
613
614
615class AiplatformProjectsLocationsHyperparameterTuningJobsGetRequest(_messages.Message):
616  r"""A AiplatformProjectsLocationsHyperparameterTuningJobsGetRequest object.
617
618  Fields:
619    name: Required. The name of the HyperparameterTuningJob resource. Format:
620      `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyper
621      parameter_tuning_job}`
622  """
623
624  name = _messages.StringField(1, required=True)
625
626
627class AiplatformProjectsLocationsHyperparameterTuningJobsListRequest(_messages.Message):
628  r"""A AiplatformProjectsLocationsHyperparameterTuningJobsListRequest object.
629
630  Fields:
631    filter: The standard list filter. Supported fields: * `display_name`
632      supports = and !=. * `state` supports = and !=. Some examples of using
633      the filter are: * `state="JOB_STATE_SUCCEEDED" AND
634      display_name="my_job"` * `state="JOB_STATE_RUNNING" OR
635      display_name="my_job"` * `NOT display_name="my_job"` *
636      `state="JOB_STATE_FAILED"`
637    pageSize: The standard list page size.
638    pageToken: The standard list page token. Typically obtained via
639      ListHyperparameterTuningJobsResponse.next_page_token of the previous
640      JobService.ListHyperparameterTuningJobs call.
641    parent: Required. The resource name of the Location to list the
642      HyperparameterTuningJobs from. Format:
643      `projects/{project}/locations/{location}`
644    readMask: Mask specifying which fields to read.
645  """
646
647  filter = _messages.StringField(1)
648  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
649  pageToken = _messages.StringField(3)
650  parent = _messages.StringField(4, required=True)
651  readMask = _messages.StringField(5)
652
653
654class AiplatformProjectsLocationsMigratableResourcesBatchMigrateRequest(_messages.Message):
655  r"""A AiplatformProjectsLocationsMigratableResourcesBatchMigrateRequest
656  object.
657
658  Fields:
659    googleCloudAiplatformV1BatchMigrateResourcesRequest: A
660      GoogleCloudAiplatformV1BatchMigrateResourcesRequest resource to be
661      passed as the request body.
662    parent: Required. The location of the migrated resource will live in.
663      Format: `projects/{project}/locations/{location}`
664  """
665
666  googleCloudAiplatformV1BatchMigrateResourcesRequest = _messages.MessageField('GoogleCloudAiplatformV1BatchMigrateResourcesRequest', 1)
667  parent = _messages.StringField(2, required=True)
668
669
670class AiplatformProjectsLocationsMigratableResourcesSearchRequest(_messages.Message):
671  r"""A AiplatformProjectsLocationsMigratableResourcesSearchRequest object.
672
673  Fields:
674    googleCloudAiplatformV1SearchMigratableResourcesRequest: A
675      GoogleCloudAiplatformV1SearchMigratableResourcesRequest resource to be
676      passed as the request body.
677    parent: Required. The location that the migratable resources should be
678      searched from. It's the AI Platform location that the resources can be
679      migrated to, not the resources' original location. Format:
680      `projects/{project}/locations/{location}`
681  """
682
683  googleCloudAiplatformV1SearchMigratableResourcesRequest = _messages.MessageField('GoogleCloudAiplatformV1SearchMigratableResourcesRequest', 1)
684  parent = _messages.StringField(2, required=True)
685
686
687class AiplatformProjectsLocationsModelsDeleteRequest(_messages.Message):
688  r"""A AiplatformProjectsLocationsModelsDeleteRequest object.
689
690  Fields:
691    name: Required. The name of the Model resource to be deleted. Format:
692      `projects/{project}/locations/{location}/models/{model}`
693  """
694
695  name = _messages.StringField(1, required=True)
696
697
698class AiplatformProjectsLocationsModelsEvaluationsGetRequest(_messages.Message):
699  r"""A AiplatformProjectsLocationsModelsEvaluationsGetRequest object.
700
701  Fields:
702    name: Required. The name of the ModelEvaluation resource. Format: `project
703      s/{project}/locations/{location}/models/{model}/evaluations/{evaluation}
704      `
705  """
706
707  name = _messages.StringField(1, required=True)
708
709
710class AiplatformProjectsLocationsModelsEvaluationsListRequest(_messages.Message):
711  r"""A AiplatformProjectsLocationsModelsEvaluationsListRequest object.
712
713  Fields:
714    filter: The standard list filter.
715    pageSize: The standard list page size.
716    pageToken: The standard list page token. Typically obtained via
717      ListModelEvaluationsResponse.next_page_token of the previous
718      ModelService.ListModelEvaluations call.
719    parent: Required. The resource name of the Model to list the
720      ModelEvaluations from. Format:
721      `projects/{project}/locations/{location}/models/{model}`
722    readMask: Mask specifying which fields to read.
723  """
724
725  filter = _messages.StringField(1)
726  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
727  pageToken = _messages.StringField(3)
728  parent = _messages.StringField(4, required=True)
729  readMask = _messages.StringField(5)
730
731
732class AiplatformProjectsLocationsModelsEvaluationsSlicesGetRequest(_messages.Message):
733  r"""A AiplatformProjectsLocationsModelsEvaluationsSlicesGetRequest object.
734
735  Fields:
736    name: Required. The name of the ModelEvaluationSlice resource. Format: `pr
737      ojects/{project}/locations/{location}/models/{model}/evaluations/{evalua
738      tion}/slices/{slice}`
739  """
740
741  name = _messages.StringField(1, required=True)
742
743
744class AiplatformProjectsLocationsModelsEvaluationsSlicesListRequest(_messages.Message):
745  r"""A AiplatformProjectsLocationsModelsEvaluationsSlicesListRequest object.
746
747  Fields:
748    filter: The standard list filter. * `slice.dimension` - for =.
749    pageSize: The standard list page size.
750    pageToken: The standard list page token. Typically obtained via
751      ListModelEvaluationSlicesResponse.next_page_token of the previous
752      ModelService.ListModelEvaluationSlices call.
753    parent: Required. The resource name of the ModelEvaluation to list the
754      ModelEvaluationSlices from. Format: `projects/{project}/locations/{locat
755      ion}/models/{model}/evaluations/{evaluation}`
756    readMask: Mask specifying which fields to read.
757  """
758
759  filter = _messages.StringField(1)
760  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
761  pageToken = _messages.StringField(3)
762  parent = _messages.StringField(4, required=True)
763  readMask = _messages.StringField(5)
764
765
766class AiplatformProjectsLocationsModelsExportRequest(_messages.Message):
767  r"""A AiplatformProjectsLocationsModelsExportRequest object.
768
769  Fields:
770    googleCloudAiplatformV1ExportModelRequest: A
771      GoogleCloudAiplatformV1ExportModelRequest resource to be passed as the
772      request body.
773    name: Required. The resource name of the Model to export. Format:
774      `projects/{project}/locations/{location}/models/{model}`
775  """
776
777  googleCloudAiplatformV1ExportModelRequest = _messages.MessageField('GoogleCloudAiplatformV1ExportModelRequest', 1)
778  name = _messages.StringField(2, required=True)
779
780
781class AiplatformProjectsLocationsModelsGetRequest(_messages.Message):
782  r"""A AiplatformProjectsLocationsModelsGetRequest object.
783
784  Fields:
785    name: Required. The name of the Model resource. Format:
786      `projects/{project}/locations/{location}/models/{model}`
787  """
788
789  name = _messages.StringField(1, required=True)
790
791
792class AiplatformProjectsLocationsModelsListRequest(_messages.Message):
793  r"""A AiplatformProjectsLocationsModelsListRequest object.
794
795  Fields:
796    filter: An expression for filtering the results of the request. For field
797      names both snake_case and camelCase are supported. * `model` supports =
798      and !=. `model` represents the Model ID, i.e. the last segment of the
799      Model's resource name. * `display_name` supports = and != * `labels`
800      supports general map functions that is: * `labels.key=value` - key:value
801      equality * `labels.key:* or labels:key - key existence * A key including
802      a space must be quoted. `labels."a key"`. Some examples: * `model=1234`
803      * `displayName="myDisplayName"` * `labels.myKey="myValue"`
804    orderBy: A comma-separated list of fields to order by, sorted in ascending
805      order. Use "desc" after a field name for descending. Supported fields: *
806      `display_name` * `create_time` * `update_time` Example: `display_name,
807      create_time desc`.
808    pageSize: The standard list page size.
809    pageToken: The standard list page token. Typically obtained via
810      ListModelsResponse.next_page_token of the previous
811      ModelService.ListModels call.
812    parent: Required. The resource name of the Location to list the Models
813      from. Format: `projects/{project}/locations/{location}`
814    readMask: Mask specifying which fields to read.
815  """
816
817  filter = _messages.StringField(1)
818  orderBy = _messages.StringField(2)
819  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
820  pageToken = _messages.StringField(4)
821  parent = _messages.StringField(5, required=True)
822  readMask = _messages.StringField(6)
823
824
825class AiplatformProjectsLocationsModelsPatchRequest(_messages.Message):
826  r"""A AiplatformProjectsLocationsModelsPatchRequest object.
827
828  Fields:
829    googleCloudAiplatformV1Model: A GoogleCloudAiplatformV1Model resource to
830      be passed as the request body.
831    name: The resource name of the Model.
832    updateMask: Required. The update mask applies to the resource. For the
833      `FieldMask` definition, see
834      [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask).
835  """
836
837  googleCloudAiplatformV1Model = _messages.MessageField('GoogleCloudAiplatformV1Model', 1)
838  name = _messages.StringField(2, required=True)
839  updateMask = _messages.StringField(3)
840
841
842class AiplatformProjectsLocationsModelsUploadRequest(_messages.Message):
843  r"""A AiplatformProjectsLocationsModelsUploadRequest object.
844
845  Fields:
846    googleCloudAiplatformV1UploadModelRequest: A
847      GoogleCloudAiplatformV1UploadModelRequest resource to be passed as the
848      request body.
849    parent: Required. The resource name of the Location into which to upload
850      the Model. Format: `projects/{project}/locations/{location}`
851  """
852
853  googleCloudAiplatformV1UploadModelRequest = _messages.MessageField('GoogleCloudAiplatformV1UploadModelRequest', 1)
854  parent = _messages.StringField(2, required=True)
855
856
857class AiplatformProjectsLocationsOperationsCancelRequest(_messages.Message):
858  r"""A AiplatformProjectsLocationsOperationsCancelRequest object.
859
860  Fields:
861    name: The name of the operation resource to be cancelled.
862  """
863
864  name = _messages.StringField(1, required=True)
865
866
867class AiplatformProjectsLocationsOperationsDeleteRequest(_messages.Message):
868  r"""A AiplatformProjectsLocationsOperationsDeleteRequest object.
869
870  Fields:
871    name: The name of the operation resource to be deleted.
872  """
873
874  name = _messages.StringField(1, required=True)
875
876
877class AiplatformProjectsLocationsOperationsGetRequest(_messages.Message):
878  r"""A AiplatformProjectsLocationsOperationsGetRequest object.
879
880  Fields:
881    name: The name of the operation resource.
882  """
883
884  name = _messages.StringField(1, required=True)
885
886
887class AiplatformProjectsLocationsOperationsListRequest(_messages.Message):
888  r"""A AiplatformProjectsLocationsOperationsListRequest object.
889
890  Fields:
891    filter: The standard list filter.
892    name: The name of the operation's parent resource.
893    pageSize: The standard list page size.
894    pageToken: The standard list page token.
895  """
896
897  filter = _messages.StringField(1)
898  name = _messages.StringField(2, required=True)
899  pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32)
900  pageToken = _messages.StringField(4)
901
902
903class AiplatformProjectsLocationsOperationsWaitRequest(_messages.Message):
904  r"""A AiplatformProjectsLocationsOperationsWaitRequest object.
905
906  Fields:
907    name: The name of the operation resource to wait on.
908    timeout: The maximum duration to wait before timing out. If left blank,
909      the wait will be at most the time permitted by the underlying HTTP/RPC
910      protocol. If RPC context deadline is also specified, the shorter one
911      will be used.
912  """
913
914  name = _messages.StringField(1, required=True)
915  timeout = _messages.StringField(2)
916
917
918class AiplatformProjectsLocationsSpecialistPoolsCreateRequest(_messages.Message):
919  r"""A AiplatformProjectsLocationsSpecialistPoolsCreateRequest object.
920
921  Fields:
922    googleCloudAiplatformV1SpecialistPool: A
923      GoogleCloudAiplatformV1SpecialistPool resource to be passed as the
924      request body.
925    parent: Required. The parent Project name for the new SpecialistPool. The
926      form is `projects/{project}/locations/{location}`.
927  """
928
929  googleCloudAiplatformV1SpecialistPool = _messages.MessageField('GoogleCloudAiplatformV1SpecialistPool', 1)
930  parent = _messages.StringField(2, required=True)
931
932
933class AiplatformProjectsLocationsSpecialistPoolsDeleteRequest(_messages.Message):
934  r"""A AiplatformProjectsLocationsSpecialistPoolsDeleteRequest object.
935
936  Fields:
937    force: If set to true, any specialist managers in this SpecialistPool will
938      also be deleted. (Otherwise, the request will only work if the
939      SpecialistPool has no specialist managers.)
940    name: Required. The resource name of the SpecialistPool to delete. Format:
941      `projects/{project}/locations/{location}/specialistPools/{specialist_poo
942      l}`
943  """
944
945  force = _messages.BooleanField(1)
946  name = _messages.StringField(2, required=True)
947
948
949class AiplatformProjectsLocationsSpecialistPoolsGetRequest(_messages.Message):
950  r"""A AiplatformProjectsLocationsSpecialistPoolsGetRequest object.
951
952  Fields:
953    name: Required. The name of the SpecialistPool resource. The form is `proj
954      ects/{project}/locations/{location}/specialistPools/{specialist_pool}`.
955  """
956
957  name = _messages.StringField(1, required=True)
958
959
960class AiplatformProjectsLocationsSpecialistPoolsListRequest(_messages.Message):
961  r"""A AiplatformProjectsLocationsSpecialistPoolsListRequest object.
962
963  Fields:
964    pageSize: The standard list page size.
965    pageToken: The standard list page token. Typically obtained by
966      ListSpecialistPoolsResponse.next_page_token of the previous
967      SpecialistPoolService.ListSpecialistPools call. Return first page if
968      empty.
969    parent: Required. The name of the SpecialistPool's parent resource.
970      Format: `projects/{project}/locations/{location}`
971    readMask: Mask specifying which fields to read. FieldMask represents a set
972      of
973  """
974
975  pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
976  pageToken = _messages.StringField(2)
977  parent = _messages.StringField(3, required=True)
978  readMask = _messages.StringField(4)
979
980
981class AiplatformProjectsLocationsSpecialistPoolsPatchRequest(_messages.Message):
982  r"""A AiplatformProjectsLocationsSpecialistPoolsPatchRequest object.
983
984  Fields:
985    googleCloudAiplatformV1SpecialistPool: A
986      GoogleCloudAiplatformV1SpecialistPool resource to be passed as the
987      request body.
988    name: Required. The resource name of the SpecialistPool.
989    updateMask: Required. The update mask applies to the resource.
990  """
991
992  googleCloudAiplatformV1SpecialistPool = _messages.MessageField('GoogleCloudAiplatformV1SpecialistPool', 1)
993  name = _messages.StringField(2, required=True)
994  updateMask = _messages.StringField(3)
995
996
997class AiplatformProjectsLocationsTrainingPipelinesCancelRequest(_messages.Message):
998  r"""A AiplatformProjectsLocationsTrainingPipelinesCancelRequest object.
999
1000  Fields:
1001    googleCloudAiplatformV1CancelTrainingPipelineRequest: A
1002      GoogleCloudAiplatformV1CancelTrainingPipelineRequest resource to be
1003      passed as the request body.
1004    name: Required. The name of the TrainingPipeline to cancel. Format: `proje
1005      cts/{project}/locations/{location}/trainingPipelines/{training_pipeline}
1006      `
1007  """
1008
1009  googleCloudAiplatformV1CancelTrainingPipelineRequest = _messages.MessageField('GoogleCloudAiplatformV1CancelTrainingPipelineRequest', 1)
1010  name = _messages.StringField(2, required=True)
1011
1012
1013class AiplatformProjectsLocationsTrainingPipelinesCreateRequest(_messages.Message):
1014  r"""A AiplatformProjectsLocationsTrainingPipelinesCreateRequest object.
1015
1016  Fields:
1017    googleCloudAiplatformV1TrainingPipeline: A
1018      GoogleCloudAiplatformV1TrainingPipeline resource to be passed as the
1019      request body.
1020    parent: Required. The resource name of the Location to create the
1021      TrainingPipeline in. Format: `projects/{project}/locations/{location}`
1022  """
1023
1024  googleCloudAiplatformV1TrainingPipeline = _messages.MessageField('GoogleCloudAiplatformV1TrainingPipeline', 1)
1025  parent = _messages.StringField(2, required=True)
1026
1027
1028class AiplatformProjectsLocationsTrainingPipelinesDeleteRequest(_messages.Message):
1029  r"""A AiplatformProjectsLocationsTrainingPipelinesDeleteRequest object.
1030
1031  Fields:
1032    name: Required. The name of the TrainingPipeline resource to be deleted.
1033      Format: `projects/{project}/locations/{location}/trainingPipelines/{trai
1034      ning_pipeline}`
1035  """
1036
1037  name = _messages.StringField(1, required=True)
1038
1039
1040class AiplatformProjectsLocationsTrainingPipelinesGetRequest(_messages.Message):
1041  r"""A AiplatformProjectsLocationsTrainingPipelinesGetRequest object.
1042
1043  Fields:
1044    name: Required. The name of the TrainingPipeline resource. Format: `projec
1045      ts/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
1046  """
1047
1048  name = _messages.StringField(1, required=True)
1049
1050
1051class AiplatformProjectsLocationsTrainingPipelinesListRequest(_messages.Message):
1052  r"""A AiplatformProjectsLocationsTrainingPipelinesListRequest object.
1053
1054  Fields:
1055    filter: The standard list filter. Supported fields: * `display_name`
1056      supports = and !=. * `state` supports = and !=. Some examples of using
1057      the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND
1058      display_name="my_pipeline"` * `state="PIPELINE_STATE_RUNNING" OR
1059      display_name="my_pipeline"` * `NOT display_name="my_pipeline"` *
1060      `state="PIPELINE_STATE_FAILED"`
1061    pageSize: The standard list page size.
1062    pageToken: The standard list page token. Typically obtained via
1063      ListTrainingPipelinesResponse.next_page_token of the previous
1064      PipelineService.ListTrainingPipelines call.
1065    parent: Required. The resource name of the Location to list the
1066      TrainingPipelines from. Format:
1067      `projects/{project}/locations/{location}`
1068    readMask: Mask specifying which fields to read.
1069  """
1070
1071  filter = _messages.StringField(1)
1072  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
1073  pageToken = _messages.StringField(3)
1074  parent = _messages.StringField(4, required=True)
1075  readMask = _messages.StringField(5)
1076
1077
1078class GoogleCloudAiplatformV1ActiveLearningConfig(_messages.Message):
1079  r"""Parameters that configure the active learning pipeline. Active learning
1080  will label the data incrementally by several iterations. For every
1081  iteration, it will select a batch of data based on the sampling strategy.
1082
1083  Fields:
1084    maxDataItemCount: Max number of human labeled DataItems.
1085    maxDataItemPercentage: Max percent of total DataItems for human labeling.
1086    sampleConfig: Active learning data sampling config. For every active
1087      learning labeling iteration, it will select a batch of data based on the
1088      sampling strategy.
1089    trainingConfig: CMLE training config. For every active learning labeling
1090      iteration, system will train a machine learning model on CMLE. The
1091      trained model will be used by data sampling algorithm to select
1092      DataItems.
1093  """
1094
1095  maxDataItemCount = _messages.IntegerField(1)
1096  maxDataItemPercentage = _messages.IntegerField(2, variant=_messages.Variant.INT32)
1097  sampleConfig = _messages.MessageField('GoogleCloudAiplatformV1SampleConfig', 3)
1098  trainingConfig = _messages.MessageField('GoogleCloudAiplatformV1TrainingConfig', 4)
1099
1100
1101class GoogleCloudAiplatformV1Annotation(_messages.Message):
1102  r"""Used to assign specific AnnotationSpec to a particular area of a
1103  DataItem or the whole part of the DataItem.
1104
1105  Messages:
1106    LabelsValue: Optional. The labels with user-defined metadata to organize
1107      your Annotations. Label keys and values can be no longer than 64
1108      characters (Unicode codepoints), can only contain lowercase letters,
1109      numeric characters, underscores and dashes. International characters are
1110      allowed. No more than 64 user labels can be associated with one
1111      Annotation(System labels are excluded). See https://goo.gl/xmQnxf for
1112      more information and examples of labels. System reserved label keys are
1113      prefixed with "aiplatform.googleapis.com/" and are immutable. Following
1114      system labels exist for each Annotation: *
1115      "aiplatform.googleapis.com/annotation_set_name": optional, name of the
1116      UI's annotation set this Annotation belongs to. If not set, the
1117      Annotation is not visible in the UI. *
1118      "aiplatform.googleapis.com/payload_schema": output only, its value is
1119      the payload_schema's title.
1120
1121  Fields:
1122    annotationSource: Output only. The source of the Annotation.
1123    createTime: Output only. Timestamp when this Annotation was created.
1124    etag: Optional. Used to perform consistent read-modify-write updates. If
1125      not set, a blind "overwrite" update happens.
1126    labels: Optional. The labels with user-defined metadata to organize your
1127      Annotations. Label keys and values can be no longer than 64 characters
1128      (Unicode codepoints), can only contain lowercase letters, numeric
1129      characters, underscores and dashes. International characters are
1130      allowed. No more than 64 user labels can be associated with one
1131      Annotation(System labels are excluded). See https://goo.gl/xmQnxf for
1132      more information and examples of labels. System reserved label keys are
1133      prefixed with "aiplatform.googleapis.com/" and are immutable. Following
1134      system labels exist for each Annotation: *
1135      "aiplatform.googleapis.com/annotation_set_name": optional, name of the
1136      UI's annotation set this Annotation belongs to. If not set, the
1137      Annotation is not visible in the UI. *
1138      "aiplatform.googleapis.com/payload_schema": output only, its value is
1139      the payload_schema's title.
1140    name: Output only. Resource name of the Annotation.
1141    payload: Required. The schema of the payload can be found in
1142      payload_schema.
1143    payloadSchemaUri: Required. Google Cloud Storage URI points to a YAML file
1144      describing payload. The schema is defined as an [OpenAPI 3.0.2 Schema
1145      Object](https://tinyurl.com/y538mdwt). The schema files that can be used
1146      here are found in gs://google-cloud-
1147      aiplatform/schema/dataset/annotation/, note that the chosen schema must
1148      be consistent with the parent Dataset's metadata.
1149    updateTime: Output only. Timestamp when this Annotation was last updated.
1150  """
1151
1152  @encoding.MapUnrecognizedFields('additionalProperties')
1153  class LabelsValue(_messages.Message):
1154    r"""Optional. The labels with user-defined metadata to organize your
1155    Annotations. Label keys and values can be no longer than 64 characters
1156    (Unicode codepoints), can only contain lowercase letters, numeric
1157    characters, underscores and dashes. International characters are allowed.
1158    No more than 64 user labels can be associated with one Annotation(System
1159    labels are excluded). See https://goo.gl/xmQnxf for more information and
1160    examples of labels. System reserved label keys are prefixed with
1161    "aiplatform.googleapis.com/" and are immutable. Following system labels
1162    exist for each Annotation: *
1163    "aiplatform.googleapis.com/annotation_set_name": optional, name of the
1164    UI's annotation set this Annotation belongs to. If not set, the Annotation
1165    is not visible in the UI. * "aiplatform.googleapis.com/payload_schema":
1166    output only, its value is the payload_schema's title.
1167
1168    Messages:
1169      AdditionalProperty: An additional property for a LabelsValue object.
1170
1171    Fields:
1172      additionalProperties: Additional properties of type LabelsValue
1173    """
1174
1175    class AdditionalProperty(_messages.Message):
1176      r"""An additional property for a LabelsValue object.
1177
1178      Fields:
1179        key: Name of the additional property.
1180        value: A string attribute.
1181      """
1182
1183      key = _messages.StringField(1)
1184      value = _messages.StringField(2)
1185
1186    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
1187
1188  annotationSource = _messages.MessageField('GoogleCloudAiplatformV1UserActionReference', 1)
1189  createTime = _messages.StringField(2)
1190  etag = _messages.StringField(3)
1191  labels = _messages.MessageField('LabelsValue', 4)
1192  name = _messages.StringField(5)
1193  payload = _messages.MessageField('extra_types.JsonValue', 6)
1194  payloadSchemaUri = _messages.StringField(7)
1195  updateTime = _messages.StringField(8)
1196
1197
1198class GoogleCloudAiplatformV1AnnotationSpec(_messages.Message):
1199  r"""Identifies a concept with which DataItems may be annotated with.
1200
1201  Fields:
1202    createTime: Output only. Timestamp when this AnnotationSpec was created.
1203    displayName: Required. The user-defined name of the AnnotationSpec. The
1204      name can be up to 128 characters long and can be consist of any UTF-8
1205      characters.
1206    etag: Optional. Used to perform consistent read-modify-write updates. If
1207      not set, a blind "overwrite" update happens.
1208    name: Output only. Resource name of the AnnotationSpec.
1209    updateTime: Output only. Timestamp when AnnotationSpec was last updated.
1210  """
1211
1212  createTime = _messages.StringField(1)
1213  displayName = _messages.StringField(2)
1214  etag = _messages.StringField(3)
1215  name = _messages.StringField(4)
1216  updateTime = _messages.StringField(5)
1217
1218
1219class GoogleCloudAiplatformV1AutomaticResources(_messages.Message):
1220  r"""A description of resources that to large degree are decided by AI
1221  Platform, and require only a modest additional configuration. Each Model
1222  supporting these resources documents its specific guidelines.
1223
1224  Fields:
1225    maxReplicaCount: Immutable. The maximum number of replicas this
1226      DeployedModel may be deployed on when the traffic against it increases.
1227      If the requested value is too large, the deployment will error, but if
1228      deployment succeeds then the ability to scale the model to that many
1229      replicas is guaranteed (barring service outages). If traffic against the
1230      DeployedModel increases beyond what its replicas at maximum may handle,
1231      a portion of the traffic will be dropped. If this value is not provided,
1232      a no upper bound for scaling under heavy traffic will be assume, though
1233      AI Platform may be unable to scale beyond certain replica number.
1234    minReplicaCount: Immutable. The minimum number of replicas this
1235      DeployedModel will be always deployed on. If traffic against it
1236      increases, it may dynamically be deployed onto more replicas up to
1237      max_replica_count, and as traffic decreases, some of these extra
1238      replicas may be freed. If the requested value is too large, the
1239      deployment will error.
1240  """
1241
1242  maxReplicaCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
1243  minReplicaCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
1244
1245
1246class GoogleCloudAiplatformV1BatchDedicatedResources(_messages.Message):
1247  r"""A description of resources that are used for performing batch
1248  operations, are dedicated to a Model, and need manual configuration.
1249
1250  Fields:
1251    machineSpec: Required. Immutable. The specification of a single machine.
1252    maxReplicaCount: Immutable. The maximum number of machine replicas the
1253      batch operation may be scaled to. The default value is 10.
1254    startingReplicaCount: Immutable. The number of machine replicas used at
1255      the start of the batch operation. If not set, AI Platform decides
1256      starting number, not greater than max_replica_count
1257  """
1258
1259  machineSpec = _messages.MessageField('GoogleCloudAiplatformV1MachineSpec', 1)
1260  maxReplicaCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
1261  startingReplicaCount = _messages.IntegerField(3, variant=_messages.Variant.INT32)
1262
1263
1264class GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata(_messages.Message):
1265  r"""Runtime operation information for
1266  MigrationService.BatchMigrateResources.
1267
1268  Fields:
1269    genericMetadata: The common part of the operation metadata.
1270    partialResults: Partial results that reflect the latest migration
1271      operation progress.
1272  """
1273
1274  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
1275  partialResults = _messages.MessageField('GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult', 2, repeated=True)
1276
1277
1278class GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult(_messages.Message):
1279  r"""Represents a partial result in batch migration operation for one
1280  MigrateResourceRequest.
1281
1282  Fields:
1283    dataset: Migrated dataset resource name.
1284    error: The error result of the migration request in case of failure.
1285    model: Migrated model resource name.
1286    request: It's the same as the value in
1287      MigrateResourceRequest.migrate_resource_requests.
1288  """
1289
1290  dataset = _messages.StringField(1)
1291  error = _messages.MessageField('GoogleRpcStatus', 2)
1292  model = _messages.StringField(3)
1293  request = _messages.MessageField('GoogleCloudAiplatformV1MigrateResourceRequest', 4)
1294
1295
1296class GoogleCloudAiplatformV1BatchMigrateResourcesRequest(_messages.Message):
1297  r"""Request message for MigrationService.BatchMigrateResources.
1298
1299  Fields:
1300    migrateResourceRequests: Required. The request messages specifying the
1301      resources to migrate. They must be in the same location as the
1302      destination. Up to 50 resources can be migrated in one batch.
1303  """
1304
1305  migrateResourceRequests = _messages.MessageField('GoogleCloudAiplatformV1MigrateResourceRequest', 1, repeated=True)
1306
1307
1308class GoogleCloudAiplatformV1BatchMigrateResourcesResponse(_messages.Message):
1309  r"""Response message for MigrationService.BatchMigrateResources.
1310
1311  Fields:
1312    migrateResourceResponses: Successfully migrated resources.
1313  """
1314
1315  migrateResourceResponses = _messages.MessageField('GoogleCloudAiplatformV1MigrateResourceResponse', 1, repeated=True)
1316
1317
1318class GoogleCloudAiplatformV1BatchPredictionJob(_messages.Message):
1319  r"""A job that uses a Model to produce predictions on multiple input
1320  instances. If predictions for significant portion of the instances fail, the
1321  job may finish without attempting predictions for all remaining instances.
1322
1323  Enums:
1324    StateValueValuesEnum: Output only. The detailed state of the job.
1325
1326  Messages:
1327    LabelsValue: The labels with user-defined metadata to organize
1328      BatchPredictionJobs. Label keys and values can be no longer than 64
1329      characters (Unicode codepoints), can only contain lowercase letters,
1330      numeric characters, underscores and dashes. International characters are
1331      allowed. See https://goo.gl/xmQnxf for more information and examples of
1332      labels.
1333
1334  Fields:
1335    completionStats: Output only. Statistics on completed and failed
1336      prediction instances.
1337    createTime: Output only. Time when the BatchPredictionJob was created.
1338    dedicatedResources: The config of resources used by the Model during the
1339      batch prediction. If the Model supports DEDICATED_RESOURCES this config
1340      may be provided (and the job will use these resources), if the Model
1341      doesn't support AUTOMATIC_RESOURCES, this config must be provided.
1342    displayName: Required. The user-defined name of this BatchPredictionJob.
1343    encryptionSpec: Customer-managed encryption key options for a
1344      BatchPredictionJob. If this is set, then all resources created by the
1345      BatchPredictionJob will be encrypted with the provided encryption key.
1346    endTime: Output only. Time when the BatchPredictionJob entered any of the
1347      following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
1348      `JOB_STATE_CANCELLED`.
1349    error: Output only. Only populated when the job's state is
1350      JOB_STATE_FAILED or JOB_STATE_CANCELLED.
1351    inputConfig: Required. Input configuration of the instances on which
1352      predictions are performed. The schema of any single instance may be
1353      specified via the Model's PredictSchemata's instance_schema_uri.
1354    labels: The labels with user-defined metadata to organize
1355      BatchPredictionJobs. Label keys and values can be no longer than 64
1356      characters (Unicode codepoints), can only contain lowercase letters,
1357      numeric characters, underscores and dashes. International characters are
1358      allowed. See https://goo.gl/xmQnxf for more information and examples of
1359      labels.
1360    manualBatchTuningParameters: Immutable. Parameters configuring the batch
1361      behavior. Currently only applicable when dedicated_resources are used
1362      (in other cases AI Platform does the tuning itself).
1363    model: Required. The name of the Model that produces the predictions via
1364      this job, must share the same ancestor Location. Starting this job has
1365      no impact on any existing deployments of the Model and their resources.
1366    modelParameters: The parameters that govern the predictions. The schema of
1367      the parameters may be specified via the Model's PredictSchemata's
1368      parameters_schema_uri.
1369    name: Output only. Resource name of the BatchPredictionJob.
1370    outputConfig: Required. The Configuration specifying where output
1371      predictions should be written. The schema of any single prediction may
1372      be specified as a concatenation of Model's PredictSchemata's
1373      instance_schema_uri and prediction_schema_uri.
1374    outputInfo: Output only. Information further describing the output of this
1375      job.
1376    partialFailures: Output only. Partial failures encountered. For example,
1377      single files that can't be read. This field never exceeds 20 entries.
1378      Status details fields contain standard GCP error details.
1379    resourcesConsumed: Output only. Information about resources that had been
1380      consumed by this job. Provided in real time at best effort basis, as
1381      well as a final value once the job completes. Note: This field currently
1382      may be not populated for batch predictions that use AutoML Models.
1383    startTime: Output only. Time when the BatchPredictionJob for the first
1384      time entered the `JOB_STATE_RUNNING` state.
1385    state: Output only. The detailed state of the job.
1386    updateTime: Output only. Time when the BatchPredictionJob was most
1387      recently updated.
1388  """
1389
1390  class StateValueValuesEnum(_messages.Enum):
1391    r"""Output only. The detailed state of the job.
1392
1393    Values:
1394      JOB_STATE_UNSPECIFIED: The job state is unspecified.
1395      JOB_STATE_QUEUED: The job has been just created or resumed and
1396        processing has not yet begun.
1397      JOB_STATE_PENDING: The service is preparing to run the job.
1398      JOB_STATE_RUNNING: The job is in progress.
1399      JOB_STATE_SUCCEEDED: The job completed successfully.
1400      JOB_STATE_FAILED: The job failed.
1401      JOB_STATE_CANCELLING: The job is being cancelled. From this state the
1402        job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or
1403        `JOB_STATE_CANCELLED`.
1404      JOB_STATE_CANCELLED: The job has been cancelled.
1405      JOB_STATE_PAUSED: The job has been stopped, and can be resumed.
1406    """
1407    JOB_STATE_UNSPECIFIED = 0
1408    JOB_STATE_QUEUED = 1
1409    JOB_STATE_PENDING = 2
1410    JOB_STATE_RUNNING = 3
1411    JOB_STATE_SUCCEEDED = 4
1412    JOB_STATE_FAILED = 5
1413    JOB_STATE_CANCELLING = 6
1414    JOB_STATE_CANCELLED = 7
1415    JOB_STATE_PAUSED = 8
1416
1417  @encoding.MapUnrecognizedFields('additionalProperties')
1418  class LabelsValue(_messages.Message):
1419    r"""The labels with user-defined metadata to organize BatchPredictionJobs.
1420    Label keys and values can be no longer than 64 characters (Unicode
1421    codepoints), can only contain lowercase letters, numeric characters,
1422    underscores and dashes. International characters are allowed. See
1423    https://goo.gl/xmQnxf for more information and examples of labels.
1424
1425    Messages:
1426      AdditionalProperty: An additional property for a LabelsValue object.
1427
1428    Fields:
1429      additionalProperties: Additional properties of type LabelsValue
1430    """
1431
1432    class AdditionalProperty(_messages.Message):
1433      r"""An additional property for a LabelsValue object.
1434
1435      Fields:
1436        key: Name of the additional property.
1437        value: A string attribute.
1438      """
1439
1440      key = _messages.StringField(1)
1441      value = _messages.StringField(2)
1442
1443    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
1444
1445  completionStats = _messages.MessageField('GoogleCloudAiplatformV1CompletionStats', 1)
1446  createTime = _messages.StringField(2)
1447  dedicatedResources = _messages.MessageField('GoogleCloudAiplatformV1BatchDedicatedResources', 3)
1448  displayName = _messages.StringField(4)
1449  encryptionSpec = _messages.MessageField('GoogleCloudAiplatformV1EncryptionSpec', 5)
1450  endTime = _messages.StringField(6)
1451  error = _messages.MessageField('GoogleRpcStatus', 7)
1452  inputConfig = _messages.MessageField('GoogleCloudAiplatformV1BatchPredictionJobInputConfig', 8)
1453  labels = _messages.MessageField('LabelsValue', 9)
1454  manualBatchTuningParameters = _messages.MessageField('GoogleCloudAiplatformV1ManualBatchTuningParameters', 10)
1455  model = _messages.StringField(11)
1456  modelParameters = _messages.MessageField('extra_types.JsonValue', 12)
1457  name = _messages.StringField(13)
1458  outputConfig = _messages.MessageField('GoogleCloudAiplatformV1BatchPredictionJobOutputConfig', 14)
1459  outputInfo = _messages.MessageField('GoogleCloudAiplatformV1BatchPredictionJobOutputInfo', 15)
1460  partialFailures = _messages.MessageField('GoogleRpcStatus', 16, repeated=True)
1461  resourcesConsumed = _messages.MessageField('GoogleCloudAiplatformV1ResourcesConsumed', 17)
1462  startTime = _messages.StringField(18)
1463  state = _messages.EnumField('StateValueValuesEnum', 19)
1464  updateTime = _messages.StringField(20)
1465
1466
1467class GoogleCloudAiplatformV1BatchPredictionJobInputConfig(_messages.Message):
1468  r"""Configures the input to BatchPredictionJob. See
1469  Model.supported_input_storage_formats for Model's supported input formats,
1470  and how instances should be expressed via any of them.
1471
1472  Fields:
1473    bigquerySource: The BigQuery location of the input table. The schema of
1474      the table should be in the format described by the given context OpenAPI
1475      Schema, if one is provided. The table may contain additional columns
1476      that are not described by the schema, and they will be ignored.
1477    gcsSource: The Cloud Storage location for the input instances.
1478    instancesFormat: Required. The format in which instances are given, must
1479      be one of the Model's supported_input_storage_formats.
1480  """
1481
1482  bigquerySource = _messages.MessageField('GoogleCloudAiplatformV1BigQuerySource', 1)
1483  gcsSource = _messages.MessageField('GoogleCloudAiplatformV1GcsSource', 2)
1484  instancesFormat = _messages.StringField(3)
1485
1486
1487class GoogleCloudAiplatformV1BatchPredictionJobOutputConfig(_messages.Message):
1488  r"""Configures the output of BatchPredictionJob. See
1489  Model.supported_output_storage_formats for supported output formats, and how
1490  predictions are expressed via any of them.
1491
1492  Fields:
1493    bigqueryDestination: The BigQuery project location where the output is to
1494      be written to. In the given project a new dataset is created with name
1495      `prediction__` where is made BigQuery-dataset-name compatible (for
1496      example, most special characters become underscores), and timestamp is
1497      in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset
1498      two tables will be created, `predictions`, and `errors`. If the Model
1499      has both instance and prediction schemata defined then the tables have
1500      columns as follows: The `predictions` table contains instances for which
1501      the prediction succeeded, it has columns as per a concatenation of the
1502      Model's instance and prediction schemata. The `errors` table contains
1503      rows for which the prediction has failed, it has instance columns, as
1504      per the instance schema, followed by a single "errors" column, which as
1505      values has [`google.rpc.Status`](Status) represented as a STRUCT, and
1506      containing only `code` and `message`.
1507    gcsDestination: The Cloud Storage location of the directory where the
1508      output is to be written to. In the given directory a new directory is
1509      created. Its name is `prediction--`, where timestamp is in YYYY-MM-
1510      DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files
1511      `predictions_0001.`, `predictions_0002.`, ..., `predictions_N.` are
1512      created where `` depends on chosen predictions_format, and N may equal
1513      0001 and depends on the total number of successfully predicted
1514      instances. If the Model has both instance and prediction schemata
1515      defined then each such file contains predictions as per the
1516      predictions_format. If prediction for any instance failed (partially or
1517      completely), then an additional `errors_0001.`, `errors_0002.`,...,
1518      `errors_N.` files are created (N depends on total number of failed
1519      predictions). These files contain the failed instances, as per their
1520      schema, followed by an additional `error` field which as value has
1521      [`google.rpc.Status`](Status) containing only `code` and `message`
1522      fields.
1523    predictionsFormat: Required. The format in which AI Platform gives the
1524      predictions, must be one of the Model's
1525      supported_output_storage_formats.
1526  """
1527
1528  bigqueryDestination = _messages.MessageField('GoogleCloudAiplatformV1BigQueryDestination', 1)
1529  gcsDestination = _messages.MessageField('GoogleCloudAiplatformV1GcsDestination', 2)
1530  predictionsFormat = _messages.StringField(3)
1531
1532
1533class GoogleCloudAiplatformV1BatchPredictionJobOutputInfo(_messages.Message):
1534  r"""Further describes this job's output. Supplements output_config.
1535
1536  Fields:
1537    bigqueryOutputDataset: Output only. The path of the BigQuery dataset
1538      created, in `bq://projectId.bqDatasetId` format, into which the
1539      prediction output is written.
1540    gcsOutputDirectory: Output only. The full path of the Cloud Storage
1541      directory created, into which the prediction output is written.
1542  """
1543
1544  bigqueryOutputDataset = _messages.StringField(1)
1545  gcsOutputDirectory = _messages.StringField(2)
1546
1547
1548class GoogleCloudAiplatformV1BigQueryDestination(_messages.Message):
1549  r"""The BigQuery location for the output content.
1550
1551  Fields:
1552    outputUri: Required. BigQuery URI to a project or table, up to 2000
1553      characters long. When only the project is specified, the Dataset and
1554      Table is created. When the full table reference is specified, the
1555      Dataset must exist and table must not exist. Accepted forms: * BigQuery
1556      path. For example: `bq://projectId` or
1557      `bq://projectId.bqDatasetId.bqTableId`.
1558  """
1559
1560  outputUri = _messages.StringField(1)
1561
1562
1563class GoogleCloudAiplatformV1BigQuerySource(_messages.Message):
1564  r"""The BigQuery location for the input content.
1565
1566  Fields:
1567    inputUri: Required. BigQuery URI to a table, up to 2000 characters long.
1568      Accepted forms: * BigQuery path. For example:
1569      `bq://projectId.bqDatasetId.bqTableId`.
1570  """
1571
1572  inputUri = _messages.StringField(1)
1573
1574
1575class GoogleCloudAiplatformV1CancelBatchPredictionJobRequest(_messages.Message):
1576  r"""Request message for JobService.CancelBatchPredictionJob."""
1577
1578
1579class GoogleCloudAiplatformV1CancelCustomJobRequest(_messages.Message):
1580  r"""Request message for JobService.CancelCustomJob."""
1581
1582
1583class GoogleCloudAiplatformV1CancelDataLabelingJobRequest(_messages.Message):
1584  r"""Request message for DataLabelingJobService.CancelDataLabelingJob."""
1585
1586
1587class GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest(_messages.Message):
1588  r"""Request message for JobService.CancelHyperparameterTuningJob."""
1589
1590
1591class GoogleCloudAiplatformV1CancelTrainingPipelineRequest(_messages.Message):
1592  r"""Request message for PipelineService.CancelTrainingPipeline."""
1593
1594
1595class GoogleCloudAiplatformV1CompletionStats(_messages.Message):
1596  r"""Success and error statistics of processing multiple entities (for
1597  example, DataItems or structured data rows) in batch.
1598
1599  Fields:
1600    failedCount: Output only. The number of entities for which any error was
1601      encountered.
1602    incompleteCount: Output only. In cases when enough errors are encountered
1603      a job, pipeline, or operation may be failed as a whole. Below is the
1604      number of entities for which the processing had not been finished
1605      (either in successful or failed state). Set to -1 if the number is
1606      unknown (for example, the operation failed before the total entity
1607      number could be collected).
1608    successfulCount: Output only. The number of entities that had been
1609      processed successfully.
1610  """
1611
1612  failedCount = _messages.IntegerField(1)
1613  incompleteCount = _messages.IntegerField(2)
1614  successfulCount = _messages.IntegerField(3)
1615
1616
1617class GoogleCloudAiplatformV1ContainerRegistryDestination(_messages.Message):
1618  r"""The Container Registry location for the container image.
1619
1620  Fields:
1621    outputUri: Required. Container Registry URI of a container image. Only
1622      Google Container Registry and Artifact Registry are supported now.
1623      Accepted forms: * Google Container Registry path. For example:
1624      `gcr.io/projectId/imageName:tag`. * Artifact Registry path. For example:
1625      `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`. If a tag
1626      is not specified, "latest" will be used as the default tag.
1627  """
1628
1629  outputUri = _messages.StringField(1)
1630
1631
1632class GoogleCloudAiplatformV1ContainerSpec(_messages.Message):
1633  r"""The spec of a Container.
1634
1635  Fields:
1636    args: The arguments to be passed when starting the container.
1637    command: The command to be invoked when the container is started. It
1638      overrides the entrypoint instruction in Dockerfile when provided.
1639    env: Environment variables to be passed to the container.
1640    imageUri: Required. The URI of a container image in the Container Registry
1641      that is to be run on each worker replica.
1642  """
1643
1644  args = _messages.StringField(1, repeated=True)
1645  command = _messages.StringField(2, repeated=True)
1646  env = _messages.MessageField('GoogleCloudAiplatformV1EnvVar', 3, repeated=True)
1647  imageUri = _messages.StringField(4)
1648
1649
1650class GoogleCloudAiplatformV1CreateDatasetOperationMetadata(_messages.Message):
1651  r"""Runtime operation information for DatasetService.CreateDataset.
1652
1653  Fields:
1654    genericMetadata: The operation generic information.
1655  """
1656
1657  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
1658
1659
1660class GoogleCloudAiplatformV1CreateEndpointOperationMetadata(_messages.Message):
1661  r"""Runtime operation information for EndpointService.CreateEndpoint.
1662
1663  Fields:
1664    genericMetadata: The operation generic information.
1665  """
1666
1667  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
1668
1669
1670class GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata(_messages.Message):
1671  r"""Runtime operation information for
1672  SpecialistPoolService.CreateSpecialistPool.
1673
1674  Fields:
1675    genericMetadata: The operation generic information.
1676  """
1677
1678  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
1679
1680
1681class GoogleCloudAiplatformV1CustomJob(_messages.Message):
1682  r"""Represents a job that runs custom workloads such as a Docker container
1683  or a Python package. A CustomJob can have multiple worker pools and each
1684  worker pool can have its own machine and input spec. A CustomJob will be
1685  cleaned up once the job enters terminal state (failed or succeeded).
1686
1687  Enums:
1688    StateValueValuesEnum: Output only. The detailed state of the job.
1689
1690  Messages:
1691    LabelsValue: The labels with user-defined metadata to organize CustomJobs.
1692      Label keys and values can be no longer than 64 characters (Unicode
1693      codepoints), can only contain lowercase letters, numeric characters,
1694      underscores and dashes. International characters are allowed. See
1695      https://goo.gl/xmQnxf for more information and examples of labels.
1696
1697  Fields:
1698    createTime: Output only. Time when the CustomJob was created.
1699    displayName: Required. The display name of the CustomJob. The name can be
1700      up to 128 characters long and can be consist of any UTF-8 characters.
1701    encryptionSpec: Customer-managed encryption key options for a CustomJob.
1702      If this is set, then all resources created by the CustomJob will be
1703      encrypted with the provided encryption key.
1704    endTime: Output only. Time when the CustomJob entered any of the following
1705      states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
1706      `JOB_STATE_CANCELLED`.
1707    error: Output only. Only populated when job's state is `JOB_STATE_FAILED`
1708      or `JOB_STATE_CANCELLED`.
1709    jobSpec: Required. Job spec.
1710    labels: The labels with user-defined metadata to organize CustomJobs.
1711      Label keys and values can be no longer than 64 characters (Unicode
1712      codepoints), can only contain lowercase letters, numeric characters,
1713      underscores and dashes. International characters are allowed. See
1714      https://goo.gl/xmQnxf for more information and examples of labels.
1715    name: Output only. Resource name of a CustomJob.
1716    startTime: Output only. Time when the CustomJob for the first time entered
1717      the `JOB_STATE_RUNNING` state.
1718    state: Output only. The detailed state of the job.
1719    updateTime: Output only. Time when the CustomJob was most recently
1720      updated.
1721  """
1722
1723  class StateValueValuesEnum(_messages.Enum):
1724    r"""Output only. The detailed state of the job.
1725
1726    Values:
1727      JOB_STATE_UNSPECIFIED: The job state is unspecified.
1728      JOB_STATE_QUEUED: The job has been just created or resumed and
1729        processing has not yet begun.
1730      JOB_STATE_PENDING: The service is preparing to run the job.
1731      JOB_STATE_RUNNING: The job is in progress.
1732      JOB_STATE_SUCCEEDED: The job completed successfully.
1733      JOB_STATE_FAILED: The job failed.
1734      JOB_STATE_CANCELLING: The job is being cancelled. From this state the
1735        job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or
1736        `JOB_STATE_CANCELLED`.
1737      JOB_STATE_CANCELLED: The job has been cancelled.
1738      JOB_STATE_PAUSED: The job has been stopped, and can be resumed.
1739    """
1740    JOB_STATE_UNSPECIFIED = 0
1741    JOB_STATE_QUEUED = 1
1742    JOB_STATE_PENDING = 2
1743    JOB_STATE_RUNNING = 3
1744    JOB_STATE_SUCCEEDED = 4
1745    JOB_STATE_FAILED = 5
1746    JOB_STATE_CANCELLING = 6
1747    JOB_STATE_CANCELLED = 7
1748    JOB_STATE_PAUSED = 8
1749
1750  @encoding.MapUnrecognizedFields('additionalProperties')
1751  class LabelsValue(_messages.Message):
1752    r"""The labels with user-defined metadata to organize CustomJobs. Label
1753    keys and values can be no longer than 64 characters (Unicode codepoints),
1754    can only contain lowercase letters, numeric characters, underscores and
1755    dashes. International characters are allowed. See https://goo.gl/xmQnxf
1756    for more information and examples of labels.
1757
1758    Messages:
1759      AdditionalProperty: An additional property for a LabelsValue object.
1760
1761    Fields:
1762      additionalProperties: Additional properties of type LabelsValue
1763    """
1764
1765    class AdditionalProperty(_messages.Message):
1766      r"""An additional property for a LabelsValue object.
1767
1768      Fields:
1769        key: Name of the additional property.
1770        value: A string attribute.
1771      """
1772
1773      key = _messages.StringField(1)
1774      value = _messages.StringField(2)
1775
1776    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
1777
1778  createTime = _messages.StringField(1)
1779  displayName = _messages.StringField(2)
1780  encryptionSpec = _messages.MessageField('GoogleCloudAiplatformV1EncryptionSpec', 3)
1781  endTime = _messages.StringField(4)
1782  error = _messages.MessageField('GoogleRpcStatus', 5)
1783  jobSpec = _messages.MessageField('GoogleCloudAiplatformV1CustomJobSpec', 6)
1784  labels = _messages.MessageField('LabelsValue', 7)
1785  name = _messages.StringField(8)
1786  startTime = _messages.StringField(9)
1787  state = _messages.EnumField('StateValueValuesEnum', 10)
1788  updateTime = _messages.StringField(11)
1789
1790
1791class GoogleCloudAiplatformV1CustomJobSpec(_messages.Message):
1792  r"""Represents the spec of a CustomJob.
1793
1794  Fields:
1795    baseOutputDirectory: The Cloud Storage location to store the output of
1796      this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob,
1797      the baseOutputDirectory of each child CustomJob backing a Trial is set
1798      to a subdirectory of name id under its parent HyperparameterTuningJob's
1799      baseOutputDirectory. The following AI Platform environment variables
1800      will be passed to containers or python modules when this field is set:
1801      For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR =
1802      `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob
1803      backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/`
1804      * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR =
1805      `//logs/`
1806    network: The full name of the Compute Engine
1807      [network](/compute/docs/networks-and-firewalls#networks) to which the
1808      Job should be peered. For example,
1809      `projects/12345/global/networks/myVPC`.
1810      [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form
1811      `projects/{project}/global/networks/{network}`. Where {project} is a
1812      project number, as in `12345`, and {network} is a network name. Private
1813      services access must already be configured for the network. If left
1814      unspecified, the job is not peered with any network.
1815    scheduling: Scheduling options for a CustomJob.
1816    serviceAccount: Specifies the service account for workload run-as account.
1817      Users submitting jobs must have act-as permission on this run-as
1818      account. If unspecified, the AI Platform Custom Code Service Agent for
1819      the CustomJob's project is used.
1820    workerPoolSpecs: Required. The spec of the worker pools including machine
1821      type and Docker image. All worker pools except the first one are
1822      optional and can be skipped by providing an empty value.
1823  """
1824
1825  baseOutputDirectory = _messages.MessageField('GoogleCloudAiplatformV1GcsDestination', 1)
1826  network = _messages.StringField(2)
1827  scheduling = _messages.MessageField('GoogleCloudAiplatformV1Scheduling', 3)
1828  serviceAccount = _messages.StringField(4)
1829  workerPoolSpecs = _messages.MessageField('GoogleCloudAiplatformV1WorkerPoolSpec', 5, repeated=True)
1830
1831
1832class GoogleCloudAiplatformV1DataItem(_messages.Message):
1833  r"""A piece of data in a Dataset. Could be an image, a video, a document or
1834  plain text.
1835
1836  Messages:
1837    LabelsValue: Optional. The labels with user-defined metadata to organize
1838      your DataItems. Label keys and values can be no longer than 64
1839      characters (Unicode codepoints), can only contain lowercase letters,
1840      numeric characters, underscores and dashes. International characters are
1841      allowed. No more than 64 user labels can be associated with one
1842      DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more
1843      information and examples of labels. System reserved label keys are
1844      prefixed with "aiplatform.googleapis.com/" and are immutable.
1845
1846  Fields:
1847    createTime: Output only. Timestamp when this DataItem was created.
1848    etag: Optional. Used to perform consistent read-modify-write updates. If
1849      not set, a blind "overwrite" update happens.
1850    labels: Optional. The labels with user-defined metadata to organize your
1851      DataItems. Label keys and values can be no longer than 64 characters
1852      (Unicode codepoints), can only contain lowercase letters, numeric
1853      characters, underscores and dashes. International characters are
1854      allowed. No more than 64 user labels can be associated with one
1855      DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more
1856      information and examples of labels. System reserved label keys are
1857      prefixed with "aiplatform.googleapis.com/" and are immutable.
1858    name: Output only. The resource name of the DataItem.
1859    payload: Required. The data that the DataItem represents (for example, an
1860      image or a text snippet). The schema of the payload is stored in the
1861      parent Dataset's metadata schema's dataItemSchemaUri field.
1862    updateTime: Output only. Timestamp when this DataItem was last updated.
1863  """
1864
1865  @encoding.MapUnrecognizedFields('additionalProperties')
1866  class LabelsValue(_messages.Message):
1867    r"""Optional. The labels with user-defined metadata to organize your
1868    DataItems. Label keys and values can be no longer than 64 characters
1869    (Unicode codepoints), can only contain lowercase letters, numeric
1870    characters, underscores and dashes. International characters are allowed.
1871    No more than 64 user labels can be associated with one DataItem(System
1872    labels are excluded). See https://goo.gl/xmQnxf for more information and
1873    examples of labels. System reserved label keys are prefixed with
1874    "aiplatform.googleapis.com/" and are immutable.
1875
1876    Messages:
1877      AdditionalProperty: An additional property for a LabelsValue object.
1878
1879    Fields:
1880      additionalProperties: Additional properties of type LabelsValue
1881    """
1882
1883    class AdditionalProperty(_messages.Message):
1884      r"""An additional property for a LabelsValue object.
1885
1886      Fields:
1887        key: Name of the additional property.
1888        value: A string attribute.
1889      """
1890
1891      key = _messages.StringField(1)
1892      value = _messages.StringField(2)
1893
1894    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
1895
1896  createTime = _messages.StringField(1)
1897  etag = _messages.StringField(2)
1898  labels = _messages.MessageField('LabelsValue', 3)
1899  name = _messages.StringField(4)
1900  payload = _messages.MessageField('extra_types.JsonValue', 5)
1901  updateTime = _messages.StringField(6)
1902
1903
1904class GoogleCloudAiplatformV1DataLabelingJob(_messages.Message):
1905  r"""DataLabelingJob is used to trigger a human labeling job on unlabeled
1906  data from the following Dataset:
1907
1908  Enums:
1909    StateValueValuesEnum: Output only. The detailed state of the job.
1910
1911  Messages:
1912    AnnotationLabelsValue: Labels to assign to annotations generated by this
1913      DataLabelingJob. Label keys and values can be no longer than 64
1914      characters (Unicode codepoints), can only contain lowercase letters,
1915      numeric characters, underscores and dashes. International characters are
1916      allowed. See https://goo.gl/xmQnxf for more information and examples of
1917      labels. System reserved label keys are prefixed with
1918      "aiplatform.googleapis.com/" and are immutable.
1919    LabelsValue: The labels with user-defined metadata to organize your
1920      DataLabelingJobs. Label keys and values can be no longer than 64
1921      characters (Unicode codepoints), can only contain lowercase letters,
1922      numeric characters, underscores and dashes. International characters are
1923      allowed. See https://goo.gl/xmQnxf for more information and examples of
1924      labels. System reserved label keys are prefixed with
1925      "aiplatform.googleapis.com/" and are immutable. Following system labels
1926      exist for each DataLabelingJob: * "aiplatform.googleapis.com/schema":
1927      output only, its value is the inputs_schema's title.
1928
1929  Fields:
1930    activeLearningConfig: Parameters that configure the active learning
1931      pipeline. Active learning will label the data incrementally via several
1932      iterations. For every iteration, it will select a batch of data based on
1933      the sampling strategy.
1934    annotationLabels: Labels to assign to annotations generated by this
1935      DataLabelingJob. Label keys and values can be no longer than 64
1936      characters (Unicode codepoints), can only contain lowercase letters,
1937      numeric characters, underscores and dashes. International characters are
1938      allowed. See https://goo.gl/xmQnxf for more information and examples of
1939      labels. System reserved label keys are prefixed with
1940      "aiplatform.googleapis.com/" and are immutable.
1941    createTime: Output only. Timestamp when this DataLabelingJob was created.
1942    currentSpend: Output only. Estimated cost(in US dollars) that the
1943      DataLabelingJob has incurred to date.
1944    datasets: Required. Dataset resource names. Right now we only support
1945      labeling from a single Dataset. Format:
1946      `projects/{project}/locations/{location}/datasets/{dataset}`
1947    displayName: Required. The user-defined name of the DataLabelingJob. The
1948      name can be up to 128 characters long and can be consist of any UTF-8
1949      characters. Display name of a DataLabelingJob.
1950    encryptionSpec: Customer-managed encryption key spec for a
1951      DataLabelingJob. If set, this DataLabelingJob will be secured by this
1952      key. Note: Annotations created in the DataLabelingJob are associated
1953      with the EncryptionSpec of the Dataset they are exported to.
1954    error: Output only. DataLabelingJob errors. It is only populated when
1955      job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
1956    inputs: Required. Input config parameters for the DataLabelingJob.
1957    inputsSchemaUri: Required. Points to a YAML file stored on Google Cloud
1958      Storage describing the config for a specific type of DataLabelingJob.
1959      The schema files that can be used here are found in the
1960      https://storage.googleapis.com/google-cloud-aiplatform bucket in the
1961      /schema/datalabelingjob/inputs/ folder.
1962    instructionUri: Required. The Google Cloud Storage location of the
1963      instruction pdf. This pdf is shared with labelers, and provides detailed
1964      description on how to label DataItems in Datasets.
1965    labelerCount: Required. Number of labelers to work on each DataItem.
1966    labelingProgress: Output only. Current labeling job progress percentage
1967      scaled in interval [0, 100], indicating the percentage of DataItems that
1968      has been finished.
1969    labels: The labels with user-defined metadata to organize your
1970      DataLabelingJobs. Label keys and values can be no longer than 64
1971      characters (Unicode codepoints), can only contain lowercase letters,
1972      numeric characters, underscores and dashes. International characters are
1973      allowed. See https://goo.gl/xmQnxf for more information and examples of
1974      labels. System reserved label keys are prefixed with
1975      "aiplatform.googleapis.com/" and are immutable. Following system labels
1976      exist for each DataLabelingJob: * "aiplatform.googleapis.com/schema":
1977      output only, its value is the inputs_schema's title.
1978    name: Output only. Resource name of the DataLabelingJob.
1979    specialistPools: The SpecialistPools' resource names associated with this
1980      job.
1981    state: Output only. The detailed state of the job.
1982    updateTime: Output only. Timestamp when this DataLabelingJob was updated
1983      most recently.
1984  """
1985
1986  class StateValueValuesEnum(_messages.Enum):
1987    r"""Output only. The detailed state of the job.
1988
1989    Values:
1990      JOB_STATE_UNSPECIFIED: The job state is unspecified.
1991      JOB_STATE_QUEUED: The job has been just created or resumed and
1992        processing has not yet begun.
1993      JOB_STATE_PENDING: The service is preparing to run the job.
1994      JOB_STATE_RUNNING: The job is in progress.
1995      JOB_STATE_SUCCEEDED: The job completed successfully.
1996      JOB_STATE_FAILED: The job failed.
1997      JOB_STATE_CANCELLING: The job is being cancelled. From this state the
1998        job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or
1999        `JOB_STATE_CANCELLED`.
2000      JOB_STATE_CANCELLED: The job has been cancelled.
2001      JOB_STATE_PAUSED: The job has been stopped, and can be resumed.
2002    """
2003    JOB_STATE_UNSPECIFIED = 0
2004    JOB_STATE_QUEUED = 1
2005    JOB_STATE_PENDING = 2
2006    JOB_STATE_RUNNING = 3
2007    JOB_STATE_SUCCEEDED = 4
2008    JOB_STATE_FAILED = 5
2009    JOB_STATE_CANCELLING = 6
2010    JOB_STATE_CANCELLED = 7
2011    JOB_STATE_PAUSED = 8
2012
2013  @encoding.MapUnrecognizedFields('additionalProperties')
2014  class AnnotationLabelsValue(_messages.Message):
2015    r"""Labels to assign to annotations generated by this DataLabelingJob.
2016    Label keys and values can be no longer than 64 characters (Unicode
2017    codepoints), can only contain lowercase letters, numeric characters,
2018    underscores and dashes. International characters are allowed. See
2019    https://goo.gl/xmQnxf for more information and examples of labels. System
2020    reserved label keys are prefixed with "aiplatform.googleapis.com/" and are
2021    immutable.
2022
2023    Messages:
2024      AdditionalProperty: An additional property for a AnnotationLabelsValue
2025        object.
2026
2027    Fields:
2028      additionalProperties: Additional properties of type
2029        AnnotationLabelsValue
2030    """
2031
2032    class AdditionalProperty(_messages.Message):
2033      r"""An additional property for a AnnotationLabelsValue object.
2034
2035      Fields:
2036        key: Name of the additional property.
2037        value: A string attribute.
2038      """
2039
2040      key = _messages.StringField(1)
2041      value = _messages.StringField(2)
2042
2043    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
2044
2045  @encoding.MapUnrecognizedFields('additionalProperties')
2046  class LabelsValue(_messages.Message):
2047    r"""The labels with user-defined metadata to organize your
2048    DataLabelingJobs. Label keys and values can be no longer than 64
2049    characters (Unicode codepoints), can only contain lowercase letters,
2050    numeric characters, underscores and dashes. International characters are
2051    allowed. See https://goo.gl/xmQnxf for more information and examples of
2052    labels. System reserved label keys are prefixed with
2053    "aiplatform.googleapis.com/" and are immutable. Following system labels
2054    exist for each DataLabelingJob: * "aiplatform.googleapis.com/schema":
2055    output only, its value is the inputs_schema's title.
2056
2057    Messages:
2058      AdditionalProperty: An additional property for a LabelsValue object.
2059
2060    Fields:
2061      additionalProperties: Additional properties of type LabelsValue
2062    """
2063
2064    class AdditionalProperty(_messages.Message):
2065      r"""An additional property for a LabelsValue object.
2066
2067      Fields:
2068        key: Name of the additional property.
2069        value: A string attribute.
2070      """
2071
2072      key = _messages.StringField(1)
2073      value = _messages.StringField(2)
2074
2075    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
2076
2077  activeLearningConfig = _messages.MessageField('GoogleCloudAiplatformV1ActiveLearningConfig', 1)
2078  annotationLabels = _messages.MessageField('AnnotationLabelsValue', 2)
2079  createTime = _messages.StringField(3)
2080  currentSpend = _messages.MessageField('GoogleTypeMoney', 4)
2081  datasets = _messages.StringField(5, repeated=True)
2082  displayName = _messages.StringField(6)
2083  encryptionSpec = _messages.MessageField('GoogleCloudAiplatformV1EncryptionSpec', 7)
2084  error = _messages.MessageField('GoogleRpcStatus', 8)
2085  inputs = _messages.MessageField('extra_types.JsonValue', 9)
2086  inputsSchemaUri = _messages.StringField(10)
2087  instructionUri = _messages.StringField(11)
2088  labelerCount = _messages.IntegerField(12, variant=_messages.Variant.INT32)
2089  labelingProgress = _messages.IntegerField(13, variant=_messages.Variant.INT32)
2090  labels = _messages.MessageField('LabelsValue', 14)
2091  name = _messages.StringField(15)
2092  specialistPools = _messages.StringField(16, repeated=True)
2093  state = _messages.EnumField('StateValueValuesEnum', 17)
2094  updateTime = _messages.StringField(18)
2095
2096
2097class GoogleCloudAiplatformV1Dataset(_messages.Message):
2098  r"""A collection of DataItems and Annotations on them.
2099
2100  Messages:
2101    LabelsValue: The labels with user-defined metadata to organize your
2102      Datasets. Label keys and values can be no longer than 64 characters
2103      (Unicode codepoints), can only contain lowercase letters, numeric
2104      characters, underscores and dashes. International characters are
2105      allowed. No more than 64 user labels can be associated with one Dataset
2106      (System labels are excluded). See https://goo.gl/xmQnxf for more
2107      information and examples of labels. System reserved label keys are
2108      prefixed with "aiplatform.googleapis.com/" and are immutable. Following
2109      system labels exist for each Dataset: *
2110      "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
2111      value is the metadata_schema's title.
2112
2113  Fields:
2114    createTime: Output only. Timestamp when this Dataset was created.
2115    displayName: Required. The user-defined name of the Dataset. The name can
2116      be up to 128 characters long and can be consist of any UTF-8 characters.
2117    encryptionSpec: Customer-managed encryption key spec for a Dataset. If
2118      set, this Dataset and all sub-resources of this Dataset will be secured
2119      by this key.
2120    etag: Used to perform consistent read-modify-write updates. If not set, a
2121      blind "overwrite" update happens.
2122    labels: The labels with user-defined metadata to organize your Datasets.
2123      Label keys and values can be no longer than 64 characters (Unicode
2124      codepoints), can only contain lowercase letters, numeric characters,
2125      underscores and dashes. International characters are allowed. No more
2126      than 64 user labels can be associated with one Dataset (System labels
2127      are excluded). See https://goo.gl/xmQnxf for more information and
2128      examples of labels. System reserved label keys are prefixed with
2129      "aiplatform.googleapis.com/" and are immutable. Following system labels
2130      exist for each Dataset: *
2131      "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
2132      value is the metadata_schema's title.
2133    metadata: Required. Additional information about the Dataset.
2134    metadataSchemaUri: Required. Points to a YAML file stored on Google Cloud
2135      Storage describing additional information about the Dataset. The schema
2136      is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can
2137      be used here are found in gs://google-cloud-
2138      aiplatform/schema/dataset/metadata/.
2139    name: Output only. The resource name of the Dataset.
2140    updateTime: Output only. Timestamp when this Dataset was last updated.
2141  """
2142
2143  @encoding.MapUnrecognizedFields('additionalProperties')
2144  class LabelsValue(_messages.Message):
2145    r"""The labels with user-defined metadata to organize your Datasets. Label
2146    keys and values can be no longer than 64 characters (Unicode codepoints),
2147    can only contain lowercase letters, numeric characters, underscores and
2148    dashes. International characters are allowed. No more than 64 user labels
2149    can be associated with one Dataset (System labels are excluded). See
2150    https://goo.gl/xmQnxf for more information and examples of labels. System
2151    reserved label keys are prefixed with "aiplatform.googleapis.com/" and are
2152    immutable. Following system labels exist for each Dataset: *
2153    "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
2154    value is the metadata_schema's title.
2155
2156    Messages:
2157      AdditionalProperty: An additional property for a LabelsValue object.
2158
2159    Fields:
2160      additionalProperties: Additional properties of type LabelsValue
2161    """
2162
2163    class AdditionalProperty(_messages.Message):
2164      r"""An additional property for a LabelsValue object.
2165
2166      Fields:
2167        key: Name of the additional property.
2168        value: A string attribute.
2169      """
2170
2171      key = _messages.StringField(1)
2172      value = _messages.StringField(2)
2173
2174    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
2175
2176  createTime = _messages.StringField(1)
2177  displayName = _messages.StringField(2)
2178  encryptionSpec = _messages.MessageField('GoogleCloudAiplatformV1EncryptionSpec', 3)
2179  etag = _messages.StringField(4)
2180  labels = _messages.MessageField('LabelsValue', 5)
2181  metadata = _messages.MessageField('extra_types.JsonValue', 6)
2182  metadataSchemaUri = _messages.StringField(7)
2183  name = _messages.StringField(8)
2184  updateTime = _messages.StringField(9)
2185
2186
2187class GoogleCloudAiplatformV1DedicatedResources(_messages.Message):
2188  r"""A description of resources that are dedicated to a DeployedModel, and
2189  that need a higher degree of manual configuration.
2190
2191  Fields:
2192    machineSpec: Required. Immutable. The specification of a single machine
2193      used by the prediction.
2194    maxReplicaCount: Immutable. The maximum number of replicas this
2195      DeployedModel may be deployed on when the traffic against it increases.
2196      If the requested value is too large, the deployment will error, but if
2197      deployment succeeds then the ability to scale the model to that many
2198      replicas is guaranteed (barring service outages). If traffic against the
2199      DeployedModel increases beyond what its replicas at maximum may handle,
2200      a portion of the traffic will be dropped. If this value is not provided,
2201      will use min_replica_count as the default value.
2202    minReplicaCount: Required. Immutable. The minimum number of machine
2203      replicas this DeployedModel will be always deployed on. If traffic
2204      against it increases, it may dynamically be deployed onto more replicas,
2205      and as traffic decreases, some of these extra replicas may be freed.
2206      Note: if machine_spec.accelerator_count is above 0, currently the model
2207      will be always deployed precisely on min_replica_count.
2208  """
2209
2210  machineSpec = _messages.MessageField('GoogleCloudAiplatformV1MachineSpec', 1)
2211  maxReplicaCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
2212  minReplicaCount = _messages.IntegerField(3, variant=_messages.Variant.INT32)
2213
2214
2215class GoogleCloudAiplatformV1DeleteOperationMetadata(_messages.Message):
2216  r"""Details of operations that perform deletes of any entities.
2217
2218  Fields:
2219    genericMetadata: The common part of the operation metadata.
2220  """
2221
2222  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
2223
2224
2225class GoogleCloudAiplatformV1DeployModelOperationMetadata(_messages.Message):
2226  r"""Runtime operation information for EndpointService.DeployModel.
2227
2228  Fields:
2229    genericMetadata: The operation generic information.
2230  """
2231
2232  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
2233
2234
2235class GoogleCloudAiplatformV1DeployModelRequest(_messages.Message):
2236  r"""Request message for EndpointService.DeployModel.
2237
2238  Messages:
2239    TrafficSplitValue: A map from a DeployedModel's ID to the percentage of
2240      this Endpoint's traffic that should be forwarded to that DeployedModel.
2241      If this field is non-empty, then the Endpoint's traffic_split will be
2242      overwritten with it. To refer to the ID of the just being deployed
2243      Model, a "0" should be used, and the actual ID of the new DeployedModel
2244      will be filled in its place by this method. The traffic percentage
2245      values must add up to 100. If this field is empty, then the Endpoint's
2246      traffic_split is not updated.
2247
2248  Fields:
2249    deployedModel: Required. The DeployedModel to be created within the
2250      Endpoint. Note that Endpoint.traffic_split must be updated for the
2251      DeployedModel to start receiving traffic, either as part of this call,
2252      or via EndpointService.UpdateEndpoint.
2253    trafficSplit: A map from a DeployedModel's ID to the percentage of this
2254      Endpoint's traffic that should be forwarded to that DeployedModel. If
2255      this field is non-empty, then the Endpoint's traffic_split will be
2256      overwritten with it. To refer to the ID of the just being deployed
2257      Model, a "0" should be used, and the actual ID of the new DeployedModel
2258      will be filled in its place by this method. The traffic percentage
2259      values must add up to 100. If this field is empty, then the Endpoint's
2260      traffic_split is not updated.
2261  """
2262
2263  @encoding.MapUnrecognizedFields('additionalProperties')
2264  class TrafficSplitValue(_messages.Message):
2265    r"""A map from a DeployedModel's ID to the percentage of this Endpoint's
2266    traffic that should be forwarded to that DeployedModel. If this field is
2267    non-empty, then the Endpoint's traffic_split will be overwritten with it.
2268    To refer to the ID of the just being deployed Model, a "0" should be used,
2269    and the actual ID of the new DeployedModel will be filled in its place by
2270    this method. The traffic percentage values must add up to 100. If this
2271    field is empty, then the Endpoint's traffic_split is not updated.
2272
2273    Messages:
2274      AdditionalProperty: An additional property for a TrafficSplitValue
2275        object.
2276
2277    Fields:
2278      additionalProperties: Additional properties of type TrafficSplitValue
2279    """
2280
2281    class AdditionalProperty(_messages.Message):
2282      r"""An additional property for a TrafficSplitValue object.
2283
2284      Fields:
2285        key: Name of the additional property.
2286        value: A integer attribute.
2287      """
2288
2289      key = _messages.StringField(1)
2290      value = _messages.IntegerField(2, variant=_messages.Variant.INT32)
2291
2292    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
2293
2294  deployedModel = _messages.MessageField('GoogleCloudAiplatformV1DeployedModel', 1)
2295  trafficSplit = _messages.MessageField('TrafficSplitValue', 2)
2296
2297
2298class GoogleCloudAiplatformV1DeployModelResponse(_messages.Message):
2299  r"""Response message for EndpointService.DeployModel.
2300
2301  Fields:
2302    deployedModel: The DeployedModel that had been deployed in the Endpoint.
2303  """
2304
2305  deployedModel = _messages.MessageField('GoogleCloudAiplatformV1DeployedModel', 1)
2306
2307
2308class GoogleCloudAiplatformV1DeployedModel(_messages.Message):
2309  r"""A deployment of a Model. Endpoints contain one or more DeployedModels.
2310
2311  Fields:
2312    automaticResources: A description of resources that to large degree are
2313      decided by AI Platform, and require only a modest additional
2314      configuration.
2315    createTime: Output only. Timestamp when the DeployedModel was created.
2316    dedicatedResources: A description of resources that are dedicated to the
2317      DeployedModel, and that need a higher degree of manual configuration.
2318    disableContainerLogging: For custom-trained Models and AutoML Tabular
2319      Models, the container of the DeployedModel instances will send `stderr`
2320      and `stdout` streams to Stackdriver Logging by default. Please note that
2321      the logs incur cost, which are subject to [Cloud Logging
2322      pricing](https://cloud.google.com/stackdriver/pricing). User can disable
2323      container logging by setting this flag to true.
2324    displayName: The display name of the DeployedModel. If not provided upon
2325      creation, the Model's display_name is used.
2326    enableAccessLogging: These logs are like standard server access logs,
2327      containing information like timestamp and latency for each prediction
2328      request. Note that Stackdriver logs may incur a cost, especially if your
2329      project receives prediction requests at a high queries per second rate
2330      (QPS). Estimate your costs before enabling this option.
2331    id: Output only. The ID of the DeployedModel.
2332    model: Required. The name of the Model that this is the deployment of.
2333      Note that the Model may be in a different location than the
2334      DeployedModel's Endpoint.
2335    serviceAccount: The service account that the DeployedModel's container
2336      runs as. Specify the email address of the service account. If this
2337      service account is not specified, the container runs as a service
2338      account that doesn't have access to the resource project. Users
2339      deploying the Model must have the `iam.serviceAccounts.actAs` permission
2340      on this service account.
2341  """
2342
2343  automaticResources = _messages.MessageField('GoogleCloudAiplatformV1AutomaticResources', 1)
2344  createTime = _messages.StringField(2)
2345  dedicatedResources = _messages.MessageField('GoogleCloudAiplatformV1DedicatedResources', 3)
2346  disableContainerLogging = _messages.BooleanField(4)
2347  displayName = _messages.StringField(5)
2348  enableAccessLogging = _messages.BooleanField(6)
2349  id = _messages.StringField(7)
2350  model = _messages.StringField(8)
2351  serviceAccount = _messages.StringField(9)
2352
2353
2354class GoogleCloudAiplatformV1DeployedModelRef(_messages.Message):
2355  r"""Points to a DeployedModel.
2356
2357  Fields:
2358    deployedModelId: Immutable. An ID of a DeployedModel in the above
2359      Endpoint.
2360    endpoint: Immutable. A resource name of an Endpoint.
2361  """
2362
2363  deployedModelId = _messages.StringField(1)
2364  endpoint = _messages.StringField(2)
2365
2366
2367class GoogleCloudAiplatformV1DiskSpec(_messages.Message):
2368  r"""Represents the spec of disk options.
2369
2370  Fields:
2371    bootDiskSizeGb: Size in GB of the boot disk (default is 100GB).
2372    bootDiskType: Type of the boot disk (default is "pd-ssd"). Valid values:
2373      "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard"
2374      (Persistent Disk Hard Disk Drive).
2375  """
2376
2377  bootDiskSizeGb = _messages.IntegerField(1, variant=_messages.Variant.INT32)
2378  bootDiskType = _messages.StringField(2)
2379
2380
2381class GoogleCloudAiplatformV1EncryptionSpec(_messages.Message):
2382  r"""Represents a customer-managed encryption key spec that can be applied to
2383  a top-level resource.
2384
2385  Fields:
2386    kmsKeyName: Required. The Cloud KMS resource identifier of the customer
2387      managed encryption key used to protect a resource. Has the form:
2388      `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-
2389      key`. The key needs to be in the same region as where the compute
2390      resource is created.
2391  """
2392
2393  kmsKeyName = _messages.StringField(1)
2394
2395
2396class GoogleCloudAiplatformV1Endpoint(_messages.Message):
2397  r"""Models are deployed into it, and afterwards Endpoint is called to obtain
2398  predictions and explanations.
2399
2400  Messages:
2401    LabelsValue: The labels with user-defined metadata to organize your
2402      Endpoints. Label keys and values can be no longer than 64 characters
2403      (Unicode codepoints), can only contain lowercase letters, numeric
2404      characters, underscores and dashes. International characters are
2405      allowed. See https://goo.gl/xmQnxf for more information and examples of
2406      labels.
2407    TrafficSplitValue: A map from a DeployedModel's ID to the percentage of
2408      this Endpoint's traffic that should be forwarded to that DeployedModel.
2409      If a DeployedModel's ID is not listed in this map, then it receives no
2410      traffic. The traffic percentage values must add up to 100, or map must
2411      be empty if the Endpoint is to not accept any traffic at a moment.
2412
2413  Fields:
2414    createTime: Output only. Timestamp when this Endpoint was created.
2415    deployedModels: Output only. The models deployed in this Endpoint. To add
2416      or remove DeployedModels use EndpointService.DeployModel and
2417      EndpointService.UndeployModel respectively.
2418    description: The description of the Endpoint.
2419    displayName: Required. The display name of the Endpoint. The name can be
2420      up to 128 characters long and can be consist of any UTF-8 characters.
2421    encryptionSpec: Customer-managed encryption key spec for an Endpoint. If
2422      set, this Endpoint and all sub-resources of this Endpoint will be
2423      secured by this key.
2424    etag: Used to perform consistent read-modify-write updates. If not set, a
2425      blind "overwrite" update happens.
2426    labels: The labels with user-defined metadata to organize your Endpoints.
2427      Label keys and values can be no longer than 64 characters (Unicode
2428      codepoints), can only contain lowercase letters, numeric characters,
2429      underscores and dashes. International characters are allowed. See
2430      https://goo.gl/xmQnxf for more information and examples of labels.
2431    name: Output only. The resource name of the Endpoint.
2432    trafficSplit: A map from a DeployedModel's ID to the percentage of this
2433      Endpoint's traffic that should be forwarded to that DeployedModel. If a
2434      DeployedModel's ID is not listed in this map, then it receives no
2435      traffic. The traffic percentage values must add up to 100, or map must
2436      be empty if the Endpoint is to not accept any traffic at a moment.
2437    updateTime: Output only. Timestamp when this Endpoint was last updated.
2438  """
2439
2440  @encoding.MapUnrecognizedFields('additionalProperties')
2441  class LabelsValue(_messages.Message):
2442    r"""The labels with user-defined metadata to organize your Endpoints.
2443    Label keys and values can be no longer than 64 characters (Unicode
2444    codepoints), can only contain lowercase letters, numeric characters,
2445    underscores and dashes. International characters are allowed. See
2446    https://goo.gl/xmQnxf for more information and examples of labels.
2447
2448    Messages:
2449      AdditionalProperty: An additional property for a LabelsValue object.
2450
2451    Fields:
2452      additionalProperties: Additional properties of type LabelsValue
2453    """
2454
2455    class AdditionalProperty(_messages.Message):
2456      r"""An additional property for a LabelsValue object.
2457
2458      Fields:
2459        key: Name of the additional property.
2460        value: A string attribute.
2461      """
2462
2463      key = _messages.StringField(1)
2464      value = _messages.StringField(2)
2465
2466    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
2467
2468  @encoding.MapUnrecognizedFields('additionalProperties')
2469  class TrafficSplitValue(_messages.Message):
2470    r"""A map from a DeployedModel's ID to the percentage of this Endpoint's
2471    traffic that should be forwarded to that DeployedModel. If a
2472    DeployedModel's ID is not listed in this map, then it receives no traffic.
2473    The traffic percentage values must add up to 100, or map must be empty if
2474    the Endpoint is to not accept any traffic at a moment.
2475
2476    Messages:
2477      AdditionalProperty: An additional property for a TrafficSplitValue
2478        object.
2479
2480    Fields:
2481      additionalProperties: Additional properties of type TrafficSplitValue
2482    """
2483
2484    class AdditionalProperty(_messages.Message):
2485      r"""An additional property for a TrafficSplitValue object.
2486
2487      Fields:
2488        key: Name of the additional property.
2489        value: A integer attribute.
2490      """
2491
2492      key = _messages.StringField(1)
2493      value = _messages.IntegerField(2, variant=_messages.Variant.INT32)
2494
2495    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
2496
2497  createTime = _messages.StringField(1)
2498  deployedModels = _messages.MessageField('GoogleCloudAiplatformV1DeployedModel', 2, repeated=True)
2499  description = _messages.StringField(3)
2500  displayName = _messages.StringField(4)
2501  encryptionSpec = _messages.MessageField('GoogleCloudAiplatformV1EncryptionSpec', 5)
2502  etag = _messages.StringField(6)
2503  labels = _messages.MessageField('LabelsValue', 7)
2504  name = _messages.StringField(8)
2505  trafficSplit = _messages.MessageField('TrafficSplitValue', 9)
2506  updateTime = _messages.StringField(10)
2507
2508
2509class GoogleCloudAiplatformV1EnvVar(_messages.Message):
2510  r"""Represents an environment variable present in a Container or Python
2511  Module.
2512
2513  Fields:
2514    name: Required. Name of the environment variable. Must be a valid C
2515      identifier.
2516    value: Required. Variables that reference a $(VAR_NAME) are expanded using
2517      the previous defined environment variables in the container and any
2518      service environment variables. If a variable cannot be resolved, the
2519      reference in the input string will be unchanged. The $(VAR_NAME) syntax
2520      can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references
2521      will never be expanded, regardless of whether the variable exists or
2522      not.
2523  """
2524
2525  name = _messages.StringField(1)
2526  value = _messages.StringField(2)
2527
2528
2529class GoogleCloudAiplatformV1ExportDataConfig(_messages.Message):
2530  r"""Describes what part of the Dataset is to be exported, the destination of
2531  the export and how to export.
2532
2533  Fields:
2534    annotationsFilter: A filter on Annotations of the Dataset. Only
2535      Annotations on to-be-exported DataItems(specified by data_items_filter)
2536      that match this filter will be exported. The filter syntax is the same
2537      as in ListAnnotations.
2538    gcsDestination: The Google Cloud Storage location where the output is to
2539      be written to. In the given directory a new directory will be created
2540      with name: `export-data--` where timestamp is in YYYY-MM-
2541      DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into
2542      that directory. Inside that directory, annotations with the same schema
2543      will be grouped into sub directories which are named with the
2544      corresponding annotations' schema title. Inside these sub directories, a
2545      schema.yaml will be created to describe the output format.
2546  """
2547
2548  annotationsFilter = _messages.StringField(1)
2549  gcsDestination = _messages.MessageField('GoogleCloudAiplatformV1GcsDestination', 2)
2550
2551
2552class GoogleCloudAiplatformV1ExportDataOperationMetadata(_messages.Message):
2553  r"""Runtime operation information for DatasetService.ExportData.
2554
2555  Fields:
2556    gcsOutputDirectory: A Google Cloud Storage directory which path ends with
2557      '/'. The exported data is stored in the directory.
2558    genericMetadata: The common part of the operation metadata.
2559  """
2560
2561  gcsOutputDirectory = _messages.StringField(1)
2562  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 2)
2563
2564
2565class GoogleCloudAiplatformV1ExportDataRequest(_messages.Message):
2566  r"""Request message for DatasetService.ExportData.
2567
2568  Fields:
2569    exportConfig: Required. The desired output location.
2570  """
2571
2572  exportConfig = _messages.MessageField('GoogleCloudAiplatformV1ExportDataConfig', 1)
2573
2574
2575class GoogleCloudAiplatformV1ExportDataResponse(_messages.Message):
2576  r"""Response message for DatasetService.ExportData.
2577
2578  Fields:
2579    exportedFiles: All of the files that are exported in this export
2580      operation.
2581  """
2582
2583  exportedFiles = _messages.StringField(1, repeated=True)
2584
2585
2586class GoogleCloudAiplatformV1ExportModelOperationMetadata(_messages.Message):
2587  r"""Details of ModelService.ExportModel operation.
2588
2589  Fields:
2590    genericMetadata: The common part of the operation metadata.
2591    outputInfo: Output only. Information further describing the output of this
2592      Model export.
2593  """
2594
2595  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
2596  outputInfo = _messages.MessageField('GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo', 2)
2597
2598
2599class GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo(_messages.Message):
2600  r"""Further describes the output of the ExportModel. Supplements
2601  ExportModelRequest.OutputConfig.
2602
2603  Fields:
2604    artifactOutputUri: Output only. If the Model artifact is being exported to
2605      Google Cloud Storage this is the full path of the directory created,
2606      into which the Model files are being written to.
2607    imageOutputUri: Output only. If the Model image is being exported to
2608      Google Container Registry or Artifact Registry this is the full path of
2609      the image created.
2610  """
2611
2612  artifactOutputUri = _messages.StringField(1)
2613  imageOutputUri = _messages.StringField(2)
2614
2615
2616class GoogleCloudAiplatformV1ExportModelRequest(_messages.Message):
2617  r"""Request message for ModelService.ExportModel.
2618
2619  Fields:
2620    outputConfig: Required. The desired output location and configuration.
2621  """
2622
2623  outputConfig = _messages.MessageField('GoogleCloudAiplatformV1ExportModelRequestOutputConfig', 1)
2624
2625
2626class GoogleCloudAiplatformV1ExportModelRequestOutputConfig(_messages.Message):
2627  r"""Output configuration for the Model export.
2628
2629  Fields:
2630    artifactDestination: The Cloud Storage location where the Model artifact
2631      is to be written to. Under the directory given as the destination a new
2632      one with name "`model-export--`", where timestamp is in YYYY-MM-
2633      DDThh:mm:ss.sssZ ISO-8601 format, will be created. Inside, the Model and
2634      any of its supporting files will be written. This field should only be
2635      set when the `exportableContent` field of the
2636      [Model.supported_export_formats] object contains `ARTIFACT`.
2637    exportFormatId: The ID of the format in which the Model must be exported.
2638      Each Model lists the export formats it supports. If no value is provided
2639      here, then the first from the list of the Model's supported formats is
2640      used by default.
2641    imageDestination: The Google Container Registry or Artifact Registry uri
2642      where the Model container image will be copied to. This field should
2643      only be set when the `exportableContent` field of the
2644      [Model.supported_export_formats] object contains `IMAGE`.
2645  """
2646
2647  artifactDestination = _messages.MessageField('GoogleCloudAiplatformV1GcsDestination', 1)
2648  exportFormatId = _messages.StringField(2)
2649  imageDestination = _messages.MessageField('GoogleCloudAiplatformV1ContainerRegistryDestination', 3)
2650
2651
2652class GoogleCloudAiplatformV1ExportModelResponse(_messages.Message):
2653  r"""Response message of ModelService.ExportModel operation."""
2654
2655
2656class GoogleCloudAiplatformV1FilterSplit(_messages.Message):
2657  r"""Assigns input data to training, validation, and test sets based on the
2658  given filters, data pieces not matched by any filter are ignored. Currently
2659  only supported for Datasets containing DataItems. If any of the filters in
2660  this message are to match nothing, then they can be set as '-' (the minus
2661  sign). Supported only for unstructured Datasets.
2662
2663  Fields:
2664    testFilter: Required. A filter on DataItems of the Dataset. DataItems that
2665      match this filter are used to test the Model. A filter with same syntax
2666      as the one used in DatasetService.ListDataItems may be used. If a single
2667      DataItem is matched by more than one of the FilterSplit filters, then it
2668      is assigned to the first set that applies to it in the training,
2669      validation, test order.
2670    trainingFilter: Required. A filter on DataItems of the Dataset. DataItems
2671      that match this filter are used to train the Model. A filter with same
2672      syntax as the one used in DatasetService.ListDataItems may be used. If a
2673      single DataItem is matched by more than one of the FilterSplit filters,
2674      then it is assigned to the first set that applies to it in the training,
2675      validation, test order.
2676    validationFilter: Required. A filter on DataItems of the Dataset.
2677      DataItems that match this filter are used to validate the Model. A
2678      filter with same syntax as the one used in DatasetService.ListDataItems
2679      may be used. If a single DataItem is matched by more than one of the
2680      FilterSplit filters, then it is assigned to the first set that applies
2681      to it in the training, validation, test order.
2682  """
2683
2684  testFilter = _messages.StringField(1)
2685  trainingFilter = _messages.StringField(2)
2686  validationFilter = _messages.StringField(3)
2687
2688
2689class GoogleCloudAiplatformV1FractionSplit(_messages.Message):
2690  r"""Assigns the input data to training, validation, and test sets as per the
2691  given fractions. Any of `training_fraction`, `validation_fraction` and
2692  `test_fraction` may optionally be provided, they must sum to up to 1. If the
2693  provided ones sum to less than 1, the remainder is assigned to sets as
2694  decided by AI Platform. If none of the fractions are set, by default roughly
2695  80% of data is used for training, 10% for validation, and 10% for test.
2696
2697  Fields:
2698    testFraction: The fraction of the input data that is to be used to
2699      evaluate the Model.
2700    trainingFraction: The fraction of the input data that is to be used to
2701      train the Model.
2702    validationFraction: The fraction of the input data that is to be used to
2703      validate the Model.
2704  """
2705
2706  testFraction = _messages.FloatField(1)
2707  trainingFraction = _messages.FloatField(2)
2708  validationFraction = _messages.FloatField(3)
2709
2710
2711class GoogleCloudAiplatformV1GcsDestination(_messages.Message):
2712  r"""The Google Cloud Storage location where the output is to be written to.
2713
2714  Fields:
2715    outputUriPrefix: Required. Google Cloud Storage URI to output directory.
2716      If the uri doesn't end with '/', a '/' will be automatically appended.
2717      The directory is created if it doesn't exist.
2718  """
2719
2720  outputUriPrefix = _messages.StringField(1)
2721
2722
2723class GoogleCloudAiplatformV1GcsSource(_messages.Message):
2724  r"""The Google Cloud Storage location for the input content.
2725
2726  Fields:
2727    uris: Required. Google Cloud Storage URI(-s) to the input file(s). May
2728      contain wildcards. For more information on wildcards, see
2729      https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
2730  """
2731
2732  uris = _messages.StringField(1, repeated=True)
2733
2734
2735class GoogleCloudAiplatformV1GenericOperationMetadata(_messages.Message):
2736  r"""Generic Metadata shared by all operations.
2737
2738  Fields:
2739    createTime: Output only. Time when the operation was created.
2740    partialFailures: Output only. Partial failures encountered. E.g. single
2741      files that couldn't be read. This field should never exceed 20 entries.
2742      Status details field will contain standard GCP error details.
2743    updateTime: Output only. Time when the operation was updated for the last
2744      time. If the operation has finished (successfully or not), this is the
2745      finish time.
2746  """
2747
2748  createTime = _messages.StringField(1)
2749  partialFailures = _messages.MessageField('GoogleRpcStatus', 2, repeated=True)
2750  updateTime = _messages.StringField(3)
2751
2752
2753class GoogleCloudAiplatformV1HyperparameterTuningJob(_messages.Message):
2754  r"""Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a
2755  Study specification and multiple CustomJobs with identical CustomJob
2756  specification.
2757
2758  Enums:
2759    StateValueValuesEnum: Output only. The detailed state of the job.
2760
2761  Messages:
2762    LabelsValue: The labels with user-defined metadata to organize
2763      HyperparameterTuningJobs. Label keys and values can be no longer than 64
2764      characters (Unicode codepoints), can only contain lowercase letters,
2765      numeric characters, underscores and dashes. International characters are
2766      allowed. See https://goo.gl/xmQnxf for more information and examples of
2767      labels.
2768
2769  Fields:
2770    createTime: Output only. Time when the HyperparameterTuningJob was
2771      created.
2772    displayName: Required. The display name of the HyperparameterTuningJob.
2773      The name can be up to 128 characters long and can be consist of any
2774      UTF-8 characters.
2775    encryptionSpec: Customer-managed encryption key options for a
2776      HyperparameterTuningJob. If this is set, then all resources created by
2777      the HyperparameterTuningJob will be encrypted with the provided
2778      encryption key.
2779    endTime: Output only. Time when the HyperparameterTuningJob entered any of
2780      the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
2781      `JOB_STATE_CANCELLED`.
2782    error: Output only. Only populated when job's state is JOB_STATE_FAILED or
2783      JOB_STATE_CANCELLED.
2784    labels: The labels with user-defined metadata to organize
2785      HyperparameterTuningJobs. Label keys and values can be no longer than 64
2786      characters (Unicode codepoints), can only contain lowercase letters,
2787      numeric characters, underscores and dashes. International characters are
2788      allowed. See https://goo.gl/xmQnxf for more information and examples of
2789      labels.
2790    maxFailedTrialCount: The number of failed Trials that need to be seen
2791      before failing the HyperparameterTuningJob. If set to 0, AI Platform
2792      decides how many Trials must fail before the whole job fails.
2793    maxTrialCount: Required. The desired total number of Trials.
2794    name: Output only. Resource name of the HyperparameterTuningJob.
2795    parallelTrialCount: Required. The desired number of Trials to run in
2796      parallel.
2797    startTime: Output only. Time when the HyperparameterTuningJob for the
2798      first time entered the `JOB_STATE_RUNNING` state.
2799    state: Output only. The detailed state of the job.
2800    studySpec: Required. Study configuration of the HyperparameterTuningJob.
2801    trialJobSpec: Required. The spec of a trial job. The same spec applies to
2802      the CustomJobs created in all the trials.
2803    trials: Output only. Trials of the HyperparameterTuningJob.
2804    updateTime: Output only. Time when the HyperparameterTuningJob was most
2805      recently updated.
2806  """
2807
2808  class StateValueValuesEnum(_messages.Enum):
2809    r"""Output only. The detailed state of the job.
2810
2811    Values:
2812      JOB_STATE_UNSPECIFIED: The job state is unspecified.
2813      JOB_STATE_QUEUED: The job has been just created or resumed and
2814        processing has not yet begun.
2815      JOB_STATE_PENDING: The service is preparing to run the job.
2816      JOB_STATE_RUNNING: The job is in progress.
2817      JOB_STATE_SUCCEEDED: The job completed successfully.
2818      JOB_STATE_FAILED: The job failed.
2819      JOB_STATE_CANCELLING: The job is being cancelled. From this state the
2820        job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or
2821        `JOB_STATE_CANCELLED`.
2822      JOB_STATE_CANCELLED: The job has been cancelled.
2823      JOB_STATE_PAUSED: The job has been stopped, and can be resumed.
2824    """
2825    JOB_STATE_UNSPECIFIED = 0
2826    JOB_STATE_QUEUED = 1
2827    JOB_STATE_PENDING = 2
2828    JOB_STATE_RUNNING = 3
2829    JOB_STATE_SUCCEEDED = 4
2830    JOB_STATE_FAILED = 5
2831    JOB_STATE_CANCELLING = 6
2832    JOB_STATE_CANCELLED = 7
2833    JOB_STATE_PAUSED = 8
2834
2835  @encoding.MapUnrecognizedFields('additionalProperties')
2836  class LabelsValue(_messages.Message):
2837    r"""The labels with user-defined metadata to organize
2838    HyperparameterTuningJobs. Label keys and values can be no longer than 64
2839    characters (Unicode codepoints), can only contain lowercase letters,
2840    numeric characters, underscores and dashes. International characters are
2841    allowed. See https://goo.gl/xmQnxf for more information and examples of
2842    labels.
2843
2844    Messages:
2845      AdditionalProperty: An additional property for a LabelsValue object.
2846
2847    Fields:
2848      additionalProperties: Additional properties of type LabelsValue
2849    """
2850
2851    class AdditionalProperty(_messages.Message):
2852      r"""An additional property for a LabelsValue object.
2853
2854      Fields:
2855        key: Name of the additional property.
2856        value: A string attribute.
2857      """
2858
2859      key = _messages.StringField(1)
2860      value = _messages.StringField(2)
2861
2862    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
2863
2864  createTime = _messages.StringField(1)
2865  displayName = _messages.StringField(2)
2866  encryptionSpec = _messages.MessageField('GoogleCloudAiplatformV1EncryptionSpec', 3)
2867  endTime = _messages.StringField(4)
2868  error = _messages.MessageField('GoogleRpcStatus', 5)
2869  labels = _messages.MessageField('LabelsValue', 6)
2870  maxFailedTrialCount = _messages.IntegerField(7, variant=_messages.Variant.INT32)
2871  maxTrialCount = _messages.IntegerField(8, variant=_messages.Variant.INT32)
2872  name = _messages.StringField(9)
2873  parallelTrialCount = _messages.IntegerField(10, variant=_messages.Variant.INT32)
2874  startTime = _messages.StringField(11)
2875  state = _messages.EnumField('StateValueValuesEnum', 12)
2876  studySpec = _messages.MessageField('GoogleCloudAiplatformV1StudySpec', 13)
2877  trialJobSpec = _messages.MessageField('GoogleCloudAiplatformV1CustomJobSpec', 14)
2878  trials = _messages.MessageField('GoogleCloudAiplatformV1Trial', 15, repeated=True)
2879  updateTime = _messages.StringField(16)
2880
2881
2882class GoogleCloudAiplatformV1ImportDataConfig(_messages.Message):
2883  r"""Describes the location from where we import data into a Dataset,
2884  together with the labels that will be applied to the DataItems and the
2885  Annotations.
2886
2887  Messages:
2888    DataItemLabelsValue: Labels that will be applied to newly imported
2889      DataItems. If an identical DataItem as one being imported already exists
2890      in the Dataset, then these labels will be appended to these of the
2891      already existing one, and if labels with identical key is imported
2892      before, the old label value will be overwritten. If two DataItems are
2893      identical in the same import data operation, the labels will be combined
2894      and if key collision happens in this case, one of the values will be
2895      picked randomly. Two DataItems are considered identical if their content
2896      bytes are identical (e.g. image bytes or pdf bytes). These labels will
2897      be overridden by Annotation labels specified inside index file
2898      referenced by import_schema_uri, e.g. jsonl file.
2899
2900  Fields:
2901    dataItemLabels: Labels that will be applied to newly imported DataItems.
2902      If an identical DataItem as one being imported already exists in the
2903      Dataset, then these labels will be appended to these of the already
2904      existing one, and if labels with identical key is imported before, the
2905      old label value will be overwritten. If two DataItems are identical in
2906      the same import data operation, the labels will be combined and if key
2907      collision happens in this case, one of the values will be picked
2908      randomly. Two DataItems are considered identical if their content bytes
2909      are identical (e.g. image bytes or pdf bytes). These labels will be
2910      overridden by Annotation labels specified inside index file referenced
2911      by import_schema_uri, e.g. jsonl file.
2912    gcsSource: The Google Cloud Storage location for the input content.
2913    importSchemaUri: Required. Points to a YAML file stored on Google Cloud
2914      Storage describing the import format. Validation will be done against
2915      the schema. The schema is defined as an [OpenAPI 3.0.2 Schema
2916      Object](https://tinyurl.com/y538mdwt).
2917  """
2918
2919  @encoding.MapUnrecognizedFields('additionalProperties')
2920  class DataItemLabelsValue(_messages.Message):
2921    r"""Labels that will be applied to newly imported DataItems. If an
2922    identical DataItem as one being imported already exists in the Dataset,
2923    then these labels will be appended to these of the already existing one,
2924    and if labels with identical key is imported before, the old label value
2925    will be overwritten. If two DataItems are identical in the same import
2926    data operation, the labels will be combined and if key collision happens
2927    in this case, one of the values will be picked randomly. Two DataItems are
2928    considered identical if their content bytes are identical (e.g. image
2929    bytes or pdf bytes). These labels will be overridden by Annotation labels
2930    specified inside index file referenced by import_schema_uri, e.g. jsonl
2931    file.
2932
2933    Messages:
2934      AdditionalProperty: An additional property for a DataItemLabelsValue
2935        object.
2936
2937    Fields:
2938      additionalProperties: Additional properties of type DataItemLabelsValue
2939    """
2940
2941    class AdditionalProperty(_messages.Message):
2942      r"""An additional property for a DataItemLabelsValue object.
2943
2944      Fields:
2945        key: Name of the additional property.
2946        value: A string attribute.
2947      """
2948
2949      key = _messages.StringField(1)
2950      value = _messages.StringField(2)
2951
2952    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
2953
2954  dataItemLabels = _messages.MessageField('DataItemLabelsValue', 1)
2955  gcsSource = _messages.MessageField('GoogleCloudAiplatformV1GcsSource', 2)
2956  importSchemaUri = _messages.StringField(3)
2957
2958
2959class GoogleCloudAiplatformV1ImportDataOperationMetadata(_messages.Message):
2960  r"""Runtime operation information for DatasetService.ImportData.
2961
2962  Fields:
2963    genericMetadata: The common part of the operation metadata.
2964  """
2965
2966  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
2967
2968
2969class GoogleCloudAiplatformV1ImportDataRequest(_messages.Message):
2970  r"""Request message for DatasetService.ImportData.
2971
2972  Fields:
2973    importConfigs: Required. The desired input locations. The contents of all
2974      input locations will be imported in one batch.
2975  """
2976
2977  importConfigs = _messages.MessageField('GoogleCloudAiplatformV1ImportDataConfig', 1, repeated=True)
2978
2979
2980class GoogleCloudAiplatformV1ImportDataResponse(_messages.Message):
2981  r"""Response message for DatasetService.ImportData."""
2982
2983
2984class GoogleCloudAiplatformV1InputDataConfig(_messages.Message):
2985  r"""Specifies AI Platform owned input data to be used for training, and
2986  possibly evaluating, the Model.
2987
2988  Fields:
2989    annotationSchemaUri: Applicable only to custom training with Datasets that
2990      have DataItems and Annotations. Cloud Storage URI that points to a YAML
2991      file describing the annotation schema. The schema is defined as an
2992      OpenAPI 3.0.2 [Schema Object](https://tinyurl.com/y538mdwt#schema-
2993      object). The schema files that can be used here are found in
2994      gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the
2995      chosen schema must be consistent with metadata of the Dataset specified
2996      by dataset_id. Only Annotations that both match this schema and belong
2997      to DataItems not ignored by the split method are used in respectively
2998      training, validation or test role, depending on the role of the DataItem
2999      they are on. When used in conjunction with annotations_filter, the
3000      Annotations used for training are filtered by both annotations_filter
3001      and annotation_schema_uri.
3002    annotationsFilter: Applicable only to Datasets that have DataItems and
3003      Annotations. A filter on Annotations of the Dataset. Only Annotations
3004      that both match this filter and belong to DataItems not ignored by the
3005      split method are used in respectively training, validation or test role,
3006      depending on the role of the DataItem they are on (for the auto-assigned
3007      that role is decided by AI Platform). A filter with same syntax as the
3008      one used in ListAnnotations may be used, but note here it filters across
3009      all Annotations of the Dataset, and not just within a single DataItem.
3010    bigqueryDestination: Only applicable to custom training with tabular
3011      Dataset with BigQuery source. The BigQuery project location where the
3012      training data is to be written to. In the given project a new dataset is
3013      created with name `dataset___` where timestamp is in
3014      YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into
3015      that dataset. In the dataset three tables are created, `training`,
3016      `validation` and `test`. * AIP_DATA_FORMAT = "bigquery". *
3017      AIP_TRAINING_DATA_URI = "bigquery_destination.dataset___.training" *
3018      AIP_VALIDATION_DATA_URI = "bigquery_destination.dataset___.validation" *
3019      AIP_TEST_DATA_URI = "bigquery_destination.dataset___.test"
3020    datasetId: Required. The ID of the Dataset in the same Project and
3021      Location which data will be used to train the Model. The Dataset must
3022      use schema compatible with Model being trained, and what is compatible
3023      should be described in the used TrainingPipeline's
3024      training_task_definition. For tabular Datasets, all their data is
3025      exported to training, to pick and choose from.
3026    filterSplit: Split based on the provided filters for each set.
3027    fractionSplit: Split based on fractions defining the size of each set.
3028    gcsDestination: The Cloud Storage location where the training data is to
3029      be written to. In the given directory a new directory is created with
3030      name: `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ
3031      ISO-8601 format. All training input data is written into that directory.
3032      The AI Platform environment variables representing Cloud Storage data
3033      URIs are represented in the Cloud Storage wildcard format to support
3034      sharded data. e.g.: "gs://.../training-*.jsonl" * AIP_DATA_FORMAT =
3035      "jsonl" for non-tabular data, "csv" for tabular data *
3036      AIP_TRAINING_DATA_URI =
3037      "gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}" *
3038      AIP_VALIDATION_DATA_URI =
3039      "gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}" *
3040      AIP_TEST_DATA_URI =
3041      "gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}"
3042    predefinedSplit: Supported only for tabular Datasets. Split based on a
3043      predefined key.
3044    timestampSplit: Supported only for tabular Datasets. Split based on the
3045      timestamp of the input data pieces.
3046  """
3047
3048  annotationSchemaUri = _messages.StringField(1)
3049  annotationsFilter = _messages.StringField(2)
3050  bigqueryDestination = _messages.MessageField('GoogleCloudAiplatformV1BigQueryDestination', 3)
3051  datasetId = _messages.StringField(4)
3052  filterSplit = _messages.MessageField('GoogleCloudAiplatformV1FilterSplit', 5)
3053  fractionSplit = _messages.MessageField('GoogleCloudAiplatformV1FractionSplit', 6)
3054  gcsDestination = _messages.MessageField('GoogleCloudAiplatformV1GcsDestination', 7)
3055  predefinedSplit = _messages.MessageField('GoogleCloudAiplatformV1PredefinedSplit', 8)
3056  timestampSplit = _messages.MessageField('GoogleCloudAiplatformV1TimestampSplit', 9)
3057
3058
3059class GoogleCloudAiplatformV1ListAnnotationsResponse(_messages.Message):
3060  r"""Response message for DatasetService.ListAnnotations.
3061
3062  Fields:
3063    annotations: A list of Annotations that matches the specified filter in
3064      the request.
3065    nextPageToken: The standard List next-page token.
3066  """
3067
3068  annotations = _messages.MessageField('GoogleCloudAiplatformV1Annotation', 1, repeated=True)
3069  nextPageToken = _messages.StringField(2)
3070
3071
3072class GoogleCloudAiplatformV1ListBatchPredictionJobsResponse(_messages.Message):
3073  r"""Response message for JobService.ListBatchPredictionJobs
3074
3075  Fields:
3076    batchPredictionJobs: List of BatchPredictionJobs in the requested page.
3077    nextPageToken: A token to retrieve the next page of results. Pass to
3078      ListBatchPredictionJobsRequest.page_token to obtain that page.
3079  """
3080
3081  batchPredictionJobs = _messages.MessageField('GoogleCloudAiplatformV1BatchPredictionJob', 1, repeated=True)
3082  nextPageToken = _messages.StringField(2)
3083
3084
3085class GoogleCloudAiplatformV1ListCustomJobsResponse(_messages.Message):
3086  r"""Response message for JobService.ListCustomJobs
3087
3088  Fields:
3089    customJobs: List of CustomJobs in the requested page.
3090    nextPageToken: A token to retrieve the next page of results. Pass to
3091      ListCustomJobsRequest.page_token to obtain that page.
3092  """
3093
3094  customJobs = _messages.MessageField('GoogleCloudAiplatformV1CustomJob', 1, repeated=True)
3095  nextPageToken = _messages.StringField(2)
3096
3097
3098class GoogleCloudAiplatformV1ListDataItemsResponse(_messages.Message):
3099  r"""Response message for DatasetService.ListDataItems.
3100
3101  Fields:
3102    dataItems: A list of DataItems that matches the specified filter in the
3103      request.
3104    nextPageToken: The standard List next-page token.
3105  """
3106
3107  dataItems = _messages.MessageField('GoogleCloudAiplatformV1DataItem', 1, repeated=True)
3108  nextPageToken = _messages.StringField(2)
3109
3110
3111class GoogleCloudAiplatformV1ListDataLabelingJobsResponse(_messages.Message):
3112  r"""Response message for JobService.ListDataLabelingJobs.
3113
3114  Fields:
3115    dataLabelingJobs: A list of DataLabelingJobs that matches the specified
3116      filter in the request.
3117    nextPageToken: The standard List next-page token.
3118  """
3119
3120  dataLabelingJobs = _messages.MessageField('GoogleCloudAiplatformV1DataLabelingJob', 1, repeated=True)
3121  nextPageToken = _messages.StringField(2)
3122
3123
3124class GoogleCloudAiplatformV1ListDatasetsResponse(_messages.Message):
3125  r"""Response message for DatasetService.ListDatasets.
3126
3127  Fields:
3128    datasets: A list of Datasets that matches the specified filter in the
3129      request.
3130    nextPageToken: The standard List next-page token.
3131  """
3132
3133  datasets = _messages.MessageField('GoogleCloudAiplatformV1Dataset', 1, repeated=True)
3134  nextPageToken = _messages.StringField(2)
3135
3136
3137class GoogleCloudAiplatformV1ListEndpointsResponse(_messages.Message):
3138  r"""Response message for EndpointService.ListEndpoints.
3139
3140  Fields:
3141    endpoints: List of Endpoints in the requested page.
3142    nextPageToken: A token to retrieve the next page of results. Pass to
3143      ListEndpointsRequest.page_token to obtain that page.
3144  """
3145
3146  endpoints = _messages.MessageField('GoogleCloudAiplatformV1Endpoint', 1, repeated=True)
3147  nextPageToken = _messages.StringField(2)
3148
3149
3150class GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse(_messages.Message):
3151  r"""Response message for JobService.ListHyperparameterTuningJobs
3152
3153  Fields:
3154    hyperparameterTuningJobs: List of HyperparameterTuningJobs in the
3155      requested page. HyperparameterTuningJob.trials of the jobs will be not
3156      be returned.
3157    nextPageToken: A token to retrieve the next page of results. Pass to
3158      ListHyperparameterTuningJobsRequest.page_token to obtain that page.
3159  """
3160
3161  hyperparameterTuningJobs = _messages.MessageField('GoogleCloudAiplatformV1HyperparameterTuningJob', 1, repeated=True)
3162  nextPageToken = _messages.StringField(2)
3163
3164
3165class GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse(_messages.Message):
3166  r"""Response message for ModelService.ListModelEvaluationSlices.
3167
3168  Fields:
3169    modelEvaluationSlices: List of ModelEvaluations in the requested page.
3170    nextPageToken: A token to retrieve next page of results. Pass to
3171      ListModelEvaluationSlicesRequest.page_token to obtain that page.
3172  """
3173
3174  modelEvaluationSlices = _messages.MessageField('GoogleCloudAiplatformV1ModelEvaluationSlice', 1, repeated=True)
3175  nextPageToken = _messages.StringField(2)
3176
3177
3178class GoogleCloudAiplatformV1ListModelEvaluationsResponse(_messages.Message):
3179  r"""Response message for ModelService.ListModelEvaluations.
3180
3181  Fields:
3182    modelEvaluations: List of ModelEvaluations in the requested page.
3183    nextPageToken: A token to retrieve next page of results. Pass to
3184      ListModelEvaluationsRequest.page_token to obtain that page.
3185  """
3186
3187  modelEvaluations = _messages.MessageField('GoogleCloudAiplatformV1ModelEvaluation', 1, repeated=True)
3188  nextPageToken = _messages.StringField(2)
3189
3190
3191class GoogleCloudAiplatformV1ListModelsResponse(_messages.Message):
3192  r"""Response message for ModelService.ListModels
3193
3194  Fields:
3195    models: List of Models in the requested page.
3196    nextPageToken: A token to retrieve next page of results. Pass to
3197      ListModelsRequest.page_token to obtain that page.
3198  """
3199
3200  models = _messages.MessageField('GoogleCloudAiplatformV1Model', 1, repeated=True)
3201  nextPageToken = _messages.StringField(2)
3202
3203
3204class GoogleCloudAiplatformV1ListSpecialistPoolsResponse(_messages.Message):
3205  r"""Response message for SpecialistPoolService.ListSpecialistPools.
3206
3207  Fields:
3208    nextPageToken: The standard List next-page token.
3209    specialistPools: A list of SpecialistPools that matches the specified
3210      filter in the request.
3211  """
3212
3213  nextPageToken = _messages.StringField(1)
3214  specialistPools = _messages.MessageField('GoogleCloudAiplatformV1SpecialistPool', 2, repeated=True)
3215
3216
3217class GoogleCloudAiplatformV1ListTrainingPipelinesResponse(_messages.Message):
3218  r"""Response message for PipelineService.ListTrainingPipelines
3219
3220  Fields:
3221    nextPageToken: A token to retrieve the next page of results. Pass to
3222      ListTrainingPipelinesRequest.page_token to obtain that page.
3223    trainingPipelines: List of TrainingPipelines in the requested page.
3224  """
3225
3226  nextPageToken = _messages.StringField(1)
3227  trainingPipelines = _messages.MessageField('GoogleCloudAiplatformV1TrainingPipeline', 2, repeated=True)
3228
3229
3230class GoogleCloudAiplatformV1MachineSpec(_messages.Message):
3231  r"""Specification of a single machine.
3232
3233  Enums:
3234    AcceleratorTypeValueValuesEnum: Immutable. The type of accelerator(s) that
3235      may be attached to the machine as per accelerator_count.
3236
3237  Fields:
3238    acceleratorCount: The number of accelerators to attach to the machine.
3239    acceleratorType: Immutable. The type of accelerator(s) that may be
3240      attached to the machine as per accelerator_count.
3241    machineType: Immutable. The type of the machine. For the machine types
3242      supported for prediction, see https://tinyurl.com/aip-
3243      docs/predictions/machine-types. For machine types supported for creating
3244      a custom training job, see https://tinyurl.com/aip-
3245      docs/training/configure-compute. For DeployedModel this field is
3246      optional, and the default value is `n1-standard-2`. For
3247      BatchPredictionJob or as part of WorkerPoolSpec this field is required.
3248  """
3249
3250  class AcceleratorTypeValueValuesEnum(_messages.Enum):
3251    r"""Immutable. The type of accelerator(s) that may be attached to the
3252    machine as per accelerator_count.
3253
3254    Values:
3255      ACCELERATOR_TYPE_UNSPECIFIED: Unspecified accelerator type, which means
3256        no accelerator.
3257      NVIDIA_TESLA_K80: Nvidia Tesla K80 GPU.
3258      NVIDIA_TESLA_P100: Nvidia Tesla P100 GPU.
3259      NVIDIA_TESLA_V100: Nvidia Tesla V100 GPU.
3260      NVIDIA_TESLA_P4: Nvidia Tesla P4 GPU.
3261      NVIDIA_TESLA_T4: Nvidia Tesla T4 GPU.
3262      TPU_V2: TPU v2.
3263      TPU_V3: TPU v3.
3264    """
3265    ACCELERATOR_TYPE_UNSPECIFIED = 0
3266    NVIDIA_TESLA_K80 = 1
3267    NVIDIA_TESLA_P100 = 2
3268    NVIDIA_TESLA_V100 = 3
3269    NVIDIA_TESLA_P4 = 4
3270    NVIDIA_TESLA_T4 = 5
3271    TPU_V2 = 6
3272    TPU_V3 = 7
3273
3274  acceleratorCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
3275  acceleratorType = _messages.EnumField('AcceleratorTypeValueValuesEnum', 2)
3276  machineType = _messages.StringField(3)
3277
3278
3279class GoogleCloudAiplatformV1ManualBatchTuningParameters(_messages.Message):
3280  r"""Manual batch tuning parameters.
3281
3282  Fields:
3283    batchSize: Immutable. The number of the records (e.g. instances) of the
3284      operation given in each batch to a machine replica. Machine type, and
3285      size of a single record should be considered when setting this
3286      parameter, higher value speeds up the batch operation's execution, but
3287      too high value will result in a whole batch not fitting in a machine's
3288      memory, and the whole operation will fail. The default value is 4.
3289  """
3290
3291  batchSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
3292
3293
3294class GoogleCloudAiplatformV1Measurement(_messages.Message):
3295  r"""A message representing a Measurement of a Trial. A Measurement contains
3296  the Metrics got by executing a Trial using suggested hyperparameter values.
3297
3298  Fields:
3299    metrics: Output only. A list of metrics got by evaluating the objective
3300      functions using suggested Parameter values.
3301    stepCount: Output only. The number of steps the machine learning model has
3302      been trained for. Must be non-negative.
3303  """
3304
3305  metrics = _messages.MessageField('GoogleCloudAiplatformV1MeasurementMetric', 1, repeated=True)
3306  stepCount = _messages.IntegerField(2)
3307
3308
3309class GoogleCloudAiplatformV1MeasurementMetric(_messages.Message):
3310  r"""A message representing a metric in the measurement.
3311
3312  Fields:
3313    metricId: Output only. The ID of the Metric. The Metric should be defined
3314      in StudySpec's Metrics.
3315    value: Output only. The value for this metric.
3316  """
3317
3318  metricId = _messages.StringField(1)
3319  value = _messages.FloatField(2)
3320
3321
3322class GoogleCloudAiplatformV1MigratableResource(_messages.Message):
3323  r"""Represents one resource that exists in automl.googleapis.com,
3324  datalabeling.googleapis.com or ml.googleapis.com.
3325
3326  Fields:
3327    automlDataset: Output only. Represents one Dataset in
3328      automl.googleapis.com.
3329    automlModel: Output only. Represents one Model in automl.googleapis.com.
3330    dataLabelingDataset: Output only. Represents one Dataset in
3331      datalabeling.googleapis.com.
3332    lastMigrateTime: Output only. Timestamp when the last migration attempt on
3333      this MigratableResource started. Will not be set if there's no migration
3334      attempt on this MigratableResource.
3335    lastUpdateTime: Output only. Timestamp when this MigratableResource was
3336      last updated.
3337    mlEngineModelVersion: Output only. Represents one Version in
3338      ml.googleapis.com.
3339  """
3340
3341  automlDataset = _messages.MessageField('GoogleCloudAiplatformV1MigratableResourceAutomlDataset', 1)
3342  automlModel = _messages.MessageField('GoogleCloudAiplatformV1MigratableResourceAutomlModel', 2)
3343  dataLabelingDataset = _messages.MessageField('GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset', 3)
3344  lastMigrateTime = _messages.StringField(4)
3345  lastUpdateTime = _messages.StringField(5)
3346  mlEngineModelVersion = _messages.MessageField('GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion', 6)
3347
3348
3349class GoogleCloudAiplatformV1MigratableResourceAutomlDataset(_messages.Message):
3350  r"""Represents one Dataset in automl.googleapis.com.
3351
3352  Fields:
3353    dataset: Full resource name of automl Dataset. Format:
3354      `projects/{project}/locations/{location}/datasets/{dataset}`.
3355    datasetDisplayName: The Dataset's display name in automl.googleapis.com.
3356  """
3357
3358  dataset = _messages.StringField(1)
3359  datasetDisplayName = _messages.StringField(2)
3360
3361
3362class GoogleCloudAiplatformV1MigratableResourceAutomlModel(_messages.Message):
3363  r"""Represents one Model in automl.googleapis.com.
3364
3365  Fields:
3366    model: Full resource name of automl Model. Format:
3367      `projects/{project}/locations/{location}/models/{model}`.
3368    modelDisplayName: The Model's display name in automl.googleapis.com.
3369  """
3370
3371  model = _messages.StringField(1)
3372  modelDisplayName = _messages.StringField(2)
3373
3374
3375class GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset(_messages.Message):
3376  r"""Represents one Dataset in datalabeling.googleapis.com.
3377
3378  Fields:
3379    dataLabelingAnnotatedDatasets: The migratable AnnotatedDataset in
3380      datalabeling.googleapis.com belongs to the data labeling Dataset.
3381    dataset: Full resource name of data labeling Dataset. Format:
3382      `projects/{project}/datasets/{dataset}`.
3383    datasetDisplayName: The Dataset's display name in
3384      datalabeling.googleapis.com.
3385  """
3386
3387  dataLabelingAnnotatedDatasets = _messages.MessageField('GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset', 1, repeated=True)
3388  dataset = _messages.StringField(2)
3389  datasetDisplayName = _messages.StringField(3)
3390
3391
3392class GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset(_messages.Message):
3393  r"""Represents one AnnotatedDataset in datalabeling.googleapis.com.
3394
3395  Fields:
3396    annotatedDataset: Full resource name of data labeling AnnotatedDataset.
3397      Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annota
3398      ted_dataset}`.
3399    annotatedDatasetDisplayName: The AnnotatedDataset's display name in
3400      datalabeling.googleapis.com.
3401  """
3402
3403  annotatedDataset = _messages.StringField(1)
3404  annotatedDatasetDisplayName = _messages.StringField(2)
3405
3406
3407class GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion(_messages.Message):
3408  r"""Represents one model Version in ml.googleapis.com.
3409
3410  Fields:
3411    endpoint: The ml.googleapis.com endpoint that this model Version currently
3412      lives in. Example values: * ml.googleapis.com * us-centrall-
3413      ml.googleapis.com * europe-west4-ml.googleapis.com * asia-
3414      east1-ml.googleapis.com
3415    version: Full resource name of ml engine model Version. Format:
3416      `projects/{project}/models/{model}/versions/{version}`.
3417  """
3418
3419  endpoint = _messages.StringField(1)
3420  version = _messages.StringField(2)
3421
3422
3423class GoogleCloudAiplatformV1MigrateResourceRequest(_messages.Message):
3424  r"""Config of migrating one resource from automl.googleapis.com,
3425  datalabeling.googleapis.com and ml.googleapis.com to AI Platform.
3426
3427  Fields:
3428    migrateAutomlDatasetConfig: Config for migrating Dataset in
3429      automl.googleapis.com to AI Platform's Dataset.
3430    migrateAutomlModelConfig: Config for migrating Model in
3431      automl.googleapis.com to AI Platform's Model.
3432    migrateDataLabelingDatasetConfig: Config for migrating Dataset in
3433      datalabeling.googleapis.com to AI Platform's Dataset.
3434    migrateMlEngineModelVersionConfig: Config for migrating Version in
3435      ml.googleapis.com to AI Platform's Model.
3436  """
3437
3438  migrateAutomlDatasetConfig = _messages.MessageField('GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig', 1)
3439  migrateAutomlModelConfig = _messages.MessageField('GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig', 2)
3440  migrateDataLabelingDatasetConfig = _messages.MessageField('GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig', 3)
3441  migrateMlEngineModelVersionConfig = _messages.MessageField('GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig', 4)
3442
3443
3444class GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig(_messages.Message):
3445  r"""Config for migrating Dataset in automl.googleapis.com to AI Platform's
3446  Dataset.
3447
3448  Fields:
3449    dataset: Required. Full resource name of automl Dataset. Format:
3450      `projects/{project}/locations/{location}/datasets/{dataset}`.
3451    datasetDisplayName: Required. Display name of the Dataset in AI Platform.
3452      System will pick a display name if unspecified.
3453  """
3454
3455  dataset = _messages.StringField(1)
3456  datasetDisplayName = _messages.StringField(2)
3457
3458
3459class GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig(_messages.Message):
3460  r"""Config for migrating Model in automl.googleapis.com to AI Platform's
3461  Model.
3462
3463  Fields:
3464    model: Required. Full resource name of automl Model. Format:
3465      `projects/{project}/locations/{location}/models/{model}`.
3466    modelDisplayName: Optional. Display name of the model in AI Platform.
3467      System will pick a display name if unspecified.
3468  """
3469
3470  model = _messages.StringField(1)
3471  modelDisplayName = _messages.StringField(2)
3472
3473
3474class GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig(_messages.Message):
3475  r"""Config for migrating Dataset in datalabeling.googleapis.com to AI
3476  Platform's Dataset.
3477
3478  Fields:
3479    dataset: Required. Full resource name of data labeling Dataset. Format:
3480      `projects/{project}/datasets/{dataset}`.
3481    datasetDisplayName: Optional. Display name of the Dataset in AI Platform.
3482      System will pick a display name if unspecified.
3483    migrateDataLabelingAnnotatedDatasetConfigs: Optional. Configs for
3484      migrating AnnotatedDataset in datalabeling.googleapis.com to AI
3485      Platform's SavedQuery. The specified AnnotatedDatasets have to belong to
3486      the datalabeling Dataset.
3487  """
3488
3489  dataset = _messages.StringField(1)
3490  datasetDisplayName = _messages.StringField(2)
3491  migrateDataLabelingAnnotatedDatasetConfigs = _messages.MessageField('GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig', 3, repeated=True)
3492
3493
3494class GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig(_messages.Message):
3495  r"""Config for migrating AnnotatedDataset in datalabeling.googleapis.com to
3496  AI Platform's SavedQuery.
3497
3498  Fields:
3499    annotatedDataset: Required. Full resource name of data labeling
3500      AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotat
3501      edDatasets/{annotated_dataset}`.
3502  """
3503
3504  annotatedDataset = _messages.StringField(1)
3505
3506
3507class GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig(_messages.Message):
3508  r"""Config for migrating version in ml.googleapis.com to AI Platform's
3509  Model.
3510
3511  Fields:
3512    endpoint: Required. The ml.googleapis.com endpoint that this model version
3513      should be migrated from. Example values: * ml.googleapis.com * us-
3514      centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * asia-
3515      east1-ml.googleapis.com
3516    modelDisplayName: Required. Display name of the model in AI Platform.
3517      System will pick a display name if unspecified.
3518    modelVersion: Required. Full resource name of ml engine model version.
3519      Format: `projects/{project}/models/{model}/versions/{version}`.
3520  """
3521
3522  endpoint = _messages.StringField(1)
3523  modelDisplayName = _messages.StringField(2)
3524  modelVersion = _messages.StringField(3)
3525
3526
3527class GoogleCloudAiplatformV1MigrateResourceResponse(_messages.Message):
3528  r"""Describes a successfully migrated resource.
3529
3530  Fields:
3531    dataset: Migrated Dataset's resource name.
3532    migratableResource: Before migration, the identifier in ml.googleapis.com,
3533      automl.googleapis.com or datalabeling.googleapis.com.
3534    model: Migrated Model's resource name.
3535  """
3536
3537  dataset = _messages.StringField(1)
3538  migratableResource = _messages.MessageField('GoogleCloudAiplatformV1MigratableResource', 2)
3539  model = _messages.StringField(3)
3540
3541
3542class GoogleCloudAiplatformV1Model(_messages.Message):
3543  r"""A trained machine learning Model.
3544
3545  Enums:
3546    SupportedDeploymentResourcesTypesValueListEntryValuesEnum:
3547
3548  Messages:
3549    LabelsValue: The labels with user-defined metadata to organize your
3550      Models. Label keys and values can be no longer than 64 characters
3551      (Unicode codepoints), can only contain lowercase letters, numeric
3552      characters, underscores and dashes. International characters are
3553      allowed. See https://goo.gl/xmQnxf for more information and examples of
3554      labels.
3555
3556  Fields:
3557    artifactUri: Immutable. The path to the directory containing the Model
3558      artifact and any of its supporting files. Not present for AutoML Models.
3559    containerSpec: Input only. The specification of the container that is to
3560      be used when deploying this Model. The specification is ingested upon
3561      ModelService.UploadModel, and all binaries it contains are copied and
3562      stored internally by AI Platform. Not present for AutoML Models.
3563    createTime: Output only. Timestamp when this Model was uploaded into AI
3564      Platform.
3565    deployedModels: Output only. The pointers to DeployedModels created from
3566      this Model. Note that Model could have been deployed to Endpoints in
3567      different Locations.
3568    description: The description of the Model.
3569    displayName: Required. The display name of the Model. The name can be up
3570      to 128 characters long and can be consist of any UTF-8 characters.
3571    encryptionSpec: Customer-managed encryption key spec for a Model. If set,
3572      this Model and all sub-resources of this Model will be secured by this
3573      key.
3574    etag: Used to perform consistent read-modify-write updates. If not set, a
3575      blind "overwrite" update happens.
3576    labels: The labels with user-defined metadata to organize your Models.
3577      Label keys and values can be no longer than 64 characters (Unicode
3578      codepoints), can only contain lowercase letters, numeric characters,
3579      underscores and dashes. International characters are allowed. See
3580      https://goo.gl/xmQnxf for more information and examples of labels.
3581    metadata: Immutable. An additional information about the Model; the schema
3582      of the metadata can be found in metadata_schema. Unset if the Model does
3583      not have any additional information.
3584    metadataSchemaUri: Immutable. Points to a YAML file stored on Google Cloud
3585      Storage describing additional information about the Model, that is
3586      specific to it. Unset if the Model does not have any additional
3587      information. The schema is defined as an OpenAPI 3.0.2 [Schema
3588      Object](https://tinyurl.com/y538mdwt#schema-object). AutoML Models
3589      always have this field populated by AI Platform, if no additional
3590      metadata is needed, this field is set to an empty string. Note: The URI
3591      given on output will be immutable and probably different, including the
3592      URI scheme, than the one given on input. The output URI will point to a
3593      location where the user only has a read access.
3594    name: The resource name of the Model.
3595    predictSchemata: The schemata that describe formats of the Model's
3596      predictions and explanations as given and returned via
3597      PredictionService.Predict and PredictionService.Explain.
3598    supportedDeploymentResourcesTypes: Output only. When this Model is
3599      deployed, its prediction resources are described by the
3600      `prediction_resources` field of the Endpoint.deployed_models object.
3601      Because not all Models support all resource configuration types, the
3602      configuration types this Model supports are listed here. If no
3603      configuration types are listed, the Model cannot be deployed to an
3604      Endpoint and does not support online predictions
3605      (PredictionService.Predict or PredictionService.Explain). Such a Model
3606      can serve predictions by using a BatchPredictionJob, if it has at least
3607      one entry each in supported_input_storage_formats and
3608      supported_output_storage_formats.
3609    supportedExportFormats: Output only. The formats in which this Model may
3610      be exported. If empty, this Model is not available for export.
3611    supportedInputStorageFormats: Output only. The formats this Model supports
3612      in BatchPredictionJob.input_config. If
3613      PredictSchemata.instance_schema_uri exists, the instances should be
3614      given as per that schema. The possible formats are: * `jsonl` The JSON
3615      Lines format, where each instance is a single line. Uses GcsSource. *
3616      `csv` The CSV format, where each instance is a single comma-separated
3617      line. The first line in the file is the header, containing comma-
3618      separated field names. Uses GcsSource. * `tf-record` The TFRecord
3619      format, where each instance is a single record in tfrecord syntax. Uses
3620      GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is
3621      gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in
3622      BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is
3623      the location of an instance to process, uses `gcs_source` field of the
3624      InputConfig object. If this Model doesn't support any of these formats
3625      it means it cannot be used with a BatchPredictionJob. However, if it has
3626      supported_deployment_resources_types, it could serve online predictions
3627      by using PredictionService.Predict or PredictionService.Explain.
3628    supportedOutputStorageFormats: Output only. The formats this Model
3629      supports in BatchPredictionJob.output_config. If both
3630      PredictSchemata.instance_schema_uri and
3631      PredictSchemata.prediction_schema_uri exist, the predictions are
3632      returned together with their instances. In other words, the prediction
3633      has the original instance data first, followed by the actual prediction
3634      content (as per the schema). The possible formats are: * `jsonl` The
3635      JSON Lines format, where each prediction is a single line. Uses
3636      GcsDestination. * `csv` The CSV format, where each prediction is a
3637      single comma-separated line. The first line in the file is the header,
3638      containing comma-separated field names. Uses GcsDestination. *
3639      `bigquery` Each prediction is a single row in a BigQuery table, uses
3640      BigQueryDestination . If this Model doesn't support any of these formats
3641      it means it cannot be used with a BatchPredictionJob. However, if it has
3642      supported_deployment_resources_types, it could serve online predictions
3643      by using PredictionService.Predict or PredictionService.Explain.
3644    trainingPipeline: Output only. The resource name of the TrainingPipeline
3645      that uploaded this Model, if any.
3646    updateTime: Output only. Timestamp when this Model was most recently
3647      updated.
3648  """
3649
3650  class SupportedDeploymentResourcesTypesValueListEntryValuesEnum(_messages.Enum):
3651    r"""SupportedDeploymentResourcesTypesValueListEntryValuesEnum enum type.
3652
3653    Values:
3654      DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED: Should not be used.
3655      DEDICATED_RESOURCES: Resources that are dedicated to the DeployedModel,
3656        and that need a higher degree of manual configuration.
3657      AUTOMATIC_RESOURCES: Resources that to large degree are decided by AI
3658        Platform, and require only a modest additional configuration.
3659    """
3660    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0
3661    DEDICATED_RESOURCES = 1
3662    AUTOMATIC_RESOURCES = 2
3663
3664  @encoding.MapUnrecognizedFields('additionalProperties')
3665  class LabelsValue(_messages.Message):
3666    r"""The labels with user-defined metadata to organize your Models. Label
3667    keys and values can be no longer than 64 characters (Unicode codepoints),
3668    can only contain lowercase letters, numeric characters, underscores and
3669    dashes. International characters are allowed. See https://goo.gl/xmQnxf
3670    for more information and examples of labels.
3671
3672    Messages:
3673      AdditionalProperty: An additional property for a LabelsValue object.
3674
3675    Fields:
3676      additionalProperties: Additional properties of type LabelsValue
3677    """
3678
3679    class AdditionalProperty(_messages.Message):
3680      r"""An additional property for a LabelsValue object.
3681
3682      Fields:
3683        key: Name of the additional property.
3684        value: A string attribute.
3685      """
3686
3687      key = _messages.StringField(1)
3688      value = _messages.StringField(2)
3689
3690    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
3691
3692  artifactUri = _messages.StringField(1)
3693  containerSpec = _messages.MessageField('GoogleCloudAiplatformV1ModelContainerSpec', 2)
3694  createTime = _messages.StringField(3)
3695  deployedModels = _messages.MessageField('GoogleCloudAiplatformV1DeployedModelRef', 4, repeated=True)
3696  description = _messages.StringField(5)
3697  displayName = _messages.StringField(6)
3698  encryptionSpec = _messages.MessageField('GoogleCloudAiplatformV1EncryptionSpec', 7)
3699  etag = _messages.StringField(8)
3700  labels = _messages.MessageField('LabelsValue', 9)
3701  metadata = _messages.MessageField('extra_types.JsonValue', 10)
3702  metadataSchemaUri = _messages.StringField(11)
3703  name = _messages.StringField(12)
3704  predictSchemata = _messages.MessageField('GoogleCloudAiplatformV1PredictSchemata', 13)
3705  supportedDeploymentResourcesTypes = _messages.EnumField('SupportedDeploymentResourcesTypesValueListEntryValuesEnum', 14, repeated=True)
3706  supportedExportFormats = _messages.MessageField('GoogleCloudAiplatformV1ModelExportFormat', 15, repeated=True)
3707  supportedInputStorageFormats = _messages.StringField(16, repeated=True)
3708  supportedOutputStorageFormats = _messages.StringField(17, repeated=True)
3709  trainingPipeline = _messages.StringField(18)
3710  updateTime = _messages.StringField(19)
3711
3712
3713class GoogleCloudAiplatformV1ModelContainerSpec(_messages.Message):
3714  r"""Specification of a container for serving predictions. This message is a
3715  subset of the Kubernetes Container v1 core
3716  [specification](https://tinyurl.com/k8s-io-api/v1.18/#container-v1-core).
3717
3718  Fields:
3719    args: Immutable. Specifies arguments for the command that runs when the
3720      container starts. This overrides the container's
3721      [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify
3722      this field as an array of executable and arguments, similar to a Docker
3723      `CMD`'s "default parameters" form. If you don't specify this field but
3724      do specify the command field, then the command from the `command` field
3725      runs without any additional arguments. See the [Kubernetes
3726      documentation](https://tinyurl.com/y8bvllf4) about how the `command` and
3727      `args` fields interact with a container's `ENTRYPOINT` and `CMD`. If you
3728      don't specify this field and don't specify the `command` field, then the
3729      container's
3730      [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd)
3731      and `CMD` determine what runs based on their default behavior. See the
3732      Docker documentation about how `CMD` and `ENTRYPOINT`
3733      [interact](https://tinyurl.com/h3kdcgs). In this field, you can
3734      reference environment variables [set by AI
3735      Platform](https://tinyurl.com/cust-cont-reqs#aip-variables) and
3736      environment variables set in the env field. You cannot reference
3737      environment variables set in the Docker image. In order for environment
3738      variables to be expanded, reference them by using the following syntax:
3739      $(VARIABLE_NAME) Note that this differs from Bash variable expansion,
3740      which does not use parentheses. If a variable cannot be resolved, the
3741      reference in the input string is used unchanged. To avoid variable
3742      expansion, you can escape this syntax with `$$`; for example:
3743      $$(VARIABLE_NAME) This field corresponds to the `args` field of the
3744      Kubernetes Containers [v1 core API](https://tinyurl.com/k8s-io-
3745      api/v1.18/#container-v1-core).
3746    command: Immutable. Specifies the command that runs when the container
3747      starts. This overrides the container's [ENTRYPOINT](https://docs.docker.
3748      com/engine/reference/builder/#entrypoint). Specify this field as an
3749      array of executable and arguments, similar to a Docker `ENTRYPOINT`'s
3750      "exec" form, not its "shell" form. If you do not specify this field,
3751      then the container's `ENTRYPOINT` runs, in conjunction with the args
3752      field or the container's
3753      [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if
3754      either exists. If this field is not specified and the container does not
3755      have an `ENTRYPOINT`, then refer to the Docker documentation about how
3756      `CMD` and `ENTRYPOINT` [interact](https://tinyurl.com/h3kdcgs). If you
3757      specify this field, then you can also specify the `args` field to
3758      provide additional arguments for this command. However, if you specify
3759      this field, then the container's `CMD` is ignored. See the [Kubernetes
3760      documentation](https://tinyurl.com/y8bvllf4) about how the `command` and
3761      `args` fields interact with a container's `ENTRYPOINT` and `CMD`. In
3762      this field, you can reference environment variables [set by AI
3763      Platform](https://tinyurl.com/cust-cont-reqs#aip-variables) and
3764      environment variables set in the env field. You cannot reference
3765      environment variables set in the Docker image. In order for environment
3766      variables to be expanded, reference them by using the following syntax:
3767      $(VARIABLE_NAME) Note that this differs from Bash variable expansion,
3768      which does not use parentheses. If a variable cannot be resolved, the
3769      reference in the input string is used unchanged. To avoid variable
3770      expansion, you can escape this syntax with `$$`; for example:
3771      $$(VARIABLE_NAME) This field corresponds to the `command` field of the
3772      Kubernetes Containers [v1 core API](https://tinyurl.com/k8s-io-
3773      api/v1.18/#container-v1-core).
3774    env: Immutable. List of environment variables to set in the container.
3775      After the container starts running, code running in the container can
3776      read these environment variables. Additionally, the command and args
3777      fields can reference these variables. Later entries in this list can
3778      also reference earlier entries. For example, the following example sets
3779      the variable `VAR_2` to have the value `foo bar`: ```json [ { "name":
3780      "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" }
3781      ] ``` If you switch the order of the variables in the example, then the
3782      expansion does not occur. This field corresponds to the `env` field of
3783      the Kubernetes Containers [v1 core API](https://tinyurl.com/k8s-io-
3784      api/v1.18/#container-v1-core).
3785    healthRoute: Immutable. HTTP path on the container to send health checks
3786      to. AI Platform intermittently sends GET requests to this path on the
3787      container's IP address and port to check that the container is healthy.
3788      Read more about [health checks](https://tinyurl.com/cust-cont-
3789      reqs#checks). For example, if you set this field to `/bar`, then AI
3790      Platform intermittently sends a GET request to the `/bar` path on the
3791      port of your container specified by the first value of this
3792      `ModelContainerSpec`'s ports field. If you don't specify this field, it
3793      defaults to the following value when you deploy this Model to an
3794      Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL :predict
3795      The placeholders in this value are replaced as follows: * ENDPOINT: The
3796      last segment (following `endpoints/`)of the Endpoint.name][] field of
3797      the Endpoint where this Model has been deployed. (AI Platform makes this
3798      value available to your container code as the
3799      [`AIP_ENDPOINT_ID`](https://tinyurl.com/cust-cont-reqs#aip-variables)
3800      environment variable.) * DEPLOYED_MODEL: DeployedModel.id of the
3801      `DeployedModel`. (AI Platform makes this value available to your
3802      container code as the
3803      [`AIP_DEPLOYED_MODEL_ID`](https://tinyurl.com/cust-cont-reqs#aip-
3804      variables) environment variable.)
3805    imageUri: Required. Immutable. URI of the Docker image to be used as the
3806      custom container for serving predictions. This URI must identify an
3807      image in Artifact Registry or Container Registry. Learn more about the
3808      container publishing requirements, including permissions requirements
3809      for the AI Platform Service Agent, [here](https://tinyurl.com/cust-cont-
3810      reqs#publishing). The container image is ingested upon
3811      ModelService.UploadModel, stored internally, and this original path is
3812      afterwards not used. To learn about the requirements for the Docker
3813      image itself, see [Custom container
3814      requirements](https://tinyurl.com/cust-cont-reqs).
3815    ports: Immutable. List of ports to expose from the container. AI Platform
3816      sends any prediction requests that it receives to the first port on this
3817      list. AI Platform also sends [liveness and health
3818      checks](https://tinyurl.com/cust-cont-reqs#health) to this port. If you
3819      do not specify this field, it defaults to following value: ```json [ {
3820      "containerPort": 8080 } ] ``` AI Platform does not use ports other than
3821      the first one listed. This field corresponds to the `ports` field of the
3822      Kubernetes Containers [v1 core API](https://tinyurl.com/k8s-io-
3823      api/v1.18/#container-v1-core).
3824    predictRoute: Immutable. HTTP path on the container to send prediction
3825      requests to. AI Platform forwards requests sent using
3826      projects.locations.endpoints.predict to this path on the container's IP
3827      address and port. AI Platform then returns the container's response in
3828      the API response. For example, if you set this field to `/foo`, then
3829      when AI Platform receives a prediction request, it forwards the request
3830      body in a POST request to the `/foo` path on the port of your container
3831      specified by the first value of this `ModelContainerSpec`'s ports field.
3832      If you don't specify this field, it defaults to the following value when
3833      you deploy this Model to an Endpoint:
3834      /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The
3835      placeholders in this value are replaced as follows: * ENDPOINT: The last
3836      segment (following `endpoints/`)of the Endpoint.name][] field of the
3837      Endpoint where this Model has been deployed. (AI Platform makes this
3838      value available to your container code as the
3839      [`AIP_ENDPOINT_ID`](https://tinyurl.com/cust-cont-reqs#aip-variables)
3840      environment variable.) * DEPLOYED_MODEL: DeployedModel.id of the
3841      `DeployedModel`. (AI Platform makes this value available to your
3842      container code as the [`AIP_DEPLOYED_MODEL_ID` environment
3843      variable](https://tinyurl.com/cust-cont-reqs#aip-variables).)
3844  """
3845
3846  args = _messages.StringField(1, repeated=True)
3847  command = _messages.StringField(2, repeated=True)
3848  env = _messages.MessageField('GoogleCloudAiplatformV1EnvVar', 3, repeated=True)
3849  healthRoute = _messages.StringField(4)
3850  imageUri = _messages.StringField(5)
3851  ports = _messages.MessageField('GoogleCloudAiplatformV1Port', 6, repeated=True)
3852  predictRoute = _messages.StringField(7)
3853
3854
3855class GoogleCloudAiplatformV1ModelEvaluation(_messages.Message):
3856  r"""A collection of metrics calculated by comparing Model's predictions on
3857  all of the test data against annotations from the test data.
3858
3859  Fields:
3860    createTime: Output only. Timestamp when this ModelEvaluation was created.
3861    metrics: Output only. Evaluation metrics of the Model. The schema of the
3862      metrics is stored in metrics_schema_uri
3863    metricsSchemaUri: Output only. Points to a YAML file stored on Google
3864      Cloud Storage describing the metrics of this ModelEvaluation. The schema
3865      is defined as an OpenAPI 3.0.2 [Schema
3866      Object](https://tinyurl.com/y538mdwt#schema-object).
3867    name: Output only. The resource name of the ModelEvaluation.
3868    sliceDimensions: Output only. All possible dimensions of
3869      ModelEvaluationSlices. The dimensions can be used as the filter of the
3870      ModelService.ListModelEvaluationSlices request, in the form of
3871      `slice.dimension = `.
3872  """
3873
3874  createTime = _messages.StringField(1)
3875  metrics = _messages.MessageField('extra_types.JsonValue', 2)
3876  metricsSchemaUri = _messages.StringField(3)
3877  name = _messages.StringField(4)
3878  sliceDimensions = _messages.StringField(5, repeated=True)
3879
3880
3881class GoogleCloudAiplatformV1ModelEvaluationSlice(_messages.Message):
3882  r"""A collection of metrics calculated by comparing Model's predictions on a
3883  slice of the test data against ground truth annotations.
3884
3885  Fields:
3886    createTime: Output only. Timestamp when this ModelEvaluationSlice was
3887      created.
3888    metrics: Output only. Sliced evaluation metrics of the Model. The schema
3889      of the metrics is stored in metrics_schema_uri
3890    metricsSchemaUri: Output only. Points to a YAML file stored on Google
3891      Cloud Storage describing the metrics of this ModelEvaluationSlice. The
3892      schema is defined as an OpenAPI 3.0.2 [Schema
3893      Object](https://tinyurl.com/y538mdwt#schema-object).
3894    name: Output only. The resource name of the ModelEvaluationSlice.
3895    slice: Output only. The slice of the test data that is used to evaluate
3896      the Model.
3897  """
3898
3899  createTime = _messages.StringField(1)
3900  metrics = _messages.MessageField('extra_types.JsonValue', 2)
3901  metricsSchemaUri = _messages.StringField(3)
3902  name = _messages.StringField(4)
3903  slice = _messages.MessageField('GoogleCloudAiplatformV1ModelEvaluationSliceSlice', 5)
3904
3905
3906class GoogleCloudAiplatformV1ModelEvaluationSliceSlice(_messages.Message):
3907  r"""Definition of a slice.
3908
3909  Fields:
3910    dimension: Output only. The dimension of the slice. Well-known dimensions
3911      are: * `annotationSpec`: This slice is on the test data that has either
3912      ground truth or prediction with AnnotationSpec.display_name equals to
3913      value.
3914    value: Output only. The value of the dimension in this slice.
3915  """
3916
3917  dimension = _messages.StringField(1)
3918  value = _messages.StringField(2)
3919
3920
3921class GoogleCloudAiplatformV1ModelExportFormat(_messages.Message):
3922  r"""Represents export format supported by the Model. All formats export to
3923  Google Cloud Storage.
3924
3925  Enums:
3926    ExportableContentsValueListEntryValuesEnum:
3927
3928  Fields:
3929    exportableContents: Output only. The content of this Model that may be
3930      exported.
3931    id: Output only. The ID of the export format. The possible format IDs are:
3932      * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for
3933      [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-
3934      model` A tensorflow model in SavedModel format. * `tf-js` A
3935      [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in
3936      the browser and in Node.js using JavaScript. * `core-ml` Used for iOS
3937      mobile devices. * `custom-trained` A Model that was uploaded or trained
3938      by custom code.
3939  """
3940
3941  class ExportableContentsValueListEntryValuesEnum(_messages.Enum):
3942    r"""ExportableContentsValueListEntryValuesEnum enum type.
3943
3944    Values:
3945      EXPORTABLE_CONTENT_UNSPECIFIED: Should not be used.
3946      ARTIFACT: Model artifact and any of its supported files. Will be
3947        exported to the location specified by the `artifactDestination` field
3948        of the ExportModelRequest.output_config object.
3949      IMAGE: The container image that is to be used when deploying this Model.
3950        Will be exported to the location specified by the `imageDestination`
3951        field of the ExportModelRequest.output_config object.
3952    """
3953    EXPORTABLE_CONTENT_UNSPECIFIED = 0
3954    ARTIFACT = 1
3955    IMAGE = 2
3956
3957  exportableContents = _messages.EnumField('ExportableContentsValueListEntryValuesEnum', 1, repeated=True)
3958  id = _messages.StringField(2)
3959
3960
3961class GoogleCloudAiplatformV1Port(_messages.Message):
3962  r"""Represents a network port in a container.
3963
3964  Fields:
3965    containerPort: The number of the port to expose on the pod's IP address.
3966      Must be a valid port number, between 1 and 65535 inclusive.
3967  """
3968
3969  containerPort = _messages.IntegerField(1, variant=_messages.Variant.INT32)
3970
3971
3972class GoogleCloudAiplatformV1PredefinedSplit(_messages.Message):
3973  r"""Assigns input data to training, validation, and test sets based on the
3974  value of a provided key. Supported only for tabular Datasets.
3975
3976  Fields:
3977    key: Required. The key is a name of one of the Dataset's data columns. The
3978      value of the key (either the label's value or value in the column) must
3979      be one of {`training`, `validation`, `test`}, and it defines to which
3980      set the given piece of data is assigned. If for a piece of data the key
3981      is not present or has an invalid value, that piece is ignored by the
3982      pipeline.
3983  """
3984
3985  key = _messages.StringField(1)
3986
3987
3988class GoogleCloudAiplatformV1PredictRequest(_messages.Message):
3989  r"""Request message for PredictionService.Predict.
3990
3991  Fields:
3992    instances: Required. The instances that are the input to the prediction
3993      call. A DeployedModel may have an upper limit on the number of instances
3994      it supports per request, and when it is exceeded the prediction call
3995      errors in case of AutoML Models, or, in case of customer created Models,
3996      the behaviour is as documented by that Model. The schema of any single
3997      instance may be specified via Endpoint's DeployedModels' Model's
3998      PredictSchemata's instance_schema_uri.
3999    parameters: The parameters that govern the prediction. The schema of the
4000      parameters may be specified via Endpoint's DeployedModels' Model's
4001      PredictSchemata's parameters_schema_uri.
4002  """
4003
4004  instances = _messages.MessageField('extra_types.JsonValue', 1, repeated=True)
4005  parameters = _messages.MessageField('extra_types.JsonValue', 2)
4006
4007
4008class GoogleCloudAiplatformV1PredictResponse(_messages.Message):
4009  r"""Response message for PredictionService.Predict.
4010
4011  Fields:
4012    deployedModelId: ID of the Endpoint's DeployedModel that served this
4013      prediction.
4014    predictions: The predictions that are the output of the predictions call.
4015      The schema of any single prediction may be specified via Endpoint's
4016      DeployedModels' Model's PredictSchemata's prediction_schema_uri.
4017  """
4018
4019  deployedModelId = _messages.StringField(1)
4020  predictions = _messages.MessageField('extra_types.JsonValue', 2, repeated=True)
4021
4022
4023class GoogleCloudAiplatformV1PredictSchemata(_messages.Message):
4024  r"""Contains the schemata used in Model's predictions and explanations via
4025  PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.
4026
4027  Fields:
4028    instanceSchemaUri: Immutable. Points to a YAML file stored on Google Cloud
4029      Storage describing the format of a single instance, which are used in
4030      PredictRequest.instances, ExplainRequest.instances and
4031      BatchPredictionJob.input_config. The schema is defined as an OpenAPI
4032      3.0.2 [Schema Object](https://tinyurl.com/y538mdwt#schema-object).
4033      AutoML Models always have this field populated by AI Platform. Note: The
4034      URI given on output will be immutable and probably different, including
4035      the URI scheme, than the one given on input. The output URI will point
4036      to a location where the user only has a read access.
4037    parametersSchemaUri: Immutable. Points to a YAML file stored on Google
4038      Cloud Storage describing the parameters of prediction and explanation
4039      via PredictRequest.parameters, ExplainRequest.parameters and
4040      BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI
4041      3.0.2 [Schema Object](https://tinyurl.com/y538mdwt#schema-object).
4042      AutoML Models always have this field populated by AI Platform, if no
4043      parameters are supported, then it is set to an empty string. Note: The
4044      URI given on output will be immutable and probably different, including
4045      the URI scheme, than the one given on input. The output URI will point
4046      to a location where the user only has a read access.
4047    predictionSchemaUri: Immutable. Points to a YAML file stored on Google
4048      Cloud Storage describing the format of a single prediction produced by
4049      this Model, which are returned via PredictResponse.predictions,
4050      ExplainResponse.explanations, and BatchPredictionJob.output_config. The
4051      schema is defined as an OpenAPI 3.0.2 [Schema
4052      Object](https://tinyurl.com/y538mdwt#schema-object). AutoML Models
4053      always have this field populated by AI Platform. Note: The URI given on
4054      output will be immutable and probably different, including the URI
4055      scheme, than the one given on input. The output URI will point to a
4056      location where the user only has a read access.
4057  """
4058
4059  instanceSchemaUri = _messages.StringField(1)
4060  parametersSchemaUri = _messages.StringField(2)
4061  predictionSchemaUri = _messages.StringField(3)
4062
4063
4064class GoogleCloudAiplatformV1PythonPackageSpec(_messages.Message):
4065  r"""The spec of a Python packaged code.
4066
4067  Fields:
4068    args: Command line arguments to be passed to the Python task.
4069    env: Environment variables to be passed to the python module.
4070    executorImageUri: Required. The URI of a container image in the Container
4071      Registry that will run the provided python package. AI Platform provides
4072      wide range of executor images with pre-installed packages to meet users'
4073      various use cases. Only one of the provided images can be set here.
4074    packageUris: Required. The Google Cloud Storage location of the Python
4075      package files which are the training program and its dependent packages.
4076      The maximum number of package URIs is 100.
4077    pythonModule: Required. The Python module name to run after installing the
4078      packages.
4079  """
4080
4081  args = _messages.StringField(1, repeated=True)
4082  env = _messages.MessageField('GoogleCloudAiplatformV1EnvVar', 2, repeated=True)
4083  executorImageUri = _messages.StringField(3)
4084  packageUris = _messages.StringField(4, repeated=True)
4085  pythonModule = _messages.StringField(5)
4086
4087
4088class GoogleCloudAiplatformV1ResourcesConsumed(_messages.Message):
4089  r"""Statistics information about resource consumption.
4090
4091  Fields:
4092    replicaHours: Output only. The number of replica hours used. Note that
4093      many replicas may run in parallel, and additionally any given work may
4094      be queued for some time. Therefore this value is not strictly related to
4095      wall time.
4096  """
4097
4098  replicaHours = _messages.FloatField(1)
4099
4100
4101class GoogleCloudAiplatformV1SampleConfig(_messages.Message):
4102  r"""Active learning data sampling config. For every active learning labeling
4103  iteration, it will select a batch of data based on the sampling strategy.
4104
4105  Enums:
4106    SampleStrategyValueValuesEnum: Field to choose sampling strategy. Sampling
4107      strategy will decide which data should be selected for human labeling in
4108      every batch.
4109
4110  Fields:
4111    followingBatchSamplePercentage: The percentage of data needed to be
4112      labeled in each following batch (except the first batch).
4113    initialBatchSamplePercentage: The percentage of data needed to be labeled
4114      in the first batch.
4115    sampleStrategy: Field to choose sampling strategy. Sampling strategy will
4116      decide which data should be selected for human labeling in every batch.
4117  """
4118
4119  class SampleStrategyValueValuesEnum(_messages.Enum):
4120    r"""Field to choose sampling strategy. Sampling strategy will decide which
4121    data should be selected for human labeling in every batch.
4122
4123    Values:
4124      SAMPLE_STRATEGY_UNSPECIFIED: Default will be treated as UNCERTAINTY.
4125      UNCERTAINTY: Sample the most uncertain data to label.
4126    """
4127    SAMPLE_STRATEGY_UNSPECIFIED = 0
4128    UNCERTAINTY = 1
4129
4130  followingBatchSamplePercentage = _messages.IntegerField(1, variant=_messages.Variant.INT32)
4131  initialBatchSamplePercentage = _messages.IntegerField(2, variant=_messages.Variant.INT32)
4132  sampleStrategy = _messages.EnumField('SampleStrategyValueValuesEnum', 3)
4133
4134
4135class GoogleCloudAiplatformV1Scheduling(_messages.Message):
4136  r"""All parameters related to queuing and scheduling of custom jobs.
4137
4138  Fields:
4139    restartJobOnWorkerRestart: Restarts the entire CustomJob if a worker gets
4140      restarted. This feature can be used by distributed training jobs that
4141      are not resilient to workers leaving and joining a job.
4142    timeout: The maximum job running time. The default is 7 days.
4143  """
4144
4145  restartJobOnWorkerRestart = _messages.BooleanField(1)
4146  timeout = _messages.StringField(2)
4147
4148
4149class GoogleCloudAiplatformV1SchemaAnnotationSpecColor(_messages.Message):
4150  r"""An entry of mapping between color and AnnotationSpec. The mapping is
4151  used in segmentation mask.
4152
4153  Fields:
4154    color: The color of the AnnotationSpec in a segmentation mask.
4155    displayName: The display name of the AnnotationSpec represented by the
4156      color in the segmentation mask.
4157    id: The ID of the AnnotationSpec represented by the color in the
4158      segmentation mask.
4159  """
4160
4161  color = _messages.MessageField('GoogleTypeColor', 1)
4162  displayName = _messages.StringField(2)
4163  id = _messages.StringField(3)
4164
4165
4166class GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation(_messages.Message):
4167  r"""Annotation details specific to image object detection.
4168
4169  Fields:
4170    annotationSpecId: The resource Id of the AnnotationSpec that this
4171      Annotation pertains to.
4172    displayName: The display name of the AnnotationSpec that this Annotation
4173      pertains to.
4174    xMax: The rightmost coordinate of the bounding box.
4175    xMin: The leftmost coordinate of the bounding box.
4176    yMax: The bottommost coordinate of the bounding box.
4177    yMin: The topmost coordinate of the bounding box.
4178  """
4179
4180  annotationSpecId = _messages.StringField(1)
4181  displayName = _messages.StringField(2)
4182  xMax = _messages.FloatField(3)
4183  xMin = _messages.FloatField(4)
4184  yMax = _messages.FloatField(5)
4185  yMin = _messages.FloatField(6)
4186
4187
4188class GoogleCloudAiplatformV1SchemaImageClassificationAnnotation(_messages.Message):
4189  r"""Annotation details specific to image classification.
4190
4191  Fields:
4192    annotationSpecId: The resource Id of the AnnotationSpec that this
4193      Annotation pertains to.
4194    displayName: The display name of the AnnotationSpec that this Annotation
4195      pertains to.
4196  """
4197
4198  annotationSpecId = _messages.StringField(1)
4199  displayName = _messages.StringField(2)
4200
4201
4202class GoogleCloudAiplatformV1SchemaImageDataItem(_messages.Message):
4203  r"""Payload of Image DataItem.
4204
4205  Fields:
4206    gcsUri: Required. Google Cloud Storage URI points to the original image in
4207      user's bucket. The image is up to 30MB in size.
4208    mimeType: Output only. The mime type of the content of the image. Only the
4209      images in below listed mime types are supported. - image/jpeg -
4210      image/gif - image/png - image/webp - image/bmp - image/tiff -
4211      image/vnd.microsoft.icon
4212  """
4213
4214  gcsUri = _messages.StringField(1)
4215  mimeType = _messages.StringField(2)
4216
4217
4218class GoogleCloudAiplatformV1SchemaImageDatasetMetadata(_messages.Message):
4219  r"""The metadata of Datasets that contain Image DataItems.
4220
4221  Fields:
4222    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
4223      describing payload of the Image DataItems that belong to this Dataset.
4224    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
4225      this Dataset.
4226  """
4227
4228  dataItemSchemaUri = _messages.StringField(1)
4229  gcsBucket = _messages.StringField(2)
4230
4231
4232class GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation(_messages.Message):
4233  r"""Annotation details specific to image segmentation.
4234
4235  Fields:
4236    maskAnnotation: Mask based segmentation annotation. Only one mask
4237      annotation can exist for one image.
4238    polygonAnnotation: Polygon annotation.
4239    polylineAnnotation: Polyline annotation.
4240  """
4241
4242  maskAnnotation = _messages.MessageField('GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation', 1)
4243  polygonAnnotation = _messages.MessageField('GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation', 2)
4244  polylineAnnotation = _messages.MessageField('GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation', 3)
4245
4246
4247class GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation(_messages.Message):
4248  r"""The mask based segmentation annotation.
4249
4250  Fields:
4251    annotationSpecColors: The mapping between color and AnnotationSpec for
4252      this Annotation.
4253    maskGcsUri: Google Cloud Storage URI that points to the mask image. The
4254      image must be in PNG format. It must have the same size as the
4255      DataItem's image. Each pixel in the image mask represents the
4256      AnnotationSpec which the pixel in the image DataItem belong to. Each
4257      color is mapped to one AnnotationSpec based on annotation_spec_colors.
4258  """
4259
4260  annotationSpecColors = _messages.MessageField('GoogleCloudAiplatformV1SchemaAnnotationSpecColor', 1, repeated=True)
4261  maskGcsUri = _messages.StringField(2)
4262
4263
4264class GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation(_messages.Message):
4265  r"""Represents a polygon in image.
4266
4267  Fields:
4268    annotationSpecId: The resource Id of the AnnotationSpec that this
4269      Annotation pertains to.
4270    displayName: The display name of the AnnotationSpec that this Annotation
4271      pertains to.
4272    vertexes: The vertexes are connected one by one and the last vertex is
4273      connected to the first one to represent a polygon.
4274  """
4275
4276  annotationSpecId = _messages.StringField(1)
4277  displayName = _messages.StringField(2)
4278  vertexes = _messages.MessageField('GoogleCloudAiplatformV1SchemaVertex', 3, repeated=True)
4279
4280
4281class GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation(_messages.Message):
4282  r"""Represents a polyline in image.
4283
4284  Fields:
4285    annotationSpecId: The resource Id of the AnnotationSpec that this
4286      Annotation pertains to.
4287    displayName: The display name of the AnnotationSpec that this Annotation
4288      pertains to.
4289    vertexes: The vertexes are connected one by one and the last vertex in not
4290      connected to the first one.
4291  """
4292
4293  annotationSpecId = _messages.StringField(1)
4294  displayName = _messages.StringField(2)
4295  vertexes = _messages.MessageField('GoogleCloudAiplatformV1SchemaVertex', 3, repeated=True)
4296
4297
4298class GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance(_messages.Message):
4299  r"""Prediction input format for Image Classification.
4300
4301  Fields:
4302    content: The image bytes or GCS URI to make the prediction on.
4303    mimeType: The MIME type of the content of the image. Only the images in
4304      below listed MIME types are supported. - image/jpeg - image/gif -
4305      image/png - image/webp - image/bmp - image/tiff -
4306      image/vnd.microsoft.icon
4307  """
4308
4309  content = _messages.StringField(1)
4310  mimeType = _messages.StringField(2)
4311
4312
4313class GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance(_messages.Message):
4314  r"""Prediction input format for Image Object Detection.
4315
4316  Fields:
4317    content: The image bytes or GCS URI to make the prediction on.
4318    mimeType: The MIME type of the content of the image. Only the images in
4319      below listed MIME types are supported. - image/jpeg - image/gif -
4320      image/png - image/webp - image/bmp - image/tiff -
4321      image/vnd.microsoft.icon
4322  """
4323
4324  content = _messages.StringField(1)
4325  mimeType = _messages.StringField(2)
4326
4327
4328class GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance(_messages.Message):
4329  r"""Prediction input format for Image Segmentation.
4330
4331  Fields:
4332    content: The image bytes to make the predictions on.
4333    mimeType: The MIME type of the content of the image. Only the images in
4334      below listed MIME types are supported. - image/jpeg - image/png
4335  """
4336
4337  content = _messages.StringField(1)
4338  mimeType = _messages.StringField(2)
4339
4340
4341class GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance(_messages.Message):
4342  r"""Prediction input format for Text Classification.
4343
4344  Fields:
4345    content: The text snippet to make the predictions on.
4346    mimeType: The MIME type of the text snippet. The supported MIME types are
4347      listed below. - text/plain
4348  """
4349
4350  content = _messages.StringField(1)
4351  mimeType = _messages.StringField(2)
4352
4353
4354class GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance(_messages.Message):
4355  r"""Prediction input format for Text Extraction.
4356
4357  Fields:
4358    content: The text snippet to make the predictions on.
4359    key: This field is only used for batch prediction. If a key is provided,
4360      the batch prediction result will by mapped to this key. If omitted, then
4361      the batch prediction result will contain the entire input instance. AI
4362      Platform will not check if keys in the request are duplicates, so it is
4363      up to the caller to ensure the keys are unique.
4364    mimeType: The MIME type of the text snippet. The supported MIME types are
4365      listed below. - text/plain
4366  """
4367
4368  content = _messages.StringField(1)
4369  key = _messages.StringField(2)
4370  mimeType = _messages.StringField(3)
4371
4372
4373class GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance(_messages.Message):
4374  r"""Prediction input format for Text Sentiment.
4375
4376  Fields:
4377    content: The text snippet to make the predictions on.
4378    mimeType: The MIME type of the text snippet. The supported MIME types are
4379      listed below. - text/plain
4380  """
4381
4382  content = _messages.StringField(1)
4383  mimeType = _messages.StringField(2)
4384
4385
4386class GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance(_messages.Message):
4387  r"""Prediction input format for Video Action Recognition.
4388
4389  Fields:
4390    content: The Google Cloud Storage location of the video on which to
4391      perform the prediction.
4392    mimeType: The MIME type of the content of the video. Only the following
4393      are supported: video/mp4 video/avi video/quicktime
4394    timeSegmentEnd: The end, exclusive, of the video's time segment on which
4395      to perform the prediction. Expressed as a number of seconds as measured
4396      from the start of the video, with "s" appended at the end. Fractions are
4397      allowed, up to a microsecond precision, and "inf" or "Infinity" is
4398      allowed, which means the end of the video.
4399    timeSegmentStart: The beginning, inclusive, of the video's time segment on
4400      which to perform the prediction. Expressed as a number of seconds as
4401      measured from the start of the video, with "s" appended at the end.
4402      Fractions are allowed, up to a microsecond precision.
4403  """
4404
4405  content = _messages.StringField(1)
4406  mimeType = _messages.StringField(2)
4407  timeSegmentEnd = _messages.StringField(3)
4408  timeSegmentStart = _messages.StringField(4)
4409
4410
4411class GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance(_messages.Message):
4412  r"""Prediction input format for Video Classification.
4413
4414  Fields:
4415    content: The Google Cloud Storage location of the video on which to
4416      perform the prediction.
4417    mimeType: The MIME type of the content of the video. Only the following
4418      are supported: video/mp4 video/avi video/quicktime
4419    timeSegmentEnd: The end, exclusive, of the video's time segment on which
4420      to perform the prediction. Expressed as a number of seconds as measured
4421      from the start of the video, with "s" appended at the end. Fractions are
4422      allowed, up to a microsecond precision, and "inf" or "Infinity" is
4423      allowed, which means the end of the video.
4424    timeSegmentStart: The beginning, inclusive, of the video's time segment on
4425      which to perform the prediction. Expressed as a number of seconds as
4426      measured from the start of the video, with "s" appended at the end.
4427      Fractions are allowed, up to a microsecond precision.
4428  """
4429
4430  content = _messages.StringField(1)
4431  mimeType = _messages.StringField(2)
4432  timeSegmentEnd = _messages.StringField(3)
4433  timeSegmentStart = _messages.StringField(4)
4434
4435
4436class GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance(_messages.Message):
4437  r"""Prediction input format for Video Object Tracking.
4438
4439  Fields:
4440    content: The Google Cloud Storage location of the video on which to
4441      perform the prediction.
4442    mimeType: The MIME type of the content of the video. Only the following
4443      are supported: video/mp4 video/avi video/quicktime
4444    timeSegmentEnd: The end, exclusive, of the video's time segment on which
4445      to perform the prediction. Expressed as a number of seconds as measured
4446      from the start of the video, with "s" appended at the end. Fractions are
4447      allowed, up to a microsecond precision, and "inf" or "Infinity" is
4448      allowed, which means the end of the video.
4449    timeSegmentStart: The beginning, inclusive, of the video's time segment on
4450      which to perform the prediction. Expressed as a number of seconds as
4451      measured from the start of the video, with "s" appended at the end.
4452      Fractions are allowed, up to a microsecond precision.
4453  """
4454
4455  content = _messages.StringField(1)
4456  mimeType = _messages.StringField(2)
4457  timeSegmentEnd = _messages.StringField(3)
4458  timeSegmentStart = _messages.StringField(4)
4459
4460
4461class GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams(_messages.Message):
4462  r"""Prediction model parameters for Image Classification.
4463
4464  Fields:
4465    confidenceThreshold: The Model only returns predictions with at least this
4466      confidence score. Default value is 0.0
4467    maxPredictions: The Model only returns up to that many top, by confidence
4468      score, predictions per instance. If this number is very high, the Model
4469      may return fewer predictions. Default value is 10.
4470  """
4471
4472  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4473  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
4474
4475
4476class GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams(_messages.Message):
4477  r"""Prediction model parameters for Image Object Detection.
4478
4479  Fields:
4480    confidenceThreshold: The Model only returns predictions with at least this
4481      confidence score. Default value is 0.0
4482    maxPredictions: The Model only returns up to that many top, by confidence
4483      score, predictions per instance. Note that number of returned
4484      predictions is also limited by metadata's predictionsLimit. Default
4485      value is 10.
4486  """
4487
4488  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4489  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
4490
4491
4492class GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams(_messages.Message):
4493  r"""Prediction model parameters for Image Segmentation.
4494
4495  Fields:
4496    confidenceThreshold: When the model predicts category of pixels of the
4497      image, it will only provide predictions for pixels that it is at least
4498      this much confident about. All other pixels will be classified as
4499      background. Default value is 0.5.
4500  """
4501
4502  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4503
4504
4505class GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams(_messages.Message):
4506  r"""Prediction model parameters for Video Action Recognition.
4507
4508  Fields:
4509    confidenceThreshold: The Model only returns predictions with at least this
4510      confidence score. Default value is 0.0
4511    maxPredictions: The model only returns up to that many top, by confidence
4512      score, predictions per frame of the video. If this number is very high,
4513      the Model may return fewer predictions per frame. Default value is 50.
4514  """
4515
4516  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4517  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
4518
4519
4520class GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams(_messages.Message):
4521  r"""Prediction model parameters for Video Classification.
4522
4523  Fields:
4524    confidenceThreshold: The Model only returns predictions with at least this
4525      confidence score. Default value is 0.0
4526    maxPredictions: The Model only returns up to that many top, by confidence
4527      score, predictions per instance. If this number is very high, the Model
4528      may return fewer predictions. Default value is 10,000.
4529    oneSecIntervalClassification: Set to true to request classification for a
4530      video at one-second intervals. AI Platform returns labels and their
4531      confidence scores for each second of the entire time segment of the
4532      video that user specified in the input WARNING: Model evaluation is not
4533      done for this classification type, the quality of it depends on the
4534      training data, but there are no metrics provided to describe that
4535      quality. Default value is false
4536    segmentClassification: Set to true to request segment-level
4537      classification. AI Platform returns labels and their confidence scores
4538      for the entire time segment of the video that user specified in the
4539      input instance. Default value is true
4540    shotClassification: Set to true to request shot-level classification. AI
4541      Platform determines the boundaries for each camera shot in the entire
4542      time segment of the video that user specified in the input instance. AI
4543      Platform then returns labels and their confidence scores for each
4544      detected shot, along with the start and end time of the shot. WARNING:
4545      Model evaluation is not done for this classification type, the quality
4546      of it depends on the training data, but there are no metrics provided to
4547      describe that quality. Default value is false
4548  """
4549
4550  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4551  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
4552  oneSecIntervalClassification = _messages.BooleanField(3)
4553  segmentClassification = _messages.BooleanField(4)
4554  shotClassification = _messages.BooleanField(5)
4555
4556
4557class GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams(_messages.Message):
4558  r"""Prediction model parameters for Video Object Tracking.
4559
4560  Fields:
4561    confidenceThreshold: The Model only returns predictions with at least this
4562      confidence score. Default value is 0.0
4563    maxPredictions: The model only returns up to that many top, by confidence
4564      score, predictions per frame of the video. If this number is very high,
4565      the Model may return fewer predictions per frame. Default value is 50.
4566    minBoundingBoxSize: Only bounding boxes with shortest edge at least that
4567      long as a relative value of video frame size are returned. Default value
4568      is 0.0.
4569  """
4570
4571  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4572  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
4573  minBoundingBoxSize = _messages.FloatField(3, variant=_messages.Variant.FLOAT)
4574
4575
4576class GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult(_messages.Message):
4577  r"""Prediction output format for Image and Text Classification.
4578
4579  Fields:
4580    confidences: The Model's confidences in correctness of the predicted IDs,
4581      higher value means higher confidence. Order matches the Ids.
4582    displayNames: The display names of the AnnotationSpecs that had been
4583      identified, order matches the IDs.
4584    ids: The resource IDs of the AnnotationSpecs that had been identified,
4585      ordered by the confidence score descendingly.
4586  """
4587
4588  confidences = _messages.FloatField(1, repeated=True, variant=_messages.Variant.FLOAT)
4589  displayNames = _messages.StringField(2, repeated=True)
4590  ids = _messages.IntegerField(3, repeated=True)
4591
4592
4593class GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult(_messages.Message):
4594  r"""Prediction output format for Image Object Detection.
4595
4596  Messages:
4597    BboxesValueListEntry: Single entry in a BboxesValue.
4598
4599  Fields:
4600    bboxes: Bounding boxes, i.e. the rectangles over the image, that pinpoint
4601      the found AnnotationSpecs. Given in order that matches the IDs. Each
4602      bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and
4603      `yMax`, which represent the extremal coordinates of the box. They are
4604      relative to the image size, and the point 0,0 is in the top left of the
4605      image.
4606    confidences: The Model's confidences in correctness of the predicted IDs,
4607      higher value means higher confidence. Order matches the Ids.
4608    displayNames: The display names of the AnnotationSpecs that had been
4609      identified, order matches the IDs.
4610    ids: The resource IDs of the AnnotationSpecs that had been identified,
4611      ordered by the confidence score descendingly.
4612  """
4613
4614  class BboxesValueListEntry(_messages.Message):
4615    r"""Single entry in a BboxesValue.
4616
4617    Fields:
4618      entry: A extra_types.JsonValue attribute.
4619    """
4620
4621    entry = _messages.MessageField('extra_types.JsonValue', 1, repeated=True)
4622
4623  bboxes = _messages.MessageField('BboxesValueListEntry', 1, repeated=True)
4624  confidences = _messages.FloatField(2, repeated=True, variant=_messages.Variant.FLOAT)
4625  displayNames = _messages.StringField(3, repeated=True)
4626  ids = _messages.IntegerField(4, repeated=True)
4627
4628
4629class GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult(_messages.Message):
4630  r"""Prediction output format for Image Segmentation.
4631
4632  Fields:
4633    categoryMask: A PNG image where each pixel in the mask represents the
4634      category in which the pixel in the original image was predicted to
4635      belong to. The size of this image will be the same as the original
4636      image. The mapping between the AnntoationSpec and the color can be found
4637      in model's metadata. The model will choose the most likely category and
4638      if none of the categories reach the confidence threshold, the pixel will
4639      be marked as background.
4640    confidenceMask: A one channel image which is encoded as an 8bit lossless
4641      PNG. The size of the image will be the same as the original image. For a
4642      specific pixel, darker color means less confidence in correctness of the
4643      cateogry in the categoryMask for the corresponding pixel. Black means no
4644      confidence and white means complete confidence.
4645  """
4646
4647  categoryMask = _messages.StringField(1)
4648  confidenceMask = _messages.StringField(2)
4649
4650
4651class GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult(_messages.Message):
4652  r"""Prediction output format for Tabular Classification.
4653
4654  Fields:
4655    classes: The name of the classes being classified, contains all possible
4656      values of the target column.
4657    scores: The model's confidence in each class being correct, higher value
4658      means higher confidence. The N-th score corresponds to the N-th class in
4659      classes.
4660  """
4661
4662  classes = _messages.StringField(1, repeated=True)
4663  scores = _messages.FloatField(2, repeated=True, variant=_messages.Variant.FLOAT)
4664
4665
4666class GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult(_messages.Message):
4667  r"""Prediction output format for Tabular Regression.
4668
4669  Fields:
4670    lowerBound: The lower bound of the prediction interval.
4671    upperBound: The upper bound of the prediction interval.
4672    value: The regression value.
4673  """
4674
4675  lowerBound = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4676  upperBound = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
4677  value = _messages.FloatField(3, variant=_messages.Variant.FLOAT)
4678
4679
4680class GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult(_messages.Message):
4681  r"""Prediction output format for Text Extraction.
4682
4683  Fields:
4684    confidences: The Model's confidences in correctness of the predicted IDs,
4685      higher value means higher confidence. Order matches the Ids.
4686    displayNames: The display names of the AnnotationSpecs that had been
4687      identified, order matches the IDs.
4688    ids: The resource IDs of the AnnotationSpecs that had been identified,
4689      ordered by the confidence score descendingly.
4690    textSegmentEndOffsets: The end offsets, inclusive, of the text segment in
4691      which the AnnotationSpec has been identified. Expressed as a zero-based
4692      number of characters as measured from the start of the text snippet.
4693    textSegmentStartOffsets: The start offsets, inclusive, of the text segment
4694      in which the AnnotationSpec has been identified. Expressed as a zero-
4695      based number of characters as measured from the start of the text
4696      snippet.
4697  """
4698
4699  confidences = _messages.FloatField(1, repeated=True, variant=_messages.Variant.FLOAT)
4700  displayNames = _messages.StringField(2, repeated=True)
4701  ids = _messages.IntegerField(3, repeated=True)
4702  textSegmentEndOffsets = _messages.IntegerField(4, repeated=True)
4703  textSegmentStartOffsets = _messages.IntegerField(5, repeated=True)
4704
4705
4706class GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult(_messages.Message):
4707  r"""Prediction output format for Text Sentiment
4708
4709  Fields:
4710    sentiment: The integer sentiment labels between 0 (inclusive) and
4711      sentimentMax label (inclusive), while 0 maps to the least positive
4712      sentiment and sentimentMax maps to the most positive one. The higher the
4713      score is, the more positive the sentiment in the text snippet is. Note:
4714      sentimentMax is an integer value between 1 (inclusive) and 10
4715      (inclusive).
4716  """
4717
4718  sentiment = _messages.IntegerField(1, variant=_messages.Variant.INT32)
4719
4720
4721class GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult(_messages.Message):
4722  r"""Prediction output format for Time Series Forecasting.
4723
4724  Fields:
4725    value: The regression value.
4726  """
4727
4728  value = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4729
4730
4731class GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult(_messages.Message):
4732  r"""Prediction output format for Video Action Recognition.
4733
4734  Fields:
4735    confidence: The Model's confidence in correction of this prediction,
4736      higher value means higher confidence.
4737    displayName: The display name of the AnnotationSpec that had been
4738      identified.
4739    id: The resource ID of the AnnotationSpec that had been identified.
4740    timeSegmentEnd: The end, exclusive, of the video's time segment in which
4741      the AnnotationSpec has been identified. Expressed as a number of seconds
4742      as measured from the start of the video, with fractions up to a
4743      microsecond precision, and with "s" appended at the end.
4744    timeSegmentStart: The beginning, inclusive, of the video's time segment in
4745      which the AnnotationSpec has been identified. Expressed as a number of
4746      seconds as measured from the start of the video, with fractions up to a
4747      microsecond precision, and with "s" appended at the end.
4748  """
4749
4750  confidence = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4751  displayName = _messages.StringField(2)
4752  id = _messages.StringField(3)
4753  timeSegmentEnd = _messages.StringField(4)
4754  timeSegmentStart = _messages.StringField(5)
4755
4756
4757class GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult(_messages.Message):
4758  r"""Prediction output format for Video Classification.
4759
4760  Fields:
4761    confidence: The Model's confidence in correction of this prediction,
4762      higher value means higher confidence.
4763    displayName: The display name of the AnnotationSpec that had been
4764      identified.
4765    id: The resource ID of the AnnotationSpec that had been identified.
4766    timeSegmentEnd: The end, exclusive, of the video's time segment in which
4767      the AnnotationSpec has been identified. Expressed as a number of seconds
4768      as measured from the start of the video, with fractions up to a
4769      microsecond precision, and with "s" appended at the end. Note that for
4770      'segment-classification' prediction type, this equals the original
4771      'timeSegmentEnd' from the input instance, for other types it is the end
4772      of a shot or a 1 second interval respectively.
4773    timeSegmentStart: The beginning, inclusive, of the video's time segment in
4774      which the AnnotationSpec has been identified. Expressed as a number of
4775      seconds as measured from the start of the video, with fractions up to a
4776      microsecond precision, and with "s" appended at the end. Note that for
4777      'segment-classification' prediction type, this equals the original
4778      'timeSegmentStart' from the input instance, for other types it is the
4779      start of a shot or a 1 second interval respectively.
4780    type: The type of the prediction. The requested types can be configured
4781      via parameters. This will be one of - segment-classification - shot-
4782      classification - one-sec-interval-classification
4783  """
4784
4785  confidence = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4786  displayName = _messages.StringField(2)
4787  id = _messages.StringField(3)
4788  timeSegmentEnd = _messages.StringField(4)
4789  timeSegmentStart = _messages.StringField(5)
4790  type = _messages.StringField(6)
4791
4792
4793class GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult(_messages.Message):
4794  r"""Prediction output format for Video Object Tracking.
4795
4796  Fields:
4797    confidence: The Model's confidence in correction of this prediction,
4798      higher value means higher confidence.
4799    displayName: The display name of the AnnotationSpec that had been
4800      identified.
4801    frames: All of the frames of the video in which a single object instance
4802      has been detected. The bounding boxes in the frames identify the same
4803      object.
4804    id: The resource ID of the AnnotationSpec that had been identified.
4805    timeSegmentEnd: The end, inclusive, of the video's time segment in which
4806      the object instance has been detected. Expressed as a number of seconds
4807      as measured from the start of the video, with fractions up to a
4808      microsecond precision, and with "s" appended at the end.
4809    timeSegmentStart: The beginning, inclusive, of the video's time segment in
4810      which the object instance has been detected. Expressed as a number of
4811      seconds as measured from the start of the video, with fractions up to a
4812      microsecond precision, and with "s" appended at the end.
4813  """
4814
4815  confidence = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
4816  displayName = _messages.StringField(2)
4817  frames = _messages.MessageField('GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame', 3, repeated=True)
4818  id = _messages.StringField(4)
4819  timeSegmentEnd = _messages.StringField(5)
4820  timeSegmentStart = _messages.StringField(6)
4821
4822
4823class GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame(_messages.Message):
4824  r"""The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box,
4825  i.e. the rectangle over the video frame pinpointing the found
4826  AnnotationSpec. The coordinates are relative to the frame size, and the
4827  point 0,0 is in the top left of the frame.
4828
4829  Fields:
4830    timeOffset: A time (frame) of a video in which the object has been
4831      detected. Expressed as a number of seconds as measured from the start of
4832      the video, with fractions up to a microsecond precision, and with "s"
4833      appended at the end.
4834    xMax: The rightmost coordinate of the bounding box.
4835    xMin: The leftmost coordinate of the bounding box.
4836    yMax: The bottommost coordinate of the bounding box.
4837    yMin: The topmost coordinate of the bounding box.
4838  """
4839
4840  timeOffset = _messages.StringField(1)
4841  xMax = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
4842  xMin = _messages.FloatField(3, variant=_messages.Variant.FLOAT)
4843  yMax = _messages.FloatField(4, variant=_messages.Variant.FLOAT)
4844  yMin = _messages.FloatField(5, variant=_messages.Variant.FLOAT)
4845
4846
4847class GoogleCloudAiplatformV1SchemaPredictionResult(_messages.Message):
4848  r"""Represents a line of JSONL in the batch prediction output file.
4849
4850  Messages:
4851    InstanceValue: User's input instance. Struct is used here instead of Any
4852      so that JsonFormat does not append an extra "@type" field when we
4853      convert the proto to JSON.
4854
4855  Fields:
4856    error: The error result. Do not set prediction if this is set.
4857    instance: User's input instance. Struct is used here instead of Any so
4858      that JsonFormat does not append an extra "@type" field when we convert
4859      the proto to JSON.
4860    key: Optional user-provided key from the input instance.
4861    prediction: The prediction result. Value is used here instead of Any so
4862      that JsonFormat does not append an extra "@type" field when we convert
4863      the proto to JSON and so we can represent array of objects. Do not set
4864      error if this is set.
4865  """
4866
4867  @encoding.MapUnrecognizedFields('additionalProperties')
4868  class InstanceValue(_messages.Message):
4869    r"""User's input instance. Struct is used here instead of Any so that
4870    JsonFormat does not append an extra "@type" field when we convert the
4871    proto to JSON.
4872
4873    Messages:
4874      AdditionalProperty: An additional property for a InstanceValue object.
4875
4876    Fields:
4877      additionalProperties: Properties of the object.
4878    """
4879
4880    class AdditionalProperty(_messages.Message):
4881      r"""An additional property for a InstanceValue object.
4882
4883      Fields:
4884        key: Name of the additional property.
4885        value: A extra_types.JsonValue attribute.
4886      """
4887
4888      key = _messages.StringField(1)
4889      value = _messages.MessageField('extra_types.JsonValue', 2)
4890
4891    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
4892
4893  error = _messages.MessageField('GoogleCloudAiplatformV1SchemaPredictionResultError', 1)
4894  instance = _messages.MessageField('InstanceValue', 2)
4895  key = _messages.StringField(3)
4896  prediction = _messages.MessageField('extra_types.JsonValue', 4)
4897
4898
4899class GoogleCloudAiplatformV1SchemaPredictionResultError(_messages.Message):
4900  r"""A GoogleCloudAiplatformV1SchemaPredictionResultError object.
4901
4902  Enums:
4903    StatusValueValuesEnum: Error status. This will be serialized into the enum
4904      name e.g. "NOT_FOUND".
4905
4906  Fields:
4907    message: Error message with additional details.
4908    status: Error status. This will be serialized into the enum name e.g.
4909      "NOT_FOUND".
4910  """
4911
4912  class StatusValueValuesEnum(_messages.Enum):
4913    r"""Error status. This will be serialized into the enum name e.g.
4914    "NOT_FOUND".
4915
4916    Values:
4917      OK: Not an error; returned on success HTTP Mapping: 200 OK
4918      CANCELLED: The operation was cancelled, typically by the caller. HTTP
4919        Mapping: 499 Client Closed Request
4920      UNKNOWN: Unknown error. For example, this error may be returned when a
4921        `Status` value received from another address space belongs to an error
4922        space that is not known in this address space. Also errors raised by
4923        APIs that do not return enough error information may be converted to
4924        this error. HTTP Mapping: 500 Internal Server Error
4925      INVALID_ARGUMENT: The client specified an invalid argument. Note that
4926        this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates
4927        arguments that are problematic regardless of the state of the system
4928        (e.g., a malformed file name). HTTP Mapping: 400 Bad Request
4929      DEADLINE_EXCEEDED: The deadline expired before the operation could
4930        complete. For operations that change the state of the system, this
4931        error may be returned even if the operation has completed
4932        successfully. For example, a successful response from a server could
4933        have been delayed long enough for the deadline to expire. HTTP
4934        Mapping: 504 Gateway Timeout
4935      NOT_FOUND: Some requested entity (e.g., file or directory) was not
4936        found. Note to server developers: if a request is denied for an entire
4937        class of users, such as gradual feature rollout or undocumented
4938        allowlist, `NOT_FOUND` may be used. If a request is denied for some
4939        users within a class of users, such as user-based access control,
4940        `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found
4941      ALREADY_EXISTS: The entity that a client attempted to create (e.g., file
4942        or directory) already exists. HTTP Mapping: 409 Conflict
4943      PERMISSION_DENIED: The caller does not have permission to execute the
4944        specified operation. `PERMISSION_DENIED` must not be used for
4945        rejections caused by exhausting some resource (use
4946        `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED`
4947        must not be used if the caller can not be identified (use
4948        `UNAUTHENTICATED` instead for those errors). This error code does not
4949        imply the request is valid or the requested entity exists or satisfies
4950        other pre-conditions. HTTP Mapping: 403 Forbidden
4951      UNAUTHENTICATED: The request does not have valid authentication
4952        credentials for the operation. HTTP Mapping: 401 Unauthorized
4953      RESOURCE_EXHAUSTED: Some resource has been exhausted, perhaps a per-user
4954        quota, or perhaps the entire file system is out of space. HTTP
4955        Mapping: 429 Too Many Requests
4956      FAILED_PRECONDITION: The operation was rejected because the system is
4957        not in a state required for the operation's execution. For example,
4958        the directory to be deleted is non-empty, an rmdir operation is
4959        applied to a non-directory, etc. Service implementors can use the
4960        following guidelines to decide between `FAILED_PRECONDITION`,
4961        `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can
4962        retry just the failing call. (b) Use `ABORTED` if the client should
4963        retry at a higher level (e.g., when a client-specified test-and-set
4964        fails, indicating the client should restart a read-modify-write
4965        sequence). (c) Use `FAILED_PRECONDITION` if the client should not
4966        retry until the system state has been explicitly fixed. E.g., if an
4967        "rmdir" fails because the directory is non-empty,
4968        `FAILED_PRECONDITION` should be returned since the client should not
4969        retry unless the files are deleted from the directory. HTTP Mapping:
4970        400 Bad Request
4971      ABORTED: The operation was aborted, typically due to a concurrency issue
4972        such as a sequencer check failure or transaction abort. See the
4973        guidelines above for deciding between `FAILED_PRECONDITION`,
4974        `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict
4975      OUT_OF_RANGE: The operation was attempted past the valid range. E.g.,
4976        seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this
4977        error indicates a problem that may be fixed if the system state
4978        changes. For example, a 32-bit file system will generate
4979        `INVALID_ARGUMENT` if asked to read at an offset that is not in the
4980        range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read
4981        from an offset past the current file size. There is a fair bit of
4982        overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend
4983        using `OUT_OF_RANGE` (the more specific error) when it applies so that
4984        callers who are iterating through a space can easily look for an
4985        `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400
4986        Bad Request
4987      UNIMPLEMENTED: The operation is not implemented or is not
4988        supported/enabled in this service. HTTP Mapping: 501 Not Implemented
4989      INTERNAL: Internal errors. This means that some invariants expected by
4990        the underlying system have been broken. This error code is reserved
4991        for serious errors. HTTP Mapping: 500 Internal Server Error
4992      UNAVAILABLE: The service is currently unavailable. This is most likely a
4993        transient condition, which can be corrected by retrying with a
4994        backoff. Note that it is not always safe to retry non-idempotent
4995        operations. See the guidelines above for deciding between
4996        `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503
4997        Service Unavailable
4998      DATA_LOSS: Unrecoverable data loss or corruption. HTTP Mapping: 500
4999        Internal Server Error
5000    """
5001    OK = 0
5002    CANCELLED = 1
5003    UNKNOWN = 2
5004    INVALID_ARGUMENT = 3
5005    DEADLINE_EXCEEDED = 4
5006    NOT_FOUND = 5
5007    ALREADY_EXISTS = 6
5008    PERMISSION_DENIED = 7
5009    UNAUTHENTICATED = 8
5010    RESOURCE_EXHAUSTED = 9
5011    FAILED_PRECONDITION = 10
5012    ABORTED = 11
5013    OUT_OF_RANGE = 12
5014    UNIMPLEMENTED = 13
5015    INTERNAL = 14
5016    UNAVAILABLE = 15
5017    DATA_LOSS = 16
5018
5019  message = _messages.StringField(1)
5020  status = _messages.EnumField('StatusValueValuesEnum', 2)
5021
5022
5023class GoogleCloudAiplatformV1SchemaTablesDatasetMetadata(_messages.Message):
5024  r"""The metadata of Datasets that contain tables data.
5025
5026  Fields:
5027    inputConfig: A
5028      GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig attribute.
5029  """
5030
5031  inputConfig = _messages.MessageField('GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig', 1)
5032
5033
5034class GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource(_messages.Message):
5035  r"""A GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource
5036  object.
5037
5038  Fields:
5039    uri: The URI of a BigQuery table. e.g.
5040      bq://projectId.bqDatasetId.bqTableId
5041  """
5042
5043  uri = _messages.StringField(1)
5044
5045
5046class GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource(_messages.Message):
5047  r"""A GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource object.
5048
5049  Fields:
5050    uri: Cloud Storage URI of one or more files. Only CSV files are supported.
5051      The first line of the CSV file is used as the header. If there are
5052      multiple files, the header is the first line of the lexicographically
5053      first file, the other files must either contain the exact same header or
5054      omit the header.
5055  """
5056
5057  uri = _messages.StringField(1, repeated=True)
5058
5059
5060class GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig(_messages.Message):
5061  r"""The tables Dataset's data source. The Dataset doesn't store the data
5062  directly, but only pointer(s) to its data.
5063
5064  Fields:
5065    bigquerySource: A
5066      GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource
5067      attribute.
5068    gcsSource: A GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource
5069      attribute.
5070  """
5071
5072  bigquerySource = _messages.MessageField('GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource', 1)
5073  gcsSource = _messages.MessageField('GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource', 2)
5074
5075
5076class GoogleCloudAiplatformV1SchemaTextClassificationAnnotation(_messages.Message):
5077  r"""Annotation details specific to text classification.
5078
5079  Fields:
5080    annotationSpecId: The resource Id of the AnnotationSpec that this
5081      Annotation pertains to.
5082    displayName: The display name of the AnnotationSpec that this Annotation
5083      pertains to.
5084  """
5085
5086  annotationSpecId = _messages.StringField(1)
5087  displayName = _messages.StringField(2)
5088
5089
5090class GoogleCloudAiplatformV1SchemaTextDataItem(_messages.Message):
5091  r"""Payload of Text DataItem.
5092
5093  Fields:
5094    gcsUri: Output only. Google Cloud Storage URI points to the original text
5095      in user's bucket. The text file is up to 10MB in size.
5096  """
5097
5098  gcsUri = _messages.StringField(1)
5099
5100
5101class GoogleCloudAiplatformV1SchemaTextDatasetMetadata(_messages.Message):
5102  r"""The metadata of Datasets that contain Text DataItems.
5103
5104  Fields:
5105    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
5106      describing payload of the Text DataItems that belong to this Dataset.
5107    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
5108      this Dataset.
5109  """
5110
5111  dataItemSchemaUri = _messages.StringField(1)
5112  gcsBucket = _messages.StringField(2)
5113
5114
5115class GoogleCloudAiplatformV1SchemaTextExtractionAnnotation(_messages.Message):
5116  r"""Annotation details specific to text extraction.
5117
5118  Fields:
5119    annotationSpecId: The resource Id of the AnnotationSpec that this
5120      Annotation pertains to.
5121    displayName: The display name of the AnnotationSpec that this Annotation
5122      pertains to.
5123    textSegment: The segment of the text content.
5124  """
5125
5126  annotationSpecId = _messages.StringField(1)
5127  displayName = _messages.StringField(2)
5128  textSegment = _messages.MessageField('GoogleCloudAiplatformV1SchemaTextSegment', 3)
5129
5130
5131class GoogleCloudAiplatformV1SchemaTextSegment(_messages.Message):
5132  r"""The text segment inside of DataItem.
5133
5134  Fields:
5135    content: The text content in the segment for output only.
5136    endOffset: Zero-based character index of the first character past the end
5137      of the text segment (counting character from the beginning of the text).
5138      The character at the end_offset is NOT included in the text segment.
5139    startOffset: Zero-based character index of the first character of the text
5140      segment (counting characters from the beginning of the text).
5141  """
5142
5143  content = _messages.StringField(1)
5144  endOffset = _messages.IntegerField(2, variant=_messages.Variant.UINT64)
5145  startOffset = _messages.IntegerField(3, variant=_messages.Variant.UINT64)
5146
5147
5148class GoogleCloudAiplatformV1SchemaTextSentimentAnnotation(_messages.Message):
5149  r"""Annotation details specific to text sentiment.
5150
5151  Fields:
5152    annotationSpecId: The resource Id of the AnnotationSpec that this
5153      Annotation pertains to.
5154    displayName: The display name of the AnnotationSpec that this Annotation
5155      pertains to.
5156    sentiment: The sentiment score for text.
5157    sentimentMax: The sentiment max score for text.
5158  """
5159
5160  annotationSpecId = _messages.StringField(1)
5161  displayName = _messages.StringField(2)
5162  sentiment = _messages.IntegerField(3, variant=_messages.Variant.INT32)
5163  sentimentMax = _messages.IntegerField(4, variant=_messages.Variant.INT32)
5164
5165
5166class GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata(_messages.Message):
5167  r"""The metadata of SavedQuery contains TextSentiment Annotations.
5168
5169  Fields:
5170    sentimentMax: The maximum sentiment of sentiment Anntoation in this
5171      SavedQuery.
5172  """
5173
5174  sentimentMax = _messages.IntegerField(1, variant=_messages.Variant.INT32)
5175
5176
5177class GoogleCloudAiplatformV1SchemaTimeSegment(_messages.Message):
5178  r"""A time period inside of a DataItem that has a time dimension (e.g.
5179  video).
5180
5181  Fields:
5182    endTimeOffset: End of the time segment (exclusive), represented as the
5183      duration since the start of the DataItem.
5184    startTimeOffset: Start of the time segment (inclusive), represented as the
5185      duration since the start of the DataItem.
5186  """
5187
5188  endTimeOffset = _messages.StringField(1)
5189  startTimeOffset = _messages.StringField(2)
5190
5191
5192class GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata(_messages.Message):
5193  r"""The metadata of Datasets that contain time series data.
5194
5195  Fields:
5196    inputConfig: A
5197      GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig
5198      attribute.
5199    timeColumn: The column name of the time column that identifies time order
5200      in the time series.
5201    timeSeriesIdentifierColumn: The column name of the time series identifier
5202      column that identifies the time series.
5203  """
5204
5205  inputConfig = _messages.MessageField('GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig', 1)
5206  timeColumn = _messages.StringField(2)
5207  timeSeriesIdentifierColumn = _messages.StringField(3)
5208
5209
5210class GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource(_messages.Message):
5211  r"""A GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource
5212  object.
5213
5214  Fields:
5215    uri: The URI of a BigQuery table.
5216  """
5217
5218  uri = _messages.StringField(1)
5219
5220
5221class GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource(_messages.Message):
5222  r"""A GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource
5223  object.
5224
5225  Fields:
5226    uri: Cloud Storage URI of one or more files. Only CSV files are supported.
5227      The first line of the CSV file is used as the header. If there are
5228      multiple files, the header is the first line of the lexicographically
5229      first file, the other files must either contain the exact same header or
5230      omit the header.
5231  """
5232
5233  uri = _messages.StringField(1, repeated=True)
5234
5235
5236class GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig(_messages.Message):
5237  r"""The time series Dataset's data source. The Dataset doesn't store the
5238  data directly, but only pointer(s) to its data.
5239
5240  Fields:
5241    bigquerySource: A
5242      GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource
5243      attribute.
5244    gcsSource: A
5245      GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource
5246      attribute.
5247  """
5248
5249  bigquerySource = _messages.MessageField('GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource', 1)
5250  gcsSource = _messages.MessageField('GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource', 2)
5251
5252
5253class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting(_messages.Message):
5254  r"""A TrainingJob that trains and uploads an AutoML Forecasting Model.
5255
5256  Fields:
5257    inputs: The input parameters of this TrainingJob.
5258    metadata: The metadata information.
5259  """
5260
5261  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs', 1)
5262  metadata = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata', 2)
5263
5264
5265class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs(_messages.Message):
5266  r"""A
5267  GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs
5268  object.
5269
5270  Fields:
5271    exportEvaluatedDataItemsConfig: Configuration for exporting test set
5272      predictions to a BigQuery table. If this configuration is absent, then
5273      the export is not performed.
5274    forecastWindowEnd: The number of periods offset into the future as the end
5275      of the forecast window (the window of future values to predict, relative
5276      to the present.), where each period is one unit of granularity as
5277      defined by the `period` field above. Inclusive.
5278    forecastWindowStart: The number of periods offset into the future as the
5279      start of the forecast window (the window of future values to predict,
5280      relative to the present.), where each period is one unit of granularity
5281      as defined by the `period` field above. Default to 0. Inclusive.
5282    optimizationObjective: Objective function the model is optimizing towards.
5283      The training process creates a model that optimizes the value of the
5284      objective function over the validation set. The supported optimization
5285      objectives: "minimize-rmse" (default) - Minimize root-mean-squared error
5286      (RMSE). "minimize-mae" - Minimize mean-absolute error (MAE). "minimize-
5287      rmsle" - Minimize root-mean-squared log error (RMSLE). "minimize-rmspe"
5288      - Minimize root-mean-squared percentage error (RMSPE). "minimize-wape-
5289      mae" - Minimize the combination of weighted absolute percentage error
5290      (WAPE) and mean-absolute-error (MAE). "minimize-quantile-loss" -
5291      Minimize the quantile loss at the quantiles defined in `quantiles`.
5292    pastHorizon: The number of periods offset into the past to restrict past
5293      sequence, where each period is one unit of granularity as defined by the
5294      `period`. Default value 0 means that it lets algorithm to define the
5295      value. Inclusive.
5296    period: Expected difference in time granularity between rows in the data.
5297      If it is not set, the period is inferred from data.
5298    quantiles: Quantiles to use for minimize-quantile-loss
5299      `optimization_objective`. Up to 5 quantiles are allowed of values
5300      between 0 and 1, exclusive. Required if the value of
5301      optimization_objective is minimize-quantile-loss. Represents the percent
5302      quantiles to use for that objective. Quantiles must be unique.
5303    staticColumns: Column names that should be used as static columns. The
5304      value of these columns are static per time series.
5305    targetColumn: The name of the column that the model is to predict.
5306    timeColumn: The name of the column that identifies time order in the time
5307      series.
5308    timeSeriesIdentifierColumn: The name of the column that identifies the
5309      time series.
5310    timeVariantPastAndFutureColumns: Column names that should be used as time
5311      variant past and future columns. This column contains information for
5312      the given entity (identified by the key column) that is known for the
5313      past and the future
5314    timeVariantPastOnlyColumns: Column names that should be used as time
5315      variant past only columns. This column contains information for the
5316      given entity (identified by the time_series_identifier_column) that is
5317      known for the past but not the future (e.g. population of a city in a
5318      given year, or weather on a given day).
5319    trainBudgetMilliNodeHours: Required. The train budget of creating this
5320      model, expressed in milli node hours i.e. 1,000 value in this field
5321      means 1 node hour. The training cost of the model will not exceed this
5322      budget. The final cost will be attempted to be close to the budget,
5323      though may end up being (even) noticeably smaller - at the backend's
5324      discretion. This especially may happen when further model training
5325      ceases to provide any improvements. If the budget is set to a value
5326      known to be insufficient to train a model for the given dataset, the
5327      training won't be attempted and will error. The train budget must be
5328      between 1,000 and 72,000 milli node hours, inclusive.
5329    transformations: Each transformation will apply transform function to
5330      given input column. And the result will be used for training. When
5331      creating transformation for BigQuery Struct column, the column should be
5332      flattened using "." as the delimiter.
5333    validationOptions: Validation options for the data validation component.
5334      The available options are: "fail-pipeline" - default, will validate
5335      against the validation and fail the pipeline if it fails. "ignore-
5336      validation" - ignore the results of the validation and continue
5337    weightColumn: Column name that should be used as the weight column. Higher
5338      values in this column give more importance to the row during model
5339      training. The column must have numeric values between 0 and 10000
5340      inclusively; 0 means the row is ignored for training. If weight column
5341      field is not set, then all rows are assumed to have equal weight of 1.
5342  """
5343
5344  exportEvaluatedDataItemsConfig = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig', 1)
5345  forecastWindowEnd = _messages.IntegerField(2)
5346  forecastWindowStart = _messages.IntegerField(3)
5347  optimizationObjective = _messages.StringField(4)
5348  pastHorizon = _messages.IntegerField(5)
5349  period = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsPeriod', 6)
5350  quantiles = _messages.FloatField(7, repeated=True)
5351  staticColumns = _messages.StringField(8, repeated=True)
5352  targetColumn = _messages.StringField(9)
5353  timeColumn = _messages.StringField(10)
5354  timeSeriesIdentifierColumn = _messages.StringField(11)
5355  timeVariantPastAndFutureColumns = _messages.StringField(12, repeated=True)
5356  timeVariantPastOnlyColumns = _messages.StringField(13, repeated=True)
5357  trainBudgetMilliNodeHours = _messages.IntegerField(14)
5358  transformations = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation', 15, repeated=True)
5359  validationOptions = _messages.StringField(16)
5360  weightColumn = _messages.StringField(17)
5361
5362
5363class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsPeriod(_messages.Message):
5364  r"""A duration of time expressed in time granularity units.
5365
5366  Fields:
5367    quantity: The number of units per period, e.g. 3 weeks or 2 months.
5368    unit: The time granularity unit of this time period. The supported unit
5369      are: "minute" "hour" "day" "week" "month" "year"
5370  """
5371
5372  quantity = _messages.IntegerField(1)
5373  unit = _messages.StringField(2)
5374
5375
5376class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation(_messages.Message):
5377  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInp
5378  utsTransformation object.
5379
5380  Fields:
5381    auto: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastin
5382      gInputsTransformationAutoTransformation attribute.
5383    categorical: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlFor
5384      ecastingInputsTransformationCategoricalTransformation attribute.
5385    numeric: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecas
5386      tingInputsTransformationNumericTransformation attribute.
5387    repeatedCategorical: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionA
5388      utoMlForecastingInputsTransformationCategoricalArrayTransformation
5389      attribute.
5390    repeatedNumeric: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoM
5391      lForecastingInputsTransformationNumericArrayTransformation attribute.
5392    repeatedText: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlFo
5393      recastingInputsTransformationTextArrayTransformation attribute.
5394    text: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastin
5395      gInputsTransformationTextTransformation attribute.
5396    timestamp: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForec
5397      astingInputsTransformationTimestampTransformation attribute.
5398  """
5399
5400  auto = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation', 1)
5401  categorical = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation', 2)
5402  numeric = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation', 3)
5403  repeatedCategorical = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalArrayTransformation', 4)
5404  repeatedNumeric = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericArrayTransformation', 5)
5405  repeatedText = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextArrayTransformation', 6)
5406  text = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation', 7)
5407  timestamp = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation', 8)
5408
5409
5410class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation(_messages.Message):
5411  r"""Training pipeline will infer the proper transformation based on the
5412  statistic of dataset.
5413
5414  Fields:
5415    columnName: A string attribute.
5416  """
5417
5418  columnName = _messages.StringField(1)
5419
5420
5421class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalArrayTransformation(_messages.Message):
5422  r"""Treats the column as categorical array and performs following
5423  transformation functions. * For each element in the array, convert the
5424  category name to a dictionary lookup index and generate an embedding for
5425  each index. Combine the embedding of all elements into a single embedding
5426  using the mean. * Empty arrays treated as an embedding of zeroes.
5427
5428  Fields:
5429    columnName: A string attribute.
5430  """
5431
5432  columnName = _messages.StringField(1)
5433
5434
5435class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation(_messages.Message):
5436  r"""Training pipeline will perform following transformation functions. * The
5437  categorical string as is--no change to case, punctuation, spelling, tense,
5438  and so on. * Convert the category name to a dictionary lookup index and
5439  generate an embedding for each index. * Categories that appear less than 5
5440  times in the training dataset are treated as the "unknown" category. The
5441  "unknown" category gets its own special lookup index and resulting
5442  embedding.
5443
5444  Fields:
5445    columnName: A string attribute.
5446  """
5447
5448  columnName = _messages.StringField(1)
5449
5450
5451class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericArrayTransformation(_messages.Message):
5452  r"""Treats the column as numerical array and performs following
5453  transformation functions. * All transformations for Numerical types applied
5454  to the average of the all elements. * The average of empty arrays is treated
5455  as zero.
5456
5457  Fields:
5458    columnName: A string attribute.
5459    invalidValuesAllowed: If invalid values is allowed, the training pipeline
5460      will create a boolean feature that indicated whether the value is valid.
5461      Otherwise, the training pipeline will discard the input row from
5462      trainining data.
5463  """
5464
5465  columnName = _messages.StringField(1)
5466  invalidValuesAllowed = _messages.BooleanField(2)
5467
5468
5469class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation(_messages.Message):
5470  r"""Training pipeline will perform following transformation functions. * The
5471  value converted to float32. * The z_score of the value. * log(value+1) when
5472  the value is greater than or equal to 0. Otherwise, this transformation is
5473  not applied and the value is considered a missing value. * z_score of
5474  log(value+1) when the value is greater than or equal to 0. Otherwise, this
5475  transformation is not applied and the value is considered a missing value. *
5476  A boolean value that indicates whether the value is valid.
5477
5478  Fields:
5479    columnName: A string attribute.
5480    invalidValuesAllowed: If invalid values is allowed, the training pipeline
5481      will create a boolean feature that indicated whether the value is valid.
5482      Otherwise, the training pipeline will discard the input row from
5483      trainining data.
5484  """
5485
5486  columnName = _messages.StringField(1)
5487  invalidValuesAllowed = _messages.BooleanField(2)
5488
5489
5490class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextArrayTransformation(_messages.Message):
5491  r"""Treats the column as text array and performs following transformation
5492  functions. * Concatenate all text values in the array into a single text
5493  value using a space (" ") as a delimiter, and then treat the result as a
5494  single text value. Apply the transformations for Text columns. * Empty
5495  arrays treated as an empty text.
5496
5497  Fields:
5498    columnName: A string attribute.
5499  """
5500
5501  columnName = _messages.StringField(1)
5502
5503
5504class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation(_messages.Message):
5505  r"""Training pipeline will perform following transformation functions. * The
5506  text as is--no change to case, punctuation, spelling, tense, and so on. *
5507  Tokenize text to words. Convert each words to a dictionary lookup index and
5508  generate an embedding for each index. Combine the embedding of all elements
5509  into a single embedding using the mean. * Tokenization is based on unicode
5510  script boundaries. * Missing values get their own lookup index and resulting
5511  embedding. * Stop-words receive no special treatment and are not removed.
5512
5513  Fields:
5514    columnName: A string attribute.
5515  """
5516
5517  columnName = _messages.StringField(1)
5518
5519
5520class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation(_messages.Message):
5521  r"""Training pipeline will perform following transformation functions. *
5522  Apply the transformation functions for Numerical columns. * Determine the
5523  year, month, day,and weekday. Treat each value from the * timestamp as a
5524  Categorical column. * Invalid numerical values (for example, values that
5525  fall outside of a typical timestamp range, or are extreme values) receive no
5526  special treatment and are not removed.
5527
5528  Fields:
5529    columnName: A string attribute.
5530    invalidValuesAllowed: If invalid values is allowed, the training pipeline
5531      will create a boolean feature that indicated whether the value is valid.
5532      Otherwise, the training pipeline will discard the input row from
5533      trainining data.
5534    timeFormat: The format in which that time field is expressed. The
5535      time_format must either be one of: * `unix-seconds` * `unix-
5536      milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for
5537      respectively number of seconds, milliseconds, microseconds and
5538      nanoseconds since start of the Unix epoch); or be written in `strftime`
5539      syntax. If time_format is not set, then the default format is RFC 3339
5540      `date-time` format, where `time-offset` = `"Z"` (e.g.
5541      1985-04-12T23:20:50.52Z)
5542  """
5543
5544  columnName = _messages.StringField(1)
5545  invalidValuesAllowed = _messages.BooleanField(2)
5546  timeFormat = _messages.StringField(3)
5547
5548
5549class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata(_messages.Message):
5550  r"""Model metadata specific to AutoML Forecasting.
5551
5552  Fields:
5553    trainCostMilliNodeHours: Output only. The actual training cost of the
5554      model, expressed in milli node hours, i.e. 1,000 value in this field
5555      means 1 node hour. Guaranteed to not exceed the train budget.
5556  """
5557
5558  trainCostMilliNodeHours = _messages.IntegerField(1)
5559
5560
5561class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification(_messages.Message):
5562  r"""A TrainingJob that trains and uploads an AutoML Image Classification
5563  Model.
5564
5565  Fields:
5566    inputs: The input parameters of this TrainingJob.
5567    metadata: The metadata information.
5568  """
5569
5570  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs', 1)
5571  metadata = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata', 2)
5572
5573
5574class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs(_messages.Message):
5575  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassific
5576  ationInputs object.
5577
5578  Enums:
5579    ModelTypeValueValuesEnum:
5580
5581  Fields:
5582    baseModelId: The ID of the `base` model. If it is specified, the new model
5583      will be trained based on the `base` model. Otherwise, the new model will
5584      be trained from scratch. The `base` model must be in the same Project
5585      and Location as the new Model to train, and have the same modelType.
5586    budgetMilliNodeHours: The training budget of creating this model,
5587      expressed in milli node hours i.e. 1,000 value in this field means 1
5588      node hour. The actual metadata.costMilliNodeHours will be equal or less
5589      than this value. If further model training ceases to provide any
5590      improvements, it will stop without using the full budget and the
5591      metadata.successfulStopReason will be `model-converged`. Note, node_hour
5592      = actual_hour * number_of_nodes_involved. For modelType
5593      `cloud`(default), the budget must be between 8,000 and 800,000 milli
5594      node hours, inclusive. The default value is 192,000 which represents one
5595      day in wall time, considering 8 nodes are used. For model types `mobile-
5596      tf-low-latency-1`, `mobile-tf-versatile-1`, `mobile-tf-high-accuracy-1`,
5597      the training budget must be between 1,000 and 100,000 milli node hours,
5598      inclusive. The default value is 24,000 which represents one day in wall
5599      time on a single node that is used.
5600    disableEarlyStopping: Use the entire training budget. This disables the
5601      early stopping feature. When false the early stopping feature is
5602      enabled, which means that AutoML Image Classification might stop
5603      training before the entire training budget has been used.
5604    modelType: A ModelTypeValueValuesEnum attribute.
5605    multiLabel: If false, a single-label (multi-class) Model will be trained
5606      (i.e. assuming that for each image just up to one annotation may be
5607      applicable). If true, a multi-label Model will be trained (i.e. assuming
5608      that for each image multiple annotations may be applicable).
5609  """
5610
5611  class ModelTypeValueValuesEnum(_messages.Enum):
5612    r"""ModelTypeValueValuesEnum enum type.
5613
5614    Values:
5615      MODEL_TYPE_UNSPECIFIED: Should not be set.
5616      CLOUD: A Model best tailored to be used within Google Cloud, and which
5617        cannot be exported. Default.
5618      MOBILE_TF_LOW_LATENCY_1: A model that, in addition to being available
5619        within Google Cloud, can also be exported (see
5620        ModelService.ExportModel) as TensorFlow or Core ML model and used on a
5621        mobile or edge device afterwards. Expected to have low latency, but
5622        may have lower prediction quality than other mobile models.
5623      MOBILE_TF_VERSATILE_1: A model that, in addition to being available
5624        within Google Cloud, can also be exported (see
5625        ModelService.ExportModel) as TensorFlow or Core ML model and used on a
5626        mobile or edge device with afterwards.
5627      MOBILE_TF_HIGH_ACCURACY_1: A model that, in addition to being available
5628        within Google Cloud, can also be exported (see
5629        ModelService.ExportModel) as TensorFlow or Core ML model and used on a
5630        mobile or edge device afterwards. Expected to have a higher latency,
5631        but should also have a higher prediction quality than other mobile
5632        models.
5633    """
5634    MODEL_TYPE_UNSPECIFIED = 0
5635    CLOUD = 1
5636    MOBILE_TF_LOW_LATENCY_1 = 2
5637    MOBILE_TF_VERSATILE_1 = 3
5638    MOBILE_TF_HIGH_ACCURACY_1 = 4
5639
5640  baseModelId = _messages.StringField(1)
5641  budgetMilliNodeHours = _messages.IntegerField(2)
5642  disableEarlyStopping = _messages.BooleanField(3)
5643  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 4)
5644  multiLabel = _messages.BooleanField(5)
5645
5646
5647class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata(_messages.Message):
5648  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassific
5649  ationMetadata object.
5650
5651  Enums:
5652    SuccessfulStopReasonValueValuesEnum: For successful job completions, this
5653      is the reason why the job has finished.
5654
5655  Fields:
5656    costMilliNodeHours: The actual training cost of creating this model,
5657      expressed in milli node hours, i.e. 1,000 value in this field means 1
5658      node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.
5659    successfulStopReason: For successful job completions, this is the reason
5660      why the job has finished.
5661  """
5662
5663  class SuccessfulStopReasonValueValuesEnum(_messages.Enum):
5664    r"""For successful job completions, this is the reason why the job has
5665    finished.
5666
5667    Values:
5668      SUCCESSFUL_STOP_REASON_UNSPECIFIED: Should not be set.
5669      BUDGET_REACHED: The inputs.budgetMilliNodeHours had been reached.
5670      MODEL_CONVERGED: Further training of the Model ceased to increase its
5671        quality, since it already has converged.
5672    """
5673    SUCCESSFUL_STOP_REASON_UNSPECIFIED = 0
5674    BUDGET_REACHED = 1
5675    MODEL_CONVERGED = 2
5676
5677  costMilliNodeHours = _messages.IntegerField(1)
5678  successfulStopReason = _messages.EnumField('SuccessfulStopReasonValueValuesEnum', 2)
5679
5680
5681class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection(_messages.Message):
5682  r"""A TrainingJob that trains and uploads an AutoML Image Object Detection
5683  Model.
5684
5685  Fields:
5686    inputs: The input parameters of this TrainingJob.
5687    metadata: The metadata information
5688  """
5689
5690  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs', 1)
5691  metadata = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata', 2)
5692
5693
5694class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs(_messages.Message):
5695  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDet
5696  ectionInputs object.
5697
5698  Enums:
5699    ModelTypeValueValuesEnum:
5700
5701  Fields:
5702    budgetMilliNodeHours: The training budget of creating this model,
5703      expressed in milli node hours i.e. 1,000 value in this field means 1
5704      node hour. The actual metadata.costMilliNodeHours will be equal or less
5705      than this value. If further model training ceases to provide any
5706      improvements, it will stop without using the full budget and the
5707      metadata.successfulStopReason will be `model-converged`. Note, node_hour
5708      = actual_hour * number_of_nodes_involved. For modelType
5709      `cloud`(default), the budget must be between 20,000 and 900,000 milli
5710      node hours, inclusive. The default value is 216,000 which represents one
5711      day in wall time, considering 9 nodes are used. For model types `mobile-
5712      tf-low-latency-1`, `mobile-tf-versatile-1`, `mobile-tf-high-accuracy-1`
5713      the training budget must be between 1,000 and 100,000 milli node hours,
5714      inclusive. The default value is 24,000 which represents one day in wall
5715      time on a single node that is used.
5716    disableEarlyStopping: Use the entire training budget. This disables the
5717      early stopping feature. When false the early stopping feature is
5718      enabled, which means that AutoML Image Object Detection might stop
5719      training before the entire training budget has been used.
5720    modelType: A ModelTypeValueValuesEnum attribute.
5721  """
5722
5723  class ModelTypeValueValuesEnum(_messages.Enum):
5724    r"""ModelTypeValueValuesEnum enum type.
5725
5726    Values:
5727      MODEL_TYPE_UNSPECIFIED: Should not be set.
5728      CLOUD_HIGH_ACCURACY_1: A model best tailored to be used within Google
5729        Cloud, and which cannot be exported. Expected to have a higher
5730        latency, but should also have a higher prediction quality than other
5731        cloud models.
5732      CLOUD_LOW_LATENCY_1: A model best tailored to be used within Google
5733        Cloud, and which cannot be exported. Expected to have a low latency,
5734        but may have lower prediction quality than other cloud models.
5735      MOBILE_TF_LOW_LATENCY_1: A model that, in addition to being available
5736        within Google Cloud can also be exported (see
5737        ModelService.ExportModel) and used on a mobile or edge device with
5738        TensorFlow afterwards. Expected to have low latency, but may have
5739        lower prediction quality than other mobile models.
5740      MOBILE_TF_VERSATILE_1: A model that, in addition to being available
5741        within Google Cloud can also be exported (see
5742        ModelService.ExportModel) and used on a mobile or edge device with
5743        TensorFlow afterwards.
5744      MOBILE_TF_HIGH_ACCURACY_1: A model that, in addition to being available
5745        within Google Cloud, can also be exported (see
5746        ModelService.ExportModel) and used on a mobile or edge device with
5747        TensorFlow afterwards. Expected to have a higher latency, but should
5748        also have a higher prediction quality than other mobile models.
5749    """
5750    MODEL_TYPE_UNSPECIFIED = 0
5751    CLOUD_HIGH_ACCURACY_1 = 1
5752    CLOUD_LOW_LATENCY_1 = 2
5753    MOBILE_TF_LOW_LATENCY_1 = 3
5754    MOBILE_TF_VERSATILE_1 = 4
5755    MOBILE_TF_HIGH_ACCURACY_1 = 5
5756
5757  budgetMilliNodeHours = _messages.IntegerField(1)
5758  disableEarlyStopping = _messages.BooleanField(2)
5759  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 3)
5760
5761
5762class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata(_messages.Message):
5763  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDet
5764  ectionMetadata object.
5765
5766  Enums:
5767    SuccessfulStopReasonValueValuesEnum: For successful job completions, this
5768      is the reason why the job has finished.
5769
5770  Fields:
5771    costMilliNodeHours: The actual training cost of creating this model,
5772      expressed in milli node hours, i.e. 1,000 value in this field means 1
5773      node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.
5774    successfulStopReason: For successful job completions, this is the reason
5775      why the job has finished.
5776  """
5777
5778  class SuccessfulStopReasonValueValuesEnum(_messages.Enum):
5779    r"""For successful job completions, this is the reason why the job has
5780    finished.
5781
5782    Values:
5783      SUCCESSFUL_STOP_REASON_UNSPECIFIED: Should not be set.
5784      BUDGET_REACHED: The inputs.budgetMilliNodeHours had been reached.
5785      MODEL_CONVERGED: Further training of the Model ceased to increase its
5786        quality, since it already has converged.
5787    """
5788    SUCCESSFUL_STOP_REASON_UNSPECIFIED = 0
5789    BUDGET_REACHED = 1
5790    MODEL_CONVERGED = 2
5791
5792  costMilliNodeHours = _messages.IntegerField(1)
5793  successfulStopReason = _messages.EnumField('SuccessfulStopReasonValueValuesEnum', 2)
5794
5795
5796class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation(_messages.Message):
5797  r"""A TrainingJob that trains and uploads an AutoML Image Segmentation
5798  Model.
5799
5800  Fields:
5801    inputs: The input parameters of this TrainingJob.
5802    metadata: The metadata information.
5803  """
5804
5805  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs', 1)
5806  metadata = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata', 2)
5807
5808
5809class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs(_messages.Message):
5810  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentat
5811  ionInputs object.
5812
5813  Enums:
5814    ModelTypeValueValuesEnum:
5815
5816  Fields:
5817    baseModelId: The ID of the `base` model. If it is specified, the new model
5818      will be trained based on the `base` model. Otherwise, the new model will
5819      be trained from scratch. The `base` model must be in the same Project
5820      and Location as the new Model to train, and have the same modelType.
5821    budgetMilliNodeHours: The training budget of creating this model,
5822      expressed in milli node hours i.e. 1,000 value in this field means 1
5823      node hour. The actual metadata.costMilliNodeHours will be equal or less
5824      than this value. If further model training ceases to provide any
5825      improvements, it will stop without using the full budget and the
5826      metadata.successfulStopReason will be `model-converged`. Note, node_hour
5827      = actual_hour * number_of_nodes_involved. Or actaul_wall_clock_hours =
5828      train_budget_milli_node_hours / (number_of_nodes_involved * 1000) For
5829      modelType `cloud-high-accuracy-1`(default), the budget must be between
5830      20,000 and 2,000,000 milli node hours, inclusive. The default value is
5831      192,000 which represents one day in wall time (1000 milli * 24 hours * 8
5832      nodes).
5833    modelType: A ModelTypeValueValuesEnum attribute.
5834  """
5835
5836  class ModelTypeValueValuesEnum(_messages.Enum):
5837    r"""ModelTypeValueValuesEnum enum type.
5838
5839    Values:
5840      MODEL_TYPE_UNSPECIFIED: Should not be set.
5841      CLOUD_HIGH_ACCURACY_1: A model to be used via prediction calls to uCAIP
5842        API. Expected to have a higher latency, but should also have a higher
5843        prediction quality than other models.
5844      CLOUD_LOW_ACCURACY_1: A model to be used via prediction calls to uCAIP
5845        API. Expected to have a lower latency but relatively lower prediction
5846        quality.
5847      MOBILE_TF_LOW_LATENCY_1: A model that, in addition to being available
5848        within Google Cloud, can also be exported (see
5849        ModelService.ExportModel) as TensorFlow model and used on a mobile or
5850        edge device afterwards. Expected to have low latency, but may have
5851        lower prediction quality than other mobile models.
5852    """
5853    MODEL_TYPE_UNSPECIFIED = 0
5854    CLOUD_HIGH_ACCURACY_1 = 1
5855    CLOUD_LOW_ACCURACY_1 = 2
5856    MOBILE_TF_LOW_LATENCY_1 = 3
5857
5858  baseModelId = _messages.StringField(1)
5859  budgetMilliNodeHours = _messages.IntegerField(2)
5860  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 3)
5861
5862
5863class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata(_messages.Message):
5864  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentat
5865  ionMetadata object.
5866
5867  Enums:
5868    SuccessfulStopReasonValueValuesEnum: For successful job completions, this
5869      is the reason why the job has finished.
5870
5871  Fields:
5872    costMilliNodeHours: The actual training cost of creating this model,
5873      expressed in milli node hours, i.e. 1,000 value in this field means 1
5874      node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.
5875    successfulStopReason: For successful job completions, this is the reason
5876      why the job has finished.
5877  """
5878
5879  class SuccessfulStopReasonValueValuesEnum(_messages.Enum):
5880    r"""For successful job completions, this is the reason why the job has
5881    finished.
5882
5883    Values:
5884      SUCCESSFUL_STOP_REASON_UNSPECIFIED: Should not be set.
5885      BUDGET_REACHED: The inputs.budgetMilliNodeHours had been reached.
5886      MODEL_CONVERGED: Further training of the Model ceased to increase its
5887        quality, since it already has converged.
5888    """
5889    SUCCESSFUL_STOP_REASON_UNSPECIFIED = 0
5890    BUDGET_REACHED = 1
5891    MODEL_CONVERGED = 2
5892
5893  costMilliNodeHours = _messages.IntegerField(1)
5894  successfulStopReason = _messages.EnumField('SuccessfulStopReasonValueValuesEnum', 2)
5895
5896
5897class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables(_messages.Message):
5898  r"""A TrainingJob that trains and uploads an AutoML Tables Model.
5899
5900  Fields:
5901    inputs: The input parameters of this TrainingJob.
5902    metadata: The metadata information.
5903  """
5904
5905  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs', 1)
5906  metadata = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata', 2)
5907
5908
5909class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs(_messages.Message):
5910  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs
5911  object.
5912
5913  Fields:
5914    disableEarlyStopping: Use the entire training budget. This disables the
5915      early stopping feature. By default, the early stopping feature is
5916      enabled, which means that AutoML Tables might stop training before the
5917      entire training budget has been used.
5918    exportEvaluatedDataItemsConfig: Configuration for exporting test set
5919      predictions to a BigQuery table. If this configuration is absent, then
5920      the export is not performed.
5921    optimizationObjective: Objective function the model is optimizing towards.
5922      The training process creates a model that maximizes/minimizes the value
5923      of the objective function over the validation set. The supported
5924      optimization objectives depend on the prediction type. If the field is
5925      not set, a default objective function is used. classification (binary):
5926      "maximize-au-roc" (default) - Maximize the area under the receiver
5927      operating characteristic (ROC) curve. "minimize-log-loss" - Minimize log
5928      loss. "maximize-au-prc" - Maximize the area under the precision-recall
5929      curve. "maximize-precision-at-recall" - Maximize precision for a
5930      specified recall value. "maximize-recall-at-precision" - Maximize recall
5931      for a specified precision value. classification (multi-class):
5932      "minimize-log-loss" (default) - Minimize log loss. regression:
5933      "minimize-rmse" (default) - Minimize root-mean-squared error (RMSE).
5934      "minimize-mae" - Minimize mean-absolute error (MAE). "minimize-rmsle" -
5935      Minimize root-mean-squared log error (RMSLE).
5936    optimizationObjectivePrecisionValue: Required when optimization_objective
5937      is "maximize-recall-at-precision". Must be between 0 and 1, inclusive.
5938    optimizationObjectiveRecallValue: Required when optimization_objective is
5939      "maximize-precision-at-recall". Must be between 0 and 1, inclusive.
5940    predictionType: The type of prediction the Model is to produce.
5941      "classification" - Predict one out of multiple target values is picked
5942      for each row. "regression" - Predict a value based on its relation to
5943      other values. This type is available only to columns that contain
5944      semantically numeric values, i.e. integers or floating point number,
5945      even if stored as e.g. strings.
5946    targetColumn: The column name of the target column that the model is to
5947      predict.
5948    trainBudgetMilliNodeHours: Required. The train budget of creating this
5949      model, expressed in milli node hours i.e. 1,000 value in this field
5950      means 1 node hour. The training cost of the model will not exceed this
5951      budget. The final cost will be attempted to be close to the budget,
5952      though may end up being (even) noticeably smaller - at the backend's
5953      discretion. This especially may happen when further model training
5954      ceases to provide any improvements. If the budget is set to a value
5955      known to be insufficient to train a model for the given dataset, the
5956      training won't be attempted and will error. The train budget must be
5957      between 1,000 and 72,000 milli node hours, inclusive.
5958    transformations: Each transformation will apply transform function to
5959      given input column. And the result will be used for training. When
5960      creating transformation for BigQuery Struct column, the column should be
5961      flattened using "." as the delimiter.
5962    weightColumnName: Column name that should be used as the weight column.
5963      Higher values in this column give more importance to the row during
5964      model training. The column must have numeric values between 0 and 10000
5965      inclusively; 0 means the row is ignored for training. If weight column
5966      field is not set, then all rows are assumed to have equal weight of 1.
5967  """
5968
5969  disableEarlyStopping = _messages.BooleanField(1)
5970  exportEvaluatedDataItemsConfig = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig', 2)
5971  optimizationObjective = _messages.StringField(3)
5972  optimizationObjectivePrecisionValue = _messages.FloatField(4, variant=_messages.Variant.FLOAT)
5973  optimizationObjectiveRecallValue = _messages.FloatField(5, variant=_messages.Variant.FLOAT)
5974  predictionType = _messages.StringField(6)
5975  targetColumn = _messages.StringField(7)
5976  trainBudgetMilliNodeHours = _messages.IntegerField(8)
5977  transformations = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation', 9, repeated=True)
5978  weightColumnName = _messages.StringField(10)
5979
5980
5981class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation(_messages.Message):
5982  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTr
5983  ansformation object.
5984
5985  Fields:
5986    auto: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInpu
5987      tsTransformationAutoTransformation attribute.
5988    categorical: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTab
5989      lesInputsTransformationCategoricalTransformation attribute.
5990    numeric: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesI
5991      nputsTransformationNumericTransformation attribute.
5992    repeatedCategorical: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionA
5993      utoMlTablesInputsTransformationCategoricalArrayTransformation attribute.
5994    repeatedNumeric: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoM
5995      lTablesInputsTransformationNumericArrayTransformation attribute.
5996    repeatedText: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTa
5997      blesInputsTransformationTextArrayTransformation attribute.
5998    text: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInpu
5999      tsTransformationTextTransformation attribute.
6000    timestamp: A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTable
6001      sInputsTransformationTimestampTransformation attribute.
6002  """
6003
6004  auto = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation', 1)
6005  categorical = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation', 2)
6006  numeric = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation', 3)
6007  repeatedCategorical = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation', 4)
6008  repeatedNumeric = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation', 5)
6009  repeatedText = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation', 6)
6010  text = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation', 7)
6011  timestamp = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation', 8)
6012
6013
6014class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation(_messages.Message):
6015  r"""Training pipeline will infer the proper transformation based on the
6016  statistic of dataset.
6017
6018  Fields:
6019    columnName: A string attribute.
6020  """
6021
6022  columnName = _messages.StringField(1)
6023
6024
6025class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation(_messages.Message):
6026  r"""Treats the column as categorical array and performs following
6027  transformation functions. * For each element in the array, convert the
6028  category name to a dictionary lookup index and generate an embedding for
6029  each index. Combine the embedding of all elements into a single embedding
6030  using the mean. * Empty arrays treated as an embedding of zeroes.
6031
6032  Fields:
6033    columnName: A string attribute.
6034  """
6035
6036  columnName = _messages.StringField(1)
6037
6038
6039class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation(_messages.Message):
6040  r"""Training pipeline will perform following transformation functions. * The
6041  categorical string as is--no change to case, punctuation, spelling, tense,
6042  and so on. * Convert the category name to a dictionary lookup index and
6043  generate an embedding for each index. * Categories that appear less than 5
6044  times in the training dataset are treated as the "unknown" category. The
6045  "unknown" category gets its own special lookup index and resulting
6046  embedding.
6047
6048  Fields:
6049    columnName: A string attribute.
6050  """
6051
6052  columnName = _messages.StringField(1)
6053
6054
6055class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation(_messages.Message):
6056  r"""Treats the column as numerical array and performs following
6057  transformation functions. * All transformations for Numerical types applied
6058  to the average of the all elements. * The average of empty arrays is treated
6059  as zero.
6060
6061  Fields:
6062    columnName: A string attribute.
6063    invalidValuesAllowed: If invalid values is allowed, the training pipeline
6064      will create a boolean feature that indicated whether the value is valid.
6065      Otherwise, the training pipeline will discard the input row from
6066      trainining data.
6067  """
6068
6069  columnName = _messages.StringField(1)
6070  invalidValuesAllowed = _messages.BooleanField(2)
6071
6072
6073class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation(_messages.Message):
6074  r"""Training pipeline will perform following transformation functions. * The
6075  value converted to float32. * The z_score of the value. * log(value+1) when
6076  the value is greater than or equal to 0. Otherwise, this transformation is
6077  not applied and the value is considered a missing value. * z_score of
6078  log(value+1) when the value is greater than or equal to 0. Otherwise, this
6079  transformation is not applied and the value is considered a missing value. *
6080  A boolean value that indicates whether the value is valid.
6081
6082  Fields:
6083    columnName: A string attribute.
6084    invalidValuesAllowed: If invalid values is allowed, the training pipeline
6085      will create a boolean feature that indicated whether the value is valid.
6086      Otherwise, the training pipeline will discard the input row from
6087      trainining data.
6088  """
6089
6090  columnName = _messages.StringField(1)
6091  invalidValuesAllowed = _messages.BooleanField(2)
6092
6093
6094class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation(_messages.Message):
6095  r"""Treats the column as text array and performs following transformation
6096  functions. * Concatenate all text values in the array into a single text
6097  value using a space (" ") as a delimiter, and then treat the result as a
6098  single text value. Apply the transformations for Text columns. * Empty
6099  arrays treated as an empty text.
6100
6101  Fields:
6102    columnName: A string attribute.
6103  """
6104
6105  columnName = _messages.StringField(1)
6106
6107
6108class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation(_messages.Message):
6109  r"""Training pipeline will perform following transformation functions. * The
6110  text as is--no change to case, punctuation, spelling, tense, and so on. *
6111  Tokenize text to words. Convert each words to a dictionary lookup index and
6112  generate an embedding for each index. Combine the embedding of all elements
6113  into a single embedding using the mean. * Tokenization is based on unicode
6114  script boundaries. * Missing values get their own lookup index and resulting
6115  embedding. * Stop-words receive no special treatment and are not removed.
6116
6117  Fields:
6118    columnName: A string attribute.
6119  """
6120
6121  columnName = _messages.StringField(1)
6122
6123
6124class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation(_messages.Message):
6125  r"""Training pipeline will perform following transformation functions. *
6126  Apply the transformation functions for Numerical columns. * Determine the
6127  year, month, day,and weekday. Treat each value from the * timestamp as a
6128  Categorical column. * Invalid numerical values (for example, values that
6129  fall outside of a typical timestamp range, or are extreme values) receive no
6130  special treatment and are not removed.
6131
6132  Fields:
6133    columnName: A string attribute.
6134    invalidValuesAllowed: If invalid values is allowed, the training pipeline
6135      will create a boolean feature that indicated whether the value is valid.
6136      Otherwise, the training pipeline will discard the input row from
6137      trainining data.
6138    timeFormat: The format in which that time field is expressed. The
6139      time_format must either be one of: * `unix-seconds` * `unix-
6140      milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for
6141      respectively number of seconds, milliseconds, microseconds and
6142      nanoseconds since start of the Unix epoch); or be written in `strftime`
6143      syntax. If time_format is not set, then the default format is RFC 3339
6144      `date-time` format, where `time-offset` = `"Z"` (e.g.
6145      1985-04-12T23:20:50.52Z)
6146  """
6147
6148  columnName = _messages.StringField(1)
6149  invalidValuesAllowed = _messages.BooleanField(2)
6150  timeFormat = _messages.StringField(3)
6151
6152
6153class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata(_messages.Message):
6154  r"""Model metadata specific to AutoML Tables.
6155
6156  Fields:
6157    trainCostMilliNodeHours: Output only. The actual training cost of the
6158      model, expressed in milli node hours, i.e. 1,000 value in this field
6159      means 1 node hour. Guaranteed to not exceed the train budget.
6160  """
6161
6162  trainCostMilliNodeHours = _messages.IntegerField(1)
6163
6164
6165class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification(_messages.Message):
6166  r"""A TrainingJob that trains and uploads an AutoML Text Classification
6167  Model.
6168
6169  Fields:
6170    inputs: The input parameters of this TrainingJob.
6171  """
6172
6173  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs', 1)
6174
6175
6176class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs(_messages.Message):
6177  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassifica
6178  tionInputs object.
6179
6180  Fields:
6181    multiLabel: A boolean attribute.
6182  """
6183
6184  multiLabel = _messages.BooleanField(1)
6185
6186
6187class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction(_messages.Message):
6188  r"""A TrainingJob that trains and uploads an AutoML Text Extraction Model.
6189
6190  Fields:
6191    inputs: The input parameters of this TrainingJob.
6192  """
6193
6194  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs', 1)
6195
6196
6197class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs(_messages.Message):
6198  r"""A
6199  GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs
6200  object.
6201  """
6202
6203
6204
6205class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment(_messages.Message):
6206  r"""A TrainingJob that trains and uploads an AutoML Text Sentiment Model.
6207
6208  Fields:
6209    inputs: The input parameters of this TrainingJob.
6210  """
6211
6212  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs', 1)
6213
6214
6215class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs(_messages.Message):
6216  r"""A
6217  GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs
6218  object.
6219
6220  Fields:
6221    sentimentMax: A sentiment is expressed as an integer ordinal, where higher
6222      value means a more positive sentiment. The range of sentiments that will
6223      be used is between 0 and sentimentMax (inclusive on both ends), and all
6224      the values in the range must be represented in the dataset before a
6225      model can be created. Only the Annotations with this sentimentMax will
6226      be used for training. sentimentMax value must be between 1 and 10
6227      (inclusive).
6228  """
6229
6230  sentimentMax = _messages.IntegerField(1, variant=_messages.Variant.INT32)
6231
6232
6233class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition(_messages.Message):
6234  r"""A TrainingJob that trains and uploads an AutoML Video Action Recognition
6235  Model.
6236
6237  Fields:
6238    inputs: The input parameters of this TrainingJob.
6239  """
6240
6241  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs', 1)
6242
6243
6244class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs(_messages.Message):
6245  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRec
6246  ognitionInputs object.
6247
6248  Enums:
6249    ModelTypeValueValuesEnum:
6250
6251  Fields:
6252    modelType: A ModelTypeValueValuesEnum attribute.
6253  """
6254
6255  class ModelTypeValueValuesEnum(_messages.Enum):
6256    r"""ModelTypeValueValuesEnum enum type.
6257
6258    Values:
6259      MODEL_TYPE_UNSPECIFIED: Should not be set.
6260      CLOUD: A model best tailored to be used within Google Cloud, and which c
6261        annot be exported. Default.
6262      MOBILE_VERSATILE_1: A model that, in addition to being available within
6263        Google Cloud, can also be exported (see ModelService.ExportModel) as a
6264        TensorFlow or TensorFlow Lite model and used on a mobile or edge
6265        device afterwards.
6266    """
6267    MODEL_TYPE_UNSPECIFIED = 0
6268    CLOUD = 1
6269    MOBILE_VERSATILE_1 = 2
6270
6271  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 1)
6272
6273
6274class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification(_messages.Message):
6275  r"""A TrainingJob that trains and uploads an AutoML Video Classification
6276  Model.
6277
6278  Fields:
6279    inputs: The input parameters of this TrainingJob.
6280  """
6281
6282  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs', 1)
6283
6284
6285class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs(_messages.Message):
6286  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassific
6287  ationInputs object.
6288
6289  Enums:
6290    ModelTypeValueValuesEnum:
6291
6292  Fields:
6293    modelType: A ModelTypeValueValuesEnum attribute.
6294  """
6295
6296  class ModelTypeValueValuesEnum(_messages.Enum):
6297    r"""ModelTypeValueValuesEnum enum type.
6298
6299    Values:
6300      MODEL_TYPE_UNSPECIFIED: Should not be set.
6301      CLOUD: A model best tailored to be used within Google Cloud, and which
6302        cannot be exported. Default.
6303      MOBILE_VERSATILE_1: A model that, in addition to being available within
6304        Google Cloud, can also be exported (see ModelService.ExportModel) as a
6305        TensorFlow or TensorFlow Lite model and used on a mobile or edge
6306        device afterwards.
6307      MOBILE_JETSON_VERSATILE_1: A model that, in addition to being available
6308        within Google Cloud, can also be exported (see
6309        ModelService.ExportModel) to a Jetson device afterwards.
6310    """
6311    MODEL_TYPE_UNSPECIFIED = 0
6312    CLOUD = 1
6313    MOBILE_VERSATILE_1 = 2
6314    MOBILE_JETSON_VERSATILE_1 = 3
6315
6316  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 1)
6317
6318
6319class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking(_messages.Message):
6320  r"""A TrainingJob that trains and uploads an AutoML Video ObjectTracking
6321  Model.
6322
6323  Fields:
6324    inputs: The input parameters of this TrainingJob.
6325  """
6326
6327  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs', 1)
6328
6329
6330class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs(_messages.Message):
6331  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTra
6332  ckingInputs object.
6333
6334  Enums:
6335    ModelTypeValueValuesEnum:
6336
6337  Fields:
6338    modelType: A ModelTypeValueValuesEnum attribute.
6339  """
6340
6341  class ModelTypeValueValuesEnum(_messages.Enum):
6342    r"""ModelTypeValueValuesEnum enum type.
6343
6344    Values:
6345      MODEL_TYPE_UNSPECIFIED: Should not be set.
6346      CLOUD: A model best tailored to be used within Google Cloud, and which c
6347        annot be exported. Default.
6348      MOBILE_VERSATILE_1: A model that, in addition to being available within
6349        Google Cloud, can also be exported (see ModelService.ExportModel) as a
6350        TensorFlow or TensorFlow Lite model and used on a mobile or edge
6351        device afterwards.
6352      MOBILE_CORAL_VERSATILE_1: A versatile model that is meant to be exported
6353        (see ModelService.ExportModel) and used on a Google Coral device.
6354      MOBILE_CORAL_LOW_LATENCY_1: A model that trades off quality for low
6355        latency, to be exported (see ModelService.ExportModel) and used on a
6356        Google Coral device.
6357      MOBILE_JETSON_VERSATILE_1: A versatile model that is meant to be
6358        exported (see ModelService.ExportModel) and used on an NVIDIA Jetson
6359        device.
6360      MOBILE_JETSON_LOW_LATENCY_1: A model that trades off quality for low
6361        latency, to be exported (see ModelService.ExportModel) and used on an
6362        NVIDIA Jetson device.
6363    """
6364    MODEL_TYPE_UNSPECIFIED = 0
6365    CLOUD = 1
6366    MOBILE_VERSATILE_1 = 2
6367    MOBILE_CORAL_VERSATILE_1 = 3
6368    MOBILE_CORAL_LOW_LATENCY_1 = 4
6369    MOBILE_JETSON_VERSATILE_1 = 5
6370    MOBILE_JETSON_LOW_LATENCY_1 = 6
6371
6372  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 1)
6373
6374
6375class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata(_messages.Message):
6376  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata
6377  object.
6378
6379  Fields:
6380    backingCustomJob: The resource name of the CustomJob that has been created
6381      to carry out this custom task.
6382  """
6383
6384  backingCustomJob = _messages.StringField(1)
6385
6386
6387class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask(_messages.Message):
6388  r"""A TrainingJob that trains a custom code Model.
6389
6390  Fields:
6391    inputs: The input parameters of this CustomTask.
6392    metadata: The metadata information.
6393  """
6394
6395  inputs = _messages.MessageField('GoogleCloudAiplatformV1CustomJobSpec', 1)
6396  metadata = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata', 2)
6397
6398
6399class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig(_messages.Message):
6400  r"""Configuration for exporting test set predictions to a BigQuery table.
6401
6402  Fields:
6403    destinationBigqueryUri: URI of desired destination BigQuery table.
6404      Expected format: bq://:: If not specified, then results are exported to
6405      the following auto-created BigQuery table:
6406      :export_evaluated_examples__.evaluated_examples
6407    overrideExistingTable: If true and an export destination is specified,
6408      then the contents of the destination are overwritten. Otherwise, if the
6409      export destination already exists, then the export operation fails.
6410  """
6411
6412  destinationBigqueryUri = _messages.StringField(1)
6413  overrideExistingTable = _messages.BooleanField(2)
6414
6415
6416class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata(_messages.Message):
6417  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuning
6418  JobMetadata object.
6419
6420  Fields:
6421    backingHyperparameterTuningJob: The resource name of the
6422      HyperparameterTuningJob that has been created to carry out this
6423      HyperparameterTuning task.
6424    bestTrialBackingCustomJob: The resource name of the CustomJob that has
6425      been created to run the best Trial of this HyperparameterTuning task.
6426  """
6427
6428  backingHyperparameterTuningJob = _messages.StringField(1)
6429  bestTrialBackingCustomJob = _messages.StringField(2)
6430
6431
6432class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec(_messages.Message):
6433  r"""A GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuning
6434  JobSpec object.
6435
6436  Fields:
6437    maxFailedTrialCount: The number of failed Trials that need to be seen
6438      before failing the HyperparameterTuningJob. If set to 0, AI Platform
6439      decides how many Trials must fail before the whole job fails.
6440    maxTrialCount: The desired total number of Trials.
6441    parallelTrialCount: The desired number of Trials to run in parallel.
6442    studySpec: Study configuration of the HyperparameterTuningJob.
6443    trialJobSpec: The spec of a trial job. The same spec applies to the
6444      CustomJobs created in all the trials.
6445  """
6446
6447  maxFailedTrialCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
6448  maxTrialCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
6449  parallelTrialCount = _messages.IntegerField(3, variant=_messages.Variant.INT32)
6450  studySpec = _messages.MessageField('GoogleCloudAiplatformV1StudySpec', 4)
6451  trialJobSpec = _messages.MessageField('GoogleCloudAiplatformV1CustomJobSpec', 5)
6452
6453
6454class GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask(_messages.Message):
6455  r"""A TrainingJob that tunes Hypererparameters of a custom code Model.
6456
6457  Fields:
6458    inputs: The input parameters of this HyperparameterTuningTask.
6459    metadata: The metadata information.
6460  """
6461
6462  inputs = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec', 1)
6463  metadata = _messages.MessageField('GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata', 2)
6464
6465
6466class GoogleCloudAiplatformV1SchemaVertex(_messages.Message):
6467  r"""A vertex represents a 2D point in the image. NOTE: the normalized vertex
6468  coordinates are relative to the original image and range from 0 to 1.
6469
6470  Fields:
6471    x: X coordinate.
6472    y: Y coordinate.
6473  """
6474
6475  x = _messages.FloatField(1)
6476  y = _messages.FloatField(2)
6477
6478
6479class GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation(_messages.Message):
6480  r"""Annotation details specific to video action recognition.
6481
6482  Fields:
6483    annotationSpecId: The resource Id of the AnnotationSpec that this
6484      Annotation pertains to.
6485    displayName: The display name of the AnnotationSpec that this Annotation
6486      pertains to.
6487    timeSegment: This Annotation applies to the time period represented by the
6488      TimeSegment. If it's not set, the Annotation applies to the whole video.
6489  """
6490
6491  annotationSpecId = _messages.StringField(1)
6492  displayName = _messages.StringField(2)
6493  timeSegment = _messages.MessageField('GoogleCloudAiplatformV1SchemaTimeSegment', 3)
6494
6495
6496class GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation(_messages.Message):
6497  r"""Annotation details specific to video classification.
6498
6499  Fields:
6500    annotationSpecId: The resource Id of the AnnotationSpec that this
6501      Annotation pertains to.
6502    displayName: The display name of the AnnotationSpec that this Annotation
6503      pertains to.
6504    timeSegment: This Annotation applies to the time period represented by the
6505      TimeSegment. If it's not set, the Annotation applies to the whole video.
6506  """
6507
6508  annotationSpecId = _messages.StringField(1)
6509  displayName = _messages.StringField(2)
6510  timeSegment = _messages.MessageField('GoogleCloudAiplatformV1SchemaTimeSegment', 3)
6511
6512
6513class GoogleCloudAiplatformV1SchemaVideoDataItem(_messages.Message):
6514  r"""Payload of Video DataItem.
6515
6516  Fields:
6517    gcsUri: Required. Google Cloud Storage URI points to the original video in
6518      user's bucket. The video is up to 50 GB in size and up to 3 hour in
6519      duration.
6520    mimeType: Output only. The mime type of the content of the video. Only the
6521      videos in below listed mime types are supported. Supported mime_type: -
6522      video/mp4 - video/avi - video/quicktime
6523  """
6524
6525  gcsUri = _messages.StringField(1)
6526  mimeType = _messages.StringField(2)
6527
6528
6529class GoogleCloudAiplatformV1SchemaVideoDatasetMetadata(_messages.Message):
6530  r"""The metadata of Datasets that contain Video DataItems.
6531
6532  Fields:
6533    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
6534      describing payload of the Video DataItems that belong to this Dataset.
6535    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
6536      this Dataset.
6537  """
6538
6539  dataItemSchemaUri = _messages.StringField(1)
6540  gcsBucket = _messages.StringField(2)
6541
6542
6543class GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation(_messages.Message):
6544  r"""Annotation details specific to video object tracking.
6545
6546  Fields:
6547    annotationSpecId: The resource Id of the AnnotationSpec that this
6548      Annotation pertains to.
6549    displayName: The display name of the AnnotationSpec that this Annotation
6550      pertains to.
6551    instanceId: The instance of the object, expressed as a positive integer.
6552      Used to track the same object across different frames.
6553    timeOffset: A time (frame) of a video to which this annotation pertains.
6554      Represented as the duration since the video's start.
6555    xMax: The rightmost coordinate of the bounding box.
6556    xMin: The leftmost coordinate of the bounding box.
6557    yMax: The bottommost coordinate of the bounding box.
6558    yMin: The topmost coordinate of the bounding box.
6559  """
6560
6561  annotationSpecId = _messages.StringField(1)
6562  displayName = _messages.StringField(2)
6563  instanceId = _messages.IntegerField(3)
6564  timeOffset = _messages.StringField(4)
6565  xMax = _messages.FloatField(5)
6566  xMin = _messages.FloatField(6)
6567  yMax = _messages.FloatField(7)
6568  yMin = _messages.FloatField(8)
6569
6570
6571class GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata(_messages.Message):
6572  r"""A GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQ
6573  ueryMetadata object.
6574
6575  Fields:
6576    multiLabel: Whether or not the classification label is multi_label.
6577  """
6578
6579  multiLabel = _messages.BooleanField(1)
6580
6581
6582class GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata(_messages.Message):
6583  r"""A GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata
6584  object.
6585  """
6586
6587
6588
6589class GoogleCloudAiplatformV1SearchMigratableResourcesRequest(_messages.Message):
6590  r"""Request message for MigrationService.SearchMigratableResources.
6591
6592  Fields:
6593    filter: Supported filters are: * Resource type: For a specific type of
6594      MigratableResource. * `ml_engine_model_version:*` * `automl_model:*`, *
6595      `automl_dataset:*` * `data_labeling_dataset:*`. * Migrated or not:
6596      Filter migrated resource or not by last_migrate_time. *
6597      `last_migrate_time:*` will filter migrated resources. * `NOT
6598      last_migrate_time:*` will filter not yet migrated resources.
6599    pageSize: The standard page size. The default and maximum value is 100.
6600    pageToken: The standard page token.
6601  """
6602
6603  filter = _messages.StringField(1)
6604  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
6605  pageToken = _messages.StringField(3)
6606
6607
6608class GoogleCloudAiplatformV1SearchMigratableResourcesResponse(_messages.Message):
6609  r"""Response message for MigrationService.SearchMigratableResources.
6610
6611  Fields:
6612    migratableResources: All migratable resources that can be migrated to the
6613      location specified in the request.
6614    nextPageToken: The standard next-page token. The migratable_resources may
6615      not fill page_size in SearchMigratableResourcesRequest even when there
6616      are subsequent pages.
6617  """
6618
6619  migratableResources = _messages.MessageField('GoogleCloudAiplatformV1MigratableResource', 1, repeated=True)
6620  nextPageToken = _messages.StringField(2)
6621
6622
6623class GoogleCloudAiplatformV1SpecialistPool(_messages.Message):
6624  r"""SpecialistPool represents customers' own workforce to work on their data
6625  labeling jobs. It includes a group of specialist managers who are
6626  responsible for managing the labelers in this pool as well as customers'
6627  data labeling jobs associated with this pool. Customers create specialist
6628  pool as well as start data labeling jobs on Cloud, managers and labelers
6629  work with the jobs using CrowdCompute console.
6630
6631  Fields:
6632    displayName: Required. The user-defined name of the SpecialistPool. The
6633      name can be up to 128 characters long and can be consist of any UTF-8
6634      characters. This field should be unique on project-level.
6635    name: Required. The resource name of the SpecialistPool.
6636    pendingDataLabelingJobs: Output only. The resource name of the pending
6637      data labeling jobs.
6638    specialistManagerEmails: The email addresses of the specialists in the
6639      SpecialistPool.
6640    specialistManagersCount: Output only. The number of Specialists in this
6641      SpecialistPool.
6642  """
6643
6644  displayName = _messages.StringField(1)
6645  name = _messages.StringField(2)
6646  pendingDataLabelingJobs = _messages.StringField(3, repeated=True)
6647  specialistManagerEmails = _messages.StringField(4, repeated=True)
6648  specialistManagersCount = _messages.IntegerField(5, variant=_messages.Variant.INT32)
6649
6650
6651class GoogleCloudAiplatformV1StudySpec(_messages.Message):
6652  r"""Represents specification of a Study.
6653
6654  Enums:
6655    AlgorithmValueValuesEnum: The search algorithm specified for the Study.
6656    MeasurementSelectionTypeValueValuesEnum: Describe which measurement
6657      selection type will be used
6658    ObservationNoiseValueValuesEnum: The observation noise level of the study.
6659      Currently only supported by the Vizier service. Not supported by
6660      HyperparamterTuningJob or TrainingPipeline.
6661
6662  Fields:
6663    algorithm: The search algorithm specified for the Study.
6664    measurementSelectionType: Describe which measurement selection type will
6665      be used
6666    metrics: Required. Metric specs for the Study.
6667    observationNoise: The observation noise level of the study. Currently only
6668      supported by the Vizier service. Not supported by HyperparamterTuningJob
6669      or TrainingPipeline.
6670    parameters: Required. The set of parameters to tune.
6671  """
6672
6673  class AlgorithmValueValuesEnum(_messages.Enum):
6674    r"""The search algorithm specified for the Study.
6675
6676    Values:
6677      ALGORITHM_UNSPECIFIED: The default algorithm used by AI Platform
6678        Optimization service.
6679      GRID_SEARCH: Simple grid search within the feasible space. To use grid
6680        search, all parameters must be `INTEGER`, `CATEGORICAL`, or
6681        `DISCRETE`.
6682      RANDOM_SEARCH: Simple random search within the feasible space.
6683    """
6684    ALGORITHM_UNSPECIFIED = 0
6685    GRID_SEARCH = 1
6686    RANDOM_SEARCH = 2
6687
6688  class MeasurementSelectionTypeValueValuesEnum(_messages.Enum):
6689    r"""Describe which measurement selection type will be used
6690
6691    Values:
6692      MEASUREMENT_SELECTION_TYPE_UNSPECIFIED: Will be treated as
6693        LAST_MEASUREMENT.
6694      LAST_MEASUREMENT: Use the last measurement reported.
6695      BEST_MEASUREMENT: Use the best measurement reported.
6696    """
6697    MEASUREMENT_SELECTION_TYPE_UNSPECIFIED = 0
6698    LAST_MEASUREMENT = 1
6699    BEST_MEASUREMENT = 2
6700
6701  class ObservationNoiseValueValuesEnum(_messages.Enum):
6702    r"""The observation noise level of the study. Currently only supported by
6703    the Vizier service. Not supported by HyperparamterTuningJob or
6704    TrainingPipeline.
6705
6706    Values:
6707      OBSERVATION_NOISE_UNSPECIFIED: The default noise level chosen by the AI
6708        Platform service.
6709      LOW: AI Platform Vizier assumes that the objective function is (nearly)
6710        perfectly reproducible, and will never repeat the same Trial
6711        parameters.
6712      HIGH: AI Platform Vizier will estimate the amount of noise in metric
6713        evaluations, it may repeat the same Trial parameters more than once.
6714    """
6715    OBSERVATION_NOISE_UNSPECIFIED = 0
6716    LOW = 1
6717    HIGH = 2
6718
6719  algorithm = _messages.EnumField('AlgorithmValueValuesEnum', 1)
6720  measurementSelectionType = _messages.EnumField('MeasurementSelectionTypeValueValuesEnum', 2)
6721  metrics = _messages.MessageField('GoogleCloudAiplatformV1StudySpecMetricSpec', 3, repeated=True)
6722  observationNoise = _messages.EnumField('ObservationNoiseValueValuesEnum', 4)
6723  parameters = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpec', 5, repeated=True)
6724
6725
6726class GoogleCloudAiplatformV1StudySpecMetricSpec(_messages.Message):
6727  r"""Represents a metric to optimize.
6728
6729  Enums:
6730    GoalValueValuesEnum: Required. The optimization goal of the metric.
6731
6732  Fields:
6733    goal: Required. The optimization goal of the metric.
6734    metricId: Required. The ID of the metric. Must not contain whitespaces and
6735      must be unique amongst all MetricSpecs.
6736  """
6737
6738  class GoalValueValuesEnum(_messages.Enum):
6739    r"""Required. The optimization goal of the metric.
6740
6741    Values:
6742      GOAL_TYPE_UNSPECIFIED: Goal Type will default to maximize.
6743      MAXIMIZE: Maximize the goal metric.
6744      MINIMIZE: Minimize the goal metric.
6745    """
6746    GOAL_TYPE_UNSPECIFIED = 0
6747    MAXIMIZE = 1
6748    MINIMIZE = 2
6749
6750  goal = _messages.EnumField('GoalValueValuesEnum', 1)
6751  metricId = _messages.StringField(2)
6752
6753
6754class GoogleCloudAiplatformV1StudySpecParameterSpec(_messages.Message):
6755  r"""Represents a single parameter to optimize.
6756
6757  Enums:
6758    ScaleTypeValueValuesEnum: How the parameter should be scaled. Leave unset
6759      for `CATEGORICAL` parameters.
6760
6761  Fields:
6762    categoricalValueSpec: The value spec for a 'CATEGORICAL' parameter.
6763    conditionalParameterSpecs: A conditional parameter node is active if the
6764      parameter's value matches the conditional node's parent_value_condition.
6765      If two items in conditional_parameter_specs have the same name, they
6766      must have disjoint parent_value_condition.
6767    discreteValueSpec: The value spec for a 'DISCRETE' parameter.
6768    doubleValueSpec: The value spec for a 'DOUBLE' parameter.
6769    integerValueSpec: The value spec for an 'INTEGER' parameter.
6770    parameterId: Required. The ID of the parameter. Must not contain
6771      whitespaces and must be unique amongst all ParameterSpecs.
6772    scaleType: How the parameter should be scaled. Leave unset for
6773      `CATEGORICAL` parameters.
6774  """
6775
6776  class ScaleTypeValueValuesEnum(_messages.Enum):
6777    r"""How the parameter should be scaled. Leave unset for `CATEGORICAL`
6778    parameters.
6779
6780    Values:
6781      SCALE_TYPE_UNSPECIFIED: By default, no scaling is applied.
6782      UNIT_LINEAR_SCALE: Scales the feasible space to (0, 1) linearly.
6783      UNIT_LOG_SCALE: Scales the feasible space logarithmically to (0, 1). The
6784        entire feasible space must be strictly positive.
6785      UNIT_REVERSE_LOG_SCALE: Scales the feasible space "reverse"
6786        logarithmically to (0, 1). The result is that values close to the top
6787        of the feasible space are spread out more than points near the bottom.
6788        The entire feasible space must be strictly positive.
6789    """
6790    SCALE_TYPE_UNSPECIFIED = 0
6791    UNIT_LINEAR_SCALE = 1
6792    UNIT_LOG_SCALE = 2
6793    UNIT_REVERSE_LOG_SCALE = 3
6794
6795  categoricalValueSpec = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec', 1)
6796  conditionalParameterSpecs = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec', 2, repeated=True)
6797  discreteValueSpec = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec', 3)
6798  doubleValueSpec = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec', 4)
6799  integerValueSpec = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec', 5)
6800  parameterId = _messages.StringField(6)
6801  scaleType = _messages.EnumField('ScaleTypeValueValuesEnum', 7)
6802
6803
6804class GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec(_messages.Message):
6805  r"""Value specification for a parameter in `CATEGORICAL` type.
6806
6807  Fields:
6808    values: Required. The list of possible categories.
6809  """
6810
6811  values = _messages.StringField(1, repeated=True)
6812
6813
6814class GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec(_messages.Message):
6815  r"""Represents a parameter spec with condition from its parent parameter.
6816
6817  Fields:
6818    parameterSpec: Required. The spec for a conditional parameter.
6819    parentCategoricalValues: The spec for matching values from a parent
6820      parameter of `CATEGORICAL` type.
6821    parentDiscreteValues: The spec for matching values from a parent parameter
6822      of `DISCRETE` type.
6823    parentIntValues: The spec for matching values from a parent parameter of
6824      `INTEGER` type.
6825  """
6826
6827  parameterSpec = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpec', 1)
6828  parentCategoricalValues = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition', 2)
6829  parentDiscreteValues = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition', 3)
6830  parentIntValues = _messages.MessageField('GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition', 4)
6831
6832
6833class GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition(_messages.Message):
6834  r"""Represents the spec to match categorical values from parent parameter.
6835
6836  Fields:
6837    values: Required. Matches values of the parent parameter of 'CATEGORICAL'
6838      type. All values must exist in `categorical_value_spec` of parent
6839      parameter.
6840  """
6841
6842  values = _messages.StringField(1, repeated=True)
6843
6844
6845class GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition(_messages.Message):
6846  r"""Represents the spec to match discrete values from parent parameter.
6847
6848  Fields:
6849    values: Required. Matches values of the parent parameter of 'DISCRETE'
6850      type. All values must exist in `discrete_value_spec` of parent
6851      parameter. The Epsilon of the value matching is 1e-10.
6852  """
6853
6854  values = _messages.FloatField(1, repeated=True)
6855
6856
6857class GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition(_messages.Message):
6858  r"""Represents the spec to match integer values from parent parameter.
6859
6860  Fields:
6861    values: Required. Matches values of the parent parameter of 'INTEGER'
6862      type. All values must lie in `integer_value_spec` of parent parameter.
6863  """
6864
6865  values = _messages.IntegerField(1, repeated=True)
6866
6867
6868class GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec(_messages.Message):
6869  r"""Value specification for a parameter in `DISCRETE` type.
6870
6871  Fields:
6872    values: Required. A list of possible values. The list should be in
6873      increasing order and at least 1e-10 apart. For instance, this parameter
6874      might have possible settings of 1.5, 2.5, and 4.0. This list should not
6875      contain more than 1,000 values.
6876  """
6877
6878  values = _messages.FloatField(1, repeated=True)
6879
6880
6881class GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec(_messages.Message):
6882  r"""Value specification for a parameter in `DOUBLE` type.
6883
6884  Fields:
6885    maxValue: Required. Inclusive maximum value of the parameter.
6886    minValue: Required. Inclusive minimum value of the parameter.
6887  """
6888
6889  maxValue = _messages.FloatField(1)
6890  minValue = _messages.FloatField(2)
6891
6892
6893class GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec(_messages.Message):
6894  r"""Value specification for a parameter in `INTEGER` type.
6895
6896  Fields:
6897    maxValue: Required. Inclusive maximum value of the parameter.
6898    minValue: Required. Inclusive minimum value of the parameter.
6899  """
6900
6901  maxValue = _messages.IntegerField(1)
6902  minValue = _messages.IntegerField(2)
6903
6904
6905class GoogleCloudAiplatformV1TimestampSplit(_messages.Message):
6906  r"""Assigns input data to training, validation, and test sets based on a
6907  provided timestamps. The youngest data pieces are assigned to training set,
6908  next to validation set, and the oldest to the test set. Supported only for
6909  tabular Datasets.
6910
6911  Fields:
6912    key: Required. The key is a name of one of the Dataset's data columns. The
6913      values of the key (the values in the column) must be in RFC 3339 `date-
6914      time` format, where `time-offset` = `"Z"` (e.g.
6915      1985-04-12T23:20:50.52Z). If for a piece of data the key is not present
6916      or has an invalid value, that piece is ignored by the pipeline.
6917    testFraction: The fraction of the input data that is to be used to
6918      evaluate the Model.
6919    trainingFraction: The fraction of the input data that is to be used to
6920      train the Model.
6921    validationFraction: The fraction of the input data that is to be used to
6922      validate the Model.
6923  """
6924
6925  key = _messages.StringField(1)
6926  testFraction = _messages.FloatField(2)
6927  trainingFraction = _messages.FloatField(3)
6928  validationFraction = _messages.FloatField(4)
6929
6930
6931class GoogleCloudAiplatformV1TrainingConfig(_messages.Message):
6932  r"""CMLE training config. For every active learning labeling iteration,
6933  system will train a machine learning model on CMLE. The trained model will
6934  be used by data sampling algorithm to select DataItems.
6935
6936  Fields:
6937    timeoutTrainingMilliHours: The timeout hours for the CMLE training job,
6938      expressed in milli hours i.e. 1,000 value in this field means 1 hour.
6939  """
6940
6941  timeoutTrainingMilliHours = _messages.IntegerField(1)
6942
6943
6944class GoogleCloudAiplatformV1TrainingPipeline(_messages.Message):
6945  r"""The TrainingPipeline orchestrates tasks associated with training a
6946  Model. It always executes the training task, and optionally may also export
6947  data from AI Platform's Dataset which becomes the training input, upload the
6948  Model to AI Platform, and evaluate the Model.
6949
6950  Enums:
6951    StateValueValuesEnum: Output only. The detailed state of the pipeline.
6952
6953  Messages:
6954    LabelsValue: The labels with user-defined metadata to organize
6955      TrainingPipelines. Label keys and values can be no longer than 64
6956      characters (Unicode codepoints), can only contain lowercase letters,
6957      numeric characters, underscores and dashes. International characters are
6958      allowed. See https://goo.gl/xmQnxf for more information and examples of
6959      labels.
6960
6961  Fields:
6962    createTime: Output only. Time when the TrainingPipeline was created.
6963    displayName: Required. The user-defined name of this TrainingPipeline.
6964    encryptionSpec: Customer-managed encryption key spec for a
6965      TrainingPipeline. If set, this TrainingPipeline will be secured by this
6966      key. Note: Model trained by this TrainingPipeline is also secured by
6967      this key if model_to_upload is not set separately.
6968    endTime: Output only. Time when the TrainingPipeline entered any of the
6969      following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`,
6970      `PIPELINE_STATE_CANCELLED`.
6971    error: Output only. Only populated when the pipeline's state is
6972      `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`.
6973    inputDataConfig: Specifies AI Platform owned input data that may be used
6974      for training the Model. The TrainingPipeline's training_task_definition
6975      should make clear whether this config is used and if there are any
6976      special requirements on how it should be filled. If nothing about this
6977      config is mentioned in the training_task_definition, then it should be
6978      assumed that the TrainingPipeline does not depend on this configuration.
6979    labels: The labels with user-defined metadata to organize
6980      TrainingPipelines. Label keys and values can be no longer than 64
6981      characters (Unicode codepoints), can only contain lowercase letters,
6982      numeric characters, underscores and dashes. International characters are
6983      allowed. See https://goo.gl/xmQnxf for more information and examples of
6984      labels.
6985    modelToUpload: Describes the Model that may be uploaded (via
6986      ModelService.UploadModel) by this TrainingPipeline. The
6987      TrainingPipeline's training_task_definition should make clear whether
6988      this Model description should be populated, and if there are any special
6989      requirements regarding how it should be filled. If nothing is mentioned
6990      in the training_task_definition, then it should be assumed that this
6991      field should not be filled and the training task either uploads the
6992      Model without a need of this information, or that training task does not
6993      support uploading a Model as part of the pipeline. When the Pipeline's
6994      state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been
6995      uploaded into AI Platform, then the model_to_upload's resource name is
6996      populated. The Model is always uploaded into the Project and Location in
6997      which this pipeline is.
6998    name: Output only. Resource name of the TrainingPipeline.
6999    startTime: Output only. Time when the TrainingPipeline for the first time
7000      entered the `PIPELINE_STATE_RUNNING` state.
7001    state: Output only. The detailed state of the pipeline.
7002    trainingTaskDefinition: Required. A Google Cloud Storage path to the YAML
7003      file that defines the training task which is responsible for producing
7004      the model artifact, and may also include additional auxiliary work. The
7005      definition files that can be used here are found in gs://google-cloud-
7006      aiplatform/schema/trainingjob/definition/. Note: The URI given on output
7007      will be immutable and probably different, including the URI scheme, than
7008      the one given on input. The output URI will point to a location where
7009      the user only has a read access.
7010    trainingTaskInputs: Required. The training task's parameter(s), as
7011      specified in the training_task_definition's `inputs`.
7012    trainingTaskMetadata: Output only. The metadata information as specified
7013      in the training_task_definition's `metadata`. This metadata is an
7014      auxiliary runtime and final information about the training task. While
7015      the pipeline is running this information is populated only at a best
7016      effort basis. Only present if the pipeline's training_task_definition
7017      contains `metadata` object.
7018    updateTime: Output only. Time when the TrainingPipeline was most recently
7019      updated.
7020  """
7021
7022  class StateValueValuesEnum(_messages.Enum):
7023    r"""Output only. The detailed state of the pipeline.
7024
7025    Values:
7026      PIPELINE_STATE_UNSPECIFIED: The pipeline state is unspecified.
7027      PIPELINE_STATE_QUEUED: The pipeline has been just created or resumed and
7028        processing has not yet begun.
7029      PIPELINE_STATE_PENDING: The service is preparing to run the pipeline.
7030      PIPELINE_STATE_RUNNING: The pipeline is in progress.
7031      PIPELINE_STATE_SUCCEEDED: The pipeline completed successfully.
7032      PIPELINE_STATE_FAILED: The pipeline failed.
7033      PIPELINE_STATE_CANCELLING: The pipeline is being cancelled. From this
7034        state the pipeline may only go to either PIPELINE_STATE_SUCCEEDED,
7035        PIPELINE_STATE_FAILED or PIPELINE_STATE_CANCELLED.
7036      PIPELINE_STATE_CANCELLED: The pipeline has been cancelled.
7037      PIPELINE_STATE_PAUSED: The pipeline has been stopped, and can be
7038        resumed.
7039    """
7040    PIPELINE_STATE_UNSPECIFIED = 0
7041    PIPELINE_STATE_QUEUED = 1
7042    PIPELINE_STATE_PENDING = 2
7043    PIPELINE_STATE_RUNNING = 3
7044    PIPELINE_STATE_SUCCEEDED = 4
7045    PIPELINE_STATE_FAILED = 5
7046    PIPELINE_STATE_CANCELLING = 6
7047    PIPELINE_STATE_CANCELLED = 7
7048    PIPELINE_STATE_PAUSED = 8
7049
7050  @encoding.MapUnrecognizedFields('additionalProperties')
7051  class LabelsValue(_messages.Message):
7052    r"""The labels with user-defined metadata to organize TrainingPipelines.
7053    Label keys and values can be no longer than 64 characters (Unicode
7054    codepoints), can only contain lowercase letters, numeric characters,
7055    underscores and dashes. International characters are allowed. See
7056    https://goo.gl/xmQnxf for more information and examples of labels.
7057
7058    Messages:
7059      AdditionalProperty: An additional property for a LabelsValue object.
7060
7061    Fields:
7062      additionalProperties: Additional properties of type LabelsValue
7063    """
7064
7065    class AdditionalProperty(_messages.Message):
7066      r"""An additional property for a LabelsValue object.
7067
7068      Fields:
7069        key: Name of the additional property.
7070        value: A string attribute.
7071      """
7072
7073      key = _messages.StringField(1)
7074      value = _messages.StringField(2)
7075
7076    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
7077
7078  createTime = _messages.StringField(1)
7079  displayName = _messages.StringField(2)
7080  encryptionSpec = _messages.MessageField('GoogleCloudAiplatformV1EncryptionSpec', 3)
7081  endTime = _messages.StringField(4)
7082  error = _messages.MessageField('GoogleRpcStatus', 5)
7083  inputDataConfig = _messages.MessageField('GoogleCloudAiplatformV1InputDataConfig', 6)
7084  labels = _messages.MessageField('LabelsValue', 7)
7085  modelToUpload = _messages.MessageField('GoogleCloudAiplatformV1Model', 8)
7086  name = _messages.StringField(9)
7087  startTime = _messages.StringField(10)
7088  state = _messages.EnumField('StateValueValuesEnum', 11)
7089  trainingTaskDefinition = _messages.StringField(12)
7090  trainingTaskInputs = _messages.MessageField('extra_types.JsonValue', 13)
7091  trainingTaskMetadata = _messages.MessageField('extra_types.JsonValue', 14)
7092  updateTime = _messages.StringField(15)
7093
7094
7095class GoogleCloudAiplatformV1Trial(_messages.Message):
7096  r"""A message representing a Trial. A Trial contains a unique set of
7097  Parameters that has been or will be evaluated, along with the objective
7098  metrics got by running the Trial.
7099
7100  Enums:
7101    StateValueValuesEnum: Output only. The detailed state of the Trial.
7102
7103  Fields:
7104    customJob: Output only. The CustomJob name linked to the Trial. It's set
7105      for a HyperparameterTuningJob's Trial.
7106    endTime: Output only. Time when the Trial's status changed to `SUCCEEDED`
7107      or `INFEASIBLE`.
7108    finalMeasurement: Output only. The final measurement containing the
7109      objective value.
7110    id: Output only. The identifier of the Trial assigned by the service.
7111    name: Output only. Resource name of the Trial assigned by the service.
7112    parameters: Output only. The parameters of the Trial.
7113    startTime: Output only. Time when the Trial was started.
7114    state: Output only. The detailed state of the Trial.
7115  """
7116
7117  class StateValueValuesEnum(_messages.Enum):
7118    r"""Output only. The detailed state of the Trial.
7119
7120    Values:
7121      STATE_UNSPECIFIED: The Trial state is unspecified.
7122      REQUESTED: Indicates that a specific Trial has been requested, but it
7123        has not yet been suggested by the service.
7124      ACTIVE: Indicates that the Trial has been suggested.
7125      STOPPING: Indicates that the Trial should stop according to the service.
7126      SUCCEEDED: Indicates that the Trial is completed successfully.
7127      INFEASIBLE: Indicates that the Trial should not be attempted again. The
7128        service will set a Trial to INFEASIBLE when it's done but missing the
7129        final_measurement.
7130    """
7131    STATE_UNSPECIFIED = 0
7132    REQUESTED = 1
7133    ACTIVE = 2
7134    STOPPING = 3
7135    SUCCEEDED = 4
7136    INFEASIBLE = 5
7137
7138  customJob = _messages.StringField(1)
7139  endTime = _messages.StringField(2)
7140  finalMeasurement = _messages.MessageField('GoogleCloudAiplatformV1Measurement', 3)
7141  id = _messages.StringField(4)
7142  name = _messages.StringField(5)
7143  parameters = _messages.MessageField('GoogleCloudAiplatformV1TrialParameter', 6, repeated=True)
7144  startTime = _messages.StringField(7)
7145  state = _messages.EnumField('StateValueValuesEnum', 8)
7146
7147
7148class GoogleCloudAiplatformV1TrialParameter(_messages.Message):
7149  r"""A message representing a parameter to be tuned.
7150
7151  Fields:
7152    parameterId: Output only. The ID of the parameter. The parameter should be
7153      defined in StudySpec's Parameters.
7154    value: Output only. The value of the parameter. `number_value` will be set
7155      if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or
7156      'DISCRETE'. `string_value` will be set if a parameter defined in
7157      StudySpec is in type 'CATEGORICAL'.
7158  """
7159
7160  parameterId = _messages.StringField(1)
7161  value = _messages.MessageField('extra_types.JsonValue', 2)
7162
7163
7164class GoogleCloudAiplatformV1UndeployModelOperationMetadata(_messages.Message):
7165  r"""Runtime operation information for EndpointService.UndeployModel.
7166
7167  Fields:
7168    genericMetadata: The operation generic information.
7169  """
7170
7171  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
7172
7173
7174class GoogleCloudAiplatformV1UndeployModelRequest(_messages.Message):
7175  r"""Request message for EndpointService.UndeployModel.
7176
7177  Messages:
7178    TrafficSplitValue: If this field is provided, then the Endpoint's
7179      traffic_split will be overwritten with it. If last DeployedModel is
7180      being undeployed from the Endpoint, the [Endpoint.traffic_split] will
7181      always end up empty when this call returns. A DeployedModel will be
7182      successfully undeployed only if it doesn't have any traffic assigned to
7183      it when this method executes, or if this field unassigns any traffic to
7184      it.
7185
7186  Fields:
7187    deployedModelId: Required. The ID of the DeployedModel to be undeployed
7188      from the Endpoint.
7189    trafficSplit: If this field is provided, then the Endpoint's traffic_split
7190      will be overwritten with it. If last DeployedModel is being undeployed
7191      from the Endpoint, the [Endpoint.traffic_split] will always end up empty
7192      when this call returns. A DeployedModel will be successfully undeployed
7193      only if it doesn't have any traffic assigned to it when this method
7194      executes, or if this field unassigns any traffic to it.
7195  """
7196
7197  @encoding.MapUnrecognizedFields('additionalProperties')
7198  class TrafficSplitValue(_messages.Message):
7199    r"""If this field is provided, then the Endpoint's traffic_split will be
7200    overwritten with it. If last DeployedModel is being undeployed from the
7201    Endpoint, the [Endpoint.traffic_split] will always end up empty when this
7202    call returns. A DeployedModel will be successfully undeployed only if it
7203    doesn't have any traffic assigned to it when this method executes, or if
7204    this field unassigns any traffic to it.
7205
7206    Messages:
7207      AdditionalProperty: An additional property for a TrafficSplitValue
7208        object.
7209
7210    Fields:
7211      additionalProperties: Additional properties of type TrafficSplitValue
7212    """
7213
7214    class AdditionalProperty(_messages.Message):
7215      r"""An additional property for a TrafficSplitValue object.
7216
7217      Fields:
7218        key: Name of the additional property.
7219        value: A integer attribute.
7220      """
7221
7222      key = _messages.StringField(1)
7223      value = _messages.IntegerField(2, variant=_messages.Variant.INT32)
7224
7225    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
7226
7227  deployedModelId = _messages.StringField(1)
7228  trafficSplit = _messages.MessageField('TrafficSplitValue', 2)
7229
7230
7231class GoogleCloudAiplatformV1UndeployModelResponse(_messages.Message):
7232  r"""Response message for EndpointService.UndeployModel."""
7233
7234
7235class GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata(_messages.Message):
7236  r"""Runtime operation metadata for
7237  SpecialistPoolService.UpdateSpecialistPool.
7238
7239  Fields:
7240    genericMetadata: The operation generic information.
7241    specialistPool: Output only. The name of the SpecialistPool to which the
7242      specialists are being added. Format: `projects/{project_id}/locations/{l
7243      ocation_id}/specialistPools/{specialist_pool}`
7244  """
7245
7246  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
7247  specialistPool = _messages.StringField(2)
7248
7249
7250class GoogleCloudAiplatformV1UploadModelOperationMetadata(_messages.Message):
7251  r"""Details of ModelService.UploadModel operation.
7252
7253  Fields:
7254    genericMetadata: The common part of the operation metadata.
7255  """
7256
7257  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1GenericOperationMetadata', 1)
7258
7259
7260class GoogleCloudAiplatformV1UploadModelRequest(_messages.Message):
7261  r"""Request message for ModelService.UploadModel.
7262
7263  Fields:
7264    model: Required. The Model to create.
7265  """
7266
7267  model = _messages.MessageField('GoogleCloudAiplatformV1Model', 1)
7268
7269
7270class GoogleCloudAiplatformV1UploadModelResponse(_messages.Message):
7271  r"""Response message of ModelService.UploadModel operation.
7272
7273  Fields:
7274    model: The name of the uploaded Model resource. Format:
7275      `projects/{project}/locations/{location}/models/{model}`
7276  """
7277
7278  model = _messages.StringField(1)
7279
7280
7281class GoogleCloudAiplatformV1UserActionReference(_messages.Message):
7282  r"""References an API call. It contains more information about long running
7283  operation and Jobs that are triggered by the API call.
7284
7285  Fields:
7286    dataLabelingJob: For API calls that start a LabelingJob. Resource name of
7287      the LabelingJob. Format: 'projects/{project}/locations/{location}/dataLa
7288      belingJobs/{data_labeling_job}'
7289    method: The method name of the API call. For example,
7290      "/google.cloud.aiplatform.v1alpha1.DatasetService.CreateDataset"
7291    operation: For API calls that return a long running operation. Resource
7292      name of the long running operation. Format:
7293      'projects/{project}/locations/{location}/operations/{operation}'
7294  """
7295
7296  dataLabelingJob = _messages.StringField(1)
7297  method = _messages.StringField(2)
7298  operation = _messages.StringField(3)
7299
7300
7301class GoogleCloudAiplatformV1WorkerPoolSpec(_messages.Message):
7302  r"""Represents the spec of a worker pool in a job.
7303
7304  Fields:
7305    containerSpec: The custom container task.
7306    diskSpec: Disk spec.
7307    machineSpec: Optional. Immutable. The specification of a single machine.
7308    pythonPackageSpec: The Python packaged task.
7309    replicaCount: Optional. The number of worker replicas to use for this
7310      worker pool.
7311  """
7312
7313  containerSpec = _messages.MessageField('GoogleCloudAiplatformV1ContainerSpec', 1)
7314  diskSpec = _messages.MessageField('GoogleCloudAiplatformV1DiskSpec', 2)
7315  machineSpec = _messages.MessageField('GoogleCloudAiplatformV1MachineSpec', 3)
7316  pythonPackageSpec = _messages.MessageField('GoogleCloudAiplatformV1PythonPackageSpec', 4)
7317  replicaCount = _messages.IntegerField(5)
7318
7319
7320class GoogleCloudAiplatformV1alpha1AutomaticResources(_messages.Message):
7321  r"""A description of resources that to large degree are decided by AI
7322  Platform, and require only a modest additional configuration. Each Model
7323  supporting these resources documents its specific guidelines.
7324
7325  Fields:
7326    maxReplicaCount: Immutable. The maximum number of replicas this
7327      DeployedModel may be deployed on when the traffic against it increases.
7328      If the requested value is too large, the deployment will error, but if
7329      deployment succeeds then the ability to scale the model to that many
7330      replicas is guaranteed (barring service outages). If traffic against the
7331      DeployedModel increases beyond what its replicas at maximum may handle,
7332      a portion of the traffic will be dropped. If this value is not provided,
7333      a no upper bound for scaling under heavy traffic will be assume, though
7334      AI Platform may be unable to scale beyond certain replica number.
7335    minReplicaCount: Immutable. The minimum number of replicas this
7336      DeployedModel will be always deployed on. If traffic against it
7337      increases, it may dynamically be deployed onto more replicas up to
7338      max_replica_count, and as traffic decreases, some of these extra
7339      replicas may be freed. If the requested value is too large, the
7340      deployment will error.
7341  """
7342
7343  maxReplicaCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
7344  minReplicaCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
7345
7346
7347class GoogleCloudAiplatformV1alpha1BatchMigrateResourcesOperationMetadata(_messages.Message):
7348  r"""Runtime operation information for
7349  MigrationService.BatchMigrateResources.
7350
7351  Fields:
7352    genericMetadata: The common part of the operation metadata.
7353    partialResults: Partial results that reflect the latest migration
7354      operation progress.
7355  """
7356
7357  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7358  partialResults = _messages.MessageField('GoogleCloudAiplatformV1alpha1BatchMigrateResourcesOperationMetadataPartialResult', 2, repeated=True)
7359
7360
7361class GoogleCloudAiplatformV1alpha1BatchMigrateResourcesOperationMetadataPartialResult(_messages.Message):
7362  r"""Represents a partial result in batch migration operation for one
7363  MigrateResourceRequest.
7364
7365  Fields:
7366    dataset: Migrated dataset resource name.
7367    error: The error result of the migration request in case of failure.
7368    model: Migrated model resource name.
7369    request: It's the same as the value in
7370      MigrateResourceRequest.migrate_resource_requests.
7371  """
7372
7373  dataset = _messages.StringField(1)
7374  error = _messages.MessageField('GoogleRpcStatus', 2)
7375  model = _messages.StringField(3)
7376  request = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigrateResourceRequest', 4)
7377
7378
7379class GoogleCloudAiplatformV1alpha1BatchMigrateResourcesResponse(_messages.Message):
7380  r"""Response message for MigrationService.BatchMigrateResources.
7381
7382  Fields:
7383    migrateResourceResponses: Successfully migrated resources.
7384  """
7385
7386  migrateResourceResponses = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigrateResourceResponse', 1, repeated=True)
7387
7388
7389class GoogleCloudAiplatformV1alpha1CreateDatasetOperationMetadata(_messages.Message):
7390  r"""Runtime operation information for DatasetService.CreateDataset.
7391
7392  Fields:
7393    genericMetadata: The operation generic information.
7394  """
7395
7396  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7397
7398
7399class GoogleCloudAiplatformV1alpha1CreateEndpointOperationMetadata(_messages.Message):
7400  r"""Runtime operation information for EndpointService.CreateEndpoint.
7401
7402  Fields:
7403    genericMetadata: The operation generic information.
7404  """
7405
7406  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7407
7408
7409class GoogleCloudAiplatformV1alpha1CreateIndexEndpointOperationMetadata(_messages.Message):
7410  r"""Runtime operation information for
7411  IndexEndpointService.CreateIndexEndpoint.
7412
7413  Fields:
7414    genericMetadata: The operation generic information.
7415  """
7416
7417  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7418
7419
7420class GoogleCloudAiplatformV1alpha1CreateIndexOperationMetadata(_messages.Message):
7421  r"""Runtime operation information for IndexService.CreateIndex.
7422
7423  Fields:
7424    genericMetadata: The operation generic information.
7425    nearestNeighborSearchOperationMetadata: The operation metadata with regard
7426      to ScaNN Index operation.
7427  """
7428
7429  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7430  nearestNeighborSearchOperationMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadata', 2)
7431
7432
7433class GoogleCloudAiplatformV1alpha1CreateSpecialistPoolOperationMetadata(_messages.Message):
7434  r"""Runtime operation information for
7435  SpecialistPoolService.CreateSpecialistPool.
7436
7437  Fields:
7438    genericMetadata: The operation generic information.
7439  """
7440
7441  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7442
7443
7444class GoogleCloudAiplatformV1alpha1DedicatedResources(_messages.Message):
7445  r"""A description of resources that are dedicated to a DeployedModel, and
7446  that need a higher degree of manual configuration.
7447
7448  Fields:
7449    machineSpec: Required. Immutable. The specification of a single machine
7450      used by the prediction.
7451    minReplicaCount: Required. Immutable. The minimum number of machine
7452      replicas this DeployedModel will be always deployed on. If traffic
7453      against it increases, it may dynamically be deployed onto more replicas,
7454      and as traffic decreases, some of these extra replicas may be freed.
7455      Note: if machine_spec.accelerator_count is above 0, currently the model
7456      will be always deployed precisely on min_replica_count.
7457  """
7458
7459  machineSpec = _messages.MessageField('GoogleCloudAiplatformV1alpha1MachineSpec', 1)
7460  minReplicaCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
7461
7462
7463class GoogleCloudAiplatformV1alpha1DeleteOperationMetadata(_messages.Message):
7464  r"""Details of operations that perform deletes of any entities.
7465
7466  Fields:
7467    genericMetadata: The common part of the operation metadata.
7468  """
7469
7470  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7471
7472
7473class GoogleCloudAiplatformV1alpha1DeployIndexOperationMetadata(_messages.Message):
7474  r"""Runtime operation information for IndexEndpointService.DeployIndex.
7475
7476  Fields:
7477    genericMetadata: The operation generic information.
7478  """
7479
7480  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7481
7482
7483class GoogleCloudAiplatformV1alpha1DeployIndexResponse(_messages.Message):
7484  r"""Response message for IndexEndpointService.DeployIndex.
7485
7486  Fields:
7487    deployedIndex: The DeployedIndex that had been deployed in the
7488      IndexEndpoint.
7489  """
7490
7491  deployedIndex = _messages.MessageField('GoogleCloudAiplatformV1alpha1DeployedIndex', 1)
7492
7493
7494class GoogleCloudAiplatformV1alpha1DeployModelOperationMetadata(_messages.Message):
7495  r"""Runtime operation information for EndpointService.DeployModel.
7496
7497  Fields:
7498    genericMetadata: The operation generic information.
7499  """
7500
7501  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7502
7503
7504class GoogleCloudAiplatformV1alpha1DeployModelResponse(_messages.Message):
7505  r"""Response message for EndpointService.DeployModel.
7506
7507  Fields:
7508    deployedModel: The DeployedModel that had been deployed in the Endpoint.
7509  """
7510
7511  deployedModel = _messages.MessageField('GoogleCloudAiplatformV1alpha1DeployedModel', 1)
7512
7513
7514class GoogleCloudAiplatformV1alpha1DeployedIndex(_messages.Message):
7515  r"""A deployment of an Index. IndexEndpoints contain one or more
7516  DeployedIndexes.
7517
7518  Fields:
7519    automaticResources: Optional. A description of resources that the
7520      DeployedIndex uses, which to large degree are decided by AI Platform,
7521      and optionally allows only a modest additional configuration. If
7522      min_replica_count is not set, the default value is 1. If
7523      max_replica_count is not set, the default value is min_replica_count.
7524      The max allowed replica count is 1000. The user is billed for the
7525      resources (at least their minimal amount) even if the DeployedIndex
7526      receives no traffic.
7527    createTime: Output only. Timestamp when the DeployedIndex was created.
7528    displayName: The display name of the DeployedIndex. If not provided upon
7529      creation, the Index's display_name is used.
7530    id: Required. The user specified ID of the DeployedIndex. The ID can be up
7531      to 128 characters long and must start with a letter and only contain
7532      letters, numbers, and underscores. The ID must be unique within the
7533      project it is created in.
7534    index: Required. The name of the Index this is the deployment of. We may
7535      refer to this Index as the DeployedIndex's "original" Index.
7536    indexSyncTime: Output only. The DeployedIndex may depend on various data
7537      on its original Index. Additionally when certain changes to the original
7538      Index are being done (e.g. when what the Index contains is being
7539      changed) the DeployedIndex may be asynchronously updated in the
7540      background to reflect this changes. If this timestamp's value is at
7541      least the Index.update_time of the original Index, it means that this
7542      DeployedIndex and the original Index are in sync. If this timestamp is
7543      older, then to see which updates this DeployedIndex already contains
7544      (and which not), one must list Operations working on the original Index.
7545      Only the successfully completed Operations with
7546      Operations.metadata.generic_metadata.update_time equal or before this
7547      sync time are contained in this DeployedIndex.
7548    privateEndpoints: Output only. Provides paths for users to send requests
7549      directly to the deployed index services running on Cloud via private
7550      services access. This field is populated if network is configured.
7551  """
7552
7553  automaticResources = _messages.MessageField('GoogleCloudAiplatformV1alpha1AutomaticResources', 1)
7554  createTime = _messages.StringField(2)
7555  displayName = _messages.StringField(3)
7556  id = _messages.StringField(4)
7557  index = _messages.StringField(5)
7558  indexSyncTime = _messages.StringField(6)
7559  privateEndpoints = _messages.MessageField('GoogleCloudAiplatformV1alpha1IndexPrivateEndpoints', 7)
7560
7561
7562class GoogleCloudAiplatformV1alpha1DeployedModel(_messages.Message):
7563  r"""A deployment of a Model. Endpoints contain one or more DeployedModels.
7564
7565  Fields:
7566    automaticResources: A description of resources that to large degree are
7567      decided by AI Platform, and require only a modest additional
7568      configuration.
7569    createTime: Output only. Timestamp when the DeployedModel was created.
7570    dedicatedResources: A description of resources that are dedicated to the
7571      DeployedModel, and that need a higher degree of manual configuration.
7572    displayName: The display name of the DeployedModel. If not provided upon
7573      creation, the Model's display_name is used.
7574    explanationSpec: Explanation configuration for this DeployedModel. When
7575      deploying a Model using EndpointService.DeployModel, this value
7576      overrides the value of Model.explanation_spec. All fields of
7577      explanation_spec are optional in the request. If a field of
7578      explanation_spec is not populated, the value of the same field of
7579      Model.explanation_spec is inherited. If the corresponding
7580      Model.explanation_spec is not populated, all fields of the
7581      explanation_spec will be used for the explanation configuration.
7582    id: Output only. The ID of the DeployedModel.
7583    model: Required. The name of the Model that this is the deployment of.
7584      Note that the Model may be in a different location than the
7585      DeployedModel's Endpoint.
7586  """
7587
7588  automaticResources = _messages.MessageField('GoogleCloudAiplatformV1alpha1AutomaticResources', 1)
7589  createTime = _messages.StringField(2)
7590  dedicatedResources = _messages.MessageField('GoogleCloudAiplatformV1alpha1DedicatedResources', 3)
7591  displayName = _messages.StringField(4)
7592  explanationSpec = _messages.MessageField('GoogleCloudAiplatformV1alpha1ExplanationSpec', 5)
7593  id = _messages.StringField(6)
7594  model = _messages.StringField(7)
7595
7596
7597class GoogleCloudAiplatformV1alpha1ExplanationMetadata(_messages.Message):
7598  r"""Metadata describing the Model's input and output for explanation.
7599
7600  Messages:
7601    InputsValue: Required. Map from feature names to feature input metadata.
7602      Keys are the name of the features. Values are the specification of the
7603      feature. An empty InputMetadata is valid. It describes a text feature
7604      which has the name specified as the key in ExplanationMetadata.inputs.
7605      The baseline of the empty feature is chosen by AI Platform. For AI
7606      Platform provided Tensorflow images, the key can be any friendly name of
7607      the feature. Once specified, featureAttributions are keyed by this key
7608      (if not grouped with another feature). For custom images, the key must
7609      match with the key in instance.
7610    OutputsValue: Required. Map from output names to output metadata. For AI
7611      Platform provided Tensorflow images, keys can be any string user
7612      defines. For custom images, keys are the name of the output field in the
7613      prediction to be explained. Currently only one key is allowed.
7614
7615  Fields:
7616    featureAttributionsSchemaUri: Points to a YAML file stored on Google Cloud
7617      Storage describing the format of the feature attributions. The schema is
7618      defined as an OpenAPI 3.0.2 [Schema
7619      Object](https://tinyurl.com/y538mdwt#schema-object). AutoML tabular
7620      Models always have this field populated by AI Platform. Note: The URI
7621      given on output may be different, including the URI scheme, than the one
7622      given on input. The output URI will point to a location where the user
7623      only has a read access.
7624    inputs: Required. Map from feature names to feature input metadata. Keys
7625      are the name of the features. Values are the specification of the
7626      feature. An empty InputMetadata is valid. It describes a text feature
7627      which has the name specified as the key in ExplanationMetadata.inputs.
7628      The baseline of the empty feature is chosen by AI Platform. For AI
7629      Platform provided Tensorflow images, the key can be any friendly name of
7630      the feature. Once specified, featureAttributions are keyed by this key
7631      (if not grouped with another feature). For custom images, the key must
7632      match with the key in instance.
7633    outputs: Required. Map from output names to output metadata. For AI
7634      Platform provided Tensorflow images, keys can be any string user
7635      defines. For custom images, keys are the name of the output field in the
7636      prediction to be explained. Currently only one key is allowed.
7637  """
7638
7639  @encoding.MapUnrecognizedFields('additionalProperties')
7640  class InputsValue(_messages.Message):
7641    r"""Required. Map from feature names to feature input metadata. Keys are
7642    the name of the features. Values are the specification of the feature. An
7643    empty InputMetadata is valid. It describes a text feature which has the
7644    name specified as the key in ExplanationMetadata.inputs. The baseline of
7645    the empty feature is chosen by AI Platform. For AI Platform provided
7646    Tensorflow images, the key can be any friendly name of the feature. Once
7647    specified, featureAttributions are keyed by this key (if not grouped with
7648    another feature). For custom images, the key must match with the key in
7649    instance.
7650
7651    Messages:
7652      AdditionalProperty: An additional property for a InputsValue object.
7653
7654    Fields:
7655      additionalProperties: Additional properties of type InputsValue
7656    """
7657
7658    class AdditionalProperty(_messages.Message):
7659      r"""An additional property for a InputsValue object.
7660
7661      Fields:
7662        key: Name of the additional property.
7663        value: A GoogleCloudAiplatformV1alpha1ExplanationMetadataInputMetadata
7664          attribute.
7665      """
7666
7667      key = _messages.StringField(1)
7668      value = _messages.MessageField('GoogleCloudAiplatformV1alpha1ExplanationMetadataInputMetadata', 2)
7669
7670    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
7671
7672  @encoding.MapUnrecognizedFields('additionalProperties')
7673  class OutputsValue(_messages.Message):
7674    r"""Required. Map from output names to output metadata. For AI Platform
7675    provided Tensorflow images, keys can be any string user defines. For
7676    custom images, keys are the name of the output field in the prediction to
7677    be explained. Currently only one key is allowed.
7678
7679    Messages:
7680      AdditionalProperty: An additional property for a OutputsValue object.
7681
7682    Fields:
7683      additionalProperties: Additional properties of type OutputsValue
7684    """
7685
7686    class AdditionalProperty(_messages.Message):
7687      r"""An additional property for a OutputsValue object.
7688
7689      Fields:
7690        key: Name of the additional property.
7691        value: A
7692          GoogleCloudAiplatformV1alpha1ExplanationMetadataOutputMetadata
7693          attribute.
7694      """
7695
7696      key = _messages.StringField(1)
7697      value = _messages.MessageField('GoogleCloudAiplatformV1alpha1ExplanationMetadataOutputMetadata', 2)
7698
7699    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
7700
7701  featureAttributionsSchemaUri = _messages.StringField(1)
7702  inputs = _messages.MessageField('InputsValue', 2)
7703  outputs = _messages.MessageField('OutputsValue', 3)
7704
7705
7706class GoogleCloudAiplatformV1alpha1ExplanationMetadataInputMetadata(_messages.Message):
7707  r"""Metadata of the input of a feature. Fields other than
7708  InputMetadata.input_baselines are applicable only for Models that are using
7709  AI Platform-provided images for Tensorflow.
7710
7711  Fields:
7712    inputBaselines: Baseline inputs for this feature. If no baseline is
7713      specified, AI Platform chooses the baseline for this feature. If
7714      multiple baselines are specified, AI Platform returns the average
7715      attributions across them in Attributions.baseline_attribution. For AI
7716      Platform provided Tensorflow images (both 1.x and 2.x), the shape of
7717      each baseline must match the shape of the input tensor. If a scalar is
7718      provided, we broadcast to the same shape as the input tensor. For custom
7719      images, the element of the baselines must be in the same format as the
7720      feature's input in the instance[]. The schema of any single instance may
7721      be specified via Endpoint's DeployedModels' Model's PredictSchemata's
7722      instance_schema_uri.
7723  """
7724
7725  inputBaselines = _messages.MessageField('extra_types.JsonValue', 1, repeated=True)
7726
7727
7728class GoogleCloudAiplatformV1alpha1ExplanationMetadataOutputMetadata(_messages.Message):
7729  r"""Metadata of the prediction output to be explained.
7730
7731  Fields:
7732    displayNameMappingKey: Specify a field name in the prediction to look for
7733      the display name. Use this if the prediction contains the display names
7734      for the outputs. The display names in the prediction must have the same
7735      shape of the outputs, so that it can be located by
7736      Attribution.output_index for a specific output.
7737    indexDisplayNameMapping: Static mapping between the index and display
7738      name. Use this if the outputs are a deterministic n-dimensional array,
7739      e.g. a list of scores of all the classes in a pre-defined order for a
7740      multi-classification Model. It's not feasible if the outputs are non-
7741      deterministic, e.g. the Model produces top-k classes or sort the outputs
7742      by their values. The shape of the value must be an n-dimensional array
7743      of strings. The number of dimensions must match that of the outputs to
7744      be explained. The Attribution.output_display_name is populated by
7745      locating in the mapping with Attribution.output_index.
7746  """
7747
7748  displayNameMappingKey = _messages.StringField(1)
7749  indexDisplayNameMapping = _messages.MessageField('extra_types.JsonValue', 2)
7750
7751
7752class GoogleCloudAiplatformV1alpha1ExplanationParameters(_messages.Message):
7753  r"""Parameters to configure explaining for Model's predictions.
7754
7755  Fields:
7756    sampledShapleyAttribution: An attribution method that approximates Shapley
7757      values for features that contribute to the label being predicted. A
7758      sampling strategy is used to approximate the value rather than
7759      considering all subsets of features. Refer to this paper for model
7760      details: https://arxiv.org/abs/1306.4265.
7761  """
7762
7763  sampledShapleyAttribution = _messages.MessageField('GoogleCloudAiplatformV1alpha1SampledShapleyAttribution', 1)
7764
7765
7766class GoogleCloudAiplatformV1alpha1ExplanationSpec(_messages.Message):
7767  r"""Specification of Model explanation.
7768
7769  Fields:
7770    metadata: Required. Metadata describing the Model's input and output for
7771      explanation.
7772    parameters: Required. Parameters that configure explaining of the Model's
7773      predictions.
7774  """
7775
7776  metadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1ExplanationMetadata', 1)
7777  parameters = _messages.MessageField('GoogleCloudAiplatformV1alpha1ExplanationParameters', 2)
7778
7779
7780class GoogleCloudAiplatformV1alpha1ExportDataOperationMetadata(_messages.Message):
7781  r"""Runtime operation information for DatasetService.ExportData.
7782
7783  Fields:
7784    gcsOutputDirectory: A Google Cloud Storage directory which path ends with
7785      '/'. The exported data is stored in the directory.
7786    genericMetadata: The common part of the operation metadata.
7787  """
7788
7789  gcsOutputDirectory = _messages.StringField(1)
7790  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 2)
7791
7792
7793class GoogleCloudAiplatformV1alpha1ExportDataResponse(_messages.Message):
7794  r"""Response message for DatasetService.ExportData.
7795
7796  Fields:
7797    exportedFiles: All of the files that are exported in this export
7798      operation.
7799  """
7800
7801  exportedFiles = _messages.StringField(1, repeated=True)
7802
7803
7804class GoogleCloudAiplatformV1alpha1ExportEvaluatedDataItemsOperationMetadata(_messages.Message):
7805  r"""Details of ModelService.ExportEvaluatedDataItems operation.
7806
7807  Fields:
7808    genericMetadata: The common part of the operation metadata.
7809    outputInfo: Output only. Information further describing the output of this
7810      operation.
7811  """
7812
7813  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7814  outputInfo = _messages.MessageField('GoogleCloudAiplatformV1alpha1ExportEvaluatedDataItemsOperationMetadataOutputInfo', 2)
7815
7816
7817class GoogleCloudAiplatformV1alpha1ExportEvaluatedDataItemsOperationMetadataOutputInfo(_messages.Message):
7818  r"""Further describes this operation's output. Supplements
7819  ExportEvaluatedDataItemsRequest.output_config.
7820
7821  Fields:
7822    bigqueryOutputDataset: Output only. The path of the BigQuery dataset
7823      created, in bq://projectId.bqDatasetId.tableId format, into which the
7824      evaluated DataItems are exported.
7825  """
7826
7827  bigqueryOutputDataset = _messages.StringField(1)
7828
7829
7830class GoogleCloudAiplatformV1alpha1ExportEvaluatedDataItemsOperationResponse(_messages.Message):
7831  r"""Response of ModelService.ExportEvaluatedDataItems operation."""
7832
7833
7834class GoogleCloudAiplatformV1alpha1ExportModelOperationMetadata(_messages.Message):
7835  r"""Details of ModelService.ExportModel operation.
7836
7837  Fields:
7838    genericMetadata: The common part of the operation metadata.
7839    outputInfo: Output only. Information further describing the output of this
7840      Model export.
7841  """
7842
7843  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7844  outputInfo = _messages.MessageField('GoogleCloudAiplatformV1alpha1ExportModelOperationMetadataOutputInfo', 2)
7845
7846
7847class GoogleCloudAiplatformV1alpha1ExportModelOperationMetadataOutputInfo(_messages.Message):
7848  r"""Further describes the output of the ExportModel. Supplements
7849  ExportModelRequest.OutputConfig.
7850
7851  Fields:
7852    gcsOutputDirectory: Output only. If the Model is being exported to Google
7853      Cloud Storage this is the full path of the directory created, into which
7854      the Model files are being written to.
7855  """
7856
7857  gcsOutputDirectory = _messages.StringField(1)
7858
7859
7860class GoogleCloudAiplatformV1alpha1ExportModelResponse(_messages.Message):
7861  r"""Response message of ModelService.ExportModel operation."""
7862
7863
7864class GoogleCloudAiplatformV1alpha1GenericOperationMetadata(_messages.Message):
7865  r"""Generic Metadata shared by all operations.
7866
7867  Fields:
7868    createTime: Output only. Time when the operation was created.
7869    partialFailures: Output only. Partial failures encountered. E.g. single
7870      files that couldn't be read. This field should never exceed 20 entries.
7871      Status details field will contain standard GCP error details.
7872    updateTime: Output only. Time when the operation was updated for the last
7873      time. If the operation has finished (successfully or not), this is the
7874      finish time.
7875  """
7876
7877  createTime = _messages.StringField(1)
7878  partialFailures = _messages.MessageField('GoogleRpcStatus', 2, repeated=True)
7879  updateTime = _messages.StringField(3)
7880
7881
7882class GoogleCloudAiplatformV1alpha1ImportDataOperationMetadata(_messages.Message):
7883  r"""Runtime operation information for DatasetService.ImportData.
7884
7885  Fields:
7886    genericMetadata: The common part of the operation metadata.
7887  """
7888
7889  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
7890
7891
7892class GoogleCloudAiplatformV1alpha1ImportDataResponse(_messages.Message):
7893  r"""Response message for DatasetService.ImportData."""
7894
7895
7896class GoogleCloudAiplatformV1alpha1IndexPrivateEndpoints(_messages.Message):
7897  r"""IndexPrivateEndpoints proto is used to provide paths for users to send
7898  requests via private services access.
7899
7900  Fields:
7901    matchGrpcAddress: Output only. The ip address used to send match gRPC
7902      requests.
7903  """
7904
7905  matchGrpcAddress = _messages.StringField(1)
7906
7907
7908class GoogleCloudAiplatformV1alpha1MachineSpec(_messages.Message):
7909  r"""Specification of a single machine.
7910
7911  Enums:
7912    AcceleratorTypeValueValuesEnum: Immutable. The type of accelerator(s) that
7913      may be attached to the machine as per accelerator_count.
7914
7915  Fields:
7916    acceleratorCount: The number of accelerators to attach to the machine.
7917    acceleratorType: Immutable. The type of accelerator(s) that may be
7918      attached to the machine as per accelerator_count.
7919    machineType: Immutable. The type of the machine. For the machine types
7920      supported for prediction, see https://tinyurl.com/aip-
7921      docs/predictions/machine-types. For machine types supported for creating
7922      a custom training job, see https://tinyurl.com/aip-
7923      docs/training/configure-compute. For DeployedModel this field is
7924      optional, and the default value is `n1-standard-2`. For
7925      BatchPredictionJob or as part of WorkerPoolSpec this field is required.
7926  """
7927
7928  class AcceleratorTypeValueValuesEnum(_messages.Enum):
7929    r"""Immutable. The type of accelerator(s) that may be attached to the
7930    machine as per accelerator_count.
7931
7932    Values:
7933      ACCELERATOR_TYPE_UNSPECIFIED: Unspecified accelerator type, which means
7934        no accelerator.
7935      NVIDIA_TESLA_K80: Nvidia Tesla K80 GPU.
7936      NVIDIA_TESLA_P100: Nvidia Tesla P100 GPU.
7937      NVIDIA_TESLA_V100: Nvidia Tesla V100 GPU.
7938      NVIDIA_TESLA_P4: Nvidia Tesla P4 GPU.
7939      NVIDIA_TESLA_T4: Nvidia Tesla T4 GPU.
7940      TPU_V2: TPU v2.
7941      TPU_V3: TPU v3.
7942    """
7943    ACCELERATOR_TYPE_UNSPECIFIED = 0
7944    NVIDIA_TESLA_K80 = 1
7945    NVIDIA_TESLA_P100 = 2
7946    NVIDIA_TESLA_V100 = 3
7947    NVIDIA_TESLA_P4 = 4
7948    NVIDIA_TESLA_T4 = 5
7949    TPU_V2 = 6
7950    TPU_V3 = 7
7951
7952  acceleratorCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
7953  acceleratorType = _messages.EnumField('AcceleratorTypeValueValuesEnum', 2)
7954  machineType = _messages.StringField(3)
7955
7956
7957class GoogleCloudAiplatformV1alpha1MigratableResource(_messages.Message):
7958  r"""Represents one resource that exists in automl.googleapis.com,
7959  datalabeling.googleapis.com or ml.googleapis.com.
7960
7961  Fields:
7962    automlDataset: Output only. Represents one Dataset in
7963      automl.googleapis.com.
7964    automlModel: Output only. Represents one Model in automl.googleapis.com.
7965    dataLabelingDataset: Output only. Represents one Dataset in
7966      datalabeling.googleapis.com.
7967    lastMigrateTime: Output only. Timestamp when the last migration attempt on
7968      this MigratableResource started. Will not be set if there's no migration
7969      attempt on this MigratableResource.
7970    lastUpdateTime: Output only. Timestamp when this MigratableResource was
7971      last updated.
7972    mlEngineModelVersion: Output only. Represents one Version in
7973      ml.googleapis.com.
7974  """
7975
7976  automlDataset = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigratableResourceAutomlDataset', 1)
7977  automlModel = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigratableResourceAutomlModel', 2)
7978  dataLabelingDataset = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigratableResourceDataLabelingDataset', 3)
7979  lastMigrateTime = _messages.StringField(4)
7980  lastUpdateTime = _messages.StringField(5)
7981  mlEngineModelVersion = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigratableResourceMlEngineModelVersion', 6)
7982
7983
7984class GoogleCloudAiplatformV1alpha1MigratableResourceAutomlDataset(_messages.Message):
7985  r"""Represents one Dataset in automl.googleapis.com.
7986
7987  Fields:
7988    dataset: Full resource name of automl Dataset. Format:
7989      `projects/{project}/locations/{location}/datasets/{dataset}`.
7990    datasetDisplayName: The Dataset's display name in automl.googleapis.com.
7991  """
7992
7993  dataset = _messages.StringField(1)
7994  datasetDisplayName = _messages.StringField(2)
7995
7996
7997class GoogleCloudAiplatformV1alpha1MigratableResourceAutomlModel(_messages.Message):
7998  r"""Represents one Model in automl.googleapis.com.
7999
8000  Fields:
8001    model: Full resource name of automl Model. Format:
8002      `projects/{project}/locations/{location}/models/{model}`.
8003    modelDisplayName: The Model's display name in automl.googleapis.com.
8004  """
8005
8006  model = _messages.StringField(1)
8007  modelDisplayName = _messages.StringField(2)
8008
8009
8010class GoogleCloudAiplatformV1alpha1MigratableResourceDataLabelingDataset(_messages.Message):
8011  r"""Represents one Dataset in datalabeling.googleapis.com.
8012
8013  Fields:
8014    dataLabelingAnnotatedDatasets: The migratable AnnotatedDataset in
8015      datalabeling.googleapis.com belongs to the data labeling Dataset.
8016    dataset: Full resource name of data labeling Dataset. Format:
8017      `projects/{project}/datasets/{dataset}`.
8018    datasetDisplayName: The Dataset's display name in
8019      datalabeling.googleapis.com.
8020  """
8021
8022  dataLabelingAnnotatedDatasets = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset', 1, repeated=True)
8023  dataset = _messages.StringField(2)
8024  datasetDisplayName = _messages.StringField(3)
8025
8026
8027class GoogleCloudAiplatformV1alpha1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset(_messages.Message):
8028  r"""Represents one AnnotatedDataset in datalabeling.googleapis.com.
8029
8030  Fields:
8031    annotatedDataset: Full resource name of data labeling AnnotatedDataset.
8032      Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annota
8033      ted_dataset}`.
8034    annotatedDatasetDisplayName: The AnnotatedDataset's display name in
8035      datalabeling.googleapis.com.
8036  """
8037
8038  annotatedDataset = _messages.StringField(1)
8039  annotatedDatasetDisplayName = _messages.StringField(2)
8040
8041
8042class GoogleCloudAiplatformV1alpha1MigratableResourceMlEngineModelVersion(_messages.Message):
8043  r"""Represents one model Version in ml.googleapis.com.
8044
8045  Fields:
8046    endpoint: The ml.googleapis.com endpoint that this model Version currently
8047      lives in. Example values: * ml.googleapis.com * us-centrall-
8048      ml.googleapis.com * europe-west4-ml.googleapis.com * asia-
8049      east1-ml.googleapis.com
8050    version: Full resource name of ml engine model Version. Format:
8051      `projects/{project}/models/{model}/versions/{version}`.
8052  """
8053
8054  endpoint = _messages.StringField(1)
8055  version = _messages.StringField(2)
8056
8057
8058class GoogleCloudAiplatformV1alpha1MigrateResourceRequest(_messages.Message):
8059  r"""Config of migrating one resource from automl.googleapis.com,
8060  datalabeling.googleapis.com and ml.googleapis.com to AI Platform.
8061
8062  Fields:
8063    migrateAutomlDatasetConfig: Config for migrating Dataset in
8064      automl.googleapis.com to AI Platform's Dataset.
8065    migrateAutomlModelConfig: Config for migrating Model in
8066      automl.googleapis.com to AI Platform's Model.
8067    migrateDataLabelingDatasetConfig: Config for migrating Dataset in
8068      datalabeling.googleapis.com to AI Platform's Dataset.
8069    migrateMlEngineModelVersionConfig: Config for migrating Version in
8070      ml.googleapis.com to AI Platform's Model.
8071  """
8072
8073  migrateAutomlDatasetConfig = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateAutomlDatasetConfig', 1)
8074  migrateAutomlModelConfig = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateAutomlModelConfig', 2)
8075  migrateDataLabelingDatasetConfig = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateDataLabelingDatasetConfig', 3)
8076  migrateMlEngineModelVersionConfig = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateMlEngineModelVersionConfig', 4)
8077
8078
8079class GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateAutomlDatasetConfig(_messages.Message):
8080  r"""Config for migrating Dataset in automl.googleapis.com to AI Platform's
8081  Dataset.
8082
8083  Fields:
8084    dataset: Required. Full resource name of automl Dataset. Format:
8085      `projects/{project}/locations/{location}/datasets/{dataset}`.
8086    datasetDisplayName: Required. Display name of the Dataset in AI Platform.
8087      System will pick a display name if unspecified.
8088  """
8089
8090  dataset = _messages.StringField(1)
8091  datasetDisplayName = _messages.StringField(2)
8092
8093
8094class GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateAutomlModelConfig(_messages.Message):
8095  r"""Config for migrating Model in automl.googleapis.com to AI Platform's
8096  Model.
8097
8098  Fields:
8099    model: Required. Full resource name of automl Model. Format:
8100      `projects/{project}/locations/{location}/models/{model}`.
8101    modelDisplayName: Optional. Display name of the model in AI Platform.
8102      System will pick a display name if unspecified.
8103  """
8104
8105  model = _messages.StringField(1)
8106  modelDisplayName = _messages.StringField(2)
8107
8108
8109class GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateDataLabelingDatasetConfig(_messages.Message):
8110  r"""Config for migrating Dataset in datalabeling.googleapis.com to AI
8111  Platform's Dataset.
8112
8113  Fields:
8114    dataset: Required. Full resource name of data labeling Dataset. Format:
8115      `projects/{project}/datasets/{dataset}`.
8116    datasetDisplayName: Optional. Display name of the Dataset in AI Platform.
8117      System will pick a display name if unspecified.
8118    migrateDataLabelingAnnotatedDatasetConfigs: Optional. Configs for
8119      migrating AnnotatedDataset in datalabeling.googleapis.com to AI
8120      Platform's SavedQuery. The specified AnnotatedDatasets have to belong to
8121      the datalabeling Dataset.
8122  """
8123
8124  dataset = _messages.StringField(1)
8125  datasetDisplayName = _messages.StringField(2)
8126  migrateDataLabelingAnnotatedDatasetConfigs = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig', 3, repeated=True)
8127
8128
8129class GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig(_messages.Message):
8130  r"""Config for migrating AnnotatedDataset in datalabeling.googleapis.com to
8131  AI Platform's SavedQuery.
8132
8133  Fields:
8134    annotatedDataset: Required. Full resource name of data labeling
8135      AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotat
8136      edDatasets/{annotated_dataset}`.
8137  """
8138
8139  annotatedDataset = _messages.StringField(1)
8140
8141
8142class GoogleCloudAiplatformV1alpha1MigrateResourceRequestMigrateMlEngineModelVersionConfig(_messages.Message):
8143  r"""Config for migrating version in ml.googleapis.com to AI Platform's
8144  Model.
8145
8146  Fields:
8147    endpoint: Required. The ml.googleapis.com endpoint that this model version
8148      should be migrated from. Example values: * ml.googleapis.com * us-
8149      centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * asia-
8150      east1-ml.googleapis.com
8151    modelDisplayName: Required. Display name of the model in AI Platform.
8152      System will pick a display name if unspecified.
8153    modelVersion: Required. Full resource name of ml engine model version.
8154      Format: `projects/{project}/models/{model}/versions/{version}`.
8155  """
8156
8157  endpoint = _messages.StringField(1)
8158  modelDisplayName = _messages.StringField(2)
8159  modelVersion = _messages.StringField(3)
8160
8161
8162class GoogleCloudAiplatformV1alpha1MigrateResourceResponse(_messages.Message):
8163  r"""Describes a successfully migrated resource.
8164
8165  Fields:
8166    dataset: Migrated Dataset's resource name.
8167    migratableResource: Before migration, the identifier in ml.googleapis.com,
8168      automl.googleapis.com or datalabeling.googleapis.com.
8169    model: Migrated Model's resource name.
8170  """
8171
8172  dataset = _messages.StringField(1)
8173  migratableResource = _messages.MessageField('GoogleCloudAiplatformV1alpha1MigratableResource', 2)
8174  model = _messages.StringField(3)
8175
8176
8177class GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadata(_messages.Message):
8178  r"""Runtime operation metadata with regard to ScaNN Index.
8179
8180  Fields:
8181    contentValidationStats: The validation stats of the content (per file) to
8182      be inserted or updated on the ScaNN Index resource. Populated if
8183      contentsDeltaUri is provided as part of Index.metadata. Please note
8184      that, currently for those files that are broken or has unsupported file
8185      format, we will not have the stats for those files.
8186  """
8187
8188  contentValidationStats = _messages.MessageField('GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadataContentValidationStats', 1, repeated=True)
8189
8190
8191class GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadataContentValidationStats(_messages.Message):
8192  r"""A GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadataCon
8193  tentValidationStats object.
8194
8195  Fields:
8196    invalidRecordCount: Number of records in this file we skipped due to
8197      validate errors.
8198    partialErrors: The detail information of the partial failures encountered
8199      for those invalid records that couldn't be parsed. Up to 50 partial
8200      errors will be reported.
8201    sourceGcsUri: GCS uri pointing to the original file in user's bucket.
8202    validRecordCount: Number of records in this file that were successfully
8203      processed.
8204  """
8205
8206  invalidRecordCount = _messages.IntegerField(1)
8207  partialErrors = _messages.MessageField('GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadataRecordError', 2, repeated=True)
8208  sourceGcsUri = _messages.StringField(3)
8209  validRecordCount = _messages.IntegerField(4)
8210
8211
8212class GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadataRecordError(_messages.Message):
8213  r"""A GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadataRec
8214  ordError object.
8215
8216  Enums:
8217    ErrorTypeValueValuesEnum: The error type of this record.
8218
8219  Fields:
8220    embeddingId: Empty if the embedding id is failed to parse.
8221    errorMessage: A human-readable message that is shown to the user to help
8222      them fix the error. Note that this message may change from time to time,
8223      your code should check against error_type as the source of truth.
8224    errorType: The error type of this record.
8225    rawRecord: The original content of this record.
8226    sourceGcsUri: GCS uri pointing to the original file in user's bucket.
8227  """
8228
8229  class ErrorTypeValueValuesEnum(_messages.Enum):
8230    r"""The error type of this record.
8231
8232    Values:
8233      ERROR_TYPE_UNSPECIFIED: Default, shall not be used.
8234      EMPTY_LINE: The record is empty.
8235      INVALID_JSON_SYNTAX: Invalid json format.
8236      INVALID_CSV_SYNTAX: Invalid csv format.
8237      INVALID_AVRO_SYNTAX: Invalid avro format.
8238      INVALID_EMBEDDING_ID: The embedding id is not valid.
8239      EMBEDDING_SIZE_MISMATCH: The size of the embedding vectors does not
8240        match with the specified dimension.
8241      NAMESPACE_MISSING: The `namespace` field is missing.
8242    """
8243    ERROR_TYPE_UNSPECIFIED = 0
8244    EMPTY_LINE = 1
8245    INVALID_JSON_SYNTAX = 2
8246    INVALID_CSV_SYNTAX = 3
8247    INVALID_AVRO_SYNTAX = 4
8248    INVALID_EMBEDDING_ID = 5
8249    EMBEDDING_SIZE_MISMATCH = 6
8250    NAMESPACE_MISSING = 7
8251
8252  embeddingId = _messages.StringField(1)
8253  errorMessage = _messages.StringField(2)
8254  errorType = _messages.EnumField('ErrorTypeValueValuesEnum', 3)
8255  rawRecord = _messages.StringField(4)
8256  sourceGcsUri = _messages.StringField(5)
8257
8258
8259class GoogleCloudAiplatformV1alpha1SampledShapleyAttribution(_messages.Message):
8260  r"""An attribution method that approximates Shapley values for features that
8261  contribute to the label being predicted. A sampling strategy is used to
8262  approximate the value rather than considering all subsets of features.
8263
8264  Fields:
8265    pathCount: Required. The number of feature permutations to consider when
8266      approximating the Shapley values. Valid range of its value is [1, 50],
8267      inclusively.
8268  """
8269
8270  pathCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
8271
8272
8273class GoogleCloudAiplatformV1alpha1SchemaAnnotationSpecColor(_messages.Message):
8274  r"""An entry of mapping between color and AnnotationSpec. The mapping is
8275  used in segmentation mask.
8276
8277  Fields:
8278    color: The color of the AnnotationSpec in a segmentation mask.
8279    displayName: The display name of the AnnotationSpec represented by the
8280      color in the segmentation mask.
8281    id: The ID of the AnnotationSpec represented by the color in the
8282      segmentation mask.
8283  """
8284
8285  color = _messages.MessageField('GoogleTypeColor', 1)
8286  displayName = _messages.StringField(2)
8287  id = _messages.StringField(3)
8288
8289
8290class GoogleCloudAiplatformV1alpha1SchemaImageBoundingBoxAnnotation(_messages.Message):
8291  r"""Annotation details specific to image object detection.
8292
8293  Fields:
8294    annotationSpecId: The resource Id of the AnnotationSpec that this
8295      Annotation pertains to.
8296    displayName: The display name of the AnnotationSpec that this Annotation
8297      pertains to.
8298    xMax: The rightmost coordinate of the bounding box.
8299    xMin: The leftmost coordinate of the bounding box.
8300    yMax: The bottommost coordinate of the bounding box.
8301    yMin: The topmost coordinate of the bounding box.
8302  """
8303
8304  annotationSpecId = _messages.StringField(1)
8305  displayName = _messages.StringField(2)
8306  xMax = _messages.FloatField(3)
8307  xMin = _messages.FloatField(4)
8308  yMax = _messages.FloatField(5)
8309  yMin = _messages.FloatField(6)
8310
8311
8312class GoogleCloudAiplatformV1alpha1SchemaImageClassificationAnnotation(_messages.Message):
8313  r"""Annotation details specific to image classification.
8314
8315  Fields:
8316    annotationSpecId: The resource Id of the AnnotationSpec that this
8317      Annotation pertains to.
8318    displayName: The display name of the AnnotationSpec that this Annotation
8319      pertains to.
8320  """
8321
8322  annotationSpecId = _messages.StringField(1)
8323  displayName = _messages.StringField(2)
8324
8325
8326class GoogleCloudAiplatformV1alpha1SchemaImageDataItem(_messages.Message):
8327  r"""Payload of Image DataItem.
8328
8329  Fields:
8330    gcsUri: Required. Google Cloud Storage URI points to the original image in
8331      user's bucket. The image is up to 30MB in size.
8332    mimeType: Output only. The mime type of the content of the image. Only the
8333      images in below listed mime types are supported. - image/jpeg -
8334      image/gif - image/png - image/webp - image/bmp - image/tiff -
8335      image/vnd.microsoft.icon
8336  """
8337
8338  gcsUri = _messages.StringField(1)
8339  mimeType = _messages.StringField(2)
8340
8341
8342class GoogleCloudAiplatformV1alpha1SchemaImageDatasetMetadata(_messages.Message):
8343  r"""The metadata of Datasets that contain Image DataItems.
8344
8345  Fields:
8346    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
8347      describing payload of the Image DataItems that belong to this Dataset.
8348    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
8349      this Dataset.
8350  """
8351
8352  dataItemSchemaUri = _messages.StringField(1)
8353  gcsBucket = _messages.StringField(2)
8354
8355
8356class GoogleCloudAiplatformV1alpha1SchemaImageSegmentationAnnotation(_messages.Message):
8357  r"""Annotation details specific to image segmentation.
8358
8359  Fields:
8360    maskAnnotation: Mask based segmentation annotation. Only one mask
8361      annotation can exist for one image.
8362    polygonAnnotation: Polygon annotation.
8363    polylineAnnotation: Polyline annotation.
8364  """
8365
8366  maskAnnotation = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaImageSegmentationAnnotationMaskAnnotation', 1)
8367  polygonAnnotation = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaImageSegmentationAnnotationPolygonAnnotation', 2)
8368  polylineAnnotation = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaImageSegmentationAnnotationPolylineAnnotation', 3)
8369
8370
8371class GoogleCloudAiplatformV1alpha1SchemaImageSegmentationAnnotationMaskAnnotation(_messages.Message):
8372  r"""The mask based segmentation annotation.
8373
8374  Fields:
8375    annotationSpecColors: The mapping between color and AnnotationSpec for
8376      this Annotation.
8377    maskGcsUri: Google Cloud Storage URI that points to the mask image. The
8378      image must be in PNG format. It must have the same size as the
8379      DataItem's image. Each pixel in the image mask represents the
8380      AnnotationSpec which the pixel in the image DataItem belong to. Each
8381      color is mapped to one AnnotationSpec based on annotation_spec_colors.
8382  """
8383
8384  annotationSpecColors = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaAnnotationSpecColor', 1, repeated=True)
8385  maskGcsUri = _messages.StringField(2)
8386
8387
8388class GoogleCloudAiplatformV1alpha1SchemaImageSegmentationAnnotationPolygonAnnotation(_messages.Message):
8389  r"""Represents a polygon in image.
8390
8391  Fields:
8392    annotationSpecId: The resource Id of the AnnotationSpec that this
8393      Annotation pertains to.
8394    displayName: The display name of the AnnotationSpec that this Annotation
8395      pertains to.
8396    vertexes: The vertexes are connected one by one and the last vertex is
8397      connected to the first one to represent a polygon.
8398  """
8399
8400  annotationSpecId = _messages.StringField(1)
8401  displayName = _messages.StringField(2)
8402  vertexes = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaVertex', 3, repeated=True)
8403
8404
8405class GoogleCloudAiplatformV1alpha1SchemaImageSegmentationAnnotationPolylineAnnotation(_messages.Message):
8406  r"""Represents a polyline in image.
8407
8408  Fields:
8409    annotationSpecId: The resource Id of the AnnotationSpec that this
8410      Annotation pertains to.
8411    displayName: The display name of the AnnotationSpec that this Annotation
8412      pertains to.
8413    vertexes: The vertexes are connected one by one and the last vertex in not
8414      connected to the first one.
8415  """
8416
8417  annotationSpecId = _messages.StringField(1)
8418  displayName = _messages.StringField(2)
8419  vertexes = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaVertex', 3, repeated=True)
8420
8421
8422class GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadata(_messages.Message):
8423  r"""The metadata of Datasets that contain tables data.
8424
8425  Fields:
8426    inputConfig: A
8427      GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataInputConfig
8428      attribute.
8429  """
8430
8431  inputConfig = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataInputConfig', 1)
8432
8433
8434class GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataBigQuerySource(_messages.Message):
8435  r"""A GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataBigQuerySource
8436  object.
8437
8438  Fields:
8439    uri: The URI of a BigQuery table. e.g.
8440      bq://projectId.bqDatasetId.bqTableId
8441  """
8442
8443  uri = _messages.StringField(1)
8444
8445
8446class GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataGcsSource(_messages.Message):
8447  r"""A GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataGcsSource
8448  object.
8449
8450  Fields:
8451    uri: Cloud Storage URI of one or more files. Only CSV files are supported.
8452      The first line of the CSV file is used as the header. If there are
8453      multiple files, the header is the first line of the lexicographically
8454      first file, the other files must either contain the exact same header or
8455      omit the header.
8456  """
8457
8458  uri = _messages.StringField(1, repeated=True)
8459
8460
8461class GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataInputConfig(_messages.Message):
8462  r"""The tables Dataset's data source. The Dataset doesn't store the data
8463  directly, but only pointer(s) to its data.
8464
8465  Fields:
8466    bigquerySource: A
8467      GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataBigQuerySource
8468      attribute.
8469    gcsSource: A
8470      GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataGcsSource
8471      attribute.
8472  """
8473
8474  bigquerySource = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataBigQuerySource', 1)
8475  gcsSource = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTablesDatasetMetadataGcsSource', 2)
8476
8477
8478class GoogleCloudAiplatformV1alpha1SchemaTextClassificationAnnotation(_messages.Message):
8479  r"""Annotation details specific to text classification.
8480
8481  Fields:
8482    annotationSpecId: The resource Id of the AnnotationSpec that this
8483      Annotation pertains to.
8484    displayName: The display name of the AnnotationSpec that this Annotation
8485      pertains to.
8486  """
8487
8488  annotationSpecId = _messages.StringField(1)
8489  displayName = _messages.StringField(2)
8490
8491
8492class GoogleCloudAiplatformV1alpha1SchemaTextDataItem(_messages.Message):
8493  r"""Payload of Text DataItem.
8494
8495  Fields:
8496    gcsUri: Output only. Google Cloud Storage URI points to the original text
8497      in user's bucket. The text file is up to 10MB in size.
8498  """
8499
8500  gcsUri = _messages.StringField(1)
8501
8502
8503class GoogleCloudAiplatformV1alpha1SchemaTextDatasetMetadata(_messages.Message):
8504  r"""The metadata of Datasets that contain Text DataItems.
8505
8506  Fields:
8507    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
8508      describing payload of the Text DataItems that belong to this Dataset.
8509    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
8510      this Dataset.
8511  """
8512
8513  dataItemSchemaUri = _messages.StringField(1)
8514  gcsBucket = _messages.StringField(2)
8515
8516
8517class GoogleCloudAiplatformV1alpha1SchemaTextExtractionAnnotation(_messages.Message):
8518  r"""Annotation details specific to text extraction.
8519
8520  Fields:
8521    annotationSpecId: The resource Id of the AnnotationSpec that this
8522      Annotation pertains to.
8523    displayName: The display name of the AnnotationSpec that this Annotation
8524      pertains to.
8525    textSegment: The segment of the text content.
8526  """
8527
8528  annotationSpecId = _messages.StringField(1)
8529  displayName = _messages.StringField(2)
8530  textSegment = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTextSegment', 3)
8531
8532
8533class GoogleCloudAiplatformV1alpha1SchemaTextSegment(_messages.Message):
8534  r"""The text segment inside of DataItem.
8535
8536  Fields:
8537    content: The text content in the segment for output only.
8538    endOffset: Zero-based character index of the first character past the end
8539      of the text segment (counting character from the beginning of the text).
8540      The character at the end_offset is NOT included in the text segment.
8541    startOffset: Zero-based character index of the first character of the text
8542      segment (counting characters from the beginning of the text).
8543  """
8544
8545  content = _messages.StringField(1)
8546  endOffset = _messages.IntegerField(2, variant=_messages.Variant.UINT64)
8547  startOffset = _messages.IntegerField(3, variant=_messages.Variant.UINT64)
8548
8549
8550class GoogleCloudAiplatformV1alpha1SchemaTextSentimentAnnotation(_messages.Message):
8551  r"""Annotation details specific to text sentiment.
8552
8553  Fields:
8554    annotationSpecId: The resource Id of the AnnotationSpec that this
8555      Annotation pertains to.
8556    displayName: The display name of the AnnotationSpec that this Annotation
8557      pertains to.
8558    sentiment: The sentiment score for text.
8559    sentimentMax: The sentiment max score for text.
8560  """
8561
8562  annotationSpecId = _messages.StringField(1)
8563  displayName = _messages.StringField(2)
8564  sentiment = _messages.IntegerField(3, variant=_messages.Variant.INT32)
8565  sentimentMax = _messages.IntegerField(4, variant=_messages.Variant.INT32)
8566
8567
8568class GoogleCloudAiplatformV1alpha1SchemaTextSentimentSavedQueryMetadata(_messages.Message):
8569  r"""The metadata of SavedQuery contains TextSentiment Annotations.
8570
8571  Fields:
8572    sentimentMax: The maximum sentiment of sentiment Anntoation in this
8573      SavedQuery.
8574  """
8575
8576  sentimentMax = _messages.IntegerField(1, variant=_messages.Variant.INT32)
8577
8578
8579class GoogleCloudAiplatformV1alpha1SchemaTimeSegment(_messages.Message):
8580  r"""A time period inside of a DataItem that has a time dimension (e.g.
8581  video).
8582
8583  Fields:
8584    endTimeOffset: End of the time segment (exclusive), represented as the
8585      duration since the start of the DataItem.
8586    startTimeOffset: Start of the time segment (inclusive), represented as the
8587      duration since the start of the DataItem.
8588  """
8589
8590  endTimeOffset = _messages.StringField(1)
8591  startTimeOffset = _messages.StringField(2)
8592
8593
8594class GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadata(_messages.Message):
8595  r"""The metadata of Datasets that contain time series data.
8596
8597  Fields:
8598    inputConfig: A
8599      GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataInputConfig
8600      attribute.
8601    timeColumn: The column name of the time column that identifies time order
8602      in the time series.
8603    timeSeriesIdentifierColumn: The column name of the time series identifier
8604      column that identifies the time series.
8605  """
8606
8607  inputConfig = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataInputConfig', 1)
8608  timeColumn = _messages.StringField(2)
8609  timeSeriesIdentifierColumn = _messages.StringField(3)
8610
8611
8612class GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataBigQuerySource(_messages.Message):
8613  r"""A
8614  GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataBigQuerySource
8615  object.
8616
8617  Fields:
8618    uri: The URI of a BigQuery table.
8619  """
8620
8621  uri = _messages.StringField(1)
8622
8623
8624class GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataGcsSource(_messages.Message):
8625  r"""A GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataGcsSource
8626  object.
8627
8628  Fields:
8629    uri: Cloud Storage URI of one or more files. Only CSV files are supported.
8630      The first line of the CSV file is used as the header. If there are
8631      multiple files, the header is the first line of the lexicographically
8632      first file, the other files must either contain the exact same header or
8633      omit the header.
8634  """
8635
8636  uri = _messages.StringField(1, repeated=True)
8637
8638
8639class GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataInputConfig(_messages.Message):
8640  r"""The time series Dataset's data source. The Dataset doesn't store the
8641  data directly, but only pointer(s) to its data.
8642
8643  Fields:
8644    bigquerySource: A
8645      GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataBigQuerySour
8646      ce attribute.
8647    gcsSource: A
8648      GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataGcsSource
8649      attribute.
8650  """
8651
8652  bigquerySource = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataBigQuerySource', 1)
8653  gcsSource = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTimeSeriesDatasetMetadataGcsSource', 2)
8654
8655
8656class GoogleCloudAiplatformV1alpha1SchemaVertex(_messages.Message):
8657  r"""A vertex represents a 2D point in the image. NOTE: the normalized vertex
8658  coordinates are relative to the original image and range from 0 to 1.
8659
8660  Fields:
8661    x: X coordinate.
8662    y: Y coordinate.
8663  """
8664
8665  x = _messages.FloatField(1)
8666  y = _messages.FloatField(2)
8667
8668
8669class GoogleCloudAiplatformV1alpha1SchemaVideoActionRecognitionAnnotation(_messages.Message):
8670  r"""Annotation details specific to video action recognition.
8671
8672  Fields:
8673    annotationSpecId: The resource Id of the AnnotationSpec that this
8674      Annotation pertains to.
8675    displayName: The display name of the AnnotationSpec that this Annotation
8676      pertains to.
8677    timeSegment: This Annotation applies to the time period represented by the
8678      TimeSegment. If it's not set, the Annotation applies to the whole video.
8679  """
8680
8681  annotationSpecId = _messages.StringField(1)
8682  displayName = _messages.StringField(2)
8683  timeSegment = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTimeSegment', 3)
8684
8685
8686class GoogleCloudAiplatformV1alpha1SchemaVideoClassificationAnnotation(_messages.Message):
8687  r"""Annotation details specific to video classification.
8688
8689  Fields:
8690    annotationSpecId: The resource Id of the AnnotationSpec that this
8691      Annotation pertains to.
8692    displayName: The display name of the AnnotationSpec that this Annotation
8693      pertains to.
8694    timeSegment: This Annotation applies to the time period represented by the
8695      TimeSegment. If it's not set, the Annotation applies to the whole video.
8696  """
8697
8698  annotationSpecId = _messages.StringField(1)
8699  displayName = _messages.StringField(2)
8700  timeSegment = _messages.MessageField('GoogleCloudAiplatformV1alpha1SchemaTimeSegment', 3)
8701
8702
8703class GoogleCloudAiplatformV1alpha1SchemaVideoDataItem(_messages.Message):
8704  r"""Payload of Video DataItem.
8705
8706  Fields:
8707    gcsUri: Required. Google Cloud Storage URI points to the original video in
8708      user's bucket. The video is up to 50 GB in size and up to 3 hour in
8709      duration.
8710    mimeType: Output only. The mime type of the content of the video. Only the
8711      videos in below listed mime types are supported. Supported mime_type: -
8712      video/mp4 - video/avi - video/quicktime
8713  """
8714
8715  gcsUri = _messages.StringField(1)
8716  mimeType = _messages.StringField(2)
8717
8718
8719class GoogleCloudAiplatformV1alpha1SchemaVideoDatasetMetadata(_messages.Message):
8720  r"""The metadata of Datasets that contain Video DataItems.
8721
8722  Fields:
8723    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
8724      describing payload of the Video DataItems that belong to this Dataset.
8725    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
8726      this Dataset.
8727  """
8728
8729  dataItemSchemaUri = _messages.StringField(1)
8730  gcsBucket = _messages.StringField(2)
8731
8732
8733class GoogleCloudAiplatformV1alpha1SchemaVideoObjectTrackingAnnotation(_messages.Message):
8734  r"""Annotation details specific to video object tracking.
8735
8736  Fields:
8737    annotationSpecId: The resource Id of the AnnotationSpec that this
8738      Annotation pertains to.
8739    displayName: The display name of the AnnotationSpec that this Annotation
8740      pertains to.
8741    instanceId: The instance of the object, expressed as a positive integer.
8742      Used to track the same object across different frames.
8743    timeOffset: A time (frame) of a video to which this annotation pertains.
8744      Represented as the duration since the video's start.
8745    xMax: The rightmost coordinate of the bounding box.
8746    xMin: The leftmost coordinate of the bounding box.
8747    yMax: The bottommost coordinate of the bounding box.
8748    yMin: The topmost coordinate of the bounding box.
8749  """
8750
8751  annotationSpecId = _messages.StringField(1)
8752  displayName = _messages.StringField(2)
8753  instanceId = _messages.IntegerField(3)
8754  timeOffset = _messages.StringField(4)
8755  xMax = _messages.FloatField(5)
8756  xMin = _messages.FloatField(6)
8757  yMax = _messages.FloatField(7)
8758  yMin = _messages.FloatField(8)
8759
8760
8761class GoogleCloudAiplatformV1alpha1SchemaVisualInspectionClassificationLabelSavedQueryMetadata(_messages.Message):
8762  r"""A GoogleCloudAiplatformV1alpha1SchemaVisualInspectionClassificationLabel
8763  SavedQueryMetadata object.
8764
8765  Fields:
8766    multiLabel: Whether or not the classification label is multi_label.
8767  """
8768
8769  multiLabel = _messages.BooleanField(1)
8770
8771
8772class GoogleCloudAiplatformV1alpha1SchemaVisualInspectionMaskSavedQueryMetadata(_messages.Message):
8773  r"""A
8774  GoogleCloudAiplatformV1alpha1SchemaVisualInspectionMaskSavedQueryMetadata
8775  object.
8776  """
8777
8778
8779
8780class GoogleCloudAiplatformV1alpha1SpecialistPool(_messages.Message):
8781  r"""SpecialistPool represents customers' own workforce to work on their data
8782  labeling jobs. It includes a group of specialist managers who are
8783  responsible for managing the labelers in this pool as well as customers'
8784  data labeling jobs associated with this pool. Customers create specialist
8785  pool as well as start data labeling jobs on Cloud, managers and labelers
8786  work with the jobs using CrowdCompute console.
8787
8788  Fields:
8789    displayName: Required. The user-defined name of the SpecialistPool. The
8790      name can be up to 128 characters long and can be consist of any UTF-8
8791      characters. This field should be unique on project-level.
8792    name: Required. The resource name of the SpecialistPool.
8793    pendingDataLabelingJobs: Output only. The resource name of the pending
8794      data labeling jobs.
8795    specialistManagerEmails: The email addresses of the specialists in the
8796      SpecialistPool.
8797    specialistManagersCount: Output only. The number of Specialists in this
8798      SpecialistPool.
8799  """
8800
8801  displayName = _messages.StringField(1)
8802  name = _messages.StringField(2)
8803  pendingDataLabelingJobs = _messages.StringField(3, repeated=True)
8804  specialistManagerEmails = _messages.StringField(4, repeated=True)
8805  specialistManagersCount = _messages.IntegerField(5, variant=_messages.Variant.INT32)
8806
8807
8808class GoogleCloudAiplatformV1alpha1UndeployIndexOperationMetadata(_messages.Message):
8809  r"""Runtime operation information for IndexEndpointService.UndeployIndex.
8810
8811  Fields:
8812    genericMetadata: The operation generic information.
8813  """
8814
8815  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
8816
8817
8818class GoogleCloudAiplatformV1alpha1UndeployIndexResponse(_messages.Message):
8819  r"""Response message for IndexEndpointService.UndeployIndex."""
8820
8821
8822class GoogleCloudAiplatformV1alpha1UndeployModelOperationMetadata(_messages.Message):
8823  r"""Runtime operation information for EndpointService.UndeployModel.
8824
8825  Fields:
8826    genericMetadata: The operation generic information.
8827  """
8828
8829  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
8830
8831
8832class GoogleCloudAiplatformV1alpha1UndeployModelResponse(_messages.Message):
8833  r"""Response message for EndpointService.UndeployModel."""
8834
8835
8836class GoogleCloudAiplatformV1alpha1UpdateIndexOperationMetadata(_messages.Message):
8837  r"""Runtime operation information for IndexService.UpdateIndex.
8838
8839  Fields:
8840    genericMetadata: The operation generic information.
8841    nearestNeighborSearchOperationMetadata: The operation metadata with regard
8842      to ScaNN Index operation.
8843  """
8844
8845  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
8846  nearestNeighborSearchOperationMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1NearestNeighborSearchOperationMetadata', 2)
8847
8848
8849class GoogleCloudAiplatformV1alpha1UpdateSpecialistPoolOperationMetadata(_messages.Message):
8850  r"""Runtime operation metadata for
8851  SpecialistPoolService.UpdateSpecialistPool.
8852
8853  Fields:
8854    genericMetadata: The operation generic information.
8855    specialistPool: Output only. The name of the SpecialistPool to which the
8856      specialists are being added. Format: `projects/{project_id}/locations/{l
8857      ocation_id}/specialistPools/{specialist_pool}`
8858  """
8859
8860  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
8861  specialistPool = _messages.StringField(2)
8862
8863
8864class GoogleCloudAiplatformV1alpha1UploadModelOperationMetadata(_messages.Message):
8865  r"""Details of ModelService.UploadModel operation.
8866
8867  Fields:
8868    genericMetadata: The common part of the operation metadata.
8869  """
8870
8871  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1alpha1GenericOperationMetadata', 1)
8872
8873
8874class GoogleCloudAiplatformV1alpha1UploadModelResponse(_messages.Message):
8875  r"""Response message of ModelService.UploadModel operation.
8876
8877  Fields:
8878    model: The name of the uploaded Model resource. Format:
8879      `projects/{project}/locations/{location}/models/{model}`
8880  """
8881
8882  model = _messages.StringField(1)
8883
8884
8885class GoogleCloudAiplatformV1beta1AutomaticResources(_messages.Message):
8886  r"""A description of resources that to large degree are decided by AI
8887  Platform, and require only a modest additional configuration. Each Model
8888  supporting these resources documents its specific guidelines.
8889
8890  Fields:
8891    maxReplicaCount: Immutable. The maximum number of replicas this
8892      DeployedModel may be deployed on when the traffic against it increases.
8893      If the requested value is too large, the deployment will error, but if
8894      deployment succeeds then the ability to scale the model to that many
8895      replicas is guaranteed (barring service outages). If traffic against the
8896      DeployedModel increases beyond what its replicas at maximum may handle,
8897      a portion of the traffic will be dropped. If this value is not provided,
8898      a no upper bound for scaling under heavy traffic will be assume, though
8899      AI Platform may be unable to scale beyond certain replica number.
8900    minReplicaCount: Immutable. The minimum number of replicas this
8901      DeployedModel will be always deployed on. If traffic against it
8902      increases, it may dynamically be deployed onto more replicas up to
8903      max_replica_count, and as traffic decreases, some of these extra
8904      replicas may be freed. If the requested value is too large, the
8905      deployment will error.
8906  """
8907
8908  maxReplicaCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
8909  minReplicaCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
8910
8911
8912class GoogleCloudAiplatformV1beta1BatchMigrateResourcesOperationMetadata(_messages.Message):
8913  r"""Runtime operation information for
8914  MigrationService.BatchMigrateResources.
8915
8916  Fields:
8917    genericMetadata: The common part of the operation metadata.
8918    partialResults: Partial results that reflect the latest migration
8919      operation progress.
8920  """
8921
8922  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
8923  partialResults = _messages.MessageField('GoogleCloudAiplatformV1beta1BatchMigrateResourcesOperationMetadataPartialResult', 2, repeated=True)
8924
8925
8926class GoogleCloudAiplatformV1beta1BatchMigrateResourcesOperationMetadataPartialResult(_messages.Message):
8927  r"""Represents a partial result in batch migration operation for one
8928  MigrateResourceRequest.
8929
8930  Fields:
8931    dataset: Migrated dataset resource name.
8932    error: The error result of the migration request in case of failure.
8933    model: Migrated model resource name.
8934    request: It's the same as the value in
8935      MigrateResourceRequest.migrate_resource_requests.
8936  """
8937
8938  dataset = _messages.StringField(1)
8939  error = _messages.MessageField('GoogleRpcStatus', 2)
8940  model = _messages.StringField(3)
8941  request = _messages.MessageField('GoogleCloudAiplatformV1beta1MigrateResourceRequest', 4)
8942
8943
8944class GoogleCloudAiplatformV1beta1BatchMigrateResourcesResponse(_messages.Message):
8945  r"""Response message for MigrationService.BatchMigrateResources.
8946
8947  Fields:
8948    migrateResourceResponses: Successfully migrated resources.
8949  """
8950
8951  migrateResourceResponses = _messages.MessageField('GoogleCloudAiplatformV1beta1MigrateResourceResponse', 1, repeated=True)
8952
8953
8954class GoogleCloudAiplatformV1beta1ContainerSpec(_messages.Message):
8955  r"""The spec of a Container.
8956
8957  Fields:
8958    args: The arguments to be passed when starting the container.
8959    command: The command to be invoked when the container is started. It
8960      overrides the entrypoint instruction in Dockerfile when provided.
8961    imageUri: Required. The URI of a container image in the Container Registry
8962      that is to be run on each worker replica.
8963  """
8964
8965  args = _messages.StringField(1, repeated=True)
8966  command = _messages.StringField(2, repeated=True)
8967  imageUri = _messages.StringField(3)
8968
8969
8970class GoogleCloudAiplatformV1beta1CreateDatasetOperationMetadata(_messages.Message):
8971  r"""Runtime operation information for DatasetService.CreateDataset.
8972
8973  Fields:
8974    genericMetadata: The operation generic information.
8975  """
8976
8977  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
8978
8979
8980class GoogleCloudAiplatformV1beta1CreateEndpointOperationMetadata(_messages.Message):
8981  r"""Runtime operation information for EndpointService.CreateEndpoint.
8982
8983  Fields:
8984    genericMetadata: The operation generic information.
8985  """
8986
8987  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
8988
8989
8990class GoogleCloudAiplatformV1beta1CreateIndexEndpointOperationMetadata(_messages.Message):
8991  r"""Runtime operation information for
8992  IndexEndpointService.CreateIndexEndpoint.
8993
8994  Fields:
8995    genericMetadata: The operation generic information.
8996  """
8997
8998  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
8999
9000
9001class GoogleCloudAiplatformV1beta1CreateIndexOperationMetadata(_messages.Message):
9002  r"""Runtime operation information for IndexService.CreateIndex.
9003
9004  Fields:
9005    genericMetadata: The operation generic information.
9006    nearestNeighborSearchOperationMetadata: The operation metadata with regard
9007      to ScaNN Index operation.
9008  """
9009
9010  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
9011  nearestNeighborSearchOperationMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata', 2)
9012
9013
9014class GoogleCloudAiplatformV1beta1CreateSpecialistPoolOperationMetadata(_messages.Message):
9015  r"""Runtime operation information for
9016  SpecialistPoolService.CreateSpecialistPool.
9017
9018  Fields:
9019    genericMetadata: The operation generic information.
9020  """
9021
9022  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
9023
9024
9025class GoogleCloudAiplatformV1beta1CustomJobSpec(_messages.Message):
9026  r"""Represents the spec of a CustomJob.
9027
9028  Fields:
9029    baseOutputDirectory: The Cloud Storage location to store the output of
9030      this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob,
9031      the baseOutputDirectory of each child CustomJob backing a Trial is set
9032      to a subdirectory of name id under its parent HyperparameterTuningJob's
9033      baseOutputDirectory. The following AI Platform environment variables
9034      will be passed to containers or python modules when this field is set:
9035      For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR =
9036      `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob
9037      backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/`
9038      * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR =
9039      `//logs/`
9040    network: The full name of the Compute Engine
9041      [network](/compute/docs/networks-and-firewalls#networks) to which the
9042      Job should be peered. For example,
9043      `projects/12345/global/networks/myVPC`.
9044      [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form
9045      `projects/{project}/global/networks/{network}`. Where {project} is a
9046      project number, as in `12345`, and {network} is a network name. Private
9047      services access must already be configured for the network. If left
9048      unspecified, the job is not peered with any network.
9049    scheduling: Scheduling options for a CustomJob.
9050    serviceAccount: Specifies the service account for workload run-as account.
9051      Users submitting jobs must have act-as permission on this run-as
9052      account. If unspecified, the AI Platform Custom Code Service Agent for
9053      the CustomJob's project is used.
9054    workerPoolSpecs: Required. The spec of the worker pools including machine
9055      type and Docker image. All worker pools except the first one are
9056      optional and can be skipped by providing an empty value.
9057  """
9058
9059  baseOutputDirectory = _messages.MessageField('GoogleCloudAiplatformV1beta1GcsDestination', 1)
9060  network = _messages.StringField(2)
9061  scheduling = _messages.MessageField('GoogleCloudAiplatformV1beta1Scheduling', 3)
9062  serviceAccount = _messages.StringField(4)
9063  workerPoolSpecs = _messages.MessageField('GoogleCloudAiplatformV1beta1WorkerPoolSpec', 5, repeated=True)
9064
9065
9066class GoogleCloudAiplatformV1beta1DedicatedResources(_messages.Message):
9067  r"""A description of resources that are dedicated to a DeployedModel, and
9068  that need a higher degree of manual configuration.
9069
9070  Fields:
9071    machineSpec: Required. Immutable. The specification of a single machine
9072      used by the prediction.
9073    maxReplicaCount: Immutable. The maximum number of replicas this
9074      DeployedModel may be deployed on when the traffic against it increases.
9075      If the requested value is too large, the deployment will error, but if
9076      deployment succeeds then the ability to scale the model to that many
9077      replicas is guaranteed (barring service outages). If traffic against the
9078      DeployedModel increases beyond what its replicas at maximum may handle,
9079      a portion of the traffic will be dropped. If this value is not provided,
9080      will use min_replica_count as the default value.
9081    minReplicaCount: Required. Immutable. The minimum number of machine
9082      replicas this DeployedModel will be always deployed on. If traffic
9083      against it increases, it may dynamically be deployed onto more replicas,
9084      and as traffic decreases, some of these extra replicas may be freed.
9085      Note: if machine_spec.accelerator_count is above 0, currently the model
9086      will be always deployed precisely on min_replica_count.
9087  """
9088
9089  machineSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1MachineSpec', 1)
9090  maxReplicaCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
9091  minReplicaCount = _messages.IntegerField(3, variant=_messages.Variant.INT32)
9092
9093
9094class GoogleCloudAiplatformV1beta1DeleteOperationMetadata(_messages.Message):
9095  r"""Details of operations that perform deletes of any entities.
9096
9097  Fields:
9098    genericMetadata: The common part of the operation metadata.
9099  """
9100
9101  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
9102
9103
9104class GoogleCloudAiplatformV1beta1DeployIndexOperationMetadata(_messages.Message):
9105  r"""Runtime operation information for IndexEndpointService.DeployIndex.
9106
9107  Fields:
9108    genericMetadata: The operation generic information.
9109  """
9110
9111  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
9112
9113
9114class GoogleCloudAiplatformV1beta1DeployIndexResponse(_messages.Message):
9115  r"""Response message for IndexEndpointService.DeployIndex.
9116
9117  Fields:
9118    deployedIndex: The DeployedIndex that had been deployed in the
9119      IndexEndpoint.
9120  """
9121
9122  deployedIndex = _messages.MessageField('GoogleCloudAiplatformV1beta1DeployedIndex', 1)
9123
9124
9125class GoogleCloudAiplatformV1beta1DeployModelOperationMetadata(_messages.Message):
9126  r"""Runtime operation information for EndpointService.DeployModel.
9127
9128  Fields:
9129    genericMetadata: The operation generic information.
9130  """
9131
9132  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
9133
9134
9135class GoogleCloudAiplatformV1beta1DeployModelResponse(_messages.Message):
9136  r"""Response message for EndpointService.DeployModel.
9137
9138  Fields:
9139    deployedModel: The DeployedModel that had been deployed in the Endpoint.
9140  """
9141
9142  deployedModel = _messages.MessageField('GoogleCloudAiplatformV1beta1DeployedModel', 1)
9143
9144
9145class GoogleCloudAiplatformV1beta1DeployedIndex(_messages.Message):
9146  r"""A deployment of an Index. IndexEndpoints contain one or more
9147  DeployedIndexes.
9148
9149  Fields:
9150    automaticResources: Optional. A description of resources that the
9151      DeployedIndex uses, which to large degree are decided by AI Platform,
9152      and optionally allows only a modest additional configuration. If
9153      min_replica_count is not set, the default value is 1. If
9154      max_replica_count is not set, the default value is min_replica_count.
9155      The max allowed replica count is 1000. The user is billed for the
9156      resources (at least their minimal amount) even if the DeployedIndex
9157      receives no traffic.
9158    createTime: Output only. Timestamp when the DeployedIndex was created.
9159    displayName: The display name of the DeployedIndex. If not provided upon
9160      creation, the Index's display_name is used.
9161    id: Required. The user specified ID of the DeployedIndex. The ID can be up
9162      to 128 characters long and must start with a letter and only contain
9163      letters, numbers, and underscores. The ID must be unique within the
9164      project it is created in.
9165    index: Required. The name of the Index this is the deployment of. We may
9166      refer to this Index as the DeployedIndex's "original" Index.
9167    indexSyncTime: Output only. The DeployedIndex may depend on various data
9168      on its original Index. Additionally when certain changes to the original
9169      Index are being done (e.g. when what the Index contains is being
9170      changed) the DeployedIndex may be asynchronously updated in the
9171      background to reflect this changes. If this timestamp's value is at
9172      least the Index.update_time of the original Index, it means that this
9173      DeployedIndex and the original Index are in sync. If this timestamp is
9174      older, then to see which updates this DeployedIndex already contains
9175      (and which not), one must list Operations working on the original Index.
9176      Only the successfully completed Operations with
9177      Operations.metadata.generic_metadata.update_time equal or before this
9178      sync time are contained in this DeployedIndex.
9179    privateEndpoints: Output only. Provides paths for users to send requests
9180      directly to the deployed index services running on Cloud via private
9181      services access. This field is populated if network is configured.
9182  """
9183
9184  automaticResources = _messages.MessageField('GoogleCloudAiplatformV1beta1AutomaticResources', 1)
9185  createTime = _messages.StringField(2)
9186  displayName = _messages.StringField(3)
9187  id = _messages.StringField(4)
9188  index = _messages.StringField(5)
9189  indexSyncTime = _messages.StringField(6)
9190  privateEndpoints = _messages.MessageField('GoogleCloudAiplatformV1beta1IndexPrivateEndpoints', 7)
9191
9192
9193class GoogleCloudAiplatformV1beta1DeployedModel(_messages.Message):
9194  r"""A deployment of a Model. Endpoints contain one or more DeployedModels.
9195
9196  Fields:
9197    automaticResources: A description of resources that to large degree are
9198      decided by AI Platform, and require only a modest additional
9199      configuration.
9200    createTime: Output only. Timestamp when the DeployedModel was created.
9201    dedicatedResources: A description of resources that are dedicated to the
9202      DeployedModel, and that need a higher degree of manual configuration.
9203    displayName: The display name of the DeployedModel. If not provided upon
9204      creation, the Model's display_name is used.
9205    enableAccessLogging: These logs are like standard server access logs,
9206      containing information like timestamp and latency for each prediction
9207      request. Note that Stackdriver logs may incur a cost, especially if your
9208      project receives prediction requests at a high queries per second rate
9209      (QPS). Estimate your costs before enabling this option.
9210    enableContainerLogging: If true, the container of the DeployedModel
9211      instances will send `stderr` and `stdout` streams to Stackdriver
9212      Logging. Only supported for custom-trained Models and AutoML Tabular
9213      Models.
9214    explanationSpec: Explanation configuration for this DeployedModel. When
9215      deploying a Model using EndpointService.DeployModel, this value
9216      overrides the value of Model.explanation_spec. All fields of
9217      explanation_spec are optional in the request. If a field of
9218      explanation_spec is not populated, the value of the same field of
9219      Model.explanation_spec is inherited. If the corresponding
9220      Model.explanation_spec is not populated, all fields of the
9221      explanation_spec will be used for the explanation configuration.
9222    id: Output only. The ID of the DeployedModel.
9223    model: Required. The name of the Model that this is the deployment of.
9224      Note that the Model may be in a different location than the
9225      DeployedModel's Endpoint.
9226    serviceAccount: The service account that the DeployedModel's container
9227      runs as. Specify the email address of the service account. If this
9228      service account is not specified, the container runs as a service
9229      account that doesn't have access to the resource project. Users
9230      deploying the Model must have the `iam.serviceAccounts.actAs` permission
9231      on this service account.
9232  """
9233
9234  automaticResources = _messages.MessageField('GoogleCloudAiplatformV1beta1AutomaticResources', 1)
9235  createTime = _messages.StringField(2)
9236  dedicatedResources = _messages.MessageField('GoogleCloudAiplatformV1beta1DedicatedResources', 3)
9237  displayName = _messages.StringField(4)
9238  enableAccessLogging = _messages.BooleanField(5)
9239  enableContainerLogging = _messages.BooleanField(6)
9240  explanationSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1ExplanationSpec', 7)
9241  id = _messages.StringField(8)
9242  model = _messages.StringField(9)
9243  serviceAccount = _messages.StringField(10)
9244
9245
9246class GoogleCloudAiplatformV1beta1DiskSpec(_messages.Message):
9247  r"""Represents the spec of disk options.
9248
9249  Fields:
9250    bootDiskSizeGb: Size in GB of the boot disk (default is 100GB).
9251    bootDiskType: Type of the boot disk (default is "pd-ssd"). Valid values:
9252      "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard"
9253      (Persistent Disk Hard Disk Drive).
9254  """
9255
9256  bootDiskSizeGb = _messages.IntegerField(1, variant=_messages.Variant.INT32)
9257  bootDiskType = _messages.StringField(2)
9258
9259
9260class GoogleCloudAiplatformV1beta1ExplanationMetadata(_messages.Message):
9261  r"""Metadata describing the Model's input and output for explanation.
9262
9263  Messages:
9264    InputsValue: Required. Map from feature names to feature input metadata.
9265      Keys are the name of the features. Values are the specification of the
9266      feature. An empty InputMetadata is valid. It describes a text feature
9267      which has the name specified as the key in ExplanationMetadata.inputs.
9268      The baseline of the empty feature is chosen by AI Platform. For AI
9269      Platform provided Tensorflow images, the key can be any friendly name of
9270      the feature. Once specified, featureAttributions are keyed by this key
9271      (if not grouped with another feature). For custom images, the key must
9272      match with the key in instance.
9273    OutputsValue: Required. Map from output names to output metadata. For AI
9274      Platform provided Tensorflow images, keys can be any string user
9275      defines. For custom images, keys are the name of the output field in the
9276      prediction to be explained. Currently only one key is allowed.
9277
9278  Fields:
9279    featureAttributionsSchemaUri: Points to a YAML file stored on Google Cloud
9280      Storage describing the format of the feature attributions. The schema is
9281      defined as an OpenAPI 3.0.2 [Schema
9282      Object](https://tinyurl.com/y538mdwt#schema-object). AutoML tabular
9283      Models always have this field populated by AI Platform. Note: The URI
9284      given on output may be different, including the URI scheme, than the one
9285      given on input. The output URI will point to a location where the user
9286      only has a read access.
9287    inputs: Required. Map from feature names to feature input metadata. Keys
9288      are the name of the features. Values are the specification of the
9289      feature. An empty InputMetadata is valid. It describes a text feature
9290      which has the name specified as the key in ExplanationMetadata.inputs.
9291      The baseline of the empty feature is chosen by AI Platform. For AI
9292      Platform provided Tensorflow images, the key can be any friendly name of
9293      the feature. Once specified, featureAttributions are keyed by this key
9294      (if not grouped with another feature). For custom images, the key must
9295      match with the key in instance.
9296    outputs: Required. Map from output names to output metadata. For AI
9297      Platform provided Tensorflow images, keys can be any string user
9298      defines. For custom images, keys are the name of the output field in the
9299      prediction to be explained. Currently only one key is allowed.
9300  """
9301
9302  @encoding.MapUnrecognizedFields('additionalProperties')
9303  class InputsValue(_messages.Message):
9304    r"""Required. Map from feature names to feature input metadata. Keys are
9305    the name of the features. Values are the specification of the feature. An
9306    empty InputMetadata is valid. It describes a text feature which has the
9307    name specified as the key in ExplanationMetadata.inputs. The baseline of
9308    the empty feature is chosen by AI Platform. For AI Platform provided
9309    Tensorflow images, the key can be any friendly name of the feature. Once
9310    specified, featureAttributions are keyed by this key (if not grouped with
9311    another feature). For custom images, the key must match with the key in
9312    instance.
9313
9314    Messages:
9315      AdditionalProperty: An additional property for a InputsValue object.
9316
9317    Fields:
9318      additionalProperties: Additional properties of type InputsValue
9319    """
9320
9321    class AdditionalProperty(_messages.Message):
9322      r"""An additional property for a InputsValue object.
9323
9324      Fields:
9325        key: Name of the additional property.
9326        value: A GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadata
9327          attribute.
9328      """
9329
9330      key = _messages.StringField(1)
9331      value = _messages.MessageField('GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadata', 2)
9332
9333    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
9334
9335  @encoding.MapUnrecognizedFields('additionalProperties')
9336  class OutputsValue(_messages.Message):
9337    r"""Required. Map from output names to output metadata. For AI Platform
9338    provided Tensorflow images, keys can be any string user defines. For
9339    custom images, keys are the name of the output field in the prediction to
9340    be explained. Currently only one key is allowed.
9341
9342    Messages:
9343      AdditionalProperty: An additional property for a OutputsValue object.
9344
9345    Fields:
9346      additionalProperties: Additional properties of type OutputsValue
9347    """
9348
9349    class AdditionalProperty(_messages.Message):
9350      r"""An additional property for a OutputsValue object.
9351
9352      Fields:
9353        key: Name of the additional property.
9354        value: A GoogleCloudAiplatformV1beta1ExplanationMetadataOutputMetadata
9355          attribute.
9356      """
9357
9358      key = _messages.StringField(1)
9359      value = _messages.MessageField('GoogleCloudAiplatformV1beta1ExplanationMetadataOutputMetadata', 2)
9360
9361    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
9362
9363  featureAttributionsSchemaUri = _messages.StringField(1)
9364  inputs = _messages.MessageField('InputsValue', 2)
9365  outputs = _messages.MessageField('OutputsValue', 3)
9366
9367
9368class GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadata(_messages.Message):
9369  r"""Metadata of the input of a feature. Fields other than
9370  InputMetadata.input_baselines are applicable only for Models that are using
9371  AI Platform-provided images for Tensorflow.
9372
9373  Enums:
9374    EncodingValueValuesEnum: Defines how the feature is encoded into the input
9375      tensor. Defaults to IDENTITY.
9376
9377  Fields:
9378    denseShapeTensorName: Specifies the shape of the values of the input if
9379      the input is a sparse representation. Refer to Tensorflow documentation
9380      for more details:
9381      https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
9382    encodedBaselines: A list of baselines for the encoded tensor. The shape of
9383      each baseline should match the shape of the encoded tensor. If a scalar
9384      is provided, AI Platform broadcast to the same shape as the encoded
9385      tensor.
9386    encodedTensorName: Encoded tensor is a transformation of the input tensor.
9387      Must be provided if choosing Integrated Gradients attribution or XRAI
9388      attribution and the input tensor is not differentiable. An encoded
9389      tensor is generated if the input tensor is encoded by a lookup table.
9390    encoding: Defines how the feature is encoded into the input tensor.
9391      Defaults to IDENTITY.
9392    featureValueDomain: The domain details of the input feature value. Like
9393      min/max, original mean or standard deviation if normalized.
9394    groupName: Name of the group that the input belongs to. Features with the
9395      same group name will be treated as one feature when computing
9396      attributions. Features grouped together can have different shapes in
9397      value. If provided, there will be one single attribution generated in
9398      featureAttributions, keyed by the group name.
9399    indexFeatureMapping: A list of feature names for each index in the input
9400      tensor. Required when the input InputMetadata.encoding is
9401      BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
9402    indicesTensorName: Specifies the index of the values of the input tensor.
9403      Required when the input tensor is a sparse representation. Refer to
9404      Tensorflow documentation for more details:
9405      https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
9406    inputBaselines: Baseline inputs for this feature. If no baseline is
9407      specified, AI Platform chooses the baseline for this feature. If
9408      multiple baselines are specified, AI Platform returns the average
9409      attributions across them in Attributions.baseline_attribution. For AI
9410      Platform provided Tensorflow images (both 1.x and 2.x), the shape of
9411      each baseline must match the shape of the input tensor. If a scalar is
9412      provided, we broadcast to the same shape as the input tensor. For custom
9413      images, the element of the baselines must be in the same format as the
9414      feature's input in the instance[]. The schema of any single instance may
9415      be specified via Endpoint's DeployedModels' Model's PredictSchemata's
9416      instance_schema_uri.
9417    inputTensorName: Name of the input tensor for this feature. Required and
9418      is only applicable to AI Platform provided images for Tensorflow.
9419    modality: Modality of the feature. Valid values are: numeric, image.
9420      Defaults to numeric.
9421    visualization: Visualization configurations for image explanation.
9422  """
9423
9424  class EncodingValueValuesEnum(_messages.Enum):
9425    r"""Defines how the feature is encoded into the input tensor. Defaults to
9426    IDENTITY.
9427
9428    Values:
9429      ENCODING_UNSPECIFIED: Default value. This is the same as IDENTITY.
9430      IDENTITY: The tensor represents one feature.
9431      BAG_OF_FEATURES: The tensor represents a bag of features where each
9432        index maps to a feature. InputMetadata.index_feature_mapping must be
9433        provided for this encoding. For example: ``` input = [27, 6.0, 150]
9434        index_feature_mapping = ["age", "height", "weight"] ```
9435      BAG_OF_FEATURES_SPARSE: The tensor represents a bag of features where
9436        each index maps to a feature. Zero values in the tensor indicates
9437        feature being non-existent. InputMetadata.index_feature_mapping must
9438        be provided for this encoding. For example: ``` input = [2, 0, 5, 0,
9439        1] index_feature_mapping = ["a", "b", "c", "d", "e"] ```
9440      INDICATOR: The tensor is a list of binaries representing whether a
9441        feature exists or not (1 indicates existence).
9442        InputMetadata.index_feature_mapping must be provided for this
9443        encoding. For example: ``` input = [1, 0, 1, 0, 1]
9444        index_feature_mapping = ["a", "b", "c", "d", "e"] ```
9445      COMBINED_EMBEDDING: The tensor is encoded into a 1-dimensional array
9446        represented by an encoded tensor. InputMetadata.encoded_tensor_name
9447        must be provided for this encoding. For example: ``` input = ["This",
9448        "is", "a", "test", "."] encoded = [0.1, 0.2, 0.3, 0.4, 0.5] ```
9449      CONCAT_EMBEDDING: Select this encoding when the input tensor is encoded
9450        into a 2-dimensional array represented by an encoded tensor.
9451        InputMetadata.encoded_tensor_name must be provided for this encoding.
9452        The first dimension of the encoded tensor's shape is the same as the
9453        input tensor's shape. For example: ``` input = ["This", "is", "a",
9454        "test", "."] encoded = [[0.1, 0.2, 0.3, 0.4, 0.5], [0.2, 0.1, 0.4,
9455        0.3, 0.5], [0.5, 0.1, 0.3, 0.5, 0.4], [0.5, 0.3, 0.1, 0.2, 0.4], [0.4,
9456        0.3, 0.2, 0.5, 0.1]] ```
9457    """
9458    ENCODING_UNSPECIFIED = 0
9459    IDENTITY = 1
9460    BAG_OF_FEATURES = 2
9461    BAG_OF_FEATURES_SPARSE = 3
9462    INDICATOR = 4
9463    COMBINED_EMBEDDING = 5
9464    CONCAT_EMBEDDING = 6
9465
9466  denseShapeTensorName = _messages.StringField(1)
9467  encodedBaselines = _messages.MessageField('extra_types.JsonValue', 2, repeated=True)
9468  encodedTensorName = _messages.StringField(3)
9469  encoding = _messages.EnumField('EncodingValueValuesEnum', 4)
9470  featureValueDomain = _messages.MessageField('GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataFeatureValueDomain', 5)
9471  groupName = _messages.StringField(6)
9472  indexFeatureMapping = _messages.StringField(7, repeated=True)
9473  indicesTensorName = _messages.StringField(8)
9474  inputBaselines = _messages.MessageField('extra_types.JsonValue', 9, repeated=True)
9475  inputTensorName = _messages.StringField(10)
9476  modality = _messages.StringField(11)
9477  visualization = _messages.MessageField('GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataVisualization', 12)
9478
9479
9480class GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataFeatureValueDomain(_messages.Message):
9481  r"""Domain details of the input feature value. Provides numeric information
9482  about the feature, such as its range (min, max). If the feature has been
9483  pre-processed, for example with z-scoring, then it provides information
9484  about how to recover the original feature. For example, if the input feature
9485  is an image and it has been pre-processed to obtain 0-mean and stddev = 1
9486  values, then original_mean, and original_stddev refer to the mean and stddev
9487  of the original feature (e.g. image tensor) from which input feature (with
9488  mean = 0 and stddev = 1) was obtained.
9489
9490  Fields:
9491    maxValue: The maximum permissible value for this feature.
9492    minValue: The minimum permissible value for this feature.
9493    originalMean: If this input feature has been normalized to a mean value of
9494      0, the original_mean specifies the mean value of the domain prior to
9495      normalization.
9496    originalStddev: If this input feature has been normalized to a standard
9497      deviation of 1.0, the original_stddev specifies the standard deviation
9498      of the domain prior to normalization.
9499  """
9500
9501  maxValue = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
9502  minValue = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
9503  originalMean = _messages.FloatField(3, variant=_messages.Variant.FLOAT)
9504  originalStddev = _messages.FloatField(4, variant=_messages.Variant.FLOAT)
9505
9506
9507class GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataVisualization(_messages.Message):
9508  r"""Visualization configurations for image explanation.
9509
9510  Enums:
9511    ColorMapValueValuesEnum: The color scheme used for the highlighted areas.
9512      Defaults to PINK_GREEN for Integrated Gradients attribution, which shows
9513      positive attributions in green and negative in pink. Defaults to VIRIDIS
9514      for XRAI attribution, which highlights the most influential regions in
9515      yellow and the least influential in blue.
9516    OverlayTypeValueValuesEnum: How the original image is displayed in the
9517      visualization. Adjusting the overlay can help increase visual clarity if
9518      the original image makes it difficult to view the visualization.
9519      Defaults to NONE.
9520    PolarityValueValuesEnum: Whether to only highlight pixels with positive
9521      contributions, negative or both. Defaults to POSITIVE.
9522    TypeValueValuesEnum: Type of the image visualization. Only applicable to
9523      Integrated Gradients attribution. OUTLINES shows regions of attribution,
9524      while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
9525
9526  Fields:
9527    clipPercentLowerbound: Excludes attributions below the specified
9528      percentile, from the highlighted areas. Defaults to 35.
9529    clipPercentUpperbound: Excludes attributions above the specified
9530      percentile from the highlighted areas. Using the clip_percent_upperbound
9531      and clip_percent_lowerbound together can be useful for filtering out
9532      noise and making it easier to see areas of strong attribution. Defaults
9533      to 99.9.
9534    colorMap: The color scheme used for the highlighted areas. Defaults to
9535      PINK_GREEN for Integrated Gradients attribution, which shows positive
9536      attributions in green and negative in pink. Defaults to VIRIDIS for XRAI
9537      attribution, which highlights the most influential regions in yellow and
9538      the least influential in blue.
9539    overlayType: How the original image is displayed in the visualization.
9540      Adjusting the overlay can help increase visual clarity if the original
9541      image makes it difficult to view the visualization. Defaults to NONE.
9542    polarity: Whether to only highlight pixels with positive contributions,
9543      negative or both. Defaults to POSITIVE.
9544    type: Type of the image visualization. Only applicable to Integrated
9545      Gradients attribution. OUTLINES shows regions of attribution, while
9546      PIXELS shows per-pixel attribution. Defaults to OUTLINES.
9547  """
9548
9549  class ColorMapValueValuesEnum(_messages.Enum):
9550    r"""The color scheme used for the highlighted areas. Defaults to
9551    PINK_GREEN for Integrated Gradients attribution, which shows positive
9552    attributions in green and negative in pink. Defaults to VIRIDIS for XRAI
9553    attribution, which highlights the most influential regions in yellow and
9554    the least influential in blue.
9555
9556    Values:
9557      COLOR_MAP_UNSPECIFIED: Should not be used.
9558      PINK_GREEN: Positive: green. Negative: pink.
9559      VIRIDIS: Viridis color map: A perceptually uniform color mapping which
9560        is easier to see by those with colorblindness and progresses from
9561        yellow to green to blue. Positive: yellow. Negative: blue.
9562      RED: Positive: red. Negative: red.
9563      GREEN: Positive: green. Negative: green.
9564      RED_GREEN: Positive: green. Negative: red.
9565      PINK_WHITE_GREEN: PiYG palette.
9566    """
9567    COLOR_MAP_UNSPECIFIED = 0
9568    PINK_GREEN = 1
9569    VIRIDIS = 2
9570    RED = 3
9571    GREEN = 4
9572    RED_GREEN = 5
9573    PINK_WHITE_GREEN = 6
9574
9575  class OverlayTypeValueValuesEnum(_messages.Enum):
9576    r"""How the original image is displayed in the visualization. Adjusting
9577    the overlay can help increase visual clarity if the original image makes
9578    it difficult to view the visualization. Defaults to NONE.
9579
9580    Values:
9581      OVERLAY_TYPE_UNSPECIFIED: Default value. This is the same as NONE.
9582      NONE: No overlay.
9583      ORIGINAL: The attributions are shown on top of the original image.
9584      GRAYSCALE: The attributions are shown on top of grayscaled version of
9585        the original image.
9586      MASK_BLACK: The attributions are used as a mask to reveal predictive
9587        parts of the image and hide the un-predictive parts.
9588    """
9589    OVERLAY_TYPE_UNSPECIFIED = 0
9590    NONE = 1
9591    ORIGINAL = 2
9592    GRAYSCALE = 3
9593    MASK_BLACK = 4
9594
9595  class PolarityValueValuesEnum(_messages.Enum):
9596    r"""Whether to only highlight pixels with positive contributions, negative
9597    or both. Defaults to POSITIVE.
9598
9599    Values:
9600      POLARITY_UNSPECIFIED: Default value. This is the same as POSITIVE.
9601      POSITIVE: Highlights the pixels/outlines that were most influential to
9602        the model's prediction.
9603      NEGATIVE: Setting polarity to negative highlights areas that does not
9604        lead to the models's current prediction.
9605      BOTH: Shows both positive and negative attributions.
9606    """
9607    POLARITY_UNSPECIFIED = 0
9608    POSITIVE = 1
9609    NEGATIVE = 2
9610    BOTH = 3
9611
9612  class TypeValueValuesEnum(_messages.Enum):
9613    r"""Type of the image visualization. Only applicable to Integrated
9614    Gradients attribution. OUTLINES shows regions of attribution, while PIXELS
9615    shows per-pixel attribution. Defaults to OUTLINES.
9616
9617    Values:
9618      TYPE_UNSPECIFIED: Should not be used.
9619      PIXELS: Shows which pixel contributed to the image prediction.
9620      OUTLINES: Shows which region contributed to the image prediction by
9621        outlining the region.
9622    """
9623    TYPE_UNSPECIFIED = 0
9624    PIXELS = 1
9625    OUTLINES = 2
9626
9627  clipPercentLowerbound = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
9628  clipPercentUpperbound = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
9629  colorMap = _messages.EnumField('ColorMapValueValuesEnum', 3)
9630  overlayType = _messages.EnumField('OverlayTypeValueValuesEnum', 4)
9631  polarity = _messages.EnumField('PolarityValueValuesEnum', 5)
9632  type = _messages.EnumField('TypeValueValuesEnum', 6)
9633
9634
9635class GoogleCloudAiplatformV1beta1ExplanationMetadataOutputMetadata(_messages.Message):
9636  r"""Metadata of the prediction output to be explained.
9637
9638  Fields:
9639    displayNameMappingKey: Specify a field name in the prediction to look for
9640      the display name. Use this if the prediction contains the display names
9641      for the outputs. The display names in the prediction must have the same
9642      shape of the outputs, so that it can be located by
9643      Attribution.output_index for a specific output.
9644    indexDisplayNameMapping: Static mapping between the index and display
9645      name. Use this if the outputs are a deterministic n-dimensional array,
9646      e.g. a list of scores of all the classes in a pre-defined order for a
9647      multi-classification Model. It's not feasible if the outputs are non-
9648      deterministic, e.g. the Model produces top-k classes or sort the outputs
9649      by their values. The shape of the value must be an n-dimensional array
9650      of strings. The number of dimensions must match that of the outputs to
9651      be explained. The Attribution.output_display_name is populated by
9652      locating in the mapping with Attribution.output_index.
9653    outputTensorName: Name of the output tensor. Required and is only
9654      applicable to AI Platform provided images for Tensorflow.
9655  """
9656
9657  displayNameMappingKey = _messages.StringField(1)
9658  indexDisplayNameMapping = _messages.MessageField('extra_types.JsonValue', 2)
9659  outputTensorName = _messages.StringField(3)
9660
9661
9662class GoogleCloudAiplatformV1beta1ExplanationParameters(_messages.Message):
9663  r"""Parameters to configure explaining for Model's predictions.
9664
9665  Fields:
9666    integratedGradientsAttribution: An attribution method that computes
9667      Aumann-Shapley values taking advantage of the model's fully
9668      differentiable structure. Refer to this paper for more details:
9669      https://arxiv.org/abs/1703.01365
9670    outputIndices: If populated, only returns attributions that have
9671      output_index contained in output_indices. It must be an ndarray of
9672      integers, with the same shape of the output it's explaining. If not
9673      populated, returns attributions for top_k indices of outputs. If neither
9674      top_k nor output_indeices is populated, returns the argmax index of the
9675      outputs. Only applicable to Models that predict multiple outputs (e,g,
9676      multi-class Models that predict multiple classes).
9677    sampledShapleyAttribution: An attribution method that approximates Shapley
9678      values for features that contribute to the label being predicted. A
9679      sampling strategy is used to approximate the value rather than
9680      considering all subsets of features. Refer to this paper for model
9681      details: https://arxiv.org/abs/1306.4265.
9682    topK: If populated, returns attributions for top K indices of outputs
9683      (defaults to 1). Only applies to Models that predicts more than one
9684      outputs (e,g, multi-class Models). When set to -1, returns explanations
9685      for all outputs.
9686    xraiAttribution: An attribution method that redistributes Integrated
9687      Gradients attribution to segmented regions, taking advantage of the
9688      model's fully differentiable structure. Refer to this paper for more
9689      details: https://arxiv.org/abs/1906.02825 XRAI currently performs better
9690      on natural images, like a picture of a house or an animal. If the images
9691      are taken in artificial environments, like a lab or manufacturing line,
9692      or from diagnostic equipment, like x-rays or quality-control cameras,
9693      use Integrated Gradients instead.
9694  """
9695
9696  integratedGradientsAttribution = _messages.MessageField('GoogleCloudAiplatformV1beta1IntegratedGradientsAttribution', 1)
9697  outputIndices = _messages.MessageField('extra_types.JsonValue', 2, repeated=True)
9698  sampledShapleyAttribution = _messages.MessageField('GoogleCloudAiplatformV1beta1SampledShapleyAttribution', 3)
9699  topK = _messages.IntegerField(4, variant=_messages.Variant.INT32)
9700  xraiAttribution = _messages.MessageField('GoogleCloudAiplatformV1beta1XraiAttribution', 5)
9701
9702
9703class GoogleCloudAiplatformV1beta1ExplanationSpec(_messages.Message):
9704  r"""Specification of Model explanation.
9705
9706  Fields:
9707    metadata: Required. Metadata describing the Model's input and output for
9708      explanation.
9709    parameters: Required. Parameters that configure explaining of the Model's
9710      predictions.
9711  """
9712
9713  metadata = _messages.MessageField('GoogleCloudAiplatformV1beta1ExplanationMetadata', 1)
9714  parameters = _messages.MessageField('GoogleCloudAiplatformV1beta1ExplanationParameters', 2)
9715
9716
9717class GoogleCloudAiplatformV1beta1ExportDataOperationMetadata(_messages.Message):
9718  r"""Runtime operation information for DatasetService.ExportData.
9719
9720  Fields:
9721    gcsOutputDirectory: A Google Cloud Storage directory which path ends with
9722      '/'. The exported data is stored in the directory.
9723    genericMetadata: The common part of the operation metadata.
9724  """
9725
9726  gcsOutputDirectory = _messages.StringField(1)
9727  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 2)
9728
9729
9730class GoogleCloudAiplatformV1beta1ExportDataResponse(_messages.Message):
9731  r"""Response message for DatasetService.ExportData.
9732
9733  Fields:
9734    exportedFiles: All of the files that are exported in this export
9735      operation.
9736  """
9737
9738  exportedFiles = _messages.StringField(1, repeated=True)
9739
9740
9741class GoogleCloudAiplatformV1beta1ExportModelOperationMetadata(_messages.Message):
9742  r"""Details of ModelService.ExportModel operation.
9743
9744  Fields:
9745    genericMetadata: The common part of the operation metadata.
9746    outputInfo: Output only. Information further describing the output of this
9747      Model export.
9748  """
9749
9750  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
9751  outputInfo = _messages.MessageField('GoogleCloudAiplatformV1beta1ExportModelOperationMetadataOutputInfo', 2)
9752
9753
9754class GoogleCloudAiplatformV1beta1ExportModelOperationMetadataOutputInfo(_messages.Message):
9755  r"""Further describes the output of the ExportModel. Supplements
9756  ExportModelRequest.OutputConfig.
9757
9758  Fields:
9759    artifactOutputUri: Output only. If the Model artifact is being exported to
9760      Google Cloud Storage this is the full path of the directory created,
9761      into which the Model files are being written to.
9762    imageOutputUri: Output only. If the Model image is being exported to
9763      Google Container Registry or Artifact Registry this is the full path of
9764      the image created.
9765  """
9766
9767  artifactOutputUri = _messages.StringField(1)
9768  imageOutputUri = _messages.StringField(2)
9769
9770
9771class GoogleCloudAiplatformV1beta1ExportModelResponse(_messages.Message):
9772  r"""Response message of ModelService.ExportModel operation."""
9773
9774
9775class GoogleCloudAiplatformV1beta1FeatureNoiseSigma(_messages.Message):
9776  r"""Noise sigma by features. Noise sigma represents the standard deviation
9777  of the gaussian kernel that will be used to add noise to interpolated inputs
9778  prior to computing gradients.
9779
9780  Fields:
9781    noiseSigma: Noise sigma per feature. No noise is added to features that
9782      are not set.
9783  """
9784
9785  noiseSigma = _messages.MessageField('GoogleCloudAiplatformV1beta1FeatureNoiseSigmaNoiseSigmaForFeature', 1, repeated=True)
9786
9787
9788class GoogleCloudAiplatformV1beta1FeatureNoiseSigmaNoiseSigmaForFeature(_messages.Message):
9789  r"""Noise sigma for a single feature.
9790
9791  Fields:
9792    name: The name of the input feature for which noise sigma is provided. The
9793      features are defined in explanation metadata inputs.
9794    sigma: This represents the standard deviation of the Gaussian kernel that
9795      will be used to add noise to the feature prior to computing gradients.
9796      Similar to noise_sigma but represents the noise added to the current
9797      feature. Defaults to 0.1.
9798  """
9799
9800  name = _messages.StringField(1)
9801  sigma = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
9802
9803
9804class GoogleCloudAiplatformV1beta1GcsDestination(_messages.Message):
9805  r"""The Google Cloud Storage location where the output is to be written to.
9806
9807  Fields:
9808    outputUriPrefix: Required. Google Cloud Storage URI to output directory.
9809      If the uri doesn't end with '/', a '/' will be automatically appended.
9810      The directory is created if it doesn't exist.
9811  """
9812
9813  outputUriPrefix = _messages.StringField(1)
9814
9815
9816class GoogleCloudAiplatformV1beta1GenericOperationMetadata(_messages.Message):
9817  r"""Generic Metadata shared by all operations.
9818
9819  Fields:
9820    createTime: Output only. Time when the operation was created.
9821    partialFailures: Output only. Partial failures encountered. E.g. single
9822      files that couldn't be read. This field should never exceed 20 entries.
9823      Status details field will contain standard GCP error details.
9824    updateTime: Output only. Time when the operation was updated for the last
9825      time. If the operation has finished (successfully or not), this is the
9826      finish time.
9827  """
9828
9829  createTime = _messages.StringField(1)
9830  partialFailures = _messages.MessageField('GoogleRpcStatus', 2, repeated=True)
9831  updateTime = _messages.StringField(3)
9832
9833
9834class GoogleCloudAiplatformV1beta1ImportDataOperationMetadata(_messages.Message):
9835  r"""Runtime operation information for DatasetService.ImportData.
9836
9837  Fields:
9838    genericMetadata: The common part of the operation metadata.
9839  """
9840
9841  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
9842
9843
9844class GoogleCloudAiplatformV1beta1ImportDataResponse(_messages.Message):
9845  r"""Response message for DatasetService.ImportData."""
9846
9847
9848class GoogleCloudAiplatformV1beta1IndexPrivateEndpoints(_messages.Message):
9849  r"""IndexPrivateEndpoints proto is used to provide paths for users to send
9850  requests via private services access.
9851
9852  Fields:
9853    matchGrpcAddress: Output only. The ip address used to send match gRPC
9854      requests.
9855  """
9856
9857  matchGrpcAddress = _messages.StringField(1)
9858
9859
9860class GoogleCloudAiplatformV1beta1IntegratedGradientsAttribution(_messages.Message):
9861  r"""An attribution method that computes the Aumann-Shapley value taking
9862  advantage of the model's fully differentiable structure. Refer to this paper
9863  for more details: https://arxiv.org/abs/1703.01365
9864
9865  Fields:
9866    smoothGradConfig: Config for SmoothGrad approximation of gradients. When
9867      enabled, the gradients are approximated by averaging the gradients from
9868      noisy samples in the vicinity of the inputs. Adding noise can help
9869      improve the computed gradients. Refer to this paper for more details:
9870      https://arxiv.org/pdf/1706.03825.pdf
9871    stepCount: Required. The number of steps for approximating the path
9872      integral. A good value to start is 50 and gradually increase until the
9873      sum to diff property is within the desired error range. Valid range of
9874      its value is [1, 100], inclusively.
9875  """
9876
9877  smoothGradConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1SmoothGradConfig', 1)
9878  stepCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
9879
9880
9881class GoogleCloudAiplatformV1beta1MachineSpec(_messages.Message):
9882  r"""Specification of a single machine.
9883
9884  Enums:
9885    AcceleratorTypeValueValuesEnum: Immutable. The type of accelerator(s) that
9886      may be attached to the machine as per accelerator_count.
9887
9888  Fields:
9889    acceleratorCount: The number of accelerators to attach to the machine.
9890    acceleratorType: Immutable. The type of accelerator(s) that may be
9891      attached to the machine as per accelerator_count.
9892    machineType: Immutable. The type of the machine. For the machine types
9893      supported for prediction, see https://tinyurl.com/aip-
9894      docs/predictions/machine-types. For machine types supported for creating
9895      a custom training job, see https://tinyurl.com/aip-
9896      docs/training/configure-compute. For DeployedModel this field is
9897      optional, and the default value is `n1-standard-2`. For
9898      BatchPredictionJob or as part of WorkerPoolSpec this field is required.
9899  """
9900
9901  class AcceleratorTypeValueValuesEnum(_messages.Enum):
9902    r"""Immutable. The type of accelerator(s) that may be attached to the
9903    machine as per accelerator_count.
9904
9905    Values:
9906      ACCELERATOR_TYPE_UNSPECIFIED: Unspecified accelerator type, which means
9907        no accelerator.
9908      NVIDIA_TESLA_K80: Nvidia Tesla K80 GPU.
9909      NVIDIA_TESLA_P100: Nvidia Tesla P100 GPU.
9910      NVIDIA_TESLA_V100: Nvidia Tesla V100 GPU.
9911      NVIDIA_TESLA_P4: Nvidia Tesla P4 GPU.
9912      NVIDIA_TESLA_T4: Nvidia Tesla T4 GPU.
9913      TPU_V2: TPU v2.
9914      TPU_V3: TPU v3.
9915    """
9916    ACCELERATOR_TYPE_UNSPECIFIED = 0
9917    NVIDIA_TESLA_K80 = 1
9918    NVIDIA_TESLA_P100 = 2
9919    NVIDIA_TESLA_V100 = 3
9920    NVIDIA_TESLA_P4 = 4
9921    NVIDIA_TESLA_T4 = 5
9922    TPU_V2 = 6
9923    TPU_V3 = 7
9924
9925  acceleratorCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
9926  acceleratorType = _messages.EnumField('AcceleratorTypeValueValuesEnum', 2)
9927  machineType = _messages.StringField(3)
9928
9929
9930class GoogleCloudAiplatformV1beta1MigratableResource(_messages.Message):
9931  r"""Represents one resource that exists in automl.googleapis.com,
9932  datalabeling.googleapis.com or ml.googleapis.com.
9933
9934  Fields:
9935    automlDataset: Output only. Represents one Dataset in
9936      automl.googleapis.com.
9937    automlModel: Output only. Represents one Model in automl.googleapis.com.
9938    dataLabelingDataset: Output only. Represents one Dataset in
9939      datalabeling.googleapis.com.
9940    lastMigrateTime: Output only. Timestamp when the last migration attempt on
9941      this MigratableResource started. Will not be set if there's no migration
9942      attempt on this MigratableResource.
9943    lastUpdateTime: Output only. Timestamp when this MigratableResource was
9944      last updated.
9945    mlEngineModelVersion: Output only. Represents one Version in
9946      ml.googleapis.com.
9947  """
9948
9949  automlDataset = _messages.MessageField('GoogleCloudAiplatformV1beta1MigratableResourceAutomlDataset', 1)
9950  automlModel = _messages.MessageField('GoogleCloudAiplatformV1beta1MigratableResourceAutomlModel', 2)
9951  dataLabelingDataset = _messages.MessageField('GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDataset', 3)
9952  lastMigrateTime = _messages.StringField(4)
9953  lastUpdateTime = _messages.StringField(5)
9954  mlEngineModelVersion = _messages.MessageField('GoogleCloudAiplatformV1beta1MigratableResourceMlEngineModelVersion', 6)
9955
9956
9957class GoogleCloudAiplatformV1beta1MigratableResourceAutomlDataset(_messages.Message):
9958  r"""Represents one Dataset in automl.googleapis.com.
9959
9960  Fields:
9961    dataset: Full resource name of automl Dataset. Format:
9962      `projects/{project}/locations/{location}/datasets/{dataset}`.
9963    datasetDisplayName: The Dataset's display name in automl.googleapis.com.
9964  """
9965
9966  dataset = _messages.StringField(1)
9967  datasetDisplayName = _messages.StringField(2)
9968
9969
9970class GoogleCloudAiplatformV1beta1MigratableResourceAutomlModel(_messages.Message):
9971  r"""Represents one Model in automl.googleapis.com.
9972
9973  Fields:
9974    model: Full resource name of automl Model. Format:
9975      `projects/{project}/locations/{location}/models/{model}`.
9976    modelDisplayName: The Model's display name in automl.googleapis.com.
9977  """
9978
9979  model = _messages.StringField(1)
9980  modelDisplayName = _messages.StringField(2)
9981
9982
9983class GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDataset(_messages.Message):
9984  r"""Represents one Dataset in datalabeling.googleapis.com.
9985
9986  Fields:
9987    dataLabelingAnnotatedDatasets: The migratable AnnotatedDataset in
9988      datalabeling.googleapis.com belongs to the data labeling Dataset.
9989    dataset: Full resource name of data labeling Dataset. Format:
9990      `projects/{project}/datasets/{dataset}`.
9991    datasetDisplayName: The Dataset's display name in
9992      datalabeling.googleapis.com.
9993  """
9994
9995  dataLabelingAnnotatedDatasets = _messages.MessageField('GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset', 1, repeated=True)
9996  dataset = _messages.StringField(2)
9997  datasetDisplayName = _messages.StringField(3)
9998
9999
10000class GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset(_messages.Message):
10001  r"""Represents one AnnotatedDataset in datalabeling.googleapis.com.
10002
10003  Fields:
10004    annotatedDataset: Full resource name of data labeling AnnotatedDataset.
10005      Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annota
10006      ted_dataset}`.
10007    annotatedDatasetDisplayName: The AnnotatedDataset's display name in
10008      datalabeling.googleapis.com.
10009  """
10010
10011  annotatedDataset = _messages.StringField(1)
10012  annotatedDatasetDisplayName = _messages.StringField(2)
10013
10014
10015class GoogleCloudAiplatformV1beta1MigratableResourceMlEngineModelVersion(_messages.Message):
10016  r"""Represents one model Version in ml.googleapis.com.
10017
10018  Fields:
10019    endpoint: The ml.googleapis.com endpoint that this model Version currently
10020      lives in. Example values: * ml.googleapis.com * us-centrall-
10021      ml.googleapis.com * europe-west4-ml.googleapis.com * asia-
10022      east1-ml.googleapis.com
10023    version: Full resource name of ml engine model Version. Format:
10024      `projects/{project}/models/{model}/versions/{version}`.
10025  """
10026
10027  endpoint = _messages.StringField(1)
10028  version = _messages.StringField(2)
10029
10030
10031class GoogleCloudAiplatformV1beta1MigrateResourceRequest(_messages.Message):
10032  r"""Config of migrating one resource from automl.googleapis.com,
10033  datalabeling.googleapis.com and ml.googleapis.com to AI Platform.
10034
10035  Fields:
10036    migrateAutomlDatasetConfig: Config for migrating Dataset in
10037      automl.googleapis.com to AI Platform's Dataset.
10038    migrateAutomlModelConfig: Config for migrating Model in
10039      automl.googleapis.com to AI Platform's Model.
10040    migrateDataLabelingDatasetConfig: Config for migrating Dataset in
10041      datalabeling.googleapis.com to AI Platform's Dataset.
10042    migrateMlEngineModelVersionConfig: Config for migrating Version in
10043      ml.googleapis.com to AI Platform's Model.
10044  """
10045
10046  migrateAutomlDatasetConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlDatasetConfig', 1)
10047  migrateAutomlModelConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlModelConfig', 2)
10048  migrateDataLabelingDatasetConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfig', 3)
10049  migrateMlEngineModelVersionConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateMlEngineModelVersionConfig', 4)
10050
10051
10052class GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlDatasetConfig(_messages.Message):
10053  r"""Config for migrating Dataset in automl.googleapis.com to AI Platform's
10054  Dataset.
10055
10056  Fields:
10057    dataset: Required. Full resource name of automl Dataset. Format:
10058      `projects/{project}/locations/{location}/datasets/{dataset}`.
10059    datasetDisplayName: Required. Display name of the Dataset in AI Platform.
10060      System will pick a display name if unspecified.
10061  """
10062
10063  dataset = _messages.StringField(1)
10064  datasetDisplayName = _messages.StringField(2)
10065
10066
10067class GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlModelConfig(_messages.Message):
10068  r"""Config for migrating Model in automl.googleapis.com to AI Platform's
10069  Model.
10070
10071  Fields:
10072    model: Required. Full resource name of automl Model. Format:
10073      `projects/{project}/locations/{location}/models/{model}`.
10074    modelDisplayName: Optional. Display name of the model in AI Platform.
10075      System will pick a display name if unspecified.
10076  """
10077
10078  model = _messages.StringField(1)
10079  modelDisplayName = _messages.StringField(2)
10080
10081
10082class GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfig(_messages.Message):
10083  r"""Config for migrating Dataset in datalabeling.googleapis.com to AI
10084  Platform's Dataset.
10085
10086  Fields:
10087    dataset: Required. Full resource name of data labeling Dataset. Format:
10088      `projects/{project}/datasets/{dataset}`.
10089    datasetDisplayName: Optional. Display name of the Dataset in AI Platform.
10090      System will pick a display name if unspecified.
10091    migrateDataLabelingAnnotatedDatasetConfigs: Optional. Configs for
10092      migrating AnnotatedDataset in datalabeling.googleapis.com to AI
10093      Platform's SavedQuery. The specified AnnotatedDatasets have to belong to
10094      the datalabeling Dataset.
10095  """
10096
10097  dataset = _messages.StringField(1)
10098  datasetDisplayName = _messages.StringField(2)
10099  migrateDataLabelingAnnotatedDatasetConfigs = _messages.MessageField('GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig', 3, repeated=True)
10100
10101
10102class GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig(_messages.Message):
10103  r"""Config for migrating AnnotatedDataset in datalabeling.googleapis.com to
10104  AI Platform's SavedQuery.
10105
10106  Fields:
10107    annotatedDataset: Required. Full resource name of data labeling
10108      AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotat
10109      edDatasets/{annotated_dataset}`.
10110  """
10111
10112  annotatedDataset = _messages.StringField(1)
10113
10114
10115class GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateMlEngineModelVersionConfig(_messages.Message):
10116  r"""Config for migrating version in ml.googleapis.com to AI Platform's
10117  Model.
10118
10119  Fields:
10120    endpoint: Required. The ml.googleapis.com endpoint that this model version
10121      should be migrated from. Example values: * ml.googleapis.com * us-
10122      centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * asia-
10123      east1-ml.googleapis.com
10124    modelDisplayName: Required. Display name of the model in AI Platform.
10125      System will pick a display name if unspecified.
10126    modelVersion: Required. Full resource name of ml engine model version.
10127      Format: `projects/{project}/models/{model}/versions/{version}`.
10128  """
10129
10130  endpoint = _messages.StringField(1)
10131  modelDisplayName = _messages.StringField(2)
10132  modelVersion = _messages.StringField(3)
10133
10134
10135class GoogleCloudAiplatformV1beta1MigrateResourceResponse(_messages.Message):
10136  r"""Describes a successfully migrated resource.
10137
10138  Fields:
10139    dataset: Migrated Dataset's resource name.
10140    migratableResource: Before migration, the identifier in ml.googleapis.com,
10141      automl.googleapis.com or datalabeling.googleapis.com.
10142    model: Migrated Model's resource name.
10143  """
10144
10145  dataset = _messages.StringField(1)
10146  migratableResource = _messages.MessageField('GoogleCloudAiplatformV1beta1MigratableResource', 2)
10147  model = _messages.StringField(3)
10148
10149
10150class GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata(_messages.Message):
10151  r"""Runtime operation metadata with regard to ScaNN Index.
10152
10153  Fields:
10154    contentValidationStats: The validation stats of the content (per file) to
10155      be inserted or updated on the ScaNN Index resource. Populated if
10156      contentsDeltaUri is provided as part of Index.metadata. Please note
10157      that, currently for those files that are broken or has unsupported file
10158      format, we will not have the stats for those files.
10159  """
10160
10161  contentValidationStats = _messages.MessageField('GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataContentValidationStats', 1, repeated=True)
10162
10163
10164class GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataContentValidationStats(_messages.Message):
10165  r"""A GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataCont
10166  entValidationStats object.
10167
10168  Fields:
10169    invalidRecordCount: Number of records in this file we skipped due to
10170      validate errors.
10171    partialErrors: The detail information of the partial failures encountered
10172      for those invalid records that couldn't be parsed. Up to 50 partial
10173      errors will be reported.
10174    sourceGcsUri: GCS uri pointing to the original file in user's bucket.
10175    validRecordCount: Number of records in this file that were successfully
10176      processed.
10177  """
10178
10179  invalidRecordCount = _messages.IntegerField(1)
10180  partialErrors = _messages.MessageField('GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError', 2, repeated=True)
10181  sourceGcsUri = _messages.StringField(3)
10182  validRecordCount = _messages.IntegerField(4)
10183
10184
10185class GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError(_messages.Message):
10186  r"""A GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataReco
10187  rdError object.
10188
10189  Enums:
10190    ErrorTypeValueValuesEnum: The error type of this record.
10191
10192  Fields:
10193    embeddingId: Empty if the embedding id is failed to parse.
10194    errorMessage: A human-readable message that is shown to the user to help
10195      them fix the error. Note that this message may change from time to time,
10196      your code should check against error_type as the source of truth.
10197    errorType: The error type of this record.
10198    rawRecord: The original content of this record.
10199    sourceGcsUri: GCS uri pointing to the original file in user's bucket.
10200  """
10201
10202  class ErrorTypeValueValuesEnum(_messages.Enum):
10203    r"""The error type of this record.
10204
10205    Values:
10206      ERROR_TYPE_UNSPECIFIED: Default, shall not be used.
10207      EMPTY_LINE: The record is empty.
10208      INVALID_JSON_SYNTAX: Invalid json format.
10209      INVALID_CSV_SYNTAX: Invalid csv format.
10210      INVALID_AVRO_SYNTAX: Invalid avro format.
10211      INVALID_EMBEDDING_ID: The embedding id is not valid.
10212      EMBEDDING_SIZE_MISMATCH: The size of the embedding vectors does not
10213        match with the specified dimension.
10214      NAMESPACE_MISSING: The `namespace` field is missing.
10215    """
10216    ERROR_TYPE_UNSPECIFIED = 0
10217    EMPTY_LINE = 1
10218    INVALID_JSON_SYNTAX = 2
10219    INVALID_CSV_SYNTAX = 3
10220    INVALID_AVRO_SYNTAX = 4
10221    INVALID_EMBEDDING_ID = 5
10222    EMBEDDING_SIZE_MISMATCH = 6
10223    NAMESPACE_MISSING = 7
10224
10225  embeddingId = _messages.StringField(1)
10226  errorMessage = _messages.StringField(2)
10227  errorType = _messages.EnumField('ErrorTypeValueValuesEnum', 3)
10228  rawRecord = _messages.StringField(4)
10229  sourceGcsUri = _messages.StringField(5)
10230
10231
10232class GoogleCloudAiplatformV1beta1PythonPackageSpec(_messages.Message):
10233  r"""The spec of a Python packaged code.
10234
10235  Fields:
10236    args: Command line arguments to be passed to the Python task.
10237    executorImageUri: Required. The URI of a container image in the Container
10238      Registry that will run the provided python package. AI Platform provides
10239      wide range of executor images with pre-installed packages to meet users'
10240      various use cases. Only one of the provided images can be set here.
10241    packageUris: Required. The Google Cloud Storage location of the Python
10242      package files which are the training program and its dependent packages.
10243      The maximum number of package URIs is 100.
10244    pythonModule: Required. The Python module name to run after installing the
10245      packages.
10246  """
10247
10248  args = _messages.StringField(1, repeated=True)
10249  executorImageUri = _messages.StringField(2)
10250  packageUris = _messages.StringField(3, repeated=True)
10251  pythonModule = _messages.StringField(4)
10252
10253
10254class GoogleCloudAiplatformV1beta1SampledShapleyAttribution(_messages.Message):
10255  r"""An attribution method that approximates Shapley values for features that
10256  contribute to the label being predicted. A sampling strategy is used to
10257  approximate the value rather than considering all subsets of features.
10258
10259  Fields:
10260    pathCount: Required. The number of feature permutations to consider when
10261      approximating the Shapley values. Valid range of its value is [1, 50],
10262      inclusively.
10263  """
10264
10265  pathCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
10266
10267
10268class GoogleCloudAiplatformV1beta1Scheduling(_messages.Message):
10269  r"""All parameters related to queuing and scheduling of custom jobs.
10270
10271  Fields:
10272    restartJobOnWorkerRestart: Restarts the entire CustomJob if a worker gets
10273      restarted. This feature can be used by distributed training jobs that
10274      are not resilient to workers leaving and joining a job.
10275    timeout: The maximum job running time. The default is 7 days.
10276  """
10277
10278  restartJobOnWorkerRestart = _messages.BooleanField(1)
10279  timeout = _messages.StringField(2)
10280
10281
10282class GoogleCloudAiplatformV1beta1SchemaAnnotationSpecColor(_messages.Message):
10283  r"""An entry of mapping between color and AnnotationSpec. The mapping is
10284  used in segmentation mask.
10285
10286  Fields:
10287    color: The color of the AnnotationSpec in a segmentation mask.
10288    displayName: The display name of the AnnotationSpec represented by the
10289      color in the segmentation mask.
10290    id: The ID of the AnnotationSpec represented by the color in the
10291      segmentation mask.
10292  """
10293
10294  color = _messages.MessageField('GoogleTypeColor', 1)
10295  displayName = _messages.StringField(2)
10296  id = _messages.StringField(3)
10297
10298
10299class GoogleCloudAiplatformV1beta1SchemaImageBoundingBoxAnnotation(_messages.Message):
10300  r"""Annotation details specific to image object detection.
10301
10302  Fields:
10303    annotationSpecId: The resource Id of the AnnotationSpec that this
10304      Annotation pertains to.
10305    displayName: The display name of the AnnotationSpec that this Annotation
10306      pertains to.
10307    xMax: The rightmost coordinate of the bounding box.
10308    xMin: The leftmost coordinate of the bounding box.
10309    yMax: The bottommost coordinate of the bounding box.
10310    yMin: The topmost coordinate of the bounding box.
10311  """
10312
10313  annotationSpecId = _messages.StringField(1)
10314  displayName = _messages.StringField(2)
10315  xMax = _messages.FloatField(3)
10316  xMin = _messages.FloatField(4)
10317  yMax = _messages.FloatField(5)
10318  yMin = _messages.FloatField(6)
10319
10320
10321class GoogleCloudAiplatformV1beta1SchemaImageClassificationAnnotation(_messages.Message):
10322  r"""Annotation details specific to image classification.
10323
10324  Fields:
10325    annotationSpecId: The resource Id of the AnnotationSpec that this
10326      Annotation pertains to.
10327    displayName: The display name of the AnnotationSpec that this Annotation
10328      pertains to.
10329  """
10330
10331  annotationSpecId = _messages.StringField(1)
10332  displayName = _messages.StringField(2)
10333
10334
10335class GoogleCloudAiplatformV1beta1SchemaImageDataItem(_messages.Message):
10336  r"""Payload of Image DataItem.
10337
10338  Fields:
10339    gcsUri: Required. Google Cloud Storage URI points to the original image in
10340      user's bucket. The image is up to 30MB in size.
10341    mimeType: Output only. The mime type of the content of the image. Only the
10342      images in below listed mime types are supported. - image/jpeg -
10343      image/gif - image/png - image/webp - image/bmp - image/tiff -
10344      image/vnd.microsoft.icon
10345  """
10346
10347  gcsUri = _messages.StringField(1)
10348  mimeType = _messages.StringField(2)
10349
10350
10351class GoogleCloudAiplatformV1beta1SchemaImageDatasetMetadata(_messages.Message):
10352  r"""The metadata of Datasets that contain Image DataItems.
10353
10354  Fields:
10355    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
10356      describing payload of the Image DataItems that belong to this Dataset.
10357    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
10358      this Dataset.
10359  """
10360
10361  dataItemSchemaUri = _messages.StringField(1)
10362  gcsBucket = _messages.StringField(2)
10363
10364
10365class GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotation(_messages.Message):
10366  r"""Annotation details specific to image segmentation.
10367
10368  Fields:
10369    maskAnnotation: Mask based segmentation annotation. Only one mask
10370      annotation can exist for one image.
10371    polygonAnnotation: Polygon annotation.
10372    polylineAnnotation: Polyline annotation.
10373  """
10374
10375  maskAnnotation = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationMaskAnnotation', 1)
10376  polygonAnnotation = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolygonAnnotation', 2)
10377  polylineAnnotation = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolylineAnnotation', 3)
10378
10379
10380class GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationMaskAnnotation(_messages.Message):
10381  r"""The mask based segmentation annotation.
10382
10383  Fields:
10384    annotationSpecColors: The mapping between color and AnnotationSpec for
10385      this Annotation.
10386    maskGcsUri: Google Cloud Storage URI that points to the mask image. The
10387      image must be in PNG format. It must have the same size as the
10388      DataItem's image. Each pixel in the image mask represents the
10389      AnnotationSpec which the pixel in the image DataItem belong to. Each
10390      color is mapped to one AnnotationSpec based on annotation_spec_colors.
10391  """
10392
10393  annotationSpecColors = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaAnnotationSpecColor', 1, repeated=True)
10394  maskGcsUri = _messages.StringField(2)
10395
10396
10397class GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolygonAnnotation(_messages.Message):
10398  r"""Represents a polygon in image.
10399
10400  Fields:
10401    annotationSpecId: The resource Id of the AnnotationSpec that this
10402      Annotation pertains to.
10403    displayName: The display name of the AnnotationSpec that this Annotation
10404      pertains to.
10405    vertexes: The vertexes are connected one by one and the last vertex is
10406      connected to the first one to represent a polygon.
10407  """
10408
10409  annotationSpecId = _messages.StringField(1)
10410  displayName = _messages.StringField(2)
10411  vertexes = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaVertex', 3, repeated=True)
10412
10413
10414class GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolylineAnnotation(_messages.Message):
10415  r"""Represents a polyline in image.
10416
10417  Fields:
10418    annotationSpecId: The resource Id of the AnnotationSpec that this
10419      Annotation pertains to.
10420    displayName: The display name of the AnnotationSpec that this Annotation
10421      pertains to.
10422    vertexes: The vertexes are connected one by one and the last vertex in not
10423      connected to the first one.
10424  """
10425
10426  annotationSpecId = _messages.StringField(1)
10427  displayName = _messages.StringField(2)
10428  vertexes = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaVertex', 3, repeated=True)
10429
10430
10431class GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageClassificationPredictionInstance(_messages.Message):
10432  r"""Prediction input format for Image Classification.
10433
10434  Fields:
10435    content: The image bytes or GCS URI to make the prediction on.
10436    mimeType: The MIME type of the content of the image. Only the images in
10437      below listed MIME types are supported. - image/jpeg - image/gif -
10438      image/png - image/webp - image/bmp - image/tiff -
10439      image/vnd.microsoft.icon
10440  """
10441
10442  content = _messages.StringField(1)
10443  mimeType = _messages.StringField(2)
10444
10445
10446class GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageObjectDetectionPredictionInstance(_messages.Message):
10447  r"""Prediction input format for Image Object Detection.
10448
10449  Fields:
10450    content: The image bytes or GCS URI to make the prediction on.
10451    mimeType: The MIME type of the content of the image. Only the images in
10452      below listed MIME types are supported. - image/jpeg - image/gif -
10453      image/png - image/webp - image/bmp - image/tiff -
10454      image/vnd.microsoft.icon
10455  """
10456
10457  content = _messages.StringField(1)
10458  mimeType = _messages.StringField(2)
10459
10460
10461class GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageSegmentationPredictionInstance(_messages.Message):
10462  r"""Prediction input format for Image Segmentation.
10463
10464  Fields:
10465    content: The image bytes to make the predictions on.
10466    mimeType: The MIME type of the content of the image. Only the images in
10467      below listed MIME types are supported. - image/jpeg - image/png
10468  """
10469
10470  content = _messages.StringField(1)
10471  mimeType = _messages.StringField(2)
10472
10473
10474class GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextClassificationPredictionInstance(_messages.Message):
10475  r"""Prediction input format for Text Classification.
10476
10477  Fields:
10478    content: The text snippet to make the predictions on.
10479    mimeType: The MIME type of the text snippet. The supported MIME types are
10480      listed below. - text/plain
10481  """
10482
10483  content = _messages.StringField(1)
10484  mimeType = _messages.StringField(2)
10485
10486
10487class GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextExtractionPredictionInstance(_messages.Message):
10488  r"""Prediction input format for Text Extraction.
10489
10490  Fields:
10491    content: The text snippet to make the predictions on.
10492    key: This field is only used for batch prediction. If a key is provided,
10493      the batch prediction result will by mapped to this key. If omitted, then
10494      the batch prediction result will contain the entire input instance. AI
10495      Platform will not check if keys in the request are duplicates, so it is
10496      up to the caller to ensure the keys are unique.
10497    mimeType: The MIME type of the text snippet. The supported MIME types are
10498      listed below. - text/plain
10499  """
10500
10501  content = _messages.StringField(1)
10502  key = _messages.StringField(2)
10503  mimeType = _messages.StringField(3)
10504
10505
10506class GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextSentimentPredictionInstance(_messages.Message):
10507  r"""Prediction input format for Text Sentiment.
10508
10509  Fields:
10510    content: The text snippet to make the predictions on.
10511    mimeType: The MIME type of the text snippet. The supported MIME types are
10512      listed below. - text/plain
10513  """
10514
10515  content = _messages.StringField(1)
10516  mimeType = _messages.StringField(2)
10517
10518
10519class GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoActionRecognitionPredictionInstance(_messages.Message):
10520  r"""Prediction input format for Video Action Recognition.
10521
10522  Fields:
10523    content: The Google Cloud Storage location of the video on which to
10524      perform the prediction.
10525    mimeType: The MIME type of the content of the video. Only the following
10526      are supported: video/mp4 video/avi video/quicktime
10527    timeSegmentEnd: The end, exclusive, of the video's time segment on which
10528      to perform the prediction. Expressed as a number of seconds as measured
10529      from the start of the video, with "s" appended at the end. Fractions are
10530      allowed, up to a microsecond precision, and "inf" or "Infinity" is
10531      allowed, which means the end of the video.
10532    timeSegmentStart: The beginning, inclusive, of the video's time segment on
10533      which to perform the prediction. Expressed as a number of seconds as
10534      measured from the start of the video, with "s" appended at the end.
10535      Fractions are allowed, up to a microsecond precision.
10536  """
10537
10538  content = _messages.StringField(1)
10539  mimeType = _messages.StringField(2)
10540  timeSegmentEnd = _messages.StringField(3)
10541  timeSegmentStart = _messages.StringField(4)
10542
10543
10544class GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoClassificationPredictionInstance(_messages.Message):
10545  r"""Prediction input format for Video Classification.
10546
10547  Fields:
10548    content: The Google Cloud Storage location of the video on which to
10549      perform the prediction.
10550    mimeType: The MIME type of the content of the video. Only the following
10551      are supported: video/mp4 video/avi video/quicktime
10552    timeSegmentEnd: The end, exclusive, of the video's time segment on which
10553      to perform the prediction. Expressed as a number of seconds as measured
10554      from the start of the video, with "s" appended at the end. Fractions are
10555      allowed, up to a microsecond precision, and "inf" or "Infinity" is
10556      allowed, which means the end of the video.
10557    timeSegmentStart: The beginning, inclusive, of the video's time segment on
10558      which to perform the prediction. Expressed as a number of seconds as
10559      measured from the start of the video, with "s" appended at the end.
10560      Fractions are allowed, up to a microsecond precision.
10561  """
10562
10563  content = _messages.StringField(1)
10564  mimeType = _messages.StringField(2)
10565  timeSegmentEnd = _messages.StringField(3)
10566  timeSegmentStart = _messages.StringField(4)
10567
10568
10569class GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoObjectTrackingPredictionInstance(_messages.Message):
10570  r"""Prediction input format for Video Object Tracking.
10571
10572  Fields:
10573    content: The Google Cloud Storage location of the video on which to
10574      perform the prediction.
10575    mimeType: The MIME type of the content of the video. Only the following
10576      are supported: video/mp4 video/avi video/quicktime
10577    timeSegmentEnd: The end, exclusive, of the video's time segment on which
10578      to perform the prediction. Expressed as a number of seconds as measured
10579      from the start of the video, with "s" appended at the end. Fractions are
10580      allowed, up to a microsecond precision, and "inf" or "Infinity" is
10581      allowed, which means the end of the video.
10582    timeSegmentStart: The beginning, inclusive, of the video's time segment on
10583      which to perform the prediction. Expressed as a number of seconds as
10584      measured from the start of the video, with "s" appended at the end.
10585      Fractions are allowed, up to a microsecond precision.
10586  """
10587
10588  content = _messages.StringField(1)
10589  mimeType = _messages.StringField(2)
10590  timeSegmentEnd = _messages.StringField(3)
10591  timeSegmentStart = _messages.StringField(4)
10592
10593
10594class GoogleCloudAiplatformV1beta1SchemaPredictParamsImageClassificationPredictionParams(_messages.Message):
10595  r"""Prediction model parameters for Image Classification.
10596
10597  Fields:
10598    confidenceThreshold: The Model only returns predictions with at least this
10599      confidence score. Default value is 0.0
10600    maxPredictions: The Model only returns up to that many top, by confidence
10601      score, predictions per instance. If this number is very high, the Model
10602      may return fewer predictions. Default value is 10.
10603  """
10604
10605  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10606  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
10607
10608
10609class GoogleCloudAiplatformV1beta1SchemaPredictParamsImageObjectDetectionPredictionParams(_messages.Message):
10610  r"""Prediction model parameters for Image Object Detection.
10611
10612  Fields:
10613    confidenceThreshold: The Model only returns predictions with at least this
10614      confidence score. Default value is 0.0
10615    maxPredictions: The Model only returns up to that many top, by confidence
10616      score, predictions per instance. Note that number of returned
10617      predictions is also limited by metadata's predictionsLimit. Default
10618      value is 10.
10619  """
10620
10621  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10622  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
10623
10624
10625class GoogleCloudAiplatformV1beta1SchemaPredictParamsImageSegmentationPredictionParams(_messages.Message):
10626  r"""Prediction model parameters for Image Segmentation.
10627
10628  Fields:
10629    confidenceThreshold: When the model predicts category of pixels of the
10630      image, it will only provide predictions for pixels that it is at least
10631      this much confident about. All other pixels will be classified as
10632      background. Default value is 0.5.
10633  """
10634
10635  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10636
10637
10638class GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoActionRecognitionPredictionParams(_messages.Message):
10639  r"""Prediction model parameters for Video Action Recognition.
10640
10641  Fields:
10642    confidenceThreshold: The Model only returns predictions with at least this
10643      confidence score. Default value is 0.0
10644    maxPredictions: The model only returns up to that many top, by confidence
10645      score, predictions per frame of the video. If this number is very high,
10646      the Model may return fewer predictions per frame. Default value is 50.
10647  """
10648
10649  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10650  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
10651
10652
10653class GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoClassificationPredictionParams(_messages.Message):
10654  r"""Prediction model parameters for Video Classification.
10655
10656  Fields:
10657    confidenceThreshold: The Model only returns predictions with at least this
10658      confidence score. Default value is 0.0
10659    maxPredictions: The Model only returns up to that many top, by confidence
10660      score, predictions per instance. If this number is very high, the Model
10661      may return fewer predictions. Default value is 10,000.
10662    oneSecIntervalClassification: Set to true to request classification for a
10663      video at one-second intervals. AI Platform returns labels and their
10664      confidence scores for each second of the entire time segment of the
10665      video that user specified in the input WARNING: Model evaluation is not
10666      done for this classification type, the quality of it depends on the
10667      training data, but there are no metrics provided to describe that
10668      quality. Default value is false
10669    segmentClassification: Set to true to request segment-level
10670      classification. AI Platform returns labels and their confidence scores
10671      for the entire time segment of the video that user specified in the
10672      input instance. Default value is true
10673    shotClassification: Set to true to request shot-level classification. AI
10674      Platform determines the boundaries for each camera shot in the entire
10675      time segment of the video that user specified in the input instance. AI
10676      Platform then returns labels and their confidence scores for each
10677      detected shot, along with the start and end time of the shot. WARNING:
10678      Model evaluation is not done for this classification type, the quality
10679      of it depends on the training data, but there are no metrics provided to
10680      describe that quality. Default value is false
10681  """
10682
10683  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10684  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
10685  oneSecIntervalClassification = _messages.BooleanField(3)
10686  segmentClassification = _messages.BooleanField(4)
10687  shotClassification = _messages.BooleanField(5)
10688
10689
10690class GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoObjectTrackingPredictionParams(_messages.Message):
10691  r"""Prediction model parameters for Video Object Tracking.
10692
10693  Fields:
10694    confidenceThreshold: The Model only returns predictions with at least this
10695      confidence score. Default value is 0.0
10696    maxPredictions: The model only returns up to that many top, by confidence
10697      score, predictions per frame of the video. If this number is very high,
10698      the Model may return fewer predictions per frame. Default value is 50.
10699    minBoundingBoxSize: Only bounding boxes with shortest edge at least that
10700      long as a relative value of video frame size are returned. Default value
10701      is 0.0.
10702  """
10703
10704  confidenceThreshold = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10705  maxPredictions = _messages.IntegerField(2, variant=_messages.Variant.INT32)
10706  minBoundingBoxSize = _messages.FloatField(3, variant=_messages.Variant.FLOAT)
10707
10708
10709class GoogleCloudAiplatformV1beta1SchemaPredictPredictionClassificationPredictionResult(_messages.Message):
10710  r"""Prediction output format for Image and Text Classification.
10711
10712  Fields:
10713    confidences: The Model's confidences in correctness of the predicted IDs,
10714      higher value means higher confidence. Order matches the Ids.
10715    displayNames: The display names of the AnnotationSpecs that had been
10716      identified, order matches the IDs.
10717    ids: The resource IDs of the AnnotationSpecs that had been identified,
10718      ordered by the confidence score descendingly.
10719  """
10720
10721  confidences = _messages.FloatField(1, repeated=True, variant=_messages.Variant.FLOAT)
10722  displayNames = _messages.StringField(2, repeated=True)
10723  ids = _messages.IntegerField(3, repeated=True)
10724
10725
10726class GoogleCloudAiplatformV1beta1SchemaPredictPredictionImageObjectDetectionPredictionResult(_messages.Message):
10727  r"""Prediction output format for Image Object Detection.
10728
10729  Messages:
10730    BboxesValueListEntry: Single entry in a BboxesValue.
10731
10732  Fields:
10733    bboxes: Bounding boxes, i.e. the rectangles over the image, that pinpoint
10734      the found AnnotationSpecs. Given in order that matches the IDs. Each
10735      bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and
10736      `yMax`, which represent the extremal coordinates of the box. They are
10737      relative to the image size, and the point 0,0 is in the top left of the
10738      image.
10739    confidences: The Model's confidences in correctness of the predicted IDs,
10740      higher value means higher confidence. Order matches the Ids.
10741    displayNames: The display names of the AnnotationSpecs that had been
10742      identified, order matches the IDs.
10743    ids: The resource IDs of the AnnotationSpecs that had been identified,
10744      ordered by the confidence score descendingly.
10745  """
10746
10747  class BboxesValueListEntry(_messages.Message):
10748    r"""Single entry in a BboxesValue.
10749
10750    Fields:
10751      entry: A extra_types.JsonValue attribute.
10752    """
10753
10754    entry = _messages.MessageField('extra_types.JsonValue', 1, repeated=True)
10755
10756  bboxes = _messages.MessageField('BboxesValueListEntry', 1, repeated=True)
10757  confidences = _messages.FloatField(2, repeated=True, variant=_messages.Variant.FLOAT)
10758  displayNames = _messages.StringField(3, repeated=True)
10759  ids = _messages.IntegerField(4, repeated=True)
10760
10761
10762class GoogleCloudAiplatformV1beta1SchemaPredictPredictionImageSegmentationPredictionResult(_messages.Message):
10763  r"""Prediction output format for Image Segmentation.
10764
10765  Fields:
10766    categoryMask: A PNG image where each pixel in the mask represents the
10767      category in which the pixel in the original image was predicted to
10768      belong to. The size of this image will be the same as the original
10769      image. The mapping between the AnntoationSpec and the color can be found
10770      in model's metadata. The model will choose the most likely category and
10771      if none of the categories reach the confidence threshold, the pixel will
10772      be marked as background.
10773    confidenceMask: A one channel image which is encoded as an 8bit lossless
10774      PNG. The size of the image will be the same as the original image. For a
10775      specific pixel, darker color means less confidence in correctness of the
10776      cateogry in the categoryMask for the corresponding pixel. Black means no
10777      confidence and white means complete confidence.
10778  """
10779
10780  categoryMask = _messages.StringField(1)
10781  confidenceMask = _messages.StringField(2)
10782
10783
10784class GoogleCloudAiplatformV1beta1SchemaPredictPredictionTabularClassificationPredictionResult(_messages.Message):
10785  r"""Prediction output format for Tabular Classification.
10786
10787  Fields:
10788    classes: The name of the classes being classified, contains all possible
10789      values of the target column.
10790    scores: The model's confidence in each class being correct, higher value
10791      means higher confidence. The N-th score corresponds to the N-th class in
10792      classes.
10793  """
10794
10795  classes = _messages.StringField(1, repeated=True)
10796  scores = _messages.FloatField(2, repeated=True, variant=_messages.Variant.FLOAT)
10797
10798
10799class GoogleCloudAiplatformV1beta1SchemaPredictPredictionTabularRegressionPredictionResult(_messages.Message):
10800  r"""Prediction output format for Tabular Regression.
10801
10802  Fields:
10803    lowerBound: The lower bound of the prediction interval.
10804    upperBound: The upper bound of the prediction interval.
10805    value: The regression value.
10806  """
10807
10808  lowerBound = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10809  upperBound = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
10810  value = _messages.FloatField(3, variant=_messages.Variant.FLOAT)
10811
10812
10813class GoogleCloudAiplatformV1beta1SchemaPredictPredictionTextExtractionPredictionResult(_messages.Message):
10814  r"""Prediction output format for Text Extraction.
10815
10816  Fields:
10817    confidences: The Model's confidences in correctness of the predicted IDs,
10818      higher value means higher confidence. Order matches the Ids.
10819    displayNames: The display names of the AnnotationSpecs that had been
10820      identified, order matches the IDs.
10821    ids: The resource IDs of the AnnotationSpecs that had been identified,
10822      ordered by the confidence score descendingly.
10823    textSegmentEndOffsets: The end offsets, inclusive, of the text segment in
10824      which the AnnotationSpec has been identified. Expressed as a zero-based
10825      number of characters as measured from the start of the text snippet.
10826    textSegmentStartOffsets: The start offsets, inclusive, of the text segment
10827      in which the AnnotationSpec has been identified. Expressed as a zero-
10828      based number of characters as measured from the start of the text
10829      snippet.
10830  """
10831
10832  confidences = _messages.FloatField(1, repeated=True, variant=_messages.Variant.FLOAT)
10833  displayNames = _messages.StringField(2, repeated=True)
10834  ids = _messages.IntegerField(3, repeated=True)
10835  textSegmentEndOffsets = _messages.IntegerField(4, repeated=True)
10836  textSegmentStartOffsets = _messages.IntegerField(5, repeated=True)
10837
10838
10839class GoogleCloudAiplatformV1beta1SchemaPredictPredictionTextSentimentPredictionResult(_messages.Message):
10840  r"""Prediction output format for Text Sentiment
10841
10842  Fields:
10843    sentiment: The integer sentiment labels between 0 (inclusive) and
10844      sentimentMax label (inclusive), while 0 maps to the least positive
10845      sentiment and sentimentMax maps to the most positive one. The higher the
10846      score is, the more positive the sentiment in the text snippet is. Note:
10847      sentimentMax is an integer value between 1 (inclusive) and 10
10848      (inclusive).
10849  """
10850
10851  sentiment = _messages.IntegerField(1, variant=_messages.Variant.INT32)
10852
10853
10854class GoogleCloudAiplatformV1beta1SchemaPredictPredictionTimeSeriesForecastingPredictionResult(_messages.Message):
10855  r"""Prediction output format for Time Series Forecasting.
10856
10857  Fields:
10858    value: The regression value.
10859  """
10860
10861  value = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10862
10863
10864class GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoActionRecognitionPredictionResult(_messages.Message):
10865  r"""Prediction output format for Video Action Recognition.
10866
10867  Fields:
10868    confidence: The Model's confidence in correction of this prediction,
10869      higher value means higher confidence.
10870    displayName: The display name of the AnnotationSpec that had been
10871      identified.
10872    id: The resource ID of the AnnotationSpec that had been identified.
10873    timeSegmentEnd: The end, exclusive, of the video's time segment in which
10874      the AnnotationSpec has been identified. Expressed as a number of seconds
10875      as measured from the start of the video, with fractions up to a
10876      microsecond precision, and with "s" appended at the end.
10877    timeSegmentStart: The beginning, inclusive, of the video's time segment in
10878      which the AnnotationSpec has been identified. Expressed as a number of
10879      seconds as measured from the start of the video, with fractions up to a
10880      microsecond precision, and with "s" appended at the end.
10881  """
10882
10883  confidence = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10884  displayName = _messages.StringField(2)
10885  id = _messages.StringField(3)
10886  timeSegmentEnd = _messages.StringField(4)
10887  timeSegmentStart = _messages.StringField(5)
10888
10889
10890class GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoClassificationPredictionResult(_messages.Message):
10891  r"""Prediction output format for Video Classification.
10892
10893  Fields:
10894    confidence: The Model's confidence in correction of this prediction,
10895      higher value means higher confidence.
10896    displayName: The display name of the AnnotationSpec that had been
10897      identified.
10898    id: The resource ID of the AnnotationSpec that had been identified.
10899    timeSegmentEnd: The end, exclusive, of the video's time segment in which
10900      the AnnotationSpec has been identified. Expressed as a number of seconds
10901      as measured from the start of the video, with fractions up to a
10902      microsecond precision, and with "s" appended at the end. Note that for
10903      'segment-classification' prediction type, this equals the original
10904      'timeSegmentEnd' from the input instance, for other types it is the end
10905      of a shot or a 1 second interval respectively.
10906    timeSegmentStart: The beginning, inclusive, of the video's time segment in
10907      which the AnnotationSpec has been identified. Expressed as a number of
10908      seconds as measured from the start of the video, with fractions up to a
10909      microsecond precision, and with "s" appended at the end. Note that for
10910      'segment-classification' prediction type, this equals the original
10911      'timeSegmentStart' from the input instance, for other types it is the
10912      start of a shot or a 1 second interval respectively.
10913    type: The type of the prediction. The requested types can be configured
10914      via parameters. This will be one of - segment-classification - shot-
10915      classification - one-sec-interval-classification
10916  """
10917
10918  confidence = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10919  displayName = _messages.StringField(2)
10920  id = _messages.StringField(3)
10921  timeSegmentEnd = _messages.StringField(4)
10922  timeSegmentStart = _messages.StringField(5)
10923  type = _messages.StringField(6)
10924
10925
10926class GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoObjectTrackingPredictionResult(_messages.Message):
10927  r"""Prediction output format for Video Object Tracking.
10928
10929  Fields:
10930    confidence: The Model's confidence in correction of this prediction,
10931      higher value means higher confidence.
10932    displayName: The display name of the AnnotationSpec that had been
10933      identified.
10934    frames: All of the frames of the video in which a single object instance
10935      has been detected. The bounding boxes in the frames identify the same
10936      object.
10937    id: The resource ID of the AnnotationSpec that had been identified.
10938    timeSegmentEnd: The end, inclusive, of the video's time segment in which
10939      the object instance has been detected. Expressed as a number of seconds
10940      as measured from the start of the video, with fractions up to a
10941      microsecond precision, and with "s" appended at the end.
10942    timeSegmentStart: The beginning, inclusive, of the video's time segment in
10943      which the object instance has been detected. Expressed as a number of
10944      seconds as measured from the start of the video, with fractions up to a
10945      microsecond precision, and with "s" appended at the end.
10946  """
10947
10948  confidence = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
10949  displayName = _messages.StringField(2)
10950  frames = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame', 3, repeated=True)
10951  id = _messages.StringField(4)
10952  timeSegmentEnd = _messages.StringField(5)
10953  timeSegmentStart = _messages.StringField(6)
10954
10955
10956class GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame(_messages.Message):
10957  r"""The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box,
10958  i.e. the rectangle over the video frame pinpointing the found
10959  AnnotationSpec. The coordinates are relative to the frame size, and the
10960  point 0,0 is in the top left of the frame.
10961
10962  Fields:
10963    timeOffset: A time (frame) of a video in which the object has been
10964      detected. Expressed as a number of seconds as measured from the start of
10965      the video, with fractions up to a microsecond precision, and with "s"
10966      appended at the end.
10967    xMax: The rightmost coordinate of the bounding box.
10968    xMin: The leftmost coordinate of the bounding box.
10969    yMax: The bottommost coordinate of the bounding box.
10970    yMin: The topmost coordinate of the bounding box.
10971  """
10972
10973  timeOffset = _messages.StringField(1)
10974  xMax = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
10975  xMin = _messages.FloatField(3, variant=_messages.Variant.FLOAT)
10976  yMax = _messages.FloatField(4, variant=_messages.Variant.FLOAT)
10977  yMin = _messages.FloatField(5, variant=_messages.Variant.FLOAT)
10978
10979
10980class GoogleCloudAiplatformV1beta1SchemaPredictionResult(_messages.Message):
10981  r"""Represents a line of JSONL in the batch prediction output file.
10982
10983  Messages:
10984    InstanceValue: User's input instance. Struct is used here instead of Any
10985      so that JsonFormat does not append an extra "@type" field when we
10986      convert the proto to JSON.
10987
10988  Fields:
10989    error: The error result. Do not set prediction if this is set.
10990    instance: User's input instance. Struct is used here instead of Any so
10991      that JsonFormat does not append an extra "@type" field when we convert
10992      the proto to JSON.
10993    key: Optional user-provided key from the input instance.
10994    prediction: The prediction result. Value is used here instead of Any so
10995      that JsonFormat does not append an extra "@type" field when we convert
10996      the proto to JSON and so we can represent array of objects. Do not set
10997      error if this is set.
10998  """
10999
11000  @encoding.MapUnrecognizedFields('additionalProperties')
11001  class InstanceValue(_messages.Message):
11002    r"""User's input instance. Struct is used here instead of Any so that
11003    JsonFormat does not append an extra "@type" field when we convert the
11004    proto to JSON.
11005
11006    Messages:
11007      AdditionalProperty: An additional property for a InstanceValue object.
11008
11009    Fields:
11010      additionalProperties: Properties of the object.
11011    """
11012
11013    class AdditionalProperty(_messages.Message):
11014      r"""An additional property for a InstanceValue object.
11015
11016      Fields:
11017        key: Name of the additional property.
11018        value: A extra_types.JsonValue attribute.
11019      """
11020
11021      key = _messages.StringField(1)
11022      value = _messages.MessageField('extra_types.JsonValue', 2)
11023
11024    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
11025
11026  error = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaPredictionResultError', 1)
11027  instance = _messages.MessageField('InstanceValue', 2)
11028  key = _messages.StringField(3)
11029  prediction = _messages.MessageField('extra_types.JsonValue', 4)
11030
11031
11032class GoogleCloudAiplatformV1beta1SchemaPredictionResultError(_messages.Message):
11033  r"""A GoogleCloudAiplatformV1beta1SchemaPredictionResultError object.
11034
11035  Enums:
11036    StatusValueValuesEnum: Error status. This will be serialized into the enum
11037      name e.g. "NOT_FOUND".
11038
11039  Fields:
11040    message: Error message with additional details.
11041    status: Error status. This will be serialized into the enum name e.g.
11042      "NOT_FOUND".
11043  """
11044
11045  class StatusValueValuesEnum(_messages.Enum):
11046    r"""Error status. This will be serialized into the enum name e.g.
11047    "NOT_FOUND".
11048
11049    Values:
11050      OK: Not an error; returned on success HTTP Mapping: 200 OK
11051      CANCELLED: The operation was cancelled, typically by the caller. HTTP
11052        Mapping: 499 Client Closed Request
11053      UNKNOWN: Unknown error. For example, this error may be returned when a
11054        `Status` value received from another address space belongs to an error
11055        space that is not known in this address space. Also errors raised by
11056        APIs that do not return enough error information may be converted to
11057        this error. HTTP Mapping: 500 Internal Server Error
11058      INVALID_ARGUMENT: The client specified an invalid argument. Note that
11059        this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates
11060        arguments that are problematic regardless of the state of the system
11061        (e.g., a malformed file name). HTTP Mapping: 400 Bad Request
11062      DEADLINE_EXCEEDED: The deadline expired before the operation could
11063        complete. For operations that change the state of the system, this
11064        error may be returned even if the operation has completed
11065        successfully. For example, a successful response from a server could
11066        have been delayed long enough for the deadline to expire. HTTP
11067        Mapping: 504 Gateway Timeout
11068      NOT_FOUND: Some requested entity (e.g., file or directory) was not
11069        found. Note to server developers: if a request is denied for an entire
11070        class of users, such as gradual feature rollout or undocumented
11071        allowlist, `NOT_FOUND` may be used. If a request is denied for some
11072        users within a class of users, such as user-based access control,
11073        `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found
11074      ALREADY_EXISTS: The entity that a client attempted to create (e.g., file
11075        or directory) already exists. HTTP Mapping: 409 Conflict
11076      PERMISSION_DENIED: The caller does not have permission to execute the
11077        specified operation. `PERMISSION_DENIED` must not be used for
11078        rejections caused by exhausting some resource (use
11079        `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED`
11080        must not be used if the caller can not be identified (use
11081        `UNAUTHENTICATED` instead for those errors). This error code does not
11082        imply the request is valid or the requested entity exists or satisfies
11083        other pre-conditions. HTTP Mapping: 403 Forbidden
11084      UNAUTHENTICATED: The request does not have valid authentication
11085        credentials for the operation. HTTP Mapping: 401 Unauthorized
11086      RESOURCE_EXHAUSTED: Some resource has been exhausted, perhaps a per-user
11087        quota, or perhaps the entire file system is out of space. HTTP
11088        Mapping: 429 Too Many Requests
11089      FAILED_PRECONDITION: The operation was rejected because the system is
11090        not in a state required for the operation's execution. For example,
11091        the directory to be deleted is non-empty, an rmdir operation is
11092        applied to a non-directory, etc. Service implementors can use the
11093        following guidelines to decide between `FAILED_PRECONDITION`,
11094        `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can
11095        retry just the failing call. (b) Use `ABORTED` if the client should
11096        retry at a higher level (e.g., when a client-specified test-and-set
11097        fails, indicating the client should restart a read-modify-write
11098        sequence). (c) Use `FAILED_PRECONDITION` if the client should not
11099        retry until the system state has been explicitly fixed. E.g., if an
11100        "rmdir" fails because the directory is non-empty,
11101        `FAILED_PRECONDITION` should be returned since the client should not
11102        retry unless the files are deleted from the directory. HTTP Mapping:
11103        400 Bad Request
11104      ABORTED: The operation was aborted, typically due to a concurrency issue
11105        such as a sequencer check failure or transaction abort. See the
11106        guidelines above for deciding between `FAILED_PRECONDITION`,
11107        `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict
11108      OUT_OF_RANGE: The operation was attempted past the valid range. E.g.,
11109        seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this
11110        error indicates a problem that may be fixed if the system state
11111        changes. For example, a 32-bit file system will generate
11112        `INVALID_ARGUMENT` if asked to read at an offset that is not in the
11113        range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read
11114        from an offset past the current file size. There is a fair bit of
11115        overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend
11116        using `OUT_OF_RANGE` (the more specific error) when it applies so that
11117        callers who are iterating through a space can easily look for an
11118        `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400
11119        Bad Request
11120      UNIMPLEMENTED: The operation is not implemented or is not
11121        supported/enabled in this service. HTTP Mapping: 501 Not Implemented
11122      INTERNAL: Internal errors. This means that some invariants expected by
11123        the underlying system have been broken. This error code is reserved
11124        for serious errors. HTTP Mapping: 500 Internal Server Error
11125      UNAVAILABLE: The service is currently unavailable. This is most likely a
11126        transient condition, which can be corrected by retrying with a
11127        backoff. Note that it is not always safe to retry non-idempotent
11128        operations. See the guidelines above for deciding between
11129        `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503
11130        Service Unavailable
11131      DATA_LOSS: Unrecoverable data loss or corruption. HTTP Mapping: 500
11132        Internal Server Error
11133    """
11134    OK = 0
11135    CANCELLED = 1
11136    UNKNOWN = 2
11137    INVALID_ARGUMENT = 3
11138    DEADLINE_EXCEEDED = 4
11139    NOT_FOUND = 5
11140    ALREADY_EXISTS = 6
11141    PERMISSION_DENIED = 7
11142    UNAUTHENTICATED = 8
11143    RESOURCE_EXHAUSTED = 9
11144    FAILED_PRECONDITION = 10
11145    ABORTED = 11
11146    OUT_OF_RANGE = 12
11147    UNIMPLEMENTED = 13
11148    INTERNAL = 14
11149    UNAVAILABLE = 15
11150    DATA_LOSS = 16
11151
11152  message = _messages.StringField(1)
11153  status = _messages.EnumField('StatusValueValuesEnum', 2)
11154
11155
11156class GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadata(_messages.Message):
11157  r"""The metadata of Datasets that contain tables data.
11158
11159  Fields:
11160    inputConfig: A
11161      GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataInputConfig
11162      attribute.
11163  """
11164
11165  inputConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataInputConfig', 1)
11166
11167
11168class GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataBigQuerySource(_messages.Message):
11169  r"""A GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataBigQuerySource
11170  object.
11171
11172  Fields:
11173    uri: The URI of a BigQuery table. e.g.
11174      bq://projectId.bqDatasetId.bqTableId
11175  """
11176
11177  uri = _messages.StringField(1)
11178
11179
11180class GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataGcsSource(_messages.Message):
11181  r"""A GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataGcsSource
11182  object.
11183
11184  Fields:
11185    uri: Cloud Storage URI of one or more files. Only CSV files are supported.
11186      The first line of the CSV file is used as the header. If there are
11187      multiple files, the header is the first line of the lexicographically
11188      first file, the other files must either contain the exact same header or
11189      omit the header.
11190  """
11191
11192  uri = _messages.StringField(1, repeated=True)
11193
11194
11195class GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataInputConfig(_messages.Message):
11196  r"""The tables Dataset's data source. The Dataset doesn't store the data
11197  directly, but only pointer(s) to its data.
11198
11199  Fields:
11200    bigquerySource: A
11201      GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataBigQuerySource
11202      attribute.
11203    gcsSource: A
11204      GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataGcsSource
11205      attribute.
11206  """
11207
11208  bigquerySource = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataBigQuerySource', 1)
11209  gcsSource = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataGcsSource', 2)
11210
11211
11212class GoogleCloudAiplatformV1beta1SchemaTextClassificationAnnotation(_messages.Message):
11213  r"""Annotation details specific to text classification.
11214
11215  Fields:
11216    annotationSpecId: The resource Id of the AnnotationSpec that this
11217      Annotation pertains to.
11218    displayName: The display name of the AnnotationSpec that this Annotation
11219      pertains to.
11220  """
11221
11222  annotationSpecId = _messages.StringField(1)
11223  displayName = _messages.StringField(2)
11224
11225
11226class GoogleCloudAiplatformV1beta1SchemaTextDataItem(_messages.Message):
11227  r"""Payload of Text DataItem.
11228
11229  Fields:
11230    gcsUri: Output only. Google Cloud Storage URI points to the original text
11231      in user's bucket. The text file is up to 10MB in size.
11232  """
11233
11234  gcsUri = _messages.StringField(1)
11235
11236
11237class GoogleCloudAiplatformV1beta1SchemaTextDatasetMetadata(_messages.Message):
11238  r"""The metadata of Datasets that contain Text DataItems.
11239
11240  Fields:
11241    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
11242      describing payload of the Text DataItems that belong to this Dataset.
11243    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
11244      this Dataset.
11245  """
11246
11247  dataItemSchemaUri = _messages.StringField(1)
11248  gcsBucket = _messages.StringField(2)
11249
11250
11251class GoogleCloudAiplatformV1beta1SchemaTextExtractionAnnotation(_messages.Message):
11252  r"""Annotation details specific to text extraction.
11253
11254  Fields:
11255    annotationSpecId: The resource Id of the AnnotationSpec that this
11256      Annotation pertains to.
11257    displayName: The display name of the AnnotationSpec that this Annotation
11258      pertains to.
11259    textSegment: The segment of the text content.
11260  """
11261
11262  annotationSpecId = _messages.StringField(1)
11263  displayName = _messages.StringField(2)
11264  textSegment = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTextSegment', 3)
11265
11266
11267class GoogleCloudAiplatformV1beta1SchemaTextSegment(_messages.Message):
11268  r"""The text segment inside of DataItem.
11269
11270  Fields:
11271    content: The text content in the segment for output only.
11272    endOffset: Zero-based character index of the first character past the end
11273      of the text segment (counting character from the beginning of the text).
11274      The character at the end_offset is NOT included in the text segment.
11275    startOffset: Zero-based character index of the first character of the text
11276      segment (counting characters from the beginning of the text).
11277  """
11278
11279  content = _messages.StringField(1)
11280  endOffset = _messages.IntegerField(2, variant=_messages.Variant.UINT64)
11281  startOffset = _messages.IntegerField(3, variant=_messages.Variant.UINT64)
11282
11283
11284class GoogleCloudAiplatformV1beta1SchemaTextSentimentAnnotation(_messages.Message):
11285  r"""Annotation details specific to text sentiment.
11286
11287  Fields:
11288    annotationSpecId: The resource Id of the AnnotationSpec that this
11289      Annotation pertains to.
11290    displayName: The display name of the AnnotationSpec that this Annotation
11291      pertains to.
11292    sentiment: The sentiment score for text.
11293    sentimentMax: The sentiment max score for text.
11294  """
11295
11296  annotationSpecId = _messages.StringField(1)
11297  displayName = _messages.StringField(2)
11298  sentiment = _messages.IntegerField(3, variant=_messages.Variant.INT32)
11299  sentimentMax = _messages.IntegerField(4, variant=_messages.Variant.INT32)
11300
11301
11302class GoogleCloudAiplatformV1beta1SchemaTextSentimentSavedQueryMetadata(_messages.Message):
11303  r"""The metadata of SavedQuery contains TextSentiment Annotations.
11304
11305  Fields:
11306    sentimentMax: The maximum sentiment of sentiment Anntoation in this
11307      SavedQuery.
11308  """
11309
11310  sentimentMax = _messages.IntegerField(1, variant=_messages.Variant.INT32)
11311
11312
11313class GoogleCloudAiplatformV1beta1SchemaTimeSegment(_messages.Message):
11314  r"""A time period inside of a DataItem that has a time dimension (e.g.
11315  video).
11316
11317  Fields:
11318    endTimeOffset: End of the time segment (exclusive), represented as the
11319      duration since the start of the DataItem.
11320    startTimeOffset: Start of the time segment (inclusive), represented as the
11321      duration since the start of the DataItem.
11322  """
11323
11324  endTimeOffset = _messages.StringField(1)
11325  startTimeOffset = _messages.StringField(2)
11326
11327
11328class GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadata(_messages.Message):
11329  r"""The metadata of Datasets that contain time series data.
11330
11331  Fields:
11332    inputConfig: A
11333      GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataInputConfig
11334      attribute.
11335    timeColumn: The column name of the time column that identifies time order
11336      in the time series.
11337    timeSeriesIdentifierColumn: The column name of the time series identifier
11338      column that identifies the time series.
11339  """
11340
11341  inputConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataInputConfig', 1)
11342  timeColumn = _messages.StringField(2)
11343  timeSeriesIdentifierColumn = _messages.StringField(3)
11344
11345
11346class GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataBigQuerySource(_messages.Message):
11347  r"""A
11348  GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataBigQuerySource
11349  object.
11350
11351  Fields:
11352    uri: The URI of a BigQuery table.
11353  """
11354
11355  uri = _messages.StringField(1)
11356
11357
11358class GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataGcsSource(_messages.Message):
11359  r"""A GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataGcsSource
11360  object.
11361
11362  Fields:
11363    uri: Cloud Storage URI of one or more files. Only CSV files are supported.
11364      The first line of the CSV file is used as the header. If there are
11365      multiple files, the header is the first line of the lexicographically
11366      first file, the other files must either contain the exact same header or
11367      omit the header.
11368  """
11369
11370  uri = _messages.StringField(1, repeated=True)
11371
11372
11373class GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataInputConfig(_messages.Message):
11374  r"""The time series Dataset's data source. The Dataset doesn't store the
11375  data directly, but only pointer(s) to its data.
11376
11377  Fields:
11378    bigquerySource: A
11379      GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataBigQuerySourc
11380      e attribute.
11381    gcsSource: A
11382      GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataGcsSource
11383      attribute.
11384  """
11385
11386  bigquerySource = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataBigQuerySource', 1)
11387  gcsSource = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataGcsSource', 2)
11388
11389
11390class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecasting(_messages.Message):
11391  r"""A TrainingJob that trains and uploads an AutoML Forecasting Model.
11392
11393  Fields:
11394    inputs: The input parameters of this TrainingJob.
11395    metadata: The metadata information.
11396  """
11397
11398  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputs', 1)
11399  metadata = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingMetadata', 2)
11400
11401
11402class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputs(_messages.Message):
11403  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecasti
11404  ngInputs object.
11405
11406  Fields:
11407    exportEvaluatedDataItemsConfig: Configuration for exporting test set
11408      predictions to a BigQuery table. If this configuration is absent, then
11409      the export is not performed.
11410    forecastWindowEnd: The number of periods offset into the future as the end
11411      of the forecast window (the window of future values to predict, relative
11412      to the present.), where each period is one unit of granularity as
11413      defined by the `period` field above. Inclusive.
11414    forecastWindowStart: The number of periods offset into the future as the
11415      start of the forecast window (the window of future values to predict,
11416      relative to the present.), where each period is one unit of granularity
11417      as defined by the `period` field above. Default to 0. Inclusive.
11418    optimizationObjective: Objective function the model is optimizing towards.
11419      The training process creates a model that optimizes the value of the
11420      objective function over the validation set. The supported optimization
11421      objectives: "minimize-rmse" (default) - Minimize root-mean-squared error
11422      (RMSE). "minimize-mae" - Minimize mean-absolute error (MAE). "minimize-
11423      rmsle" - Minimize root-mean-squared log error (RMSLE). "minimize-rmspe"
11424      - Minimize root-mean-squared percentage error (RMSPE). "minimize-wape-
11425      mae" - Minimize the combination of weighted absolute percentage error
11426      (WAPE) and mean-absolute-error (MAE). "minimize-quantile-loss" -
11427      Minimize the quantile loss at the quantiles defined in `quantiles`.
11428    pastHorizon: The number of periods offset into the past to restrict past
11429      sequence, where each period is one unit of granularity as defined by the
11430      `period`. Default value 0 means that it lets algorithm to define the
11431      value. Inclusive.
11432    period: Expected difference in time granularity between rows in the data.
11433      If it is not set, the period is inferred from data.
11434    quantiles: Quantiles to use for minimize-quantile-loss
11435      `optimization_objective`. Up to 5 quantiles are allowed of values
11436      between 0 and 1, exclusive. Required if the value of
11437      optimization_objective is minimize-quantile-loss. Represents the percent
11438      quantiles to use for that objective. Quantiles must be unique.
11439    staticColumns: Column names that should be used as static columns. The
11440      value of these columns are static per time series.
11441    targetColumn: The name of the column that the model is to predict.
11442    timeColumn: The name of the column that identifies time order in the time
11443      series.
11444    timeSeriesIdentifierColumn: The name of the column that identifies the
11445      time series.
11446    timeVariantPastAndFutureColumns: Column names that should be used as time
11447      variant past and future columns. This column contains information for
11448      the given entity (identified by the key column) that is known for the
11449      past and the future
11450    timeVariantPastOnlyColumns: Column names that should be used as time
11451      variant past only columns. This column contains information for the
11452      given entity (identified by the time_series_identifier_column) that is
11453      known for the past but not the future (e.g. population of a city in a
11454      given year, or weather on a given day).
11455    trainBudgetMilliNodeHours: Required. The train budget of creating this
11456      model, expressed in milli node hours i.e. 1,000 value in this field
11457      means 1 node hour. The training cost of the model will not exceed this
11458      budget. The final cost will be attempted to be close to the budget,
11459      though may end up being (even) noticeably smaller - at the backend's
11460      discretion. This especially may happen when further model training
11461      ceases to provide any improvements. If the budget is set to a value
11462      known to be insufficient to train a model for the given dataset, the
11463      training won't be attempted and will error. The train budget must be
11464      between 1,000 and 72,000 milli node hours, inclusive.
11465    transformations: Each transformation will apply transform function to
11466      given input column. And the result will be used for training. When
11467      creating transformation for BigQuery Struct column, the column should be
11468      flattened using "." as the delimiter.
11469    validationOptions: Validation options for the data validation component.
11470      The available options are: "fail-pipeline" - default, will validate
11471      against the validation and fail the pipeline if it fails. "ignore-
11472      validation" - ignore the results of the validation and continue
11473    weightColumn: Column name that should be used as the weight column. Higher
11474      values in this column give more importance to the row during model
11475      training. The column must have numeric values between 0 and 10000
11476      inclusively; 0 means the row is ignored for training. If weight column
11477      field is not set, then all rows are assumed to have equal weight of 1.
11478  """
11479
11480  exportEvaluatedDataItemsConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig', 1)
11481  forecastWindowEnd = _messages.IntegerField(2)
11482  forecastWindowStart = _messages.IntegerField(3)
11483  optimizationObjective = _messages.StringField(4)
11484  pastHorizon = _messages.IntegerField(5)
11485  period = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsPeriod', 6)
11486  quantiles = _messages.FloatField(7, repeated=True)
11487  staticColumns = _messages.StringField(8, repeated=True)
11488  targetColumn = _messages.StringField(9)
11489  timeColumn = _messages.StringField(10)
11490  timeSeriesIdentifierColumn = _messages.StringField(11)
11491  timeVariantPastAndFutureColumns = _messages.StringField(12, repeated=True)
11492  timeVariantPastOnlyColumns = _messages.StringField(13, repeated=True)
11493  trainBudgetMilliNodeHours = _messages.IntegerField(14)
11494  transformations = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation', 15, repeated=True)
11495  validationOptions = _messages.StringField(16)
11496  weightColumn = _messages.StringField(17)
11497
11498
11499class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsPeriod(_messages.Message):
11500  r"""A duration of time expressed in time granularity units.
11501
11502  Fields:
11503    quantity: The number of units per period, e.g. 3 weeks or 2 months.
11504    unit: The time granularity unit of this time period. The supported unit
11505      are: "minute" "hour" "day" "week" "month" "year"
11506  """
11507
11508  quantity = _messages.IntegerField(1)
11509  unit = _messages.StringField(2)
11510
11511
11512class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation(_messages.Message):
11513  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecasti
11514  ngInputsTransformation object.
11515
11516  Fields:
11517    auto: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForec
11518      astingInputsTransformationAutoTransformation attribute.
11519    categorical: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAuto
11520      MlForecastingInputsTransformationCategoricalTransformation attribute.
11521    numeric: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlFo
11522      recastingInputsTransformationNumericTransformation attribute.
11523    repeatedCategorical: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefini
11524      tionAutoMlForecastingInputsTransformationCategoricalArrayTransformation
11525      attribute.
11526    repeatedNumeric: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinition
11527      AutoMlForecastingInputsTransformationNumericArrayTransformation
11528      attribute.
11529    repeatedText: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAut
11530      oMlForecastingInputsTransformationTextArrayTransformation attribute.
11531    text: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForec
11532      astingInputsTransformationTextTransformation attribute.
11533    timestamp: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMl
11534      ForecastingInputsTransformationTimestampTransformation attribute.
11535  """
11536
11537  auto = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation', 1)
11538  categorical = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation', 2)
11539  numeric = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation', 3)
11540  repeatedCategorical = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalArrayTransformation', 4)
11541  repeatedNumeric = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericArrayTransformation', 5)
11542  repeatedText = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextArrayTransformation', 6)
11543  text = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation', 7)
11544  timestamp = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation', 8)
11545
11546
11547class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation(_messages.Message):
11548  r"""Training pipeline will infer the proper transformation based on the
11549  statistic of dataset.
11550
11551  Fields:
11552    columnName: A string attribute.
11553  """
11554
11555  columnName = _messages.StringField(1)
11556
11557
11558class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalArrayTransformation(_messages.Message):
11559  r"""Treats the column as categorical array and performs following
11560  transformation functions. * For each element in the array, convert the
11561  category name to a dictionary lookup index and generate an embedding for
11562  each index. Combine the embedding of all elements into a single embedding
11563  using the mean. * Empty arrays treated as an embedding of zeroes.
11564
11565  Fields:
11566    columnName: A string attribute.
11567  """
11568
11569  columnName = _messages.StringField(1)
11570
11571
11572class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation(_messages.Message):
11573  r"""Training pipeline will perform following transformation functions. * The
11574  categorical string as is--no change to case, punctuation, spelling, tense,
11575  and so on. * Convert the category name to a dictionary lookup index and
11576  generate an embedding for each index. * Categories that appear less than 5
11577  times in the training dataset are treated as the "unknown" category. The
11578  "unknown" category gets its own special lookup index and resulting
11579  embedding.
11580
11581  Fields:
11582    columnName: A string attribute.
11583  """
11584
11585  columnName = _messages.StringField(1)
11586
11587
11588class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericArrayTransformation(_messages.Message):
11589  r"""Treats the column as numerical array and performs following
11590  transformation functions. * All transformations for Numerical types applied
11591  to the average of the all elements. * The average of empty arrays is treated
11592  as zero.
11593
11594  Fields:
11595    columnName: A string attribute.
11596    invalidValuesAllowed: If invalid values is allowed, the training pipeline
11597      will create a boolean feature that indicated whether the value is valid.
11598      Otherwise, the training pipeline will discard the input row from
11599      trainining data.
11600  """
11601
11602  columnName = _messages.StringField(1)
11603  invalidValuesAllowed = _messages.BooleanField(2)
11604
11605
11606class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation(_messages.Message):
11607  r"""Training pipeline will perform following transformation functions. * The
11608  value converted to float32. * The z_score of the value. * log(value+1) when
11609  the value is greater than or equal to 0. Otherwise, this transformation is
11610  not applied and the value is considered a missing value. * z_score of
11611  log(value+1) when the value is greater than or equal to 0. Otherwise, this
11612  transformation is not applied and the value is considered a missing value. *
11613  A boolean value that indicates whether the value is valid.
11614
11615  Fields:
11616    columnName: A string attribute.
11617    invalidValuesAllowed: If invalid values is allowed, the training pipeline
11618      will create a boolean feature that indicated whether the value is valid.
11619      Otherwise, the training pipeline will discard the input row from
11620      trainining data.
11621  """
11622
11623  columnName = _messages.StringField(1)
11624  invalidValuesAllowed = _messages.BooleanField(2)
11625
11626
11627class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextArrayTransformation(_messages.Message):
11628  r"""Treats the column as text array and performs following transformation
11629  functions. * Concatenate all text values in the array into a single text
11630  value using a space (" ") as a delimiter, and then treat the result as a
11631  single text value. Apply the transformations for Text columns. * Empty
11632  arrays treated as an empty text.
11633
11634  Fields:
11635    columnName: A string attribute.
11636  """
11637
11638  columnName = _messages.StringField(1)
11639
11640
11641class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation(_messages.Message):
11642  r"""Training pipeline will perform following transformation functions. * The
11643  text as is--no change to case, punctuation, spelling, tense, and so on. *
11644  Tokenize text to words. Convert each words to a dictionary lookup index and
11645  generate an embedding for each index. Combine the embedding of all elements
11646  into a single embedding using the mean. * Tokenization is based on unicode
11647  script boundaries. * Missing values get their own lookup index and resulting
11648  embedding. * Stop-words receive no special treatment and are not removed.
11649
11650  Fields:
11651    columnName: A string attribute.
11652  """
11653
11654  columnName = _messages.StringField(1)
11655
11656
11657class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation(_messages.Message):
11658  r"""Training pipeline will perform following transformation functions. *
11659  Apply the transformation functions for Numerical columns. * Determine the
11660  year, month, day,and weekday. Treat each value from the * timestamp as a
11661  Categorical column. * Invalid numerical values (for example, values that
11662  fall outside of a typical timestamp range, or are extreme values) receive no
11663  special treatment and are not removed.
11664
11665  Fields:
11666    columnName: A string attribute.
11667    invalidValuesAllowed: If invalid values is allowed, the training pipeline
11668      will create a boolean feature that indicated whether the value is valid.
11669      Otherwise, the training pipeline will discard the input row from
11670      trainining data.
11671    timeFormat: The format in which that time field is expressed. The
11672      time_format must either be one of: * `unix-seconds` * `unix-
11673      milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for
11674      respectively number of seconds, milliseconds, microseconds and
11675      nanoseconds since start of the Unix epoch); or be written in `strftime`
11676      syntax. If time_format is not set, then the default format is RFC 3339
11677      `date-time` format, where `time-offset` = `"Z"` (e.g.
11678      1985-04-12T23:20:50.52Z)
11679  """
11680
11681  columnName = _messages.StringField(1)
11682  invalidValuesAllowed = _messages.BooleanField(2)
11683  timeFormat = _messages.StringField(3)
11684
11685
11686class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingMetadata(_messages.Message):
11687  r"""Model metadata specific to AutoML Forecasting.
11688
11689  Fields:
11690    trainCostMilliNodeHours: Output only. The actual training cost of the
11691      model, expressed in milli node hours, i.e. 1,000 value in this field
11692      means 1 node hour. Guaranteed to not exceed the train budget.
11693  """
11694
11695  trainCostMilliNodeHours = _messages.IntegerField(1)
11696
11697
11698class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassification(_messages.Message):
11699  r"""A TrainingJob that trains and uploads an AutoML Image Classification
11700  Model.
11701
11702  Fields:
11703    inputs: The input parameters of this TrainingJob.
11704    metadata: The metadata information.
11705  """
11706
11707  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs', 1)
11708  metadata = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata', 2)
11709
11710
11711class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs(_messages.Message):
11712  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClas
11713  sificationInputs object.
11714
11715  Enums:
11716    ModelTypeValueValuesEnum:
11717
11718  Fields:
11719    baseModelId: The ID of the `base` model. If it is specified, the new model
11720      will be trained based on the `base` model. Otherwise, the new model will
11721      be trained from scratch. The `base` model must be in the same Project
11722      and Location as the new Model to train, and have the same modelType.
11723    budgetMilliNodeHours: The training budget of creating this model,
11724      expressed in milli node hours i.e. 1,000 value in this field means 1
11725      node hour. The actual metadata.costMilliNodeHours will be equal or less
11726      than this value. If further model training ceases to provide any
11727      improvements, it will stop without using the full budget and the
11728      metadata.successfulStopReason will be `model-converged`. Note, node_hour
11729      = actual_hour * number_of_nodes_involved. For modelType
11730      `cloud`(default), the budget must be between 8,000 and 800,000 milli
11731      node hours, inclusive. The default value is 192,000 which represents one
11732      day in wall time, considering 8 nodes are used. For model types `mobile-
11733      tf-low-latency-1`, `mobile-tf-versatile-1`, `mobile-tf-high-accuracy-1`,
11734      the training budget must be between 1,000 and 100,000 milli node hours,
11735      inclusive. The default value is 24,000 which represents one day in wall
11736      time on a single node that is used.
11737    disableEarlyStopping: Use the entire training budget. This disables the
11738      early stopping feature. When false the early stopping feature is
11739      enabled, which means that AutoML Image Classification might stop
11740      training before the entire training budget has been used.
11741    evaluationExplanationSpec: Specification for explaining the evaluation
11742      results. If specified, the ModelEvaluation of the trained Model will
11743      include explanations for predictions on the test data. Each prediction
11744      will be explained twice, using integrated gradients and XRAI attribution
11745      methods respectively.
11746    modelType: A ModelTypeValueValuesEnum attribute.
11747    multiLabel: If false, a single-label (multi-class) Model will be trained
11748      (i.e. assuming that for each image just up to one annotation may be
11749      applicable). If true, a multi-label Model will be trained (i.e. assuming
11750      that for each image multiple annotations may be applicable).
11751  """
11752
11753  class ModelTypeValueValuesEnum(_messages.Enum):
11754    r"""ModelTypeValueValuesEnum enum type.
11755
11756    Values:
11757      MODEL_TYPE_UNSPECIFIED: Should not be set.
11758      CLOUD: A Model best tailored to be used within Google Cloud, and which
11759        cannot be exported. Default.
11760      MOBILE_TF_LOW_LATENCY_1: A model that, in addition to being available
11761        within Google Cloud, can also be exported (see
11762        ModelService.ExportModel) as TensorFlow or Core ML model and used on a
11763        mobile or edge device afterwards. Expected to have low latency, but
11764        may have lower prediction quality than other mobile models.
11765      MOBILE_TF_VERSATILE_1: A model that, in addition to being available
11766        within Google Cloud, can also be exported (see
11767        ModelService.ExportModel) as TensorFlow or Core ML model and used on a
11768        mobile or edge device with afterwards.
11769      MOBILE_TF_HIGH_ACCURACY_1: A model that, in addition to being available
11770        within Google Cloud, can also be exported (see
11771        ModelService.ExportModel) as TensorFlow or Core ML model and used on a
11772        mobile or edge device afterwards. Expected to have a higher latency,
11773        but should also have a higher prediction quality than other mobile
11774        models.
11775    """
11776    MODEL_TYPE_UNSPECIFIED = 0
11777    CLOUD = 1
11778    MOBILE_TF_LOW_LATENCY_1 = 2
11779    MOBILE_TF_VERSATILE_1 = 3
11780    MOBILE_TF_HIGH_ACCURACY_1 = 4
11781
11782  baseModelId = _messages.StringField(1)
11783  budgetMilliNodeHours = _messages.IntegerField(2)
11784  disableEarlyStopping = _messages.BooleanField(3)
11785  evaluationExplanationSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageExplanationSpecGroup', 4)
11786  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 5)
11787  multiLabel = _messages.BooleanField(6)
11788
11789
11790class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata(_messages.Message):
11791  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClas
11792  sificationMetadata object.
11793
11794  Enums:
11795    SuccessfulStopReasonValueValuesEnum: For successful job completions, this
11796      is the reason why the job has finished.
11797
11798  Fields:
11799    costMilliNodeHours: The actual training cost of creating this model,
11800      expressed in milli node hours, i.e. 1,000 value in this field means 1
11801      node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.
11802    successfulStopReason: For successful job completions, this is the reason
11803      why the job has finished.
11804  """
11805
11806  class SuccessfulStopReasonValueValuesEnum(_messages.Enum):
11807    r"""For successful job completions, this is the reason why the job has
11808    finished.
11809
11810    Values:
11811      SUCCESSFUL_STOP_REASON_UNSPECIFIED: Should not be set.
11812      BUDGET_REACHED: The inputs.budgetMilliNodeHours had been reached.
11813      MODEL_CONVERGED: Further training of the Model ceased to increase its
11814        quality, since it already has converged.
11815    """
11816    SUCCESSFUL_STOP_REASON_UNSPECIFIED = 0
11817    BUDGET_REACHED = 1
11818    MODEL_CONVERGED = 2
11819
11820  costMilliNodeHours = _messages.IntegerField(1)
11821  successfulStopReason = _messages.EnumField('SuccessfulStopReasonValueValuesEnum', 2)
11822
11823
11824class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageExplanationSpec(_messages.Message):
11825  r"""Specification of a specified explanation attribution method.
11826
11827  Fields:
11828    stepCount: The number of steps for approximating the path integral. A good
11829      value to start is 50 and gradually increase until the sum to diff
11830      property is within the desired error range. Valid range of its value is
11831      [1, 100], inclusively.
11832    visualization: Visualization configurations for image explanation.
11833  """
11834
11835  stepCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
11836  visualization = _messages.MessageField('GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataVisualization', 2)
11837
11838
11839class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageExplanationSpecGroup(_messages.Message):
11840  r"""Specification for explaining the evaluation results.
11841
11842  Fields:
11843    imageGcsDestination: The Cloud Storage location to store the images
11844      explaining the evaluation result of the images in the test data.
11845    integratedGradients: Specification for explaining the evaluation results
11846      using integrated gradients attribution method. The full ExplanationSpec
11847      used for explaining the evaluation can be found in the
11848      ModelEvaluation.explanationSpecs object.
11849    xrai: Specification for explaining the evaluation results using XRAI
11850      attribution method. The full ExplanationSpec used for explaining the
11851      evaluation can be found in the ModelEvaluation.explanationSpecs object.
11852  """
11853
11854  imageGcsDestination = _messages.StringField(1)
11855  integratedGradients = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageExplanationSpec', 2)
11856  xrai = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageExplanationSpec', 3)
11857
11858
11859class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetection(_messages.Message):
11860  r"""A TrainingJob that trains and uploads an AutoML Image Object Detection
11861  Model.
11862
11863  Fields:
11864    inputs: The input parameters of this TrainingJob.
11865    metadata: The metadata information
11866  """
11867
11868  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs', 1)
11869  metadata = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata', 2)
11870
11871
11872class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs(_messages.Message):
11873  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObje
11874  ctDetectionInputs object.
11875
11876  Enums:
11877    ModelTypeValueValuesEnum:
11878
11879  Fields:
11880    budgetMilliNodeHours: The training budget of creating this model,
11881      expressed in milli node hours i.e. 1,000 value in this field means 1
11882      node hour. The actual metadata.costMilliNodeHours will be equal or less
11883      than this value. If further model training ceases to provide any
11884      improvements, it will stop without using the full budget and the
11885      metadata.successfulStopReason will be `model-converged`. Note, node_hour
11886      = actual_hour * number_of_nodes_involved. For modelType
11887      `cloud`(default), the budget must be between 20,000 and 900,000 milli
11888      node hours, inclusive. The default value is 216,000 which represents one
11889      day in wall time, considering 9 nodes are used. For model types `mobile-
11890      tf-low-latency-1`, `mobile-tf-versatile-1`, `mobile-tf-high-accuracy-1`
11891      the training budget must be between 1,000 and 100,000 milli node hours,
11892      inclusive. The default value is 24,000 which represents one day in wall
11893      time on a single node that is used.
11894    disableEarlyStopping: Use the entire training budget. This disables the
11895      early stopping feature. When false the early stopping feature is
11896      enabled, which means that AutoML Image Object Detection might stop
11897      training before the entire training budget has been used.
11898    modelType: A ModelTypeValueValuesEnum attribute.
11899  """
11900
11901  class ModelTypeValueValuesEnum(_messages.Enum):
11902    r"""ModelTypeValueValuesEnum enum type.
11903
11904    Values:
11905      MODEL_TYPE_UNSPECIFIED: Should not be set.
11906      CLOUD_HIGH_ACCURACY_1: A model best tailored to be used within Google
11907        Cloud, and which cannot be exported. Expected to have a higher
11908        latency, but should also have a higher prediction quality than other
11909        cloud models.
11910      CLOUD_LOW_LATENCY_1: A model best tailored to be used within Google
11911        Cloud, and which cannot be exported. Expected to have a low latency,
11912        but may have lower prediction quality than other cloud models.
11913      MOBILE_TF_LOW_LATENCY_1: A model that, in addition to being available
11914        within Google Cloud can also be exported (see
11915        ModelService.ExportModel) and used on a mobile or edge device with
11916        TensorFlow afterwards. Expected to have low latency, but may have
11917        lower prediction quality than other mobile models.
11918      MOBILE_TF_VERSATILE_1: A model that, in addition to being available
11919        within Google Cloud can also be exported (see
11920        ModelService.ExportModel) and used on a mobile or edge device with
11921        TensorFlow afterwards.
11922      MOBILE_TF_HIGH_ACCURACY_1: A model that, in addition to being available
11923        within Google Cloud, can also be exported (see
11924        ModelService.ExportModel) and used on a mobile or edge device with
11925        TensorFlow afterwards. Expected to have a higher latency, but should
11926        also have a higher prediction quality than other mobile models.
11927    """
11928    MODEL_TYPE_UNSPECIFIED = 0
11929    CLOUD_HIGH_ACCURACY_1 = 1
11930    CLOUD_LOW_LATENCY_1 = 2
11931    MOBILE_TF_LOW_LATENCY_1 = 3
11932    MOBILE_TF_VERSATILE_1 = 4
11933    MOBILE_TF_HIGH_ACCURACY_1 = 5
11934
11935  budgetMilliNodeHours = _messages.IntegerField(1)
11936  disableEarlyStopping = _messages.BooleanField(2)
11937  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 3)
11938
11939
11940class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata(_messages.Message):
11941  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObje
11942  ctDetectionMetadata object.
11943
11944  Enums:
11945    SuccessfulStopReasonValueValuesEnum: For successful job completions, this
11946      is the reason why the job has finished.
11947
11948  Fields:
11949    costMilliNodeHours: The actual training cost of creating this model,
11950      expressed in milli node hours, i.e. 1,000 value in this field means 1
11951      node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.
11952    successfulStopReason: For successful job completions, this is the reason
11953      why the job has finished.
11954  """
11955
11956  class SuccessfulStopReasonValueValuesEnum(_messages.Enum):
11957    r"""For successful job completions, this is the reason why the job has
11958    finished.
11959
11960    Values:
11961      SUCCESSFUL_STOP_REASON_UNSPECIFIED: Should not be set.
11962      BUDGET_REACHED: The inputs.budgetMilliNodeHours had been reached.
11963      MODEL_CONVERGED: Further training of the Model ceased to increase its
11964        quality, since it already has converged.
11965    """
11966    SUCCESSFUL_STOP_REASON_UNSPECIFIED = 0
11967    BUDGET_REACHED = 1
11968    MODEL_CONVERGED = 2
11969
11970  costMilliNodeHours = _messages.IntegerField(1)
11971  successfulStopReason = _messages.EnumField('SuccessfulStopReasonValueValuesEnum', 2)
11972
11973
11974class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentation(_messages.Message):
11975  r"""A TrainingJob that trains and uploads an AutoML Image Segmentation
11976  Model.
11977
11978  Fields:
11979    inputs: The input parameters of this TrainingJob.
11980    metadata: The metadata information.
11981  """
11982
11983  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs', 1)
11984  metadata = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata', 2)
11985
11986
11987class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs(_messages.Message):
11988  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegm
11989  entationInputs object.
11990
11991  Enums:
11992    ModelTypeValueValuesEnum:
11993
11994  Fields:
11995    baseModelId: The ID of the `base` model. If it is specified, the new model
11996      will be trained based on the `base` model. Otherwise, the new model will
11997      be trained from scratch. The `base` model must be in the same Project
11998      and Location as the new Model to train, and have the same modelType.
11999    budgetMilliNodeHours: The training budget of creating this model,
12000      expressed in milli node hours i.e. 1,000 value in this field means 1
12001      node hour. The actual metadata.costMilliNodeHours will be equal or less
12002      than this value. If further model training ceases to provide any
12003      improvements, it will stop without using the full budget and the
12004      metadata.successfulStopReason will be `model-converged`. Note, node_hour
12005      = actual_hour * number_of_nodes_involved. Or actaul_wall_clock_hours =
12006      train_budget_milli_node_hours / (number_of_nodes_involved * 1000) For
12007      modelType `cloud-high-accuracy-1`(default), the budget must be between
12008      20,000 and 2,000,000 milli node hours, inclusive. The default value is
12009      192,000 which represents one day in wall time (1000 milli * 24 hours * 8
12010      nodes).
12011    modelType: A ModelTypeValueValuesEnum attribute.
12012  """
12013
12014  class ModelTypeValueValuesEnum(_messages.Enum):
12015    r"""ModelTypeValueValuesEnum enum type.
12016
12017    Values:
12018      MODEL_TYPE_UNSPECIFIED: Should not be set.
12019      CLOUD_HIGH_ACCURACY_1: A model to be used via prediction calls to uCAIP
12020        API. Expected to have a higher latency, but should also have a higher
12021        prediction quality than other models.
12022      CLOUD_LOW_ACCURACY_1: A model to be used via prediction calls to uCAIP
12023        API. Expected to have a lower latency but relatively lower prediction
12024        quality.
12025      MOBILE_TF_LOW_LATENCY_1: A model that, in addition to being available
12026        within Google Cloud, can also be exported (see
12027        ModelService.ExportModel) as TensorFlow model and used on a mobile or
12028        edge device afterwards. Expected to have low latency, but may have
12029        lower prediction quality than other mobile models.
12030    """
12031    MODEL_TYPE_UNSPECIFIED = 0
12032    CLOUD_HIGH_ACCURACY_1 = 1
12033    CLOUD_LOW_ACCURACY_1 = 2
12034    MOBILE_TF_LOW_LATENCY_1 = 3
12035
12036  baseModelId = _messages.StringField(1)
12037  budgetMilliNodeHours = _messages.IntegerField(2)
12038  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 3)
12039
12040
12041class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata(_messages.Message):
12042  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegm
12043  entationMetadata object.
12044
12045  Enums:
12046    SuccessfulStopReasonValueValuesEnum: For successful job completions, this
12047      is the reason why the job has finished.
12048
12049  Fields:
12050    costMilliNodeHours: The actual training cost of creating this model,
12051      expressed in milli node hours, i.e. 1,000 value in this field means 1
12052      node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.
12053    successfulStopReason: For successful job completions, this is the reason
12054      why the job has finished.
12055  """
12056
12057  class SuccessfulStopReasonValueValuesEnum(_messages.Enum):
12058    r"""For successful job completions, this is the reason why the job has
12059    finished.
12060
12061    Values:
12062      SUCCESSFUL_STOP_REASON_UNSPECIFIED: Should not be set.
12063      BUDGET_REACHED: The inputs.budgetMilliNodeHours had been reached.
12064      MODEL_CONVERGED: Further training of the Model ceased to increase its
12065        quality, since it already has converged.
12066    """
12067    SUCCESSFUL_STOP_REASON_UNSPECIFIED = 0
12068    BUDGET_REACHED = 1
12069    MODEL_CONVERGED = 2
12070
12071  costMilliNodeHours = _messages.IntegerField(1)
12072  successfulStopReason = _messages.EnumField('SuccessfulStopReasonValueValuesEnum', 2)
12073
12074
12075class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTables(_messages.Message):
12076  r"""A TrainingJob that trains and uploads an AutoML Tables Model.
12077
12078  Fields:
12079    inputs: The input parameters of this TrainingJob.
12080    metadata: The metadata information.
12081  """
12082
12083  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputs', 1)
12084  metadata = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesMetadata', 2)
12085
12086
12087class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputs(_messages.Message):
12088  r"""A
12089  GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputs
12090  object.
12091
12092  Fields:
12093    disableEarlyStopping: Use the entire training budget. This disables the
12094      early stopping feature. By default, the early stopping feature is
12095      enabled, which means that AutoML Tables might stop training before the
12096      entire training budget has been used.
12097    exportEvaluatedDataItemsConfig: Configuration for exporting test set
12098      predictions to a BigQuery table. If this configuration is absent, then
12099      the export is not performed.
12100    optimizationObjective: Objective function the model is optimizing towards.
12101      The training process creates a model that maximizes/minimizes the value
12102      of the objective function over the validation set. The supported
12103      optimization objectives depend on the prediction type. If the field is
12104      not set, a default objective function is used. classification (binary):
12105      "maximize-au-roc" (default) - Maximize the area under the receiver
12106      operating characteristic (ROC) curve. "minimize-log-loss" - Minimize log
12107      loss. "maximize-au-prc" - Maximize the area under the precision-recall
12108      curve. "maximize-precision-at-recall" - Maximize precision for a
12109      specified recall value. "maximize-recall-at-precision" - Maximize recall
12110      for a specified precision value. classification (multi-class):
12111      "minimize-log-loss" (default) - Minimize log loss. regression:
12112      "minimize-rmse" (default) - Minimize root-mean-squared error (RMSE).
12113      "minimize-mae" - Minimize mean-absolute error (MAE). "minimize-rmsle" -
12114      Minimize root-mean-squared log error (RMSLE).
12115    optimizationObjectivePrecisionValue: Required when optimization_objective
12116      is "maximize-recall-at-precision". Must be between 0 and 1, inclusive.
12117    optimizationObjectiveRecallValue: Required when optimization_objective is
12118      "maximize-precision-at-recall". Must be between 0 and 1, inclusive.
12119    predictionType: The type of prediction the Model is to produce.
12120      "classification" - Predict one out of multiple target values is picked
12121      for each row. "regression" - Predict a value based on its relation to
12122      other values. This type is available only to columns that contain
12123      semantically numeric values, i.e. integers or floating point number,
12124      even if stored as e.g. strings.
12125    targetColumn: The column name of the target column that the model is to
12126      predict.
12127    trainBudgetMilliNodeHours: Required. The train budget of creating this
12128      model, expressed in milli node hours i.e. 1,000 value in this field
12129      means 1 node hour. The training cost of the model will not exceed this
12130      budget. The final cost will be attempted to be close to the budget,
12131      though may end up being (even) noticeably smaller - at the backend's
12132      discretion. This especially may happen when further model training
12133      ceases to provide any improvements. If the budget is set to a value
12134      known to be insufficient to train a model for the given dataset, the
12135      training won't be attempted and will error. The train budget must be
12136      between 1,000 and 72,000 milli node hours, inclusive.
12137    transformations: Each transformation will apply transform function to
12138      given input column. And the result will be used for training. When
12139      creating transformation for BigQuery Struct column, the column should be
12140      flattened using "." as the delimiter.
12141    weightColumnName: Column name that should be used as the weight column.
12142      Higher values in this column give more importance to the row during
12143      model training. The column must have numeric values between 0 and 10000
12144      inclusively; 0 means the row is ignored for training. If weight column
12145      field is not set, then all rows are assumed to have equal weight of 1.
12146  """
12147
12148  disableEarlyStopping = _messages.BooleanField(1)
12149  exportEvaluatedDataItemsConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig', 2)
12150  optimizationObjective = _messages.StringField(3)
12151  optimizationObjectivePrecisionValue = _messages.FloatField(4, variant=_messages.Variant.FLOAT)
12152  optimizationObjectiveRecallValue = _messages.FloatField(5, variant=_messages.Variant.FLOAT)
12153  predictionType = _messages.StringField(6)
12154  targetColumn = _messages.StringField(7)
12155  trainBudgetMilliNodeHours = _messages.IntegerField(8)
12156  transformations = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation', 9, repeated=True)
12157  weightColumnName = _messages.StringField(10)
12158
12159
12160class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation(_messages.Message):
12161  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInp
12162  utsTransformation object.
12163
12164  Fields:
12165    auto: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTable
12166      sInputsTransformationAutoTransformation attribute.
12167    categorical: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAuto
12168      MlTablesInputsTransformationCategoricalTransformation attribute.
12169    numeric: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTa
12170      blesInputsTransformationNumericTransformation attribute.
12171    repeatedCategorical: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefini
12172      tionAutoMlTablesInputsTransformationCategoricalArrayTransformation
12173      attribute.
12174    repeatedNumeric: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinition
12175      AutoMlTablesInputsTransformationNumericArrayTransformation attribute.
12176    repeatedText: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAut
12177      oMlTablesInputsTransformationTextArrayTransformation attribute.
12178    text: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTable
12179      sInputsTransformationTextTransformation attribute.
12180    timestamp: A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMl
12181      TablesInputsTransformationTimestampTransformation attribute.
12182  """
12183
12184  auto = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation', 1)
12185  categorical = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation', 2)
12186  numeric = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation', 3)
12187  repeatedCategorical = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation', 4)
12188  repeatedNumeric = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation', 5)
12189  repeatedText = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation', 6)
12190  text = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation', 7)
12191  timestamp = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation', 8)
12192
12193
12194class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation(_messages.Message):
12195  r"""Training pipeline will infer the proper transformation based on the
12196  statistic of dataset.
12197
12198  Fields:
12199    columnName: A string attribute.
12200  """
12201
12202  columnName = _messages.StringField(1)
12203
12204
12205class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation(_messages.Message):
12206  r"""Treats the column as categorical array and performs following
12207  transformation functions. * For each element in the array, convert the
12208  category name to a dictionary lookup index and generate an embedding for
12209  each index. Combine the embedding of all elements into a single embedding
12210  using the mean. * Empty arrays treated as an embedding of zeroes.
12211
12212  Fields:
12213    columnName: A string attribute.
12214  """
12215
12216  columnName = _messages.StringField(1)
12217
12218
12219class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation(_messages.Message):
12220  r"""Training pipeline will perform following transformation functions. * The
12221  categorical string as is--no change to case, punctuation, spelling, tense,
12222  and so on. * Convert the category name to a dictionary lookup index and
12223  generate an embedding for each index. * Categories that appear less than 5
12224  times in the training dataset are treated as the "unknown" category. The
12225  "unknown" category gets its own special lookup index and resulting
12226  embedding.
12227
12228  Fields:
12229    columnName: A string attribute.
12230  """
12231
12232  columnName = _messages.StringField(1)
12233
12234
12235class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation(_messages.Message):
12236  r"""Treats the column as numerical array and performs following
12237  transformation functions. * All transformations for Numerical types applied
12238  to the average of the all elements. * The average of empty arrays is treated
12239  as zero.
12240
12241  Fields:
12242    columnName: A string attribute.
12243    invalidValuesAllowed: If invalid values is allowed, the training pipeline
12244      will create a boolean feature that indicated whether the value is valid.
12245      Otherwise, the training pipeline will discard the input row from
12246      trainining data.
12247  """
12248
12249  columnName = _messages.StringField(1)
12250  invalidValuesAllowed = _messages.BooleanField(2)
12251
12252
12253class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation(_messages.Message):
12254  r"""Training pipeline will perform following transformation functions. * The
12255  value converted to float32. * The z_score of the value. * log(value+1) when
12256  the value is greater than or equal to 0. Otherwise, this transformation is
12257  not applied and the value is considered a missing value. * z_score of
12258  log(value+1) when the value is greater than or equal to 0. Otherwise, this
12259  transformation is not applied and the value is considered a missing value. *
12260  A boolean value that indicates whether the value is valid.
12261
12262  Fields:
12263    columnName: A string attribute.
12264    invalidValuesAllowed: If invalid values is allowed, the training pipeline
12265      will create a boolean feature that indicated whether the value is valid.
12266      Otherwise, the training pipeline will discard the input row from
12267      trainining data.
12268  """
12269
12270  columnName = _messages.StringField(1)
12271  invalidValuesAllowed = _messages.BooleanField(2)
12272
12273
12274class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation(_messages.Message):
12275  r"""Treats the column as text array and performs following transformation
12276  functions. * Concatenate all text values in the array into a single text
12277  value using a space (" ") as a delimiter, and then treat the result as a
12278  single text value. Apply the transformations for Text columns. * Empty
12279  arrays treated as an empty text.
12280
12281  Fields:
12282    columnName: A string attribute.
12283  """
12284
12285  columnName = _messages.StringField(1)
12286
12287
12288class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation(_messages.Message):
12289  r"""Training pipeline will perform following transformation functions. * The
12290  text as is--no change to case, punctuation, spelling, tense, and so on. *
12291  Tokenize text to words. Convert each words to a dictionary lookup index and
12292  generate an embedding for each index. Combine the embedding of all elements
12293  into a single embedding using the mean. * Tokenization is based on unicode
12294  script boundaries. * Missing values get their own lookup index and resulting
12295  embedding. * Stop-words receive no special treatment and are not removed.
12296
12297  Fields:
12298    columnName: A string attribute.
12299  """
12300
12301  columnName = _messages.StringField(1)
12302
12303
12304class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation(_messages.Message):
12305  r"""Training pipeline will perform following transformation functions. *
12306  Apply the transformation functions for Numerical columns. * Determine the
12307  year, month, day,and weekday. Treat each value from the * timestamp as a
12308  Categorical column. * Invalid numerical values (for example, values that
12309  fall outside of a typical timestamp range, or are extreme values) receive no
12310  special treatment and are not removed.
12311
12312  Fields:
12313    columnName: A string attribute.
12314    invalidValuesAllowed: If invalid values is allowed, the training pipeline
12315      will create a boolean feature that indicated whether the value is valid.
12316      Otherwise, the training pipeline will discard the input row from
12317      trainining data.
12318    timeFormat: The format in which that time field is expressed. The
12319      time_format must either be one of: * `unix-seconds` * `unix-
12320      milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for
12321      respectively number of seconds, milliseconds, microseconds and
12322      nanoseconds since start of the Unix epoch); or be written in `strftime`
12323      syntax. If time_format is not set, then the default format is RFC 3339
12324      `date-time` format, where `time-offset` = `"Z"` (e.g.
12325      1985-04-12T23:20:50.52Z)
12326  """
12327
12328  columnName = _messages.StringField(1)
12329  invalidValuesAllowed = _messages.BooleanField(2)
12330  timeFormat = _messages.StringField(3)
12331
12332
12333class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesMetadata(_messages.Message):
12334  r"""Model metadata specific to AutoML Tables.
12335
12336  Fields:
12337    trainCostMilliNodeHours: Output only. The actual training cost of the
12338      model, expressed in milli node hours, i.e. 1,000 value in this field
12339      means 1 node hour. Guaranteed to not exceed the train budget.
12340  """
12341
12342  trainCostMilliNodeHours = _messages.IntegerField(1)
12343
12344
12345class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClassification(_messages.Message):
12346  r"""A TrainingJob that trains and uploads an AutoML Text Classification
12347  Model.
12348
12349  Fields:
12350    inputs: The input parameters of this TrainingJob.
12351  """
12352
12353  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs', 1)
12354
12355
12356class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs(_messages.Message):
12357  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClass
12358  ificationInputs object.
12359
12360  Fields:
12361    multiLabel: A boolean attribute.
12362  """
12363
12364  multiLabel = _messages.BooleanField(1)
12365
12366
12367class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtraction(_messages.Message):
12368  r"""A TrainingJob that trains and uploads an AutoML Text Extraction Model.
12369
12370  Fields:
12371    inputs: The input parameters of this TrainingJob.
12372  """
12373
12374  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs', 1)
12375
12376
12377class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs(_messages.Message):
12378  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtra
12379  ctionInputs object.
12380  """
12381
12382
12383
12384class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSentiment(_messages.Message):
12385  r"""A TrainingJob that trains and uploads an AutoML Text Sentiment Model.
12386
12387  Fields:
12388    inputs: The input parameters of this TrainingJob.
12389  """
12390
12391  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs', 1)
12392
12393
12394class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs(_messages.Message):
12395  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSenti
12396  mentInputs object.
12397
12398  Fields:
12399    sentimentMax: A sentiment is expressed as an integer ordinal, where higher
12400      value means a more positive sentiment. The range of sentiments that will
12401      be used is between 0 and sentimentMax (inclusive on both ends), and all
12402      the values in the range must be represented in the dataset before a
12403      model can be created. Only the Annotations with this sentimentMax will
12404      be used for training. sentimentMax value must be between 1 and 10
12405      (inclusive).
12406  """
12407
12408  sentimentMax = _messages.IntegerField(1, variant=_messages.Variant.INT32)
12409
12410
12411class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition(_messages.Message):
12412  r"""A TrainingJob that trains and uploads an AutoML Video Action Recognition
12413  Model.
12414
12415  Fields:
12416    inputs: The input parameters of this TrainingJob.
12417  """
12418
12419  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs', 1)
12420
12421
12422class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs(_messages.Message):
12423  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActi
12424  onRecognitionInputs object.
12425
12426  Enums:
12427    ModelTypeValueValuesEnum:
12428
12429  Fields:
12430    modelType: A ModelTypeValueValuesEnum attribute.
12431  """
12432
12433  class ModelTypeValueValuesEnum(_messages.Enum):
12434    r"""ModelTypeValueValuesEnum enum type.
12435
12436    Values:
12437      MODEL_TYPE_UNSPECIFIED: Should not be set.
12438      CLOUD: A model best tailored to be used within Google Cloud, and which c
12439        annot be exported. Default.
12440      MOBILE_VERSATILE_1: A model that, in addition to being available within
12441        Google Cloud, can also be exported (see ModelService.ExportModel) as a
12442        TensorFlow or TensorFlow Lite model and used on a mobile or edge
12443        device afterwards.
12444    """
12445    MODEL_TYPE_UNSPECIFIED = 0
12446    CLOUD = 1
12447    MOBILE_VERSATILE_1 = 2
12448
12449  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 1)
12450
12451
12452class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClassification(_messages.Message):
12453  r"""A TrainingJob that trains and uploads an AutoML Video Classification
12454  Model.
12455
12456  Fields:
12457    inputs: The input parameters of this TrainingJob.
12458  """
12459
12460  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs', 1)
12461
12462
12463class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs(_messages.Message):
12464  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClas
12465  sificationInputs object.
12466
12467  Enums:
12468    ModelTypeValueValuesEnum:
12469
12470  Fields:
12471    modelType: A ModelTypeValueValuesEnum attribute.
12472  """
12473
12474  class ModelTypeValueValuesEnum(_messages.Enum):
12475    r"""ModelTypeValueValuesEnum enum type.
12476
12477    Values:
12478      MODEL_TYPE_UNSPECIFIED: Should not be set.
12479      CLOUD: A model best tailored to be used within Google Cloud, and which
12480        cannot be exported. Default.
12481      MOBILE_VERSATILE_1: A model that, in addition to being available within
12482        Google Cloud, can also be exported (see ModelService.ExportModel) as a
12483        TensorFlow or TensorFlow Lite model and used on a mobile or edge
12484        device afterwards.
12485      MOBILE_JETSON_VERSATILE_1: A model that, in addition to being available
12486        within Google Cloud, can also be exported (see
12487        ModelService.ExportModel) to a Jetson device afterwards.
12488    """
12489    MODEL_TYPE_UNSPECIFIED = 0
12490    CLOUD = 1
12491    MOBILE_VERSATILE_1 = 2
12492    MOBILE_JETSON_VERSATILE_1 = 3
12493
12494  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 1)
12495
12496
12497class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking(_messages.Message):
12498  r"""A TrainingJob that trains and uploads an AutoML Video ObjectTracking
12499  Model.
12500
12501  Fields:
12502    inputs: The input parameters of this TrainingJob.
12503  """
12504
12505  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs', 1)
12506
12507
12508class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs(_messages.Message):
12509  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObje
12510  ctTrackingInputs object.
12511
12512  Enums:
12513    ModelTypeValueValuesEnum:
12514
12515  Fields:
12516    modelType: A ModelTypeValueValuesEnum attribute.
12517  """
12518
12519  class ModelTypeValueValuesEnum(_messages.Enum):
12520    r"""ModelTypeValueValuesEnum enum type.
12521
12522    Values:
12523      MODEL_TYPE_UNSPECIFIED: Should not be set.
12524      CLOUD: A model best tailored to be used within Google Cloud, and which c
12525        annot be exported. Default.
12526      MOBILE_VERSATILE_1: A model that, in addition to being available within
12527        Google Cloud, can also be exported (see ModelService.ExportModel) as a
12528        TensorFlow or TensorFlow Lite model and used on a mobile or edge
12529        device afterwards.
12530      MOBILE_CORAL_VERSATILE_1: A versatile model that is meant to be exported
12531        (see ModelService.ExportModel) and used on a Google Coral device.
12532      MOBILE_CORAL_LOW_LATENCY_1: A model that trades off quality for low
12533        latency, to be exported (see ModelService.ExportModel) and used on a
12534        Google Coral device.
12535      MOBILE_JETSON_VERSATILE_1: A versatile model that is meant to be
12536        exported (see ModelService.ExportModel) and used on an NVIDIA Jetson
12537        device.
12538      MOBILE_JETSON_LOW_LATENCY_1: A model that trades off quality for low
12539        latency, to be exported (see ModelService.ExportModel) and used on an
12540        NVIDIA Jetson device.
12541    """
12542    MODEL_TYPE_UNSPECIFIED = 0
12543    CLOUD = 1
12544    MOBILE_VERSATILE_1 = 2
12545    MOBILE_CORAL_VERSATILE_1 = 3
12546    MOBILE_CORAL_LOW_LATENCY_1 = 4
12547    MOBILE_JETSON_VERSATILE_1 = 5
12548    MOBILE_JETSON_LOW_LATENCY_1 = 6
12549
12550  modelType = _messages.EnumField('ModelTypeValueValuesEnum', 1)
12551
12552
12553class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomJobMetadata(_messages.Message):
12554  r"""A
12555  GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomJobMetadata
12556  object.
12557
12558  Fields:
12559    backingCustomJob: The resource name of the CustomJob that has been created
12560      to carry out this custom task.
12561  """
12562
12563  backingCustomJob = _messages.StringField(1)
12564
12565
12566class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomTask(_messages.Message):
12567  r"""A TrainingJob that trains a custom code Model.
12568
12569  Fields:
12570    inputs: The input parameters of this CustomTask.
12571    metadata: The metadata information.
12572  """
12573
12574  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1CustomJobSpec', 1)
12575  metadata = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomJobMetadata', 2)
12576
12577
12578class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig(_messages.Message):
12579  r"""Configuration for exporting test set predictions to a BigQuery table.
12580
12581  Fields:
12582    destinationBigqueryUri: URI of desired destination BigQuery table.
12583      Expected format: bq://:: If not specified, then results are exported to
12584      the following auto-created BigQuery table:
12585      :export_evaluated_examples__.evaluated_examples
12586    overrideExistingTable: If true and an export destination is specified,
12587      then the contents of the destination are overwritten. Otherwise, if the
12588      export destination already exists, then the export operation fails.
12589  """
12590
12591  destinationBigqueryUri = _messages.StringField(1)
12592  overrideExistingTable = _messages.BooleanField(2)
12593
12594
12595class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata(_messages.Message):
12596  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterT
12597  uningJobMetadata object.
12598
12599  Fields:
12600    backingHyperparameterTuningJob: The resource name of the
12601      HyperparameterTuningJob that has been created to carry out this
12602      HyperparameterTuning task.
12603    bestTrialBackingCustomJob: The resource name of the CustomJob that has
12604      been created to run the best Trial of this HyperparameterTuning task.
12605  """
12606
12607  backingHyperparameterTuningJob = _messages.StringField(1)
12608  bestTrialBackingCustomJob = _messages.StringField(2)
12609
12610
12611class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec(_messages.Message):
12612  r"""A GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterT
12613  uningJobSpec object.
12614
12615  Fields:
12616    maxFailedTrialCount: The number of failed Trials that need to be seen
12617      before failing the HyperparameterTuningJob. If set to 0, AI Platform
12618      decides how many Trials must fail before the whole job fails.
12619    maxTrialCount: The desired total number of Trials.
12620    parallelTrialCount: The desired number of Trials to run in parallel.
12621    studySpec: Study configuration of the HyperparameterTuningJob.
12622    trialJobSpec: The spec of a trial job. The same spec applies to the
12623      CustomJobs created in all the trials.
12624  """
12625
12626  maxFailedTrialCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
12627  maxTrialCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
12628  parallelTrialCount = _messages.IntegerField(3, variant=_messages.Variant.INT32)
12629  studySpec = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpec', 4)
12630  trialJobSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1CustomJobSpec', 5)
12631
12632
12633class GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningTask(_messages.Message):
12634  r"""A TrainingJob that tunes Hypererparameters of a custom code Model.
12635
12636  Fields:
12637    inputs: The input parameters of this HyperparameterTuningTask.
12638    metadata: The metadata information.
12639  """
12640
12641  inputs = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec', 1)
12642  metadata = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata', 2)
12643
12644
12645class GoogleCloudAiplatformV1beta1SchemaVertex(_messages.Message):
12646  r"""A vertex represents a 2D point in the image. NOTE: the normalized vertex
12647  coordinates are relative to the original image and range from 0 to 1.
12648
12649  Fields:
12650    x: X coordinate.
12651    y: Y coordinate.
12652  """
12653
12654  x = _messages.FloatField(1)
12655  y = _messages.FloatField(2)
12656
12657
12658class GoogleCloudAiplatformV1beta1SchemaVideoActionRecognitionAnnotation(_messages.Message):
12659  r"""Annotation details specific to video action recognition.
12660
12661  Fields:
12662    annotationSpecId: The resource Id of the AnnotationSpec that this
12663      Annotation pertains to.
12664    displayName: The display name of the AnnotationSpec that this Annotation
12665      pertains to.
12666    timeSegment: This Annotation applies to the time period represented by the
12667      TimeSegment. If it's not set, the Annotation applies to the whole video.
12668  """
12669
12670  annotationSpecId = _messages.StringField(1)
12671  displayName = _messages.StringField(2)
12672  timeSegment = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTimeSegment', 3)
12673
12674
12675class GoogleCloudAiplatformV1beta1SchemaVideoClassificationAnnotation(_messages.Message):
12676  r"""Annotation details specific to video classification.
12677
12678  Fields:
12679    annotationSpecId: The resource Id of the AnnotationSpec that this
12680      Annotation pertains to.
12681    displayName: The display name of the AnnotationSpec that this Annotation
12682      pertains to.
12683    timeSegment: This Annotation applies to the time period represented by the
12684      TimeSegment. If it's not set, the Annotation applies to the whole video.
12685  """
12686
12687  annotationSpecId = _messages.StringField(1)
12688  displayName = _messages.StringField(2)
12689  timeSegment = _messages.MessageField('GoogleCloudAiplatformV1beta1SchemaTimeSegment', 3)
12690
12691
12692class GoogleCloudAiplatformV1beta1SchemaVideoDataItem(_messages.Message):
12693  r"""Payload of Video DataItem.
12694
12695  Fields:
12696    gcsUri: Required. Google Cloud Storage URI points to the original video in
12697      user's bucket. The video is up to 50 GB in size and up to 3 hour in
12698      duration.
12699    mimeType: Output only. The mime type of the content of the video. Only the
12700      videos in below listed mime types are supported. Supported mime_type: -
12701      video/mp4 - video/avi - video/quicktime
12702  """
12703
12704  gcsUri = _messages.StringField(1)
12705  mimeType = _messages.StringField(2)
12706
12707
12708class GoogleCloudAiplatformV1beta1SchemaVideoDatasetMetadata(_messages.Message):
12709  r"""The metadata of Datasets that contain Video DataItems.
12710
12711  Fields:
12712    dataItemSchemaUri: Points to a YAML file stored on Google Cloud Storage
12713      describing payload of the Video DataItems that belong to this Dataset.
12714    gcsBucket: Google Cloud Storage Bucket name that contains the blob data of
12715      this Dataset.
12716  """
12717
12718  dataItemSchemaUri = _messages.StringField(1)
12719  gcsBucket = _messages.StringField(2)
12720
12721
12722class GoogleCloudAiplatformV1beta1SchemaVideoObjectTrackingAnnotation(_messages.Message):
12723  r"""Annotation details specific to video object tracking.
12724
12725  Fields:
12726    annotationSpecId: The resource Id of the AnnotationSpec that this
12727      Annotation pertains to.
12728    displayName: The display name of the AnnotationSpec that this Annotation
12729      pertains to.
12730    instanceId: The instance of the object, expressed as a positive integer.
12731      Used to track the same object across different frames.
12732    timeOffset: A time (frame) of a video to which this annotation pertains.
12733      Represented as the duration since the video's start.
12734    xMax: The rightmost coordinate of the bounding box.
12735    xMin: The leftmost coordinate of the bounding box.
12736    yMax: The bottommost coordinate of the bounding box.
12737    yMin: The topmost coordinate of the bounding box.
12738  """
12739
12740  annotationSpecId = _messages.StringField(1)
12741  displayName = _messages.StringField(2)
12742  instanceId = _messages.IntegerField(3)
12743  timeOffset = _messages.StringField(4)
12744  xMax = _messages.FloatField(5)
12745  xMin = _messages.FloatField(6)
12746  yMax = _messages.FloatField(7)
12747  yMin = _messages.FloatField(8)
12748
12749
12750class GoogleCloudAiplatformV1beta1SchemaVisualInspectionClassificationLabelSavedQueryMetadata(_messages.Message):
12751  r"""A GoogleCloudAiplatformV1beta1SchemaVisualInspectionClassificationLabelS
12752  avedQueryMetadata object.
12753
12754  Fields:
12755    multiLabel: Whether or not the classification label is multi_label.
12756  """
12757
12758  multiLabel = _messages.BooleanField(1)
12759
12760
12761class GoogleCloudAiplatformV1beta1SchemaVisualInspectionMaskSavedQueryMetadata(_messages.Message):
12762  r"""A
12763  GoogleCloudAiplatformV1beta1SchemaVisualInspectionMaskSavedQueryMetadata
12764  object.
12765  """
12766
12767
12768
12769class GoogleCloudAiplatformV1beta1SmoothGradConfig(_messages.Message):
12770  r"""Config for SmoothGrad approximation of gradients. When enabled, the
12771  gradients are approximated by averaging the gradients from noisy samples in
12772  the vicinity of the inputs. Adding noise can help improve the computed
12773  gradients. Refer to this paper for more details:
12774  https://arxiv.org/pdf/1706.03825.pdf
12775
12776  Fields:
12777    featureNoiseSigma: This is similar to noise_sigma, but provides additional
12778      flexibility. A separate noise sigma can be provided for each feature,
12779      which is useful if their distributions are different. No noise is added
12780      to features that are not set. If this field is unset, noise_sigma will
12781      be used for all features.
12782    noiseSigma: This is a single float value and will be used to add noise to
12783      all the features. Use this field when all features are normalized to
12784      have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring,
12785      where features are normalized to have 0-mean and 1-variance. For more
12786      details about normalization: https://tinyurl.com/dgc-normalization. For
12787      best results the recommended value is about 10% - 20% of the standard
12788      deviation of the input feature. Refer to section 3.2 of the SmoothGrad
12789      paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the
12790      distribution is different per feature, set feature_noise_sigma instead
12791      for each feature.
12792    noisySampleCount: The number of gradient samples to use for approximation.
12793      The higher this number, the more accurate the gradient is, but the
12794      runtime complexity increases by this factor as well. Valid range of its
12795      value is [1, 50]. Defaults to 3.
12796  """
12797
12798  featureNoiseSigma = _messages.MessageField('GoogleCloudAiplatformV1beta1FeatureNoiseSigma', 1)
12799  noiseSigma = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
12800  noisySampleCount = _messages.IntegerField(3, variant=_messages.Variant.INT32)
12801
12802
12803class GoogleCloudAiplatformV1beta1SpecialistPool(_messages.Message):
12804  r"""SpecialistPool represents customers' own workforce to work on their data
12805  labeling jobs. It includes a group of specialist managers who are
12806  responsible for managing the labelers in this pool as well as customers'
12807  data labeling jobs associated with this pool. Customers create specialist
12808  pool as well as start data labeling jobs on Cloud, managers and labelers
12809  work with the jobs using CrowdCompute console.
12810
12811  Fields:
12812    displayName: Required. The user-defined name of the SpecialistPool. The
12813      name can be up to 128 characters long and can be consist of any UTF-8
12814      characters. This field should be unique on project-level.
12815    name: Required. The resource name of the SpecialistPool.
12816    pendingDataLabelingJobs: Output only. The resource name of the pending
12817      data labeling jobs.
12818    specialistManagerEmails: The email addresses of the specialists in the
12819      SpecialistPool.
12820    specialistManagersCount: Output only. The number of Specialists in this
12821      SpecialistPool.
12822  """
12823
12824  displayName = _messages.StringField(1)
12825  name = _messages.StringField(2)
12826  pendingDataLabelingJobs = _messages.StringField(3, repeated=True)
12827  specialistManagerEmails = _messages.StringField(4, repeated=True)
12828  specialistManagersCount = _messages.IntegerField(5, variant=_messages.Variant.INT32)
12829
12830
12831class GoogleCloudAiplatformV1beta1StudySpec(_messages.Message):
12832  r"""Represents specification of a Study.
12833
12834  Enums:
12835    AlgorithmValueValuesEnum: The search algorithm specified for the Study.
12836    MeasurementSelectionTypeValueValuesEnum: Describe which measurement
12837      selection type will be used
12838    ObservationNoiseValueValuesEnum: The observation noise level of the study.
12839      Currently only supported by the Vizier service. Not supported by
12840      HyperparamterTuningJob or TrainingPipeline.
12841
12842  Fields:
12843    algorithm: The search algorithm specified for the Study.
12844    measurementSelectionType: Describe which measurement selection type will
12845      be used
12846    metrics: Required. Metric specs for the Study.
12847    observationNoise: The observation noise level of the study. Currently only
12848      supported by the Vizier service. Not supported by HyperparamterTuningJob
12849      or TrainingPipeline.
12850    parameters: Required. The set of parameters to tune.
12851  """
12852
12853  class AlgorithmValueValuesEnum(_messages.Enum):
12854    r"""The search algorithm specified for the Study.
12855
12856    Values:
12857      ALGORITHM_UNSPECIFIED: The default algorithm used by AI Platform
12858        Optimization service.
12859      GRID_SEARCH: Simple grid search within the feasible space. To use grid
12860        search, all parameters must be `INTEGER`, `CATEGORICAL`, or
12861        `DISCRETE`.
12862      RANDOM_SEARCH: Simple random search within the feasible space.
12863    """
12864    ALGORITHM_UNSPECIFIED = 0
12865    GRID_SEARCH = 1
12866    RANDOM_SEARCH = 2
12867
12868  class MeasurementSelectionTypeValueValuesEnum(_messages.Enum):
12869    r"""Describe which measurement selection type will be used
12870
12871    Values:
12872      MEASUREMENT_SELECTION_TYPE_UNSPECIFIED: Will be treated as
12873        LAST_MEASUREMENT.
12874      LAST_MEASUREMENT: Use the last measurement reported.
12875      BEST_MEASUREMENT: Use the best measurement reported.
12876    """
12877    MEASUREMENT_SELECTION_TYPE_UNSPECIFIED = 0
12878    LAST_MEASUREMENT = 1
12879    BEST_MEASUREMENT = 2
12880
12881  class ObservationNoiseValueValuesEnum(_messages.Enum):
12882    r"""The observation noise level of the study. Currently only supported by
12883    the Vizier service. Not supported by HyperparamterTuningJob or
12884    TrainingPipeline.
12885
12886    Values:
12887      OBSERVATION_NOISE_UNSPECIFIED: The default noise level chosen by the AI
12888        Platform service.
12889      LOW: AI Platform Vizier assumes that the objective function is (nearly)
12890        perfectly reproducible, and will never repeat the same Trial
12891        parameters.
12892      HIGH: AI Platform Vizier will estimate the amount of noise in metric
12893        evaluations, it may repeat the same Trial parameters more than once.
12894    """
12895    OBSERVATION_NOISE_UNSPECIFIED = 0
12896    LOW = 1
12897    HIGH = 2
12898
12899  algorithm = _messages.EnumField('AlgorithmValueValuesEnum', 1)
12900  measurementSelectionType = _messages.EnumField('MeasurementSelectionTypeValueValuesEnum', 2)
12901  metrics = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecMetricSpec', 3, repeated=True)
12902  observationNoise = _messages.EnumField('ObservationNoiseValueValuesEnum', 4)
12903  parameters = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpec', 5, repeated=True)
12904
12905
12906class GoogleCloudAiplatformV1beta1StudySpecMetricSpec(_messages.Message):
12907  r"""Represents a metric to optimize.
12908
12909  Enums:
12910    GoalValueValuesEnum: Required. The optimization goal of the metric.
12911
12912  Fields:
12913    goal: Required. The optimization goal of the metric.
12914    metricId: Required. The ID of the metric. Must not contain whitespaces and
12915      must be unique amongst all MetricSpecs.
12916  """
12917
12918  class GoalValueValuesEnum(_messages.Enum):
12919    r"""Required. The optimization goal of the metric.
12920
12921    Values:
12922      GOAL_TYPE_UNSPECIFIED: Goal Type will default to maximize.
12923      MAXIMIZE: Maximize the goal metric.
12924      MINIMIZE: Minimize the goal metric.
12925    """
12926    GOAL_TYPE_UNSPECIFIED = 0
12927    MAXIMIZE = 1
12928    MINIMIZE = 2
12929
12930  goal = _messages.EnumField('GoalValueValuesEnum', 1)
12931  metricId = _messages.StringField(2)
12932
12933
12934class GoogleCloudAiplatformV1beta1StudySpecParameterSpec(_messages.Message):
12935  r"""Represents a single parameter to optimize.
12936
12937  Enums:
12938    ScaleTypeValueValuesEnum: How the parameter should be scaled. Leave unset
12939      for `CATEGORICAL` parameters.
12940
12941  Fields:
12942    categoricalValueSpec: The value spec for a 'CATEGORICAL' parameter.
12943    conditionalParameterSpecs: A conditional parameter node is active if the
12944      parameter's value matches the conditional node's parent_value_condition.
12945      If two items in conditional_parameter_specs have the same name, they
12946      must have disjoint parent_value_condition.
12947    discreteValueSpec: The value spec for a 'DISCRETE' parameter.
12948    doubleValueSpec: The value spec for a 'DOUBLE' parameter.
12949    integerValueSpec: The value spec for an 'INTEGER' parameter.
12950    parameterId: Required. The ID of the parameter. Must not contain
12951      whitespaces and must be unique amongst all ParameterSpecs.
12952    scaleType: How the parameter should be scaled. Leave unset for
12953      `CATEGORICAL` parameters.
12954  """
12955
12956  class ScaleTypeValueValuesEnum(_messages.Enum):
12957    r"""How the parameter should be scaled. Leave unset for `CATEGORICAL`
12958    parameters.
12959
12960    Values:
12961      SCALE_TYPE_UNSPECIFIED: By default, no scaling is applied.
12962      UNIT_LINEAR_SCALE: Scales the feasible space to (0, 1) linearly.
12963      UNIT_LOG_SCALE: Scales the feasible space logarithmically to (0, 1). The
12964        entire feasible space must be strictly positive.
12965      UNIT_REVERSE_LOG_SCALE: Scales the feasible space "reverse"
12966        logarithmically to (0, 1). The result is that values close to the top
12967        of the feasible space are spread out more than points near the bottom.
12968        The entire feasible space must be strictly positive.
12969    """
12970    SCALE_TYPE_UNSPECIFIED = 0
12971    UNIT_LINEAR_SCALE = 1
12972    UNIT_LOG_SCALE = 2
12973    UNIT_REVERSE_LOG_SCALE = 3
12974
12975  categoricalValueSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpecCategoricalValueSpec', 1)
12976  conditionalParameterSpecs = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpec', 2, repeated=True)
12977  discreteValueSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpecDiscreteValueSpec', 3)
12978  doubleValueSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpecDoubleValueSpec', 4)
12979  integerValueSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpecIntegerValueSpec', 5)
12980  parameterId = _messages.StringField(6)
12981  scaleType = _messages.EnumField('ScaleTypeValueValuesEnum', 7)
12982
12983
12984class GoogleCloudAiplatformV1beta1StudySpecParameterSpecCategoricalValueSpec(_messages.Message):
12985  r"""Value specification for a parameter in `CATEGORICAL` type.
12986
12987  Fields:
12988    values: Required. The list of possible categories.
12989  """
12990
12991  values = _messages.StringField(1, repeated=True)
12992
12993
12994class GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpec(_messages.Message):
12995  r"""Represents a parameter spec with condition from its parent parameter.
12996
12997  Fields:
12998    parameterSpec: Required. The spec for a conditional parameter.
12999    parentCategoricalValues: The spec for matching values from a parent
13000      parameter of `CATEGORICAL` type.
13001    parentDiscreteValues: The spec for matching values from a parent parameter
13002      of `DISCRETE` type.
13003    parentIntValues: The spec for matching values from a parent parameter of
13004      `INTEGER` type.
13005  """
13006
13007  parameterSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpec', 1)
13008  parentCategoricalValues = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition', 2)
13009  parentDiscreteValues = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition', 3)
13010  parentIntValues = _messages.MessageField('GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecIntValueCondition', 4)
13011
13012
13013class GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition(_messages.Message):
13014  r"""Represents the spec to match categorical values from parent parameter.
13015
13016  Fields:
13017    values: Required. Matches values of the parent parameter of 'CATEGORICAL'
13018      type. All values must exist in `categorical_value_spec` of parent
13019      parameter.
13020  """
13021
13022  values = _messages.StringField(1, repeated=True)
13023
13024
13025class GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition(_messages.Message):
13026  r"""Represents the spec to match discrete values from parent parameter.
13027
13028  Fields:
13029    values: Required. Matches values of the parent parameter of 'DISCRETE'
13030      type. All values must exist in `discrete_value_spec` of parent
13031      parameter. The Epsilon of the value matching is 1e-10.
13032  """
13033
13034  values = _messages.FloatField(1, repeated=True)
13035
13036
13037class GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecIntValueCondition(_messages.Message):
13038  r"""Represents the spec to match integer values from parent parameter.
13039
13040  Fields:
13041    values: Required. Matches values of the parent parameter of 'INTEGER'
13042      type. All values must lie in `integer_value_spec` of parent parameter.
13043  """
13044
13045  values = _messages.IntegerField(1, repeated=True)
13046
13047
13048class GoogleCloudAiplatformV1beta1StudySpecParameterSpecDiscreteValueSpec(_messages.Message):
13049  r"""Value specification for a parameter in `DISCRETE` type.
13050
13051  Fields:
13052    values: Required. A list of possible values. The list should be in
13053      increasing order and at least 1e-10 apart. For instance, this parameter
13054      might have possible settings of 1.5, 2.5, and 4.0. This list should not
13055      contain more than 1,000 values.
13056  """
13057
13058  values = _messages.FloatField(1, repeated=True)
13059
13060
13061class GoogleCloudAiplatformV1beta1StudySpecParameterSpecDoubleValueSpec(_messages.Message):
13062  r"""Value specification for a parameter in `DOUBLE` type.
13063
13064  Fields:
13065    maxValue: Required. Inclusive maximum value of the parameter.
13066    minValue: Required. Inclusive minimum value of the parameter.
13067  """
13068
13069  maxValue = _messages.FloatField(1)
13070  minValue = _messages.FloatField(2)
13071
13072
13073class GoogleCloudAiplatformV1beta1StudySpecParameterSpecIntegerValueSpec(_messages.Message):
13074  r"""Value specification for a parameter in `INTEGER` type.
13075
13076  Fields:
13077    maxValue: Required. Inclusive maximum value of the parameter.
13078    minValue: Required. Inclusive minimum value of the parameter.
13079  """
13080
13081  maxValue = _messages.IntegerField(1)
13082  minValue = _messages.IntegerField(2)
13083
13084
13085class GoogleCloudAiplatformV1beta1UndeployIndexOperationMetadata(_messages.Message):
13086  r"""Runtime operation information for IndexEndpointService.UndeployIndex.
13087
13088  Fields:
13089    genericMetadata: The operation generic information.
13090  """
13091
13092  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
13093
13094
13095class GoogleCloudAiplatformV1beta1UndeployIndexResponse(_messages.Message):
13096  r"""Response message for IndexEndpointService.UndeployIndex."""
13097
13098
13099class GoogleCloudAiplatformV1beta1UndeployModelOperationMetadata(_messages.Message):
13100  r"""Runtime operation information for EndpointService.UndeployModel.
13101
13102  Fields:
13103    genericMetadata: The operation generic information.
13104  """
13105
13106  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
13107
13108
13109class GoogleCloudAiplatformV1beta1UndeployModelResponse(_messages.Message):
13110  r"""Response message for EndpointService.UndeployModel."""
13111
13112
13113class GoogleCloudAiplatformV1beta1UpdateIndexOperationMetadata(_messages.Message):
13114  r"""Runtime operation information for IndexService.UpdateIndex.
13115
13116  Fields:
13117    genericMetadata: The operation generic information.
13118    nearestNeighborSearchOperationMetadata: The operation metadata with regard
13119      to ScaNN Index operation.
13120  """
13121
13122  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
13123  nearestNeighborSearchOperationMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata', 2)
13124
13125
13126class GoogleCloudAiplatformV1beta1UpdateSpecialistPoolOperationMetadata(_messages.Message):
13127  r"""Runtime operation metadata for
13128  SpecialistPoolService.UpdateSpecialistPool.
13129
13130  Fields:
13131    genericMetadata: The operation generic information.
13132    specialistPool: Output only. The name of the SpecialistPool to which the
13133      specialists are being added. Format: `projects/{project_id}/locations/{l
13134      ocation_id}/specialistPools/{specialist_pool}`
13135  """
13136
13137  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
13138  specialistPool = _messages.StringField(2)
13139
13140
13141class GoogleCloudAiplatformV1beta1UploadModelOperationMetadata(_messages.Message):
13142  r"""Details of ModelService.UploadModel operation.
13143
13144  Fields:
13145    genericMetadata: The common part of the operation metadata.
13146  """
13147
13148  genericMetadata = _messages.MessageField('GoogleCloudAiplatformV1beta1GenericOperationMetadata', 1)
13149
13150
13151class GoogleCloudAiplatformV1beta1UploadModelResponse(_messages.Message):
13152  r"""Response message of ModelService.UploadModel operation.
13153
13154  Fields:
13155    model: The name of the uploaded Model resource. Format:
13156      `projects/{project}/locations/{location}/models/{model}`
13157  """
13158
13159  model = _messages.StringField(1)
13160
13161
13162class GoogleCloudAiplatformV1beta1WorkerPoolSpec(_messages.Message):
13163  r"""Represents the spec of a worker pool in a job.
13164
13165  Fields:
13166    containerSpec: The custom container task.
13167    diskSpec: Disk spec.
13168    machineSpec: Optional. Immutable. The specification of a single machine.
13169    pythonPackageSpec: The Python packaged task.
13170    replicaCount: Optional. The number of worker replicas to use for this
13171      worker pool.
13172  """
13173
13174  containerSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1ContainerSpec', 1)
13175  diskSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1DiskSpec', 2)
13176  machineSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1MachineSpec', 3)
13177  pythonPackageSpec = _messages.MessageField('GoogleCloudAiplatformV1beta1PythonPackageSpec', 4)
13178  replicaCount = _messages.IntegerField(5)
13179
13180
13181class GoogleCloudAiplatformV1beta1XraiAttribution(_messages.Message):
13182  r"""An explanation method that redistributes Integrated Gradients
13183  attributions to segmented regions, taking advantage of the model's fully
13184  differentiable structure. Refer to this paper for more details:
13185  https://arxiv.org/abs/1906.02825 Supported only by image Models.
13186
13187  Fields:
13188    smoothGradConfig: Config for SmoothGrad approximation of gradients. When
13189      enabled, the gradients are approximated by averaging the gradients from
13190      noisy samples in the vicinity of the inputs. Adding noise can help
13191      improve the computed gradients. Refer to this paper for more details:
13192      https://arxiv.org/pdf/1706.03825.pdf
13193    stepCount: Required. The number of steps for approximating the path
13194      integral. A good value to start is 50 and gradually increase until the
13195      sum to diff property is met within the desired error range. Valid range
13196      of its value is [1, 100], inclusively.
13197  """
13198
13199  smoothGradConfig = _messages.MessageField('GoogleCloudAiplatformV1beta1SmoothGradConfig', 1)
13200  stepCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
13201
13202
13203class GoogleLongrunningListOperationsResponse(_messages.Message):
13204  r"""The response message for Operations.ListOperations.
13205
13206  Fields:
13207    nextPageToken: The standard List next-page token.
13208    operations: A list of operations that matches the specified filter in the
13209      request.
13210  """
13211
13212  nextPageToken = _messages.StringField(1)
13213  operations = _messages.MessageField('GoogleLongrunningOperation', 2, repeated=True)
13214
13215
13216class GoogleLongrunningOperation(_messages.Message):
13217  r"""This resource represents a long-running operation that is the result of
13218  a network API call.
13219
13220  Messages:
13221    MetadataValue: Service-specific metadata associated with the operation. It
13222      typically contains progress information and common metadata such as
13223      create time. Some services might not provide such metadata. Any method
13224      that returns a long-running operation should document the metadata type,
13225      if any.
13226    ResponseValue: The normal response of the operation in case of success. If
13227      the original method returns no data on success, such as `Delete`, the
13228      response is `google.protobuf.Empty`. If the original method is standard
13229      `Get`/`Create`/`Update`, the response should be the resource. For other
13230      methods, the response should have the type `XxxResponse`, where `Xxx` is
13231      the original method name. For example, if the original method name is
13232      `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
13233
13234  Fields:
13235    done: If the value is `false`, it means the operation is still in
13236      progress. If `true`, the operation is completed, and either `error` or
13237      `response` is available.
13238    error: The error result of the operation in case of failure or
13239      cancellation.
13240    metadata: Service-specific metadata associated with the operation. It
13241      typically contains progress information and common metadata such as
13242      create time. Some services might not provide such metadata. Any method
13243      that returns a long-running operation should document the metadata type,
13244      if any.
13245    name: The server-assigned name, which is only unique within the same
13246      service that originally returns it. If you use the default HTTP mapping,
13247      the `name` should be a resource name ending with
13248      `operations/{unique_id}`.
13249    response: The normal response of the operation in case of success. If the
13250      original method returns no data on success, such as `Delete`, the
13251      response is `google.protobuf.Empty`. If the original method is standard
13252      `Get`/`Create`/`Update`, the response should be the resource. For other
13253      methods, the response should have the type `XxxResponse`, where `Xxx` is
13254      the original method name. For example, if the original method name is
13255      `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
13256  """
13257
13258  @encoding.MapUnrecognizedFields('additionalProperties')
13259  class MetadataValue(_messages.Message):
13260    r"""Service-specific metadata associated with the operation. It typically
13261    contains progress information and common metadata such as create time.
13262    Some services might not provide such metadata. Any method that returns a
13263    long-running operation should document the metadata type, if any.
13264
13265    Messages:
13266      AdditionalProperty: An additional property for a MetadataValue object.
13267
13268    Fields:
13269      additionalProperties: Properties of the object. Contains field @type
13270        with type URL.
13271    """
13272
13273    class AdditionalProperty(_messages.Message):
13274      r"""An additional property for a MetadataValue object.
13275
13276      Fields:
13277        key: Name of the additional property.
13278        value: A extra_types.JsonValue attribute.
13279      """
13280
13281      key = _messages.StringField(1)
13282      value = _messages.MessageField('extra_types.JsonValue', 2)
13283
13284    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
13285
13286  @encoding.MapUnrecognizedFields('additionalProperties')
13287  class ResponseValue(_messages.Message):
13288    r"""The normal response of the operation in case of success. If the
13289    original method returns no data on success, such as `Delete`, the response
13290    is `google.protobuf.Empty`. If the original method is standard
13291    `Get`/`Create`/`Update`, the response should be the resource. For other
13292    methods, the response should have the type `XxxResponse`, where `Xxx` is
13293    the original method name. For example, if the original method name is
13294    `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
13295
13296    Messages:
13297      AdditionalProperty: An additional property for a ResponseValue object.
13298
13299    Fields:
13300      additionalProperties: Properties of the object. Contains field @type
13301        with type URL.
13302    """
13303
13304    class AdditionalProperty(_messages.Message):
13305      r"""An additional property for a ResponseValue object.
13306
13307      Fields:
13308        key: Name of the additional property.
13309        value: A extra_types.JsonValue attribute.
13310      """
13311
13312      key = _messages.StringField(1)
13313      value = _messages.MessageField('extra_types.JsonValue', 2)
13314
13315    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
13316
13317  done = _messages.BooleanField(1)
13318  error = _messages.MessageField('GoogleRpcStatus', 2)
13319  metadata = _messages.MessageField('MetadataValue', 3)
13320  name = _messages.StringField(4)
13321  response = _messages.MessageField('ResponseValue', 5)
13322
13323
13324class GoogleProtobufEmpty(_messages.Message):
13325  r"""A generic empty message that you can re-use to avoid defining duplicated
13326  empty messages in your APIs. A typical example is to use it as the request
13327  or the response type of an API method. For instance: service Foo { rpc
13328  Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
13329  representation for `Empty` is empty JSON object `{}`.
13330  """
13331
13332
13333
13334class GoogleRpcStatus(_messages.Message):
13335  r"""The `Status` type defines a logical error model that is suitable for
13336  different programming environments, including REST APIs and RPC APIs. It is
13337  used by [gRPC](https://github.com/grpc). Each `Status` message contains
13338  three pieces of data: error code, error message, and error details. You can
13339  find out more about this error model and how to work with it in the [API
13340  Design Guide](https://cloud.google.com/apis/design/errors).
13341
13342  Messages:
13343    DetailsValueListEntry: A DetailsValueListEntry object.
13344
13345  Fields:
13346    code: The status code, which should be an enum value of google.rpc.Code.
13347    details: A list of messages that carry the error details. There is a
13348      common set of message types for APIs to use.
13349    message: A developer-facing error message, which should be in English. Any
13350      user-facing error message should be localized and sent in the
13351      google.rpc.Status.details field, or localized by the client.
13352  """
13353
13354  @encoding.MapUnrecognizedFields('additionalProperties')
13355  class DetailsValueListEntry(_messages.Message):
13356    r"""A DetailsValueListEntry object.
13357
13358    Messages:
13359      AdditionalProperty: An additional property for a DetailsValueListEntry
13360        object.
13361
13362    Fields:
13363      additionalProperties: Properties of the object. Contains field @type
13364        with type URL.
13365    """
13366
13367    class AdditionalProperty(_messages.Message):
13368      r"""An additional property for a DetailsValueListEntry object.
13369
13370      Fields:
13371        key: Name of the additional property.
13372        value: A extra_types.JsonValue attribute.
13373      """
13374
13375      key = _messages.StringField(1)
13376      value = _messages.MessageField('extra_types.JsonValue', 2)
13377
13378    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
13379
13380  code = _messages.IntegerField(1, variant=_messages.Variant.INT32)
13381  details = _messages.MessageField('DetailsValueListEntry', 2, repeated=True)
13382  message = _messages.StringField(3)
13383
13384
13385class GoogleTypeColor(_messages.Message):
13386  r"""Represents a color in the RGBA color space. This representation is
13387  designed for simplicity of conversion to/from color representations in
13388  various languages over compactness; for example, the fields of this
13389  representation can be trivially provided to the constructor of
13390  "java.awt.Color" in Java; it can also be trivially provided to UIColor's
13391  "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little
13392  work, it can be easily formatted into a CSS "rgba()" string in JavaScript,
13393  as well. Note: this proto does not carry information about the absolute
13394  color space that should be used to interpret the RGB value (e.g. sRGB, Adobe
13395  RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB
13396  color space. Note: when color equality needs to be decided, implementations,
13397  unless documented otherwise, will treat two colors to be equal if all their
13398  red, green, blue and alpha values each differ by at most 1e-5. Example
13399  (Java): import com.google.type.Color; // ... public static java.awt.Color
13400  fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ?
13401  protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color(
13402  protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); }
13403  public static Color toProto(java.awt.Color color) { float red = (float)
13404  color.getRed(); float green = (float) color.getGreen(); float blue = (float)
13405  color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder =
13406  Color .newBuilder() .setRed(red / denominator) .setGreen(green /
13407  denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if
13408  (alpha != 255) { result.setAlpha( FloatValue .newBuilder()
13409  .setValue(((float) alpha) / denominator) .build()); } return
13410  resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static
13411  UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float
13412  green = [protocolor green]; float blue = [protocolor blue]; FloatValue*
13413  alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper !=
13414  nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red
13415  green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color)
13416  { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green
13417  blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc]
13418  init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue];
13419  if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; }
13420  [result autorelease]; return result; } // ... Example (JavaScript): // ...
13421  var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red ||
13422  0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue
13423  || 0.0; var red = Math.floor(redFrac * 255); var green =
13424  Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if
13425  (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var
13426  alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green,
13427  blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
13428  }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new
13429  Number((red << 16) | (green << 8) | blue); var hexString =
13430  rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var
13431  resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) {
13432  resultBuilder.push('0'); } resultBuilder.push(hexString); return
13433  resultBuilder.join(''); }; // ...
13434
13435  Fields:
13436    alpha: The fraction of this color that should be applied to the pixel.
13437      That is, the final pixel color is defined by the equation: pixel color =
13438      alpha * (this color) + (1.0 - alpha) * (background color) This means
13439      that a value of 1.0 corresponds to a solid color, whereas a value of 0.0
13440      corresponds to a completely transparent color. This uses a wrapper
13441      message rather than a simple float scalar so that it is possible to
13442      distinguish between a default value and the value being unset. If
13443      omitted, this color object is to be rendered as a solid color (as if the
13444      alpha value had been explicitly given with a value of 1.0).
13445    blue: The amount of blue in the color as a value in the interval [0, 1].
13446    green: The amount of green in the color as a value in the interval [0, 1].
13447    red: The amount of red in the color as a value in the interval [0, 1].
13448  """
13449
13450  alpha = _messages.FloatField(1, variant=_messages.Variant.FLOAT)
13451  blue = _messages.FloatField(2, variant=_messages.Variant.FLOAT)
13452  green = _messages.FloatField(3, variant=_messages.Variant.FLOAT)
13453  red = _messages.FloatField(4, variant=_messages.Variant.FLOAT)
13454
13455
13456class GoogleTypeMoney(_messages.Message):
13457  r"""Represents an amount of money with its currency type.
13458
13459  Fields:
13460    currencyCode: The three-letter currency code defined in ISO 4217.
13461    nanos: Number of nano (10^-9) units of the amount. The value must be
13462      between -999,999,999 and +999,999,999 inclusive. If `units` is positive,
13463      `nanos` must be positive or zero. If `units` is zero, `nanos` can be
13464      positive, zero, or negative. If `units` is negative, `nanos` must be
13465      negative or zero. For example $-1.75 is represented as `units`=-1 and
13466      `nanos`=-750,000,000.
13467    units: The whole units of the amount. For example if `currencyCode` is
13468      `"USD"`, then 1 unit is one US dollar.
13469  """
13470
13471  currencyCode = _messages.StringField(1)
13472  nanos = _messages.IntegerField(2, variant=_messages.Variant.INT32)
13473  units = _messages.IntegerField(3)
13474
13475
13476class StandardQueryParameters(_messages.Message):
13477  r"""Query parameters accepted by all methods.
13478
13479  Enums:
13480    FXgafvValueValuesEnum: V1 error format.
13481    AltValueValuesEnum: Data format for response.
13482
13483  Fields:
13484    f__xgafv: V1 error format.
13485    access_token: OAuth access token.
13486    alt: Data format for response.
13487    callback: JSONP
13488    fields: Selector specifying which fields to include in a partial response.
13489    key: API key. Your API key identifies your project and provides you with
13490      API access, quota, and reports. Required unless you provide an OAuth 2.0
13491      token.
13492    oauth_token: OAuth 2.0 token for the current user.
13493    prettyPrint: Returns response with indentations and line breaks.
13494    quotaUser: Available to use for quota purposes for server-side
13495      applications. Can be any arbitrary string assigned to a user, but should
13496      not exceed 40 characters.
13497    trace: A tracing token of the form "token:<tokenid>" to include in api
13498      requests.
13499    uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
13500    upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
13501  """
13502
13503  class AltValueValuesEnum(_messages.Enum):
13504    r"""Data format for response.
13505
13506    Values:
13507      json: Responses with Content-Type of application/json
13508      media: Media download with context-dependent Content-Type
13509      proto: Responses with Content-Type of application/x-protobuf
13510    """
13511    json = 0
13512    media = 1
13513    proto = 2
13514
13515  class FXgafvValueValuesEnum(_messages.Enum):
13516    r"""V1 error format.
13517
13518    Values:
13519      _1: v1 error format
13520      _2: v2 error format
13521    """
13522    _1 = 0
13523    _2 = 1
13524
13525  f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1)
13526  access_token = _messages.StringField(2)
13527  alt = _messages.EnumField('AltValueValuesEnum', 3, default='json')
13528  callback = _messages.StringField(4)
13529  fields = _messages.StringField(5)
13530  key = _messages.StringField(6)
13531  oauth_token = _messages.StringField(7)
13532  prettyPrint = _messages.BooleanField(8, default=True)
13533  quotaUser = _messages.StringField(9)
13534  trace = _messages.StringField(10)
13535  uploadType = _messages.StringField(11)
13536  upload_protocol = _messages.StringField(12)
13537
13538
13539encoding.AddCustomJsonFieldMapping(
13540    StandardQueryParameters, 'f__xgafv', '$.xgafv')
13541encoding.AddCustomJsonEnumMapping(
13542    StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1')
13543encoding.AddCustomJsonEnumMapping(
13544    StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2')
13545