google-apis-aiplatform_v1beta1 0.65.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
@@ -3891,16 +3911,16 @@ module Google
3891
3911
  end
3892
3912
  end
3893
3913
 
3894
- # Source attributions for content.
3914
+ # A citation for a piece of generatedcontent.
3895
3915
  class GoogleCloudAiplatformV1beta1Citation
3896
3916
  include Google::Apis::Core::Hashable
3897
3917
 
3898
- # Output only. End index into the content.
3918
+ # Output only. The end index of the citation in the content.
3899
3919
  # Corresponds to the JSON property `endIndex`
3900
3920
  # @return [Fixnum]
3901
3921
  attr_accessor :end_index
3902
3922
 
3903
- # Output only. License of the attribution.
3923
+ # Output only. The license of the source of the citation.
3904
3924
  # Corresponds to the JSON property `license`
3905
3925
  # @return [String]
3906
3926
  attr_accessor :license
@@ -3917,17 +3937,17 @@ module Google
3917
3937
  # @return [Google::Apis::AiplatformV1beta1::GoogleTypeDate]
3918
3938
  attr_accessor :publication_date
3919
3939
 
3920
- # Output only. Start index into the content.
3940
+ # Output only. The start index of the citation in the content.
3921
3941
  # Corresponds to the JSON property `startIndex`
3922
3942
  # @return [Fixnum]
3923
3943
  attr_accessor :start_index
3924
3944
 
3925
- # Output only. Title of the attribution.
3945
+ # Output only. The title of the source of the citation.
3926
3946
  # Corresponds to the JSON property `title`
3927
3947
  # @return [String]
3928
3948
  attr_accessor :title
3929
3949
 
3930
- # Output only. Url reference of the attribution.
3950
+ # Output only. The URI of the source of the citation.
3931
3951
  # Corresponds to the JSON property `uri`
3932
3952
  # @return [String]
3933
3953
  attr_accessor :uri
@@ -3947,11 +3967,11 @@ module Google
3947
3967
  end
3948
3968
  end
3949
3969
 
3950
- # A collection of source attributions for a piece of content.
3970
+ # A collection of citations that apply to a piece of generated content.
3951
3971
  class GoogleCloudAiplatformV1beta1CitationMetadata
3952
3972
  include Google::Apis::Core::Hashable
3953
3973
 
3954
- # Output only. List of citations.
3974
+ # Output only. A list of citations for the content.
3955
3975
  # Corresponds to the JSON property `citations`
3956
3976
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Citation>]
3957
3977
  attr_accessor :citations
@@ -4479,22 +4499,21 @@ module Google
4479
4499
  end
4480
4500
  end
4481
4501
 
4482
- # The base structured datatype containing multi-part content of a message. A `
4483
- # Content` includes a `role` field designating the producer of the `Content` and
4484
- # a `parts` field containing multi-part data that contains the content of the
4485
- # 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.
4486
4505
  class GoogleCloudAiplatformV1beta1Content
4487
4506
  include Google::Apis::Core::Hashable
4488
4507
 
4489
- # Required. Ordered `Parts` that constitute a single message. Parts may have
4490
- # 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.
4491
4511
  # Corresponds to the JSON property `parts`
4492
4512
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Part>]
4493
4513
  attr_accessor :parts
4494
4514
 
4495
- # Optional. The producer of the content. Must be either 'user' or 'model'.
4496
- # Useful to set for multi-turn conversations, otherwise can be left blank or
4497
- # unset.
4515
+ # Optional. The producer of the content. Must be either 'user' or 'model'. If
4516
+ # not set, the service will default to 'user'.
4498
4517
  # Corresponds to the JSON property `role`
4499
4518
  # @return [String]
4500
4519
  attr_accessor :role
@@ -4580,10 +4599,9 @@ module Google
4580
4599
  class GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent
4581
4600
  include Google::Apis::Core::Hashable
4582
4601
 
4583
- # The base structured datatype containing multi-part content of a message. A `
4584
- # Content` includes a `role` field designating the producer of the `Content` and
4585
- # a `parts` field containing multi-part data that contains the content of the
4586
- # 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.
4587
4605
  # Corresponds to the JSON property `content`
4588
4606
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4589
4607
  attr_accessor :content
@@ -4807,10 +4825,9 @@ module Google
4807
4825
  class GoogleCloudAiplatformV1beta1CorroborateContentRequest
4808
4826
  include Google::Apis::Core::Hashable
4809
4827
 
4810
- # The base structured datatype containing multi-part content of a message. A `
4811
- # Content` includes a `role` field designating the producer of the `Content` and
4812
- # a `parts` field containing multi-part data that contains the content of the
4813
- # 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.
4814
4831
  # Corresponds to the JSON property `content`
4815
4832
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4816
4833
  attr_accessor :content
@@ -4893,7 +4910,9 @@ module Google
4893
4910
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
4894
4911
  attr_accessor :contents
4895
4912
 
4896
- # 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.
4897
4916
  # Corresponds to the JSON property `generationConfig`
4898
4917
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
4899
4918
  attr_accessor :generation_config
@@ -4910,10 +4929,9 @@ module Google
4910
4929
  # @return [String]
4911
4930
  attr_accessor :model
4912
4931
 
4913
- # The base structured datatype containing multi-part content of a message. A `
4914
- # Content` includes a `role` field designating the producer of the `Content` and
4915
- # a `parts` field containing multi-part data that contains the content of the
4916
- # 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.
4917
4935
  # Corresponds to the JSON property `systemInstruction`
4918
4936
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4919
4937
  attr_accessor :system_instruction
@@ -5698,6 +5716,56 @@ module Google
5698
5716
  end
5699
5717
  end
5700
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
+
5701
5769
  # Represents a job that runs custom workloads such as a Docker container or a
5702
5770
  # Python package. A CustomJob can have multiple worker pools and each worker
5703
5771
  # pool can have its own machine and input spec. A CustomJob will be cleaned up
@@ -8427,10 +8495,9 @@ module Google
8427
8495
  attr_accessor :auto_truncate
8428
8496
  alias_method :auto_truncate?, :auto_truncate
8429
8497
 
8430
- # The base structured datatype containing multi-part content of a message. A `
8431
- # Content` includes a `role` field designating the producer of the `Content` and
8432
- # a `parts` field containing multi-part data that contains the content of the
8433
- # 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.
8434
8501
  # Corresponds to the JSON property `content`
8435
8502
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
8436
8503
  attr_accessor :content
@@ -9845,11 +9912,6 @@ module Google
9845
9912
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents]
9846
9913
  attr_accessor :events
9847
9914
 
9848
- # A JSON string containing a sequence of events.
9849
- # Corresponds to the JSON property `eventsText`
9850
- # @return [String]
9851
- attr_accessor :events_text
9852
-
9853
9915
  # Represents a list of tools for an agent.
9854
9916
  # Corresponds to the JSON property `tools`
9855
9917
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools]
@@ -9875,7 +9937,6 @@ module Google
9875
9937
  @agent_config = args[:agent_config] if args.key?(:agent_config)
9876
9938
  @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction)
9877
9939
  @events = args[:events] if args.key?(:events)
9878
- @events_text = args[:events_text] if args.key?(:events_text)
9879
9940
  @tools = args[:tools] if args.key?(:tools)
9880
9941
  @tools_text = args[:tools_text] if args.key?(:tools_text)
9881
9942
  end
@@ -10456,7 +10517,9 @@ module Google
10456
10517
  # @return [String]
10457
10518
  attr_accessor :autorater_model
10458
10519
 
10459
- # 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.
10460
10523
  # Corresponds to the JSON property `generationConfig`
10461
10524
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
10462
10525
  attr_accessor :generation_config
@@ -10541,7 +10604,9 @@ module Google
10541
10604
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig]
10542
10605
  attr_accessor :agent_config
10543
10606
 
10544
- # Generation config.
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.
10545
10610
  # Corresponds to the JSON property `generationConfig`
10546
10611
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
10547
10612
  attr_accessor :generation_config
@@ -10570,10 +10635,9 @@ module Google
10570
10635
  class GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig
10571
10636
  include Google::Apis::Core::Hashable
10572
10637
 
10573
- # The base structured datatype containing multi-part content of a message. A `
10574
- # Content` includes a `role` field designating the producer of the `Content` and
10575
- # a `parts` field containing multi-part data that contains the content of the
10576
- # message turn.
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.
10577
10641
  # Corresponds to the JSON property `developerInstruction`
10578
10642
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
10579
10643
  attr_accessor :developer_instruction
@@ -10997,7 +11061,9 @@ module Google
10997
11061
  # @return [Hash<String,Object>]
10998
11062
  attr_accessor :custom_metadata
10999
11063
 
11000
- # 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.
11001
11067
  # Corresponds to the JSON property `groundingMetadata`
11002
11068
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata]
11003
11069
  attr_accessor :grounding_metadata
@@ -11460,6 +11526,44 @@ module Google
11460
11526
  end
11461
11527
  end
11462
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
+
11463
11567
  # Request message for ExtensionExecutionService.ExecuteExtension.
11464
11568
  class GoogleCloudAiplatformV1beta1ExecuteExtensionRequest
11465
11569
  include Google::Apis::Core::Hashable
@@ -15769,20 +15873,21 @@ module Google
15769
15873
  end
15770
15874
  end
15771
15875
 
15772
- # 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.
15773
15879
  class GoogleCloudAiplatformV1beta1FileData
15774
15880
  include Google::Apis::Core::Hashable
15775
15881
 
15776
- # Optional. Display name of the file data. Used to provide a label or filename
15777
- # to distinguish file datas. This field is only returned in PromptMessage for
15778
- # prompt management. It is currently used in the Gemini GenerateContent calls
15779
- # only when server side tools (code_execution, google_search, and url_context)
15780
- # 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.
15781
15886
  # Corresponds to the JSON property `displayName`
15782
15887
  # @return [String]
15783
15888
  attr_accessor :display_name
15784
15889
 
15785
- # Required. URI.
15890
+ # Required. The URI of the file in Google Cloud Storage.
15786
15891
  # Corresponds to the JSON property `fileUri`
15787
15892
  # @return [String]
15788
15893
  attr_accessor :file_uri
@@ -16719,7 +16824,9 @@ module Google
16719
16824
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
16720
16825
  attr_accessor :contents
16721
16826
 
16722
- # 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.
16723
16830
  # Corresponds to the JSON property `generationConfig`
16724
16831
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
16725
16832
  attr_accessor :generation_config
@@ -16747,10 +16854,9 @@ module Google
16747
16854
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
16748
16855
  attr_accessor :safety_settings
16749
16856
 
16750
- # The base structured datatype containing multi-part content of a message. A `
16751
- # Content` includes a `role` field designating the producer of the `Content` and
16752
- # a `parts` field containing multi-part data that contains the content of the
16753
- # 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.
16754
16860
  # Corresponds to the JSON property `systemInstruction`
16755
16861
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
16756
16862
  attr_accessor :system_instruction
@@ -16815,10 +16921,9 @@ module Google
16815
16921
  class GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion
16816
16922
  include Google::Apis::Core::Hashable
16817
16923
 
16818
- # The base structured datatype containing multi-part content of a message. A `
16819
- # Content` includes a `role` field designating the producer of the `Content` and
16820
- # a `parts` field containing multi-part data that contains the content of the
16821
- # 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.
16822
16927
  # Corresponds to the JSON property `completion`
16823
16928
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
16824
16929
  attr_accessor :completion
@@ -17011,7 +17116,9 @@ module Google
17011
17116
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
17012
17117
  attr_accessor :contents
17013
17118
 
17014
- # 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.
17015
17122
  # Corresponds to the JSON property `generationConfig`
17016
17123
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
17017
17124
  attr_accessor :generation_config
@@ -17025,7 +17132,10 @@ module Google
17025
17132
  # @return [Hash<String,String>]
17026
17133
  attr_accessor :labels
17027
17134
 
17028
- # 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.
17029
17139
  # Corresponds to the JSON property `modelArmorConfig`
17030
17140
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelArmorConfig]
17031
17141
  attr_accessor :model_armor_config
@@ -17036,10 +17146,9 @@ module Google
17036
17146
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
17037
17147
  attr_accessor :safety_settings
17038
17148
 
17039
- # The base structured datatype containing multi-part content of a message. A `
17040
- # Content` includes a `role` field designating the producer of the `Content` and
17041
- # a `parts` field containing multi-part data that contains the content of the
17042
- # 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.
17043
17152
  # Corresponds to the JSON property `systemInstruction`
17044
17153
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
17045
17154
  attr_accessor :system_instruction
@@ -17454,10 +17563,9 @@ module Google
17454
17563
  class GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSourceEvent
17455
17564
  include Google::Apis::Core::Hashable
17456
17565
 
17457
- # The base structured datatype containing multi-part content of a message. A `
17458
- # Content` includes a `role` field designating the producer of the `Content` and
17459
- # a `parts` field containing multi-part data that contains the content of the
17460
- # 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.
17461
17569
  # Corresponds to the JSON property `content`
17462
17570
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
17463
17571
  attr_accessor :content
@@ -17682,50 +17790,72 @@ module Google
17682
17790
  end
17683
17791
  end
17684
17792
 
17685
- # 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.
17686
17796
  class GoogleCloudAiplatformV1beta1GenerationConfig
17687
17797
  include Google::Apis::Core::Hashable
17688
17798
 
17689
- # Optional. If enabled, audio timestamp will be included in the request to the
17690
- # 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.
17691
17802
  # Corresponds to the JSON property `audioTimestamp`
17692
17803
  # @return [Boolean]
17693
17804
  attr_accessor :audio_timestamp
17694
17805
  alias_method :audio_timestamp?, :audio_timestamp
17695
17806
 
17696
- # 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.
17697
17811
  # Corresponds to the JSON property `candidateCount`
17698
17812
  # @return [Fixnum]
17699
17813
  attr_accessor :candidate_count
17700
17814
 
17701
17815
  # Optional. If enabled, the model will detect emotions and adapt its responses
17702
- # accordingly.
17816
+ # accordingly. For example, if the model detects that the user is frustrated, it
17817
+ # may provide a more empathetic response.
17703
17818
  # Corresponds to the JSON property `enableAffectiveDialog`
17704
17819
  # @return [Boolean]
17705
17820
  attr_accessor :enable_affective_dialog
17706
17821
  alias_method :enable_affective_dialog?, :enable_affective_dialog
17707
17822
 
17708
- # 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].
17709
17826
  # Corresponds to the JSON property `frequencyPenalty`
17710
17827
  # @return [Float]
17711
17828
  attr_accessor :frequency_penalty
17712
17829
 
17713
- # 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.
17714
17833
  # Corresponds to the JSON property `imageConfig`
17715
17834
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImageConfig]
17716
17835
  attr_accessor :image_config
17717
17836
 
17718
- # 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.
17719
17841
  # Corresponds to the JSON property `logprobs`
17720
17842
  # @return [Fixnum]
17721
17843
  attr_accessor :logprobs
17722
17844
 
17723
- # 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.
17724
17849
  # Corresponds to the JSON property `maxOutputTokens`
17725
17850
  # @return [Fixnum]
17726
17851
  attr_accessor :max_output_tokens
17727
17852
 
17728
- # 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.
17729
17859
  # Corresponds to the JSON property `mediaResolution`
17730
17860
  # @return [String]
17731
17861
  attr_accessor :media_resolution
@@ -17735,44 +17865,41 @@ module Google
17735
17865
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigModelConfig]
17736
17866
  attr_accessor :model_config
17737
17867
 
17738
- # 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].
17739
17871
  # Corresponds to the JSON property `presencePenalty`
17740
17872
  # @return [Float]
17741
17873
  attr_accessor :presence_penalty
17742
17874
 
17743
- # Optional. Output schema of the generated response. This is an alternative to `
17744
- # response_schema` that accepts [JSON Schema](https://json-schema.org/). If set,
17745
- # `response_schema` must be omitted, but `response_mime_type` is required. While
17746
- # the full JSON Schema may be sent, not all features are supported. Specifically,
17747
- # only the following properties are supported: - `$id` - `$defs` - `$ref` - `$
17748
- # anchor` - `type` - `format` - `title` - `description` - `enum` (for strings
17749
- # and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` -
17750
- # `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties`
17751
- # - `additionalProperties` - `required` The non-standard `propertyOrdering`
17752
- # property may also be set. Cyclic references are unrolled to a limited degree
17753
- # and, as such, may only be used within non-required properties. (Nullable
17754
- # properties are not sufficient.) If `$ref` is set on a sub-schema, no other
17755
- # 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`.
17756
17877
  # Corresponds to the JSON property `responseJsonSchema`
17757
17878
  # @return [Object]
17758
17879
  attr_accessor :response_json_schema
17759
17880
 
17760
- # 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.
17761
17886
  # Corresponds to the JSON property `responseLogprobs`
17762
17887
  # @return [Boolean]
17763
17888
  attr_accessor :response_logprobs
17764
17889
  alias_method :response_logprobs?, :response_logprobs
17765
17890
 
17766
- # Optional. Output response mimetype of the generated candidate text. Supported
17767
- # mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON
17768
- # 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
17769
17894
  # appropriate response type, otherwise the behavior is undefined. This is a
17770
17895
  # preview feature.
17771
17896
  # Corresponds to the JSON property `responseMimeType`
17772
17897
  # @return [String]
17773
17898
  attr_accessor :response_mime_type
17774
17899
 
17775
- # 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.
17776
17903
  # Corresponds to the JSON property `responseModalities`
17777
17904
  # @return [Array<String>]
17778
17905
  attr_accessor :response_modalities
@@ -17784,42 +17911,68 @@ module Google
17784
17911
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema]
17785
17912
  attr_accessor :response_schema
17786
17913
 
17787
- # 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.
17788
17917
  # Corresponds to the JSON property `routingConfig`
17789
17918
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig]
17790
17919
  attr_accessor :routing_config
17791
17920
 
17792
- # 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.
17793
17929
  # Corresponds to the JSON property `seed`
17794
17930
  # @return [Fixnum]
17795
17931
  attr_accessor :seed
17796
17932
 
17797
- # The speech generation config.
17933
+ # Configuration for speech generation.
17798
17934
  # Corresponds to the JSON property `speechConfig`
17799
17935
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpeechConfig]
17800
17936
  attr_accessor :speech_config
17801
17937
 
17802
- # 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.
17803
17943
  # Corresponds to the JSON property `stopSequences`
17804
17944
  # @return [Array<String>]
17805
17945
  attr_accessor :stop_sequences
17806
17946
 
17807
- # 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].
17808
17950
  # Corresponds to the JSON property `temperature`
17809
17951
  # @return [Float]
17810
17952
  attr_accessor :temperature
17811
17953
 
17812
- # 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.
17813
17958
  # Corresponds to the JSON property `thinkingConfig`
17814
17959
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig]
17815
17960
  attr_accessor :thinking_config
17816
17961
 
17817
- # 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.
17818
17966
  # Corresponds to the JSON property `topK`
17819
17967
  # @return [Float]
17820
17968
  attr_accessor :top_k
17821
17969
 
17822
- # 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.
17823
17976
  # Corresponds to the JSON property `topP`
17824
17977
  # @return [Float]
17825
17978
  attr_accessor :top_p
@@ -17875,17 +18028,21 @@ module Google
17875
18028
  end
17876
18029
  end
17877
18030
 
17878
- # 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.
17879
18034
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig
17880
18035
  include Google::Apis::Core::Hashable
17881
18036
 
17882
- # When automated routing is specified, the routing will be determined by the
17883
- # 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.
17884
18040
  # Corresponds to the JSON property `autoMode`
17885
18041
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode]
17886
18042
  attr_accessor :auto_mode
17887
18043
 
17888
- # 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.
17889
18046
  # Corresponds to the JSON property `manualMode`
17890
18047
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode]
17891
18048
  attr_accessor :manual_mode
@@ -17901,8 +18058,9 @@ module Google
17901
18058
  end
17902
18059
  end
17903
18060
 
17904
- # When automated routing is specified, the routing will be determined by the
17905
- # 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.
17906
18064
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode
17907
18065
  include Google::Apis::Core::Hashable
17908
18066
 
@@ -17921,13 +18079,12 @@ module Google
17921
18079
  end
17922
18080
  end
17923
18081
 
17924
- # 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.
17925
18084
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode
17926
18085
  include Google::Apis::Core::Hashable
17927
18086
 
17928
- # The model name to use. Only the public LLM models are accepted. See [Supported
17929
- # models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/
17930
- # inference#supported-models).
18087
+ # The name of the model to use. Only public LLM models are accepted.
17931
18088
  # Corresponds to the JSON property `modelName`
17932
18089
  # @return [String]
17933
18090
  attr_accessor :model_name
@@ -17942,18 +18099,26 @@ module Google
17942
18099
  end
17943
18100
  end
17944
18101
 
17945
- # 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.
17946
18106
  class GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig
17947
18107
  include Google::Apis::Core::Hashable
17948
18108
 
17949
- # Optional. Indicates whether to include thoughts in the response. If true,
17950
- # 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.
17951
18114
  # Corresponds to the JSON property `includeThoughts`
17952
18115
  # @return [Boolean]
17953
18116
  attr_accessor :include_thoughts
17954
18117
  alias_method :include_thoughts?, :include_thoughts
17955
18118
 
17956
- # 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.
17957
18122
  # Corresponds to the JSON property `thinkingBudget`
17958
18123
  # @return [Fixnum]
17959
18124
  attr_accessor :thinking_budget
@@ -18207,21 +18372,30 @@ module Google
18207
18372
  end
18208
18373
  end
18209
18374
 
18210
- # 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.
18211
18379
  class GoogleCloudAiplatformV1beta1GroundingChunk
18212
18380
  include Google::Apis::Core::Hashable
18213
18381
 
18214
- # 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.
18215
18385
  # Corresponds to the JSON property `maps`
18216
18386
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMaps]
18217
18387
  attr_accessor :maps
18218
18388
 
18219
- # 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.
18220
18392
  # Corresponds to the JSON property `retrievedContext`
18221
18393
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext]
18222
18394
  attr_accessor :retrieved_context
18223
18395
 
18224
- # 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.
18225
18399
  # Corresponds to the JSON property `web`
18226
18400
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkWeb]
18227
18401
  attr_accessor :web
@@ -18238,32 +18412,36 @@ module Google
18238
18412
  end
18239
18413
  end
18240
18414
 
18241
- # 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.
18242
18418
  class GoogleCloudAiplatformV1beta1GroundingChunkMaps
18243
18419
  include Google::Apis::Core::Hashable
18244
18420
 
18245
- # 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.
18246
18424
  # Corresponds to the JSON property `placeAnswerSources`
18247
18425
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources]
18248
18426
  attr_accessor :place_answer_sources
18249
18427
 
18250
- # This Place's resource name, in `places/`place_id`` format. Can be used to look
18251
- # 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.
18252
18430
  # Corresponds to the JSON property `placeId`
18253
18431
  # @return [String]
18254
18432
  attr_accessor :place_id
18255
18433
 
18256
- # Text of the place answer.
18434
+ # The text of the place answer.
18257
18435
  # Corresponds to the JSON property `text`
18258
18436
  # @return [String]
18259
18437
  attr_accessor :text
18260
18438
 
18261
- # Title of the place.
18439
+ # The title of the place.
18262
18440
  # Corresponds to the JSON property `title`
18263
18441
  # @return [String]
18264
18442
  attr_accessor :title
18265
18443
 
18266
- # URI reference of the place.
18444
+ # The URI of the place.
18267
18445
  # Corresponds to the JSON property `uri`
18268
18446
  # @return [String]
18269
18447
  attr_accessor :uri
@@ -18282,11 +18460,13 @@ module Google
18282
18460
  end
18283
18461
  end
18284
18462
 
18285
- # 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.
18286
18466
  class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources
18287
18467
  include Google::Apis::Core::Hashable
18288
18468
 
18289
- # Snippets of reviews that are used to generate the answer.
18469
+ # Snippets of reviews that were used to generate the answer.
18290
18470
  # Corresponds to the JSON property `reviewSnippets`
18291
18471
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet>]
18292
18472
  attr_accessor :review_snippets
@@ -18301,7 +18481,7 @@ module Google
18301
18481
  end
18302
18482
  end
18303
18483
 
18304
- # Encapsulates a review snippet.
18484
+ # A review snippet that is used to generate the answer.
18305
18485
  class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
18306
18486
  include Google::Apis::Core::Hashable
18307
18487
 
@@ -18310,12 +18490,12 @@ module Google
18310
18490
  # @return [String]
18311
18491
  attr_accessor :google_maps_uri
18312
18492
 
18313
- # Id of the review referencing the place.
18493
+ # The ID of the review that is being referenced.
18314
18494
  # Corresponds to the JSON property `reviewId`
18315
18495
  # @return [String]
18316
18496
  attr_accessor :review_id
18317
18497
 
18318
- # Title of the review.
18498
+ # The title of the review.
18319
18499
  # Corresponds to the JSON property `title`
18320
18500
  # @return [String]
18321
18501
  attr_accessor :title
@@ -18332,12 +18512,16 @@ module Google
18332
18512
  end
18333
18513
  end
18334
18514
 
18335
- # 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.
18336
18518
  class GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext
18337
18519
  include Google::Apis::Core::Hashable
18338
18520
 
18339
- # Output only. The full document name for the referenced Vertex AI Search
18340
- # 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``.
18341
18525
  # Corresponds to the JSON property `documentName`
18342
18526
  # @return [String]
18343
18527
  attr_accessor :document_name
@@ -18348,17 +18532,17 @@ module Google
18348
18532
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagChunk]
18349
18533
  attr_accessor :rag_chunk
18350
18534
 
18351
- # Text of the attribution.
18535
+ # The content of the retrieved data source.
18352
18536
  # Corresponds to the JSON property `text`
18353
18537
  # @return [String]
18354
18538
  attr_accessor :text
18355
18539
 
18356
- # Title of the attribution.
18540
+ # The title of the retrieved data source.
18357
18541
  # Corresponds to the JSON property `title`
18358
18542
  # @return [String]
18359
18543
  attr_accessor :title
18360
18544
 
18361
- # URI reference of the attribution.
18545
+ # The URI of the retrieved data source.
18362
18546
  # Corresponds to the JSON property `uri`
18363
18547
  # @return [String]
18364
18548
  attr_accessor :uri
@@ -18377,21 +18561,24 @@ module Google
18377
18561
  end
18378
18562
  end
18379
18563
 
18380
- # 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.
18381
18567
  class GoogleCloudAiplatformV1beta1GroundingChunkWeb
18382
18568
  include Google::Apis::Core::Hashable
18383
18569
 
18384
- # 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.
18385
18572
  # Corresponds to the JSON property `domain`
18386
18573
  # @return [String]
18387
18574
  attr_accessor :domain
18388
18575
 
18389
- # Title of the chunk.
18576
+ # The title of the web page that contains the evidence.
18390
18577
  # Corresponds to the JSON property `title`
18391
18578
  # @return [String]
18392
18579
  attr_accessor :title
18393
18580
 
18394
- # URI reference of the chunk.
18581
+ # The URI of the web page that contains the evidence.
18395
18582
  # Corresponds to the JSON property `uri`
18396
18583
  # @return [String]
18397
18584
  attr_accessor :uri
@@ -18408,49 +18595,63 @@ module Google
18408
18595
  end
18409
18596
  end
18410
18597
 
18411
- # 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.
18412
18601
  class GoogleCloudAiplatformV1beta1GroundingMetadata
18413
18602
  include Google::Apis::Core::Hashable
18414
18603
 
18415
- # Optional. Output only. Resource name of the Google Maps widget context token
18416
- # to be used with the PlacesContextElement widget to render contextual data.
18417
- # 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.
18418
18607
  # Corresponds to the JSON property `googleMapsWidgetContextToken`
18419
18608
  # @return [String]
18420
18609
  attr_accessor :google_maps_widget_context_token
18421
18610
 
18422
- # 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.
18423
18614
  # Corresponds to the JSON property `groundingChunks`
18424
18615
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunk>]
18425
18616
  attr_accessor :grounding_chunks
18426
18617
 
18427
- # 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.
18428
18621
  # Corresponds to the JSON property `groundingSupports`
18429
18622
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingSupport>]
18430
18623
  attr_accessor :grounding_supports
18431
18624
 
18432
- # 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.
18433
18627
  # Corresponds to the JSON property `retrievalMetadata`
18434
18628
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrievalMetadata]
18435
18629
  attr_accessor :retrieval_metadata
18436
18630
 
18437
- # 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.
18438
18634
  # Corresponds to the JSON property `retrievalQueries`
18439
18635
  # @return [Array<String>]
18440
18636
  attr_accessor :retrieval_queries
18441
18637
 
18442
- # 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.
18443
18642
  # Corresponds to the JSON property `searchEntryPoint`
18444
18643
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchEntryPoint]
18445
18644
  attr_accessor :search_entry_point
18446
18645
 
18447
- # Optional. Output only. List of source flagging uris. This is currently
18448
- # 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.
18449
18649
  # Corresponds to the JSON property `sourceFlaggingUris`
18450
18650
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri>]
18451
18651
  attr_accessor :source_flagging_uris
18452
18652
 
18453
- # 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.
18454
18655
  # Corresponds to the JSON property `webSearchQueries`
18455
18656
  # @return [Array<String>]
18456
18657
  attr_accessor :web_search_queries
@@ -18472,17 +18673,17 @@ module Google
18472
18673
  end
18473
18674
  end
18474
18675
 
18475
- # Source content flagging uri for a place or review. This is currently populated
18476
- # 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.
18477
18678
  class GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri
18478
18679
  include Google::Apis::Core::Hashable
18479
18680
 
18480
- # 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.
18481
18682
  # Corresponds to the JSON property `flagContentUri`
18482
18683
  # @return [String]
18483
18684
  attr_accessor :flag_content_uri
18484
18685
 
18485
- # Id of the place or review.
18686
+ # The ID of the place or review.
18486
18687
  # Corresponds to the JSON property `sourceId`
18487
18688
  # @return [String]
18488
18689
  attr_accessor :source_id
@@ -18498,27 +18699,30 @@ module Google
18498
18699
  end
18499
18700
  end
18500
18701
 
18501
- # Grounding support.
18702
+ # A collection of supporting references for a segment of the model's response.
18502
18703
  class GoogleCloudAiplatformV1beta1GroundingSupport
18503
18704
  include Google::Apis::Core::Hashable
18504
18705
 
18505
- # Confidence score of the support references. Ranges from 0 to 1. 1 is the most
18506
- # confident. For Gemini 2.0 and before, this list must have the same size as the
18507
- # 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
18508
18711
  # should be ignored.
18509
18712
  # Corresponds to the JSON property `confidenceScores`
18510
18713
  # @return [Array<Float>]
18511
18714
  attr_accessor :confidence_scores
18512
18715
 
18513
- # A list of indices (into 'grounding_chunk') specifying the citations associated
18514
- # with the claim. For instance [1,3,4] means that grounding_chunk[1],
18515
- # grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to
18516
- # 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.
18517
18721
  # Corresponds to the JSON property `groundingChunkIndices`
18518
18722
  # @return [Array<Fixnum>]
18519
18723
  attr_accessor :grounding_chunk_indices
18520
18724
 
18521
- # Segment of the content.
18725
+ # A segment of the content.
18522
18726
  # Corresponds to the JSON property `segment`
18523
18727
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Segment]
18524
18728
  attr_accessor :segment
@@ -18697,7 +18901,9 @@ module Google
18697
18901
  end
18698
18902
  end
18699
18903
 
18700
- # 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.
18701
18907
  class GoogleCloudAiplatformV1beta1ImageConfig
18702
18908
  include Google::Apis::Core::Hashable
18703
18909
 
@@ -22189,17 +22395,24 @@ module Google
22189
22395
  end
22190
22396
  end
22191
22397
 
22192
- # 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.
22193
22404
  class GoogleCloudAiplatformV1beta1LogprobsResult
22194
22405
  include Google::Apis::Core::Hashable
22195
22406
 
22196
- # Length = total number of decoding steps. The chosen candidates may or may not
22197
- # 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`.
22198
22410
  # Corresponds to the JSON property `chosenCandidates`
22199
22411
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
22200
22412
  attr_accessor :chosen_candidates
22201
22413
 
22202
- # 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.
22203
22416
  # Corresponds to the JSON property `topCandidates`
22204
22417
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates>]
22205
22418
  attr_accessor :top_candidates
@@ -22215,21 +22428,27 @@ module Google
22215
22428
  end
22216
22429
  end
22217
22430
 
22218
- # Candidate for the logprobs token and score.
22431
+ # A single token and its associated log probability.
22219
22432
  class GoogleCloudAiplatformV1beta1LogprobsResultCandidate
22220
22433
  include Google::Apis::Core::Hashable
22221
22434
 
22222
- # 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.
22223
22439
  # Corresponds to the JSON property `logProbability`
22224
22440
  # @return [Float]
22225
22441
  attr_accessor :log_probability
22226
22442
 
22227
- # The candidate's token string value.
22443
+ # The token's string representation.
22228
22444
  # Corresponds to the JSON property `token`
22229
22445
  # @return [String]
22230
22446
  attr_accessor :token
22231
22447
 
22232
- # 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.
22233
22452
  # Corresponds to the JSON property `tokenId`
22234
22453
  # @return [Fixnum]
22235
22454
  attr_accessor :token_id
@@ -22246,11 +22465,12 @@ module Google
22246
22465
  end
22247
22466
  end
22248
22467
 
22249
- # 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.
22250
22470
  class GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates
22251
22471
  include Google::Apis::Core::Hashable
22252
22472
 
22253
- # Sorted by log probability in descending order.
22473
+ # The list of candidate tokens, sorted by log probability in descending order.
22254
22474
  # Corresponds to the JSON property `candidates`
22255
22475
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
22256
22476
  attr_accessor :candidates
@@ -22530,6 +22750,12 @@ module Google
22530
22750
  # @return [String]
22531
22751
  attr_accessor :revision_expire_time
22532
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
+
22533
22759
  # Optional. Input only. The TTL for the revision. The expiration time is
22534
22760
  # computed: now + TTL.
22535
22761
  # Corresponds to the JSON property `revisionTtl`
@@ -22573,6 +22799,7 @@ module Google
22573
22799
  @fact = args[:fact] if args.key?(:fact)
22574
22800
  @name = args[:name] if args.key?(:name)
22575
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)
22576
22803
  @revision_ttl = args[:revision_ttl] if args.key?(:revision_ttl)
22577
22804
  @scope = args[:scope] if args.key?(:scope)
22578
22805
  @topics = args[:topics] if args.key?(:topics)
@@ -22670,10 +22897,9 @@ module Google
22670
22897
  class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent
22671
22898
  include Google::Apis::Core::Hashable
22672
22899
 
22673
- # The base structured datatype containing multi-part content of a message. A `
22674
- # Content` includes a `role` field designating the producer of the `Content` and
22675
- # a `parts` field containing multi-part data that contains the content of the
22676
- # 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.
22677
22903
  # Corresponds to the JSON property `content`
22678
22904
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
22679
22905
  attr_accessor :content
@@ -23082,6 +23308,11 @@ module Google
23082
23308
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuSpec]
23083
23309
  attr_accessor :bleu_spec
23084
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
+
23085
23316
  # Spec for exact match metric - returns 1 if prediction and reference exactly
23086
23317
  # matches, otherwise 0.
23087
23318
  # Corresponds to the JSON property `exactMatchSpec`
@@ -23122,6 +23353,7 @@ module Google
23122
23353
  def update!(**args)
23123
23354
  @aggregation_metrics = args[:aggregation_metrics] if args.key?(:aggregation_metrics)
23124
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)
23125
23357
  @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec)
23126
23358
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
23127
23359
  @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec)
@@ -23692,16 +23924,21 @@ module Google
23692
23924
  end
23693
23925
  end
23694
23926
 
23695
- # 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.
23696
23933
  class GoogleCloudAiplatformV1beta1ModalityTokenCount
23697
23934
  include Google::Apis::Core::Hashable
23698
23935
 
23699
- # The modality associated with this token count.
23936
+ # The modality that this token count applies to.
23700
23937
  # Corresponds to the JSON property `modality`
23701
23938
  # @return [String]
23702
23939
  attr_accessor :modality
23703
23940
 
23704
- # Number of tokens.
23941
+ # The number of tokens counted for this modality.
23705
23942
  # Corresponds to the JSON property `tokenCount`
23706
23943
  # @return [Fixnum]
23707
23944
  attr_accessor :token_count
@@ -24002,17 +24239,29 @@ module Google
24002
24239
  end
24003
24240
  end
24004
24241
 
24005
- # 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.
24006
24246
  class GoogleCloudAiplatformV1beta1ModelArmorConfig
24007
24247
  include Google::Apis::Core::Hashable
24008
24248
 
24009
- # 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``.
24010
24255
  # Corresponds to the JSON property `promptTemplateName`
24011
24256
  # @return [String]
24012
24257
  attr_accessor :prompt_template_name
24013
24258
 
24014
- # Optional. The name of the Model Armor template to use for response
24015
- # 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``.
24016
24265
  # Corresponds to the JSON property `responseTemplateName`
24017
24266
  # @return [String]
24018
24267
  attr_accessor :response_template_name
@@ -26753,8 +27002,7 @@ module Google
26753
27002
  end
26754
27003
  end
26755
27004
 
26756
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
26757
- # to two distinct voices in a single synthesis request.
27005
+ # Configuration for a multi-speaker text-to-speech request.
26758
27006
  class GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig
26759
27007
  include Google::Apis::Core::Hashable
26760
27008
 
@@ -28558,10 +28806,9 @@ module Google
28558
28806
  class GoogleCloudAiplatformV1beta1OptimizePromptRequest
28559
28807
  include Google::Apis::Core::Hashable
28560
28808
 
28561
- # The base structured datatype containing multi-part content of a message. A `
28562
- # Content` includes a `role` field designating the producer of the `Content` and
28563
- # a `parts` field containing multi-part data that contains the content of the
28564
- # 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.
28565
28812
  # Corresponds to the JSON property `content`
28566
28813
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
28567
28814
  attr_accessor :content
@@ -28586,10 +28833,9 @@ module Google
28586
28833
  class GoogleCloudAiplatformV1beta1OptimizePromptResponse
28587
28834
  include Google::Apis::Core::Hashable
28588
28835
 
28589
- # The base structured datatype containing multi-part content of a message. A `
28590
- # Content` includes a `role` field designating the producer of the `Content` and
28591
- # a `parts` field containing multi-part data that contains the content of the
28592
- # 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.
28593
28839
  # Corresponds to the JSON property `content`
28594
28840
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
28595
28841
  attr_accessor :content
@@ -29109,11 +29355,11 @@ module Google
29109
29355
  end
29110
29356
  end
29111
29357
 
29112
- # 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 `
29113
29359
  # Part` consists of data which has an associated datatype. A `Part` can only
29114
- # contain one of the accepted types in `Part.data`. A `Part` must have a fixed
29115
- # IANA MIME type identifying the type and subtype of the media if `inline_data`
29116
- # 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.
29117
29363
  class GoogleCloudAiplatformV1beta1Part
29118
29364
  include Google::Apis::Core::Hashable
29119
29365
 
@@ -29132,7 +29378,9 @@ module Google
29132
29378
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecutableCode]
29133
29379
  attr_accessor :executable_code
29134
29380
 
29135
- # 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.
29136
29384
  # Corresponds to the JSON property `fileData`
29137
29385
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FileData]
29138
29386
  attr_accessor :file_data
@@ -29152,17 +29400,19 @@ module Google
29152
29400
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FunctionResponse]
29153
29401
  attr_accessor :function_response
29154
29402
 
29155
- # 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.
29156
29405
  # Corresponds to the JSON property `inlineData`
29157
29406
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Blob]
29158
29407
  attr_accessor :inline_data
29159
29408
 
29160
- # Optional. Text part (can be code).
29409
+ # Optional. The text content of the part.
29161
29410
  # Corresponds to the JSON property `text`
29162
29411
  # @return [String]
29163
29412
  attr_accessor :text
29164
29413
 
29165
- # 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.
29166
29416
  # Corresponds to the JSON property `thought`
29167
29417
  # @return [Boolean]
29168
29418
  attr_accessor :thought
@@ -29175,7 +29425,8 @@ module Google
29175
29425
  # @return [String]
29176
29426
  attr_accessor :thought_signature
29177
29427
 
29178
- # 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.
29179
29430
  # Corresponds to the JSON property `videoMetadata`
29180
29431
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VideoMetadata]
29181
29432
  attr_accessor :video_metadata
@@ -30394,11 +30645,11 @@ module Google
30394
30645
  end
30395
30646
  end
30396
30647
 
30397
- # The configuration for the prebuilt speaker to use.
30648
+ # Configuration for a prebuilt voice.
30398
30649
  class GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig
30399
30650
  include Google::Apis::Core::Hashable
30400
30651
 
30401
- # The name of the preset voice to use.
30652
+ # The name of the prebuilt voice to use.
30402
30653
  # Corresponds to the JSON property `voiceName`
30403
30654
  # @return [String]
30404
30655
  attr_accessor :voice_name
@@ -32981,6 +33232,18 @@ module Google
32981
33232
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig]
32982
33233
  attr_accessor :rag_vector_db_config
32983
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
+
32984
33247
  # Output only. Timestamp when this RagCorpus was last updated.
32985
33248
  # Corresponds to the JSON property `updateTime`
32986
33249
  # @return [String]
@@ -33012,6 +33275,8 @@ module Google
33012
33275
  @rag_embedding_model_config = args[:rag_embedding_model_config] if args.key?(:rag_embedding_model_config)
33013
33276
  @rag_files_count = args[:rag_files_count] if args.key?(:rag_files_count)
33014
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)
33015
33280
  @update_time = args[:update_time] if args.key?(:update_time)
33016
33281
  @vector_db_config = args[:vector_db_config] if args.key?(:vector_db_config)
33017
33282
  @vertex_ai_search_config = args[:vertex_ai_search_config] if args.key?(:vertex_ai_search_config)
@@ -34901,6 +35166,13 @@ module Google
34901
35166
  class GoogleCloudAiplatformV1beta1ReasoningEngineSpec
34902
35167
  include Google::Apis::Core::Hashable
34903
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
+
34904
35176
  # Optional. The OSS agent framework used to develop the agent. Currently
34905
35177
  # supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index",
34906
35178
  # "custom".
@@ -34919,6 +35191,23 @@ module Google
34919
35191
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec]
34920
35192
  attr_accessor :deployment_spec
34921
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
+
34922
35211
  # User-provided package specification, containing pickled object and package
34923
35212
  # requirements.
34924
35213
  # Corresponds to the JSON property `packageSpec`
@@ -34945,9 +35234,12 @@ module Google
34945
35234
 
34946
35235
  # Update properties of this object
34947
35236
  def update!(**args)
35237
+ @agent_card = args[:agent_card] if args.key?(:agent_card)
34948
35238
  @agent_framework = args[:agent_framework] if args.key?(:agent_framework)
34949
35239
  @class_methods = args[:class_methods] if args.key?(:class_methods)
34950
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)
34951
35243
  @package_spec = args[:package_spec] if args.key?(:package_spec)
34952
35244
  @service_account = args[:service_account] if args.key?(:service_account)
34953
35245
  @source_code_spec = args[:source_code_spec] if args.key?(:source_code_spec)
@@ -35044,8 +35336,8 @@ module Google
35044
35336
  # @return [String]
35045
35337
  attr_accessor :pickle_object_gcs_uri
35046
35338
 
35047
- # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not
35048
- # 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.
35049
35341
  # Corresponds to the JSON property `pythonVersion`
35050
35342
  # @return [String]
35051
35343
  attr_accessor :python_version
@@ -35916,15 +36208,17 @@ module Google
35916
36208
  end
35917
36209
  end
35918
36210
 
35919
- # 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.
35920
36213
  class GoogleCloudAiplatformV1beta1RetrievalMetadata
35921
36214
  include Google::Apis::Core::Hashable
35922
36215
 
35923
- # Optional. Score indicating how likely information from Google Search could
35924
- # help answer the prompt. The score is in the range `[0, 1]`, where 0 is the
35925
- # least likely and 1 is the most likely. This score is only populated when
35926
- # Google Search grounding and dynamic retrieval is enabled. It will be compared
35927
- # 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.
35928
36222
  # Corresponds to the JSON property `googleSearchDynamicRetrievalScore`
35929
36223
  # @return [Float]
35930
36224
  attr_accessor :google_search_dynamic_retrieval_score
@@ -36889,18 +37183,18 @@ module Google
36889
37183
  end
36890
37184
  end
36891
37185
 
36892
- # 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.
36893
37188
  class GoogleCloudAiplatformV1beta1SafetyRating
36894
37189
  include Google::Apis::Core::Hashable
36895
37190
 
36896
- # Output only. Indicates whether the content was filtered out because of this
36897
- # rating.
37191
+ # Output only. Indicates whether the content was blocked because of this rating.
36898
37192
  # Corresponds to the JSON property `blocked`
36899
37193
  # @return [Boolean]
36900
37194
  attr_accessor :blocked
36901
37195
  alias_method :blocked?, :blocked
36902
37196
 
36903
- # Output only. Harm category.
37197
+ # Output only. The harm category of this rating.
36904
37198
  # Corresponds to the JSON property `category`
36905
37199
  # @return [String]
36906
37200
  attr_accessor :category
@@ -36912,22 +37206,22 @@ module Google
36912
37206
  # @return [String]
36913
37207
  attr_accessor :overwritten_threshold
36914
37208
 
36915
- # Output only. Harm probability levels in the content.
37209
+ # Output only. The probability of harm for this category.
36916
37210
  # Corresponds to the JSON property `probability`
36917
37211
  # @return [String]
36918
37212
  attr_accessor :probability
36919
37213
 
36920
- # Output only. Harm probability score.
37214
+ # Output only. The probability score of harm for this category.
36921
37215
  # Corresponds to the JSON property `probabilityScore`
36922
37216
  # @return [Float]
36923
37217
  attr_accessor :probability_score
36924
37218
 
36925
- # Output only. Harm severity levels in the content.
37219
+ # Output only. The severity of harm for this category.
36926
37220
  # Corresponds to the JSON property `severity`
36927
37221
  # @return [String]
36928
37222
  attr_accessor :severity
36929
37223
 
36930
- # Output only. Harm severity score.
37224
+ # Output only. The severity score of harm for this category.
36931
37225
  # Corresponds to the JSON property `severityScore`
36932
37226
  # @return [Float]
36933
37227
  attr_accessor :severity_score
@@ -36979,22 +37273,24 @@ module Google
36979
37273
  end
36980
37274
  end
36981
37275
 
36982
- # 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.
36983
37278
  class GoogleCloudAiplatformV1beta1SafetySetting
36984
37279
  include Google::Apis::Core::Hashable
36985
37280
 
36986
- # Required. Harm category.
37281
+ # Required. The harm category to be blocked.
36987
37282
  # Corresponds to the JSON property `category`
36988
37283
  # @return [String]
36989
37284
  attr_accessor :category
36990
37285
 
36991
- # Optional. Specify if the threshold is used for probability or severity score.
36992
- # 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.
36993
37288
  # Corresponds to the JSON property `method`
36994
37289
  # @return [String]
36995
37290
  attr_accessor :method_prop
36996
37291
 
36997
- # 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.
36998
37294
  # Corresponds to the JSON property `threshold`
36999
37295
  # @return [String]
37000
37296
  attr_accessor :threshold
@@ -40619,7 +40915,9 @@ module Google
40619
40915
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
40620
40916
  attr_accessor :contents
40621
40917
 
40622
- # 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.
40623
40921
  # Corresponds to the JSON property `generationConfig`
40624
40922
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
40625
40923
  attr_accessor :generation_config
@@ -40635,10 +40933,9 @@ module Google
40635
40933
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
40636
40934
  attr_accessor :safety_settings
40637
40935
 
40638
- # The base structured datatype containing multi-part content of a message. A `
40639
- # Content` includes a `role` field designating the producer of the `Content` and
40640
- # a `parts` field containing multi-part data that contains the content of the
40641
- # 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.
40642
40939
  # Corresponds to the JSON property `systemInstruction`
40643
40940
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
40644
40941
  attr_accessor :system_instruction
@@ -40720,10 +41017,9 @@ module Google
40720
41017
  class GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt
40721
41018
  include Google::Apis::Core::Hashable
40722
41019
 
40723
- # The base structured datatype containing multi-part content of a message. A `
40724
- # Content` includes a `role` field designating the producer of the `Content` and
40725
- # a `parts` field containing multi-part data that contains the content of the
40726
- # 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.
40727
41023
  # Corresponds to the JSON property `context`
40728
41024
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
40729
41025
  attr_accessor :context
@@ -44493,17 +44789,23 @@ module Google
44493
44789
  end
44494
44790
  end
44495
44791
 
44496
- # 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.
44497
44796
  class GoogleCloudAiplatformV1beta1SearchEntryPoint
44498
44797
  include Google::Apis::Core::Hashable
44499
44798
 
44500
- # Optional. Web content snippet that can be embedded in a web page or an app
44501
- # 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.
44502
44802
  # Corresponds to the JSON property `renderedContent`
44503
44803
  # @return [String]
44504
44804
  attr_accessor :rendered_content
44505
44805
 
44506
- # 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.
44507
44809
  # Corresponds to the JSON property `sdkBlob`
44508
44810
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
44509
44811
  # @return [String]
@@ -45122,28 +45424,31 @@ module Google
45122
45424
  end
45123
45425
  end
45124
45426
 
45125
- # Segment of the content.
45427
+ # A segment of the content.
45126
45428
  class GoogleCloudAiplatformV1beta1Segment
45127
45429
  include Google::Apis::Core::Hashable
45128
45430
 
45129
- # Output only. End index in the given Part, measured in bytes. Offset from the
45130
- # 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.
45131
45434
  # Corresponds to the JSON property `endIndex`
45132
45435
  # @return [Fixnum]
45133
45436
  attr_accessor :end_index
45134
45437
 
45135
- # 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.
45136
45440
  # Corresponds to the JSON property `partIndex`
45137
45441
  # @return [Fixnum]
45138
45442
  attr_accessor :part_index
45139
45443
 
45140
- # Output only. Start index in the given Part, measured in bytes. Offset from the
45141
- # 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.
45142
45447
  # Corresponds to the JSON property `startIndex`
45143
45448
  # @return [Fixnum]
45144
45449
  attr_accessor :start_index
45145
45450
 
45146
- # Output only. The text corresponding to the segment from the response.
45451
+ # Output only. The text of the segment.
45147
45452
  # Corresponds to the JSON property `text`
45148
45453
  # @return [String]
45149
45454
  attr_accessor :text
@@ -45216,6 +45521,15 @@ module Google
45216
45521
  # @return [String]
45217
45522
  attr_accessor :expire_time
45218
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
+
45219
45533
  # Identifier. The resource name of the session. Format: 'projects/`project`/
45220
45534
  # locations/`location`/reasoningEngines/`reasoning_engine`/sessions/`session`'.
45221
45535
  # Corresponds to the JSON property `name`
@@ -45251,6 +45565,7 @@ module Google
45251
45565
  @create_time = args[:create_time] if args.key?(:create_time)
45252
45566
  @display_name = args[:display_name] if args.key?(:display_name)
45253
45567
  @expire_time = args[:expire_time] if args.key?(:expire_time)
45568
+ @labels = args[:labels] if args.key?(:labels)
45254
45569
  @name = args[:name] if args.key?(:name)
45255
45570
  @session_state = args[:session_state] if args.key?(:session_state)
45256
45571
  @ttl = args[:ttl] if args.key?(:ttl)
@@ -45273,10 +45588,9 @@ module Google
45273
45588
  # @return [String]
45274
45589
  attr_accessor :author
45275
45590
 
45276
- # The base structured datatype containing multi-part content of a message. A `
45277
- # Content` includes a `role` field designating the producer of the `Content` and
45278
- # a `parts` field containing multi-part data that contains the content of the
45279
- # 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.
45280
45594
  # Corresponds to the JSON property `content`
45281
45595
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
45282
45596
  attr_accessor :content
@@ -45588,7 +45902,7 @@ module Google
45588
45902
  end
45589
45903
  end
45590
45904
 
45591
- # Configuration for a single speaker in a multi speaker setup.
45905
+ # Configuration for a single speaker in a multi-speaker setup.
45592
45906
  class GoogleCloudAiplatformV1beta1SpeakerVoiceConfig
45593
45907
  include Google::Apis::Core::Hashable
45594
45908
 
@@ -45598,7 +45912,7 @@ module Google
45598
45912
  # @return [String]
45599
45913
  attr_accessor :speaker
45600
45914
 
45601
- # The configuration for the voice to use.
45915
+ # Configuration for a voice.
45602
45916
  # Corresponds to the JSON property `voiceConfig`
45603
45917
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VoiceConfig]
45604
45918
  attr_accessor :voice_config
@@ -45745,22 +46059,21 @@ module Google
45745
46059
  end
45746
46060
  end
45747
46061
 
45748
- # The speech generation config.
46062
+ # Configuration for speech generation.
45749
46063
  class GoogleCloudAiplatformV1beta1SpeechConfig
45750
46064
  include Google::Apis::Core::Hashable
45751
46065
 
45752
- # 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.
45753
46067
  # Corresponds to the JSON property `languageCode`
45754
46068
  # @return [String]
45755
46069
  attr_accessor :language_code
45756
46070
 
45757
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
45758
- # to two distinct voices in a single synthesis request.
46071
+ # Configuration for a multi-speaker text-to-speech request.
45759
46072
  # Corresponds to the JSON property `multiSpeakerVoiceConfig`
45760
46073
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig]
45761
46074
  attr_accessor :multi_speaker_voice_config
45762
46075
 
45763
- # The configuration for the voice to use.
46076
+ # Configuration for a voice.
45764
46077
  # Corresponds to the JSON property `voiceConfig`
45765
46078
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VoiceConfig]
45766
46079
  attr_accessor :voice_config
@@ -47986,10 +48299,9 @@ module Google
47986
48299
  class GoogleCloudAiplatformV1beta1SyntheticField
47987
48300
  include Google::Apis::Core::Hashable
47988
48301
 
47989
- # The base structured datatype containing multi-part content of a message. A `
47990
- # Content` includes a `role` field designating the producer of the `Content` and
47991
- # a `parts` field containing multi-part data that contains the content of the
47992
- # 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.
47993
48305
  # Corresponds to the JSON property `content`
47994
48306
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
47995
48307
  attr_accessor :content
@@ -51651,11 +51963,13 @@ module Google
51651
51963
  end
51652
51964
  end
51653
51965
 
51654
- # 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.
51655
51968
  class GoogleCloudAiplatformV1beta1UrlContextMetadata
51656
51969
  include Google::Apis::Core::Hashable
51657
51970
 
51658
- # 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.
51659
51973
  # Corresponds to the JSON property `urlMetadata`
51660
51974
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UrlMetadata>]
51661
51975
  attr_accessor :url_metadata
@@ -51670,16 +51984,16 @@ module Google
51670
51984
  end
51671
51985
  end
51672
51986
 
51673
- # Context of the a single url retrieval.
51987
+ # The metadata for a single URL retrieval.
51674
51988
  class GoogleCloudAiplatformV1beta1UrlMetadata
51675
51989
  include Google::Apis::Core::Hashable
51676
51990
 
51677
- # Retrieved url by the tool.
51991
+ # The URL retrieved by the tool.
51678
51992
  # Corresponds to the JSON property `retrievedUrl`
51679
51993
  # @return [String]
51680
51994
  attr_accessor :retrieved_url
51681
51995
 
51682
- # Status of the url retrieval.
51996
+ # The status of the URL retrieval.
51683
51997
  # Corresponds to the JSON property `urlRetrievalStatus`
51684
51998
  # @return [String]
51685
51999
  attr_accessor :url_retrieval_status
@@ -52110,7 +52424,8 @@ module Google
52110
52424
  end
52111
52425
  end
52112
52426
 
52113
- # 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.
52114
52429
  class GoogleCloudAiplatformV1beta1VideoMetadata
52115
52430
  include Google::Apis::Core::Hashable
52116
52431
 
@@ -52120,7 +52435,7 @@ module Google
52120
52435
  attr_accessor :end_offset
52121
52436
 
52122
52437
  # Optional. The frame rate of the video sent to the model. If not specified, the
52123
- # 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].
52124
52439
  # Corresponds to the JSON property `fps`
52125
52440
  # @return [Float]
52126
52441
  attr_accessor :fps
@@ -52142,11 +52457,11 @@ module Google
52142
52457
  end
52143
52458
  end
52144
52459
 
52145
- # The configuration for the voice to use.
52460
+ # Configuration for a voice.
52146
52461
  class GoogleCloudAiplatformV1beta1VoiceConfig
52147
52462
  include Google::Apis::Core::Hashable
52148
52463
 
52149
- # The configuration for the prebuilt speaker to use.
52464
+ # Configuration for a prebuilt voice.
52150
52465
  # Corresponds to the JSON property `prebuiltVoiceConfig`
52151
52466
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig]
52152
52467
  attr_accessor :prebuilt_voice_config