google-apis-aiplatform_v1beta1 0.64.0 → 0.66.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.
@@ -818,6 +818,11 @@ module Google
818
818
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuMetricValue]
819
819
  attr_accessor :bleu_metric_value
820
820
 
821
+ # Result for custom code execution metric.
822
+ # Corresponds to the JSON property `customCodeExecutionResult`
823
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionResult]
824
+ attr_accessor :custom_code_execution_result
825
+
821
826
  # Exact match metric value for an instance.
822
827
  # Corresponds to the JSON property `exactMatchMetricValue`
823
828
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExactMatchMetricValue]
@@ -846,6 +851,7 @@ module Google
846
851
  def update!(**args)
847
852
  @aggregation_metric = args[:aggregation_metric] if args.key?(:aggregation_metric)
848
853
  @bleu_metric_value = args[:bleu_metric_value] if args.key?(:bleu_metric_value)
854
+ @custom_code_execution_result = args[:custom_code_execution_result] if args.key?(:custom_code_execution_result)
849
855
  @exact_match_metric_value = args[:exact_match_metric_value] if args.key?(:exact_match_metric_value)
850
856
  @pairwise_metric_result = args[:pairwise_metric_result] if args.key?(:pairwise_metric_result)
851
857
  @pointwise_metric_result = args[:pointwise_metric_result] if args.key?(:pointwise_metric_result)
@@ -1830,7 +1836,9 @@ module Google
1830
1836
  attr_accessor :flip_enabled
1831
1837
  alias_method :flip_enabled?, :flip_enabled
1832
1838
 
1833
- # Generation config.
1839
+ # Configuration for content generation. This message contains all the parameters
1840
+ # that control how the model generates content. It allows you to influence the
1841
+ # randomness, length, and structure of the output.
1834
1842
  # Corresponds to the JSON property `generationConfig`
1835
1843
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
1836
1844
  attr_accessor :generation_config
@@ -3204,20 +3212,21 @@ module Google
3204
3212
  end
3205
3213
  end
3206
3214
 
3207
- # Content blob.
3215
+ # A content blob. A Blob contains data of a specific media type. It is used to
3216
+ # represent images, audio, and video.
3208
3217
  class GoogleCloudAiplatformV1beta1Blob
3209
3218
  include Google::Apis::Core::Hashable
3210
3219
 
3211
- # Required. Raw bytes.
3220
+ # Required. The raw bytes of the data.
3212
3221
  # Corresponds to the JSON property `data`
3213
3222
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
3214
3223
  # @return [String]
3215
3224
  attr_accessor :data
3216
3225
 
3217
- # Optional. Display name of the blob. Used to provide a label or filename to
3218
- # distinguish blobs. This field is only returned in PromptMessage for prompt
3219
- # management. It is currently used in the Gemini GenerateContent calls only when
3220
- # server side tools (code_execution, google_search, and url_context) are enabled.
3226
+ # Optional. The display name of the blob. Used to provide a label or filename to
3227
+ # distinguish blobs. This field is only returned in `PromptMessage` for prompt
3228
+ # management. It is used in the Gemini calls only when server-side tools (`
3229
+ # code_execution`, `google_search`, and `url_context`) are enabled.
3221
3230
  # Corresponds to the JSON property `displayName`
3222
3231
  # @return [String]
3223
3232
  attr_accessor :display_name
@@ -3356,10 +3365,9 @@ module Google
3356
3365
  # @return [String]
3357
3366
  attr_accessor :name
3358
3367
 
3359
- # The base structured datatype containing multi-part content of a message. A `
3360
- # Content` includes a `role` field designating the producer of the `Content` and
3361
- # a `parts` field containing multi-part data that contains the content of the
3362
- # message turn.
3368
+ # The structured data content of a message. A Content message contains a `role`
3369
+ # field, which indicates the producer of the content, and a `parts` field, which
3370
+ # contains the multi-part data of the message.
3363
3371
  # Corresponds to the JSON property `systemInstruction`
3364
3372
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
3365
3373
  attr_accessor :system_instruction
@@ -3577,58 +3585,70 @@ module Google
3577
3585
  class GoogleCloudAiplatformV1beta1Candidate
3578
3586
  include Google::Apis::Core::Hashable
3579
3587
 
3580
- # Output only. Average log probability score of the candidate.
3588
+ # Output only. The average log probability of the tokens in this candidate. This
3589
+ # is a length-normalized score that can be used to compare the quality of
3590
+ # candidates of different lengths. A higher average log probability suggests a
3591
+ # more confident and coherent response.
3581
3592
  # Corresponds to the JSON property `avgLogprobs`
3582
3593
  # @return [Float]
3583
3594
  attr_accessor :avg_logprobs
3584
3595
 
3585
- # A collection of source attributions for a piece of content.
3596
+ # A collection of citations that apply to a piece of generated content.
3586
3597
  # Corresponds to the JSON property `citationMetadata`
3587
3598
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CitationMetadata]
3588
3599
  attr_accessor :citation_metadata
3589
3600
 
3590
- # The base structured datatype containing multi-part content of a message. A `
3591
- # Content` includes a `role` field designating the producer of the `Content` and
3592
- # a `parts` field containing multi-part data that contains the content of the
3593
- # message turn.
3601
+ # The structured data content of a message. A Content message contains a `role`
3602
+ # field, which indicates the producer of the content, and a `parts` field, which
3603
+ # contains the multi-part data of the message.
3594
3604
  # Corresponds to the JSON property `content`
3595
3605
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
3596
3606
  attr_accessor :content
3597
3607
 
3598
- # Output only. Describes the reason the mode stopped generating tokens in more
3599
- # detail. This is only filled when `finish_reason` is set.
3608
+ # Output only. Describes the reason the model stopped generating tokens in more
3609
+ # detail. This field is returned only when `finish_reason` is set.
3600
3610
  # Corresponds to the JSON property `finishMessage`
3601
3611
  # @return [String]
3602
3612
  attr_accessor :finish_message
3603
3613
 
3604
3614
  # Output only. The reason why the model stopped generating tokens. If empty, the
3605
- # model has not stopped generating the tokens.
3615
+ # model has not stopped generating.
3606
3616
  # Corresponds to the JSON property `finishReason`
3607
3617
  # @return [String]
3608
3618
  attr_accessor :finish_reason
3609
3619
 
3610
- # Metadata returned to client when grounding is enabled.
3620
+ # Information about the sources that support the content of a response. When
3621
+ # grounding is enabled, the model returns citations for claims in the response.
3622
+ # This object contains the retrieved sources.
3611
3623
  # Corresponds to the JSON property `groundingMetadata`
3612
3624
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata]
3613
3625
  attr_accessor :grounding_metadata
3614
3626
 
3615
- # Output only. Index of the candidate.
3627
+ # Output only. The 0-based index of this candidate in the list of generated
3628
+ # responses. This is useful for distinguishing between multiple candidates when `
3629
+ # candidate_count` > 1.
3616
3630
  # Corresponds to the JSON property `index`
3617
3631
  # @return [Fixnum]
3618
3632
  attr_accessor :index
3619
3633
 
3620
- # Logprobs Result
3634
+ # The log probabilities of the tokens generated by the model. This is useful for
3635
+ # understanding the model's confidence in its predictions and for debugging. For
3636
+ # example, you can use log probabilities to identify when the model is making a
3637
+ # less confident prediction or to explore alternative responses that the model
3638
+ # considered. A low log probability can also indicate that the model is "
3639
+ # hallucinating" or generating factually incorrect information.
3621
3640
  # Corresponds to the JSON property `logprobsResult`
3622
3641
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResult]
3623
3642
  attr_accessor :logprobs_result
3624
3643
 
3625
- # Output only. List of ratings for the safety of a response candidate. There is
3626
- # at most one rating per category.
3644
+ # Output only. A list of ratings for the safety of a response candidate. There
3645
+ # is at most one rating per category.
3627
3646
  # Corresponds to the JSON property `safetyRatings`
3628
3647
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetyRating>]
3629
3648
  attr_accessor :safety_ratings
3630
3649
 
3631
- # Metadata related to url context retrieval tool.
3650
+ # Metadata returned when the model uses the `url_context` tool to get
3651
+ # information from a user-provided URL.
3632
3652
  # Corresponds to the JSON property `urlContextMetadata`
3633
3653
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UrlContextMetadata]
3634
3654
  attr_accessor :url_context_metadata
@@ -3661,6 +3681,12 @@ module Google
3661
3681
  # @return [String]
3662
3682
  attr_accessor :candidate
3663
3683
 
3684
+ # Optional. Intermediate events (such as tool calls and responses) that led to
3685
+ # the final response.
3686
+ # Corresponds to the JSON property `events`
3687
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
3688
+ attr_accessor :events
3689
+
3664
3690
  # Text response.
3665
3691
  # Corresponds to the JSON property `text`
3666
3692
  # @return [String]
@@ -3678,6 +3704,7 @@ module Google
3678
3704
  # Update properties of this object
3679
3705
  def update!(**args)
3680
3706
  @candidate = args[:candidate] if args.key?(:candidate)
3707
+ @events = args[:events] if args.key?(:events)
3681
3708
  @text = args[:text] if args.key?(:text)
3682
3709
  @value = args[:value] if args.key?(:value)
3683
3710
  end
@@ -3884,16 +3911,16 @@ module Google
3884
3911
  end
3885
3912
  end
3886
3913
 
3887
- # Source attributions for content.
3914
+ # A citation for a piece of generatedcontent.
3888
3915
  class GoogleCloudAiplatformV1beta1Citation
3889
3916
  include Google::Apis::Core::Hashable
3890
3917
 
3891
- # Output only. End index into the content.
3918
+ # Output only. The end index of the citation in the content.
3892
3919
  # Corresponds to the JSON property `endIndex`
3893
3920
  # @return [Fixnum]
3894
3921
  attr_accessor :end_index
3895
3922
 
3896
- # Output only. License of the attribution.
3923
+ # Output only. The license of the source of the citation.
3897
3924
  # Corresponds to the JSON property `license`
3898
3925
  # @return [String]
3899
3926
  attr_accessor :license
@@ -3910,17 +3937,17 @@ module Google
3910
3937
  # @return [Google::Apis::AiplatformV1beta1::GoogleTypeDate]
3911
3938
  attr_accessor :publication_date
3912
3939
 
3913
- # Output only. Start index into the content.
3940
+ # Output only. The start index of the citation in the content.
3914
3941
  # Corresponds to the JSON property `startIndex`
3915
3942
  # @return [Fixnum]
3916
3943
  attr_accessor :start_index
3917
3944
 
3918
- # Output only. Title of the attribution.
3945
+ # Output only. The title of the source of the citation.
3919
3946
  # Corresponds to the JSON property `title`
3920
3947
  # @return [String]
3921
3948
  attr_accessor :title
3922
3949
 
3923
- # Output only. Url reference of the attribution.
3950
+ # Output only. The URI of the source of the citation.
3924
3951
  # Corresponds to the JSON property `uri`
3925
3952
  # @return [String]
3926
3953
  attr_accessor :uri
@@ -3940,11 +3967,11 @@ module Google
3940
3967
  end
3941
3968
  end
3942
3969
 
3943
- # A collection of source attributions for a piece of content.
3970
+ # A collection of citations that apply to a piece of generated content.
3944
3971
  class GoogleCloudAiplatformV1beta1CitationMetadata
3945
3972
  include Google::Apis::Core::Hashable
3946
3973
 
3947
- # Output only. List of citations.
3974
+ # Output only. A list of citations for the content.
3948
3975
  # Corresponds to the JSON property `citations`
3949
3976
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Citation>]
3950
3977
  attr_accessor :citations
@@ -4472,22 +4499,21 @@ module Google
4472
4499
  end
4473
4500
  end
4474
4501
 
4475
- # The base structured datatype containing multi-part content of a message. A `
4476
- # Content` includes a `role` field designating the producer of the `Content` and
4477
- # a `parts` field containing multi-part data that contains the content of the
4478
- # message turn.
4502
+ # The structured data content of a message. A Content message contains a `role`
4503
+ # field, which indicates the producer of the content, and a `parts` field, which
4504
+ # contains the multi-part data of the message.
4479
4505
  class GoogleCloudAiplatformV1beta1Content
4480
4506
  include Google::Apis::Core::Hashable
4481
4507
 
4482
- # Required. Ordered `Parts` that constitute a single message. Parts may have
4483
- # different IANA MIME types.
4508
+ # Required. A list of Part objects that make up a single message. Parts of a
4509
+ # message can have different MIME types. A Content message must have at least
4510
+ # one Part.
4484
4511
  # Corresponds to the JSON property `parts`
4485
4512
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Part>]
4486
4513
  attr_accessor :parts
4487
4514
 
4488
- # Optional. The producer of the content. Must be either 'user' or 'model'.
4489
- # Useful to set for multi-turn conversations, otherwise can be left blank or
4490
- # unset.
4515
+ # Optional. The producer of the content. Must be either 'user' or 'model'. If
4516
+ # not set, the service will default to 'user'.
4491
4517
  # Corresponds to the JSON property `role`
4492
4518
  # @return [String]
4493
4519
  attr_accessor :role
@@ -4573,10 +4599,9 @@ module Google
4573
4599
  class GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent
4574
4600
  include Google::Apis::Core::Hashable
4575
4601
 
4576
- # The base structured datatype containing multi-part content of a message. A `
4577
- # Content` includes a `role` field designating the producer of the `Content` and
4578
- # a `parts` field containing multi-part data that contains the content of the
4579
- # message turn.
4602
+ # The structured data content of a message. A Content message contains a `role`
4603
+ # field, which indicates the producer of the content, and a `parts` field, which
4604
+ # contains the multi-part data of the message.
4580
4605
  # Corresponds to the JSON property `content`
4581
4606
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4582
4607
  attr_accessor :content
@@ -4800,10 +4825,9 @@ module Google
4800
4825
  class GoogleCloudAiplatformV1beta1CorroborateContentRequest
4801
4826
  include Google::Apis::Core::Hashable
4802
4827
 
4803
- # The base structured datatype containing multi-part content of a message. A `
4804
- # Content` includes a `role` field designating the producer of the `Content` and
4805
- # a `parts` field containing multi-part data that contains the content of the
4806
- # message turn.
4828
+ # The structured data content of a message. A Content message contains a `role`
4829
+ # field, which indicates the producer of the content, and a `parts` field, which
4830
+ # contains the multi-part data of the message.
4807
4831
  # Corresponds to the JSON property `content`
4808
4832
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4809
4833
  attr_accessor :content
@@ -4886,7 +4910,9 @@ module Google
4886
4910
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
4887
4911
  attr_accessor :contents
4888
4912
 
4889
- # Generation config.
4913
+ # Configuration for content generation. This message contains all the parameters
4914
+ # that control how the model generates content. It allows you to influence the
4915
+ # randomness, length, and structure of the output.
4890
4916
  # Corresponds to the JSON property `generationConfig`
4891
4917
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
4892
4918
  attr_accessor :generation_config
@@ -4903,10 +4929,9 @@ module Google
4903
4929
  # @return [String]
4904
4930
  attr_accessor :model
4905
4931
 
4906
- # The base structured datatype containing multi-part content of a message. A `
4907
- # Content` includes a `role` field designating the producer of the `Content` and
4908
- # a `parts` field containing multi-part data that contains the content of the
4909
- # message turn.
4932
+ # The structured data content of a message. A Content message contains a `role`
4933
+ # field, which indicates the producer of the content, and a `parts` field, which
4934
+ # contains the multi-part data of the message.
4910
4935
  # Corresponds to the JSON property `systemInstruction`
4911
4936
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4912
4937
  attr_accessor :system_instruction
@@ -5691,6 +5716,56 @@ module Google
5691
5716
  end
5692
5717
  end
5693
5718
 
5719
+ # Result for custom code execution metric.
5720
+ class GoogleCloudAiplatformV1beta1CustomCodeExecutionResult
5721
+ include Google::Apis::Core::Hashable
5722
+
5723
+ # Output only. Custom code execution score.
5724
+ # Corresponds to the JSON property `score`
5725
+ # @return [Float]
5726
+ attr_accessor :score
5727
+
5728
+ def initialize(**args)
5729
+ update!(**args)
5730
+ end
5731
+
5732
+ # Update properties of this object
5733
+ def update!(**args)
5734
+ @score = args[:score] if args.key?(:score)
5735
+ end
5736
+ end
5737
+
5738
+ # Specificies a metric that is populated by evaluating user-defined Python code.
5739
+ class GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec
5740
+ include Google::Apis::Core::Hashable
5741
+
5742
+ # Required. Python function. Expected user to define the following function, e.g.
5743
+ # : def evaluate(instance: dict[str, Any]) -> float: Please include this
5744
+ # function signature in the code snippet. Instance is the evaluation instance,
5745
+ # any fields populated in the instance are available to the function as instance[
5746
+ # field_name]. Example: Example input: ``` instance= EvaluationInstance(
5747
+ # response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=
5748
+ # EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` `
5749
+ # 'response': `'text': 'The answer is 4.'`, 'reference': `'text': '4'` ` ```
5750
+ # Example python function: ``` def evaluate(instance: dict[str, Any]) -> float:
5751
+ # if instance'response' == instance'reference': return 1.0 return 0.0 ```
5752
+ # CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC)
5753
+ # and Tuning Evaluation. Each line in the input jsonl file will be converted to
5754
+ # dict[str, Any] and passed to the evaluation function.
5755
+ # Corresponds to the JSON property `evaluationFunction`
5756
+ # @return [String]
5757
+ attr_accessor :evaluation_function
5758
+
5759
+ def initialize(**args)
5760
+ update!(**args)
5761
+ end
5762
+
5763
+ # Update properties of this object
5764
+ def update!(**args)
5765
+ @evaluation_function = args[:evaluation_function] if args.key?(:evaluation_function)
5766
+ end
5767
+ end
5768
+
5694
5769
  # Represents a job that runs custom workloads such as a Docker container or a
5695
5770
  # Python package. A CustomJob can have multiple worker pools and each worker
5696
5771
  # pool can have its own machine and input spec. A CustomJob will be cleaned up
@@ -6756,7 +6831,7 @@ module Google
6756
6831
  class GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec
6757
6832
  include Google::Apis::Core::Hashable
6758
6833
 
6759
- # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5
6834
+ # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5
6760
6835
  # minutes) [MaxValue=28800] (8 hours)
6761
6836
  # Corresponds to the JSON property `idleScaledownPeriod`
6762
6837
  # @return [String]
@@ -8420,10 +8495,9 @@ module Google
8420
8495
  attr_accessor :auto_truncate
8421
8496
  alias_method :auto_truncate?, :auto_truncate
8422
8497
 
8423
- # The base structured datatype containing multi-part content of a message. A `
8424
- # Content` includes a `role` field designating the producer of the `Content` and
8425
- # a `parts` field containing multi-part data that contains the content of the
8426
- # message turn.
8498
+ # The structured data content of a message. A Content message contains a `role`
8499
+ # field, which indicates the producer of the content, and a `parts` field, which
8500
+ # contains the multi-part data of the message.
8427
8501
  # Corresponds to the JSON property `content`
8428
8502
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
8429
8503
  attr_accessor :content
@@ -9721,6 +9795,11 @@ module Google
9721
9795
  class GoogleCloudAiplatformV1beta1EvaluationInstance
9722
9796
  include Google::Apis::Core::Hashable
9723
9797
 
9798
+ # Contains data specific to agent evaluations.
9799
+ # Corresponds to the JSON property `agentData`
9800
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData]
9801
+ attr_accessor :agent_data
9802
+
9724
9803
  # Instance data specified as a map.
9725
9804
  # Corresponds to the JSON property `otherData`
9726
9805
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance]
@@ -9754,6 +9833,7 @@ module Google
9754
9833
 
9755
9834
  # Update properties of this object
9756
9835
  def update!(**args)
9836
+ @agent_data = args[:agent_data] if args.key?(:agent_data)
9757
9837
  @other_data = args[:other_data] if args.key?(:other_data)
9758
9838
  @prompt = args[:prompt] if args.key?(:prompt)
9759
9839
  @reference = args[:reference] if args.key?(:reference)
@@ -9762,6 +9842,144 @@ module Google
9762
9842
  end
9763
9843
  end
9764
9844
 
9845
+ # Configuration for an Agent.
9846
+ class GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig
9847
+ include Google::Apis::Core::Hashable
9848
+
9849
+ # Instance data used to populate placeholders in a metric prompt template.
9850
+ # Corresponds to the JSON property `developerInstruction`
9851
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData]
9852
+ attr_accessor :developer_instruction
9853
+
9854
+ # Represents a list of tools for an agent.
9855
+ # Corresponds to the JSON property `tools`
9856
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools]
9857
+ attr_accessor :tools
9858
+
9859
+ # A JSON string containing a list of tools available to an agent with info such
9860
+ # as name, description, parameters and required parameters.
9861
+ # Corresponds to the JSON property `toolsText`
9862
+ # @return [String]
9863
+ attr_accessor :tools_text
9864
+
9865
+ def initialize(**args)
9866
+ update!(**args)
9867
+ end
9868
+
9869
+ # Update properties of this object
9870
+ def update!(**args)
9871
+ @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction)
9872
+ @tools = args[:tools] if args.key?(:tools)
9873
+ @tools_text = args[:tools_text] if args.key?(:tools_text)
9874
+ end
9875
+ end
9876
+
9877
+ # Represents a list of tools for an agent.
9878
+ class GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools
9879
+ include Google::Apis::Core::Hashable
9880
+
9881
+ # Optional. List of tools: each tool can have multiple function declarations.
9882
+ # Corresponds to the JSON property `tool`
9883
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tool>]
9884
+ attr_accessor :tool
9885
+
9886
+ def initialize(**args)
9887
+ update!(**args)
9888
+ end
9889
+
9890
+ # Update properties of this object
9891
+ def update!(**args)
9892
+ @tool = args[:tool] if args.key?(:tool)
9893
+ end
9894
+ end
9895
+
9896
+ # Contains data specific to agent evaluations.
9897
+ class GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData
9898
+ include Google::Apis::Core::Hashable
9899
+
9900
+ # Configuration for an Agent.
9901
+ # Corresponds to the JSON property `agentConfig`
9902
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig]
9903
+ attr_accessor :agent_config
9904
+
9905
+ # Instance data used to populate placeholders in a metric prompt template.
9906
+ # Corresponds to the JSON property `developerInstruction`
9907
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData]
9908
+ attr_accessor :developer_instruction
9909
+
9910
+ # Represents a list of events for an agent.
9911
+ # Corresponds to the JSON property `events`
9912
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents]
9913
+ attr_accessor :events
9914
+
9915
+ # Represents a list of tools for an agent.
9916
+ # Corresponds to the JSON property `tools`
9917
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools]
9918
+ attr_accessor :tools
9919
+
9920
+ # A JSON string containing a list of tools available to an agent with info such
9921
+ # as name, description, parameters and required parameters. Example: [ ` "name":
9922
+ # "search_actors", "description": "Search for actors in a movie. Returns a list
9923
+ # of actors, their roles, their birthdate, and their place of birth.", "
9924
+ # parameters": [ ` "name": "movie_name", "description": "The name of the movie."
9925
+ # `, ` "name": "character_name", "description": "The name of the character." ` ],
9926
+ # "required": ["movie_name", "character_name"] ` ]
9927
+ # Corresponds to the JSON property `toolsText`
9928
+ # @return [String]
9929
+ attr_accessor :tools_text
9930
+
9931
+ def initialize(**args)
9932
+ update!(**args)
9933
+ end
9934
+
9935
+ # Update properties of this object
9936
+ def update!(**args)
9937
+ @agent_config = args[:agent_config] if args.key?(:agent_config)
9938
+ @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction)
9939
+ @events = args[:events] if args.key?(:events)
9940
+ @tools = args[:tools] if args.key?(:tools)
9941
+ @tools_text = args[:tools_text] if args.key?(:tools_text)
9942
+ end
9943
+ end
9944
+
9945
+ # Represents a list of events for an agent.
9946
+ class GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents
9947
+ include Google::Apis::Core::Hashable
9948
+
9949
+ # Optional. A list of events.
9950
+ # Corresponds to the JSON property `event`
9951
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
9952
+ attr_accessor :event
9953
+
9954
+ def initialize(**args)
9955
+ update!(**args)
9956
+ end
9957
+
9958
+ # Update properties of this object
9959
+ def update!(**args)
9960
+ @event = args[:event] if args.key?(:event)
9961
+ end
9962
+ end
9963
+
9964
+ # Represents a list of tools for an agent.
9965
+ class GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools
9966
+ include Google::Apis::Core::Hashable
9967
+
9968
+ # Optional. List of tools: each tool can have multiple function declarations.
9969
+ # Corresponds to the JSON property `tool`
9970
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tool>]
9971
+ attr_accessor :tool
9972
+
9973
+ def initialize(**args)
9974
+ update!(**args)
9975
+ end
9976
+
9977
+ # Update properties of this object
9978
+ def update!(**args)
9979
+ @tool = args[:tool] if args.key?(:tool)
9980
+ end
9981
+ end
9982
+
9765
9983
  # Instance data used to populate placeholders in a metric prompt template.
9766
9984
  class GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData
9767
9985
  include Google::Apis::Core::Hashable
@@ -10299,7 +10517,9 @@ module Google
10299
10517
  # @return [String]
10300
10518
  attr_accessor :autorater_model
10301
10519
 
10302
- # Generation config.
10520
+ # Configuration for content generation. This message contains all the parameters
10521
+ # that control how the model generates content. It allows you to influence the
10522
+ # randomness, length, and structure of the output.
10303
10523
  # Corresponds to the JSON property `generationConfig`
10304
10524
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
10305
10525
  attr_accessor :generation_config
@@ -10379,7 +10599,14 @@ module Google
10379
10599
  class GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig
10380
10600
  include Google::Apis::Core::Hashable
10381
10601
 
10382
- # Generation config.
10602
+ # Configuration that describes an agent.
10603
+ # Corresponds to the JSON property `agentConfig`
10604
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig]
10605
+ attr_accessor :agent_config
10606
+
10607
+ # Configuration for content generation. This message contains all the parameters
10608
+ # that control how the model generates content. It allows you to influence the
10609
+ # randomness, length, and structure of the output.
10383
10610
  # Corresponds to the JSON property `generationConfig`
10384
10611
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
10385
10612
  attr_accessor :generation_config
@@ -10398,11 +10625,39 @@ module Google
10398
10625
 
10399
10626
  # Update properties of this object
10400
10627
  def update!(**args)
10628
+ @agent_config = args[:agent_config] if args.key?(:agent_config)
10401
10629
  @generation_config = args[:generation_config] if args.key?(:generation_config)
10402
10630
  @model = args[:model] if args.key?(:model)
10403
10631
  end
10404
10632
  end
10405
10633
 
10634
+ # Configuration that describes an agent.
10635
+ class GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig
10636
+ include Google::Apis::Core::Hashable
10637
+
10638
+ # The structured data content of a message. A Content message contains a `role`
10639
+ # field, which indicates the producer of the content, and a `parts` field, which
10640
+ # contains the multi-part data of the message.
10641
+ # Corresponds to the JSON property `developerInstruction`
10642
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
10643
+ attr_accessor :developer_instruction
10644
+
10645
+ # Optional. The tools available to the agent.
10646
+ # Corresponds to the JSON property `tools`
10647
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tool>]
10648
+ attr_accessor :tools
10649
+
10650
+ def initialize(**args)
10651
+ update!(**args)
10652
+ end
10653
+
10654
+ # Update properties of this object
10655
+ def update!(**args)
10656
+ @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction)
10657
+ @tools = args[:tools] if args.key?(:tools)
10658
+ end
10659
+ end
10660
+
10406
10661
  # The metric used for evaluation runs.
10407
10662
  class GoogleCloudAiplatformV1beta1EvaluationRunMetric
10408
10663
  include Google::Apis::Core::Hashable
@@ -10417,6 +10672,11 @@ module Google
10417
10672
  # @return [String]
10418
10673
  attr_accessor :metric
10419
10674
 
10675
+ # The metric used for running evaluations.
10676
+ # Corresponds to the JSON property `metricConfig`
10677
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Metric]
10678
+ attr_accessor :metric_config
10679
+
10420
10680
  # Specification for a pre-defined metric.
10421
10681
  # Corresponds to the JSON property `predefinedMetricSpec`
10422
10682
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec]
@@ -10435,6 +10695,7 @@ module Google
10435
10695
  def update!(**args)
10436
10696
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
10437
10697
  @metric = args[:metric] if args.key?(:metric)
10698
+ @metric_config = args[:metric_config] if args.key?(:metric_config)
10438
10699
  @predefined_metric_spec = args[:predefined_metric_spec] if args.key?(:predefined_metric_spec)
10439
10700
  @rubric_based_metric_spec = args[:rubric_based_metric_spec] if args.key?(:rubric_based_metric_spec)
10440
10701
  end
@@ -10800,7 +11061,9 @@ module Google
10800
11061
  # @return [Hash<String,Object>]
10801
11062
  attr_accessor :custom_metadata
10802
11063
 
10803
- # Metadata returned to client when grounding is enabled.
11064
+ # Information about the sources that support the content of a response. When
11065
+ # grounding is enabled, the model returns citations for claims in the response.
11066
+ # This object contains the retrieved sources.
10804
11067
  # Corresponds to the JSON property `groundingMetadata`
10805
11068
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata]
10806
11069
  attr_accessor :grounding_metadata
@@ -11263,6 +11526,44 @@ module Google
11263
11526
  end
11264
11527
  end
11265
11528
 
11529
+ # Request message for SandboxEnvironmentExecutionService.ExecuteCode.
11530
+ class GoogleCloudAiplatformV1beta1ExecuteCodeRequest
11531
+ include Google::Apis::Core::Hashable
11532
+
11533
+ # Required. The inputs used for the stateless code execution.
11534
+ # Corresponds to the JSON property `inputs`
11535
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk>]
11536
+ attr_accessor :inputs
11537
+
11538
+ def initialize(**args)
11539
+ update!(**args)
11540
+ end
11541
+
11542
+ # Update properties of this object
11543
+ def update!(**args)
11544
+ @inputs = args[:inputs] if args.key?(:inputs)
11545
+ end
11546
+ end
11547
+
11548
+ # Response message for SandboxEnvironmentExecutionService.ExecuteCode.
11549
+ class GoogleCloudAiplatformV1beta1ExecuteCodeResponse
11550
+ include Google::Apis::Core::Hashable
11551
+
11552
+ # The outputs from the sandbox environment.
11553
+ # Corresponds to the JSON property `outputs`
11554
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk>]
11555
+ attr_accessor :outputs
11556
+
11557
+ def initialize(**args)
11558
+ update!(**args)
11559
+ end
11560
+
11561
+ # Update properties of this object
11562
+ def update!(**args)
11563
+ @outputs = args[:outputs] if args.key?(:outputs)
11564
+ end
11565
+ end
11566
+
11266
11567
  # Request message for ExtensionExecutionService.ExecuteExtension.
11267
11568
  class GoogleCloudAiplatformV1beta1ExecuteExtensionRequest
11268
11569
  include Google::Apis::Core::Hashable
@@ -15572,20 +15873,21 @@ module Google
15572
15873
  end
15573
15874
  end
15574
15875
 
15575
- # URI based data.
15876
+ # URI-based data. A FileData message contains a URI pointing to data of a
15877
+ # specific media type. It is used to represent images, audio, and video stored
15878
+ # in Google Cloud Storage.
15576
15879
  class GoogleCloudAiplatformV1beta1FileData
15577
15880
  include Google::Apis::Core::Hashable
15578
15881
 
15579
- # Optional. Display name of the file data. Used to provide a label or filename
15580
- # to distinguish file datas. This field is only returned in PromptMessage for
15581
- # prompt management. It is currently used in the Gemini GenerateContent calls
15582
- # only when server side tools (code_execution, google_search, and url_context)
15583
- # are enabled.
15882
+ # Optional. The display name of the file. Used to provide a label or filename to
15883
+ # distinguish files. This field is only returned in `PromptMessage` for prompt
15884
+ # management. It is used in the Gemini calls only when server side tools (`
15885
+ # code_execution`, `google_search`, and `url_context`) are enabled.
15584
15886
  # Corresponds to the JSON property `displayName`
15585
15887
  # @return [String]
15586
15888
  attr_accessor :display_name
15587
15889
 
15588
- # Required. URI.
15890
+ # Required. The URI of the file in Google Cloud Storage.
15589
15891
  # Corresponds to the JSON property `fileUri`
15590
15892
  # @return [String]
15591
15893
  attr_accessor :file_uri
@@ -16522,7 +16824,9 @@ module Google
16522
16824
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
16523
16825
  attr_accessor :contents
16524
16826
 
16525
- # Generation config.
16827
+ # Configuration for content generation. This message contains all the parameters
16828
+ # that control how the model generates content. It allows you to influence the
16829
+ # randomness, length, and structure of the output.
16526
16830
  # Corresponds to the JSON property `generationConfig`
16527
16831
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
16528
16832
  attr_accessor :generation_config
@@ -16550,10 +16854,9 @@ module Google
16550
16854
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
16551
16855
  attr_accessor :safety_settings
16552
16856
 
16553
- # The base structured datatype containing multi-part content of a message. A `
16554
- # Content` includes a `role` field designating the producer of the `Content` and
16555
- # a `parts` field containing multi-part data that contains the content of the
16556
- # message turn.
16857
+ # The structured data content of a message. A Content message contains a `role`
16858
+ # field, which indicates the producer of the content, and a `parts` field, which
16859
+ # contains the multi-part data of the message.
16557
16860
  # Corresponds to the JSON property `systemInstruction`
16558
16861
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
16559
16862
  attr_accessor :system_instruction
@@ -16618,10 +16921,9 @@ module Google
16618
16921
  class GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion
16619
16922
  include Google::Apis::Core::Hashable
16620
16923
 
16621
- # The base structured datatype containing multi-part content of a message. A `
16622
- # Content` includes a `role` field designating the producer of the `Content` and
16623
- # a `parts` field containing multi-part data that contains the content of the
16624
- # message turn.
16924
+ # The structured data content of a message. A Content message contains a `role`
16925
+ # field, which indicates the producer of the content, and a `parts` field, which
16926
+ # contains the multi-part data of the message.
16625
16927
  # Corresponds to the JSON property `completion`
16626
16928
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
16627
16929
  attr_accessor :completion
@@ -16814,7 +17116,9 @@ module Google
16814
17116
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
16815
17117
  attr_accessor :contents
16816
17118
 
16817
- # Generation config.
17119
+ # Configuration for content generation. This message contains all the parameters
17120
+ # that control how the model generates content. It allows you to influence the
17121
+ # randomness, length, and structure of the output.
16818
17122
  # Corresponds to the JSON property `generationConfig`
16819
17123
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
16820
17124
  attr_accessor :generation_config
@@ -16828,7 +17132,10 @@ module Google
16828
17132
  # @return [Hash<String,String>]
16829
17133
  attr_accessor :labels
16830
17134
 
16831
- # Configuration for Model Armor integrations of prompt and responses.
17135
+ # Configuration for Model Armor. Model Armor is a Google Cloud service that
17136
+ # provides safety and security filtering for prompts and responses. It helps
17137
+ # protect your AI applications from risks such as harmful content, sensitive
17138
+ # data leakage, and prompt injection attacks.
16832
17139
  # Corresponds to the JSON property `modelArmorConfig`
16833
17140
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelArmorConfig]
16834
17141
  attr_accessor :model_armor_config
@@ -16839,10 +17146,9 @@ module Google
16839
17146
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
16840
17147
  attr_accessor :safety_settings
16841
17148
 
16842
- # The base structured datatype containing multi-part content of a message. A `
16843
- # Content` includes a `role` field designating the producer of the `Content` and
16844
- # a `parts` field containing multi-part data that contains the content of the
16845
- # message turn.
17149
+ # The structured data content of a message. A Content message contains a `role`
17150
+ # field, which indicates the producer of the content, and a `parts` field, which
17151
+ # contains the multi-part data of the message.
16846
17152
  # Corresponds to the JSON property `systemInstruction`
16847
17153
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
16848
17154
  attr_accessor :system_instruction
@@ -17099,6 +17405,11 @@ module Google
17099
17405
  class GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest
17100
17406
  include Google::Apis::Core::Hashable
17101
17407
 
17408
+ # Configuration for an Agent.
17409
+ # Corresponds to the JSON property `agentConfig`
17410
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig]
17411
+ attr_accessor :agent_config
17412
+
17102
17413
  # Required. The prompt to generate rubrics from. For single-turn queries, this
17103
17414
  # is a single instance. For multi-turn queries, this is a repeated field that
17104
17415
  # contains conversation history + latest request.
@@ -17122,6 +17433,7 @@ module Google
17122
17433
 
17123
17434
  # Update properties of this object
17124
17435
  def update!(**args)
17436
+ @agent_config = args[:agent_config] if args.key?(:agent_config)
17125
17437
  @contents = args[:contents] if args.key?(:contents)
17126
17438
  @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
17127
17439
  @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
@@ -17251,10 +17563,9 @@ module Google
17251
17563
  class GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSourceEvent
17252
17564
  include Google::Apis::Core::Hashable
17253
17565
 
17254
- # The base structured datatype containing multi-part content of a message. A `
17255
- # Content` includes a `role` field designating the producer of the `Content` and
17256
- # a `parts` field containing multi-part data that contains the content of the
17257
- # message turn.
17566
+ # The structured data content of a message. A Content message contains a `role`
17567
+ # field, which indicates the producer of the content, and a `parts` field, which
17568
+ # contains the multi-part data of the message.
17258
17569
  # Corresponds to the JSON property `content`
17259
17570
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
17260
17571
  attr_accessor :content
@@ -17299,6 +17610,11 @@ module Google
17299
17610
  # @return [String]
17300
17611
  attr_accessor :fact
17301
17612
 
17613
+ # Optional. The topics that the consolidated memories should be associated with.
17614
+ # Corresponds to the JSON property `topics`
17615
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryTopicId>]
17616
+ attr_accessor :topics
17617
+
17302
17618
  def initialize(**args)
17303
17619
  update!(**args)
17304
17620
  end
@@ -17306,6 +17622,7 @@ module Google
17306
17622
  # Update properties of this object
17307
17623
  def update!(**args)
17308
17624
  @fact = args[:fact] if args.key?(:fact)
17625
+ @topics = args[:topics] if args.key?(:topics)
17309
17626
  end
17310
17627
  end
17311
17628
 
@@ -17473,50 +17790,72 @@ module Google
17473
17790
  end
17474
17791
  end
17475
17792
 
17476
- # Generation config.
17793
+ # Configuration for content generation. This message contains all the parameters
17794
+ # that control how the model generates content. It allows you to influence the
17795
+ # randomness, length, and structure of the output.
17477
17796
  class GoogleCloudAiplatformV1beta1GenerationConfig
17478
17797
  include Google::Apis::Core::Hashable
17479
17798
 
17480
- # Optional. If enabled, audio timestamp will be included in the request to the
17481
- # model.
17799
+ # Optional. If enabled, audio timestamps will be included in the request to the
17800
+ # model. This can be useful for synchronizing audio with other modalities in the
17801
+ # response.
17482
17802
  # Corresponds to the JSON property `audioTimestamp`
17483
17803
  # @return [Boolean]
17484
17804
  attr_accessor :audio_timestamp
17485
17805
  alias_method :audio_timestamp?, :audio_timestamp
17486
17806
 
17487
- # Optional. Number of candidates to generate.
17807
+ # Optional. The number of candidate responses to generate. A higher `
17808
+ # candidate_count` can provide more options to choose from, but it also consumes
17809
+ # more resources. This can be useful for generating a variety of responses and
17810
+ # selecting the best one.
17488
17811
  # Corresponds to the JSON property `candidateCount`
17489
17812
  # @return [Fixnum]
17490
17813
  attr_accessor :candidate_count
17491
17814
 
17492
17815
  # Optional. If enabled, the model will detect emotions and adapt its responses
17493
- # accordingly.
17816
+ # accordingly. For example, if the model detects that the user is frustrated, it
17817
+ # may provide a more empathetic response.
17494
17818
  # Corresponds to the JSON property `enableAffectiveDialog`
17495
17819
  # @return [Boolean]
17496
17820
  attr_accessor :enable_affective_dialog
17497
17821
  alias_method :enable_affective_dialog?, :enable_affective_dialog
17498
17822
 
17499
- # Optional. Frequency penalties.
17823
+ # Optional. Penalizes tokens based on their frequency in the generated text. A
17824
+ # positive value helps to reduce the repetition of words and phrases. Valid
17825
+ # values can range from [-2.0, 2.0].
17500
17826
  # Corresponds to the JSON property `frequencyPenalty`
17501
17827
  # @return [Float]
17502
17828
  attr_accessor :frequency_penalty
17503
17829
 
17504
- # Config for image generation features.
17830
+ # Configuration for image generation. This message allows you to control various
17831
+ # aspects of image generation, such as the output format, aspect ratio, and
17832
+ # whether the model can generate images of people.
17505
17833
  # Corresponds to the JSON property `imageConfig`
17506
17834
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImageConfig]
17507
17835
  attr_accessor :image_config
17508
17836
 
17509
- # Optional. Logit probabilities.
17837
+ # Optional. The number of top log probabilities to return for each token. This
17838
+ # can be used to see which other tokens were considered likely candidates for a
17839
+ # given position. A higher value will return more options, but it will also
17840
+ # increase the size of the response.
17510
17841
  # Corresponds to the JSON property `logprobs`
17511
17842
  # @return [Fixnum]
17512
17843
  attr_accessor :logprobs
17513
17844
 
17514
- # Optional. The maximum number of output tokens to generate per message.
17845
+ # Optional. The maximum number of tokens to generate in the response. A token is
17846
+ # approximately four characters. The default value varies by model. This
17847
+ # parameter can be used to control the length of the generated text and prevent
17848
+ # overly long responses.
17515
17849
  # Corresponds to the JSON property `maxOutputTokens`
17516
17850
  # @return [Fixnum]
17517
17851
  attr_accessor :max_output_tokens
17518
17852
 
17519
- # Optional. If specified, the media resolution specified will be used.
17853
+ # Optional. The token resolution at which input media content is sampled. This
17854
+ # is used to control the trade-off between the quality of the response and the
17855
+ # number of tokens used to represent the media. A higher resolution allows the
17856
+ # model to perceive more detail, which can lead to a more nuanced response, but
17857
+ # it will also use more tokens. This does not affect the image dimensions sent
17858
+ # to the model.
17520
17859
  # Corresponds to the JSON property `mediaResolution`
17521
17860
  # @return [String]
17522
17861
  attr_accessor :media_resolution
@@ -17526,44 +17865,41 @@ module Google
17526
17865
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigModelConfig]
17527
17866
  attr_accessor :model_config
17528
17867
 
17529
- # Optional. Positive penalties.
17868
+ # Optional. Penalizes tokens that have already appeared in the generated text. A
17869
+ # positive value encourages the model to generate more diverse and less
17870
+ # repetitive text. Valid values can range from [-2.0, 2.0].
17530
17871
  # Corresponds to the JSON property `presencePenalty`
17531
17872
  # @return [Float]
17532
17873
  attr_accessor :presence_penalty
17533
17874
 
17534
- # Optional. Output schema of the generated response. This is an alternative to `
17535
- # response_schema` that accepts [JSON Schema](https://json-schema.org/). If set,
17536
- # `response_schema` must be omitted, but `response_mime_type` is required. While
17537
- # the full JSON Schema may be sent, not all features are supported. Specifically,
17538
- # only the following properties are supported: - `$id` - `$defs` - `$ref` - `$
17539
- # anchor` - `type` - `format` - `title` - `description` - `enum` (for strings
17540
- # and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` -
17541
- # `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties`
17542
- # - `additionalProperties` - `required` The non-standard `propertyOrdering`
17543
- # property may also be set. Cyclic references are unrolled to a limited degree
17544
- # and, as such, may only be used within non-required properties. (Nullable
17545
- # properties are not sufficient.) If `$ref` is set on a sub-schema, no other
17546
- # properties, except for than those starting as a `$`, may be set.
17875
+ # Optional. When this field is set, response_schema must be omitted and
17876
+ # response_mime_type must be set to `application/json`.
17547
17877
  # Corresponds to the JSON property `responseJsonSchema`
17548
17878
  # @return [Object]
17549
17879
  attr_accessor :response_json_schema
17550
17880
 
17551
- # Optional. If true, export the logprobs results in response.
17881
+ # Optional. If set to true, the log probabilities of the output tokens are
17882
+ # returned. Log probabilities are the logarithm of the probability of a token
17883
+ # appearing in the output. A higher log probability means the token is more
17884
+ # likely to be generated. This can be useful for analyzing the model's
17885
+ # confidence in its own output and for debugging.
17552
17886
  # Corresponds to the JSON property `responseLogprobs`
17553
17887
  # @return [Boolean]
17554
17888
  attr_accessor :response_logprobs
17555
17889
  alias_method :response_logprobs?, :response_logprobs
17556
17890
 
17557
- # Optional. Output response mimetype of the generated candidate text. Supported
17558
- # mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON
17559
- # response in the candidates. The model needs to be prompted to output the
17891
+ # Optional. The IANA standard MIME type of the response. The model will generate
17892
+ # output that conforms to this MIME type. Supported values include 'text/plain' (
17893
+ # default) and 'application/json'. The model needs to be prompted to output the
17560
17894
  # appropriate response type, otherwise the behavior is undefined. This is a
17561
17895
  # preview feature.
17562
17896
  # Corresponds to the JSON property `responseMimeType`
17563
17897
  # @return [String]
17564
17898
  attr_accessor :response_mime_type
17565
17899
 
17566
- # Optional. The modalities of the response.
17900
+ # Optional. The modalities of the response. The model will generate a response
17901
+ # that includes all the specified modalities. For example, if this is set to `[
17902
+ # TEXT, IMAGE]`, the response will include both text and an image.
17567
17903
  # Corresponds to the JSON property `responseModalities`
17568
17904
  # @return [Array<String>]
17569
17905
  attr_accessor :response_modalities
@@ -17575,42 +17911,68 @@ module Google
17575
17911
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema]
17576
17912
  attr_accessor :response_schema
17577
17913
 
17578
- # The configuration for routing the request to a specific model.
17914
+ # The configuration for routing the request to a specific model. This can be
17915
+ # used to control which model is used for the generation, either automatically
17916
+ # or by specifying a model name.
17579
17917
  # Corresponds to the JSON property `routingConfig`
17580
17918
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig]
17581
17919
  attr_accessor :routing_config
17582
17920
 
17583
- # Optional. Seed.
17921
+ # Optional. A seed for the random number generator. By setting a seed, you can
17922
+ # make the model's output mostly deterministic. For a given prompt and
17923
+ # parameters (like temperature, top_p, etc.), the model will produce the same
17924
+ # response every time. However, it's not a guaranteed absolute deterministic
17925
+ # behavior. This is different from parameters like `temperature`, which control
17926
+ # the *level* of randomness. `seed` ensures that the "random" choices the model
17927
+ # makes are the same on every run, making it essential for testing and ensuring
17928
+ # reproducible results.
17584
17929
  # Corresponds to the JSON property `seed`
17585
17930
  # @return [Fixnum]
17586
17931
  attr_accessor :seed
17587
17932
 
17588
- # The speech generation config.
17933
+ # Configuration for speech generation.
17589
17934
  # Corresponds to the JSON property `speechConfig`
17590
17935
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpeechConfig]
17591
17936
  attr_accessor :speech_config
17592
17937
 
17593
- # Optional. Stop sequences.
17938
+ # Optional. A list of character sequences that will stop the model from
17939
+ # generating further tokens. If a stop sequence is generated, the output will
17940
+ # end at that point. This is useful for controlling the length and structure of
17941
+ # the output. For example, you can use ["\n", "###"] to stop generation at a new
17942
+ # line or a specific marker.
17594
17943
  # Corresponds to the JSON property `stopSequences`
17595
17944
  # @return [Array<String>]
17596
17945
  attr_accessor :stop_sequences
17597
17946
 
17598
- # Optional. Controls the randomness of predictions.
17947
+ # Optional. Controls the randomness of the output. A higher temperature results
17948
+ # in more creative and diverse responses, while a lower temperature makes the
17949
+ # output more predictable and focused. The valid range is (0.0, 2.0].
17599
17950
  # Corresponds to the JSON property `temperature`
17600
17951
  # @return [Float]
17601
17952
  attr_accessor :temperature
17602
17953
 
17603
- # Config for thinking features.
17954
+ # Configuration for the model's thinking features. "Thinking" is a process where
17955
+ # the model breaks down a complex task into smaller, manageable steps. This
17956
+ # allows the model to reason about the task, plan its approach, and execute the
17957
+ # plan to generate a high-quality response.
17604
17958
  # Corresponds to the JSON property `thinkingConfig`
17605
17959
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig]
17606
17960
  attr_accessor :thinking_config
17607
17961
 
17608
- # Optional. If specified, top-k sampling will be used.
17962
+ # Optional. Specifies the top-k sampling threshold. The model considers only the
17963
+ # top k most probable tokens for the next token. This can be useful for
17964
+ # generating more coherent and less random text. For example, a `top_k` of 40
17965
+ # means the model will choose the next word from the 40 most likely words.
17609
17966
  # Corresponds to the JSON property `topK`
17610
17967
  # @return [Float]
17611
17968
  attr_accessor :top_k
17612
17969
 
17613
- # Optional. If specified, nucleus sampling will be used.
17970
+ # Optional. Specifies the nucleus sampling threshold. The model considers only
17971
+ # the smallest set of tokens whose cumulative probability is at least `top_p`.
17972
+ # This helps generate more diverse and less repetitive responses. For example, a
17973
+ # `top_p` of 0.9 means the model considers tokens until the cumulative
17974
+ # probability of the tokens to select from reaches 0.9. It's recommended to
17975
+ # adjust either temperature or `top_p`, but not both.
17614
17976
  # Corresponds to the JSON property `topP`
17615
17977
  # @return [Float]
17616
17978
  attr_accessor :top_p
@@ -17666,17 +18028,21 @@ module Google
17666
18028
  end
17667
18029
  end
17668
18030
 
17669
- # The configuration for routing the request to a specific model.
18031
+ # The configuration for routing the request to a specific model. This can be
18032
+ # used to control which model is used for the generation, either automatically
18033
+ # or by specifying a model name.
17670
18034
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig
17671
18035
  include Google::Apis::Core::Hashable
17672
18036
 
17673
- # When automated routing is specified, the routing will be determined by the
17674
- # pretrained routing model and customer provided model routing preference.
18037
+ # The configuration for automated routing. When automated routing is specified,
18038
+ # the routing will be determined by the pretrained routing model and customer
18039
+ # provided model routing preference.
17675
18040
  # Corresponds to the JSON property `autoMode`
17676
18041
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode]
17677
18042
  attr_accessor :auto_mode
17678
18043
 
17679
- # When manual routing is set, the specified model will be used directly.
18044
+ # The configuration for manual routing. When manual routing is specified, the
18045
+ # model will be selected based on the model name provided.
17680
18046
  # Corresponds to the JSON property `manualMode`
17681
18047
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode]
17682
18048
  attr_accessor :manual_mode
@@ -17692,8 +18058,9 @@ module Google
17692
18058
  end
17693
18059
  end
17694
18060
 
17695
- # When automated routing is specified, the routing will be determined by the
17696
- # pretrained routing model and customer provided model routing preference.
18061
+ # The configuration for automated routing. When automated routing is specified,
18062
+ # the routing will be determined by the pretrained routing model and customer
18063
+ # provided model routing preference.
17697
18064
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode
17698
18065
  include Google::Apis::Core::Hashable
17699
18066
 
@@ -17712,13 +18079,12 @@ module Google
17712
18079
  end
17713
18080
  end
17714
18081
 
17715
- # When manual routing is set, the specified model will be used directly.
18082
+ # The configuration for manual routing. When manual routing is specified, the
18083
+ # model will be selected based on the model name provided.
17716
18084
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode
17717
18085
  include Google::Apis::Core::Hashable
17718
18086
 
17719
- # The model name to use. Only the public LLM models are accepted. See [Supported
17720
- # models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/
17721
- # inference#supported-models).
18087
+ # The name of the model to use. Only public LLM models are accepted.
17722
18088
  # Corresponds to the JSON property `modelName`
17723
18089
  # @return [String]
17724
18090
  attr_accessor :model_name
@@ -17733,18 +18099,26 @@ module Google
17733
18099
  end
17734
18100
  end
17735
18101
 
17736
- # Config for thinking features.
18102
+ # Configuration for the model's thinking features. "Thinking" is a process where
18103
+ # the model breaks down a complex task into smaller, manageable steps. This
18104
+ # allows the model to reason about the task, plan its approach, and execute the
18105
+ # plan to generate a high-quality response.
17737
18106
  class GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig
17738
18107
  include Google::Apis::Core::Hashable
17739
18108
 
17740
- # Optional. Indicates whether to include thoughts in the response. If true,
17741
- # thoughts are returned only when available.
18109
+ # Optional. If true, the model will include its thoughts in the response. "
18110
+ # Thoughts" are the intermediate steps the model takes to arrive at the final
18111
+ # response. They can provide insights into the model's reasoning process and
18112
+ # help with debugging. If this is true, thoughts are returned only when
18113
+ # available.
17742
18114
  # Corresponds to the JSON property `includeThoughts`
17743
18115
  # @return [Boolean]
17744
18116
  attr_accessor :include_thoughts
17745
18117
  alias_method :include_thoughts?, :include_thoughts
17746
18118
 
17747
- # Optional. Indicates the thinking budget in tokens.
18119
+ # Optional. The token budget for the model's thinking process. The model will
18120
+ # make a best effort to stay within this budget. This can be used to control the
18121
+ # trade-off between response quality and latency.
17748
18122
  # Corresponds to the JSON property `thinkingBudget`
17749
18123
  # @return [Fixnum]
17750
18124
  attr_accessor :thinking_budget
@@ -17998,21 +18372,30 @@ module Google
17998
18372
  end
17999
18373
  end
18000
18374
 
18001
- # Grounding chunk.
18375
+ # A piece of evidence that supports a claim made by the model. This is used to
18376
+ # show a citation for a claim made by the model. When grounding is enabled, the
18377
+ # model returns a `GroundingChunk` that contains a reference to the source of
18378
+ # the information.
18002
18379
  class GoogleCloudAiplatformV1beta1GroundingChunk
18003
18380
  include Google::Apis::Core::Hashable
18004
18381
 
18005
- # Chunk from Google Maps.
18382
+ # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
18383
+ # information about a place, such as its name, address, and reviews. This is
18384
+ # used to provide the user with rich, location-based information.
18006
18385
  # Corresponds to the JSON property `maps`
18007
18386
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMaps]
18008
18387
  attr_accessor :maps
18009
18388
 
18010
- # Chunk from context retrieved by the retrieval tools.
18389
+ # Context retrieved from a data source to ground the model's response. This is
18390
+ # used when a retrieval tool fetches information from a user-provided corpus or
18391
+ # a public dataset.
18011
18392
  # Corresponds to the JSON property `retrievedContext`
18012
18393
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext]
18013
18394
  attr_accessor :retrieved_context
18014
18395
 
18015
- # Chunk from the web.
18396
+ # A `Web` chunk is a piece of evidence that comes from a web page. It contains
18397
+ # the URI of the web page, the title of the page, and the domain of the page.
18398
+ # This is used to provide the user with a link to the source of the information.
18016
18399
  # Corresponds to the JSON property `web`
18017
18400
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkWeb]
18018
18401
  attr_accessor :web
@@ -18029,32 +18412,36 @@ module Google
18029
18412
  end
18030
18413
  end
18031
18414
 
18032
- # Chunk from Google Maps.
18415
+ # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
18416
+ # information about a place, such as its name, address, and reviews. This is
18417
+ # used to provide the user with rich, location-based information.
18033
18418
  class GoogleCloudAiplatformV1beta1GroundingChunkMaps
18034
18419
  include Google::Apis::Core::Hashable
18035
18420
 
18036
- # Sources used to generate the place answer.
18421
+ # The sources that were used to generate the place answer. This includes review
18422
+ # snippets and photos that were used to generate the answer, as well as URIs to
18423
+ # flag content.
18037
18424
  # Corresponds to the JSON property `placeAnswerSources`
18038
18425
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources]
18039
18426
  attr_accessor :place_answer_sources
18040
18427
 
18041
- # This Place's resource name, in `places/`place_id`` format. Can be used to look
18042
- # up the Place.
18428
+ # This Place's resource name, in `places/`place_id`` format. This can be used to
18429
+ # look up the place in the Google Maps API.
18043
18430
  # Corresponds to the JSON property `placeId`
18044
18431
  # @return [String]
18045
18432
  attr_accessor :place_id
18046
18433
 
18047
- # Text of the place answer.
18434
+ # The text of the place answer.
18048
18435
  # Corresponds to the JSON property `text`
18049
18436
  # @return [String]
18050
18437
  attr_accessor :text
18051
18438
 
18052
- # Title of the place.
18439
+ # The title of the place.
18053
18440
  # Corresponds to the JSON property `title`
18054
18441
  # @return [String]
18055
18442
  attr_accessor :title
18056
18443
 
18057
- # URI reference of the place.
18444
+ # The URI of the place.
18058
18445
  # Corresponds to the JSON property `uri`
18059
18446
  # @return [String]
18060
18447
  attr_accessor :uri
@@ -18073,11 +18460,13 @@ module Google
18073
18460
  end
18074
18461
  end
18075
18462
 
18076
- # Sources used to generate the place answer.
18463
+ # The sources that were used to generate the place answer. This includes review
18464
+ # snippets and photos that were used to generate the answer, as well as URIs to
18465
+ # flag content.
18077
18466
  class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources
18078
18467
  include Google::Apis::Core::Hashable
18079
18468
 
18080
- # Snippets of reviews that are used to generate the answer.
18469
+ # Snippets of reviews that were used to generate the answer.
18081
18470
  # Corresponds to the JSON property `reviewSnippets`
18082
18471
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet>]
18083
18472
  attr_accessor :review_snippets
@@ -18092,7 +18481,7 @@ module Google
18092
18481
  end
18093
18482
  end
18094
18483
 
18095
- # Encapsulates a review snippet.
18484
+ # A review snippet that is used to generate the answer.
18096
18485
  class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
18097
18486
  include Google::Apis::Core::Hashable
18098
18487
 
@@ -18101,12 +18490,12 @@ module Google
18101
18490
  # @return [String]
18102
18491
  attr_accessor :google_maps_uri
18103
18492
 
18104
- # Id of the review referencing the place.
18493
+ # The ID of the review that is being referenced.
18105
18494
  # Corresponds to the JSON property `reviewId`
18106
18495
  # @return [String]
18107
18496
  attr_accessor :review_id
18108
18497
 
18109
- # Title of the review.
18498
+ # The title of the review.
18110
18499
  # Corresponds to the JSON property `title`
18111
18500
  # @return [String]
18112
18501
  attr_accessor :title
@@ -18123,12 +18512,16 @@ module Google
18123
18512
  end
18124
18513
  end
18125
18514
 
18126
- # Chunk from context retrieved by the retrieval tools.
18515
+ # Context retrieved from a data source to ground the model's response. This is
18516
+ # used when a retrieval tool fetches information from a user-provided corpus or
18517
+ # a public dataset.
18127
18518
  class GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext
18128
18519
  include Google::Apis::Core::Hashable
18129
18520
 
18130
- # Output only. The full document name for the referenced Vertex AI Search
18131
- # document.
18521
+ # Output only. The full resource name of the referenced Vertex AI Search
18522
+ # document. This is used to identify the specific document that was retrieved.
18523
+ # The format is `projects/`project`/locations/`location`/collections/`collection`
18524
+ # /dataStores/`data_store`/branches/`branch`/documents/`document``.
18132
18525
  # Corresponds to the JSON property `documentName`
18133
18526
  # @return [String]
18134
18527
  attr_accessor :document_name
@@ -18139,17 +18532,17 @@ module Google
18139
18532
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagChunk]
18140
18533
  attr_accessor :rag_chunk
18141
18534
 
18142
- # Text of the attribution.
18535
+ # The content of the retrieved data source.
18143
18536
  # Corresponds to the JSON property `text`
18144
18537
  # @return [String]
18145
18538
  attr_accessor :text
18146
18539
 
18147
- # Title of the attribution.
18540
+ # The title of the retrieved data source.
18148
18541
  # Corresponds to the JSON property `title`
18149
18542
  # @return [String]
18150
18543
  attr_accessor :title
18151
18544
 
18152
- # URI reference of the attribution.
18545
+ # The URI of the retrieved data source.
18153
18546
  # Corresponds to the JSON property `uri`
18154
18547
  # @return [String]
18155
18548
  attr_accessor :uri
@@ -18168,21 +18561,24 @@ module Google
18168
18561
  end
18169
18562
  end
18170
18563
 
18171
- # Chunk from the web.
18564
+ # A `Web` chunk is a piece of evidence that comes from a web page. It contains
18565
+ # the URI of the web page, the title of the page, and the domain of the page.
18566
+ # This is used to provide the user with a link to the source of the information.
18172
18567
  class GoogleCloudAiplatformV1beta1GroundingChunkWeb
18173
18568
  include Google::Apis::Core::Hashable
18174
18569
 
18175
- # Domain of the (original) URI.
18570
+ # The domain of the web page that contains the evidence. This can be used to
18571
+ # filter out low-quality sources.
18176
18572
  # Corresponds to the JSON property `domain`
18177
18573
  # @return [String]
18178
18574
  attr_accessor :domain
18179
18575
 
18180
- # Title of the chunk.
18576
+ # The title of the web page that contains the evidence.
18181
18577
  # Corresponds to the JSON property `title`
18182
18578
  # @return [String]
18183
18579
  attr_accessor :title
18184
18580
 
18185
- # URI reference of the chunk.
18581
+ # The URI of the web page that contains the evidence.
18186
18582
  # Corresponds to the JSON property `uri`
18187
18583
  # @return [String]
18188
18584
  attr_accessor :uri
@@ -18199,49 +18595,63 @@ module Google
18199
18595
  end
18200
18596
  end
18201
18597
 
18202
- # Metadata returned to client when grounding is enabled.
18598
+ # Information about the sources that support the content of a response. When
18599
+ # grounding is enabled, the model returns citations for claims in the response.
18600
+ # This object contains the retrieved sources.
18203
18601
  class GoogleCloudAiplatformV1beta1GroundingMetadata
18204
18602
  include Google::Apis::Core::Hashable
18205
18603
 
18206
- # Optional. Output only. Resource name of the Google Maps widget context token
18207
- # to be used with the PlacesContextElement widget to render contextual data.
18208
- # This is populated only for Google Maps grounding.
18604
+ # Optional. Output only. A token that can be used to render a Google Maps widget
18605
+ # with the contextual data. This field is populated only when the grounding
18606
+ # source is Google Maps.
18209
18607
  # Corresponds to the JSON property `googleMapsWidgetContextToken`
18210
18608
  # @return [String]
18211
18609
  attr_accessor :google_maps_widget_context_token
18212
18610
 
18213
- # List of supporting references retrieved from specified grounding source.
18611
+ # A list of supporting references retrieved from the grounding source. This
18612
+ # field is populated when the grounding source is Google Search, Vertex AI
18613
+ # Search, or Google Maps.
18214
18614
  # Corresponds to the JSON property `groundingChunks`
18215
18615
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunk>]
18216
18616
  attr_accessor :grounding_chunks
18217
18617
 
18218
- # Optional. List of grounding support.
18618
+ # Optional. A list of grounding supports that connect the generated content to
18619
+ # the grounding chunks. This field is populated when the grounding source is
18620
+ # Google Search or Vertex AI Search.
18219
18621
  # Corresponds to the JSON property `groundingSupports`
18220
18622
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingSupport>]
18221
18623
  attr_accessor :grounding_supports
18222
18624
 
18223
- # Metadata related to retrieval in the grounding flow.
18625
+ # Metadata related to the retrieval grounding source. This is part of the `
18626
+ # GroundingMetadata` returned when grounding is enabled.
18224
18627
  # Corresponds to the JSON property `retrievalMetadata`
18225
18628
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrievalMetadata]
18226
18629
  attr_accessor :retrieval_metadata
18227
18630
 
18228
- # Optional. Queries executed by the retrieval tools.
18631
+ # Optional. The queries that were executed by the retrieval tools. This field is
18632
+ # populated only when the grounding source is a retrieval tool, such as Vertex
18633
+ # AI Search.
18229
18634
  # Corresponds to the JSON property `retrievalQueries`
18230
18635
  # @return [Array<String>]
18231
18636
  attr_accessor :retrieval_queries
18232
18637
 
18233
- # Google search entry point.
18638
+ # An entry point for displaying Google Search results. A `SearchEntryPoint` is
18639
+ # populated when the grounding source for a model's response is Google Search.
18640
+ # It provides information that you can use to display the search results in your
18641
+ # application.
18234
18642
  # Corresponds to the JSON property `searchEntryPoint`
18235
18643
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchEntryPoint]
18236
18644
  attr_accessor :search_entry_point
18237
18645
 
18238
- # Optional. Output only. List of source flagging uris. This is currently
18239
- # populated only for Google Maps grounding.
18646
+ # Optional. Output only. A list of URIs that can be used to flag a place or
18647
+ # review for inappropriate content. This field is populated only when the
18648
+ # grounding source is Google Maps.
18240
18649
  # Corresponds to the JSON property `sourceFlaggingUris`
18241
18650
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri>]
18242
18651
  attr_accessor :source_flagging_uris
18243
18652
 
18244
- # Optional. Web search queries for the following-up web search.
18653
+ # Optional. The web search queries that were used to generate the content. This
18654
+ # field is populated only when the grounding source is Google Search.
18245
18655
  # Corresponds to the JSON property `webSearchQueries`
18246
18656
  # @return [Array<String>]
18247
18657
  attr_accessor :web_search_queries
@@ -18263,17 +18673,17 @@ module Google
18263
18673
  end
18264
18674
  end
18265
18675
 
18266
- # Source content flagging uri for a place or review. This is currently populated
18267
- # only for Google Maps grounding.
18676
+ # A URI that can be used to flag a place or review for inappropriate content.
18677
+ # This is populated only when the grounding source is Google Maps.
18268
18678
  class GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri
18269
18679
  include Google::Apis::Core::Hashable
18270
18680
 
18271
- # A link where users can flag a problem with the source (place or review).
18681
+ # The URI that can be used to flag the content.
18272
18682
  # Corresponds to the JSON property `flagContentUri`
18273
18683
  # @return [String]
18274
18684
  attr_accessor :flag_content_uri
18275
18685
 
18276
- # Id of the place or review.
18686
+ # The ID of the place or review.
18277
18687
  # Corresponds to the JSON property `sourceId`
18278
18688
  # @return [String]
18279
18689
  attr_accessor :source_id
@@ -18289,27 +18699,30 @@ module Google
18289
18699
  end
18290
18700
  end
18291
18701
 
18292
- # Grounding support.
18702
+ # A collection of supporting references for a segment of the model's response.
18293
18703
  class GoogleCloudAiplatformV1beta1GroundingSupport
18294
18704
  include Google::Apis::Core::Hashable
18295
18705
 
18296
- # Confidence score of the support references. Ranges from 0 to 1. 1 is the most
18297
- # confident. For Gemini 2.0 and before, this list must have the same size as the
18298
- # grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and
18706
+ # The confidence scores for the support references. This list is parallel to the
18707
+ # `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a
18708
+ # higher score indicating a higher confidence that the reference supports the
18709
+ # claim. For Gemini 2.0 and before, this list has the same size as `
18710
+ # grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and
18299
18711
  # should be ignored.
18300
18712
  # Corresponds to the JSON property `confidenceScores`
18301
18713
  # @return [Array<Float>]
18302
18714
  attr_accessor :confidence_scores
18303
18715
 
18304
- # A list of indices (into 'grounding_chunk') specifying the citations associated
18305
- # with the claim. For instance [1,3,4] means that grounding_chunk[1],
18306
- # grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to
18307
- # the claim.
18716
+ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata`
18717
+ # message. These indices specify which grounding chunks support the claim made
18718
+ # in the content segment. For example, if this field has the values `[1, 3]`, it
18719
+ # means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for
18720
+ # the claim in the content segment.
18308
18721
  # Corresponds to the JSON property `groundingChunkIndices`
18309
18722
  # @return [Array<Fixnum>]
18310
18723
  attr_accessor :grounding_chunk_indices
18311
18724
 
18312
- # Segment of the content.
18725
+ # A segment of the content.
18313
18726
  # Corresponds to the JSON property `segment`
18314
18727
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Segment]
18315
18728
  attr_accessor :segment
@@ -18488,7 +18901,9 @@ module Google
18488
18901
  end
18489
18902
  end
18490
18903
 
18491
- # Config for image generation features.
18904
+ # Configuration for image generation. This message allows you to control various
18905
+ # aspects of image generation, such as the output format, aspect ratio, and
18906
+ # whether the model can generate images of people.
18492
18907
  class GoogleCloudAiplatformV1beta1ImageConfig
18493
18908
  include Google::Apis::Core::Hashable
18494
18909
 
@@ -18499,6 +18914,16 @@ module Google
18499
18914
  # @return [String]
18500
18915
  attr_accessor :aspect_ratio
18501
18916
 
18917
+ # The image output format for generated images.
18918
+ # Corresponds to the JSON property `imageOutputOptions`
18919
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions]
18920
+ attr_accessor :image_output_options
18921
+
18922
+ # Optional. Controls whether the model can generate people.
18923
+ # Corresponds to the JSON property `personGeneration`
18924
+ # @return [String]
18925
+ attr_accessor :person_generation
18926
+
18502
18927
  def initialize(**args)
18503
18928
  update!(**args)
18504
18929
  end
@@ -18506,6 +18931,33 @@ module Google
18506
18931
  # Update properties of this object
18507
18932
  def update!(**args)
18508
18933
  @aspect_ratio = args[:aspect_ratio] if args.key?(:aspect_ratio)
18934
+ @image_output_options = args[:image_output_options] if args.key?(:image_output_options)
18935
+ @person_generation = args[:person_generation] if args.key?(:person_generation)
18936
+ end
18937
+ end
18938
+
18939
+ # The image output format for generated images.
18940
+ class GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions
18941
+ include Google::Apis::Core::Hashable
18942
+
18943
+ # Optional. The compression quality of the output image.
18944
+ # Corresponds to the JSON property `compressionQuality`
18945
+ # @return [Fixnum]
18946
+ attr_accessor :compression_quality
18947
+
18948
+ # Optional. The image format that the output should be saved as.
18949
+ # Corresponds to the JSON property `mimeType`
18950
+ # @return [String]
18951
+ attr_accessor :mime_type
18952
+
18953
+ def initialize(**args)
18954
+ update!(**args)
18955
+ end
18956
+
18957
+ # Update properties of this object
18958
+ def update!(**args)
18959
+ @compression_quality = args[:compression_quality] if args.key?(:compression_quality)
18960
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
18509
18961
  end
18510
18962
  end
18511
18963
 
@@ -19907,6 +20359,25 @@ module Google
19907
20359
  end
19908
20360
  end
19909
20361
 
20362
+ # An extracted memory that is the intermediate result before consolidation.
20363
+ class GoogleCloudAiplatformV1beta1IntermediateExtractedMemory
20364
+ include Google::Apis::Core::Hashable
20365
+
20366
+ # Output only. The fact of the extracted memory.
20367
+ # Corresponds to the JSON property `fact`
20368
+ # @return [String]
20369
+ attr_accessor :fact
20370
+
20371
+ def initialize(**args)
20372
+ update!(**args)
20373
+ end
20374
+
20375
+ # Update properties of this object
20376
+ def update!(**args)
20377
+ @fact = args[:fact] if args.key?(:fact)
20378
+ end
20379
+ end
20380
+
19910
20381
  # Request message for [InternalOsServiceStateInstance].
19911
20382
  class GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance
19912
20383
  include Google::Apis::Core::Hashable
@@ -21924,17 +22395,24 @@ module Google
21924
22395
  end
21925
22396
  end
21926
22397
 
21927
- # Logprobs Result
22398
+ # The log probabilities of the tokens generated by the model. This is useful for
22399
+ # understanding the model's confidence in its predictions and for debugging. For
22400
+ # example, you can use log probabilities to identify when the model is making a
22401
+ # less confident prediction or to explore alternative responses that the model
22402
+ # considered. A low log probability can also indicate that the model is "
22403
+ # hallucinating" or generating factually incorrect information.
21928
22404
  class GoogleCloudAiplatformV1beta1LogprobsResult
21929
22405
  include Google::Apis::Core::Hashable
21930
22406
 
21931
- # Length = total number of decoding steps. The chosen candidates may or may not
21932
- # be in top_candidates.
22407
+ # A list of the chosen candidate tokens at each decoding step. The length of
22408
+ # this list is equal to the total number of decoding steps. Note that the chosen
22409
+ # candidate might not be in `top_candidates`.
21933
22410
  # Corresponds to the JSON property `chosenCandidates`
21934
22411
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
21935
22412
  attr_accessor :chosen_candidates
21936
22413
 
21937
- # Length = total number of decoding steps.
22414
+ # A list of the top candidate tokens at each decoding step. The length of this
22415
+ # list is equal to the total number of decoding steps.
21938
22416
  # Corresponds to the JSON property `topCandidates`
21939
22417
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates>]
21940
22418
  attr_accessor :top_candidates
@@ -21950,21 +22428,27 @@ module Google
21950
22428
  end
21951
22429
  end
21952
22430
 
21953
- # Candidate for the logprobs token and score.
22431
+ # A single token and its associated log probability.
21954
22432
  class GoogleCloudAiplatformV1beta1LogprobsResultCandidate
21955
22433
  include Google::Apis::Core::Hashable
21956
22434
 
21957
- # The candidate's log probability.
22435
+ # The log probability of this token. A higher value indicates that the model was
22436
+ # more confident in this token. The log probability can be used to assess the
22437
+ # relative likelihood of different tokens and to identify when the model is
22438
+ # uncertain.
21958
22439
  # Corresponds to the JSON property `logProbability`
21959
22440
  # @return [Float]
21960
22441
  attr_accessor :log_probability
21961
22442
 
21962
- # The candidate's token string value.
22443
+ # The token's string representation.
21963
22444
  # Corresponds to the JSON property `token`
21964
22445
  # @return [String]
21965
22446
  attr_accessor :token
21966
22447
 
21967
- # The candidate's token id value.
22448
+ # The token's numerical ID. While the `token` field provides the string
22449
+ # representation of the token, the `token_id` is the numerical representation
22450
+ # that the model uses internally. This can be useful for developers who want to
22451
+ # build custom logic based on the model's vocabulary.
21968
22452
  # Corresponds to the JSON property `tokenId`
21969
22453
  # @return [Fixnum]
21970
22454
  attr_accessor :token_id
@@ -21981,11 +22465,12 @@ module Google
21981
22465
  end
21982
22466
  end
21983
22467
 
21984
- # Candidates with top log probabilities at each decoding step.
22468
+ # A list of the top candidate tokens and their log probabilities at each
22469
+ # decoding step. This can be used to see what other tokens the model considered.
21985
22470
  class GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates
21986
22471
  include Google::Apis::Core::Hashable
21987
22472
 
21988
- # Sorted by log probability in descending order.
22473
+ # The list of candidate tokens, sorted by log probability in descending order.
21989
22474
  # Corresponds to the JSON property `candidates`
21990
22475
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
21991
22476
  attr_accessor :candidates
@@ -22265,6 +22750,12 @@ module Google
22265
22750
  # @return [String]
22266
22751
  attr_accessor :revision_expire_time
22267
22752
 
22753
+ # Optional. Input only. The labels to apply to the Memory Revision created as a
22754
+ # result of this request.
22755
+ # Corresponds to the JSON property `revisionLabels`
22756
+ # @return [Hash<String,String>]
22757
+ attr_accessor :revision_labels
22758
+
22268
22759
  # Optional. Input only. The TTL for the revision. The expiration time is
22269
22760
  # computed: now + TTL.
22270
22761
  # Corresponds to the JSON property `revisionTtl`
@@ -22278,6 +22769,11 @@ module Google
22278
22769
  # @return [Hash<String,String>]
22279
22770
  attr_accessor :scope
22280
22771
 
22772
+ # Optional. The Topics of the Memory.
22773
+ # Corresponds to the JSON property `topics`
22774
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryTopicId>]
22775
+ attr_accessor :topics
22776
+
22281
22777
  # Optional. Input only. The TTL for this resource. The expiration time is
22282
22778
  # computed: now + TTL.
22283
22779
  # Corresponds to the JSON property `ttl`
@@ -22303,8 +22799,10 @@ module Google
22303
22799
  @fact = args[:fact] if args.key?(:fact)
22304
22800
  @name = args[:name] if args.key?(:name)
22305
22801
  @revision_expire_time = args[:revision_expire_time] if args.key?(:revision_expire_time)
22802
+ @revision_labels = args[:revision_labels] if args.key?(:revision_labels)
22306
22803
  @revision_ttl = args[:revision_ttl] if args.key?(:revision_ttl)
22307
22804
  @scope = args[:scope] if args.key?(:scope)
22805
+ @topics = args[:topics] if args.key?(:topics)
22308
22806
  @ttl = args[:ttl] if args.key?(:ttl)
22309
22807
  @update_time = args[:update_time] if args.key?(:update_time)
22310
22808
  end
@@ -22399,10 +22897,9 @@ module Google
22399
22897
  class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent
22400
22898
  include Google::Apis::Core::Hashable
22401
22899
 
22402
- # The base structured datatype containing multi-part content of a message. A `
22403
- # Content` includes a `role` field designating the producer of the `Content` and
22404
- # a `parts` field containing multi-part data that contains the content of the
22405
- # message turn.
22900
+ # The structured data content of a message. A Content message contains a `role`
22901
+ # field, which indicates the producer of the content, and a `parts` field, which
22902
+ # contains the multi-part data of the message.
22406
22903
  # Corresponds to the JSON property `content`
22407
22904
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
22408
22905
  attr_accessor :content
@@ -22529,6 +23026,13 @@ module Google
22529
23026
  # @return [String]
22530
23027
  attr_accessor :expire_time
22531
23028
 
23029
+ # Output only. The extracted memories from the source content before
23030
+ # consolidation when the memory was updated via GenerateMemories. This
23031
+ # information was used to modify an existing Memory via Consolidation.
23032
+ # Corresponds to the JSON property `extractedMemories`
23033
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IntermediateExtractedMemory>]
23034
+ attr_accessor :extracted_memories
23035
+
22532
23036
  # Output only. The fact of the Memory Revision. This corresponds to the `fact`
22533
23037
  # field of the parent Memory at the time of revision creation.
22534
23038
  # Corresponds to the JSON property `fact`
@@ -22557,6 +23061,7 @@ module Google
22557
23061
  def update!(**args)
22558
23062
  @create_time = args[:create_time] if args.key?(:create_time)
22559
23063
  @expire_time = args[:expire_time] if args.key?(:expire_time)
23064
+ @extracted_memories = args[:extracted_memories] if args.key?(:extracted_memories)
22560
23065
  @fact = args[:fact] if args.key?(:fact)
22561
23066
  @labels = args[:labels] if args.key?(:labels)
22562
23067
  @name = args[:name] if args.key?(:name)
@@ -22803,6 +23308,11 @@ module Google
22803
23308
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuSpec]
22804
23309
  attr_accessor :bleu_spec
22805
23310
 
23311
+ # Specificies a metric that is populated by evaluating user-defined Python code.
23312
+ # Corresponds to the JSON property `customCodeExecutionSpec`
23313
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec]
23314
+ attr_accessor :custom_code_execution_spec
23315
+
22806
23316
  # Spec for exact match metric - returns 1 if prediction and reference exactly
22807
23317
  # matches, otherwise 0.
22808
23318
  # Corresponds to the JSON property `exactMatchSpec`
@@ -22843,6 +23353,7 @@ module Google
22843
23353
  def update!(**args)
22844
23354
  @aggregation_metrics = args[:aggregation_metrics] if args.key?(:aggregation_metrics)
22845
23355
  @bleu_spec = args[:bleu_spec] if args.key?(:bleu_spec)
23356
+ @custom_code_execution_spec = args[:custom_code_execution_spec] if args.key?(:custom_code_execution_spec)
22846
23357
  @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec)
22847
23358
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
22848
23359
  @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec)
@@ -23413,16 +23924,21 @@ module Google
23413
23924
  end
23414
23925
  end
23415
23926
 
23416
- # Represents token counting info for a single modality.
23927
+ # Represents a breakdown of token usage by modality. This message is used in
23928
+ # CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a
23929
+ # detailed view of how many tokens are used by each modality (e.g., text, image,
23930
+ # video) in a request. This is particularly useful for multimodal models,
23931
+ # allowing you to track and manage token consumption for billing and quota
23932
+ # purposes.
23417
23933
  class GoogleCloudAiplatformV1beta1ModalityTokenCount
23418
23934
  include Google::Apis::Core::Hashable
23419
23935
 
23420
- # The modality associated with this token count.
23936
+ # The modality that this token count applies to.
23421
23937
  # Corresponds to the JSON property `modality`
23422
23938
  # @return [String]
23423
23939
  attr_accessor :modality
23424
23940
 
23425
- # Number of tokens.
23941
+ # The number of tokens counted for this modality.
23426
23942
  # Corresponds to the JSON property `tokenCount`
23427
23943
  # @return [Fixnum]
23428
23944
  attr_accessor :token_count
@@ -23723,17 +24239,29 @@ module Google
23723
24239
  end
23724
24240
  end
23725
24241
 
23726
- # Configuration for Model Armor integrations of prompt and responses.
24242
+ # Configuration for Model Armor. Model Armor is a Google Cloud service that
24243
+ # provides safety and security filtering for prompts and responses. It helps
24244
+ # protect your AI applications from risks such as harmful content, sensitive
24245
+ # data leakage, and prompt injection attacks.
23727
24246
  class GoogleCloudAiplatformV1beta1ModelArmorConfig
23728
24247
  include Google::Apis::Core::Hashable
23729
24248
 
23730
- # Optional. The name of the Model Armor template to use for prompt sanitization.
24249
+ # Optional. The resource name of the Model Armor template to use for prompt
24250
+ # screening. A Model Armor template is a set of customized filters and
24251
+ # thresholds that define how Model Armor screens content. If specified, Model
24252
+ # Armor will use this template to check the user's prompt for safety and
24253
+ # security risks before it is sent to the model. The name must be in the format `
24254
+ # projects/`project`/locations/`location`/templates/`template``.
23731
24255
  # Corresponds to the JSON property `promptTemplateName`
23732
24256
  # @return [String]
23733
24257
  attr_accessor :prompt_template_name
23734
24258
 
23735
- # Optional. The name of the Model Armor template to use for response
23736
- # sanitization.
24259
+ # Optional. The resource name of the Model Armor template to use for response
24260
+ # screening. A Model Armor template is a set of customized filters and
24261
+ # thresholds that define how Model Armor screens content. If specified, Model
24262
+ # Armor will use this template to check the model's response for safety and
24263
+ # security risks before it is returned to the user. The name must be in the
24264
+ # format `projects/`project`/locations/`location`/templates/`template``.
23737
24265
  # Corresponds to the JSON property `responseTemplateName`
23738
24266
  # @return [String]
23739
24267
  attr_accessor :response_template_name
@@ -26474,8 +27002,7 @@ module Google
26474
27002
  end
26475
27003
  end
26476
27004
 
26477
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
26478
- # to two distinct voices in a single synthesis request.
27005
+ # Configuration for a multi-speaker text-to-speech request.
26479
27006
  class GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig
26480
27007
  include Google::Apis::Core::Hashable
26481
27008
 
@@ -28279,14 +28806,18 @@ module Google
28279
28806
  class GoogleCloudAiplatformV1beta1OptimizePromptRequest
28280
28807
  include Google::Apis::Core::Hashable
28281
28808
 
28282
- # The base structured datatype containing multi-part content of a message. A `
28283
- # Content` includes a `role` field designating the producer of the `Content` and
28284
- # a `parts` field containing multi-part data that contains the content of the
28285
- # message turn.
28809
+ # The structured data content of a message. A Content message contains a `role`
28810
+ # field, which indicates the producer of the content, and a `parts` field, which
28811
+ # contains the multi-part data of the message.
28286
28812
  # Corresponds to the JSON property `content`
28287
28813
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
28288
28814
  attr_accessor :content
28289
28815
 
28816
+ # Optional. The target model to optimize the prompt for.
28817
+ # Corresponds to the JSON property `optimizationTarget`
28818
+ # @return [String]
28819
+ attr_accessor :optimization_target
28820
+
28290
28821
  def initialize(**args)
28291
28822
  update!(**args)
28292
28823
  end
@@ -28294,6 +28825,7 @@ module Google
28294
28825
  # Update properties of this object
28295
28826
  def update!(**args)
28296
28827
  @content = args[:content] if args.key?(:content)
28828
+ @optimization_target = args[:optimization_target] if args.key?(:optimization_target)
28297
28829
  end
28298
28830
  end
28299
28831
 
@@ -28301,10 +28833,9 @@ module Google
28301
28833
  class GoogleCloudAiplatformV1beta1OptimizePromptResponse
28302
28834
  include Google::Apis::Core::Hashable
28303
28835
 
28304
- # The base structured datatype containing multi-part content of a message. A `
28305
- # Content` includes a `role` field designating the producer of the `Content` and
28306
- # a `parts` field containing multi-part data that contains the content of the
28307
- # message turn.
28836
+ # The structured data content of a message. A Content message contains a `role`
28837
+ # field, which indicates the producer of the content, and a `parts` field, which
28838
+ # contains the multi-part data of the message.
28308
28839
  # Corresponds to the JSON property `content`
28309
28840
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
28310
28841
  attr_accessor :content
@@ -28824,11 +29355,11 @@ module Google
28824
29355
  end
28825
29356
  end
28826
29357
 
28827
- # A datatype containing media that is part of a multi-part `Content` message. A `
29358
+ # A datatype containing media that is part of a multi-part Content message. A `
28828
29359
  # Part` consists of data which has an associated datatype. A `Part` can only
28829
- # contain one of the accepted types in `Part.data`. A `Part` must have a fixed
28830
- # IANA MIME type identifying the type and subtype of the media if `inline_data`
28831
- # or `file_data` field is filled with raw bytes.
29360
+ # contain one of the accepted types in `Part.data`. For media types that are not
29361
+ # text, `Part` must have a fixed IANA MIME type identifying the type and subtype
29362
+ # of the media if `inline_data` or `file_data` field is filled with raw bytes.
28832
29363
  class GoogleCloudAiplatformV1beta1Part
28833
29364
  include Google::Apis::Core::Hashable
28834
29365
 
@@ -28847,7 +29378,9 @@ module Google
28847
29378
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecutableCode]
28848
29379
  attr_accessor :executable_code
28849
29380
 
28850
- # URI based data.
29381
+ # URI-based data. A FileData message contains a URI pointing to data of a
29382
+ # specific media type. It is used to represent images, audio, and video stored
29383
+ # in Google Cloud Storage.
28851
29384
  # Corresponds to the JSON property `fileData`
28852
29385
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FileData]
28853
29386
  attr_accessor :file_data
@@ -28867,17 +29400,19 @@ module Google
28867
29400
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FunctionResponse]
28868
29401
  attr_accessor :function_response
28869
29402
 
28870
- # Content blob.
29403
+ # A content blob. A Blob contains data of a specific media type. It is used to
29404
+ # represent images, audio, and video.
28871
29405
  # Corresponds to the JSON property `inlineData`
28872
29406
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Blob]
28873
29407
  attr_accessor :inline_data
28874
29408
 
28875
- # Optional. Text part (can be code).
29409
+ # Optional. The text content of the part.
28876
29410
  # Corresponds to the JSON property `text`
28877
29411
  # @return [String]
28878
29412
  attr_accessor :text
28879
29413
 
28880
- # Optional. Indicates if the part is thought from the model.
29414
+ # Optional. Indicates whether the `part` represents the model's thought process
29415
+ # or reasoning.
28881
29416
  # Corresponds to the JSON property `thought`
28882
29417
  # @return [Boolean]
28883
29418
  attr_accessor :thought
@@ -28890,7 +29425,8 @@ module Google
28890
29425
  # @return [String]
28891
29426
  attr_accessor :thought_signature
28892
29427
 
28893
- # Metadata describes the input video content.
29428
+ # Provides metadata for a video, including the start and end offsets for
29429
+ # clipping and the frame rate.
28894
29430
  # Corresponds to the JSON property `videoMetadata`
28895
29431
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VideoMetadata]
28896
29432
  attr_accessor :video_metadata
@@ -30109,11 +30645,11 @@ module Google
30109
30645
  end
30110
30646
  end
30111
30647
 
30112
- # The configuration for the prebuilt speaker to use.
30648
+ # Configuration for a prebuilt voice.
30113
30649
  class GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig
30114
30650
  include Google::Apis::Core::Hashable
30115
30651
 
30116
- # The name of the preset voice to use.
30652
+ # The name of the prebuilt voice to use.
30117
30653
  # Corresponds to the JSON property `voiceName`
30118
30654
  # @return [String]
30119
30655
  attr_accessor :voice_name
@@ -30558,11 +31094,6 @@ module Google
30558
31094
  class GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec
30559
31095
  include Google::Apis::Core::Hashable
30560
31096
 
30561
- # Evaluation Config for Tuning Job.
30562
- # Corresponds to the JSON property `evaluationConfig`
30563
- # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationConfig]
30564
- attr_accessor :evaluation_config
30565
-
30566
31097
  # Optional. If set to true, disable intermediate checkpoints for Preference
30567
31098
  # Optimization and only the last checkpoint will be exported. Otherwise, enable
30568
31099
  # intermediate checkpoints for Preference Optimization. Default is false.
@@ -30594,7 +31125,6 @@ module Google
30594
31125
 
30595
31126
  # Update properties of this object
30596
31127
  def update!(**args)
30597
- @evaluation_config = args[:evaluation_config] if args.key?(:evaluation_config)
30598
31128
  @export_last_checkpoint_only = args[:export_last_checkpoint_only] if args.key?(:export_last_checkpoint_only)
30599
31129
  @hyper_parameters = args[:hyper_parameters] if args.key?(:hyper_parameters)
30600
31130
  @training_dataset_uri = args[:training_dataset_uri] if args.key?(:training_dataset_uri)
@@ -32702,6 +33232,18 @@ module Google
32702
33232
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig]
32703
33233
  attr_accessor :rag_vector_db_config
32704
33234
 
33235
+ # Output only. Reserved for future use.
33236
+ # Corresponds to the JSON property `satisfiesPzi`
33237
+ # @return [Boolean]
33238
+ attr_accessor :satisfies_pzi
33239
+ alias_method :satisfies_pzi?, :satisfies_pzi
33240
+
33241
+ # Output only. Reserved for future use.
33242
+ # Corresponds to the JSON property `satisfiesPzs`
33243
+ # @return [Boolean]
33244
+ attr_accessor :satisfies_pzs
33245
+ alias_method :satisfies_pzs?, :satisfies_pzs
33246
+
32705
33247
  # Output only. Timestamp when this RagCorpus was last updated.
32706
33248
  # Corresponds to the JSON property `updateTime`
32707
33249
  # @return [String]
@@ -32733,6 +33275,8 @@ module Google
32733
33275
  @rag_embedding_model_config = args[:rag_embedding_model_config] if args.key?(:rag_embedding_model_config)
32734
33276
  @rag_files_count = args[:rag_files_count] if args.key?(:rag_files_count)
32735
33277
  @rag_vector_db_config = args[:rag_vector_db_config] if args.key?(:rag_vector_db_config)
33278
+ @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
33279
+ @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
32736
33280
  @update_time = args[:update_time] if args.key?(:update_time)
32737
33281
  @vector_db_config = args[:vector_db_config] if args.key?(:vector_db_config)
32738
33282
  @vertex_ai_search_config = args[:vertex_ai_search_config] if args.key?(:vertex_ai_search_config)
@@ -34622,6 +35166,13 @@ module Google
34622
35166
  class GoogleCloudAiplatformV1beta1ReasoningEngineSpec
34623
35167
  include Google::Apis::Core::Hashable
34624
35168
 
35169
+ # Optional. The A2A Agent Card for the agent (if available). It follows the
35170
+ # specification at https://a2a-protocol.org/latest/specification/#5-agent-
35171
+ # discovery-the-agent-card.
35172
+ # Corresponds to the JSON property `agentCard`
35173
+ # @return [Hash<String,Object>]
35174
+ attr_accessor :agent_card
35175
+
34625
35176
  # Optional. The OSS agent framework used to develop the agent. Currently
34626
35177
  # supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index",
34627
35178
  # "custom".
@@ -34640,6 +35191,23 @@ module Google
34640
35191
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec]
34641
35192
  attr_accessor :deployment_spec
34642
35193
 
35194
+ # Output only. The identity to use for the Reasoning Engine. It can contain one
35195
+ # of the following values: * service-`project`@gcp-sa-aiplatform-re.googleapis.
35196
+ # com (for SERVICE_AGENT identity type) * `name`@`project`.gserviceaccount.com (
35197
+ # for SERVICE_ACCOUNT identity type) * agents.global.`org`.system.id.goog/
35198
+ # resources/aiplatform/projects/`project`/locations/`location`/reasoningEngines/`
35199
+ # reasoning_engine` (for AGENT_IDENTITY identity type)
35200
+ # Corresponds to the JSON property `effectiveIdentity`
35201
+ # @return [String]
35202
+ attr_accessor :effective_identity
35203
+
35204
+ # Optional. The identity type to use for the Reasoning Engine. If not specified,
35205
+ # the `service_account` field will be used if set, otherwise the default Vertex
35206
+ # AI Reasoning Engine Service Agent in the project will be used.
35207
+ # Corresponds to the JSON property `identityType`
35208
+ # @return [String]
35209
+ attr_accessor :identity_type
35210
+
34643
35211
  # User-provided package specification, containing pickled object and package
34644
35212
  # requirements.
34645
35213
  # Corresponds to the JSON property `packageSpec`
@@ -34655,17 +35223,26 @@ module Google
34655
35223
  # @return [String]
34656
35224
  attr_accessor :service_account
34657
35225
 
35226
+ # Specification for deploying from source code.
35227
+ # Corresponds to the JSON property `sourceCodeSpec`
35228
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec]
35229
+ attr_accessor :source_code_spec
35230
+
34658
35231
  def initialize(**args)
34659
35232
  update!(**args)
34660
35233
  end
34661
35234
 
34662
35235
  # Update properties of this object
34663
35236
  def update!(**args)
35237
+ @agent_card = args[:agent_card] if args.key?(:agent_card)
34664
35238
  @agent_framework = args[:agent_framework] if args.key?(:agent_framework)
34665
35239
  @class_methods = args[:class_methods] if args.key?(:class_methods)
34666
35240
  @deployment_spec = args[:deployment_spec] if args.key?(:deployment_spec)
35241
+ @effective_identity = args[:effective_identity] if args.key?(:effective_identity)
35242
+ @identity_type = args[:identity_type] if args.key?(:identity_type)
34667
35243
  @package_spec = args[:package_spec] if args.key?(:package_spec)
34668
35244
  @service_account = args[:service_account] if args.key?(:service_account)
35245
+ @source_code_spec = args[:source_code_spec] if args.key?(:source_code_spec)
34669
35246
  end
34670
35247
  end
34671
35248
 
@@ -34759,8 +35336,8 @@ module Google
34759
35336
  # @return [String]
34760
35337
  attr_accessor :pickle_object_gcs_uri
34761
35338
 
34762
- # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not
34763
- # specified, default value is 3.10.
35339
+ # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13.
35340
+ # If not specified, the default value is 3.10.
34764
35341
  # Corresponds to the JSON property `pythonVersion`
34765
35342
  # @return [String]
34766
35343
  attr_accessor :python_version
@@ -34783,6 +35360,95 @@ module Google
34783
35360
  end
34784
35361
  end
34785
35362
 
35363
+ # Specification for deploying from source code.
35364
+ class GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec
35365
+ include Google::Apis::Core::Hashable
35366
+
35367
+ # Specifies source code provided as a byte stream.
35368
+ # Corresponds to the JSON property `inlineSource`
35369
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource]
35370
+ attr_accessor :inline_source
35371
+
35372
+ # Specification for running a Python application from source.
35373
+ # Corresponds to the JSON property `pythonSpec`
35374
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec]
35375
+ attr_accessor :python_spec
35376
+
35377
+ def initialize(**args)
35378
+ update!(**args)
35379
+ end
35380
+
35381
+ # Update properties of this object
35382
+ def update!(**args)
35383
+ @inline_source = args[:inline_source] if args.key?(:inline_source)
35384
+ @python_spec = args[:python_spec] if args.key?(:python_spec)
35385
+ end
35386
+ end
35387
+
35388
+ # Specifies source code provided as a byte stream.
35389
+ class GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource
35390
+ include Google::Apis::Core::Hashable
35391
+
35392
+ # Required. Input only. The application source code archive, provided as a
35393
+ # compressed tarball (.tar.gz) file.
35394
+ # Corresponds to the JSON property `sourceArchive`
35395
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
35396
+ # @return [String]
35397
+ attr_accessor :source_archive
35398
+
35399
+ def initialize(**args)
35400
+ update!(**args)
35401
+ end
35402
+
35403
+ # Update properties of this object
35404
+ def update!(**args)
35405
+ @source_archive = args[:source_archive] if args.key?(:source_archive)
35406
+ end
35407
+ end
35408
+
35409
+ # Specification for running a Python application from source.
35410
+ class GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec
35411
+ include Google::Apis::Core::Hashable
35412
+
35413
+ # Optional. The Python module to load as the entrypoint, specified as a fully
35414
+ # qualified module name. For example: path.to.agent. If not specified, defaults
35415
+ # to "agent". The project root will be added to Python sys.path, allowing
35416
+ # imports to be specified relative to the root.
35417
+ # Corresponds to the JSON property `entrypointModule`
35418
+ # @return [String]
35419
+ attr_accessor :entrypoint_module
35420
+
35421
+ # Optional. The name of the callable object within the `entrypoint_module` to
35422
+ # use as the application If not specified, defaults to "root_agent".
35423
+ # Corresponds to the JSON property `entrypointObject`
35424
+ # @return [String]
35425
+ attr_accessor :entrypoint_object
35426
+
35427
+ # Optional. The path to the requirements file, relative to the source root. If
35428
+ # not specified, defaults to "requirements.txt".
35429
+ # Corresponds to the JSON property `requirementsFile`
35430
+ # @return [String]
35431
+ attr_accessor :requirements_file
35432
+
35433
+ # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.
35434
+ # 11, 3.12, 3.13. If not specified, default value is 3.10.
35435
+ # Corresponds to the JSON property `version`
35436
+ # @return [String]
35437
+ attr_accessor :version
35438
+
35439
+ def initialize(**args)
35440
+ update!(**args)
35441
+ end
35442
+
35443
+ # Update properties of this object
35444
+ def update!(**args)
35445
+ @entrypoint_module = args[:entrypoint_module] if args.key?(:entrypoint_module)
35446
+ @entrypoint_object = args[:entrypoint_object] if args.key?(:entrypoint_object)
35447
+ @requirements_file = args[:requirements_file] if args.key?(:requirements_file)
35448
+ @version = args[:version] if args.key?(:version)
35449
+ end
35450
+ end
35451
+
34786
35452
  # Request message for GenAiTuningService.RebaseTunedModel.
34787
35453
  class GoogleCloudAiplatformV1beta1RebaseTunedModelRequest
34788
35454
  include Google::Apis::Core::Hashable
@@ -35542,15 +36208,17 @@ module Google
35542
36208
  end
35543
36209
  end
35544
36210
 
35545
- # Metadata related to retrieval in the grounding flow.
36211
+ # Metadata related to the retrieval grounding source. This is part of the `
36212
+ # GroundingMetadata` returned when grounding is enabled.
35546
36213
  class GoogleCloudAiplatformV1beta1RetrievalMetadata
35547
36214
  include Google::Apis::Core::Hashable
35548
36215
 
35549
- # Optional. Score indicating how likely information from Google Search could
35550
- # help answer the prompt. The score is in the range `[0, 1]`, where 0 is the
35551
- # least likely and 1 is the most likely. This score is only populated when
35552
- # Google Search grounding and dynamic retrieval is enabled. It will be compared
35553
- # to the threshold to determine whether to trigger Google Search.
36216
+ # Optional. A score indicating how likely it is that a Google Search query could
36217
+ # help answer the prompt. The score is in the range of `[0, 1]`. A score of 1
36218
+ # means the model is confident that a search will be helpful, and 0 means it is
36219
+ # not. This score is populated only when Google Search grounding and dynamic
36220
+ # retrieval are enabled. The score is used to determine whether to trigger a
36221
+ # search.
35554
36222
  # Corresponds to the JSON property `googleSearchDynamicRetrievalScore`
35555
36223
  # @return [Float]
35556
36224
  attr_accessor :google_search_dynamic_retrieval_score
@@ -35673,6 +36341,13 @@ module Google
35673
36341
  class GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest
35674
36342
  include Google::Apis::Core::Hashable
35675
36343
 
36344
+ # Optional. The standard list filter that will be applied to the retrieved
36345
+ # memories. More detail in [AIP-160](https://google.aip.dev/160). Supported
36346
+ # fields: * `fact` * `create_time` * `update_time`
36347
+ # Corresponds to the JSON property `filter`
36348
+ # @return [String]
36349
+ attr_accessor :filter
36350
+
35676
36351
  # Required. The scope of the memories to retrieve. A memory must have exactly
35677
36352
  # the same scope (`Memory.scope`) as the scope provided here to be retrieved (
35678
36353
  # same keys and values). Order does not matter, but it is case-sensitive.
@@ -35696,6 +36371,7 @@ module Google
35696
36371
 
35697
36372
  # Update properties of this object
35698
36373
  def update!(**args)
36374
+ @filter = args[:filter] if args.key?(:filter)
35699
36375
  @scope = args[:scope] if args.key?(:scope)
35700
36376
  @similarity_search_params = args[:similarity_search_params] if args.key?(:similarity_search_params)
35701
36377
  @simple_retrieval_params = args[:simple_retrieval_params] if args.key?(:simple_retrieval_params)
@@ -36507,18 +37183,18 @@ module Google
36507
37183
  end
36508
37184
  end
36509
37185
 
36510
- # Safety rating corresponding to the generated content.
37186
+ # A safety rating for a piece of content. The safety rating contains the harm
37187
+ # category and the harm probability level.
36511
37188
  class GoogleCloudAiplatformV1beta1SafetyRating
36512
37189
  include Google::Apis::Core::Hashable
36513
37190
 
36514
- # Output only. Indicates whether the content was filtered out because of this
36515
- # rating.
37191
+ # Output only. Indicates whether the content was blocked because of this rating.
36516
37192
  # Corresponds to the JSON property `blocked`
36517
37193
  # @return [Boolean]
36518
37194
  attr_accessor :blocked
36519
37195
  alias_method :blocked?, :blocked
36520
37196
 
36521
- # Output only. Harm category.
37197
+ # Output only. The harm category of this rating.
36522
37198
  # Corresponds to the JSON property `category`
36523
37199
  # @return [String]
36524
37200
  attr_accessor :category
@@ -36530,22 +37206,22 @@ module Google
36530
37206
  # @return [String]
36531
37207
  attr_accessor :overwritten_threshold
36532
37208
 
36533
- # Output only. Harm probability levels in the content.
37209
+ # Output only. The probability of harm for this category.
36534
37210
  # Corresponds to the JSON property `probability`
36535
37211
  # @return [String]
36536
37212
  attr_accessor :probability
36537
37213
 
36538
- # Output only. Harm probability score.
37214
+ # Output only. The probability score of harm for this category.
36539
37215
  # Corresponds to the JSON property `probabilityScore`
36540
37216
  # @return [Float]
36541
37217
  attr_accessor :probability_score
36542
37218
 
36543
- # Output only. Harm severity levels in the content.
37219
+ # Output only. The severity of harm for this category.
36544
37220
  # Corresponds to the JSON property `severity`
36545
37221
  # @return [String]
36546
37222
  attr_accessor :severity
36547
37223
 
36548
- # Output only. Harm severity score.
37224
+ # Output only. The severity score of harm for this category.
36549
37225
  # Corresponds to the JSON property `severityScore`
36550
37226
  # @return [Float]
36551
37227
  attr_accessor :severity_score
@@ -36597,22 +37273,24 @@ module Google
36597
37273
  end
36598
37274
  end
36599
37275
 
36600
- # Safety settings.
37276
+ # A safety setting that affects the safety-blocking behavior. A SafetySetting
37277
+ # consists of a harm category and a threshold for that category.
36601
37278
  class GoogleCloudAiplatformV1beta1SafetySetting
36602
37279
  include Google::Apis::Core::Hashable
36603
37280
 
36604
- # Required. Harm category.
37281
+ # Required. The harm category to be blocked.
36605
37282
  # Corresponds to the JSON property `category`
36606
37283
  # @return [String]
36607
37284
  attr_accessor :category
36608
37285
 
36609
- # Optional. Specify if the threshold is used for probability or severity score.
36610
- # If not specified, the threshold is used for probability score.
37286
+ # Optional. The method for blocking content. If not specified, the default
37287
+ # behavior is to use the probability score.
36611
37288
  # Corresponds to the JSON property `method`
36612
37289
  # @return [String]
36613
37290
  attr_accessor :method_prop
36614
37291
 
36615
- # Required. The harm block threshold.
37292
+ # Required. The threshold for blocking content. If the harm probability exceeds
37293
+ # this threshold, the content will be blocked.
36616
37294
  # Corresponds to the JSON property `threshold`
36617
37295
  # @return [String]
36618
37296
  attr_accessor :threshold
@@ -40237,7 +40915,9 @@ module Google
40237
40915
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
40238
40916
  attr_accessor :contents
40239
40917
 
40240
- # Generation config.
40918
+ # Configuration for content generation. This message contains all the parameters
40919
+ # that control how the model generates content. It allows you to influence the
40920
+ # randomness, length, and structure of the output.
40241
40921
  # Corresponds to the JSON property `generationConfig`
40242
40922
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
40243
40923
  attr_accessor :generation_config
@@ -40253,10 +40933,9 @@ module Google
40253
40933
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
40254
40934
  attr_accessor :safety_settings
40255
40935
 
40256
- # The base structured datatype containing multi-part content of a message. A `
40257
- # Content` includes a `role` field designating the producer of the `Content` and
40258
- # a `parts` field containing multi-part data that contains the content of the
40259
- # message turn.
40936
+ # The structured data content of a message. A Content message contains a `role`
40937
+ # field, which indicates the producer of the content, and a `parts` field, which
40938
+ # contains the multi-part data of the message.
40260
40939
  # Corresponds to the JSON property `systemInstruction`
40261
40940
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
40262
40941
  attr_accessor :system_instruction
@@ -40338,10 +41017,9 @@ module Google
40338
41017
  class GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt
40339
41018
  include Google::Apis::Core::Hashable
40340
41019
 
40341
- # The base structured datatype containing multi-part content of a message. A `
40342
- # Content` includes a `role` field designating the producer of the `Content` and
40343
- # a `parts` field containing multi-part data that contains the content of the
40344
- # message turn.
41020
+ # The structured data content of a message. A Content message contains a `role`
41021
+ # field, which indicates the producer of the content, and a `parts` field, which
41022
+ # contains the multi-part data of the message.
40345
41023
  # Corresponds to the JSON property `context`
40346
41024
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
40347
41025
  attr_accessor :context
@@ -44111,17 +44789,23 @@ module Google
44111
44789
  end
44112
44790
  end
44113
44791
 
44114
- # Google search entry point.
44792
+ # An entry point for displaying Google Search results. A `SearchEntryPoint` is
44793
+ # populated when the grounding source for a model's response is Google Search.
44794
+ # It provides information that you can use to display the search results in your
44795
+ # application.
44115
44796
  class GoogleCloudAiplatformV1beta1SearchEntryPoint
44116
44797
  include Google::Apis::Core::Hashable
44117
44798
 
44118
- # Optional. Web content snippet that can be embedded in a web page or an app
44119
- # webview.
44799
+ # Optional. An HTML snippet that can be embedded in a web page or an application'
44800
+ # s webview. This snippet displays a search result, including the title, URL,
44801
+ # and a brief description of the search result.
44120
44802
  # Corresponds to the JSON property `renderedContent`
44121
44803
  # @return [String]
44122
44804
  attr_accessor :rendered_content
44123
44805
 
44124
- # Optional. Base64 encoded JSON representing array of tuple.
44806
+ # Optional. A base64-encoded JSON object that contains a list of search queries
44807
+ # and their corresponding search URLs. This information can be used to build a
44808
+ # custom search UI.
44125
44809
  # Corresponds to the JSON property `sdkBlob`
44126
44810
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
44127
44811
  # @return [String]
@@ -44740,28 +45424,31 @@ module Google
44740
45424
  end
44741
45425
  end
44742
45426
 
44743
- # Segment of the content.
45427
+ # A segment of the content.
44744
45428
  class GoogleCloudAiplatformV1beta1Segment
44745
45429
  include Google::Apis::Core::Hashable
44746
45430
 
44747
- # Output only. End index in the given Part, measured in bytes. Offset from the
44748
- # start of the Part, exclusive, starting at zero.
45431
+ # Output only. The end index of the segment in the `Part`, measured in bytes.
45432
+ # This marks the end of the segment and is exclusive, meaning the segment
45433
+ # includes content up to, but not including, the byte at this index.
44749
45434
  # Corresponds to the JSON property `endIndex`
44750
45435
  # @return [Fixnum]
44751
45436
  attr_accessor :end_index
44752
45437
 
44753
- # Output only. The index of a Part object within its parent Content object.
45438
+ # Output only. The index of the `Part` object that this segment belongs to. This
45439
+ # is useful for associating the segment with a specific part of the content.
44754
45440
  # Corresponds to the JSON property `partIndex`
44755
45441
  # @return [Fixnum]
44756
45442
  attr_accessor :part_index
44757
45443
 
44758
- # Output only. Start index in the given Part, measured in bytes. Offset from the
44759
- # start of the Part, inclusive, starting at zero.
45444
+ # Output only. The start index of the segment in the `Part`, measured in bytes.
45445
+ # This marks the beginning of the segment and is inclusive, meaning the byte at
45446
+ # this index is the first byte of the segment.
44760
45447
  # Corresponds to the JSON property `startIndex`
44761
45448
  # @return [Fixnum]
44762
45449
  attr_accessor :start_index
44763
45450
 
44764
- # Output only. The text corresponding to the segment from the response.
45451
+ # Output only. The text of the segment.
44765
45452
  # Corresponds to the JSON property `text`
44766
45453
  # @return [String]
44767
45454
  attr_accessor :text
@@ -44834,6 +45521,15 @@ module Google
44834
45521
  # @return [String]
44835
45522
  attr_accessor :expire_time
44836
45523
 
45524
+ # The labels with user-defined metadata to organize your Sessions. Label keys
45525
+ # and values can be no longer than 64 characters (Unicode codepoints), can only
45526
+ # contain lowercase letters, numeric characters, underscores and dashes.
45527
+ # International characters are allowed. See https://goo.gl/xmQnxf for more
45528
+ # information and examples of labels.
45529
+ # Corresponds to the JSON property `labels`
45530
+ # @return [Hash<String,String>]
45531
+ attr_accessor :labels
45532
+
44837
45533
  # Identifier. The resource name of the session. Format: 'projects/`project`/
44838
45534
  # locations/`location`/reasoningEngines/`reasoning_engine`/sessions/`session`'.
44839
45535
  # Corresponds to the JSON property `name`
@@ -44869,6 +45565,7 @@ module Google
44869
45565
  @create_time = args[:create_time] if args.key?(:create_time)
44870
45566
  @display_name = args[:display_name] if args.key?(:display_name)
44871
45567
  @expire_time = args[:expire_time] if args.key?(:expire_time)
45568
+ @labels = args[:labels] if args.key?(:labels)
44872
45569
  @name = args[:name] if args.key?(:name)
44873
45570
  @session_state = args[:session_state] if args.key?(:session_state)
44874
45571
  @ttl = args[:ttl] if args.key?(:ttl)
@@ -44891,10 +45588,9 @@ module Google
44891
45588
  # @return [String]
44892
45589
  attr_accessor :author
44893
45590
 
44894
- # The base structured datatype containing multi-part content of a message. A `
44895
- # Content` includes a `role` field designating the producer of the `Content` and
44896
- # a `parts` field containing multi-part data that contains the content of the
44897
- # message turn.
45591
+ # The structured data content of a message. A Content message contains a `role`
45592
+ # field, which indicates the producer of the content, and a `parts` field, which
45593
+ # contains the multi-part data of the message.
44898
45594
  # Corresponds to the JSON property `content`
44899
45595
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
44900
45596
  attr_accessor :content
@@ -45206,7 +45902,7 @@ module Google
45206
45902
  end
45207
45903
  end
45208
45904
 
45209
- # Configuration for a single speaker in a multi speaker setup.
45905
+ # Configuration for a single speaker in a multi-speaker setup.
45210
45906
  class GoogleCloudAiplatformV1beta1SpeakerVoiceConfig
45211
45907
  include Google::Apis::Core::Hashable
45212
45908
 
@@ -45216,7 +45912,7 @@ module Google
45216
45912
  # @return [String]
45217
45913
  attr_accessor :speaker
45218
45914
 
45219
- # The configuration for the voice to use.
45915
+ # Configuration for a voice.
45220
45916
  # Corresponds to the JSON property `voiceConfig`
45221
45917
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VoiceConfig]
45222
45918
  attr_accessor :voice_config
@@ -45363,22 +46059,21 @@ module Google
45363
46059
  end
45364
46060
  end
45365
46061
 
45366
- # The speech generation config.
46062
+ # Configuration for speech generation.
45367
46063
  class GoogleCloudAiplatformV1beta1SpeechConfig
45368
46064
  include Google::Apis::Core::Hashable
45369
46065
 
45370
- # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
46066
+ # Optional. The language code (ISO 639-1) for the speech synthesis.
45371
46067
  # Corresponds to the JSON property `languageCode`
45372
46068
  # @return [String]
45373
46069
  attr_accessor :language_code
45374
46070
 
45375
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
45376
- # to two distinct voices in a single synthesis request.
46071
+ # Configuration for a multi-speaker text-to-speech request.
45377
46072
  # Corresponds to the JSON property `multiSpeakerVoiceConfig`
45378
46073
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig]
45379
46074
  attr_accessor :multi_speaker_voice_config
45380
46075
 
45381
- # The configuration for the voice to use.
46076
+ # Configuration for a voice.
45382
46077
  # Corresponds to the JSON property `voiceConfig`
45383
46078
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VoiceConfig]
45384
46079
  attr_accessor :voice_config
@@ -47604,10 +48299,9 @@ module Google
47604
48299
  class GoogleCloudAiplatformV1beta1SyntheticField
47605
48300
  include Google::Apis::Core::Hashable
47606
48301
 
47607
- # The base structured datatype containing multi-part content of a message. A `
47608
- # Content` includes a `role` field designating the producer of the `Content` and
47609
- # a `parts` field containing multi-part data that contains the content of the
47610
- # message turn.
48302
+ # The structured data content of a message. A Content message contains a `role`
48303
+ # field, which indicates the producer of the content, and a `parts` field, which
48304
+ # contains the multi-part data of the message.
47611
48305
  # Corresponds to the JSON property `content`
47612
48306
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
47613
48307
  attr_accessor :content
@@ -48612,11 +49306,12 @@ module Google
48612
49306
  # @return [String]
48613
49307
  attr_accessor :environment
48614
49308
 
48615
- # Optional. By default, predefined functions are included in the final model
48616
- # call. Some of them can be explicitly excluded from being automatically
48617
- # included. This can serve two purposes: 1. Using a more restricted / different
48618
- # action space. 2. Improving the definitions / instructions of predefined
48619
- # functions.
49309
+ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-
49310
+ # ai/generative-ai/docs/computer-use#supported-actions) are included in the
49311
+ # final model call. Some of them can be explicitly excluded from being
49312
+ # automatically included. This can serve two purposes: 1. Using a more
49313
+ # restricted / different action space. 2. Improving the definitions /
49314
+ # instructions of predefined functions.
48620
49315
  # Corresponds to the JSON property `excludedPredefinedFunctions`
48621
49316
  # @return [Array<String>]
48622
49317
  attr_accessor :excluded_predefined_functions
@@ -51268,11 +51963,13 @@ module Google
51268
51963
  end
51269
51964
  end
51270
51965
 
51271
- # Metadata related to url context retrieval tool.
51966
+ # Metadata returned when the model uses the `url_context` tool to get
51967
+ # information from a user-provided URL.
51272
51968
  class GoogleCloudAiplatformV1beta1UrlContextMetadata
51273
51969
  include Google::Apis::Core::Hashable
51274
51970
 
51275
- # Output only. List of url context.
51971
+ # Output only. A list of URL metadata, with one entry for each URL retrieved by
51972
+ # the tool.
51276
51973
  # Corresponds to the JSON property `urlMetadata`
51277
51974
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UrlMetadata>]
51278
51975
  attr_accessor :url_metadata
@@ -51287,16 +51984,16 @@ module Google
51287
51984
  end
51288
51985
  end
51289
51986
 
51290
- # Context of the a single url retrieval.
51987
+ # The metadata for a single URL retrieval.
51291
51988
  class GoogleCloudAiplatformV1beta1UrlMetadata
51292
51989
  include Google::Apis::Core::Hashable
51293
51990
 
51294
- # Retrieved url by the tool.
51991
+ # The URL retrieved by the tool.
51295
51992
  # Corresponds to the JSON property `retrievedUrl`
51296
51993
  # @return [String]
51297
51994
  attr_accessor :retrieved_url
51298
51995
 
51299
- # Status of the url retrieval.
51996
+ # The status of the URL retrieval.
51300
51997
  # Corresponds to the JSON property `urlRetrievalStatus`
51301
51998
  # @return [String]
51302
51999
  attr_accessor :url_retrieval_status
@@ -51727,7 +52424,8 @@ module Google
51727
52424
  end
51728
52425
  end
51729
52426
 
51730
- # Metadata describes the input video content.
52427
+ # Provides metadata for a video, including the start and end offsets for
52428
+ # clipping and the frame rate.
51731
52429
  class GoogleCloudAiplatformV1beta1VideoMetadata
51732
52430
  include Google::Apis::Core::Hashable
51733
52431
 
@@ -51737,7 +52435,7 @@ module Google
51737
52435
  attr_accessor :end_offset
51738
52436
 
51739
52437
  # Optional. The frame rate of the video sent to the model. If not specified, the
51740
- # default value will be 1.0. The fps range is (0.0, 24.0].
52438
+ # default value is 1.0. The valid range is (0.0, 24.0].
51741
52439
  # Corresponds to the JSON property `fps`
51742
52440
  # @return [Float]
51743
52441
  attr_accessor :fps
@@ -51759,11 +52457,11 @@ module Google
51759
52457
  end
51760
52458
  end
51761
52459
 
51762
- # The configuration for the voice to use.
52460
+ # Configuration for a voice.
51763
52461
  class GoogleCloudAiplatformV1beta1VoiceConfig
51764
52462
  include Google::Apis::Core::Hashable
51765
52463
 
51766
- # The configuration for the prebuilt speaker to use.
52464
+ # Configuration for a prebuilt voice.
51767
52465
  # Corresponds to the JSON property `prebuiltVoiceConfig`
51768
52466
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig]
51769
52467
  attr_accessor :prebuilt_voice_config