google-apis-aiplatform_v1 0.70.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
@@ -8612,6 +8748,11 @@ module Google
8612
8748
  class GoogleCloudAiplatformV1EvaluationInstance
8613
8749
  include Google::Apis::Core::Hashable
8614
8750
 
8751
+ # Contains data specific to agent evaluations.
8752
+ # Corresponds to the JSON property `agentData`
8753
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceAgentData]
8754
+ attr_accessor :agent_data
8755
+
8615
8756
  # Instance data specified as a map.
8616
8757
  # Corresponds to the JSON property `otherData`
8617
8758
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceMapInstance]
@@ -8645,6 +8786,7 @@ module Google
8645
8786
 
8646
8787
  # Update properties of this object
8647
8788
  def update!(**args)
8789
+ @agent_data = args[:agent_data] if args.key?(:agent_data)
8648
8790
  @other_data = args[:other_data] if args.key?(:other_data)
8649
8791
  @prompt = args[:prompt] if args.key?(:prompt)
8650
8792
  @reference = args[:reference] if args.key?(:reference)
@@ -8653,6 +8795,144 @@ module Google
8653
8795
  end
8654
8796
  end
8655
8797
 
8798
+ # Configuration for an Agent.
8799
+ class GoogleCloudAiplatformV1EvaluationInstanceAgentConfig
8800
+ include Google::Apis::Core::Hashable
8801
+
8802
+ # Instance data used to populate placeholders in a metric prompt template.
8803
+ # Corresponds to the JSON property `developerInstruction`
8804
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceInstanceData]
8805
+ attr_accessor :developer_instruction
8806
+
8807
+ # Represents a list of tools for an agent.
8808
+ # Corresponds to the JSON property `tools`
8809
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools]
8810
+ attr_accessor :tools
8811
+
8812
+ # A JSON string containing a list of tools available to an agent with info such
8813
+ # as name, description, parameters and required parameters.
8814
+ # Corresponds to the JSON property `toolsText`
8815
+ # @return [String]
8816
+ attr_accessor :tools_text
8817
+
8818
+ def initialize(**args)
8819
+ update!(**args)
8820
+ end
8821
+
8822
+ # Update properties of this object
8823
+ def update!(**args)
8824
+ @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction)
8825
+ @tools = args[:tools] if args.key?(:tools)
8826
+ @tools_text = args[:tools_text] if args.key?(:tools_text)
8827
+ end
8828
+ end
8829
+
8830
+ # Represents a list of tools for an agent.
8831
+ class GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools
8832
+ include Google::Apis::Core::Hashable
8833
+
8834
+ # Optional. List of tools: each tool can have multiple function declarations.
8835
+ # Corresponds to the JSON property `tool`
8836
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tool>]
8837
+ attr_accessor :tool
8838
+
8839
+ def initialize(**args)
8840
+ update!(**args)
8841
+ end
8842
+
8843
+ # Update properties of this object
8844
+ def update!(**args)
8845
+ @tool = args[:tool] if args.key?(:tool)
8846
+ end
8847
+ end
8848
+
8849
+ # Contains data specific to agent evaluations.
8850
+ class GoogleCloudAiplatformV1EvaluationInstanceAgentData
8851
+ include Google::Apis::Core::Hashable
8852
+
8853
+ # Configuration for an Agent.
8854
+ # Corresponds to the JSON property `agentConfig`
8855
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceAgentConfig]
8856
+ attr_accessor :agent_config
8857
+
8858
+ # Instance data used to populate placeholders in a metric prompt template.
8859
+ # Corresponds to the JSON property `developerInstruction`
8860
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceInstanceData]
8861
+ attr_accessor :developer_instruction
8862
+
8863
+ # Represents a list of events for an agent.
8864
+ # Corresponds to the JSON property `events`
8865
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents]
8866
+ attr_accessor :events
8867
+
8868
+ # Represents a list of tools for an agent.
8869
+ # Corresponds to the JSON property `tools`
8870
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools]
8871
+ attr_accessor :tools
8872
+
8873
+ # A JSON string containing a list of tools available to an agent with info such
8874
+ # as name, description, parameters and required parameters. Example: [ ` "name":
8875
+ # "search_actors", "description": "Search for actors in a movie. Returns a list
8876
+ # of actors, their roles, their birthdate, and their place of birth.", "
8877
+ # parameters": [ ` "name": "movie_name", "description": "The name of the movie."
8878
+ # `, ` "name": "character_name", "description": "The name of the character." ` ],
8879
+ # "required": ["movie_name", "character_name"] ` ]
8880
+ # Corresponds to the JSON property `toolsText`
8881
+ # @return [String]
8882
+ attr_accessor :tools_text
8883
+
8884
+ def initialize(**args)
8885
+ update!(**args)
8886
+ end
8887
+
8888
+ # Update properties of this object
8889
+ def update!(**args)
8890
+ @agent_config = args[:agent_config] if args.key?(:agent_config)
8891
+ @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction)
8892
+ @events = args[:events] if args.key?(:events)
8893
+ @tools = args[:tools] if args.key?(:tools)
8894
+ @tools_text = args[:tools_text] if args.key?(:tools_text)
8895
+ end
8896
+ end
8897
+
8898
+ # Represents a list of events for an agent.
8899
+ class GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents
8900
+ include Google::Apis::Core::Hashable
8901
+
8902
+ # Optional. A list of events.
8903
+ # Corresponds to the JSON property `event`
8904
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
8905
+ attr_accessor :event
8906
+
8907
+ def initialize(**args)
8908
+ update!(**args)
8909
+ end
8910
+
8911
+ # Update properties of this object
8912
+ def update!(**args)
8913
+ @event = args[:event] if args.key?(:event)
8914
+ end
8915
+ end
8916
+
8917
+ # Represents a list of tools for an agent.
8918
+ class GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools
8919
+ include Google::Apis::Core::Hashable
8920
+
8921
+ # Optional. List of tools: each tool can have multiple function declarations.
8922
+ # Corresponds to the JSON property `tool`
8923
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tool>]
8924
+ attr_accessor :tool
8925
+
8926
+ def initialize(**args)
8927
+ update!(**args)
8928
+ end
8929
+
8930
+ # Update properties of this object
8931
+ def update!(**args)
8932
+ @tool = args[:tool] if args.key?(:tool)
8933
+ end
8934
+ end
8935
+
8656
8936
  # Instance data used to populate placeholders in a metric prompt template.
8657
8937
  class GoogleCloudAiplatformV1EvaluationInstanceInstanceData
8658
8938
  include Google::Apis::Core::Hashable
@@ -9190,7 +9470,9 @@ module Google
9190
9470
  # @return [String]
9191
9471
  attr_accessor :autorater_model
9192
9472
 
9193
- # 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.
9194
9476
  # Corresponds to the JSON property `generationConfig`
9195
9477
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
9196
9478
  attr_accessor :generation_config
@@ -9270,7 +9552,9 @@ module Google
9270
9552
  class GoogleCloudAiplatformV1EvaluationRunInferenceConfig
9271
9553
  include Google::Apis::Core::Hashable
9272
9554
 
9273
- # 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.
9274
9558
  # Corresponds to the JSON property `generationConfig`
9275
9559
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
9276
9560
  attr_accessor :generation_config
@@ -9308,6 +9592,11 @@ module Google
9308
9592
  # @return [String]
9309
9593
  attr_accessor :metric
9310
9594
 
9595
+ # The metric used for running evaluations.
9596
+ # Corresponds to the JSON property `metricConfig`
9597
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Metric]
9598
+ attr_accessor :metric_config
9599
+
9311
9600
  # Specification for a pre-defined metric.
9312
9601
  # Corresponds to the JSON property `predefinedMetricSpec`
9313
9602
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec]
@@ -9326,6 +9615,7 @@ module Google
9326
9615
  def update!(**args)
9327
9616
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
9328
9617
  @metric = args[:metric] if args.key?(:metric)
9618
+ @metric_config = args[:metric_config] if args.key?(:metric_config)
9329
9619
  @predefined_metric_spec = args[:predefined_metric_spec] if args.key?(:predefined_metric_spec)
9330
9620
  @rubric_based_metric_spec = args[:rubric_based_metric_spec] if args.key?(:rubric_based_metric_spec)
9331
9621
  end
@@ -13308,20 +13598,21 @@ module Google
13308
13598
  end
13309
13599
  end
13310
13600
 
13311
- # 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.
13312
13604
  class GoogleCloudAiplatformV1FileData
13313
13605
  include Google::Apis::Core::Hashable
13314
13606
 
13315
- # Optional. Display name of the file data. Used to provide a label or filename
13316
- # to distinguish file datas. This field is only returned in PromptMessage for
13317
- # prompt management. It is currently used in the Gemini GenerateContent calls
13318
- # only when server side tools (code_execution, google_search, and url_context)
13319
- # 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.
13320
13611
  # Corresponds to the JSON property `displayName`
13321
13612
  # @return [String]
13322
13613
  attr_accessor :display_name
13323
13614
 
13324
- # Required. URI.
13615
+ # Required. The URI of the file in Google Cloud Storage.
13325
13616
  # Corresponds to the JSON property `fileUri`
13326
13617
  # @return [String]
13327
13618
  attr_accessor :file_uri
@@ -13978,6 +14269,12 @@ module Google
13978
14269
  # @return [String]
13979
14270
  attr_accessor :name
13980
14271
 
14272
+ # Optional. Ordered `Parts` that constitute a function response. Parts may have
14273
+ # different IANA MIME types.
14274
+ # Corresponds to the JSON property `parts`
14275
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionResponsePart>]
14276
+ attr_accessor :parts
14277
+
13981
14278
  # Required. The function response in JSON object format. Use "output" key to
13982
14279
  # specify function output and "error" key to specify error details (if any). If "
13983
14280
  # output" and "error" keys are not specified, then whole "response" is treated
@@ -13993,10 +14290,113 @@ module Google
13993
14290
  # Update properties of this object
13994
14291
  def update!(**args)
13995
14292
  @name = args[:name] if args.key?(:name)
14293
+ @parts = args[:parts] if args.key?(:parts)
13996
14294
  @response = args[:response] if args.key?(:response)
13997
14295
  end
13998
14296
  end
13999
14297
 
14298
+ # Raw media bytes for function response. Text should not be sent as raw bytes,
14299
+ # use the 'text' field.
14300
+ class GoogleCloudAiplatformV1FunctionResponseBlob
14301
+ include Google::Apis::Core::Hashable
14302
+
14303
+ # Required. Raw bytes.
14304
+ # Corresponds to the JSON property `data`
14305
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
14306
+ # @return [String]
14307
+ attr_accessor :data
14308
+
14309
+ # Optional. Display name of the blob. Used to provide a label or filename to
14310
+ # distinguish blobs. This field is only returned in PromptMessage for prompt
14311
+ # management. It is currently used in the Gemini GenerateContent calls only when
14312
+ # server side tools (code_execution, google_search, and url_context) are enabled.
14313
+ # Corresponds to the JSON property `displayName`
14314
+ # @return [String]
14315
+ attr_accessor :display_name
14316
+
14317
+ # Required. The IANA standard MIME type of the source data.
14318
+ # Corresponds to the JSON property `mimeType`
14319
+ # @return [String]
14320
+ attr_accessor :mime_type
14321
+
14322
+ def initialize(**args)
14323
+ update!(**args)
14324
+ end
14325
+
14326
+ # Update properties of this object
14327
+ def update!(**args)
14328
+ @data = args[:data] if args.key?(:data)
14329
+ @display_name = args[:display_name] if args.key?(:display_name)
14330
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
14331
+ end
14332
+ end
14333
+
14334
+ # URI based data for function response.
14335
+ class GoogleCloudAiplatformV1FunctionResponseFileData
14336
+ include Google::Apis::Core::Hashable
14337
+
14338
+ # Optional. Display name of the file data. Used to provide a label or filename
14339
+ # to distinguish file datas. This field is only returned in PromptMessage for
14340
+ # prompt management. It is currently used in the Gemini GenerateContent calls
14341
+ # only when server side tools (code_execution, google_search, and url_context)
14342
+ # are enabled.
14343
+ # Corresponds to the JSON property `displayName`
14344
+ # @return [String]
14345
+ attr_accessor :display_name
14346
+
14347
+ # Required. URI.
14348
+ # Corresponds to the JSON property `fileUri`
14349
+ # @return [String]
14350
+ attr_accessor :file_uri
14351
+
14352
+ # Required. The IANA standard MIME type of the source data.
14353
+ # Corresponds to the JSON property `mimeType`
14354
+ # @return [String]
14355
+ attr_accessor :mime_type
14356
+
14357
+ def initialize(**args)
14358
+ update!(**args)
14359
+ end
14360
+
14361
+ # Update properties of this object
14362
+ def update!(**args)
14363
+ @display_name = args[:display_name] if args.key?(:display_name)
14364
+ @file_uri = args[:file_uri] if args.key?(:file_uri)
14365
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
14366
+ end
14367
+ end
14368
+
14369
+ # A datatype containing media that is part of a `FunctionResponse` message. A `
14370
+ # FunctionResponsePart` consists of data which has an associated datatype. A `
14371
+ # FunctionResponsePart` can only contain one of the accepted types in `
14372
+ # FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA
14373
+ # MIME type identifying the type and subtype of the media if the `inline_data`
14374
+ # field is filled with raw bytes.
14375
+ class GoogleCloudAiplatformV1FunctionResponsePart
14376
+ include Google::Apis::Core::Hashable
14377
+
14378
+ # URI based data for function response.
14379
+ # Corresponds to the JSON property `fileData`
14380
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionResponseFileData]
14381
+ attr_accessor :file_data
14382
+
14383
+ # Raw media bytes for function response. Text should not be sent as raw bytes,
14384
+ # use the 'text' field.
14385
+ # Corresponds to the JSON property `inlineData`
14386
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionResponseBlob]
14387
+ attr_accessor :inline_data
14388
+
14389
+ def initialize(**args)
14390
+ update!(**args)
14391
+ end
14392
+
14393
+ # Update properties of this object
14394
+ def update!(**args)
14395
+ @file_data = args[:file_data] if args.key?(:file_data)
14396
+ @inline_data = args[:inline_data] if args.key?(:inline_data)
14397
+ end
14398
+ end
14399
+
14000
14400
  # The Google Cloud Storage location where the output is to be written to.
14001
14401
  class GoogleCloudAiplatformV1GcsDestination
14002
14402
  include Google::Apis::Core::Hashable
@@ -14058,6 +14458,58 @@ module Google
14058
14458
  end
14059
14459
  end
14060
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
+
14061
14513
  # Configuration for GenAiAdvancedFeatures.
14062
14514
  class GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig
14063
14515
  include Google::Apis::Core::Hashable
@@ -14119,7 +14571,9 @@ module Google
14119
14571
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
14120
14572
  attr_accessor :contents
14121
14573
 
14122
- # 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.
14123
14577
  # Corresponds to the JSON property `generationConfig`
14124
14578
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
14125
14579
  attr_accessor :generation_config
@@ -14133,7 +14587,10 @@ module Google
14133
14587
  # @return [Hash<String,String>]
14134
14588
  attr_accessor :labels
14135
14589
 
14136
- # 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.
14137
14594
  # Corresponds to the JSON property `modelArmorConfig`
14138
14595
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelArmorConfig]
14139
14596
  attr_accessor :model_armor_config
@@ -14144,10 +14601,9 @@ module Google
14144
14601
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetySetting>]
14145
14602
  attr_accessor :safety_settings
14146
14603
 
14147
- # The base structured datatype containing multi-part content of a message. A `
14148
- # Content` includes a `role` field designating the producer of the `Content` and
14149
- # a `parts` field containing multi-part data that contains the content of the
14150
- # 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.
14151
14607
  # Corresponds to the JSON property `systemInstruction`
14152
14608
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
14153
14609
  attr_accessor :system_instruction
@@ -14404,6 +14860,11 @@ module Google
14404
14860
  class GoogleCloudAiplatformV1GenerateInstanceRubricsRequest
14405
14861
  include Google::Apis::Core::Hashable
14406
14862
 
14863
+ # Configuration for an Agent.
14864
+ # Corresponds to the JSON property `agentConfig`
14865
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationInstanceAgentConfig]
14866
+ attr_accessor :agent_config
14867
+
14407
14868
  # Required. The prompt to generate rubrics from. For single-turn queries, this
14408
14869
  # is a single instance. For multi-turn queries, this is a repeated field that
14409
14870
  # contains conversation history + latest request.
@@ -14427,6 +14888,7 @@ module Google
14427
14888
 
14428
14889
  # Update properties of this object
14429
14890
  def update!(**args)
14891
+ @agent_config = args[:agent_config] if args.key?(:agent_config)
14430
14892
  @contents = args[:contents] if args.key?(:contents)
14431
14893
  @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
14432
14894
  @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
@@ -14578,92 +15040,111 @@ module Google
14578
15040
  end
14579
15041
  end
14580
15042
 
14581
- # 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.
14582
15046
  class GoogleCloudAiplatformV1GenerationConfig
14583
15047
  include Google::Apis::Core::Hashable
14584
15048
 
14585
- # Optional. If enabled, audio timestamp will be included in the request to the
14586
- # 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.
14587
15052
  # Corresponds to the JSON property `audioTimestamp`
14588
15053
  # @return [Boolean]
14589
15054
  attr_accessor :audio_timestamp
14590
15055
  alias_method :audio_timestamp?, :audio_timestamp
14591
15056
 
14592
- # 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.
14593
15061
  # Corresponds to the JSON property `candidateCount`
14594
15062
  # @return [Fixnum]
14595
15063
  attr_accessor :candidate_count
14596
15064
 
14597
15065
  # Optional. If enabled, the model will detect emotions and adapt its responses
14598
- # accordingly.
15066
+ # accordingly. For example, if the model detects that the user is frustrated, it
15067
+ # may provide a more empathetic response.
14599
15068
  # Corresponds to the JSON property `enableAffectiveDialog`
14600
15069
  # @return [Boolean]
14601
15070
  attr_accessor :enable_affective_dialog
14602
15071
  alias_method :enable_affective_dialog?, :enable_affective_dialog
14603
15072
 
14604
- # 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].
14605
15076
  # Corresponds to the JSON property `frequencyPenalty`
14606
15077
  # @return [Float]
14607
15078
  attr_accessor :frequency_penalty
14608
15079
 
14609
- # 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.
14610
15083
  # Corresponds to the JSON property `imageConfig`
14611
15084
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImageConfig]
14612
15085
  attr_accessor :image_config
14613
15086
 
14614
- # 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.
14615
15091
  # Corresponds to the JSON property `logprobs`
14616
15092
  # @return [Fixnum]
14617
15093
  attr_accessor :logprobs
14618
15094
 
14619
- # 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.
14620
15099
  # Corresponds to the JSON property `maxOutputTokens`
14621
15100
  # @return [Fixnum]
14622
15101
  attr_accessor :max_output_tokens
14623
15102
 
14624
- # 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.
14625
15109
  # Corresponds to the JSON property `mediaResolution`
14626
15110
  # @return [String]
14627
15111
  attr_accessor :media_resolution
14628
15112
 
14629
- # 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].
14630
15116
  # Corresponds to the JSON property `presencePenalty`
14631
15117
  # @return [Float]
14632
15118
  attr_accessor :presence_penalty
14633
15119
 
14634
- # Optional. Output schema of the generated response. This is an alternative to `
14635
- # response_schema` that accepts [JSON Schema](https://json-schema.org/). If set,
14636
- # `response_schema` must be omitted, but `response_mime_type` is required. While
14637
- # the full JSON Schema may be sent, not all features are supported. Specifically,
14638
- # only the following properties are supported: - `$id` - `$defs` - `$ref` - `$
14639
- # anchor` - `type` - `format` - `title` - `description` - `enum` (for strings
14640
- # and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` -
14641
- # `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties`
14642
- # - `additionalProperties` - `required` The non-standard `propertyOrdering`
14643
- # property may also be set. Cyclic references are unrolled to a limited degree
14644
- # and, as such, may only be used within non-required properties. (Nullable
14645
- # properties are not sufficient.) If `$ref` is set on a sub-schema, no other
14646
- # 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`.
14647
15122
  # Corresponds to the JSON property `responseJsonSchema`
14648
15123
  # @return [Object]
14649
15124
  attr_accessor :response_json_schema
14650
15125
 
14651
- # 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.
14652
15131
  # Corresponds to the JSON property `responseLogprobs`
14653
15132
  # @return [Boolean]
14654
15133
  attr_accessor :response_logprobs
14655
15134
  alias_method :response_logprobs?, :response_logprobs
14656
15135
 
14657
- # Optional. Output response mimetype of the generated candidate text. Supported
14658
- # mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON
14659
- # 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
14660
15139
  # appropriate response type, otherwise the behavior is undefined. This is a
14661
15140
  # preview feature.
14662
15141
  # Corresponds to the JSON property `responseMimeType`
14663
15142
  # @return [String]
14664
15143
  attr_accessor :response_mime_type
14665
15144
 
14666
- # 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.
14667
15148
  # Corresponds to the JSON property `responseModalities`
14668
15149
  # @return [Array<String>]
14669
15150
  attr_accessor :response_modalities
@@ -14675,42 +15156,68 @@ module Google
14675
15156
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema]
14676
15157
  attr_accessor :response_schema
14677
15158
 
14678
- # 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.
14679
15162
  # Corresponds to the JSON property `routingConfig`
14680
15163
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigRoutingConfig]
14681
15164
  attr_accessor :routing_config
14682
15165
 
14683
- # 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.
14684
15174
  # Corresponds to the JSON property `seed`
14685
15175
  # @return [Fixnum]
14686
15176
  attr_accessor :seed
14687
15177
 
14688
- # The speech generation config.
15178
+ # Configuration for speech generation.
14689
15179
  # Corresponds to the JSON property `speechConfig`
14690
15180
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpeechConfig]
14691
15181
  attr_accessor :speech_config
14692
15182
 
14693
- # 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.
14694
15188
  # Corresponds to the JSON property `stopSequences`
14695
15189
  # @return [Array<String>]
14696
15190
  attr_accessor :stop_sequences
14697
15191
 
14698
- # 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].
14699
15195
  # Corresponds to the JSON property `temperature`
14700
15196
  # @return [Float]
14701
15197
  attr_accessor :temperature
14702
15198
 
14703
- # 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.
14704
15203
  # Corresponds to the JSON property `thinkingConfig`
14705
15204
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigThinkingConfig]
14706
15205
  attr_accessor :thinking_config
14707
15206
 
14708
- # 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.
14709
15211
  # Corresponds to the JSON property `topK`
14710
15212
  # @return [Float]
14711
15213
  attr_accessor :top_k
14712
15214
 
14713
- # 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.
14714
15221
  # Corresponds to the JSON property `topP`
14715
15222
  # @return [Float]
14716
15223
  attr_accessor :top_p
@@ -14746,17 +15253,21 @@ module Google
14746
15253
  end
14747
15254
  end
14748
15255
 
14749
- # 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.
14750
15259
  class GoogleCloudAiplatformV1GenerationConfigRoutingConfig
14751
15260
  include Google::Apis::Core::Hashable
14752
15261
 
14753
- # When automated routing is specified, the routing will be determined by the
14754
- # 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.
14755
15265
  # Corresponds to the JSON property `autoMode`
14756
15266
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode]
14757
15267
  attr_accessor :auto_mode
14758
15268
 
14759
- # 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.
14760
15271
  # Corresponds to the JSON property `manualMode`
14761
15272
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode]
14762
15273
  attr_accessor :manual_mode
@@ -14772,8 +15283,9 @@ module Google
14772
15283
  end
14773
15284
  end
14774
15285
 
14775
- # When automated routing is specified, the routing will be determined by the
14776
- # 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.
14777
15289
  class GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode
14778
15290
  include Google::Apis::Core::Hashable
14779
15291
 
@@ -14792,13 +15304,12 @@ module Google
14792
15304
  end
14793
15305
  end
14794
15306
 
14795
- # 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.
14796
15309
  class GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode
14797
15310
  include Google::Apis::Core::Hashable
14798
15311
 
14799
- # The model name to use. Only the public LLM models are accepted. See [Supported
14800
- # models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/
14801
- # inference#supported-models).
15312
+ # The name of the model to use. Only public LLM models are accepted.
14802
15313
  # Corresponds to the JSON property `modelName`
14803
15314
  # @return [String]
14804
15315
  attr_accessor :model_name
@@ -14813,18 +15324,26 @@ module Google
14813
15324
  end
14814
15325
  end
14815
15326
 
14816
- # 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.
14817
15331
  class GoogleCloudAiplatformV1GenerationConfigThinkingConfig
14818
15332
  include Google::Apis::Core::Hashable
14819
15333
 
14820
- # Optional. Indicates whether to include thoughts in the response. If true,
14821
- # 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.
14822
15339
  # Corresponds to the JSON property `includeThoughts`
14823
15340
  # @return [Boolean]
14824
15341
  attr_accessor :include_thoughts
14825
15342
  alias_method :include_thoughts?, :include_thoughts
14826
15343
 
14827
- # 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.
14828
15347
  # Corresponds to the JSON property `thinkingBudget`
14829
15348
  # @return [Fixnum]
14830
15349
  attr_accessor :thinking_budget
@@ -15078,21 +15597,30 @@ module Google
15078
15597
  end
15079
15598
  end
15080
15599
 
15081
- # 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.
15082
15604
  class GoogleCloudAiplatformV1GroundingChunk
15083
15605
  include Google::Apis::Core::Hashable
15084
15606
 
15085
- # 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.
15086
15610
  # Corresponds to the JSON property `maps`
15087
15611
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkMaps]
15088
15612
  attr_accessor :maps
15089
15613
 
15090
- # 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.
15091
15617
  # Corresponds to the JSON property `retrievedContext`
15092
15618
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkRetrievedContext]
15093
15619
  attr_accessor :retrieved_context
15094
15620
 
15095
- # 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.
15096
15624
  # Corresponds to the JSON property `web`
15097
15625
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkWeb]
15098
15626
  attr_accessor :web
@@ -15109,32 +15637,36 @@ module Google
15109
15637
  end
15110
15638
  end
15111
15639
 
15112
- # 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.
15113
15643
  class GoogleCloudAiplatformV1GroundingChunkMaps
15114
15644
  include Google::Apis::Core::Hashable
15115
15645
 
15116
- # 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.
15117
15649
  # Corresponds to the JSON property `placeAnswerSources`
15118
15650
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources]
15119
15651
  attr_accessor :place_answer_sources
15120
15652
 
15121
- # This Place's resource name, in `places/`place_id`` format. Can be used to look
15122
- # 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.
15123
15655
  # Corresponds to the JSON property `placeId`
15124
15656
  # @return [String]
15125
15657
  attr_accessor :place_id
15126
15658
 
15127
- # Text of the place answer.
15659
+ # The text of the place answer.
15128
15660
  # Corresponds to the JSON property `text`
15129
15661
  # @return [String]
15130
15662
  attr_accessor :text
15131
15663
 
15132
- # Title of the place.
15664
+ # The title of the place.
15133
15665
  # Corresponds to the JSON property `title`
15134
15666
  # @return [String]
15135
15667
  attr_accessor :title
15136
15668
 
15137
- # URI reference of the place.
15669
+ # The URI of the place.
15138
15670
  # Corresponds to the JSON property `uri`
15139
15671
  # @return [String]
15140
15672
  attr_accessor :uri
@@ -15153,11 +15685,13 @@ module Google
15153
15685
  end
15154
15686
  end
15155
15687
 
15156
- # 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.
15157
15691
  class GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources
15158
15692
  include Google::Apis::Core::Hashable
15159
15693
 
15160
- # Snippets of reviews that are used to generate the answer.
15694
+ # Snippets of reviews that were used to generate the answer.
15161
15695
  # Corresponds to the JSON property `reviewSnippets`
15162
15696
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet>]
15163
15697
  attr_accessor :review_snippets
@@ -15172,7 +15706,7 @@ module Google
15172
15706
  end
15173
15707
  end
15174
15708
 
15175
- # Encapsulates a review snippet.
15709
+ # A review snippet that is used to generate the answer.
15176
15710
  class GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
15177
15711
  include Google::Apis::Core::Hashable
15178
15712
 
@@ -15181,12 +15715,12 @@ module Google
15181
15715
  # @return [String]
15182
15716
  attr_accessor :google_maps_uri
15183
15717
 
15184
- # Id of the review referencing the place.
15718
+ # The ID of the review that is being referenced.
15185
15719
  # Corresponds to the JSON property `reviewId`
15186
15720
  # @return [String]
15187
15721
  attr_accessor :review_id
15188
15722
 
15189
- # Title of the review.
15723
+ # The title of the review.
15190
15724
  # Corresponds to the JSON property `title`
15191
15725
  # @return [String]
15192
15726
  attr_accessor :title
@@ -15203,12 +15737,16 @@ module Google
15203
15737
  end
15204
15738
  end
15205
15739
 
15206
- # 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.
15207
15743
  class GoogleCloudAiplatformV1GroundingChunkRetrievedContext
15208
15744
  include Google::Apis::Core::Hashable
15209
15745
 
15210
- # Output only. The full document name for the referenced Vertex AI Search
15211
- # 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``.
15212
15750
  # Corresponds to the JSON property `documentName`
15213
15751
  # @return [String]
15214
15752
  attr_accessor :document_name
@@ -15219,17 +15757,17 @@ module Google
15219
15757
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagChunk]
15220
15758
  attr_accessor :rag_chunk
15221
15759
 
15222
- # Text of the attribution.
15760
+ # The content of the retrieved data source.
15223
15761
  # Corresponds to the JSON property `text`
15224
15762
  # @return [String]
15225
15763
  attr_accessor :text
15226
15764
 
15227
- # Title of the attribution.
15765
+ # The title of the retrieved data source.
15228
15766
  # Corresponds to the JSON property `title`
15229
15767
  # @return [String]
15230
15768
  attr_accessor :title
15231
15769
 
15232
- # URI reference of the attribution.
15770
+ # The URI of the retrieved data source.
15233
15771
  # Corresponds to the JSON property `uri`
15234
15772
  # @return [String]
15235
15773
  attr_accessor :uri
@@ -15248,21 +15786,24 @@ module Google
15248
15786
  end
15249
15787
  end
15250
15788
 
15251
- # 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.
15252
15792
  class GoogleCloudAiplatformV1GroundingChunkWeb
15253
15793
  include Google::Apis::Core::Hashable
15254
15794
 
15255
- # 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.
15256
15797
  # Corresponds to the JSON property `domain`
15257
15798
  # @return [String]
15258
15799
  attr_accessor :domain
15259
15800
 
15260
- # Title of the chunk.
15801
+ # The title of the web page that contains the evidence.
15261
15802
  # Corresponds to the JSON property `title`
15262
15803
  # @return [String]
15263
15804
  attr_accessor :title
15264
15805
 
15265
- # URI reference of the chunk.
15806
+ # The URI of the web page that contains the evidence.
15266
15807
  # Corresponds to the JSON property `uri`
15267
15808
  # @return [String]
15268
15809
  attr_accessor :uri
@@ -15279,44 +15820,56 @@ module Google
15279
15820
  end
15280
15821
  end
15281
15822
 
15282
- # 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.
15283
15826
  class GoogleCloudAiplatformV1GroundingMetadata
15284
15827
  include Google::Apis::Core::Hashable
15285
15828
 
15286
- # Optional. Output only. Resource name of the Google Maps widget context token
15287
- # to be used with the PlacesContextElement widget to render contextual data.
15288
- # 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.
15289
15832
  # Corresponds to the JSON property `googleMapsWidgetContextToken`
15290
15833
  # @return [String]
15291
15834
  attr_accessor :google_maps_widget_context_token
15292
15835
 
15293
- # 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.
15294
15839
  # Corresponds to the JSON property `groundingChunks`
15295
15840
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunk>]
15296
15841
  attr_accessor :grounding_chunks
15297
15842
 
15298
- # 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.
15299
15846
  # Corresponds to the JSON property `groundingSupports`
15300
15847
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingSupport>]
15301
15848
  attr_accessor :grounding_supports
15302
15849
 
15303
- # 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.
15304
15852
  # Corresponds to the JSON property `retrievalMetadata`
15305
15853
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrievalMetadata]
15306
15854
  attr_accessor :retrieval_metadata
15307
15855
 
15308
- # 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.
15309
15860
  # Corresponds to the JSON property `searchEntryPoint`
15310
15861
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchEntryPoint]
15311
15862
  attr_accessor :search_entry_point
15312
15863
 
15313
- # Optional. Output only. List of source flagging uris. This is currently
15314
- # 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.
15315
15867
  # Corresponds to the JSON property `sourceFlaggingUris`
15316
15868
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri>]
15317
15869
  attr_accessor :source_flagging_uris
15318
15870
 
15319
- # 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.
15320
15873
  # Corresponds to the JSON property `webSearchQueries`
15321
15874
  # @return [Array<String>]
15322
15875
  attr_accessor :web_search_queries
@@ -15337,17 +15890,17 @@ module Google
15337
15890
  end
15338
15891
  end
15339
15892
 
15340
- # Source content flagging uri for a place or review. This is currently populated
15341
- # 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.
15342
15895
  class GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri
15343
15896
  include Google::Apis::Core::Hashable
15344
15897
 
15345
- # 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.
15346
15899
  # Corresponds to the JSON property `flagContentUri`
15347
15900
  # @return [String]
15348
15901
  attr_accessor :flag_content_uri
15349
15902
 
15350
- # Id of the place or review.
15903
+ # The ID of the place or review.
15351
15904
  # Corresponds to the JSON property `sourceId`
15352
15905
  # @return [String]
15353
15906
  attr_accessor :source_id
@@ -15363,27 +15916,30 @@ module Google
15363
15916
  end
15364
15917
  end
15365
15918
 
15366
- # Grounding support.
15919
+ # A collection of supporting references for a segment of the model's response.
15367
15920
  class GoogleCloudAiplatformV1GroundingSupport
15368
15921
  include Google::Apis::Core::Hashable
15369
15922
 
15370
- # Confidence score of the support references. Ranges from 0 to 1. 1 is the most
15371
- # confident. For Gemini 2.0 and before, this list must have the same size as the
15372
- # 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
15373
15928
  # should be ignored.
15374
15929
  # Corresponds to the JSON property `confidenceScores`
15375
15930
  # @return [Array<Float>]
15376
15931
  attr_accessor :confidence_scores
15377
15932
 
15378
- # A list of indices (into 'grounding_chunk') specifying the citations associated
15379
- # with the claim. For instance [1,3,4] means that grounding_chunk[1],
15380
- # grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to
15381
- # 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.
15382
15938
  # Corresponds to the JSON property `groundingChunkIndices`
15383
15939
  # @return [Array<Fixnum>]
15384
15940
  attr_accessor :grounding_chunk_indices
15385
15941
 
15386
- # Segment of the content.
15942
+ # A segment of the content.
15387
15943
  # Corresponds to the JSON property `segment`
15388
15944
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Segment]
15389
15945
  attr_accessor :segment
@@ -15562,7 +16118,9 @@ module Google
15562
16118
  end
15563
16119
  end
15564
16120
 
15565
- # 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.
15566
16124
  class GoogleCloudAiplatformV1ImageConfig
15567
16125
  include Google::Apis::Core::Hashable
15568
16126
 
@@ -15573,6 +16131,16 @@ module Google
15573
16131
  # @return [String]
15574
16132
  attr_accessor :aspect_ratio
15575
16133
 
16134
+ # The image output format for generated images.
16135
+ # Corresponds to the JSON property `imageOutputOptions`
16136
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImageConfigImageOutputOptions]
16137
+ attr_accessor :image_output_options
16138
+
16139
+ # Optional. Controls whether the model can generate people.
16140
+ # Corresponds to the JSON property `personGeneration`
16141
+ # @return [String]
16142
+ attr_accessor :person_generation
16143
+
15576
16144
  def initialize(**args)
15577
16145
  update!(**args)
15578
16146
  end
@@ -15580,6 +16148,33 @@ module Google
15580
16148
  # Update properties of this object
15581
16149
  def update!(**args)
15582
16150
  @aspect_ratio = args[:aspect_ratio] if args.key?(:aspect_ratio)
16151
+ @image_output_options = args[:image_output_options] if args.key?(:image_output_options)
16152
+ @person_generation = args[:person_generation] if args.key?(:person_generation)
16153
+ end
16154
+ end
16155
+
16156
+ # The image output format for generated images.
16157
+ class GoogleCloudAiplatformV1ImageConfigImageOutputOptions
16158
+ include Google::Apis::Core::Hashable
16159
+
16160
+ # Optional. The compression quality of the output image.
16161
+ # Corresponds to the JSON property `compressionQuality`
16162
+ # @return [Fixnum]
16163
+ attr_accessor :compression_quality
16164
+
16165
+ # Optional. The image format that the output should be saved as.
16166
+ # Corresponds to the JSON property `mimeType`
16167
+ # @return [String]
16168
+ attr_accessor :mime_type
16169
+
16170
+ def initialize(**args)
16171
+ update!(**args)
16172
+ end
16173
+
16174
+ # Update properties of this object
16175
+ def update!(**args)
16176
+ @compression_quality = args[:compression_quality] if args.key?(:compression_quality)
16177
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
15583
16178
  end
15584
16179
  end
15585
16180
 
@@ -18440,17 +19035,24 @@ module Google
18440
19035
  end
18441
19036
  end
18442
19037
 
18443
- # 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.
18444
19044
  class GoogleCloudAiplatformV1LogprobsResult
18445
19045
  include Google::Apis::Core::Hashable
18446
19046
 
18447
- # Length = total number of decoding steps. The chosen candidates may or may not
18448
- # 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`.
18449
19050
  # Corresponds to the JSON property `chosenCandidates`
18450
19051
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LogprobsResultCandidate>]
18451
19052
  attr_accessor :chosen_candidates
18452
19053
 
18453
- # 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.
18454
19056
  # Corresponds to the JSON property `topCandidates`
18455
19057
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LogprobsResultTopCandidates>]
18456
19058
  attr_accessor :top_candidates
@@ -18466,21 +19068,27 @@ module Google
18466
19068
  end
18467
19069
  end
18468
19070
 
18469
- # Candidate for the logprobs token and score.
19071
+ # A single token and its associated log probability.
18470
19072
  class GoogleCloudAiplatformV1LogprobsResultCandidate
18471
19073
  include Google::Apis::Core::Hashable
18472
19074
 
18473
- # 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.
18474
19079
  # Corresponds to the JSON property `logProbability`
18475
19080
  # @return [Float]
18476
19081
  attr_accessor :log_probability
18477
19082
 
18478
- # The candidate's token string value.
19083
+ # The token's string representation.
18479
19084
  # Corresponds to the JSON property `token`
18480
19085
  # @return [String]
18481
19086
  attr_accessor :token
18482
19087
 
18483
- # 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.
18484
19092
  # Corresponds to the JSON property `tokenId`
18485
19093
  # @return [Fixnum]
18486
19094
  attr_accessor :token_id
@@ -18497,11 +19105,12 @@ module Google
18497
19105
  end
18498
19106
  end
18499
19107
 
18500
- # 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.
18501
19110
  class GoogleCloudAiplatformV1LogprobsResultTopCandidates
18502
19111
  include Google::Apis::Core::Hashable
18503
19112
 
18504
- # Sorted by log probability in descending order.
19113
+ # The list of candidate tokens, sorted by log probability in descending order.
18505
19114
  # Corresponds to the JSON property `candidates`
18506
19115
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LogprobsResultCandidate>]
18507
19116
  attr_accessor :candidates
@@ -18904,6 +19513,11 @@ module Google
18904
19513
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BleuSpec]
18905
19514
  attr_accessor :bleu_spec
18906
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
+
18907
19521
  # Spec for exact match metric - returns 1 if prediction and reference exactly
18908
19522
  # matches, otherwise 0.
18909
19523
  # Corresponds to the JSON property `exactMatchSpec`
@@ -18944,6 +19558,7 @@ module Google
18944
19558
  def update!(**args)
18945
19559
  @aggregation_metrics = args[:aggregation_metrics] if args.key?(:aggregation_metrics)
18946
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)
18947
19562
  @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec)
18948
19563
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
18949
19564
  @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec)
@@ -19514,16 +20129,21 @@ module Google
19514
20129
  end
19515
20130
  end
19516
20131
 
19517
- # 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.
19518
20138
  class GoogleCloudAiplatformV1ModalityTokenCount
19519
20139
  include Google::Apis::Core::Hashable
19520
20140
 
19521
- # The modality associated with this token count.
20141
+ # The modality that this token count applies to.
19522
20142
  # Corresponds to the JSON property `modality`
19523
20143
  # @return [String]
19524
20144
  attr_accessor :modality
19525
20145
 
19526
- # Number of tokens.
20146
+ # The number of tokens counted for this modality.
19527
20147
  # Corresponds to the JSON property `tokenCount`
19528
20148
  # @return [Fixnum]
19529
20149
  attr_accessor :token_count
@@ -19836,17 +20456,29 @@ module Google
19836
20456
  end
19837
20457
  end
19838
20458
 
19839
- # 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.
19840
20463
  class GoogleCloudAiplatformV1ModelArmorConfig
19841
20464
  include Google::Apis::Core::Hashable
19842
20465
 
19843
- # 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``.
19844
20472
  # Corresponds to the JSON property `promptTemplateName`
19845
20473
  # @return [String]
19846
20474
  attr_accessor :prompt_template_name
19847
20475
 
19848
- # Optional. The name of the Model Armor template to use for response
19849
- # 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``.
19850
20482
  # Corresponds to the JSON property `responseTemplateName`
19851
20483
  # @return [String]
19852
20484
  attr_accessor :response_template_name
@@ -21387,8 +22019,7 @@ module Google
21387
22019
  end
21388
22020
  end
21389
22021
 
21390
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
21391
- # to two distinct voices in a single synthesis request.
22022
+ # Configuration for a multi-speaker text-to-speech request.
21392
22023
  class GoogleCloudAiplatformV1MultiSpeakerVoiceConfig
21393
22024
  include Google::Apis::Core::Hashable
21394
22025
 
@@ -23673,11 +24304,11 @@ module Google
23673
24304
  end
23674
24305
  end
23675
24306
 
23676
- # 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 `
23677
24308
  # Part` consists of data which has an associated datatype. A `Part` can only
23678
- # contain one of the accepted types in `Part.data`. A `Part` must have a fixed
23679
- # IANA MIME type identifying the type and subtype of the media if `inline_data`
23680
- # 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.
23681
24312
  class GoogleCloudAiplatformV1Part
23682
24313
  include Google::Apis::Core::Hashable
23683
24314
 
@@ -23696,7 +24327,9 @@ module Google
23696
24327
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExecutableCode]
23697
24328
  attr_accessor :executable_code
23698
24329
 
23699
- # 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.
23700
24333
  # Corresponds to the JSON property `fileData`
23701
24334
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FileData]
23702
24335
  attr_accessor :file_data
@@ -23716,17 +24349,19 @@ module Google
23716
24349
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionResponse]
23717
24350
  attr_accessor :function_response
23718
24351
 
23719
- # 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.
23720
24354
  # Corresponds to the JSON property `inlineData`
23721
24355
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Blob]
23722
24356
  attr_accessor :inline_data
23723
24357
 
23724
- # Optional. Text part (can be code).
24358
+ # Optional. The text content of the part.
23725
24359
  # Corresponds to the JSON property `text`
23726
24360
  # @return [String]
23727
24361
  attr_accessor :text
23728
24362
 
23729
- # 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.
23730
24365
  # Corresponds to the JSON property `thought`
23731
24366
  # @return [Boolean]
23732
24367
  attr_accessor :thought
@@ -23739,7 +24374,8 @@ module Google
23739
24374
  # @return [String]
23740
24375
  attr_accessor :thought_signature
23741
24376
 
23742
- # 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.
23743
24379
  # Corresponds to the JSON property `videoMetadata`
23744
24380
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VideoMetadata]
23745
24381
  attr_accessor :video_metadata
@@ -24739,11 +25375,11 @@ module Google
24739
25375
  end
24740
25376
  end
24741
25377
 
24742
- # The configuration for the prebuilt speaker to use.
25378
+ # Configuration for a prebuilt voice.
24743
25379
  class GoogleCloudAiplatformV1PrebuiltVoiceConfig
24744
25380
  include Google::Apis::Core::Hashable
24745
25381
 
24746
- # The name of the preset voice to use.
25382
+ # The name of the prebuilt voice to use.
24747
25383
  # Corresponds to the JSON property `voiceName`
24748
25384
  # @return [String]
24749
25385
  attr_accessor :voice_name
@@ -25022,6 +25658,161 @@ module Google
25022
25658
  end
25023
25659
  end
25024
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
+
25025
25816
  # Preset configuration for example-based explanations
25026
25817
  class GoogleCloudAiplatformV1Presets
25027
25818
  include Google::Apis::Core::Hashable
@@ -26946,6 +27737,18 @@ module Google
26946
27737
  # @return [String]
26947
27738
  attr_accessor :name
26948
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
+
26949
27752
  # Output only. Timestamp when this RagCorpus was last updated.
26950
27753
  # Corresponds to the JSON property `updateTime`
26951
27754
  # @return [String]
@@ -26973,6 +27776,8 @@ module Google
26973
27776
  @display_name = args[:display_name] if args.key?(:display_name)
26974
27777
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
26975
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)
26976
27781
  @update_time = args[:update_time] if args.key?(:update_time)
26977
27782
  @vector_db_config = args[:vector_db_config] if args.key?(:vector_db_config)
26978
27783
  @vertex_ai_search_config = args[:vertex_ai_search_config] if args.key?(:vertex_ai_search_config)
@@ -28289,6 +29094,11 @@ module Google
28289
29094
  # @return [String]
28290
29095
  attr_accessor :service_account
28291
29096
 
29097
+ # Specification for deploying from source code.
29098
+ # Corresponds to the JSON property `sourceCodeSpec`
29099
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec]
29100
+ attr_accessor :source_code_spec
29101
+
28292
29102
  def initialize(**args)
28293
29103
  update!(**args)
28294
29104
  end
@@ -28300,6 +29110,7 @@ module Google
28300
29110
  @deployment_spec = args[:deployment_spec] if args.key?(:deployment_spec)
28301
29111
  @package_spec = args[:package_spec] if args.key?(:package_spec)
28302
29112
  @service_account = args[:service_account] if args.key?(:service_account)
29113
+ @source_code_spec = args[:source_code_spec] if args.key?(:source_code_spec)
28303
29114
  end
28304
29115
  end
28305
29116
 
@@ -28387,8 +29198,8 @@ module Google
28387
29198
  # @return [String]
28388
29199
  attr_accessor :pickle_object_gcs_uri
28389
29200
 
28390
- # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not
28391
- # 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.
28392
29203
  # Corresponds to the JSON property `pythonVersion`
28393
29204
  # @return [String]
28394
29205
  attr_accessor :python_version
@@ -28411,6 +29222,95 @@ module Google
28411
29222
  end
28412
29223
  end
28413
29224
 
29225
+ # Specification for deploying from source code.
29226
+ class GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec
29227
+ include Google::Apis::Core::Hashable
29228
+
29229
+ # Specifies source code provided as a byte stream.
29230
+ # Corresponds to the JSON property `inlineSource`
29231
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource]
29232
+ attr_accessor :inline_source
29233
+
29234
+ # Specification for running a Python application from source.
29235
+ # Corresponds to the JSON property `pythonSpec`
29236
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec]
29237
+ attr_accessor :python_spec
29238
+
29239
+ def initialize(**args)
29240
+ update!(**args)
29241
+ end
29242
+
29243
+ # Update properties of this object
29244
+ def update!(**args)
29245
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
29246
+ @python_spec = args[:python_spec] if args.key?(:python_spec)
29247
+ end
29248
+ end
29249
+
29250
+ # Specifies source code provided as a byte stream.
29251
+ class GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource
29252
+ include Google::Apis::Core::Hashable
29253
+
29254
+ # Required. Input only. The application source code archive, provided as a
29255
+ # compressed tarball (.tar.gz) file.
29256
+ # Corresponds to the JSON property `sourceArchive`
29257
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
29258
+ # @return [String]
29259
+ attr_accessor :source_archive
29260
+
29261
+ def initialize(**args)
29262
+ update!(**args)
29263
+ end
29264
+
29265
+ # Update properties of this object
29266
+ def update!(**args)
29267
+ @source_archive = args[:source_archive] if args.key?(:source_archive)
29268
+ end
29269
+ end
29270
+
29271
+ # Specification for running a Python application from source.
29272
+ class GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec
29273
+ include Google::Apis::Core::Hashable
29274
+
29275
+ # Optional. The Python module to load as the entrypoint, specified as a fully
29276
+ # qualified module name. For example: path.to.agent. If not specified, defaults
29277
+ # to "agent". The project root will be added to Python sys.path, allowing
29278
+ # imports to be specified relative to the root.
29279
+ # Corresponds to the JSON property `entrypointModule`
29280
+ # @return [String]
29281
+ attr_accessor :entrypoint_module
29282
+
29283
+ # Optional. The name of the callable object within the `entrypoint_module` to
29284
+ # use as the application If not specified, defaults to "root_agent".
29285
+ # Corresponds to the JSON property `entrypointObject`
29286
+ # @return [String]
29287
+ attr_accessor :entrypoint_object
29288
+
29289
+ # Optional. The path to the requirements file, relative to the source root. If
29290
+ # not specified, defaults to "requirements.txt".
29291
+ # Corresponds to the JSON property `requirementsFile`
29292
+ # @return [String]
29293
+ attr_accessor :requirements_file
29294
+
29295
+ # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.
29296
+ # 11, 3.12, 3.13. If not specified, default value is 3.10.
29297
+ # Corresponds to the JSON property `version`
29298
+ # @return [String]
29299
+ attr_accessor :version
29300
+
29301
+ def initialize(**args)
29302
+ update!(**args)
29303
+ end
29304
+
29305
+ # Update properties of this object
29306
+ def update!(**args)
29307
+ @entrypoint_module = args[:entrypoint_module] if args.key?(:entrypoint_module)
29308
+ @entrypoint_object = args[:entrypoint_object] if args.key?(:entrypoint_object)
29309
+ @requirements_file = args[:requirements_file] if args.key?(:requirements_file)
29310
+ @version = args[:version] if args.key?(:version)
29311
+ end
29312
+ end
29313
+
28414
29314
  # Request message for GenAiTuningService.RebaseTunedModel.
28415
29315
  class GoogleCloudAiplatformV1RebaseTunedModelRequest
28416
29316
  include Google::Apis::Core::Hashable
@@ -28869,15 +29769,17 @@ module Google
28869
29769
  end
28870
29770
  end
28871
29771
 
28872
- # 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.
28873
29774
  class GoogleCloudAiplatformV1RetrievalMetadata
28874
29775
  include Google::Apis::Core::Hashable
28875
29776
 
28876
- # Optional. Score indicating how likely information from Google Search could
28877
- # help answer the prompt. The score is in the range `[0, 1]`, where 0 is the
28878
- # least likely and 1 is the most likely. This score is only populated when
28879
- # Google Search grounding and dynamic retrieval is enabled. It will be compared
28880
- # 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.
28881
29783
  # Corresponds to the JSON property `googleSearchDynamicRetrievalScore`
28882
29784
  # @return [Float]
28883
29785
  attr_accessor :google_search_dynamic_retrieval_score
@@ -29463,18 +30365,18 @@ module Google
29463
30365
  end
29464
30366
  end
29465
30367
 
29466
- # 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.
29467
30370
  class GoogleCloudAiplatformV1SafetyRating
29468
30371
  include Google::Apis::Core::Hashable
29469
30372
 
29470
- # Output only. Indicates whether the content was filtered out because of this
29471
- # rating.
30373
+ # Output only. Indicates whether the content was blocked because of this rating.
29472
30374
  # Corresponds to the JSON property `blocked`
29473
30375
  # @return [Boolean]
29474
30376
  attr_accessor :blocked
29475
30377
  alias_method :blocked?, :blocked
29476
30378
 
29477
- # Output only. Harm category.
30379
+ # Output only. The harm category of this rating.
29478
30380
  # Corresponds to the JSON property `category`
29479
30381
  # @return [String]
29480
30382
  attr_accessor :category
@@ -29486,22 +30388,22 @@ module Google
29486
30388
  # @return [String]
29487
30389
  attr_accessor :overwritten_threshold
29488
30390
 
29489
- # Output only. Harm probability levels in the content.
30391
+ # Output only. The probability of harm for this category.
29490
30392
  # Corresponds to the JSON property `probability`
29491
30393
  # @return [String]
29492
30394
  attr_accessor :probability
29493
30395
 
29494
- # Output only. Harm probability score.
30396
+ # Output only. The probability score of harm for this category.
29495
30397
  # Corresponds to the JSON property `probabilityScore`
29496
30398
  # @return [Float]
29497
30399
  attr_accessor :probability_score
29498
30400
 
29499
- # Output only. Harm severity levels in the content.
30401
+ # Output only. The severity of harm for this category.
29500
30402
  # Corresponds to the JSON property `severity`
29501
30403
  # @return [String]
29502
30404
  attr_accessor :severity
29503
30405
 
29504
- # Output only. Harm severity score.
30406
+ # Output only. The severity score of harm for this category.
29505
30407
  # Corresponds to the JSON property `severityScore`
29506
30408
  # @return [Float]
29507
30409
  attr_accessor :severity_score
@@ -29553,22 +30455,24 @@ module Google
29553
30455
  end
29554
30456
  end
29555
30457
 
29556
- # 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.
29557
30460
  class GoogleCloudAiplatformV1SafetySetting
29558
30461
  include Google::Apis::Core::Hashable
29559
30462
 
29560
- # Required. Harm category.
30463
+ # Required. The harm category to be blocked.
29561
30464
  # Corresponds to the JSON property `category`
29562
30465
  # @return [String]
29563
30466
  attr_accessor :category
29564
30467
 
29565
- # Optional. Specify if the threshold is used for probability or severity score.
29566
- # 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.
29567
30470
  # Corresponds to the JSON property `method`
29568
30471
  # @return [String]
29569
30472
  attr_accessor :method_prop
29570
30473
 
29571
- # 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.
29572
30476
  # Corresponds to the JSON property `threshold`
29573
30477
  # @return [String]
29574
30478
  attr_accessor :threshold
@@ -32998,7 +33902,9 @@ module Google
32998
33902
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
32999
33903
  attr_accessor :contents
33000
33904
 
33001
- # 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.
33002
33908
  # Corresponds to the JSON property `generationConfig`
33003
33909
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
33004
33910
  attr_accessor :generation_config
@@ -33014,10 +33920,9 @@ module Google
33014
33920
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetySetting>]
33015
33921
  attr_accessor :safety_settings
33016
33922
 
33017
- # The base structured datatype containing multi-part content of a message. A `
33018
- # Content` includes a `role` field designating the producer of the `Content` and
33019
- # a `parts` field containing multi-part data that contains the content of the
33020
- # 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.
33021
33926
  # Corresponds to the JSON property `systemInstruction`
33022
33927
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
33023
33928
  attr_accessor :system_instruction
@@ -33099,10 +34004,9 @@ module Google
33099
34004
  class GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt
33100
34005
  include Google::Apis::Core::Hashable
33101
34006
 
33102
- # The base structured datatype containing multi-part content of a message. A `
33103
- # Content` includes a `role` field designating the producer of the `Content` and
33104
- # a `parts` field containing multi-part data that contains the content of the
33105
- # 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.
33106
34010
  # Corresponds to the JSON property `context`
33107
34011
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
33108
34012
  attr_accessor :context
@@ -36872,17 +37776,23 @@ module Google
36872
37776
  end
36873
37777
  end
36874
37778
 
36875
- # 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.
36876
37783
  class GoogleCloudAiplatformV1SearchEntryPoint
36877
37784
  include Google::Apis::Core::Hashable
36878
37785
 
36879
- # Optional. Web content snippet that can be embedded in a web page or an app
36880
- # 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.
36881
37789
  # Corresponds to the JSON property `renderedContent`
36882
37790
  # @return [String]
36883
37791
  attr_accessor :rendered_content
36884
37792
 
36885
- # 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.
36886
37796
  # Corresponds to the JSON property `sdkBlob`
36887
37797
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
36888
37798
  # @return [String]
@@ -37213,28 +38123,31 @@ module Google
37213
38123
  end
37214
38124
  end
37215
38125
 
37216
- # Segment of the content.
38126
+ # A segment of the content.
37217
38127
  class GoogleCloudAiplatformV1Segment
37218
38128
  include Google::Apis::Core::Hashable
37219
38129
 
37220
- # Output only. End index in the given Part, measured in bytes. Offset from the
37221
- # 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.
37222
38133
  # Corresponds to the JSON property `endIndex`
37223
38134
  # @return [Fixnum]
37224
38135
  attr_accessor :end_index
37225
38136
 
37226
- # 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.
37227
38139
  # Corresponds to the JSON property `partIndex`
37228
38140
  # @return [Fixnum]
37229
38141
  attr_accessor :part_index
37230
38142
 
37231
- # Output only. Start index in the given Part, measured in bytes. Offset from the
37232
- # 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.
37233
38146
  # Corresponds to the JSON property `startIndex`
37234
38147
  # @return [Fixnum]
37235
38148
  attr_accessor :start_index
37236
38149
 
37237
- # Output only. The text corresponding to the segment from the response.
38150
+ # Output only. The text of the segment.
37238
38151
  # Corresponds to the JSON property `text`
37239
38152
  # @return [String]
37240
38153
  attr_accessor :text
@@ -37524,7 +38437,7 @@ module Google
37524
38437
  end
37525
38438
  end
37526
38439
 
37527
- # Configuration for a single speaker in a multi speaker setup.
38440
+ # Configuration for a single speaker in a multi-speaker setup.
37528
38441
  class GoogleCloudAiplatformV1SpeakerVoiceConfig
37529
38442
  include Google::Apis::Core::Hashable
37530
38443
 
@@ -37534,7 +38447,7 @@ module Google
37534
38447
  # @return [String]
37535
38448
  attr_accessor :speaker
37536
38449
 
37537
- # The configuration for the voice to use.
38450
+ # Configuration for a voice.
37538
38451
  # Corresponds to the JSON property `voiceConfig`
37539
38452
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VoiceConfig]
37540
38453
  attr_accessor :voice_config
@@ -37681,22 +38594,21 @@ module Google
37681
38594
  end
37682
38595
  end
37683
38596
 
37684
- # The speech generation config.
38597
+ # Configuration for speech generation.
37685
38598
  class GoogleCloudAiplatformV1SpeechConfig
37686
38599
  include Google::Apis::Core::Hashable
37687
38600
 
37688
- # 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.
37689
38602
  # Corresponds to the JSON property `languageCode`
37690
38603
  # @return [String]
37691
38604
  attr_accessor :language_code
37692
38605
 
37693
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
37694
- # to two distinct voices in a single synthesis request.
38606
+ # Configuration for a multi-speaker text-to-speech request.
37695
38607
  # Corresponds to the JSON property `multiSpeakerVoiceConfig`
37696
38608
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MultiSpeakerVoiceConfig]
37697
38609
  attr_accessor :multi_speaker_voice_config
37698
38610
 
37699
- # The configuration for the voice to use.
38611
+ # Configuration for a voice.
37700
38612
  # Corresponds to the JSON property `voiceConfig`
37701
38613
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VoiceConfig]
37702
38614
  attr_accessor :voice_config
@@ -39572,10 +40484,9 @@ module Google
39572
40484
  class GoogleCloudAiplatformV1SyntheticField
39573
40485
  include Google::Apis::Core::Hashable
39574
40486
 
39575
- # The base structured datatype containing multi-part content of a message. A `
39576
- # Content` includes a `role` field designating the producer of the `Content` and
39577
- # a `parts` field containing multi-part data that contains the content of the
39578
- # 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.
39579
40490
  # Corresponds to the JSON property `content`
39580
40491
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
39581
40492
  attr_accessor :content
@@ -40365,6 +41276,11 @@ module Google
40365
41276
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolCodeExecution]
40366
41277
  attr_accessor :code_execution
40367
41278
 
41279
+ # Tool to support computer use.
41280
+ # Corresponds to the JSON property `computerUse`
41281
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolComputerUse]
41282
+ attr_accessor :computer_use
41283
+
40368
41284
  # Tool to search public web data, powered by Vertex AI Search and Sec4
40369
41285
  # compliance.
40370
41286
  # Corresponds to the JSON property `enterpriseWebSearch`
@@ -40414,6 +41330,7 @@ module Google
40414
41330
  # Update properties of this object
40415
41331
  def update!(**args)
40416
41332
  @code_execution = args[:code_execution] if args.key?(:code_execution)
41333
+ @computer_use = args[:computer_use] if args.key?(:computer_use)
40417
41334
  @enterprise_web_search = args[:enterprise_web_search] if args.key?(:enterprise_web_search)
40418
41335
  @function_declarations = args[:function_declarations] if args.key?(:function_declarations)
40419
41336
  @google_maps = args[:google_maps] if args.key?(:google_maps)
@@ -40565,6 +41482,36 @@ module Google
40565
41482
  end
40566
41483
  end
40567
41484
 
41485
+ # Tool to support computer use.
41486
+ class GoogleCloudAiplatformV1ToolComputerUse
41487
+ include Google::Apis::Core::Hashable
41488
+
41489
+ # Required. The environment being operated.
41490
+ # Corresponds to the JSON property `environment`
41491
+ # @return [String]
41492
+ attr_accessor :environment
41493
+
41494
+ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-
41495
+ # ai/generative-ai/docs/computer-use#supported-actions) are included in the
41496
+ # final model call. Some of them can be explicitly excluded from being
41497
+ # automatically included. This can serve two purposes: 1. Using a more
41498
+ # restricted / different action space. 2. Improving the definitions /
41499
+ # instructions of predefined functions.
41500
+ # Corresponds to the JSON property `excludedPredefinedFunctions`
41501
+ # @return [Array<String>]
41502
+ attr_accessor :excluded_predefined_functions
41503
+
41504
+ def initialize(**args)
41505
+ update!(**args)
41506
+ end
41507
+
41508
+ # Update properties of this object
41509
+ def update!(**args)
41510
+ @environment = args[:environment] if args.key?(:environment)
41511
+ @excluded_predefined_functions = args[:excluded_predefined_functions] if args.key?(:excluded_predefined_functions)
41512
+ end
41513
+ end
41514
+
40568
41515
  # Tool config. This config is shared for all tools provided in the request.
40569
41516
  class GoogleCloudAiplatformV1ToolConfig
40570
41517
  include Google::Apis::Core::Hashable
@@ -42018,6 +42965,11 @@ module Google
42018
42965
  class GoogleCloudAiplatformV1TuningDataStats
42019
42966
  include Google::Apis::Core::Hashable
42020
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
+
42021
42973
  # Tuning data statistics for Supervised Tuning.
42022
42974
  # Corresponds to the JSON property `supervisedTuningDataStats`
42023
42975
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SupervisedTuningDataStats]
@@ -42029,6 +42981,7 @@ module Google
42029
42981
 
42030
42982
  # Update properties of this object
42031
42983
  def update!(**args)
42984
+ @preference_optimization_data_stats = args[:preference_optimization_data_stats] if args.key?(:preference_optimization_data_stats)
42032
42985
  @supervised_tuning_data_stats = args[:supervised_tuning_data_stats] if args.key?(:supervised_tuning_data_stats)
42033
42986
  end
42034
42987
  end
@@ -42103,6 +43056,11 @@ module Google
42103
43056
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PreTunedModel]
42104
43057
  attr_accessor :pre_tuned_model
42105
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
+
42106
43064
  # The service account that the tuningJob workload runs as. If not specified, the
42107
43065
  # Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See
42108
43066
  # https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-
@@ -42169,6 +43127,7 @@ module Google
42169
43127
  @labels = args[:labels] if args.key?(:labels)
42170
43128
  @name = args[:name] if args.key?(:name)
42171
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)
42172
43131
  @service_account = args[:service_account] if args.key?(:service_account)
42173
43132
  @start_time = args[:start_time] if args.key?(:start_time)
42174
43133
  @state = args[:state] if args.key?(:state)
@@ -42891,11 +43850,13 @@ module Google
42891
43850
  end
42892
43851
  end
42893
43852
 
42894
- # 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.
42895
43855
  class GoogleCloudAiplatformV1UrlContextMetadata
42896
43856
  include Google::Apis::Core::Hashable
42897
43857
 
42898
- # 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.
42899
43860
  # Corresponds to the JSON property `urlMetadata`
42900
43861
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UrlMetadata>]
42901
43862
  attr_accessor :url_metadata
@@ -42910,16 +43871,16 @@ module Google
42910
43871
  end
42911
43872
  end
42912
43873
 
42913
- # Context of the a single url retrieval.
43874
+ # The metadata for a single URL retrieval.
42914
43875
  class GoogleCloudAiplatformV1UrlMetadata
42915
43876
  include Google::Apis::Core::Hashable
42916
43877
 
42917
- # Retrieved url by the tool.
43878
+ # The URL retrieved by the tool.
42918
43879
  # Corresponds to the JSON property `retrievedUrl`
42919
43880
  # @return [String]
42920
43881
  attr_accessor :retrieved_url
42921
43882
 
42922
- # Status of the url retrieval.
43883
+ # The status of the URL retrieval.
42923
43884
  # Corresponds to the JSON property `urlRetrievalStatus`
42924
43885
  # @return [String]
42925
43886
  attr_accessor :url_retrieval_status
@@ -43266,7 +44227,8 @@ module Google
43266
44227
  end
43267
44228
  end
43268
44229
 
43269
- # 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.
43270
44232
  class GoogleCloudAiplatformV1VideoMetadata
43271
44233
  include Google::Apis::Core::Hashable
43272
44234
 
@@ -43276,7 +44238,7 @@ module Google
43276
44238
  attr_accessor :end_offset
43277
44239
 
43278
44240
  # Optional. The frame rate of the video sent to the model. If not specified, the
43279
- # 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].
43280
44242
  # Corresponds to the JSON property `fps`
43281
44243
  # @return [Float]
43282
44244
  attr_accessor :fps
@@ -43298,11 +44260,11 @@ module Google
43298
44260
  end
43299
44261
  end
43300
44262
 
43301
- # The configuration for the voice to use.
44263
+ # Configuration for a voice.
43302
44264
  class GoogleCloudAiplatformV1VoiceConfig
43303
44265
  include Google::Apis::Core::Hashable
43304
44266
 
43305
- # The configuration for the prebuilt speaker to use.
44267
+ # Configuration for a prebuilt voice.
43306
44268
  # Corresponds to the JSON property `prebuiltVoiceConfig`
43307
44269
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PrebuiltVoiceConfig]
43308
44270
  attr_accessor :prebuilt_voice_config