google-apis-aiplatform_v1 0.71.0 → 0.73.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1533,7 +1533,9 @@ module Google
1533
1533
  attr_accessor :flip_enabled
1534
1534
  alias_method :flip_enabled?, :flip_enabled
1535
1535
 
1536
- # Generation config.
1536
+ # Configuration for content generation. This message contains all the parameters
1537
+ # that control how the model generates content. It allows you to influence the
1538
+ # randomness, length, and structure of the output.
1537
1539
  # Corresponds to the JSON property `generationConfig`
1538
1540
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
1539
1541
  attr_accessor :generation_config
@@ -1566,7 +1568,8 @@ module Google
1566
1568
  # Required. The resource metric name. Supported metrics: * For Online Prediction:
1567
1569
  # * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `
1568
1570
  # aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.
1569
- # googleapis.com/prediction/online/request_count`
1571
+ # googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/
1572
+ # subscription/num_undelivered_messages`
1570
1573
  # Corresponds to the JSON property `metricName`
1571
1574
  # @return [String]
1572
1575
  attr_accessor :metric_name
@@ -2823,20 +2826,21 @@ module Google
2823
2826
  end
2824
2827
  end
2825
2828
 
2826
- # Content blob.
2829
+ # A content blob. A Blob contains data of a specific media type. It is used to
2830
+ # represent images, audio, and video.
2827
2831
  class GoogleCloudAiplatformV1Blob
2828
2832
  include Google::Apis::Core::Hashable
2829
2833
 
2830
- # Required. Raw bytes.
2834
+ # Required. The raw bytes of the data.
2831
2835
  # Corresponds to the JSON property `data`
2832
2836
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
2833
2837
  # @return [String]
2834
2838
  attr_accessor :data
2835
2839
 
2836
- # Optional. Display name of the blob. Used to provide a label or filename to
2837
- # distinguish blobs. This field is only returned in PromptMessage for prompt
2838
- # management. It is currently used in the Gemini GenerateContent calls only when
2839
- # server side tools (code_execution, google_search, and url_context) are enabled.
2840
+ # Optional. The display name of the blob. Used to provide a label or filename to
2841
+ # distinguish blobs. This field is only returned in `PromptMessage` for prompt
2842
+ # management. It is used in the Gemini calls only when server-side tools (`
2843
+ # code_execution`, `google_search`, and `url_context`) are enabled.
2840
2844
  # Corresponds to the JSON property `displayName`
2841
2845
  # @return [String]
2842
2846
  attr_accessor :display_name
@@ -2975,10 +2979,9 @@ module Google
2975
2979
  # @return [String]
2976
2980
  attr_accessor :name
2977
2981
 
2978
- # The base structured datatype containing multi-part content of a message. A `
2979
- # Content` includes a `role` field designating the producer of the `Content` and
2980
- # a `parts` field containing multi-part data that contains the content of the
2981
- # message turn.
2982
+ # The structured data content of a message. A Content message contains a `role`
2983
+ # field, which indicates the producer of the content, and a `parts` field, which
2984
+ # contains the multi-part data of the message.
2982
2985
  # Corresponds to the JSON property `systemInstruction`
2983
2986
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
2984
2987
  attr_accessor :system_instruction
@@ -3196,58 +3199,70 @@ module Google
3196
3199
  class GoogleCloudAiplatformV1Candidate
3197
3200
  include Google::Apis::Core::Hashable
3198
3201
 
3199
- # Output only. Average log probability score of the candidate.
3202
+ # Output only. The average log probability of the tokens in this candidate. This
3203
+ # is a length-normalized score that can be used to compare the quality of
3204
+ # candidates of different lengths. A higher average log probability suggests a
3205
+ # more confident and coherent response.
3200
3206
  # Corresponds to the JSON property `avgLogprobs`
3201
3207
  # @return [Float]
3202
3208
  attr_accessor :avg_logprobs
3203
3209
 
3204
- # A collection of source attributions for a piece of content.
3210
+ # A collection of citations that apply to a piece of generated content.
3205
3211
  # Corresponds to the JSON property `citationMetadata`
3206
3212
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CitationMetadata]
3207
3213
  attr_accessor :citation_metadata
3208
3214
 
3209
- # The base structured datatype containing multi-part content of a message. A `
3210
- # Content` includes a `role` field designating the producer of the `Content` and
3211
- # a `parts` field containing multi-part data that contains the content of the
3212
- # message turn.
3215
+ # The structured data content of a message. A Content message contains a `role`
3216
+ # field, which indicates the producer of the content, and a `parts` field, which
3217
+ # contains the multi-part data of the message.
3213
3218
  # Corresponds to the JSON property `content`
3214
3219
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
3215
3220
  attr_accessor :content
3216
3221
 
3217
- # Output only. Describes the reason the mode stopped generating tokens in more
3218
- # detail. This is only filled when `finish_reason` is set.
3222
+ # Output only. Describes the reason the model stopped generating tokens in more
3223
+ # detail. This field is returned only when `finish_reason` is set.
3219
3224
  # Corresponds to the JSON property `finishMessage`
3220
3225
  # @return [String]
3221
3226
  attr_accessor :finish_message
3222
3227
 
3223
3228
  # Output only. The reason why the model stopped generating tokens. If empty, the
3224
- # model has not stopped generating the tokens.
3229
+ # model has not stopped generating.
3225
3230
  # Corresponds to the JSON property `finishReason`
3226
3231
  # @return [String]
3227
3232
  attr_accessor :finish_reason
3228
3233
 
3229
- # Metadata returned to client when grounding is enabled.
3234
+ # Information about the sources that support the content of a response. When
3235
+ # grounding is enabled, the model returns citations for claims in the response.
3236
+ # This object contains the retrieved sources.
3230
3237
  # Corresponds to the JSON property `groundingMetadata`
3231
3238
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingMetadata]
3232
3239
  attr_accessor :grounding_metadata
3233
3240
 
3234
- # Output only. Index of the candidate.
3241
+ # Output only. The 0-based index of this candidate in the list of generated
3242
+ # responses. This is useful for distinguishing between multiple candidates when `
3243
+ # candidate_count` > 1.
3235
3244
  # Corresponds to the JSON property `index`
3236
3245
  # @return [Fixnum]
3237
3246
  attr_accessor :index
3238
3247
 
3239
- # Logprobs Result
3248
+ # The log probabilities of the tokens generated by the model. This is useful for
3249
+ # understanding the model's confidence in its predictions and for debugging. For
3250
+ # example, you can use log probabilities to identify when the model is making a
3251
+ # less confident prediction or to explore alternative responses that the model
3252
+ # considered. A low log probability can also indicate that the model is "
3253
+ # hallucinating" or generating factually incorrect information.
3240
3254
  # Corresponds to the JSON property `logprobsResult`
3241
3255
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LogprobsResult]
3242
3256
  attr_accessor :logprobs_result
3243
3257
 
3244
- # Output only. List of ratings for the safety of a response candidate. There is
3245
- # at most one rating per category.
3258
+ # Output only. A list of ratings for the safety of a response candidate. There
3259
+ # is at most one rating per category.
3246
3260
  # Corresponds to the JSON property `safetyRatings`
3247
3261
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetyRating>]
3248
3262
  attr_accessor :safety_ratings
3249
3263
 
3250
- # Metadata related to url context retrieval tool.
3264
+ # Metadata returned when the model uses the `url_context` tool to get
3265
+ # information from a user-provided URL.
3251
3266
  # Corresponds to the JSON property `urlContextMetadata`
3252
3267
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UrlContextMetadata]
3253
3268
  attr_accessor :url_context_metadata
@@ -3448,16 +3463,16 @@ module Google
3448
3463
  end
3449
3464
  end
3450
3465
 
3451
- # Source attributions for content.
3466
+ # A citation for a piece of generatedcontent.
3452
3467
  class GoogleCloudAiplatformV1Citation
3453
3468
  include Google::Apis::Core::Hashable
3454
3469
 
3455
- # Output only. End index into the content.
3470
+ # Output only. The end index of the citation in the content.
3456
3471
  # Corresponds to the JSON property `endIndex`
3457
3472
  # @return [Fixnum]
3458
3473
  attr_accessor :end_index
3459
3474
 
3460
- # Output only. License of the attribution.
3475
+ # Output only. The license of the source of the citation.
3461
3476
  # Corresponds to the JSON property `license`
3462
3477
  # @return [String]
3463
3478
  attr_accessor :license
@@ -3474,17 +3489,17 @@ module Google
3474
3489
  # @return [Google::Apis::AiplatformV1::GoogleTypeDate]
3475
3490
  attr_accessor :publication_date
3476
3491
 
3477
- # Output only. Start index into the content.
3492
+ # Output only. The start index of the citation in the content.
3478
3493
  # Corresponds to the JSON property `startIndex`
3479
3494
  # @return [Fixnum]
3480
3495
  attr_accessor :start_index
3481
3496
 
3482
- # Output only. Title of the attribution.
3497
+ # Output only. The title of the source of the citation.
3483
3498
  # Corresponds to the JSON property `title`
3484
3499
  # @return [String]
3485
3500
  attr_accessor :title
3486
3501
 
3487
- # Output only. Url reference of the attribution.
3502
+ # Output only. The URI of the source of the citation.
3488
3503
  # Corresponds to the JSON property `uri`
3489
3504
  # @return [String]
3490
3505
  attr_accessor :uri
@@ -3504,11 +3519,11 @@ module Google
3504
3519
  end
3505
3520
  end
3506
3521
 
3507
- # A collection of source attributions for a piece of content.
3522
+ # A collection of citations that apply to a piece of generated content.
3508
3523
  class GoogleCloudAiplatformV1CitationMetadata
3509
3524
  include Google::Apis::Core::Hashable
3510
3525
 
3511
- # Output only. List of citations.
3526
+ # Output only. A list of citations for the content.
3512
3527
  # Corresponds to the JSON property `citations`
3513
3528
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Citation>]
3514
3529
  attr_accessor :citations
@@ -4036,22 +4051,21 @@ module Google
4036
4051
  end
4037
4052
  end
4038
4053
 
4039
- # The base structured datatype containing multi-part content of a message. A `
4040
- # Content` includes a `role` field designating the producer of the `Content` and
4041
- # a `parts` field containing multi-part data that contains the content of the
4042
- # message turn.
4054
+ # The structured data content of a message. A Content message contains a `role`
4055
+ # field, which indicates the producer of the content, and a `parts` field, which
4056
+ # contains the multi-part data of the message.
4043
4057
  class GoogleCloudAiplatformV1Content
4044
4058
  include Google::Apis::Core::Hashable
4045
4059
 
4046
- # Required. Ordered `Parts` that constitute a single message. Parts may have
4047
- # different IANA MIME types.
4060
+ # Required. A list of Part objects that make up a single message. Parts of a
4061
+ # message can have different MIME types. A Content message must have at least
4062
+ # one Part.
4048
4063
  # Corresponds to the JSON property `parts`
4049
4064
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Part>]
4050
4065
  attr_accessor :parts
4051
4066
 
4052
- # Optional. The producer of the content. Must be either 'user' or 'model'.
4053
- # Useful to set for multi-turn conversations, otherwise can be left blank or
4054
- # unset.
4067
+ # Optional. The producer of the content. Must be either 'user' or 'model'. If
4068
+ # not set, the service will default to 'user'.
4055
4069
  # Corresponds to the JSON property `role`
4056
4070
  # @return [String]
4057
4071
  attr_accessor :role
@@ -4314,10 +4328,9 @@ module Google
4314
4328
  class GoogleCloudAiplatformV1CorroborateContentRequest
4315
4329
  include Google::Apis::Core::Hashable
4316
4330
 
4317
- # The base structured datatype containing multi-part content of a message. A `
4318
- # Content` includes a `role` field designating the producer of the `Content` and
4319
- # a `parts` field containing multi-part data that contains the content of the
4320
- # message turn.
4331
+ # The structured data content of a message. A Content message contains a `role`
4332
+ # field, which indicates the producer of the content, and a `parts` field, which
4333
+ # contains the multi-part data of the message.
4321
4334
  # Corresponds to the JSON property `content`
4322
4335
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
4323
4336
  attr_accessor :content
@@ -4400,7 +4413,9 @@ module Google
4400
4413
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
4401
4414
  attr_accessor :contents
4402
4415
 
4403
- # Generation config.
4416
+ # Configuration for content generation. This message contains all the parameters
4417
+ # that control how the model generates content. It allows you to influence the
4418
+ # randomness, length, and structure of the output.
4404
4419
  # Corresponds to the JSON property `generationConfig`
4405
4420
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
4406
4421
  attr_accessor :generation_config
@@ -4417,10 +4432,9 @@ module Google
4417
4432
  # @return [String]
4418
4433
  attr_accessor :model
4419
4434
 
4420
- # The base structured datatype containing multi-part content of a message. A `
4421
- # Content` includes a `role` field designating the producer of the `Content` and
4422
- # a `parts` field containing multi-part data that contains the content of the
4423
- # message turn.
4435
+ # The structured data content of a message. A Content message contains a `role`
4436
+ # field, which indicates the producer of the content, and a `parts` field, which
4437
+ # contains the multi-part data of the message.
4424
4438
  # Corresponds to the JSON property `systemInstruction`
4425
4439
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
4426
4440
  attr_accessor :system_instruction
@@ -5112,6 +5126,37 @@ module Google
5112
5126
  end
5113
5127
  end
5114
5128
 
5129
+ # Specificies a metric that is populated by evaluating user-defined Python code.
5130
+ class GoogleCloudAiplatformV1CustomCodeExecutionSpec
5131
+ include Google::Apis::Core::Hashable
5132
+
5133
+ # Required. Python function. Expected user to define the following function, e.g.
5134
+ # : def evaluate(instance: dict[str, Any]) -> float: Please include this
5135
+ # function signature in the code snippet. Instance is the evaluation instance,
5136
+ # any fields populated in the instance are available to the function as instance[
5137
+ # field_name]. Example: Example input: ``` instance= EvaluationInstance(
5138
+ # response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=
5139
+ # EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` `
5140
+ # 'response': `'text': 'The answer is 4.'`, 'reference': `'text': '4'` ` ```
5141
+ # Example python function: ``` def evaluate(instance: dict[str, Any]) -> float:
5142
+ # if instance'response' == instance'reference': return 1.0 return 0.0 ```
5143
+ # CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC)
5144
+ # and Tuning Evaluation. Each line in the input jsonl file will be converted to
5145
+ # dict[str, Any] and passed to the evaluation function.
5146
+ # Corresponds to the JSON property `evaluationFunction`
5147
+ # @return [String]
5148
+ attr_accessor :evaluation_function
5149
+
5150
+ def initialize(**args)
5151
+ update!(**args)
5152
+ end
5153
+
5154
+ # Update properties of this object
5155
+ def update!(**args)
5156
+ @evaluation_function = args[:evaluation_function] if args.key?(:evaluation_function)
5157
+ end
5158
+ end
5159
+
5115
5160
  # Represents a job that runs custom workloads such as a Docker container or a
5116
5161
  # Python package. A CustomJob can have multiple worker pools and each worker
5117
5162
  # pool can have its own machine and input spec. A CustomJob will be cleaned up
@@ -5821,6 +5866,99 @@ module Google
5821
5866
  end
5822
5867
  end
5823
5868
 
5869
+ # Distribution computed over a tuning dataset.
5870
+ class GoogleCloudAiplatformV1DatasetDistribution
5871
+ include Google::Apis::Core::Hashable
5872
+
5873
+ # Output only. Defines the histogram bucket.
5874
+ # Corresponds to the JSON property `buckets`
5875
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetDistributionDistributionBucket>]
5876
+ attr_accessor :buckets
5877
+
5878
+ # Output only. The maximum of the population values.
5879
+ # Corresponds to the JSON property `max`
5880
+ # @return [Float]
5881
+ attr_accessor :max
5882
+
5883
+ # Output only. The arithmetic mean of the values in the population.
5884
+ # Corresponds to the JSON property `mean`
5885
+ # @return [Float]
5886
+ attr_accessor :mean
5887
+
5888
+ # Output only. The median of the values in the population.
5889
+ # Corresponds to the JSON property `median`
5890
+ # @return [Float]
5891
+ attr_accessor :median
5892
+
5893
+ # Output only. The minimum of the population values.
5894
+ # Corresponds to the JSON property `min`
5895
+ # @return [Float]
5896
+ attr_accessor :min
5897
+
5898
+ # Output only. The 5th percentile of the values in the population.
5899
+ # Corresponds to the JSON property `p5`
5900
+ # @return [Float]
5901
+ attr_accessor :p5
5902
+
5903
+ # Output only. The 95th percentile of the values in the population.
5904
+ # Corresponds to the JSON property `p95`
5905
+ # @return [Float]
5906
+ attr_accessor :p95
5907
+
5908
+ # Output only. Sum of a given population of values.
5909
+ # Corresponds to the JSON property `sum`
5910
+ # @return [Float]
5911
+ attr_accessor :sum
5912
+
5913
+ def initialize(**args)
5914
+ update!(**args)
5915
+ end
5916
+
5917
+ # Update properties of this object
5918
+ def update!(**args)
5919
+ @buckets = args[:buckets] if args.key?(:buckets)
5920
+ @max = args[:max] if args.key?(:max)
5921
+ @mean = args[:mean] if args.key?(:mean)
5922
+ @median = args[:median] if args.key?(:median)
5923
+ @min = args[:min] if args.key?(:min)
5924
+ @p5 = args[:p5] if args.key?(:p5)
5925
+ @p95 = args[:p95] if args.key?(:p95)
5926
+ @sum = args[:sum] if args.key?(:sum)
5927
+ end
5928
+ end
5929
+
5930
+ # Dataset bucket used to create a histogram for the distribution given a
5931
+ # population of values.
5932
+ class GoogleCloudAiplatformV1DatasetDistributionDistributionBucket
5933
+ include Google::Apis::Core::Hashable
5934
+
5935
+ # Output only. Number of values in the bucket.
5936
+ # Corresponds to the JSON property `count`
5937
+ # @return [Fixnum]
5938
+ attr_accessor :count
5939
+
5940
+ # Output only. Left bound of the bucket.
5941
+ # Corresponds to the JSON property `left`
5942
+ # @return [Float]
5943
+ attr_accessor :left
5944
+
5945
+ # Output only. Right bound of the bucket.
5946
+ # Corresponds to the JSON property `right`
5947
+ # @return [Float]
5948
+ attr_accessor :right
5949
+
5950
+ def initialize(**args)
5951
+ update!(**args)
5952
+ end
5953
+
5954
+ # Update properties of this object
5955
+ def update!(**args)
5956
+ @count = args[:count] if args.key?(:count)
5957
+ @left = args[:left] if args.key?(:left)
5958
+ @right = args[:right] if args.key?(:right)
5959
+ end
5960
+ end
5961
+
5824
5962
  # Describes the dataset version.
5825
5963
  class GoogleCloudAiplatformV1DatasetVersion
5826
5964
  include Google::Apis::Core::Hashable
@@ -7459,10 +7597,9 @@ module Google
7459
7597
  attr_accessor :auto_truncate
7460
7598
  alias_method :auto_truncate?, :auto_truncate
7461
7599
 
7462
- # The base structured datatype containing multi-part content of a message. A `
7463
- # Content` includes a `role` field designating the producer of the `Content` and
7464
- # a `parts` field containing multi-part data that contains the content of the
7465
- # message turn.
7600
+ # The structured data content of a message. A Content message contains a `role`
7601
+ # field, which indicates the producer of the content, and a `parts` field, which
7602
+ # contains the multi-part data of the message.
7466
7603
  # Corresponds to the JSON property `content`
7467
7604
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
7468
7605
  attr_accessor :content
@@ -8729,11 +8866,6 @@ module Google
8729
8866
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents]
8730
8867
  attr_accessor :events
8731
8868
 
8732
- # A JSON string containing a sequence of events.
8733
- # Corresponds to the JSON property `eventsText`
8734
- # @return [String]
8735
- attr_accessor :events_text
8736
-
8737
8869
  # Represents a list of tools for an agent.
8738
8870
  # Corresponds to the JSON property `tools`
8739
8871
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools]
@@ -8759,7 +8891,6 @@ module Google
8759
8891
  @agent_config = args[:agent_config] if args.key?(:agent_config)
8760
8892
  @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction)
8761
8893
  @events = args[:events] if args.key?(:events)
8762
- @events_text = args[:events_text] if args.key?(:events_text)
8763
8894
  @tools = args[:tools] if args.key?(:tools)
8764
8895
  @tools_text = args[:tools_text] if args.key?(:tools_text)
8765
8896
  end
@@ -9340,7 +9471,9 @@ module Google
9340
9471
  # @return [String]
9341
9472
  attr_accessor :autorater_model
9342
9473
 
9343
- # Generation config.
9474
+ # Configuration for content generation. This message contains all the parameters
9475
+ # that control how the model generates content. It allows you to influence the
9476
+ # randomness, length, and structure of the output.
9344
9477
  # Corresponds to the JSON property `generationConfig`
9345
9478
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
9346
9479
  attr_accessor :generation_config
@@ -9420,7 +9553,9 @@ module Google
9420
9553
  class GoogleCloudAiplatformV1EvaluationRunInferenceConfig
9421
9554
  include Google::Apis::Core::Hashable
9422
9555
 
9423
- # Generation config.
9556
+ # Configuration for content generation. This message contains all the parameters
9557
+ # that control how the model generates content. It allows you to influence the
9558
+ # randomness, length, and structure of the output.
9424
9559
  # Corresponds to the JSON property `generationConfig`
9425
9560
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
9426
9561
  attr_accessor :generation_config
@@ -13464,20 +13599,21 @@ module Google
13464
13599
  end
13465
13600
  end
13466
13601
 
13467
- # URI based data.
13602
+ # URI-based data. A FileData message contains a URI pointing to data of a
13603
+ # specific media type. It is used to represent images, audio, and video stored
13604
+ # in Google Cloud Storage.
13468
13605
  class GoogleCloudAiplatformV1FileData
13469
13606
  include Google::Apis::Core::Hashable
13470
13607
 
13471
- # Optional. Display name of the file data. Used to provide a label or filename
13472
- # to distinguish file datas. This field is only returned in PromptMessage for
13473
- # prompt management. It is currently used in the Gemini GenerateContent calls
13474
- # only when server side tools (code_execution, google_search, and url_context)
13475
- # are enabled.
13608
+ # Optional. The display name of the file. Used to provide a label or filename to
13609
+ # distinguish files. This field is only returned in `PromptMessage` for prompt
13610
+ # management. It is used in the Gemini calls only when server side tools (`
13611
+ # code_execution`, `google_search`, and `url_context`) are enabled.
13476
13612
  # Corresponds to the JSON property `displayName`
13477
13613
  # @return [String]
13478
13614
  attr_accessor :display_name
13479
13615
 
13480
- # Required. URI.
13616
+ # Required. The URI of the file in Google Cloud Storage.
13481
13617
  # Corresponds to the JSON property `fileUri`
13482
13618
  # @return [String]
13483
13619
  attr_accessor :file_uri
@@ -14323,6 +14459,58 @@ module Google
14323
14459
  end
14324
14460
  end
14325
14461
 
14462
+ # Input example for preference optimization.
14463
+ class GoogleCloudAiplatformV1GeminiPreferenceExample
14464
+ include Google::Apis::Core::Hashable
14465
+
14466
+ # List of completions for a given prompt.
14467
+ # Corresponds to the JSON property `completions`
14468
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion>]
14469
+ attr_accessor :completions
14470
+
14471
+ # Multi-turn contents that represents the Prompt.
14472
+ # Corresponds to the JSON property `contents`
14473
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
14474
+ attr_accessor :contents
14475
+
14476
+ def initialize(**args)
14477
+ update!(**args)
14478
+ end
14479
+
14480
+ # Update properties of this object
14481
+ def update!(**args)
14482
+ @completions = args[:completions] if args.key?(:completions)
14483
+ @contents = args[:contents] if args.key?(:contents)
14484
+ end
14485
+ end
14486
+
14487
+ # Completion and its preference score.
14488
+ class GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion
14489
+ include Google::Apis::Core::Hashable
14490
+
14491
+ # The structured data content of a message. A Content message contains a `role`
14492
+ # field, which indicates the producer of the content, and a `parts` field, which
14493
+ # contains the multi-part data of the message.
14494
+ # Corresponds to the JSON property `completion`
14495
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
14496
+ attr_accessor :completion
14497
+
14498
+ # The score for the given completion.
14499
+ # Corresponds to the JSON property `score`
14500
+ # @return [Float]
14501
+ attr_accessor :score
14502
+
14503
+ def initialize(**args)
14504
+ update!(**args)
14505
+ end
14506
+
14507
+ # Update properties of this object
14508
+ def update!(**args)
14509
+ @completion = args[:completion] if args.key?(:completion)
14510
+ @score = args[:score] if args.key?(:score)
14511
+ end
14512
+ end
14513
+
14326
14514
  # Configuration for GenAiAdvancedFeatures.
14327
14515
  class GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig
14328
14516
  include Google::Apis::Core::Hashable
@@ -14384,7 +14572,9 @@ module Google
14384
14572
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
14385
14573
  attr_accessor :contents
14386
14574
 
14387
- # Generation config.
14575
+ # Configuration for content generation. This message contains all the parameters
14576
+ # that control how the model generates content. It allows you to influence the
14577
+ # randomness, length, and structure of the output.
14388
14578
  # Corresponds to the JSON property `generationConfig`
14389
14579
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
14390
14580
  attr_accessor :generation_config
@@ -14398,7 +14588,10 @@ module Google
14398
14588
  # @return [Hash<String,String>]
14399
14589
  attr_accessor :labels
14400
14590
 
14401
- # Configuration for Model Armor integrations of prompt and responses.
14591
+ # Configuration for Model Armor. Model Armor is a Google Cloud service that
14592
+ # provides safety and security filtering for prompts and responses. It helps
14593
+ # protect your AI applications from risks such as harmful content, sensitive
14594
+ # data leakage, and prompt injection attacks.
14402
14595
  # Corresponds to the JSON property `modelArmorConfig`
14403
14596
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelArmorConfig]
14404
14597
  attr_accessor :model_armor_config
@@ -14409,10 +14602,9 @@ module Google
14409
14602
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetySetting>]
14410
14603
  attr_accessor :safety_settings
14411
14604
 
14412
- # The base structured datatype containing multi-part content of a message. A `
14413
- # Content` includes a `role` field designating the producer of the `Content` and
14414
- # a `parts` field containing multi-part data that contains the content of the
14415
- # message turn.
14605
+ # The structured data content of a message. A Content message contains a `role`
14606
+ # field, which indicates the producer of the content, and a `parts` field, which
14607
+ # contains the multi-part data of the message.
14416
14608
  # Corresponds to the JSON property `systemInstruction`
14417
14609
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
14418
14610
  attr_accessor :system_instruction
@@ -14849,92 +15041,111 @@ module Google
14849
15041
  end
14850
15042
  end
14851
15043
 
14852
- # Generation config.
15044
+ # Configuration for content generation. This message contains all the parameters
15045
+ # that control how the model generates content. It allows you to influence the
15046
+ # randomness, length, and structure of the output.
14853
15047
  class GoogleCloudAiplatformV1GenerationConfig
14854
15048
  include Google::Apis::Core::Hashable
14855
15049
 
14856
- # Optional. If enabled, audio timestamp will be included in the request to the
14857
- # model.
15050
+ # Optional. If enabled, audio timestamps will be included in the request to the
15051
+ # model. This can be useful for synchronizing audio with other modalities in the
15052
+ # response.
14858
15053
  # Corresponds to the JSON property `audioTimestamp`
14859
15054
  # @return [Boolean]
14860
15055
  attr_accessor :audio_timestamp
14861
15056
  alias_method :audio_timestamp?, :audio_timestamp
14862
15057
 
14863
- # Optional. Number of candidates to generate.
15058
+ # Optional. The number of candidate responses to generate. A higher `
15059
+ # candidate_count` can provide more options to choose from, but it also consumes
15060
+ # more resources. This can be useful for generating a variety of responses and
15061
+ # selecting the best one.
14864
15062
  # Corresponds to the JSON property `candidateCount`
14865
15063
  # @return [Fixnum]
14866
15064
  attr_accessor :candidate_count
14867
15065
 
14868
15066
  # Optional. If enabled, the model will detect emotions and adapt its responses
14869
- # accordingly.
15067
+ # accordingly. For example, if the model detects that the user is frustrated, it
15068
+ # may provide a more empathetic response.
14870
15069
  # Corresponds to the JSON property `enableAffectiveDialog`
14871
15070
  # @return [Boolean]
14872
15071
  attr_accessor :enable_affective_dialog
14873
15072
  alias_method :enable_affective_dialog?, :enable_affective_dialog
14874
15073
 
14875
- # Optional. Frequency penalties.
15074
+ # Optional. Penalizes tokens based on their frequency in the generated text. A
15075
+ # positive value helps to reduce the repetition of words and phrases. Valid
15076
+ # values can range from [-2.0, 2.0].
14876
15077
  # Corresponds to the JSON property `frequencyPenalty`
14877
15078
  # @return [Float]
14878
15079
  attr_accessor :frequency_penalty
14879
15080
 
14880
- # Config for image generation features.
15081
+ # Configuration for image generation. This message allows you to control various
15082
+ # aspects of image generation, such as the output format, aspect ratio, and
15083
+ # whether the model can generate images of people.
14881
15084
  # Corresponds to the JSON property `imageConfig`
14882
15085
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImageConfig]
14883
15086
  attr_accessor :image_config
14884
15087
 
14885
- # Optional. Logit probabilities.
15088
+ # Optional. The number of top log probabilities to return for each token. This
15089
+ # can be used to see which other tokens were considered likely candidates for a
15090
+ # given position. A higher value will return more options, but it will also
15091
+ # increase the size of the response.
14886
15092
  # Corresponds to the JSON property `logprobs`
14887
15093
  # @return [Fixnum]
14888
15094
  attr_accessor :logprobs
14889
15095
 
14890
- # Optional. The maximum number of output tokens to generate per message.
15096
+ # Optional. The maximum number of tokens to generate in the response. A token is
15097
+ # approximately four characters. The default value varies by model. This
15098
+ # parameter can be used to control the length of the generated text and prevent
15099
+ # overly long responses.
14891
15100
  # Corresponds to the JSON property `maxOutputTokens`
14892
15101
  # @return [Fixnum]
14893
15102
  attr_accessor :max_output_tokens
14894
15103
 
14895
- # Optional. If specified, the media resolution specified will be used.
15104
+ # Optional. The token resolution at which input media content is sampled. This
15105
+ # is used to control the trade-off between the quality of the response and the
15106
+ # number of tokens used to represent the media. A higher resolution allows the
15107
+ # model to perceive more detail, which can lead to a more nuanced response, but
15108
+ # it will also use more tokens. This does not affect the image dimensions sent
15109
+ # to the model.
14896
15110
  # Corresponds to the JSON property `mediaResolution`
14897
15111
  # @return [String]
14898
15112
  attr_accessor :media_resolution
14899
15113
 
14900
- # Optional. Positive penalties.
15114
+ # Optional. Penalizes tokens that have already appeared in the generated text. A
15115
+ # positive value encourages the model to generate more diverse and less
15116
+ # repetitive text. Valid values can range from [-2.0, 2.0].
14901
15117
  # Corresponds to the JSON property `presencePenalty`
14902
15118
  # @return [Float]
14903
15119
  attr_accessor :presence_penalty
14904
15120
 
14905
- # Optional. Output schema of the generated response. This is an alternative to `
14906
- # response_schema` that accepts [JSON Schema](https://json-schema.org/). If set,
14907
- # `response_schema` must be omitted, but `response_mime_type` is required. While
14908
- # the full JSON Schema may be sent, not all features are supported. Specifically,
14909
- # only the following properties are supported: - `$id` - `$defs` - `$ref` - `$
14910
- # anchor` - `type` - `format` - `title` - `description` - `enum` (for strings
14911
- # and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` -
14912
- # `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties`
14913
- # - `additionalProperties` - `required` The non-standard `propertyOrdering`
14914
- # property may also be set. Cyclic references are unrolled to a limited degree
14915
- # and, as such, may only be used within non-required properties. (Nullable
14916
- # properties are not sufficient.) If `$ref` is set on a sub-schema, no other
14917
- # properties, except for than those starting as a `$`, may be set.
15121
+ # Optional. When this field is set, response_schema must be omitted and
15122
+ # response_mime_type must be set to `application/json`.
14918
15123
  # Corresponds to the JSON property `responseJsonSchema`
14919
15124
  # @return [Object]
14920
15125
  attr_accessor :response_json_schema
14921
15126
 
14922
- # Optional. If true, export the logprobs results in response.
15127
+ # Optional. If set to true, the log probabilities of the output tokens are
15128
+ # returned. Log probabilities are the logarithm of the probability of a token
15129
+ # appearing in the output. A higher log probability means the token is more
15130
+ # likely to be generated. This can be useful for analyzing the model's
15131
+ # confidence in its own output and for debugging.
14923
15132
  # Corresponds to the JSON property `responseLogprobs`
14924
15133
  # @return [Boolean]
14925
15134
  attr_accessor :response_logprobs
14926
15135
  alias_method :response_logprobs?, :response_logprobs
14927
15136
 
14928
- # Optional. Output response mimetype of the generated candidate text. Supported
14929
- # mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON
14930
- # response in the candidates. The model needs to be prompted to output the
15137
+ # Optional. The IANA standard MIME type of the response. The model will generate
15138
+ # output that conforms to this MIME type. Supported values include 'text/plain' (
15139
+ # default) and 'application/json'. The model needs to be prompted to output the
14931
15140
  # appropriate response type, otherwise the behavior is undefined. This is a
14932
15141
  # preview feature.
14933
15142
  # Corresponds to the JSON property `responseMimeType`
14934
15143
  # @return [String]
14935
15144
  attr_accessor :response_mime_type
14936
15145
 
14937
- # Optional. The modalities of the response.
15146
+ # Optional. The modalities of the response. The model will generate a response
15147
+ # that includes all the specified modalities. For example, if this is set to `[
15148
+ # TEXT, IMAGE]`, the response will include both text and an image.
14938
15149
  # Corresponds to the JSON property `responseModalities`
14939
15150
  # @return [Array<String>]
14940
15151
  attr_accessor :response_modalities
@@ -14946,42 +15157,68 @@ module Google
14946
15157
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema]
14947
15158
  attr_accessor :response_schema
14948
15159
 
14949
- # The configuration for routing the request to a specific model.
15160
+ # The configuration for routing the request to a specific model. This can be
15161
+ # used to control which model is used for the generation, either automatically
15162
+ # or by specifying a model name.
14950
15163
  # Corresponds to the JSON property `routingConfig`
14951
15164
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigRoutingConfig]
14952
15165
  attr_accessor :routing_config
14953
15166
 
14954
- # Optional. Seed.
15167
+ # Optional. A seed for the random number generator. By setting a seed, you can
15168
+ # make the model's output mostly deterministic. For a given prompt and
15169
+ # parameters (like temperature, top_p, etc.), the model will produce the same
15170
+ # response every time. However, it's not a guaranteed absolute deterministic
15171
+ # behavior. This is different from parameters like `temperature`, which control
15172
+ # the *level* of randomness. `seed` ensures that the "random" choices the model
15173
+ # makes are the same on every run, making it essential for testing and ensuring
15174
+ # reproducible results.
14955
15175
  # Corresponds to the JSON property `seed`
14956
15176
  # @return [Fixnum]
14957
15177
  attr_accessor :seed
14958
15178
 
14959
- # The speech generation config.
15179
+ # Configuration for speech generation.
14960
15180
  # Corresponds to the JSON property `speechConfig`
14961
15181
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpeechConfig]
14962
15182
  attr_accessor :speech_config
14963
15183
 
14964
- # Optional. Stop sequences.
15184
+ # Optional. A list of character sequences that will stop the model from
15185
+ # generating further tokens. If a stop sequence is generated, the output will
15186
+ # end at that point. This is useful for controlling the length and structure of
15187
+ # the output. For example, you can use ["\n", "###"] to stop generation at a new
15188
+ # line or a specific marker.
14965
15189
  # Corresponds to the JSON property `stopSequences`
14966
15190
  # @return [Array<String>]
14967
15191
  attr_accessor :stop_sequences
14968
15192
 
14969
- # Optional. Controls the randomness of predictions.
15193
+ # Optional. Controls the randomness of the output. A higher temperature results
15194
+ # in more creative and diverse responses, while a lower temperature makes the
15195
+ # output more predictable and focused. The valid range is (0.0, 2.0].
14970
15196
  # Corresponds to the JSON property `temperature`
14971
15197
  # @return [Float]
14972
15198
  attr_accessor :temperature
14973
15199
 
14974
- # Config for thinking features.
15200
+ # Configuration for the model's thinking features. "Thinking" is a process where
15201
+ # the model breaks down a complex task into smaller, manageable steps. This
15202
+ # allows the model to reason about the task, plan its approach, and execute the
15203
+ # plan to generate a high-quality response.
14975
15204
  # Corresponds to the JSON property `thinkingConfig`
14976
15205
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigThinkingConfig]
14977
15206
  attr_accessor :thinking_config
14978
15207
 
14979
- # Optional. If specified, top-k sampling will be used.
15208
+ # Optional. Specifies the top-k sampling threshold. The model considers only the
15209
+ # top k most probable tokens for the next token. This can be useful for
15210
+ # generating more coherent and less random text. For example, a `top_k` of 40
15211
+ # means the model will choose the next word from the 40 most likely words.
14980
15212
  # Corresponds to the JSON property `topK`
14981
15213
  # @return [Float]
14982
15214
  attr_accessor :top_k
14983
15215
 
14984
- # Optional. If specified, nucleus sampling will be used.
15216
+ # Optional. Specifies the nucleus sampling threshold. The model considers only
15217
+ # the smallest set of tokens whose cumulative probability is at least `top_p`.
15218
+ # This helps generate more diverse and less repetitive responses. For example, a
15219
+ # `top_p` of 0.9 means the model considers tokens until the cumulative
15220
+ # probability of the tokens to select from reaches 0.9. It's recommended to
15221
+ # adjust either temperature or `top_p`, but not both.
14985
15222
  # Corresponds to the JSON property `topP`
14986
15223
  # @return [Float]
14987
15224
  attr_accessor :top_p
@@ -15017,17 +15254,21 @@ module Google
15017
15254
  end
15018
15255
  end
15019
15256
 
15020
- # The configuration for routing the request to a specific model.
15257
+ # The configuration for routing the request to a specific model. This can be
15258
+ # used to control which model is used for the generation, either automatically
15259
+ # or by specifying a model name.
15021
15260
  class GoogleCloudAiplatformV1GenerationConfigRoutingConfig
15022
15261
  include Google::Apis::Core::Hashable
15023
15262
 
15024
- # When automated routing is specified, the routing will be determined by the
15025
- # pretrained routing model and customer provided model routing preference.
15263
+ # The configuration for automated routing. When automated routing is specified,
15264
+ # the routing will be determined by the pretrained routing model and customer
15265
+ # provided model routing preference.
15026
15266
  # Corresponds to the JSON property `autoMode`
15027
15267
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode]
15028
15268
  attr_accessor :auto_mode
15029
15269
 
15030
- # When manual routing is set, the specified model will be used directly.
15270
+ # The configuration for manual routing. When manual routing is specified, the
15271
+ # model will be selected based on the model name provided.
15031
15272
  # Corresponds to the JSON property `manualMode`
15032
15273
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode]
15033
15274
  attr_accessor :manual_mode
@@ -15043,8 +15284,9 @@ module Google
15043
15284
  end
15044
15285
  end
15045
15286
 
15046
- # When automated routing is specified, the routing will be determined by the
15047
- # pretrained routing model and customer provided model routing preference.
15287
+ # The configuration for automated routing. When automated routing is specified,
15288
+ # the routing will be determined by the pretrained routing model and customer
15289
+ # provided model routing preference.
15048
15290
  class GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode
15049
15291
  include Google::Apis::Core::Hashable
15050
15292
 
@@ -15063,13 +15305,12 @@ module Google
15063
15305
  end
15064
15306
  end
15065
15307
 
15066
- # When manual routing is set, the specified model will be used directly.
15308
+ # The configuration for manual routing. When manual routing is specified, the
15309
+ # model will be selected based on the model name provided.
15067
15310
  class GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode
15068
15311
  include Google::Apis::Core::Hashable
15069
15312
 
15070
- # The model name to use. Only the public LLM models are accepted. See [Supported
15071
- # models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/
15072
- # inference#supported-models).
15313
+ # The name of the model to use. Only public LLM models are accepted.
15073
15314
  # Corresponds to the JSON property `modelName`
15074
15315
  # @return [String]
15075
15316
  attr_accessor :model_name
@@ -15084,18 +15325,26 @@ module Google
15084
15325
  end
15085
15326
  end
15086
15327
 
15087
- # Config for thinking features.
15328
+ # Configuration for the model's thinking features. "Thinking" is a process where
15329
+ # the model breaks down a complex task into smaller, manageable steps. This
15330
+ # allows the model to reason about the task, plan its approach, and execute the
15331
+ # plan to generate a high-quality response.
15088
15332
  class GoogleCloudAiplatformV1GenerationConfigThinkingConfig
15089
15333
  include Google::Apis::Core::Hashable
15090
15334
 
15091
- # Optional. Indicates whether to include thoughts in the response. If true,
15092
- # thoughts are returned only when available.
15335
+ # Optional. If true, the model will include its thoughts in the response. "
15336
+ # Thoughts" are the intermediate steps the model takes to arrive at the final
15337
+ # response. They can provide insights into the model's reasoning process and
15338
+ # help with debugging. If this is true, thoughts are returned only when
15339
+ # available.
15093
15340
  # Corresponds to the JSON property `includeThoughts`
15094
15341
  # @return [Boolean]
15095
15342
  attr_accessor :include_thoughts
15096
15343
  alias_method :include_thoughts?, :include_thoughts
15097
15344
 
15098
- # Optional. Indicates the thinking budget in tokens.
15345
+ # Optional. The token budget for the model's thinking process. The model will
15346
+ # make a best effort to stay within this budget. This can be used to control the
15347
+ # trade-off between response quality and latency.
15099
15348
  # Corresponds to the JSON property `thinkingBudget`
15100
15349
  # @return [Fixnum]
15101
15350
  attr_accessor :thinking_budget
@@ -15349,21 +15598,30 @@ module Google
15349
15598
  end
15350
15599
  end
15351
15600
 
15352
- # Grounding chunk.
15601
+ # A piece of evidence that supports a claim made by the model. This is used to
15602
+ # show a citation for a claim made by the model. When grounding is enabled, the
15603
+ # model returns a `GroundingChunk` that contains a reference to the source of
15604
+ # the information.
15353
15605
  class GoogleCloudAiplatformV1GroundingChunk
15354
15606
  include Google::Apis::Core::Hashable
15355
15607
 
15356
- # Chunk from Google Maps.
15608
+ # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
15609
+ # information about a place, such as its name, address, and reviews. This is
15610
+ # used to provide the user with rich, location-based information.
15357
15611
  # Corresponds to the JSON property `maps`
15358
15612
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkMaps]
15359
15613
  attr_accessor :maps
15360
15614
 
15361
- # Chunk from context retrieved by the retrieval tools.
15615
+ # Context retrieved from a data source to ground the model's response. This is
15616
+ # used when a retrieval tool fetches information from a user-provided corpus or
15617
+ # a public dataset.
15362
15618
  # Corresponds to the JSON property `retrievedContext`
15363
15619
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkRetrievedContext]
15364
15620
  attr_accessor :retrieved_context
15365
15621
 
15366
- # Chunk from the web.
15622
+ # A `Web` chunk is a piece of evidence that comes from a web page. It contains
15623
+ # the URI of the web page, the title of the page, and the domain of the page.
15624
+ # This is used to provide the user with a link to the source of the information.
15367
15625
  # Corresponds to the JSON property `web`
15368
15626
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkWeb]
15369
15627
  attr_accessor :web
@@ -15380,32 +15638,36 @@ module Google
15380
15638
  end
15381
15639
  end
15382
15640
 
15383
- # Chunk from Google Maps.
15641
+ # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
15642
+ # information about a place, such as its name, address, and reviews. This is
15643
+ # used to provide the user with rich, location-based information.
15384
15644
  class GoogleCloudAiplatformV1GroundingChunkMaps
15385
15645
  include Google::Apis::Core::Hashable
15386
15646
 
15387
- # Sources used to generate the place answer.
15647
+ # The sources that were used to generate the place answer. This includes review
15648
+ # snippets and photos that were used to generate the answer, as well as URIs to
15649
+ # flag content.
15388
15650
  # Corresponds to the JSON property `placeAnswerSources`
15389
15651
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources]
15390
15652
  attr_accessor :place_answer_sources
15391
15653
 
15392
- # This Place's resource name, in `places/`place_id`` format. Can be used to look
15393
- # up the Place.
15654
+ # This Place's resource name, in `places/`place_id`` format. This can be used to
15655
+ # look up the place in the Google Maps API.
15394
15656
  # Corresponds to the JSON property `placeId`
15395
15657
  # @return [String]
15396
15658
  attr_accessor :place_id
15397
15659
 
15398
- # Text of the place answer.
15660
+ # The text of the place answer.
15399
15661
  # Corresponds to the JSON property `text`
15400
15662
  # @return [String]
15401
15663
  attr_accessor :text
15402
15664
 
15403
- # Title of the place.
15665
+ # The title of the place.
15404
15666
  # Corresponds to the JSON property `title`
15405
15667
  # @return [String]
15406
15668
  attr_accessor :title
15407
15669
 
15408
- # URI reference of the place.
15670
+ # The URI of the place.
15409
15671
  # Corresponds to the JSON property `uri`
15410
15672
  # @return [String]
15411
15673
  attr_accessor :uri
@@ -15424,11 +15686,13 @@ module Google
15424
15686
  end
15425
15687
  end
15426
15688
 
15427
- # Sources used to generate the place answer.
15689
+ # The sources that were used to generate the place answer. This includes review
15690
+ # snippets and photos that were used to generate the answer, as well as URIs to
15691
+ # flag content.
15428
15692
  class GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources
15429
15693
  include Google::Apis::Core::Hashable
15430
15694
 
15431
- # Snippets of reviews that are used to generate the answer.
15695
+ # Snippets of reviews that were used to generate the answer.
15432
15696
  # Corresponds to the JSON property `reviewSnippets`
15433
15697
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet>]
15434
15698
  attr_accessor :review_snippets
@@ -15443,7 +15707,7 @@ module Google
15443
15707
  end
15444
15708
  end
15445
15709
 
15446
- # Encapsulates a review snippet.
15710
+ # A review snippet that is used to generate the answer.
15447
15711
  class GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
15448
15712
  include Google::Apis::Core::Hashable
15449
15713
 
@@ -15452,12 +15716,12 @@ module Google
15452
15716
  # @return [String]
15453
15717
  attr_accessor :google_maps_uri
15454
15718
 
15455
- # Id of the review referencing the place.
15719
+ # The ID of the review that is being referenced.
15456
15720
  # Corresponds to the JSON property `reviewId`
15457
15721
  # @return [String]
15458
15722
  attr_accessor :review_id
15459
15723
 
15460
- # Title of the review.
15724
+ # The title of the review.
15461
15725
  # Corresponds to the JSON property `title`
15462
15726
  # @return [String]
15463
15727
  attr_accessor :title
@@ -15474,12 +15738,16 @@ module Google
15474
15738
  end
15475
15739
  end
15476
15740
 
15477
- # Chunk from context retrieved by the retrieval tools.
15741
+ # Context retrieved from a data source to ground the model's response. This is
15742
+ # used when a retrieval tool fetches information from a user-provided corpus or
15743
+ # a public dataset.
15478
15744
  class GoogleCloudAiplatformV1GroundingChunkRetrievedContext
15479
15745
  include Google::Apis::Core::Hashable
15480
15746
 
15481
- # Output only. The full document name for the referenced Vertex AI Search
15482
- # document.
15747
+ # Output only. The full resource name of the referenced Vertex AI Search
15748
+ # document. This is used to identify the specific document that was retrieved.
15749
+ # The format is `projects/`project`/locations/`location`/collections/`collection`
15750
+ # /dataStores/`data_store`/branches/`branch`/documents/`document``.
15483
15751
  # Corresponds to the JSON property `documentName`
15484
15752
  # @return [String]
15485
15753
  attr_accessor :document_name
@@ -15490,17 +15758,17 @@ module Google
15490
15758
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagChunk]
15491
15759
  attr_accessor :rag_chunk
15492
15760
 
15493
- # Text of the attribution.
15761
+ # The content of the retrieved data source.
15494
15762
  # Corresponds to the JSON property `text`
15495
15763
  # @return [String]
15496
15764
  attr_accessor :text
15497
15765
 
15498
- # Title of the attribution.
15766
+ # The title of the retrieved data source.
15499
15767
  # Corresponds to the JSON property `title`
15500
15768
  # @return [String]
15501
15769
  attr_accessor :title
15502
15770
 
15503
- # URI reference of the attribution.
15771
+ # The URI of the retrieved data source.
15504
15772
  # Corresponds to the JSON property `uri`
15505
15773
  # @return [String]
15506
15774
  attr_accessor :uri
@@ -15519,21 +15787,24 @@ module Google
15519
15787
  end
15520
15788
  end
15521
15789
 
15522
- # Chunk from the web.
15790
+ # A `Web` chunk is a piece of evidence that comes from a web page. It contains
15791
+ # the URI of the web page, the title of the page, and the domain of the page.
15792
+ # This is used to provide the user with a link to the source of the information.
15523
15793
  class GoogleCloudAiplatformV1GroundingChunkWeb
15524
15794
  include Google::Apis::Core::Hashable
15525
15795
 
15526
- # Domain of the (original) URI.
15796
+ # The domain of the web page that contains the evidence. This can be used to
15797
+ # filter out low-quality sources.
15527
15798
  # Corresponds to the JSON property `domain`
15528
15799
  # @return [String]
15529
15800
  attr_accessor :domain
15530
15801
 
15531
- # Title of the chunk.
15802
+ # The title of the web page that contains the evidence.
15532
15803
  # Corresponds to the JSON property `title`
15533
15804
  # @return [String]
15534
15805
  attr_accessor :title
15535
15806
 
15536
- # URI reference of the chunk.
15807
+ # The URI of the web page that contains the evidence.
15537
15808
  # Corresponds to the JSON property `uri`
15538
15809
  # @return [String]
15539
15810
  attr_accessor :uri
@@ -15550,44 +15821,56 @@ module Google
15550
15821
  end
15551
15822
  end
15552
15823
 
15553
- # Metadata returned to client when grounding is enabled.
15824
+ # Information about the sources that support the content of a response. When
15825
+ # grounding is enabled, the model returns citations for claims in the response.
15826
+ # This object contains the retrieved sources.
15554
15827
  class GoogleCloudAiplatformV1GroundingMetadata
15555
15828
  include Google::Apis::Core::Hashable
15556
15829
 
15557
- # Optional. Output only. Resource name of the Google Maps widget context token
15558
- # to be used with the PlacesContextElement widget to render contextual data.
15559
- # This is populated only for Google Maps grounding.
15830
+ # Optional. Output only. A token that can be used to render a Google Maps widget
15831
+ # with the contextual data. This field is populated only when the grounding
15832
+ # source is Google Maps.
15560
15833
  # Corresponds to the JSON property `googleMapsWidgetContextToken`
15561
15834
  # @return [String]
15562
15835
  attr_accessor :google_maps_widget_context_token
15563
15836
 
15564
- # List of supporting references retrieved from specified grounding source.
15837
+ # A list of supporting references retrieved from the grounding source. This
15838
+ # field is populated when the grounding source is Google Search, Vertex AI
15839
+ # Search, or Google Maps.
15565
15840
  # Corresponds to the JSON property `groundingChunks`
15566
15841
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunk>]
15567
15842
  attr_accessor :grounding_chunks
15568
15843
 
15569
- # Optional. List of grounding support.
15844
+ # Optional. A list of grounding supports that connect the generated content to
15845
+ # the grounding chunks. This field is populated when the grounding source is
15846
+ # Google Search or Vertex AI Search.
15570
15847
  # Corresponds to the JSON property `groundingSupports`
15571
15848
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingSupport>]
15572
15849
  attr_accessor :grounding_supports
15573
15850
 
15574
- # Metadata related to retrieval in the grounding flow.
15851
+ # Metadata related to the retrieval grounding source. This is part of the `
15852
+ # GroundingMetadata` returned when grounding is enabled.
15575
15853
  # Corresponds to the JSON property `retrievalMetadata`
15576
15854
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrievalMetadata]
15577
15855
  attr_accessor :retrieval_metadata
15578
15856
 
15579
- # Google search entry point.
15857
+ # An entry point for displaying Google Search results. A `SearchEntryPoint` is
15858
+ # populated when the grounding source for a model's response is Google Search.
15859
+ # It provides information that you can use to display the search results in your
15860
+ # application.
15580
15861
  # Corresponds to the JSON property `searchEntryPoint`
15581
15862
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchEntryPoint]
15582
15863
  attr_accessor :search_entry_point
15583
15864
 
15584
- # Optional. Output only. List of source flagging uris. This is currently
15585
- # populated only for Google Maps grounding.
15865
+ # Optional. Output only. A list of URIs that can be used to flag a place or
15866
+ # review for inappropriate content. This field is populated only when the
15867
+ # grounding source is Google Maps.
15586
15868
  # Corresponds to the JSON property `sourceFlaggingUris`
15587
15869
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri>]
15588
15870
  attr_accessor :source_flagging_uris
15589
15871
 
15590
- # Optional. Web search queries for the following-up web search.
15872
+ # Optional. The web search queries that were used to generate the content. This
15873
+ # field is populated only when the grounding source is Google Search.
15591
15874
  # Corresponds to the JSON property `webSearchQueries`
15592
15875
  # @return [Array<String>]
15593
15876
  attr_accessor :web_search_queries
@@ -15608,17 +15891,17 @@ module Google
15608
15891
  end
15609
15892
  end
15610
15893
 
15611
- # Source content flagging uri for a place or review. This is currently populated
15612
- # only for Google Maps grounding.
15894
+ # A URI that can be used to flag a place or review for inappropriate content.
15895
+ # This is populated only when the grounding source is Google Maps.
15613
15896
  class GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri
15614
15897
  include Google::Apis::Core::Hashable
15615
15898
 
15616
- # A link where users can flag a problem with the source (place or review).
15899
+ # The URI that can be used to flag the content.
15617
15900
  # Corresponds to the JSON property `flagContentUri`
15618
15901
  # @return [String]
15619
15902
  attr_accessor :flag_content_uri
15620
15903
 
15621
- # Id of the place or review.
15904
+ # The ID of the place or review.
15622
15905
  # Corresponds to the JSON property `sourceId`
15623
15906
  # @return [String]
15624
15907
  attr_accessor :source_id
@@ -15634,27 +15917,30 @@ module Google
15634
15917
  end
15635
15918
  end
15636
15919
 
15637
- # Grounding support.
15920
+ # A collection of supporting references for a segment of the model's response.
15638
15921
  class GoogleCloudAiplatformV1GroundingSupport
15639
15922
  include Google::Apis::Core::Hashable
15640
15923
 
15641
- # Confidence score of the support references. Ranges from 0 to 1. 1 is the most
15642
- # confident. For Gemini 2.0 and before, this list must have the same size as the
15643
- # grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and
15924
+ # The confidence scores for the support references. This list is parallel to the
15925
+ # `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a
15926
+ # higher score indicating a higher confidence that the reference supports the
15927
+ # claim. For Gemini 2.0 and before, this list has the same size as `
15928
+ # grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and
15644
15929
  # should be ignored.
15645
15930
  # Corresponds to the JSON property `confidenceScores`
15646
15931
  # @return [Array<Float>]
15647
15932
  attr_accessor :confidence_scores
15648
15933
 
15649
- # A list of indices (into 'grounding_chunk') specifying the citations associated
15650
- # with the claim. For instance [1,3,4] means that grounding_chunk[1],
15651
- # grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to
15652
- # the claim.
15934
+ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata`
15935
+ # message. These indices specify which grounding chunks support the claim made
15936
+ # in the content segment. For example, if this field has the values `[1, 3]`, it
15937
+ # means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for
15938
+ # the claim in the content segment.
15653
15939
  # Corresponds to the JSON property `groundingChunkIndices`
15654
15940
  # @return [Array<Fixnum>]
15655
15941
  attr_accessor :grounding_chunk_indices
15656
15942
 
15657
- # Segment of the content.
15943
+ # A segment of the content.
15658
15944
  # Corresponds to the JSON property `segment`
15659
15945
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Segment]
15660
15946
  attr_accessor :segment
@@ -15833,7 +16119,9 @@ module Google
15833
16119
  end
15834
16120
  end
15835
16121
 
15836
- # Config for image generation features.
16122
+ # Configuration for image generation. This message allows you to control various
16123
+ # aspects of image generation, such as the output format, aspect ratio, and
16124
+ # whether the model can generate images of people.
15837
16125
  class GoogleCloudAiplatformV1ImageConfig
15838
16126
  include Google::Apis::Core::Hashable
15839
16127
 
@@ -18748,17 +19036,24 @@ module Google
18748
19036
  end
18749
19037
  end
18750
19038
 
18751
- # Logprobs Result
19039
+ # The log probabilities of the tokens generated by the model. This is useful for
19040
+ # understanding the model's confidence in its predictions and for debugging. For
19041
+ # example, you can use log probabilities to identify when the model is making a
19042
+ # less confident prediction or to explore alternative responses that the model
19043
+ # considered. A low log probability can also indicate that the model is "
19044
+ # hallucinating" or generating factually incorrect information.
18752
19045
  class GoogleCloudAiplatformV1LogprobsResult
18753
19046
  include Google::Apis::Core::Hashable
18754
19047
 
18755
- # Length = total number of decoding steps. The chosen candidates may or may not
18756
- # be in top_candidates.
19048
+ # A list of the chosen candidate tokens at each decoding step. The length of
19049
+ # this list is equal to the total number of decoding steps. Note that the chosen
19050
+ # candidate might not be in `top_candidates`.
18757
19051
  # Corresponds to the JSON property `chosenCandidates`
18758
19052
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LogprobsResultCandidate>]
18759
19053
  attr_accessor :chosen_candidates
18760
19054
 
18761
- # Length = total number of decoding steps.
19055
+ # A list of the top candidate tokens at each decoding step. The length of this
19056
+ # list is equal to the total number of decoding steps.
18762
19057
  # Corresponds to the JSON property `topCandidates`
18763
19058
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LogprobsResultTopCandidates>]
18764
19059
  attr_accessor :top_candidates
@@ -18774,21 +19069,27 @@ module Google
18774
19069
  end
18775
19070
  end
18776
19071
 
18777
- # Candidate for the logprobs token and score.
19072
+ # A single token and its associated log probability.
18778
19073
  class GoogleCloudAiplatformV1LogprobsResultCandidate
18779
19074
  include Google::Apis::Core::Hashable
18780
19075
 
18781
- # The candidate's log probability.
19076
+ # The log probability of this token. A higher value indicates that the model was
19077
+ # more confident in this token. The log probability can be used to assess the
19078
+ # relative likelihood of different tokens and to identify when the model is
19079
+ # uncertain.
18782
19080
  # Corresponds to the JSON property `logProbability`
18783
19081
  # @return [Float]
18784
19082
  attr_accessor :log_probability
18785
19083
 
18786
- # The candidate's token string value.
19084
+ # The token's string representation.
18787
19085
  # Corresponds to the JSON property `token`
18788
19086
  # @return [String]
18789
19087
  attr_accessor :token
18790
19088
 
18791
- # The candidate's token id value.
19089
+ # The token's numerical ID. While the `token` field provides the string
19090
+ # representation of the token, the `token_id` is the numerical representation
19091
+ # that the model uses internally. This can be useful for developers who want to
19092
+ # build custom logic based on the model's vocabulary.
18792
19093
  # Corresponds to the JSON property `tokenId`
18793
19094
  # @return [Fixnum]
18794
19095
  attr_accessor :token_id
@@ -18805,11 +19106,12 @@ module Google
18805
19106
  end
18806
19107
  end
18807
19108
 
18808
- # Candidates with top log probabilities at each decoding step.
19109
+ # A list of the top candidate tokens and their log probabilities at each
19110
+ # decoding step. This can be used to see what other tokens the model considered.
18809
19111
  class GoogleCloudAiplatformV1LogprobsResultTopCandidates
18810
19112
  include Google::Apis::Core::Hashable
18811
19113
 
18812
- # Sorted by log probability in descending order.
19114
+ # The list of candidate tokens, sorted by log probability in descending order.
18813
19115
  # Corresponds to the JSON property `candidates`
18814
19116
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LogprobsResultCandidate>]
18815
19117
  attr_accessor :candidates
@@ -19212,6 +19514,11 @@ module Google
19212
19514
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BleuSpec]
19213
19515
  attr_accessor :bleu_spec
19214
19516
 
19517
+ # Specificies a metric that is populated by evaluating user-defined Python code.
19518
+ # Corresponds to the JSON property `customCodeExecutionSpec`
19519
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomCodeExecutionSpec]
19520
+ attr_accessor :custom_code_execution_spec
19521
+
19215
19522
  # Spec for exact match metric - returns 1 if prediction and reference exactly
19216
19523
  # matches, otherwise 0.
19217
19524
  # Corresponds to the JSON property `exactMatchSpec`
@@ -19252,6 +19559,7 @@ module Google
19252
19559
  def update!(**args)
19253
19560
  @aggregation_metrics = args[:aggregation_metrics] if args.key?(:aggregation_metrics)
19254
19561
  @bleu_spec = args[:bleu_spec] if args.key?(:bleu_spec)
19562
+ @custom_code_execution_spec = args[:custom_code_execution_spec] if args.key?(:custom_code_execution_spec)
19255
19563
  @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec)
19256
19564
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
19257
19565
  @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec)
@@ -19822,16 +20130,21 @@ module Google
19822
20130
  end
19823
20131
  end
19824
20132
 
19825
- # Represents token counting info for a single modality.
20133
+ # Represents a breakdown of token usage by modality. This message is used in
20134
+ # CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a
20135
+ # detailed view of how many tokens are used by each modality (e.g., text, image,
20136
+ # video) in a request. This is particularly useful for multimodal models,
20137
+ # allowing you to track and manage token consumption for billing and quota
20138
+ # purposes.
19826
20139
  class GoogleCloudAiplatformV1ModalityTokenCount
19827
20140
  include Google::Apis::Core::Hashable
19828
20141
 
19829
- # The modality associated with this token count.
20142
+ # The modality that this token count applies to.
19830
20143
  # Corresponds to the JSON property `modality`
19831
20144
  # @return [String]
19832
20145
  attr_accessor :modality
19833
20146
 
19834
- # Number of tokens.
20147
+ # The number of tokens counted for this modality.
19835
20148
  # Corresponds to the JSON property `tokenCount`
19836
20149
  # @return [Fixnum]
19837
20150
  attr_accessor :token_count
@@ -20144,17 +20457,29 @@ module Google
20144
20457
  end
20145
20458
  end
20146
20459
 
20147
- # Configuration for Model Armor integrations of prompt and responses.
20460
+ # Configuration for Model Armor. Model Armor is a Google Cloud service that
20461
+ # provides safety and security filtering for prompts and responses. It helps
20462
+ # protect your AI applications from risks such as harmful content, sensitive
20463
+ # data leakage, and prompt injection attacks.
20148
20464
  class GoogleCloudAiplatformV1ModelArmorConfig
20149
20465
  include Google::Apis::Core::Hashable
20150
20466
 
20151
- # Optional. The name of the Model Armor template to use for prompt sanitization.
20467
+ # Optional. The resource name of the Model Armor template to use for prompt
20468
+ # screening. A Model Armor template is a set of customized filters and
20469
+ # thresholds that define how Model Armor screens content. If specified, Model
20470
+ # Armor will use this template to check the user's prompt for safety and
20471
+ # security risks before it is sent to the model. The name must be in the format `
20472
+ # projects/`project`/locations/`location`/templates/`template``.
20152
20473
  # Corresponds to the JSON property `promptTemplateName`
20153
20474
  # @return [String]
20154
20475
  attr_accessor :prompt_template_name
20155
20476
 
20156
- # Optional. The name of the Model Armor template to use for response
20157
- # sanitization.
20477
+ # Optional. The resource name of the Model Armor template to use for response
20478
+ # screening. A Model Armor template is a set of customized filters and
20479
+ # thresholds that define how Model Armor screens content. If specified, Model
20480
+ # Armor will use this template to check the model's response for safety and
20481
+ # security risks before it is returned to the user. The name must be in the
20482
+ # format `projects/`project`/locations/`location`/templates/`template``.
20158
20483
  # Corresponds to the JSON property `responseTemplateName`
20159
20484
  # @return [String]
20160
20485
  attr_accessor :response_template_name
@@ -21695,8 +22020,7 @@ module Google
21695
22020
  end
21696
22021
  end
21697
22022
 
21698
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
21699
- # to two distinct voices in a single synthesis request.
22023
+ # Configuration for a multi-speaker text-to-speech request.
21700
22024
  class GoogleCloudAiplatformV1MultiSpeakerVoiceConfig
21701
22025
  include Google::Apis::Core::Hashable
21702
22026
 
@@ -23981,11 +24305,11 @@ module Google
23981
24305
  end
23982
24306
  end
23983
24307
 
23984
- # A datatype containing media that is part of a multi-part `Content` message. A `
24308
+ # A datatype containing media that is part of a multi-part Content message. A `
23985
24309
  # Part` consists of data which has an associated datatype. A `Part` can only
23986
- # contain one of the accepted types in `Part.data`. A `Part` must have a fixed
23987
- # IANA MIME type identifying the type and subtype of the media if `inline_data`
23988
- # or `file_data` field is filled with raw bytes.
24310
+ # contain one of the accepted types in `Part.data`. For media types that are not
24311
+ # text, `Part` must have a fixed IANA MIME type identifying the type and subtype
24312
+ # of the media if `inline_data` or `file_data` field is filled with raw bytes.
23989
24313
  class GoogleCloudAiplatformV1Part
23990
24314
  include Google::Apis::Core::Hashable
23991
24315
 
@@ -24004,7 +24328,9 @@ module Google
24004
24328
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExecutableCode]
24005
24329
  attr_accessor :executable_code
24006
24330
 
24007
- # URI based data.
24331
+ # URI-based data. A FileData message contains a URI pointing to data of a
24332
+ # specific media type. It is used to represent images, audio, and video stored
24333
+ # in Google Cloud Storage.
24008
24334
  # Corresponds to the JSON property `fileData`
24009
24335
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FileData]
24010
24336
  attr_accessor :file_data
@@ -24024,17 +24350,19 @@ module Google
24024
24350
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionResponse]
24025
24351
  attr_accessor :function_response
24026
24352
 
24027
- # Content blob.
24353
+ # A content blob. A Blob contains data of a specific media type. It is used to
24354
+ # represent images, audio, and video.
24028
24355
  # Corresponds to the JSON property `inlineData`
24029
24356
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Blob]
24030
24357
  attr_accessor :inline_data
24031
24358
 
24032
- # Optional. Text part (can be code).
24359
+ # Optional. The text content of the part.
24033
24360
  # Corresponds to the JSON property `text`
24034
24361
  # @return [String]
24035
24362
  attr_accessor :text
24036
24363
 
24037
- # Optional. Indicates if the part is thought from the model.
24364
+ # Optional. Indicates whether the `part` represents the model's thought process
24365
+ # or reasoning.
24038
24366
  # Corresponds to the JSON property `thought`
24039
24367
  # @return [Boolean]
24040
24368
  attr_accessor :thought
@@ -24047,7 +24375,8 @@ module Google
24047
24375
  # @return [String]
24048
24376
  attr_accessor :thought_signature
24049
24377
 
24050
- # Metadata describes the input video content.
24378
+ # Provides metadata for a video, including the start and end offsets for
24379
+ # clipping and the frame rate.
24051
24380
  # Corresponds to the JSON property `videoMetadata`
24052
24381
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VideoMetadata]
24053
24382
  attr_accessor :video_metadata
@@ -25047,11 +25376,11 @@ module Google
25047
25376
  end
25048
25377
  end
25049
25378
 
25050
- # The configuration for the prebuilt speaker to use.
25379
+ # Configuration for a prebuilt voice.
25051
25380
  class GoogleCloudAiplatformV1PrebuiltVoiceConfig
25052
25381
  include Google::Apis::Core::Hashable
25053
25382
 
25054
- # The name of the preset voice to use.
25383
+ # The name of the prebuilt voice to use.
25055
25384
  # Corresponds to the JSON property `voiceName`
25056
25385
  # @return [String]
25057
25386
  attr_accessor :voice_name
@@ -25330,6 +25659,161 @@ module Google
25330
25659
  end
25331
25660
  end
25332
25661
 
25662
+ # Statistics computed for datasets used for preference optimization.
25663
+ class GoogleCloudAiplatformV1PreferenceOptimizationDataStats
25664
+ include Google::Apis::Core::Hashable
25665
+
25666
+ # Output only. A partial sample of the indices (starting from 1) of the dropped
25667
+ # examples.
25668
+ # Corresponds to the JSON property `droppedExampleIndices`
25669
+ # @return [Array<Fixnum>]
25670
+ attr_accessor :dropped_example_indices
25671
+
25672
+ # Output only. For each index in `dropped_example_indices`, the user-facing
25673
+ # reason why the example was dropped.
25674
+ # Corresponds to the JSON property `droppedExampleReasons`
25675
+ # @return [Array<String>]
25676
+ attr_accessor :dropped_example_reasons
25677
+
25678
+ # Distribution computed over a tuning dataset.
25679
+ # Corresponds to the JSON property `scoreVariancePerExampleDistribution`
25680
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetDistribution]
25681
+ attr_accessor :score_variance_per_example_distribution
25682
+
25683
+ # Distribution computed over a tuning dataset.
25684
+ # Corresponds to the JSON property `scoresDistribution`
25685
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetDistribution]
25686
+ attr_accessor :scores_distribution
25687
+
25688
+ # Output only. Number of billable tokens in the tuning dataset.
25689
+ # Corresponds to the JSON property `totalBillableTokenCount`
25690
+ # @return [Fixnum]
25691
+ attr_accessor :total_billable_token_count
25692
+
25693
+ # Output only. Number of examples in the tuning dataset.
25694
+ # Corresponds to the JSON property `tuningDatasetExampleCount`
25695
+ # @return [Fixnum]
25696
+ attr_accessor :tuning_dataset_example_count
25697
+
25698
+ # Output only. Number of tuning steps for this Tuning Job.
25699
+ # Corresponds to the JSON property `tuningStepCount`
25700
+ # @return [Fixnum]
25701
+ attr_accessor :tuning_step_count
25702
+
25703
+ # Output only. Sample user examples in the training dataset.
25704
+ # Corresponds to the JSON property `userDatasetExamples`
25705
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GeminiPreferenceExample>]
25706
+ attr_accessor :user_dataset_examples
25707
+
25708
+ # Distribution computed over a tuning dataset.
25709
+ # Corresponds to the JSON property `userInputTokenDistribution`
25710
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetDistribution]
25711
+ attr_accessor :user_input_token_distribution
25712
+
25713
+ # Distribution computed over a tuning dataset.
25714
+ # Corresponds to the JSON property `userOutputTokenDistribution`
25715
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetDistribution]
25716
+ attr_accessor :user_output_token_distribution
25717
+
25718
+ def initialize(**args)
25719
+ update!(**args)
25720
+ end
25721
+
25722
+ # Update properties of this object
25723
+ def update!(**args)
25724
+ @dropped_example_indices = args[:dropped_example_indices] if args.key?(:dropped_example_indices)
25725
+ @dropped_example_reasons = args[:dropped_example_reasons] if args.key?(:dropped_example_reasons)
25726
+ @score_variance_per_example_distribution = args[:score_variance_per_example_distribution] if args.key?(:score_variance_per_example_distribution)
25727
+ @scores_distribution = args[:scores_distribution] if args.key?(:scores_distribution)
25728
+ @total_billable_token_count = args[:total_billable_token_count] if args.key?(:total_billable_token_count)
25729
+ @tuning_dataset_example_count = args[:tuning_dataset_example_count] if args.key?(:tuning_dataset_example_count)
25730
+ @tuning_step_count = args[:tuning_step_count] if args.key?(:tuning_step_count)
25731
+ @user_dataset_examples = args[:user_dataset_examples] if args.key?(:user_dataset_examples)
25732
+ @user_input_token_distribution = args[:user_input_token_distribution] if args.key?(:user_input_token_distribution)
25733
+ @user_output_token_distribution = args[:user_output_token_distribution] if args.key?(:user_output_token_distribution)
25734
+ end
25735
+ end
25736
+
25737
+ # Hyperparameters for Preference Optimization.
25738
+ class GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters
25739
+ include Google::Apis::Core::Hashable
25740
+
25741
+ # Optional. Adapter size for preference optimization.
25742
+ # Corresponds to the JSON property `adapterSize`
25743
+ # @return [String]
25744
+ attr_accessor :adapter_size
25745
+
25746
+ # Optional. Weight for KL Divergence regularization.
25747
+ # Corresponds to the JSON property `beta`
25748
+ # @return [Float]
25749
+ attr_accessor :beta
25750
+
25751
+ # Optional. Number of complete passes the model makes over the entire training
25752
+ # dataset during training.
25753
+ # Corresponds to the JSON property `epochCount`
25754
+ # @return [Fixnum]
25755
+ attr_accessor :epoch_count
25756
+
25757
+ # Optional. Multiplier for adjusting the default learning rate.
25758
+ # Corresponds to the JSON property `learningRateMultiplier`
25759
+ # @return [Float]
25760
+ attr_accessor :learning_rate_multiplier
25761
+
25762
+ def initialize(**args)
25763
+ update!(**args)
25764
+ end
25765
+
25766
+ # Update properties of this object
25767
+ def update!(**args)
25768
+ @adapter_size = args[:adapter_size] if args.key?(:adapter_size)
25769
+ @beta = args[:beta] if args.key?(:beta)
25770
+ @epoch_count = args[:epoch_count] if args.key?(:epoch_count)
25771
+ @learning_rate_multiplier = args[:learning_rate_multiplier] if args.key?(:learning_rate_multiplier)
25772
+ end
25773
+ end
25774
+
25775
+ # Tuning Spec for Preference Optimization.
25776
+ class GoogleCloudAiplatformV1PreferenceOptimizationSpec
25777
+ include Google::Apis::Core::Hashable
25778
+
25779
+ # Optional. If set to true, disable intermediate checkpoints for Preference
25780
+ # Optimization and only the last checkpoint will be exported. Otherwise, enable
25781
+ # intermediate checkpoints for Preference Optimization. Default is false.
25782
+ # Corresponds to the JSON property `exportLastCheckpointOnly`
25783
+ # @return [Boolean]
25784
+ attr_accessor :export_last_checkpoint_only
25785
+ alias_method :export_last_checkpoint_only?, :export_last_checkpoint_only
25786
+
25787
+ # Hyperparameters for Preference Optimization.
25788
+ # Corresponds to the JSON property `hyperParameters`
25789
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters]
25790
+ attr_accessor :hyper_parameters
25791
+
25792
+ # Required. Cloud Storage path to file containing training dataset for
25793
+ # preference optimization tuning. The dataset must be formatted as a JSONL file.
25794
+ # Corresponds to the JSON property `trainingDatasetUri`
25795
+ # @return [String]
25796
+ attr_accessor :training_dataset_uri
25797
+
25798
+ # Optional. Cloud Storage path to file containing validation dataset for
25799
+ # preference optimization tuning. The dataset must be formatted as a JSONL file.
25800
+ # Corresponds to the JSON property `validationDatasetUri`
25801
+ # @return [String]
25802
+ attr_accessor :validation_dataset_uri
25803
+
25804
+ def initialize(**args)
25805
+ update!(**args)
25806
+ end
25807
+
25808
+ # Update properties of this object
25809
+ def update!(**args)
25810
+ @export_last_checkpoint_only = args[:export_last_checkpoint_only] if args.key?(:export_last_checkpoint_only)
25811
+ @hyper_parameters = args[:hyper_parameters] if args.key?(:hyper_parameters)
25812
+ @training_dataset_uri = args[:training_dataset_uri] if args.key?(:training_dataset_uri)
25813
+ @validation_dataset_uri = args[:validation_dataset_uri] if args.key?(:validation_dataset_uri)
25814
+ end
25815
+ end
25816
+
25333
25817
  # Preset configuration for example-based explanations
25334
25818
  class GoogleCloudAiplatformV1Presets
25335
25819
  include Google::Apis::Core::Hashable
@@ -27254,6 +27738,18 @@ module Google
27254
27738
  # @return [String]
27255
27739
  attr_accessor :name
27256
27740
 
27741
+ # Output only. Reserved for future use.
27742
+ # Corresponds to the JSON property `satisfiesPzi`
27743
+ # @return [Boolean]
27744
+ attr_accessor :satisfies_pzi
27745
+ alias_method :satisfies_pzi?, :satisfies_pzi
27746
+
27747
+ # Output only. Reserved for future use.
27748
+ # Corresponds to the JSON property `satisfiesPzs`
27749
+ # @return [Boolean]
27750
+ attr_accessor :satisfies_pzs
27751
+ alias_method :satisfies_pzs?, :satisfies_pzs
27752
+
27257
27753
  # Output only. Timestamp when this RagCorpus was last updated.
27258
27754
  # Corresponds to the JSON property `updateTime`
27259
27755
  # @return [String]
@@ -27281,6 +27777,8 @@ module Google
27281
27777
  @display_name = args[:display_name] if args.key?(:display_name)
27282
27778
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
27283
27779
  @name = args[:name] if args.key?(:name)
27780
+ @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
27781
+ @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
27284
27782
  @update_time = args[:update_time] if args.key?(:update_time)
27285
27783
  @vector_db_config = args[:vector_db_config] if args.key?(:vector_db_config)
27286
27784
  @vertex_ai_search_config = args[:vertex_ai_search_config] if args.key?(:vertex_ai_search_config)
@@ -28701,8 +29199,8 @@ module Google
28701
29199
  # @return [String]
28702
29200
  attr_accessor :pickle_object_gcs_uri
28703
29201
 
28704
- # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not
28705
- # specified, default value is 3.10.
29202
+ # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13.
29203
+ # If not specified, the default value is 3.10.
28706
29204
  # Corresponds to the JSON property `pythonVersion`
28707
29205
  # @return [String]
28708
29206
  attr_accessor :python_version
@@ -29272,15 +29770,17 @@ module Google
29272
29770
  end
29273
29771
  end
29274
29772
 
29275
- # Metadata related to retrieval in the grounding flow.
29773
+ # Metadata related to the retrieval grounding source. This is part of the `
29774
+ # GroundingMetadata` returned when grounding is enabled.
29276
29775
  class GoogleCloudAiplatformV1RetrievalMetadata
29277
29776
  include Google::Apis::Core::Hashable
29278
29777
 
29279
- # Optional. Score indicating how likely information from Google Search could
29280
- # help answer the prompt. The score is in the range `[0, 1]`, where 0 is the
29281
- # least likely and 1 is the most likely. This score is only populated when
29282
- # Google Search grounding and dynamic retrieval is enabled. It will be compared
29283
- # to the threshold to determine whether to trigger Google Search.
29778
+ # Optional. A score indicating how likely it is that a Google Search query could
29779
+ # help answer the prompt. The score is in the range of `[0, 1]`. A score of 1
29780
+ # means the model is confident that a search will be helpful, and 0 means it is
29781
+ # not. This score is populated only when Google Search grounding and dynamic
29782
+ # retrieval are enabled. The score is used to determine whether to trigger a
29783
+ # search.
29284
29784
  # Corresponds to the JSON property `googleSearchDynamicRetrievalScore`
29285
29785
  # @return [Float]
29286
29786
  attr_accessor :google_search_dynamic_retrieval_score
@@ -29866,18 +30366,18 @@ module Google
29866
30366
  end
29867
30367
  end
29868
30368
 
29869
- # Safety rating corresponding to the generated content.
30369
+ # A safety rating for a piece of content. The safety rating contains the harm
30370
+ # category and the harm probability level.
29870
30371
  class GoogleCloudAiplatformV1SafetyRating
29871
30372
  include Google::Apis::Core::Hashable
29872
30373
 
29873
- # Output only. Indicates whether the content was filtered out because of this
29874
- # rating.
30374
+ # Output only. Indicates whether the content was blocked because of this rating.
29875
30375
  # Corresponds to the JSON property `blocked`
29876
30376
  # @return [Boolean]
29877
30377
  attr_accessor :blocked
29878
30378
  alias_method :blocked?, :blocked
29879
30379
 
29880
- # Output only. Harm category.
30380
+ # Output only. The harm category of this rating.
29881
30381
  # Corresponds to the JSON property `category`
29882
30382
  # @return [String]
29883
30383
  attr_accessor :category
@@ -29889,22 +30389,22 @@ module Google
29889
30389
  # @return [String]
29890
30390
  attr_accessor :overwritten_threshold
29891
30391
 
29892
- # Output only. Harm probability levels in the content.
30392
+ # Output only. The probability of harm for this category.
29893
30393
  # Corresponds to the JSON property `probability`
29894
30394
  # @return [String]
29895
30395
  attr_accessor :probability
29896
30396
 
29897
- # Output only. Harm probability score.
30397
+ # Output only. The probability score of harm for this category.
29898
30398
  # Corresponds to the JSON property `probabilityScore`
29899
30399
  # @return [Float]
29900
30400
  attr_accessor :probability_score
29901
30401
 
29902
- # Output only. Harm severity levels in the content.
30402
+ # Output only. The severity of harm for this category.
29903
30403
  # Corresponds to the JSON property `severity`
29904
30404
  # @return [String]
29905
30405
  attr_accessor :severity
29906
30406
 
29907
- # Output only. Harm severity score.
30407
+ # Output only. The severity score of harm for this category.
29908
30408
  # Corresponds to the JSON property `severityScore`
29909
30409
  # @return [Float]
29910
30410
  attr_accessor :severity_score
@@ -29956,22 +30456,24 @@ module Google
29956
30456
  end
29957
30457
  end
29958
30458
 
29959
- # Safety settings.
30459
+ # A safety setting that affects the safety-blocking behavior. A SafetySetting
30460
+ # consists of a harm category and a threshold for that category.
29960
30461
  class GoogleCloudAiplatformV1SafetySetting
29961
30462
  include Google::Apis::Core::Hashable
29962
30463
 
29963
- # Required. Harm category.
30464
+ # Required. The harm category to be blocked.
29964
30465
  # Corresponds to the JSON property `category`
29965
30466
  # @return [String]
29966
30467
  attr_accessor :category
29967
30468
 
29968
- # Optional. Specify if the threshold is used for probability or severity score.
29969
- # If not specified, the threshold is used for probability score.
30469
+ # Optional. The method for blocking content. If not specified, the default
30470
+ # behavior is to use the probability score.
29970
30471
  # Corresponds to the JSON property `method`
29971
30472
  # @return [String]
29972
30473
  attr_accessor :method_prop
29973
30474
 
29974
- # Required. The harm block threshold.
30475
+ # Required. The threshold for blocking content. If the harm probability exceeds
30476
+ # this threshold, the content will be blocked.
29975
30477
  # Corresponds to the JSON property `threshold`
29976
30478
  # @return [String]
29977
30479
  attr_accessor :threshold
@@ -33350,6 +33852,71 @@ module Google
33350
33852
  end
33351
33853
  end
33352
33854
 
33855
+ # Defines data for an application builder.
33856
+ class GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData
33857
+ include Google::Apis::Core::Hashable
33858
+
33859
+ # Serialized state of the code repository. This string will typically contain a
33860
+ # JSON representation of the UI's CodeRepositoryService state (files, folders,
33861
+ # content, and any metadata). The UI is responsible for serialization and
33862
+ # deserialization.
33863
+ # Corresponds to the JSON property `codeRepositoryState`
33864
+ # @return [String]
33865
+ attr_accessor :code_repository_state
33866
+
33867
+ # Linked resources attached to the application by the user.
33868
+ # Corresponds to the JSON property `linkedResources`
33869
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource>]
33870
+ attr_accessor :linked_resources
33871
+
33872
+ def initialize(**args)
33873
+ update!(**args)
33874
+ end
33875
+
33876
+ # Update properties of this object
33877
+ def update!(**args)
33878
+ @code_repository_state = args[:code_repository_state] if args.key?(:code_repository_state)
33879
+ @linked_resources = args[:linked_resources] if args.key?(:linked_resources)
33880
+ end
33881
+ end
33882
+
33883
+ # A linked resource attached to the application by the user.
33884
+ class GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderDataLinkedResource
33885
+ include Google::Apis::Core::Hashable
33886
+
33887
+ # A user-friendly name for the data source shown in the UI.
33888
+ # Corresponds to the JSON property `displayName`
33889
+ # @return [String]
33890
+ attr_accessor :display_name
33891
+
33892
+ # The unique resource name of the data source. The format is determined by the '
33893
+ # type' field. For type "SAVED_PROMPT": projects/`project`/locations/`location`/
33894
+ # datasets/`dataset` For type "AI_AGENT": projects/`project`/locations/`location`
33895
+ # /agents/`agent`
33896
+ # Corresponds to the JSON property `name`
33897
+ # @return [String]
33898
+ attr_accessor :name
33899
+
33900
+ # The type of the linked resource. e.g., "SAVED_PROMPT", "AI_AGENT" This string
33901
+ # corresponds to the name of the LinkedResourceType enum member. See: google3/
33902
+ # cloud/console/web/ai/platform/llm/prompts/build/services/
33903
+ # specs_repository_service/linked_resources/linked_resource.ts
33904
+ # Corresponds to the JSON property `type`
33905
+ # @return [String]
33906
+ attr_accessor :type
33907
+
33908
+ def initialize(**args)
33909
+ update!(**args)
33910
+ end
33911
+
33912
+ # Update properties of this object
33913
+ def update!(**args)
33914
+ @display_name = args[:display_name] if args.key?(:display_name)
33915
+ @name = args[:name] if args.key?(:name)
33916
+ @type = args[:type] if args.key?(:type)
33917
+ end
33918
+ end
33919
+
33353
33920
  # Prompt variation that embeds preambles to prompt string.
33354
33921
  class GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt
33355
33922
  include Google::Apis::Core::Hashable
@@ -33401,7 +33968,9 @@ module Google
33401
33968
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
33402
33969
  attr_accessor :contents
33403
33970
 
33404
- # Generation config.
33971
+ # Configuration for content generation. This message contains all the parameters
33972
+ # that control how the model generates content. It allows you to influence the
33973
+ # randomness, length, and structure of the output.
33405
33974
  # Corresponds to the JSON property `generationConfig`
33406
33975
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
33407
33976
  attr_accessor :generation_config
@@ -33417,10 +33986,9 @@ module Google
33417
33986
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetySetting>]
33418
33987
  attr_accessor :safety_settings
33419
33988
 
33420
- # The base structured datatype containing multi-part content of a message. A `
33421
- # Content` includes a `role` field designating the producer of the `Content` and
33422
- # a `parts` field containing multi-part data that contains the content of the
33423
- # message turn.
33989
+ # The structured data content of a message. A Content message contains a `role`
33990
+ # field, which indicates the producer of the content, and a `parts` field, which
33991
+ # contains the multi-part data of the message.
33424
33992
  # Corresponds to the JSON property `systemInstruction`
33425
33993
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
33426
33994
  attr_accessor :system_instruction
@@ -33502,10 +34070,14 @@ module Google
33502
34070
  class GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt
33503
34071
  include Google::Apis::Core::Hashable
33504
34072
 
33505
- # The base structured datatype containing multi-part content of a message. A `
33506
- # Content` includes a `role` field designating the producer of the `Content` and
33507
- # a `parts` field containing multi-part data that contains the content of the
33508
- # message turn.
34073
+ # Defines data for an application builder.
34074
+ # Corresponds to the JSON property `appBuilderData`
34075
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SchemaPromptSpecAppBuilderData]
34076
+ attr_accessor :app_builder_data
34077
+
34078
+ # The structured data content of a message. A Content message contains a `role`
34079
+ # field, which indicates the producer of the content, and a `parts` field, which
34080
+ # contains the multi-part data of the message.
33509
34081
  # Corresponds to the JSON property `context`
33510
34082
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
33511
34083
  attr_accessor :context
@@ -33553,6 +34125,7 @@ module Google
33553
34125
 
33554
34126
  # Update properties of this object
33555
34127
  def update!(**args)
34128
+ @app_builder_data = args[:app_builder_data] if args.key?(:app_builder_data)
33556
34129
  @context = args[:context] if args.key?(:context)
33557
34130
  @examples = args[:examples] if args.key?(:examples)
33558
34131
  @infill_prefix = args[:infill_prefix] if args.key?(:infill_prefix)
@@ -37275,17 +37848,23 @@ module Google
37275
37848
  end
37276
37849
  end
37277
37850
 
37278
- # Google search entry point.
37851
+ # An entry point for displaying Google Search results. A `SearchEntryPoint` is
37852
+ # populated when the grounding source for a model's response is Google Search.
37853
+ # It provides information that you can use to display the search results in your
37854
+ # application.
37279
37855
  class GoogleCloudAiplatformV1SearchEntryPoint
37280
37856
  include Google::Apis::Core::Hashable
37281
37857
 
37282
- # Optional. Web content snippet that can be embedded in a web page or an app
37283
- # webview.
37858
+ # Optional. An HTML snippet that can be embedded in a web page or an application'
37859
+ # s webview. This snippet displays a search result, including the title, URL,
37860
+ # and a brief description of the search result.
37284
37861
  # Corresponds to the JSON property `renderedContent`
37285
37862
  # @return [String]
37286
37863
  attr_accessor :rendered_content
37287
37864
 
37288
- # Optional. Base64 encoded JSON representing array of tuple.
37865
+ # Optional. A base64-encoded JSON object that contains a list of search queries
37866
+ # and their corresponding search URLs. This information can be used to build a
37867
+ # custom search UI.
37289
37868
  # Corresponds to the JSON property `sdkBlob`
37290
37869
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
37291
37870
  # @return [String]
@@ -37616,28 +38195,31 @@ module Google
37616
38195
  end
37617
38196
  end
37618
38197
 
37619
- # Segment of the content.
38198
+ # A segment of the content.
37620
38199
  class GoogleCloudAiplatformV1Segment
37621
38200
  include Google::Apis::Core::Hashable
37622
38201
 
37623
- # Output only. End index in the given Part, measured in bytes. Offset from the
37624
- # start of the Part, exclusive, starting at zero.
38202
+ # Output only. The end index of the segment in the `Part`, measured in bytes.
38203
+ # This marks the end of the segment and is exclusive, meaning the segment
38204
+ # includes content up to, but not including, the byte at this index.
37625
38205
  # Corresponds to the JSON property `endIndex`
37626
38206
  # @return [Fixnum]
37627
38207
  attr_accessor :end_index
37628
38208
 
37629
- # Output only. The index of a Part object within its parent Content object.
38209
+ # Output only. The index of the `Part` object that this segment belongs to. This
38210
+ # is useful for associating the segment with a specific part of the content.
37630
38211
  # Corresponds to the JSON property `partIndex`
37631
38212
  # @return [Fixnum]
37632
38213
  attr_accessor :part_index
37633
38214
 
37634
- # Output only. Start index in the given Part, measured in bytes. Offset from the
37635
- # start of the Part, inclusive, starting at zero.
38215
+ # Output only. The start index of the segment in the `Part`, measured in bytes.
38216
+ # This marks the beginning of the segment and is inclusive, meaning the byte at
38217
+ # this index is the first byte of the segment.
37636
38218
  # Corresponds to the JSON property `startIndex`
37637
38219
  # @return [Fixnum]
37638
38220
  attr_accessor :start_index
37639
38221
 
37640
- # Output only. The text corresponding to the segment from the response.
38222
+ # Output only. The text of the segment.
37641
38223
  # Corresponds to the JSON property `text`
37642
38224
  # @return [String]
37643
38225
  attr_accessor :text
@@ -37927,7 +38509,7 @@ module Google
37927
38509
  end
37928
38510
  end
37929
38511
 
37930
- # Configuration for a single speaker in a multi speaker setup.
38512
+ # Configuration for a single speaker in a multi-speaker setup.
37931
38513
  class GoogleCloudAiplatformV1SpeakerVoiceConfig
37932
38514
  include Google::Apis::Core::Hashable
37933
38515
 
@@ -37937,7 +38519,7 @@ module Google
37937
38519
  # @return [String]
37938
38520
  attr_accessor :speaker
37939
38521
 
37940
- # The configuration for the voice to use.
38522
+ # Configuration for a voice.
37941
38523
  # Corresponds to the JSON property `voiceConfig`
37942
38524
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VoiceConfig]
37943
38525
  attr_accessor :voice_config
@@ -38084,22 +38666,21 @@ module Google
38084
38666
  end
38085
38667
  end
38086
38668
 
38087
- # The speech generation config.
38669
+ # Configuration for speech generation.
38088
38670
  class GoogleCloudAiplatformV1SpeechConfig
38089
38671
  include Google::Apis::Core::Hashable
38090
38672
 
38091
- # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
38673
+ # Optional. The language code (ISO 639-1) for the speech synthesis.
38092
38674
  # Corresponds to the JSON property `languageCode`
38093
38675
  # @return [String]
38094
38676
  attr_accessor :language_code
38095
38677
 
38096
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
38097
- # to two distinct voices in a single synthesis request.
38678
+ # Configuration for a multi-speaker text-to-speech request.
38098
38679
  # Corresponds to the JSON property `multiSpeakerVoiceConfig`
38099
38680
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MultiSpeakerVoiceConfig]
38100
38681
  attr_accessor :multi_speaker_voice_config
38101
38682
 
38102
- # The configuration for the voice to use.
38683
+ # Configuration for a voice.
38103
38684
  # Corresponds to the JSON property `voiceConfig`
38104
38685
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VoiceConfig]
38105
38686
  attr_accessor :voice_config
@@ -39975,10 +40556,9 @@ module Google
39975
40556
  class GoogleCloudAiplatformV1SyntheticField
39976
40557
  include Google::Apis::Core::Hashable
39977
40558
 
39978
- # The base structured datatype containing multi-part content of a message. A `
39979
- # Content` includes a `role` field designating the producer of the `Content` and
39980
- # a `parts` field containing multi-part data that contains the content of the
39981
- # message turn.
40559
+ # The structured data content of a message. A Content message contains a `role`
40560
+ # field, which indicates the producer of the content, and a `parts` field, which
40561
+ # contains the multi-part data of the message.
39982
40562
  # Corresponds to the JSON property `content`
39983
40563
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
39984
40564
  attr_accessor :content
@@ -42457,6 +43037,11 @@ module Google
42457
43037
  class GoogleCloudAiplatformV1TuningDataStats
42458
43038
  include Google::Apis::Core::Hashable
42459
43039
 
43040
+ # Statistics computed for datasets used for preference optimization.
43041
+ # Corresponds to the JSON property `preferenceOptimizationDataStats`
43042
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PreferenceOptimizationDataStats]
43043
+ attr_accessor :preference_optimization_data_stats
43044
+
42460
43045
  # Tuning data statistics for Supervised Tuning.
42461
43046
  # Corresponds to the JSON property `supervisedTuningDataStats`
42462
43047
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SupervisedTuningDataStats]
@@ -42468,6 +43053,7 @@ module Google
42468
43053
 
42469
43054
  # Update properties of this object
42470
43055
  def update!(**args)
43056
+ @preference_optimization_data_stats = args[:preference_optimization_data_stats] if args.key?(:preference_optimization_data_stats)
42471
43057
  @supervised_tuning_data_stats = args[:supervised_tuning_data_stats] if args.key?(:supervised_tuning_data_stats)
42472
43058
  end
42473
43059
  end
@@ -42542,6 +43128,11 @@ module Google
42542
43128
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PreTunedModel]
42543
43129
  attr_accessor :pre_tuned_model
42544
43130
 
43131
+ # Tuning Spec for Preference Optimization.
43132
+ # Corresponds to the JSON property `preferenceOptimizationSpec`
43133
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PreferenceOptimizationSpec]
43134
+ attr_accessor :preference_optimization_spec
43135
+
42545
43136
  # The service account that the tuningJob workload runs as. If not specified, the
42546
43137
  # Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See
42547
43138
  # https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-
@@ -42608,6 +43199,7 @@ module Google
42608
43199
  @labels = args[:labels] if args.key?(:labels)
42609
43200
  @name = args[:name] if args.key?(:name)
42610
43201
  @pre_tuned_model = args[:pre_tuned_model] if args.key?(:pre_tuned_model)
43202
+ @preference_optimization_spec = args[:preference_optimization_spec] if args.key?(:preference_optimization_spec)
42611
43203
  @service_account = args[:service_account] if args.key?(:service_account)
42612
43204
  @start_time = args[:start_time] if args.key?(:start_time)
42613
43205
  @state = args[:state] if args.key?(:state)
@@ -43330,11 +43922,13 @@ module Google
43330
43922
  end
43331
43923
  end
43332
43924
 
43333
- # Metadata related to url context retrieval tool.
43925
+ # Metadata returned when the model uses the `url_context` tool to get
43926
+ # information from a user-provided URL.
43334
43927
  class GoogleCloudAiplatformV1UrlContextMetadata
43335
43928
  include Google::Apis::Core::Hashable
43336
43929
 
43337
- # Output only. List of url context.
43930
+ # Output only. A list of URL metadata, with one entry for each URL retrieved by
43931
+ # the tool.
43338
43932
  # Corresponds to the JSON property `urlMetadata`
43339
43933
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UrlMetadata>]
43340
43934
  attr_accessor :url_metadata
@@ -43349,16 +43943,16 @@ module Google
43349
43943
  end
43350
43944
  end
43351
43945
 
43352
- # Context of the a single url retrieval.
43946
+ # The metadata for a single URL retrieval.
43353
43947
  class GoogleCloudAiplatformV1UrlMetadata
43354
43948
  include Google::Apis::Core::Hashable
43355
43949
 
43356
- # Retrieved url by the tool.
43950
+ # The URL retrieved by the tool.
43357
43951
  # Corresponds to the JSON property `retrievedUrl`
43358
43952
  # @return [String]
43359
43953
  attr_accessor :retrieved_url
43360
43954
 
43361
- # Status of the url retrieval.
43955
+ # The status of the URL retrieval.
43362
43956
  # Corresponds to the JSON property `urlRetrievalStatus`
43363
43957
  # @return [String]
43364
43958
  attr_accessor :url_retrieval_status
@@ -43705,7 +44299,8 @@ module Google
43705
44299
  end
43706
44300
  end
43707
44301
 
43708
- # Metadata describes the input video content.
44302
+ # Provides metadata for a video, including the start and end offsets for
44303
+ # clipping and the frame rate.
43709
44304
  class GoogleCloudAiplatformV1VideoMetadata
43710
44305
  include Google::Apis::Core::Hashable
43711
44306
 
@@ -43715,7 +44310,7 @@ module Google
43715
44310
  attr_accessor :end_offset
43716
44311
 
43717
44312
  # Optional. The frame rate of the video sent to the model. If not specified, the
43718
- # default value will be 1.0. The fps range is (0.0, 24.0].
44313
+ # default value is 1.0. The valid range is (0.0, 24.0].
43719
44314
  # Corresponds to the JSON property `fps`
43720
44315
  # @return [Float]
43721
44316
  attr_accessor :fps
@@ -43737,11 +44332,11 @@ module Google
43737
44332
  end
43738
44333
  end
43739
44334
 
43740
- # The configuration for the voice to use.
44335
+ # Configuration for a voice.
43741
44336
  class GoogleCloudAiplatformV1VoiceConfig
43742
44337
  include Google::Apis::Core::Hashable
43743
44338
 
43744
- # The configuration for the prebuilt speaker to use.
44339
+ # Configuration for a prebuilt voice.
43745
44340
  # Corresponds to the JSON property `prebuiltVoiceConfig`
43746
44341
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PrebuiltVoiceConfig]
43747
44342
  attr_accessor :prebuilt_voice_config