google-cloud-ai_platform-v1 0.18.0 → 0.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +36 -46
- data/lib/google/cloud/ai_platform/v1/dataset_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +20 -22
- data/lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +6 -6
- data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +176 -68
- data/lib/google/cloud/ai_platform/v1/featurestore_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +24 -26
- data/lib/google/cloud/ai_platform/v1/index_endpoint_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/index_service/client.rb +16 -18
- data/lib/google/cloud/ai_platform/v1/index_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/job_service/client.rb +777 -60
- data/lib/google/cloud/ai_platform/v1/job_service/credentials.rb +2 -1
- data/lib/google/cloud/ai_platform/v1/job_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/job_service/paths.rb +40 -0
- data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +52 -62
- data/lib/google/cloud/ai_platform/v1/metadata_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +8 -10
- data/lib/google/cloud/ai_platform/v1/migration_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/model_service/client.rb +254 -42
- data/lib/google/cloud/ai_platform/v1/model_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +16 -20
- data/lib/google/cloud/ai_platform/v1/pipeline_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +16 -18
- data/lib/google/cloud/ai_platform/v1/specialist_pool_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +50 -60
- data/lib/google/cloud/ai_platform/v1/tensorboard_service/operations.rb +12 -14
- data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
- data/lib/google/cloud/ai_platform/v1/vizier_service/client.rb +17 -21
- data/lib/google/cloud/ai_platform/v1/vizier_service/operations.rb +12 -14
- data/lib/google/cloud/aiplatform/v1/accelerator_type_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +9 -0
- data/lib/google/cloud/aiplatform/v1/dataset_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/endpoint_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/evaluated_annotation_pb.rb +63 -0
- data/lib/google/cloud/aiplatform/v1/featurestore_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/featurestore_service_pb.rb +49 -0
- data/lib/google/cloud/aiplatform/v1/featurestore_service_services_pb.rb +11 -0
- data/lib/google/cloud/aiplatform/v1/index_endpoint_pb.rb +2 -0
- data/lib/google/cloud/aiplatform/v1/index_endpoint_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/index_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/job_service_pb.rb +46 -0
- data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +26 -0
- data/lib/google/cloud/aiplatform/v1/metadata_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/model_evaluation_slice_pb.rb +28 -0
- data/lib/google/cloud/aiplatform/v1/model_pb.rb +5 -0
- data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +31 -0
- data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +12 -2
- data/lib/google/cloud/aiplatform/v1/nas_job_pb.rb +123 -0
- data/lib/google/cloud/aiplatform/v1/pipeline_job_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/pipeline_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/service_networking_pb.rb +25 -0
- data/lib/google/cloud/aiplatform/v1/specialist_pool_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/study_pb.rb +6 -0
- data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +1 -0
- data/lib/google/cloud/aiplatform/v1/vizier_service_services_pb.rb +1 -1
- data/proto_docs/google/cloud/aiplatform/v1/accelerator_type.rb +4 -0
- data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +14 -1
- data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +23 -0
- data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +8 -2
- data/proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb +190 -0
- data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +9 -0
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb +6 -8
- data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +128 -0
- data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +10 -3
- data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +166 -0
- data/proto_docs/google/cloud/aiplatform/v1/job_state.rb +2 -5
- data/proto_docs/google/cloud/aiplatform/v1/model.rb +31 -11
- data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +6 -5
- data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +131 -0
- data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +83 -0
- data/proto_docs/google/cloud/aiplatform/v1/nas_job.rb +306 -0
- data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +5 -0
- data/proto_docs/google/cloud/aiplatform/v1/service_networking.rb +39 -0
- data/proto_docs/google/cloud/aiplatform/v1/study.rb +22 -0
- data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +2 -1
- data/proto_docs/google/type/interval.rb +45 -0
- metadata +19 -11
@@ -365,6 +365,172 @@ module Google
|
|
365
365
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
366
366
|
end
|
367
367
|
|
368
|
+
# Request message for
|
369
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#create_nas_job JobService.CreateNasJob}.
|
370
|
+
# @!attribute [rw] parent
|
371
|
+
# @return [::String]
|
372
|
+
# Required. The resource name of the Location to create the NasJob in.
|
373
|
+
# Format: `projects/{project}/locations/{location}`
|
374
|
+
# @!attribute [rw] nas_job
|
375
|
+
# @return [::Google::Cloud::AIPlatform::V1::NasJob]
|
376
|
+
# Required. The NasJob to create.
|
377
|
+
class CreateNasJobRequest
|
378
|
+
include ::Google::Protobuf::MessageExts
|
379
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
380
|
+
end
|
381
|
+
|
382
|
+
# Request message for
|
383
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#get_nas_job JobService.GetNasJob}.
|
384
|
+
# @!attribute [rw] name
|
385
|
+
# @return [::String]
|
386
|
+
# Required. The name of the NasJob resource.
|
387
|
+
# Format:
|
388
|
+
# `projects/{project}/locations/{location}/nasJobs/{nas_job}`
|
389
|
+
class GetNasJobRequest
|
390
|
+
include ::Google::Protobuf::MessageExts
|
391
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
392
|
+
end
|
393
|
+
|
394
|
+
# Request message for
|
395
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_nas_jobs JobService.ListNasJobs}.
|
396
|
+
# @!attribute [rw] parent
|
397
|
+
# @return [::String]
|
398
|
+
# Required. The resource name of the Location to list the NasJobs
|
399
|
+
# from. Format: `projects/{project}/locations/{location}`
|
400
|
+
# @!attribute [rw] filter
|
401
|
+
# @return [::String]
|
402
|
+
# The standard list filter.
|
403
|
+
#
|
404
|
+
# Supported fields:
|
405
|
+
#
|
406
|
+
# * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
|
407
|
+
# * `state` supports `=`, `!=` comparisons.
|
408
|
+
# * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
|
409
|
+
# `create_time` must be in RFC 3339 format.
|
410
|
+
# * `labels` supports general map functions that is:
|
411
|
+
# `labels.key=value` - key:value equality
|
412
|
+
# `labels.key:* - key existence
|
413
|
+
#
|
414
|
+
# Some examples of using the filter are:
|
415
|
+
#
|
416
|
+
# * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
|
417
|
+
# * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
|
418
|
+
# * `NOT display_name="my_job"`
|
419
|
+
# * `create_time>"2021-05-18T00:00:00Z"`
|
420
|
+
# * `labels.keyA=valueA`
|
421
|
+
# * `labels.keyB:*`
|
422
|
+
# @!attribute [rw] page_size
|
423
|
+
# @return [::Integer]
|
424
|
+
# The standard list page size.
|
425
|
+
# @!attribute [rw] page_token
|
426
|
+
# @return [::String]
|
427
|
+
# The standard list page token.
|
428
|
+
# Typically obtained via
|
429
|
+
# {::Google::Cloud::AIPlatform::V1::ListNasJobsResponse#next_page_token ListNasJobsResponse.next_page_token}
|
430
|
+
# of the previous
|
431
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_nas_jobs JobService.ListNasJobs}
|
432
|
+
# call.
|
433
|
+
# @!attribute [rw] read_mask
|
434
|
+
# @return [::Google::Protobuf::FieldMask]
|
435
|
+
# Mask specifying which fields to read.
|
436
|
+
class ListNasJobsRequest
|
437
|
+
include ::Google::Protobuf::MessageExts
|
438
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
439
|
+
end
|
440
|
+
|
441
|
+
# Response message for
|
442
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_nas_jobs JobService.ListNasJobs}
|
443
|
+
# @!attribute [rw] nas_jobs
|
444
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::NasJob>]
|
445
|
+
# List of NasJobs in the requested page.
|
446
|
+
# {::Google::Cloud::AIPlatform::V1::NasJob#nas_job_output NasJob.nas_job_output}
|
447
|
+
# of the jobs will not be returned.
|
448
|
+
# @!attribute [rw] next_page_token
|
449
|
+
# @return [::String]
|
450
|
+
# A token to retrieve the next page of results.
|
451
|
+
# Pass to
|
452
|
+
# {::Google::Cloud::AIPlatform::V1::ListNasJobsRequest#page_token ListNasJobsRequest.page_token}
|
453
|
+
# to obtain that page.
|
454
|
+
class ListNasJobsResponse
|
455
|
+
include ::Google::Protobuf::MessageExts
|
456
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
457
|
+
end
|
458
|
+
|
459
|
+
# Request message for
|
460
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_nas_job JobService.DeleteNasJob}.
|
461
|
+
# @!attribute [rw] name
|
462
|
+
# @return [::String]
|
463
|
+
# Required. The name of the NasJob resource to be deleted.
|
464
|
+
# Format:
|
465
|
+
# `projects/{project}/locations/{location}/nasJobs/{nas_job}`
|
466
|
+
class DeleteNasJobRequest
|
467
|
+
include ::Google::Protobuf::MessageExts
|
468
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
469
|
+
end
|
470
|
+
|
471
|
+
# Request message for
|
472
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_nas_job JobService.CancelNasJob}.
|
473
|
+
# @!attribute [rw] name
|
474
|
+
# @return [::String]
|
475
|
+
# Required. The name of the NasJob to cancel.
|
476
|
+
# Format:
|
477
|
+
# `projects/{project}/locations/{location}/nasJobs/{nas_job}`
|
478
|
+
class CancelNasJobRequest
|
479
|
+
include ::Google::Protobuf::MessageExts
|
480
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
481
|
+
end
|
482
|
+
|
483
|
+
# Request message for
|
484
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#get_nas_trial_detail JobService.GetNasTrialDetail}.
|
485
|
+
# @!attribute [rw] name
|
486
|
+
# @return [::String]
|
487
|
+
# Required. The name of the NasTrialDetail resource.
|
488
|
+
# Format:
|
489
|
+
# `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
|
490
|
+
class GetNasTrialDetailRequest
|
491
|
+
include ::Google::Protobuf::MessageExts
|
492
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
493
|
+
end
|
494
|
+
|
495
|
+
# Request message for
|
496
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_nas_trial_details JobService.ListNasTrialDetails}.
|
497
|
+
# @!attribute [rw] parent
|
498
|
+
# @return [::String]
|
499
|
+
# Required. The name of the NasJob resource.
|
500
|
+
# Format:
|
501
|
+
# `projects/{project}/locations/{location}/nasJobs/{nas_job}`
|
502
|
+
# @!attribute [rw] page_size
|
503
|
+
# @return [::Integer]
|
504
|
+
# The standard list page size.
|
505
|
+
# @!attribute [rw] page_token
|
506
|
+
# @return [::String]
|
507
|
+
# The standard list page token.
|
508
|
+
# Typically obtained via
|
509
|
+
# {::Google::Cloud::AIPlatform::V1::ListNasTrialDetailsResponse#next_page_token ListNasTrialDetailsResponse.next_page_token}
|
510
|
+
# of the previous
|
511
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_nas_trial_details JobService.ListNasTrialDetails}
|
512
|
+
# call.
|
513
|
+
class ListNasTrialDetailsRequest
|
514
|
+
include ::Google::Protobuf::MessageExts
|
515
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
516
|
+
end
|
517
|
+
|
518
|
+
# Response message for
|
519
|
+
# {::Google::Cloud::AIPlatform::V1::JobService::Client#list_nas_trial_details JobService.ListNasTrialDetails}
|
520
|
+
# @!attribute [rw] nas_trial_details
|
521
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::NasTrialDetail>]
|
522
|
+
# List of top NasTrials in the requested page.
|
523
|
+
# @!attribute [rw] next_page_token
|
524
|
+
# @return [::String]
|
525
|
+
# A token to retrieve the next page of results.
|
526
|
+
# Pass to
|
527
|
+
# {::Google::Cloud::AIPlatform::V1::ListNasTrialDetailsRequest#page_token ListNasTrialDetailsRequest.page_token}
|
528
|
+
# to obtain that page.
|
529
|
+
class ListNasTrialDetailsResponse
|
530
|
+
include ::Google::Protobuf::MessageExts
|
531
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
532
|
+
end
|
533
|
+
|
368
534
|
# Request message for
|
369
535
|
# {::Google::Cloud::AIPlatform::V1::JobService::Client#create_batch_prediction_job JobService.CreateBatchPredictionJob}.
|
370
536
|
# @!attribute [rw] parent
|
@@ -54,11 +54,8 @@ module Google
|
|
54
54
|
# The job has expired.
|
55
55
|
JOB_STATE_EXPIRED = 9
|
56
56
|
|
57
|
-
# The job is being updated.
|
58
|
-
#
|
59
|
-
# the update operation fails, the job goes back to RUNNING state with error
|
60
|
-
# messages written to [ModelDeploymentMonitoringJob.partial_errors][] field
|
61
|
-
# if it is a ModelDeploymentMonitoringJob.
|
57
|
+
# The job is being updated. Only jobs in the `RUNNING` state can be updated.
|
58
|
+
# After updating, the job goes back to the `RUNNING` state.
|
62
59
|
JOB_STATE_UPDATING = 10
|
63
60
|
end
|
64
61
|
end
|
@@ -98,11 +98,11 @@ module Google
|
|
98
98
|
# deploying this Model. The specification is ingested upon
|
99
99
|
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#upload_model ModelService.UploadModel},
|
100
100
|
# and all binaries it contains are copied and stored internally by Vertex AI.
|
101
|
-
# Not present for AutoML Models.
|
101
|
+
# Not present for AutoML Models or Large Models.
|
102
102
|
# @!attribute [rw] artifact_uri
|
103
103
|
# @return [::String]
|
104
104
|
# Immutable. The path to the directory containing the Model artifact and any
|
105
|
-
# of its supporting files. Not present for AutoML Models.
|
105
|
+
# of its supporting files. Not present for AutoML Models or Large Models.
|
106
106
|
# @!attribute [r] supported_deployment_resources_types
|
107
107
|
# @return [::Array<::Google::Cloud::AIPlatform::V1::Model::DeploymentResourcesType>]
|
108
108
|
# Output only. When this Model is deployed, its prediction resources are
|
@@ -224,11 +224,13 @@ module Google
|
|
224
224
|
# @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
|
225
225
|
# The default explanation specification for this Model.
|
226
226
|
#
|
227
|
-
# The Model can be used for
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
227
|
+
# The Model can be used for
|
228
|
+
# [requesting
|
229
|
+
# explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after
|
230
|
+
# being {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model deployed} if
|
231
|
+
# it is populated. The Model can be used for [batch
|
232
|
+
# explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
|
233
|
+
# if it is populated.
|
232
234
|
#
|
233
235
|
# All fields of the explanation_spec can be overridden by
|
234
236
|
# {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
|
@@ -239,13 +241,16 @@ module Google
|
|
239
241
|
# of {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob}.
|
240
242
|
#
|
241
243
|
# If the default explanation specification is not set for this Model, this
|
242
|
-
# Model can still be used for
|
243
|
-
#
|
244
|
+
# Model can still be used for
|
245
|
+
# [requesting
|
246
|
+
# explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by
|
247
|
+
# setting
|
244
248
|
# {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
|
245
249
|
# of
|
246
250
|
# {::Google::Cloud::AIPlatform::V1::DeployModelRequest#deployed_model DeployModelRequest.deployed_model}
|
247
|
-
# and for [batch
|
248
|
-
#
|
251
|
+
# and for [batch
|
252
|
+
# explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
|
253
|
+
# by setting
|
249
254
|
# {::Google::Cloud::AIPlatform::V1::BatchPredictionJob#explanation_spec explanation_spec}
|
250
255
|
# of {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob}.
|
251
256
|
# @!attribute [rw] etag
|
@@ -269,6 +274,10 @@ module Google
|
|
269
274
|
# @return [::Google::Cloud::AIPlatform::V1::ModelSourceInfo]
|
270
275
|
# Output only. Source of a model. It can either be automl training pipeline,
|
271
276
|
# custom training pipeline, BigQuery ML, or existing Vertex AI Model.
|
277
|
+
# @!attribute [r] original_model_info
|
278
|
+
# @return [::Google::Cloud::AIPlatform::V1::Model::OriginalModelInfo]
|
279
|
+
# Output only. If this Model is a copy of another Model, this contains info
|
280
|
+
# about the original.
|
272
281
|
# @!attribute [r] metadata_artifact
|
273
282
|
# @return [::String]
|
274
283
|
# Output only. The resource name of the Artifact that was created in
|
@@ -331,6 +340,17 @@ module Google
|
|
331
340
|
end
|
332
341
|
end
|
333
342
|
|
343
|
+
# Contains information about the original Model if this Model is a copy.
|
344
|
+
# @!attribute [r] model
|
345
|
+
# @return [::String]
|
346
|
+
# Output only. The resource name of the Model this Model is a copy of,
|
347
|
+
# including the revision. Format:
|
348
|
+
# `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
|
349
|
+
class OriginalModelInfo
|
350
|
+
include ::Google::Protobuf::MessageExts
|
351
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
352
|
+
end
|
353
|
+
|
334
354
|
# @!attribute [rw] key
|
335
355
|
# @return [::String]
|
336
356
|
# @!attribute [rw] value
|
@@ -52,8 +52,8 @@ module Google
|
|
52
52
|
# @return [::String]
|
53
53
|
# Points to a YAML file stored on Google Cloud Storage describing
|
54
54
|
# [EvaluatedDataItemView.data_item_payload][] and
|
55
|
-
#
|
56
|
-
# OpenAPI 3.0.2 [Schema
|
55
|
+
# {::Google::Cloud::AIPlatform::V1::EvaluatedAnnotation#data_item_payload EvaluatedAnnotation.data_item_payload}.
|
56
|
+
# The schema is defined as an OpenAPI 3.0.2 [Schema
|
57
57
|
# Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
|
58
58
|
#
|
59
59
|
# This field is not populated if there are neither EvaluatedDataItemViews nor
|
@@ -63,9 +63,10 @@ module Google
|
|
63
63
|
# Points to a YAML file stored on Google Cloud Storage describing
|
64
64
|
# [EvaluatedDataItemView.predictions][],
|
65
65
|
# [EvaluatedDataItemView.ground_truths][],
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
66
|
+
# {::Google::Cloud::AIPlatform::V1::EvaluatedAnnotation#predictions EvaluatedAnnotation.predictions},
|
67
|
+
# and
|
68
|
+
# {::Google::Cloud::AIPlatform::V1::EvaluatedAnnotation#ground_truths EvaluatedAnnotation.ground_truths}.
|
69
|
+
# The schema is defined as an OpenAPI 3.0.2 [Schema
|
69
70
|
# Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
|
70
71
|
#
|
71
72
|
# This field is not populated if there are neither EvaluatedDataItemViews nor
|
@@ -44,6 +44,12 @@ module Google
|
|
44
44
|
# @!attribute [r] create_time
|
45
45
|
# @return [::Google::Protobuf::Timestamp]
|
46
46
|
# Output only. Timestamp when this ModelEvaluationSlice was created.
|
47
|
+
# @!attribute [r] model_explanation
|
48
|
+
# @return [::Google::Cloud::AIPlatform::V1::ModelExplanation]
|
49
|
+
# Output only. Aggregated explanation metrics for the Model's prediction
|
50
|
+
# output over the data this ModelEvaluation uses. This field is populated
|
51
|
+
# only if the Model is evaluated with explanations, and only for tabular
|
52
|
+
# Models.
|
47
53
|
class ModelEvaluationSlice
|
48
54
|
include ::Google::Protobuf::MessageExts
|
49
55
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -58,12 +64,137 @@ module Google
|
|
58
64
|
# {::Google::Cloud::AIPlatform::V1::AnnotationSpec#display_name AnnotationSpec.display_name}
|
59
65
|
# equals to
|
60
66
|
# {::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice#value value}.
|
67
|
+
# * `slice`: This slice is a user customized slice defined by its
|
68
|
+
# SliceSpec.
|
61
69
|
# @!attribute [r] value
|
62
70
|
# @return [::String]
|
63
71
|
# Output only. The value of the dimension in this slice.
|
72
|
+
# @!attribute [r] slice_spec
|
73
|
+
# @return [::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice::SliceSpec]
|
74
|
+
# Output only. Specification for how the data was sliced.
|
64
75
|
class Slice
|
65
76
|
include ::Google::Protobuf::MessageExts
|
66
77
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
78
|
+
|
79
|
+
# Specification for how the data should be sliced.
|
80
|
+
# @!attribute [rw] configs
|
81
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice::SliceSpec::SliceConfig}]
|
82
|
+
# Mapping configuration for this SliceSpec.
|
83
|
+
# The key is the name of the feature.
|
84
|
+
# By default, the key will be prefixed by "instance" as a dictionary
|
85
|
+
# prefix for Vertex Batch Predictions output format.
|
86
|
+
class SliceSpec
|
87
|
+
include ::Google::Protobuf::MessageExts
|
88
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
89
|
+
|
90
|
+
# Specification message containing the config for this SliceSpec.
|
91
|
+
# When `kind` is selected as `value` and/or `range`, only a single slice
|
92
|
+
# will be computed.
|
93
|
+
# When `all_values` is present, a separate slice will be computed for
|
94
|
+
# each possible label/value for the corresponding key in `config`.
|
95
|
+
# Examples, with feature zip_code with values 12345, 23334, 88888 and
|
96
|
+
# feature country with values "US", "Canada", "Mexico" in the dataset:
|
97
|
+
#
|
98
|
+
# Example 1:
|
99
|
+
#
|
100
|
+
# {
|
101
|
+
# "zip_code": { "value": { "float_value": 12345.0 } }
|
102
|
+
# }
|
103
|
+
#
|
104
|
+
# A single slice for any data with zip_code 12345 in the dataset.
|
105
|
+
#
|
106
|
+
# Example 2:
|
107
|
+
#
|
108
|
+
# {
|
109
|
+
# "zip_code": { "range": { "low": 12345, "high": 20000 } }
|
110
|
+
# }
|
111
|
+
#
|
112
|
+
# A single slice containing data where the zip_codes between 12345 and
|
113
|
+
# 20000 For this example, data with the zip_code of 12345 will be in this
|
114
|
+
# slice.
|
115
|
+
#
|
116
|
+
# Example 3:
|
117
|
+
#
|
118
|
+
# {
|
119
|
+
# "zip_code": { "range": { "low": 10000, "high": 20000 } },
|
120
|
+
# "country": { "value": { "string_value": "US" } }
|
121
|
+
# }
|
122
|
+
#
|
123
|
+
# A single slice containing data where the zip_codes between 10000 and
|
124
|
+
# 20000 has the country "US". For this example, data with the zip_code of
|
125
|
+
# 12345 and country "US" will be in this slice.
|
126
|
+
#
|
127
|
+
# Example 4:
|
128
|
+
#
|
129
|
+
# { "country": {"all_values": { "value": true } } }
|
130
|
+
#
|
131
|
+
# Three slices are computed, one for each unique country in the dataset.
|
132
|
+
#
|
133
|
+
# Example 5:
|
134
|
+
#
|
135
|
+
# {
|
136
|
+
# "country": { "all_values": { "value": true } },
|
137
|
+
# "zip_code": { "value": { "float_value": 12345.0 } }
|
138
|
+
# }
|
139
|
+
#
|
140
|
+
# Three slices are computed, one for each unique country in the dataset
|
141
|
+
# where the zip_code is also 12345. For this example, data with zip_code
|
142
|
+
# 12345 and country "US" will be in one slice, zip_code 12345 and country
|
143
|
+
# "Canada" in another slice, and zip_code 12345 and country "Mexico" in
|
144
|
+
# another slice, totaling 3 slices.
|
145
|
+
# @!attribute [rw] value
|
146
|
+
# @return [::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice::SliceSpec::Value]
|
147
|
+
# A unique specific value for a given feature.
|
148
|
+
# Example: `{ "value": { "string_value": "12345" } }`
|
149
|
+
# @!attribute [rw] range
|
150
|
+
# @return [::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice::SliceSpec::Range]
|
151
|
+
# A range of values for a numerical feature.
|
152
|
+
# Example: `{"range":{"low":10000.0,"high":50000.0}}`
|
153
|
+
# will capture 12345 and 23334 in the slice.
|
154
|
+
# @!attribute [rw] all_values
|
155
|
+
# @return [::Google::Protobuf::BoolValue]
|
156
|
+
# If all_values is set to true, then all possible labels of the keyed
|
157
|
+
# feature will have another slice computed.
|
158
|
+
# Example: `{"all_values":{"value":true}}`
|
159
|
+
class SliceConfig
|
160
|
+
include ::Google::Protobuf::MessageExts
|
161
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
162
|
+
end
|
163
|
+
|
164
|
+
# A range of values for slice(s).
|
165
|
+
# `low` is inclusive, `high` is exclusive.
|
166
|
+
# @!attribute [rw] low
|
167
|
+
# @return [::Float]
|
168
|
+
# Inclusive low value for the range.
|
169
|
+
# @!attribute [rw] high
|
170
|
+
# @return [::Float]
|
171
|
+
# Exclusive high value for the range.
|
172
|
+
class Range
|
173
|
+
include ::Google::Protobuf::MessageExts
|
174
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
175
|
+
end
|
176
|
+
|
177
|
+
# Single value that supports strings and floats.
|
178
|
+
# @!attribute [rw] string_value
|
179
|
+
# @return [::String]
|
180
|
+
# String type.
|
181
|
+
# @!attribute [rw] float_value
|
182
|
+
# @return [::Float]
|
183
|
+
# Float type.
|
184
|
+
class Value
|
185
|
+
include ::Google::Protobuf::MessageExts
|
186
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
187
|
+
end
|
188
|
+
|
189
|
+
# @!attribute [rw] key
|
190
|
+
# @return [::String]
|
191
|
+
# @!attribute [rw] value
|
192
|
+
# @return [::Google::Cloud::AIPlatform::V1::ModelEvaluationSlice::Slice::SliceSpec::SliceConfig]
|
193
|
+
class ConfigsEntry
|
194
|
+
include ::Google::Protobuf::MessageExts
|
195
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
end
|
197
|
+
end
|
67
198
|
end
|
68
199
|
end
|
69
200
|
end
|
@@ -402,6 +402,64 @@ module Google
|
|
402
402
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
403
403
|
end
|
404
404
|
|
405
|
+
# Request message for
|
406
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#copy_model ModelService.CopyModel}.
|
407
|
+
# @!attribute [rw] model_id
|
408
|
+
# @return [::String]
|
409
|
+
# Optional. Copy source_model into a new Model with this ID. The ID will
|
410
|
+
# become the final component of the model resource name.
|
411
|
+
#
|
412
|
+
# This value may be up to 63 characters, and valid characters are
|
413
|
+
# `[a-z0-9_-]`. The first character cannot be a number or hyphen.
|
414
|
+
# @!attribute [rw] parent_model
|
415
|
+
# @return [::String]
|
416
|
+
# Optional. Specify this field to copy source_model into this existing
|
417
|
+
# Model as a new version. Format:
|
418
|
+
# `projects/{project}/locations/{location}/models/{model}`
|
419
|
+
# @!attribute [rw] parent
|
420
|
+
# @return [::String]
|
421
|
+
# Required. The resource name of the Location into which to copy the Model.
|
422
|
+
# Format: `projects/{project}/locations/{location}`
|
423
|
+
# @!attribute [rw] source_model
|
424
|
+
# @return [::String]
|
425
|
+
# Required. The resource name of the Model to copy. That Model must be in the
|
426
|
+
# same Project. Format:
|
427
|
+
# `projects/{project}/locations/{location}/models/{model}`
|
428
|
+
# @!attribute [rw] encryption_spec
|
429
|
+
# @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
|
430
|
+
# Customer-managed encryption key options. If this is set,
|
431
|
+
# then the Model copy will be encrypted with the provided encryption key.
|
432
|
+
class CopyModelRequest
|
433
|
+
include ::Google::Protobuf::MessageExts
|
434
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
435
|
+
end
|
436
|
+
|
437
|
+
# Details of
|
438
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#copy_model ModelService.CopyModel}
|
439
|
+
# operation.
|
440
|
+
# @!attribute [rw] generic_metadata
|
441
|
+
# @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
|
442
|
+
# The common part of the operation metadata.
|
443
|
+
class CopyModelOperationMetadata
|
444
|
+
include ::Google::Protobuf::MessageExts
|
445
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
446
|
+
end
|
447
|
+
|
448
|
+
# Response message of
|
449
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#copy_model ModelService.CopyModel}
|
450
|
+
# operation.
|
451
|
+
# @!attribute [rw] model
|
452
|
+
# @return [::String]
|
453
|
+
# The name of the copied Model resource.
|
454
|
+
# Format: `projects/{project}/locations/{location}/models/{model}`
|
455
|
+
# @!attribute [r] model_version_id
|
456
|
+
# @return [::String]
|
457
|
+
# Output only. The version ID of the model that is copied.
|
458
|
+
class CopyModelResponse
|
459
|
+
include ::Google::Protobuf::MessageExts
|
460
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
461
|
+
end
|
462
|
+
|
405
463
|
# Request message for
|
406
464
|
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#import_model_evaluation ModelService.ImportModelEvaluation}
|
407
465
|
# @!attribute [rw] parent
|
@@ -442,6 +500,31 @@ module Google
|
|
442
500
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
443
501
|
end
|
444
502
|
|
503
|
+
# Request message for
|
504
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#batch_import_evaluated_annotations ModelService.BatchImportEvaluatedAnnotations}
|
505
|
+
# @!attribute [rw] parent
|
506
|
+
# @return [::String]
|
507
|
+
# Required. The name of the parent ModelEvaluationSlice resource.
|
508
|
+
# Format:
|
509
|
+
# `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
|
510
|
+
# @!attribute [rw] evaluated_annotations
|
511
|
+
# @return [::Array<::Google::Cloud::AIPlatform::V1::EvaluatedAnnotation>]
|
512
|
+
# Required. Evaluated annotations resource to be imported.
|
513
|
+
class BatchImportEvaluatedAnnotationsRequest
|
514
|
+
include ::Google::Protobuf::MessageExts
|
515
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
516
|
+
end
|
517
|
+
|
518
|
+
# Response message for
|
519
|
+
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#batch_import_evaluated_annotations ModelService.BatchImportEvaluatedAnnotations}
|
520
|
+
# @!attribute [r] imported_evaluated_annotations_count
|
521
|
+
# @return [::Integer]
|
522
|
+
# Output only. Number of EvaluatedAnnotations imported.
|
523
|
+
class BatchImportEvaluatedAnnotationsResponse
|
524
|
+
include ::Google::Protobuf::MessageExts
|
525
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
526
|
+
end
|
527
|
+
|
445
528
|
# Request message for
|
446
529
|
# {::Google::Cloud::AIPlatform::V1::ModelService::Client#get_model_evaluation ModelService.GetModelEvaluation}.
|
447
530
|
# @!attribute [rw] name
|