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