google-cloud-ai_platform-v1 0.62.0 → 0.63.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/ai_platform/v1/bindings_override.rb +24 -0
  4. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +11 -0
  5. data/lib/google/cloud/ai_platform/v1/dataset_service/operations.rb +7 -0
  6. data/lib/google/cloud/ai_platform/v1/dataset_service/rest/client.rb +11 -0
  7. data/lib/google/cloud/ai_platform/v1/dataset_service/rest/operations.rb +35 -0
  8. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/client.rb +7 -0
  9. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/operations.rb +7 -0
  10. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/client.rb +7 -0
  11. data/lib/google/cloud/ai_platform/v1/deployment_resource_pool_service/rest/operations.rb +35 -0
  12. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +7 -0
  13. data/lib/google/cloud/ai_platform/v1/endpoint_service/operations.rb +7 -0
  14. data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/client.rb +7 -0
  15. data/lib/google/cloud/ai_platform/v1/endpoint_service/rest/operations.rb +35 -0
  16. data/lib/google/cloud/ai_platform/v1/evaluation_service/client.rb +57 -0
  17. data/lib/google/cloud/ai_platform/v1/evaluation_service/rest/client.rb +57 -0
  18. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/client.rb +7 -0
  19. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/operations.rb +7 -0
  20. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/rest/client.rb +7 -0
  21. data/lib/google/cloud/ai_platform/v1/feature_online_store_admin_service/rest/operations.rb +35 -0
  22. data/lib/google/cloud/ai_platform/v1/feature_online_store_service/client.rb +7 -0
  23. data/lib/google/cloud/ai_platform/v1/feature_online_store_service/rest/client.rb +7 -0
  24. data/lib/google/cloud/ai_platform/v1/feature_registry_service/client.rb +7 -0
  25. data/lib/google/cloud/ai_platform/v1/feature_registry_service/operations.rb +7 -0
  26. data/lib/google/cloud/ai_platform/v1/feature_registry_service/rest/client.rb +7 -0
  27. data/lib/google/cloud/ai_platform/v1/feature_registry_service/rest/operations.rb +35 -0
  28. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +7 -0
  29. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/rest/client.rb +7 -0
  30. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +26 -0
  31. data/lib/google/cloud/ai_platform/v1/featurestore_service/operations.rb +7 -0
  32. data/lib/google/cloud/ai_platform/v1/featurestore_service/rest/client.rb +26 -0
  33. data/lib/google/cloud/ai_platform/v1/featurestore_service/rest/operations.rb +35 -0
  34. data/lib/google/cloud/ai_platform/v1/gen_ai_cache_service/client.rb +7 -0
  35. data/lib/google/cloud/ai_platform/v1/gen_ai_cache_service/rest/client.rb +7 -0
  36. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/client.rb +7 -0
  37. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/operations.rb +7 -0
  38. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/rest/client.rb +7 -0
  39. data/lib/google/cloud/ai_platform/v1/gen_ai_tuning_service/rest/operations.rb +35 -0
  40. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +7 -0
  41. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/operations.rb +7 -0
  42. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/rest/client.rb +7 -0
  43. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/rest/operations.rb +35 -0
  44. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +7 -0
  45. data/lib/google/cloud/ai_platform/v1/index_service/operations.rb +7 -0
  46. data/lib/google/cloud/ai_platform/v1/index_service/rest/client.rb +7 -0
  47. data/lib/google/cloud/ai_platform/v1/index_service/rest/operations.rb +35 -0
  48. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +7 -0
  49. data/lib/google/cloud/ai_platform/v1/job_service/operations.rb +7 -0
  50. data/lib/google/cloud/ai_platform/v1/job_service/rest/client.rb +7 -0
  51. data/lib/google/cloud/ai_platform/v1/job_service/rest/operations.rb +35 -0
  52. data/lib/google/cloud/ai_platform/v1/llm_utility_service/client.rb +7 -0
  53. data/lib/google/cloud/ai_platform/v1/llm_utility_service/rest/client.rb +7 -0
  54. data/lib/google/cloud/ai_platform/v1/match_service/client.rb +7 -0
  55. data/lib/google/cloud/ai_platform/v1/match_service/rest/client.rb +7 -0
  56. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +7 -0
  57. data/lib/google/cloud/ai_platform/v1/metadata_service/operations.rb +7 -0
  58. data/lib/google/cloud/ai_platform/v1/metadata_service/rest/client.rb +7 -0
  59. data/lib/google/cloud/ai_platform/v1/metadata_service/rest/operations.rb +35 -0
  60. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +7 -0
  61. data/lib/google/cloud/ai_platform/v1/migration_service/operations.rb +7 -0
  62. data/lib/google/cloud/ai_platform/v1/migration_service/rest/client.rb +7 -0
  63. data/lib/google/cloud/ai_platform/v1/migration_service/rest/operations.rb +35 -0
  64. data/lib/google/cloud/ai_platform/v1/model_garden_service/client.rb +7 -0
  65. data/lib/google/cloud/ai_platform/v1/model_garden_service/rest/client.rb +7 -0
  66. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +124 -0
  67. data/lib/google/cloud/ai_platform/v1/model_service/operations.rb +7 -0
  68. data/lib/google/cloud/ai_platform/v1/model_service/rest/client.rb +117 -0
  69. data/lib/google/cloud/ai_platform/v1/model_service/rest/operations.rb +35 -0
  70. data/lib/google/cloud/ai_platform/v1/model_service/rest/service_stub.rb +61 -0
  71. data/lib/google/cloud/ai_platform/v1/notebook_service/client.rb +7 -0
  72. data/lib/google/cloud/ai_platform/v1/notebook_service/operations.rb +7 -0
  73. data/lib/google/cloud/ai_platform/v1/notebook_service/rest/client.rb +7 -0
  74. data/lib/google/cloud/ai_platform/v1/notebook_service/rest/operations.rb +35 -0
  75. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/client.rb +7 -0
  76. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/operations.rb +7 -0
  77. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/rest/client.rb +7 -0
  78. data/lib/google/cloud/ai_platform/v1/persistent_resource_service/rest/operations.rb +35 -0
  79. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +7 -0
  80. data/lib/google/cloud/ai_platform/v1/pipeline_service/operations.rb +7 -0
  81. data/lib/google/cloud/ai_platform/v1/pipeline_service/rest/client.rb +7 -0
  82. data/lib/google/cloud/ai_platform/v1/pipeline_service/rest/operations.rb +35 -0
  83. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +7 -0
  84. data/lib/google/cloud/ai_platform/v1/prediction_service/rest/client.rb +7 -0
  85. data/lib/google/cloud/ai_platform/v1/reasoning_engine_execution_service/client.rb +7 -0
  86. data/lib/google/cloud/ai_platform/v1/reasoning_engine_execution_service/rest/client.rb +7 -0
  87. data/lib/google/cloud/ai_platform/v1/reasoning_engine_service/client.rb +7 -0
  88. data/lib/google/cloud/ai_platform/v1/reasoning_engine_service/operations.rb +7 -0
  89. data/lib/google/cloud/ai_platform/v1/reasoning_engine_service/rest/client.rb +7 -0
  90. data/lib/google/cloud/ai_platform/v1/reasoning_engine_service/rest/operations.rb +35 -0
  91. data/lib/google/cloud/ai_platform/v1/schedule_service/client.rb +7 -0
  92. data/lib/google/cloud/ai_platform/v1/schedule_service/operations.rb +7 -0
  93. data/lib/google/cloud/ai_platform/v1/schedule_service/rest/client.rb +7 -0
  94. data/lib/google/cloud/ai_platform/v1/schedule_service/rest/operations.rb +35 -0
  95. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +7 -0
  96. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/operations.rb +7 -0
  97. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/rest/client.rb +7 -0
  98. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/rest/operations.rb +35 -0
  99. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +7 -0
  100. data/lib/google/cloud/ai_platform/v1/tensorboard_service/operations.rb +7 -0
  101. data/lib/google/cloud/ai_platform/v1/tensorboard_service/rest/client.rb +7 -0
  102. data/lib/google/cloud/ai_platform/v1/tensorboard_service/rest/operations.rb +35 -0
  103. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  104. data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/client.rb +7 -0
  105. data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/operations.rb +7 -0
  106. data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/rest/client.rb +7 -0
  107. data/lib/google/cloud/ai_platform/v1/vertex_rag_data_service/rest/operations.rb +35 -0
  108. data/lib/google/cloud/ai_platform/v1/vertex_rag_service/client.rb +7 -0
  109. data/lib/google/cloud/ai_platform/v1/vertex_rag_service/rest/client.rb +7 -0
  110. data/lib/google/cloud/ai_platform/v1/vizier_service/client.rb +7 -0
  111. data/lib/google/cloud/ai_platform/v1/vizier_service/operations.rb +7 -0
  112. data/lib/google/cloud/ai_platform/v1/vizier_service/rest/client.rb +7 -0
  113. data/lib/google/cloud/ai_platform/v1/vizier_service/rest/operations.rb +35 -0
  114. data/lib/google/cloud/aiplatform/v1/content_pb.rb +3 -1
  115. data/lib/google/cloud/aiplatform/v1/endpoint_pb.rb +5 -2
  116. data/lib/google/cloud/aiplatform/v1/feature_view_pb.rb +2 -1
  117. data/lib/google/cloud/aiplatform/v1/model_pb.rb +1 -1
  118. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +4 -1
  119. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +2 -0
  120. data/lib/google/cloud/aiplatform/v1/prediction_service_pb.rb +1 -1
  121. data/lib/google/cloud/aiplatform/v1/tool_pb.rb +6 -1
  122. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +12 -0
  123. data/proto_docs/google/cloud/aiplatform/v1/cached_content.rb +4 -0
  124. data/proto_docs/google/cloud/aiplatform/v1/content.rb +61 -0
  125. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +4 -0
  126. data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +4 -0
  127. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +4 -0
  128. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +4 -0
  129. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +57 -5
  130. data/proto_docs/google/cloud/aiplatform/v1/evaluation_service.rb +100 -0
  131. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +16 -0
  132. data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +4 -0
  133. data/proto_docs/google/cloud/aiplatform/v1/feature_online_store.rb +4 -0
  134. data/proto_docs/google/cloud/aiplatform/v1/feature_online_store_service.rb +18 -0
  135. data/proto_docs/google/cloud/aiplatform/v1/feature_view.rb +39 -0
  136. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +24 -0
  137. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +29 -0
  138. data/proto_docs/google/cloud/aiplatform/v1/index.rb +6 -0
  139. data/proto_docs/google/cloud/aiplatform/v1/io.rb +8 -0
  140. data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +8 -0
  141. data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +18 -0
  142. data/proto_docs/google/cloud/aiplatform/v1/model.rb +7 -0
  143. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +10 -0
  144. data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +10 -0
  145. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +63 -0
  146. data/proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb +14 -0
  147. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +4 -0
  148. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +13 -0
  149. data/proto_docs/google/cloud/aiplatform/v1/publisher_model.rb +14 -0
  150. data/proto_docs/google/cloud/aiplatform/v1/schedule.rb +4 -0
  151. data/proto_docs/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_tables.rb +12 -0
  152. data/proto_docs/google/cloud/aiplatform/v1/study.rb +24 -0
  153. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +6 -0
  154. data/proto_docs/google/cloud/aiplatform/v1/tool.rb +80 -0
  155. data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +14 -0
  156. data/proto_docs/google/cloud/aiplatform/v1/tuning_job.rb +6 -0
  157. data/proto_docs/google/cloud/aiplatform/v1/user_action_reference.rb +4 -0
  158. data/proto_docs/google/cloud/aiplatform/v1/value.rb +6 -0
  159. data/proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb +32 -0
  160. data/proto_docs/google/cloud/aiplatform/v1/vertex_rag_data_service.rb +8 -0
  161. data/proto_docs/google/longrunning/operations.rb +4 -0
  162. data/proto_docs/google/protobuf/struct.rb +12 -0
  163. metadata +5 -5
@@ -26,84 +26,134 @@ module Google
26
26
  # @return [::Google::Cloud::AIPlatform::V1::ExactMatchInput]
27
27
  # Auto metric instances.
28
28
  # Instances and metric spec for exact match metric.
29
+ #
30
+ # Note: The following fields are mutually exclusive: `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
29
31
  # @!attribute [rw] bleu_input
30
32
  # @return [::Google::Cloud::AIPlatform::V1::BleuInput]
31
33
  # Instances and metric spec for bleu metric.
34
+ #
35
+ # Note: The following fields are mutually exclusive: `bleu_input`, `exact_match_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
32
36
  # @!attribute [rw] rouge_input
33
37
  # @return [::Google::Cloud::AIPlatform::V1::RougeInput]
34
38
  # Instances and metric spec for rouge metric.
39
+ #
40
+ # Note: The following fields are mutually exclusive: `rouge_input`, `exact_match_input`, `bleu_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
35
41
  # @!attribute [rw] fluency_input
36
42
  # @return [::Google::Cloud::AIPlatform::V1::FluencyInput]
37
43
  # LLM-based metric instance.
38
44
  # General text generation metrics, applicable to other categories.
39
45
  # Input for fluency metric.
46
+ #
47
+ # Note: The following fields are mutually exclusive: `fluency_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
40
48
  # @!attribute [rw] coherence_input
41
49
  # @return [::Google::Cloud::AIPlatform::V1::CoherenceInput]
42
50
  # Input for coherence metric.
51
+ #
52
+ # Note: The following fields are mutually exclusive: `coherence_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
43
53
  # @!attribute [rw] safety_input
44
54
  # @return [::Google::Cloud::AIPlatform::V1::SafetyInput]
45
55
  # Input for safety metric.
56
+ #
57
+ # Note: The following fields are mutually exclusive: `safety_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
46
58
  # @!attribute [rw] groundedness_input
47
59
  # @return [::Google::Cloud::AIPlatform::V1::GroundednessInput]
48
60
  # Input for groundedness metric.
61
+ #
62
+ # Note: The following fields are mutually exclusive: `groundedness_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
49
63
  # @!attribute [rw] fulfillment_input
50
64
  # @return [::Google::Cloud::AIPlatform::V1::FulfillmentInput]
51
65
  # Input for fulfillment metric.
66
+ #
67
+ # Note: The following fields are mutually exclusive: `fulfillment_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
52
68
  # @!attribute [rw] summarization_quality_input
53
69
  # @return [::Google::Cloud::AIPlatform::V1::SummarizationQualityInput]
54
70
  # Input for summarization quality metric.
71
+ #
72
+ # Note: The following fields are mutually exclusive: `summarization_quality_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
55
73
  # @!attribute [rw] pairwise_summarization_quality_input
56
74
  # @return [::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityInput]
57
75
  # Input for pairwise summarization quality metric.
76
+ #
77
+ # Note: The following fields are mutually exclusive: `pairwise_summarization_quality_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
58
78
  # @!attribute [rw] summarization_helpfulness_input
59
79
  # @return [::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessInput]
60
80
  # Input for summarization helpfulness metric.
81
+ #
82
+ # Note: The following fields are mutually exclusive: `summarization_helpfulness_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
61
83
  # @!attribute [rw] summarization_verbosity_input
62
84
  # @return [::Google::Cloud::AIPlatform::V1::SummarizationVerbosityInput]
63
85
  # Input for summarization verbosity metric.
86
+ #
87
+ # Note: The following fields are mutually exclusive: `summarization_verbosity_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
64
88
  # @!attribute [rw] question_answering_quality_input
65
89
  # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityInput]
66
90
  # Input for question answering quality metric.
91
+ #
92
+ # Note: The following fields are mutually exclusive: `question_answering_quality_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
67
93
  # @!attribute [rw] pairwise_question_answering_quality_input
68
94
  # @return [::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityInput]
69
95
  # Input for pairwise question answering quality metric.
96
+ #
97
+ # Note: The following fields are mutually exclusive: `pairwise_question_answering_quality_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
70
98
  # @!attribute [rw] question_answering_relevance_input
71
99
  # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceInput]
72
100
  # Input for question answering relevance metric.
101
+ #
102
+ # Note: The following fields are mutually exclusive: `question_answering_relevance_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
73
103
  # @!attribute [rw] question_answering_helpfulness_input
74
104
  # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessInput]
75
105
  # Input for question answering helpfulness
76
106
  # metric.
107
+ #
108
+ # Note: The following fields are mutually exclusive: `question_answering_helpfulness_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
77
109
  # @!attribute [rw] question_answering_correctness_input
78
110
  # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessInput]
79
111
  # Input for question answering correctness
80
112
  # metric.
113
+ #
114
+ # Note: The following fields are mutually exclusive: `question_answering_correctness_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
81
115
  # @!attribute [rw] pointwise_metric_input
82
116
  # @return [::Google::Cloud::AIPlatform::V1::PointwiseMetricInput]
83
117
  # Input for pointwise metric.
118
+ #
119
+ # Note: The following fields are mutually exclusive: `pointwise_metric_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
84
120
  # @!attribute [rw] pairwise_metric_input
85
121
  # @return [::Google::Cloud::AIPlatform::V1::PairwiseMetricInput]
86
122
  # Input for pairwise metric.
123
+ #
124
+ # Note: The following fields are mutually exclusive: `pairwise_metric_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
87
125
  # @!attribute [rw] tool_call_valid_input
88
126
  # @return [::Google::Cloud::AIPlatform::V1::ToolCallValidInput]
89
127
  # Tool call metric instances.
90
128
  # Input for tool call valid metric.
129
+ #
130
+ # Note: The following fields are mutually exclusive: `tool_call_valid_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
91
131
  # @!attribute [rw] tool_name_match_input
92
132
  # @return [::Google::Cloud::AIPlatform::V1::ToolNameMatchInput]
93
133
  # Input for tool name match metric.
134
+ #
135
+ # Note: The following fields are mutually exclusive: `tool_name_match_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
94
136
  # @!attribute [rw] tool_parameter_key_match_input
95
137
  # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchInput]
96
138
  # Input for tool parameter key match metric.
139
+ #
140
+ # Note: The following fields are mutually exclusive: `tool_parameter_key_match_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_kv_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
97
141
  # @!attribute [rw] tool_parameter_kv_match_input
98
142
  # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchInput]
99
143
  # Input for tool parameter key value match metric.
144
+ #
145
+ # Note: The following fields are mutually exclusive: `tool_parameter_kv_match_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `comet_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
100
146
  # @!attribute [rw] comet_input
101
147
  # @return [::Google::Cloud::AIPlatform::V1::CometInput]
102
148
  # Translation metrics.
103
149
  # Input for Comet metric.
150
+ #
151
+ # Note: The following fields are mutually exclusive: `comet_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `metricx_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
104
152
  # @!attribute [rw] metricx_input
105
153
  # @return [::Google::Cloud::AIPlatform::V1::MetricxInput]
106
154
  # Input for Metricx metric.
155
+ #
156
+ # Note: The following fields are mutually exclusive: `metricx_input`, `exact_match_input`, `bleu_input`, `rouge_input`, `fluency_input`, `coherence_input`, `safety_input`, `groundedness_input`, `fulfillment_input`, `summarization_quality_input`, `pairwise_summarization_quality_input`, `summarization_helpfulness_input`, `summarization_verbosity_input`, `question_answering_quality_input`, `pairwise_question_answering_quality_input`, `question_answering_relevance_input`, `question_answering_helpfulness_input`, `question_answering_correctness_input`, `pointwise_metric_input`, `pairwise_metric_input`, `tool_call_valid_input`, `tool_name_match_input`, `tool_parameter_key_match_input`, `tool_parameter_kv_match_input`, `comet_input`. If a field in that set is populated, all other fields in the set will automatically be cleared.
107
157
  # @!attribute [rw] location
108
158
  # @return [::String]
109
159
  # Required. The resource name of the Location to evaluate the instances.
@@ -118,85 +168,135 @@ module Google
118
168
  # @return [::Google::Cloud::AIPlatform::V1::ExactMatchResults]
119
169
  # Auto metric evaluation results.
120
170
  # Results for exact match metric.
171
+ #
172
+ # Note: The following fields are mutually exclusive: `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
121
173
  # @!attribute [rw] bleu_results
122
174
  # @return [::Google::Cloud::AIPlatform::V1::BleuResults]
123
175
  # Results for bleu metric.
176
+ #
177
+ # Note: The following fields are mutually exclusive: `bleu_results`, `exact_match_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
124
178
  # @!attribute [rw] rouge_results
125
179
  # @return [::Google::Cloud::AIPlatform::V1::RougeResults]
126
180
  # Results for rouge metric.
181
+ #
182
+ # Note: The following fields are mutually exclusive: `rouge_results`, `exact_match_results`, `bleu_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
127
183
  # @!attribute [rw] fluency_result
128
184
  # @return [::Google::Cloud::AIPlatform::V1::FluencyResult]
129
185
  # LLM-based metric evaluation result.
130
186
  # General text generation metrics, applicable to other categories.
131
187
  # Result for fluency metric.
188
+ #
189
+ # Note: The following fields are mutually exclusive: `fluency_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
132
190
  # @!attribute [rw] coherence_result
133
191
  # @return [::Google::Cloud::AIPlatform::V1::CoherenceResult]
134
192
  # Result for coherence metric.
193
+ #
194
+ # Note: The following fields are mutually exclusive: `coherence_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
135
195
  # @!attribute [rw] safety_result
136
196
  # @return [::Google::Cloud::AIPlatform::V1::SafetyResult]
137
197
  # Result for safety metric.
198
+ #
199
+ # Note: The following fields are mutually exclusive: `safety_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
138
200
  # @!attribute [rw] groundedness_result
139
201
  # @return [::Google::Cloud::AIPlatform::V1::GroundednessResult]
140
202
  # Result for groundedness metric.
203
+ #
204
+ # Note: The following fields are mutually exclusive: `groundedness_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
141
205
  # @!attribute [rw] fulfillment_result
142
206
  # @return [::Google::Cloud::AIPlatform::V1::FulfillmentResult]
143
207
  # Result for fulfillment metric.
208
+ #
209
+ # Note: The following fields are mutually exclusive: `fulfillment_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
144
210
  # @!attribute [rw] summarization_quality_result
145
211
  # @return [::Google::Cloud::AIPlatform::V1::SummarizationQualityResult]
146
212
  # Summarization only metrics.
147
213
  # Result for summarization quality metric.
214
+ #
215
+ # Note: The following fields are mutually exclusive: `summarization_quality_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
148
216
  # @!attribute [rw] pairwise_summarization_quality_result
149
217
  # @return [::Google::Cloud::AIPlatform::V1::PairwiseSummarizationQualityResult]
150
218
  # Result for pairwise summarization quality metric.
219
+ #
220
+ # Note: The following fields are mutually exclusive: `pairwise_summarization_quality_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
151
221
  # @!attribute [rw] summarization_helpfulness_result
152
222
  # @return [::Google::Cloud::AIPlatform::V1::SummarizationHelpfulnessResult]
153
223
  # Result for summarization helpfulness metric.
224
+ #
225
+ # Note: The following fields are mutually exclusive: `summarization_helpfulness_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
154
226
  # @!attribute [rw] summarization_verbosity_result
155
227
  # @return [::Google::Cloud::AIPlatform::V1::SummarizationVerbosityResult]
156
228
  # Result for summarization verbosity metric.
229
+ #
230
+ # Note: The following fields are mutually exclusive: `summarization_verbosity_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
157
231
  # @!attribute [rw] question_answering_quality_result
158
232
  # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringQualityResult]
159
233
  # Question answering only metrics.
160
234
  # Result for question answering quality metric.
235
+ #
236
+ # Note: The following fields are mutually exclusive: `question_answering_quality_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
161
237
  # @!attribute [rw] pairwise_question_answering_quality_result
162
238
  # @return [::Google::Cloud::AIPlatform::V1::PairwiseQuestionAnsweringQualityResult]
163
239
  # Result for pairwise question answering quality metric.
240
+ #
241
+ # Note: The following fields are mutually exclusive: `pairwise_question_answering_quality_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
164
242
  # @!attribute [rw] question_answering_relevance_result
165
243
  # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringRelevanceResult]
166
244
  # Result for question answering relevance metric.
245
+ #
246
+ # Note: The following fields are mutually exclusive: `question_answering_relevance_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
167
247
  # @!attribute [rw] question_answering_helpfulness_result
168
248
  # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringHelpfulnessResult]
169
249
  # Result for question answering helpfulness metric.
250
+ #
251
+ # Note: The following fields are mutually exclusive: `question_answering_helpfulness_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
170
252
  # @!attribute [rw] question_answering_correctness_result
171
253
  # @return [::Google::Cloud::AIPlatform::V1::QuestionAnsweringCorrectnessResult]
172
254
  # Result for question answering correctness metric.
255
+ #
256
+ # Note: The following fields are mutually exclusive: `question_answering_correctness_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
173
257
  # @!attribute [rw] pointwise_metric_result
174
258
  # @return [::Google::Cloud::AIPlatform::V1::PointwiseMetricResult]
175
259
  # Generic metrics.
176
260
  # Result for pointwise metric.
261
+ #
262
+ # Note: The following fields are mutually exclusive: `pointwise_metric_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
177
263
  # @!attribute [rw] pairwise_metric_result
178
264
  # @return [::Google::Cloud::AIPlatform::V1::PairwiseMetricResult]
179
265
  # Result for pairwise metric.
266
+ #
267
+ # Note: The following fields are mutually exclusive: `pairwise_metric_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
180
268
  # @!attribute [rw] tool_call_valid_results
181
269
  # @return [::Google::Cloud::AIPlatform::V1::ToolCallValidResults]
182
270
  # Tool call metrics.
183
271
  # Results for tool call valid metric.
272
+ #
273
+ # Note: The following fields are mutually exclusive: `tool_call_valid_results`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
184
274
  # @!attribute [rw] tool_name_match_results
185
275
  # @return [::Google::Cloud::AIPlatform::V1::ToolNameMatchResults]
186
276
  # Results for tool name match metric.
277
+ #
278
+ # Note: The following fields are mutually exclusive: `tool_name_match_results`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
187
279
  # @!attribute [rw] tool_parameter_key_match_results
188
280
  # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKeyMatchResults]
189
281
  # Results for tool parameter key match metric.
282
+ #
283
+ # Note: The following fields are mutually exclusive: `tool_parameter_key_match_results`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_kv_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
190
284
  # @!attribute [rw] tool_parameter_kv_match_results
191
285
  # @return [::Google::Cloud::AIPlatform::V1::ToolParameterKVMatchResults]
192
286
  # Results for tool parameter key value match metric.
287
+ #
288
+ # Note: The following fields are mutually exclusive: `tool_parameter_kv_match_results`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `comet_result`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
193
289
  # @!attribute [rw] comet_result
194
290
  # @return [::Google::Cloud::AIPlatform::V1::CometResult]
195
291
  # Translation metrics.
196
292
  # Result for Comet metric.
293
+ #
294
+ # Note: The following fields are mutually exclusive: `comet_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `metricx_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
197
295
  # @!attribute [rw] metricx_result
198
296
  # @return [::Google::Cloud::AIPlatform::V1::MetricxResult]
199
297
  # Result for Metricx metric.
298
+ #
299
+ # Note: The following fields are mutually exclusive: `metricx_result`, `exact_match_results`, `bleu_results`, `rouge_results`, `fluency_result`, `coherence_result`, `safety_result`, `groundedness_result`, `fulfillment_result`, `summarization_quality_result`, `pairwise_summarization_quality_result`, `summarization_helpfulness_result`, `summarization_verbosity_result`, `question_answering_quality_result`, `pairwise_question_answering_quality_result`, `question_answering_relevance_result`, `question_answering_helpfulness_result`, `question_answering_correctness_result`, `pointwise_metric_result`, `pairwise_metric_result`, `tool_call_valid_results`, `tool_name_match_results`, `tool_parameter_key_match_results`, `tool_parameter_kv_match_results`, `comet_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
200
300
  class EvaluateInstancesResponse
201
301
  include ::Google::Protobuf::MessageExts
202
302
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -237,11 +237,15 @@ module Google
237
237
  # contribute to the label being predicted. A sampling strategy is used to
238
238
  # approximate the value rather than considering all subsets of features.
239
239
  # Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
240
+ #
241
+ # Note: The following fields are mutually exclusive: `sampled_shapley_attribution`, `integrated_gradients_attribution`, `xrai_attribution`, `examples`. If a field in that set is populated, all other fields in the set will automatically be cleared.
240
242
  # @!attribute [rw] integrated_gradients_attribution
241
243
  # @return [::Google::Cloud::AIPlatform::V1::IntegratedGradientsAttribution]
242
244
  # An attribution method that computes Aumann-Shapley values taking
243
245
  # advantage of the model's fully differentiable structure. Refer to this
244
246
  # paper for more details: https://arxiv.org/abs/1703.01365
247
+ #
248
+ # Note: The following fields are mutually exclusive: `integrated_gradients_attribution`, `sampled_shapley_attribution`, `xrai_attribution`, `examples`. If a field in that set is populated, all other fields in the set will automatically be cleared.
245
249
  # @!attribute [rw] xrai_attribution
246
250
  # @return [::Google::Cloud::AIPlatform::V1::XraiAttribution]
247
251
  # An attribution method that redistributes Integrated Gradients
@@ -253,10 +257,14 @@ module Google
253
257
  # house or an animal. If the images are taken in artificial environments,
254
258
  # like a lab or manufacturing line, or from diagnostic equipment, like
255
259
  # x-rays or quality-control cameras, use Integrated Gradients instead.
260
+ #
261
+ # Note: The following fields are mutually exclusive: `xrai_attribution`, `sampled_shapley_attribution`, `integrated_gradients_attribution`, `examples`. If a field in that set is populated, all other fields in the set will automatically be cleared.
256
262
  # @!attribute [rw] examples
257
263
  # @return [::Google::Cloud::AIPlatform::V1::Examples]
258
264
  # Example-based explanations that returns the nearest neighbors from the
259
265
  # provided dataset.
266
+ #
267
+ # Note: The following fields are mutually exclusive: `examples`, `sampled_shapley_attribution`, `integrated_gradients_attribution`, `xrai_attribution`. If a field in that set is populated, all other fields in the set will automatically be cleared.
260
268
  # @!attribute [rw] top_k
261
269
  # @return [::Integer]
262
270
  # If populated, returns attributions for top K indices of outputs
@@ -382,6 +390,8 @@ module Google
382
390
  # If the distribution is different per feature, set
383
391
  # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#feature_noise_sigma feature_noise_sigma}
384
392
  # instead for each feature.
393
+ #
394
+ # Note: The following fields are mutually exclusive: `noise_sigma`, `feature_noise_sigma`. If a field in that set is populated, all other fields in the set will automatically be cleared.
385
395
  # @!attribute [rw] feature_noise_sigma
386
396
  # @return [::Google::Cloud::AIPlatform::V1::FeatureNoiseSigma]
387
397
  # This is similar to
@@ -392,6 +402,8 @@ module Google
392
402
  # is unset,
393
403
  # {::Google::Cloud::AIPlatform::V1::SmoothGradConfig#noise_sigma noise_sigma}
394
404
  # will be used for all features.
405
+ #
406
+ # Note: The following fields are mutually exclusive: `feature_noise_sigma`, `noise_sigma`. If a field in that set is populated, all other fields in the set will automatically be cleared.
395
407
  # @!attribute [rw] noisy_sample_count
396
408
  # @return [::Integer]
397
409
  # The number of gradient samples to use for
@@ -460,10 +472,14 @@ module Google
460
472
  # same as {::Google::Cloud::AIPlatform::V1::Index#metadata metadata} and should
461
473
  # match
462
474
  # [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
475
+ #
476
+ # Note: The following fields are mutually exclusive: `nearest_neighbor_search_config`, `presets`. If a field in that set is populated, all other fields in the set will automatically be cleared.
463
477
  # @!attribute [rw] presets
464
478
  # @return [::Google::Cloud::AIPlatform::V1::Presets]
465
479
  # Simplified preset configuration, which automatically sets configuration
466
480
  # values based on the desired query speed-precision trade-off and modality.
481
+ #
482
+ # Note: The following fields are mutually exclusive: `presets`, `nearest_neighbor_search_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
467
483
  # @!attribute [rw] neighbor_count
468
484
  # @return [::Integer]
469
485
  # The number of neighbors to return when querying for examples.
@@ -399,6 +399,8 @@ module Google
399
399
  # {::Google::Cloud::AIPlatform::V1::Attribution#output_display_name Attribution.output_display_name}
400
400
  # is populated by locating in the mapping with
401
401
  # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}.
402
+ #
403
+ # Note: The following fields are mutually exclusive: `index_display_name_mapping`, `display_name_mapping_key`. If a field in that set is populated, all other fields in the set will automatically be cleared.
402
404
  # @!attribute [rw] display_name_mapping_key
403
405
  # @return [::String]
404
406
  # Specify a field name in the prediction to look for the display name.
@@ -409,6 +411,8 @@ module Google
409
411
  # outputs, so that it can be located by
410
412
  # {::Google::Cloud::AIPlatform::V1::Attribution#output_index Attribution.output_index}
411
413
  # for a specific output.
414
+ #
415
+ # Note: The following fields are mutually exclusive: `display_name_mapping_key`, `index_display_name_mapping`. If a field in that set is populated, all other fields in the set will automatically be cleared.
412
416
  # @!attribute [rw] output_tensor_name
413
417
  # @return [::String]
414
418
  # Name of the output tensor. Required and is only applicable to Vertex
@@ -29,6 +29,8 @@ module Google
29
29
  # Contains settings for the Cloud Bigtable instance that will be created
30
30
  # to serve featureValues for all FeatureViews under this
31
31
  # FeatureOnlineStore.
32
+ #
33
+ # Note: The following fields are mutually exclusive: `bigtable`, `optimized`. If a field in that set is populated, all other fields in the set will automatically be cleared.
32
34
  # @!attribute [rw] optimized
33
35
  # @return [::Google::Cloud::AIPlatform::V1::FeatureOnlineStore::Optimized]
34
36
  # Contains settings for the Optimized store that will be created
@@ -36,6 +38,8 @@ module Google
36
38
  # FeatureOnlineStore. When choose Optimized storage type, need to set
37
39
  # {::Google::Cloud::AIPlatform::V1::PrivateServiceConnectConfig#enable_private_service_connect PrivateServiceConnectConfig.enable_private_service_connect}
38
40
  # to use private endpoint. Otherwise will use public endpoint by default.
41
+ #
42
+ # Note: The following fields are mutually exclusive: `optimized`, `bigtable`. If a field in that set is populated, all other fields in the set will automatically be cleared.
39
43
  # @!attribute [rw] name
40
44
  # @return [::String]
41
45
  # Identifier. Name of the FeatureOnlineStore. Format:
@@ -25,10 +25,14 @@ module Google
25
25
  # @!attribute [rw] key
26
26
  # @return [::String]
27
27
  # String key to use for lookup.
28
+ #
29
+ # Note: The following fields are mutually exclusive: `key`, `composite_key`. If a field in that set is populated, all other fields in the set will automatically be cleared.
28
30
  # @!attribute [rw] composite_key
29
31
  # @return [::Google::Cloud::AIPlatform::V1::FeatureViewDataKey::CompositeKey]
30
32
  # The actual Entity ID will be composed from this struct. This should match
31
33
  # with the way ID is defined in the FeatureView spec.
34
+ #
35
+ # Note: The following fields are mutually exclusive: `composite_key`, `key`. If a field in that set is populated, all other fields in the set will automatically be cleared.
32
36
  class FeatureViewDataKey
33
37
  include ::Google::Protobuf::MessageExts
34
38
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -69,9 +73,13 @@ module Google
69
73
  # @!attribute [rw] key_values
70
74
  # @return [::Google::Cloud::AIPlatform::V1::FetchFeatureValuesResponse::FeatureNameValuePairList]
71
75
  # Feature values in KeyValue format.
76
+ #
77
+ # Note: The following fields are mutually exclusive: `key_values`, `proto_struct`. If a field in that set is populated, all other fields in the set will automatically be cleared.
72
78
  # @!attribute [rw] proto_struct
73
79
  # @return [::Google::Protobuf::Struct]
74
80
  # Feature values in proto Struct format.
81
+ #
82
+ # Note: The following fields are mutually exclusive: `proto_struct`, `key_values`. If a field in that set is populated, all other fields in the set will automatically be cleared.
75
83
  # @!attribute [rw] data_key
76
84
  # @return [::Google::Cloud::AIPlatform::V1::FeatureViewDataKey]
77
85
  # The data key associated with this response.
@@ -110,9 +118,13 @@ module Google
110
118
  # Optional. The entity id whose similar entities should be searched for.
111
119
  # If embedding is set, search will use embedding instead of
112
120
  # entity_id.
121
+ #
122
+ # Note: The following fields are mutually exclusive: `entity_id`, `embedding`. If a field in that set is populated, all other fields in the set will automatically be cleared.
113
123
  # @!attribute [rw] embedding
114
124
  # @return [::Google::Cloud::AIPlatform::V1::NearestNeighborQuery::Embedding]
115
125
  # Optional. The embedding vector that be used for similar search.
126
+ #
127
+ # Note: The following fields are mutually exclusive: `embedding`, `entity_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
116
128
  # @!attribute [rw] neighbor_count
117
129
  # @return [::Integer]
118
130
  # Optional. The number of similar entities to be retrieved from feature view
@@ -178,12 +190,18 @@ module Google
178
190
  # @!attribute [rw] value_int
179
191
  # @return [::Integer]
180
192
  # int value type.
193
+ #
194
+ # Note: The following fields are mutually exclusive: `value_int`, `value_float`, `value_double`. If a field in that set is populated, all other fields in the set will automatically be cleared.
181
195
  # @!attribute [rw] value_float
182
196
  # @return [::Float]
183
197
  # float value type.
198
+ #
199
+ # Note: The following fields are mutually exclusive: `value_float`, `value_int`, `value_double`. If a field in that set is populated, all other fields in the set will automatically be cleared.
184
200
  # @!attribute [rw] value_double
185
201
  # @return [::Float]
186
202
  # double value type.
203
+ #
204
+ # Note: The following fields are mutually exclusive: `value_double`, `value_int`, `value_float`. If a field in that set is populated, all other fields in the set will automatically be cleared.
187
205
  # @!attribute [rw] name
188
206
  # @return [::String]
189
207
  # Required. Column name in BigQuery that used as filters.
@@ -27,13 +27,19 @@ module Google
27
27
  # @return [::Google::Cloud::AIPlatform::V1::FeatureView::BigQuerySource]
28
28
  # Optional. Configures how data is supposed to be extracted from a BigQuery
29
29
  # source to be loaded onto the FeatureOnlineStore.
30
+ #
31
+ # Note: The following fields are mutually exclusive: `big_query_source`, `feature_registry_source`, `vertex_rag_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
30
32
  # @!attribute [rw] feature_registry_source
31
33
  # @return [::Google::Cloud::AIPlatform::V1::FeatureView::FeatureRegistrySource]
32
34
  # Optional. Configures the features from a Feature Registry source that
33
35
  # need to be loaded onto the FeatureOnlineStore.
36
+ #
37
+ # Note: The following fields are mutually exclusive: `feature_registry_source`, `big_query_source`, `vertex_rag_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
34
38
  # @!attribute [rw] vertex_rag_source
35
39
  # @return [::Google::Cloud::AIPlatform::V1::FeatureView::VertexRagSource]
36
40
  # Optional. The Vertex RAG Source that the FeatureView is linked to.
41
+ #
42
+ # Note: The following fields are mutually exclusive: `vertex_rag_source`, `big_query_source`, `feature_registry_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
37
43
  # @!attribute [rw] name
38
44
  # @return [::String]
39
45
  # Identifier. Name of the FeatureView. Format:
@@ -72,6 +78,19 @@ module Google
72
78
  # contains the required configurations to create an index from source data,
73
79
  # so that approximate nearest neighbor (a.k.a ANN) algorithms search can be
74
80
  # performed during online serving.
81
+ # @!attribute [rw] service_agent_type
82
+ # @return [::Google::Cloud::AIPlatform::V1::FeatureView::ServiceAgentType]
83
+ # Optional. Service agent type used during data sync. By default, the Vertex
84
+ # AI Service Agent is used. When using an IAM Policy to isolate this
85
+ # FeatureView within a project, a separate service account should be
86
+ # provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`.
87
+ # This will generate a separate service account to access the BigQuery source
88
+ # table.
89
+ # @!attribute [r] service_account_email
90
+ # @return [::String]
91
+ # Output only. A Service Account unique to this FeatureView. The role
92
+ # bigquery.dataViewer should be granted to this service account to allow
93
+ # Vertex AI Feature Store to sync data to the online store.
75
94
  # @!attribute [r] satisfies_pzs
76
95
  # @return [::Boolean]
77
96
  # Output only. Reserved for future use.
@@ -118,12 +137,16 @@ module Google
118
137
  # Optional. Configuration options for the tree-AH algorithm (Shallow tree
119
138
  # + Asymmetric Hashing). Please refer to this paper for more details:
120
139
  # https://arxiv.org/abs/1908.10396
140
+ #
141
+ # Note: The following fields are mutually exclusive: `tree_ah_config`, `brute_force_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
121
142
  # @!attribute [rw] brute_force_config
122
143
  # @return [::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig::BruteForceConfig]
123
144
  # Optional. Configuration options for using brute force search, which
124
145
  # simply implements the standard linear search in the database for each
125
146
  # query. It is primarily meant for benchmarking and to generate the
126
147
  # ground truth for approximate search.
148
+ #
149
+ # Note: The following fields are mutually exclusive: `brute_force_config`, `tree_ah_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
127
150
  # @!attribute [rw] embedding_column
128
151
  # @return [::String]
129
152
  # Optional. Column of embedding. This column contains the source data to
@@ -248,6 +271,22 @@ module Google
248
271
  include ::Google::Protobuf::MessageExts
249
272
  extend ::Google::Protobuf::MessageExts::ClassMethods
250
273
  end
274
+
275
+ # Service agent type used during data sync.
276
+ module ServiceAgentType
277
+ # By default, the project-level Vertex AI Service Agent is enabled.
278
+ SERVICE_AGENT_TYPE_UNSPECIFIED = 0
279
+
280
+ # Indicates the project-level Vertex AI Service Agent
281
+ # (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
282
+ # will be used during sync jobs.
283
+ SERVICE_AGENT_TYPE_PROJECT = 1
284
+
285
+ # Enable a FeatureView service account to be created by Vertex AI and
286
+ # output in the field `service_account_email`. This service account will
287
+ # be used to read from the source BigQuery table during sync.
288
+ SERVICE_AGENT_TYPE_FEATURE_VIEW = 2
289
+ end
251
290
  end
252
291
  end
253
292
  end