google-apis-aiplatform_v1beta1 0.65.0 → 0.67.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
@@ -1863,7 +1871,8 @@ module Google
1863
1871
  # Required. The resource metric name. Supported metrics: * For Online Prediction:
1864
1872
  # * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `
1865
1873
  # aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.
1866
- # googleapis.com/prediction/online/request_count`
1874
+ # googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/
1875
+ # subscription/num_undelivered_messages`
1867
1876
  # Corresponds to the JSON property `metricName`
1868
1877
  # @return [String]
1869
1878
  attr_accessor :metric_name
@@ -3204,20 +3213,21 @@ module Google
3204
3213
  end
3205
3214
  end
3206
3215
 
3207
- # Content blob.
3216
+ # A content blob. A Blob contains data of a specific media type. It is used to
3217
+ # represent images, audio, and video.
3208
3218
  class GoogleCloudAiplatformV1beta1Blob
3209
3219
  include Google::Apis::Core::Hashable
3210
3220
 
3211
- # Required. Raw bytes.
3221
+ # Required. The raw bytes of the data.
3212
3222
  # Corresponds to the JSON property `data`
3213
3223
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
3214
3224
  # @return [String]
3215
3225
  attr_accessor :data
3216
3226
 
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.
3227
+ # Optional. The display name of the blob. Used to provide a label or filename to
3228
+ # distinguish blobs. This field is only returned in `PromptMessage` for prompt
3229
+ # management. It is used in the Gemini calls only when server-side tools (`
3230
+ # code_execution`, `google_search`, and `url_context`) are enabled.
3221
3231
  # Corresponds to the JSON property `displayName`
3222
3232
  # @return [String]
3223
3233
  attr_accessor :display_name
@@ -3356,10 +3366,9 @@ module Google
3356
3366
  # @return [String]
3357
3367
  attr_accessor :name
3358
3368
 
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.
3369
+ # The structured data content of a message. A Content message contains a `role`
3370
+ # field, which indicates the producer of the content, and a `parts` field, which
3371
+ # contains the multi-part data of the message.
3363
3372
  # Corresponds to the JSON property `systemInstruction`
3364
3373
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
3365
3374
  attr_accessor :system_instruction
@@ -3577,58 +3586,70 @@ module Google
3577
3586
  class GoogleCloudAiplatformV1beta1Candidate
3578
3587
  include Google::Apis::Core::Hashable
3579
3588
 
3580
- # Output only. Average log probability score of the candidate.
3589
+ # Output only. The average log probability of the tokens in this candidate. This
3590
+ # is a length-normalized score that can be used to compare the quality of
3591
+ # candidates of different lengths. A higher average log probability suggests a
3592
+ # more confident and coherent response.
3581
3593
  # Corresponds to the JSON property `avgLogprobs`
3582
3594
  # @return [Float]
3583
3595
  attr_accessor :avg_logprobs
3584
3596
 
3585
- # A collection of source attributions for a piece of content.
3597
+ # A collection of citations that apply to a piece of generated content.
3586
3598
  # Corresponds to the JSON property `citationMetadata`
3587
3599
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CitationMetadata]
3588
3600
  attr_accessor :citation_metadata
3589
3601
 
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.
3602
+ # The structured data content of a message. A Content message contains a `role`
3603
+ # field, which indicates the producer of the content, and a `parts` field, which
3604
+ # contains the multi-part data of the message.
3594
3605
  # Corresponds to the JSON property `content`
3595
3606
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
3596
3607
  attr_accessor :content
3597
3608
 
3598
- # Output only. Describes the reason the mode stopped generating tokens in more
3599
- # detail. This is only filled when `finish_reason` is set.
3609
+ # Output only. Describes the reason the model stopped generating tokens in more
3610
+ # detail. This field is returned only when `finish_reason` is set.
3600
3611
  # Corresponds to the JSON property `finishMessage`
3601
3612
  # @return [String]
3602
3613
  attr_accessor :finish_message
3603
3614
 
3604
3615
  # Output only. The reason why the model stopped generating tokens. If empty, the
3605
- # model has not stopped generating the tokens.
3616
+ # model has not stopped generating.
3606
3617
  # Corresponds to the JSON property `finishReason`
3607
3618
  # @return [String]
3608
3619
  attr_accessor :finish_reason
3609
3620
 
3610
- # Metadata returned to client when grounding is enabled.
3621
+ # Information about the sources that support the content of a response. When
3622
+ # grounding is enabled, the model returns citations for claims in the response.
3623
+ # This object contains the retrieved sources.
3611
3624
  # Corresponds to the JSON property `groundingMetadata`
3612
3625
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata]
3613
3626
  attr_accessor :grounding_metadata
3614
3627
 
3615
- # Output only. Index of the candidate.
3628
+ # Output only. The 0-based index of this candidate in the list of generated
3629
+ # responses. This is useful for distinguishing between multiple candidates when `
3630
+ # candidate_count` > 1.
3616
3631
  # Corresponds to the JSON property `index`
3617
3632
  # @return [Fixnum]
3618
3633
  attr_accessor :index
3619
3634
 
3620
- # Logprobs Result
3635
+ # The log probabilities of the tokens generated by the model. This is useful for
3636
+ # understanding the model's confidence in its predictions and for debugging. For
3637
+ # example, you can use log probabilities to identify when the model is making a
3638
+ # less confident prediction or to explore alternative responses that the model
3639
+ # considered. A low log probability can also indicate that the model is "
3640
+ # hallucinating" or generating factually incorrect information.
3621
3641
  # Corresponds to the JSON property `logprobsResult`
3622
3642
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResult]
3623
3643
  attr_accessor :logprobs_result
3624
3644
 
3625
- # Output only. List of ratings for the safety of a response candidate. There is
3626
- # at most one rating per category.
3645
+ # Output only. A list of ratings for the safety of a response candidate. There
3646
+ # is at most one rating per category.
3627
3647
  # Corresponds to the JSON property `safetyRatings`
3628
3648
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetyRating>]
3629
3649
  attr_accessor :safety_ratings
3630
3650
 
3631
- # Metadata related to url context retrieval tool.
3651
+ # Metadata returned when the model uses the `url_context` tool to get
3652
+ # information from a user-provided URL.
3632
3653
  # Corresponds to the JSON property `urlContextMetadata`
3633
3654
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UrlContextMetadata]
3634
3655
  attr_accessor :url_context_metadata
@@ -3891,16 +3912,16 @@ module Google
3891
3912
  end
3892
3913
  end
3893
3914
 
3894
- # Source attributions for content.
3915
+ # A citation for a piece of generatedcontent.
3895
3916
  class GoogleCloudAiplatformV1beta1Citation
3896
3917
  include Google::Apis::Core::Hashable
3897
3918
 
3898
- # Output only. End index into the content.
3919
+ # Output only. The end index of the citation in the content.
3899
3920
  # Corresponds to the JSON property `endIndex`
3900
3921
  # @return [Fixnum]
3901
3922
  attr_accessor :end_index
3902
3923
 
3903
- # Output only. License of the attribution.
3924
+ # Output only. The license of the source of the citation.
3904
3925
  # Corresponds to the JSON property `license`
3905
3926
  # @return [String]
3906
3927
  attr_accessor :license
@@ -3917,17 +3938,17 @@ module Google
3917
3938
  # @return [Google::Apis::AiplatformV1beta1::GoogleTypeDate]
3918
3939
  attr_accessor :publication_date
3919
3940
 
3920
- # Output only. Start index into the content.
3941
+ # Output only. The start index of the citation in the content.
3921
3942
  # Corresponds to the JSON property `startIndex`
3922
3943
  # @return [Fixnum]
3923
3944
  attr_accessor :start_index
3924
3945
 
3925
- # Output only. Title of the attribution.
3946
+ # Output only. The title of the source of the citation.
3926
3947
  # Corresponds to the JSON property `title`
3927
3948
  # @return [String]
3928
3949
  attr_accessor :title
3929
3950
 
3930
- # Output only. Url reference of the attribution.
3951
+ # Output only. The URI of the source of the citation.
3931
3952
  # Corresponds to the JSON property `uri`
3932
3953
  # @return [String]
3933
3954
  attr_accessor :uri
@@ -3947,11 +3968,11 @@ module Google
3947
3968
  end
3948
3969
  end
3949
3970
 
3950
- # A collection of source attributions for a piece of content.
3971
+ # A collection of citations that apply to a piece of generated content.
3951
3972
  class GoogleCloudAiplatformV1beta1CitationMetadata
3952
3973
  include Google::Apis::Core::Hashable
3953
3974
 
3954
- # Output only. List of citations.
3975
+ # Output only. A list of citations for the content.
3955
3976
  # Corresponds to the JSON property `citations`
3956
3977
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Citation>]
3957
3978
  attr_accessor :citations
@@ -4479,22 +4500,21 @@ module Google
4479
4500
  end
4480
4501
  end
4481
4502
 
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.
4503
+ # The structured data content of a message. A Content message contains a `role`
4504
+ # field, which indicates the producer of the content, and a `parts` field, which
4505
+ # contains the multi-part data of the message.
4486
4506
  class GoogleCloudAiplatformV1beta1Content
4487
4507
  include Google::Apis::Core::Hashable
4488
4508
 
4489
- # Required. Ordered `Parts` that constitute a single message. Parts may have
4490
- # different IANA MIME types.
4509
+ # Required. A list of Part objects that make up a single message. Parts of a
4510
+ # message can have different MIME types. A Content message must have at least
4511
+ # one Part.
4491
4512
  # Corresponds to the JSON property `parts`
4492
4513
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Part>]
4493
4514
  attr_accessor :parts
4494
4515
 
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.
4516
+ # Optional. The producer of the content. Must be either 'user' or 'model'. If
4517
+ # not set, the service will default to 'user'.
4498
4518
  # Corresponds to the JSON property `role`
4499
4519
  # @return [String]
4500
4520
  attr_accessor :role
@@ -4580,10 +4600,9 @@ module Google
4580
4600
  class GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent
4581
4601
  include Google::Apis::Core::Hashable
4582
4602
 
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.
4603
+ # The structured data content of a message. A Content message contains a `role`
4604
+ # field, which indicates the producer of the content, and a `parts` field, which
4605
+ # contains the multi-part data of the message.
4587
4606
  # Corresponds to the JSON property `content`
4588
4607
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4589
4608
  attr_accessor :content
@@ -4807,10 +4826,9 @@ module Google
4807
4826
  class GoogleCloudAiplatformV1beta1CorroborateContentRequest
4808
4827
  include Google::Apis::Core::Hashable
4809
4828
 
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.
4829
+ # The structured data content of a message. A Content message contains a `role`
4830
+ # field, which indicates the producer of the content, and a `parts` field, which
4831
+ # contains the multi-part data of the message.
4814
4832
  # Corresponds to the JSON property `content`
4815
4833
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4816
4834
  attr_accessor :content
@@ -4893,7 +4911,9 @@ module Google
4893
4911
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
4894
4912
  attr_accessor :contents
4895
4913
 
4896
- # Generation config.
4914
+ # Configuration for content generation. This message contains all the parameters
4915
+ # that control how the model generates content. It allows you to influence the
4916
+ # randomness, length, and structure of the output.
4897
4917
  # Corresponds to the JSON property `generationConfig`
4898
4918
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
4899
4919
  attr_accessor :generation_config
@@ -4910,10 +4930,9 @@ module Google
4910
4930
  # @return [String]
4911
4931
  attr_accessor :model
4912
4932
 
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.
4933
+ # The structured data content of a message. A Content message contains a `role`
4934
+ # field, which indicates the producer of the content, and a `parts` field, which
4935
+ # contains the multi-part data of the message.
4917
4936
  # Corresponds to the JSON property `systemInstruction`
4918
4937
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
4919
4938
  attr_accessor :system_instruction
@@ -5698,6 +5717,56 @@ module Google
5698
5717
  end
5699
5718
  end
5700
5719
 
5720
+ # Result for custom code execution metric.
5721
+ class GoogleCloudAiplatformV1beta1CustomCodeExecutionResult
5722
+ include Google::Apis::Core::Hashable
5723
+
5724
+ # Output only. Custom code execution score.
5725
+ # Corresponds to the JSON property `score`
5726
+ # @return [Float]
5727
+ attr_accessor :score
5728
+
5729
+ def initialize(**args)
5730
+ update!(**args)
5731
+ end
5732
+
5733
+ # Update properties of this object
5734
+ def update!(**args)
5735
+ @score = args[:score] if args.key?(:score)
5736
+ end
5737
+ end
5738
+
5739
+ # Specificies a metric that is populated by evaluating user-defined Python code.
5740
+ class GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec
5741
+ include Google::Apis::Core::Hashable
5742
+
5743
+ # Required. Python function. Expected user to define the following function, e.g.
5744
+ # : def evaluate(instance: dict[str, Any]) -> float: Please include this
5745
+ # function signature in the code snippet. Instance is the evaluation instance,
5746
+ # any fields populated in the instance are available to the function as instance[
5747
+ # field_name]. Example: Example input: ``` instance= EvaluationInstance(
5748
+ # response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=
5749
+ # EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` `
5750
+ # 'response': `'text': 'The answer is 4.'`, 'reference': `'text': '4'` ` ```
5751
+ # Example python function: ``` def evaluate(instance: dict[str, Any]) -> float:
5752
+ # if instance'response' == instance'reference': return 1.0 return 0.0 ```
5753
+ # CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC)
5754
+ # and Tuning Evaluation. Each line in the input jsonl file will be converted to
5755
+ # dict[str, Any] and passed to the evaluation function.
5756
+ # Corresponds to the JSON property `evaluationFunction`
5757
+ # @return [String]
5758
+ attr_accessor :evaluation_function
5759
+
5760
+ def initialize(**args)
5761
+ update!(**args)
5762
+ end
5763
+
5764
+ # Update properties of this object
5765
+ def update!(**args)
5766
+ @evaluation_function = args[:evaluation_function] if args.key?(:evaluation_function)
5767
+ end
5768
+ end
5769
+
5701
5770
  # Represents a job that runs custom workloads such as a Docker container or a
5702
5771
  # Python package. A CustomJob can have multiple worker pools and each worker
5703
5772
  # pool can have its own machine and input spec. A CustomJob will be cleaned up
@@ -8427,10 +8496,9 @@ module Google
8427
8496
  attr_accessor :auto_truncate
8428
8497
  alias_method :auto_truncate?, :auto_truncate
8429
8498
 
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.
8499
+ # The structured data content of a message. A Content message contains a `role`
8500
+ # field, which indicates the producer of the content, and a `parts` field, which
8501
+ # contains the multi-part data of the message.
8434
8502
  # Corresponds to the JSON property `content`
8435
8503
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
8436
8504
  attr_accessor :content
@@ -9845,11 +9913,6 @@ module Google
9845
9913
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents]
9846
9914
  attr_accessor :events
9847
9915
 
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
9916
  # Represents a list of tools for an agent.
9854
9917
  # Corresponds to the JSON property `tools`
9855
9918
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools]
@@ -9875,7 +9938,6 @@ module Google
9875
9938
  @agent_config = args[:agent_config] if args.key?(:agent_config)
9876
9939
  @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction)
9877
9940
  @events = args[:events] if args.key?(:events)
9878
- @events_text = args[:events_text] if args.key?(:events_text)
9879
9941
  @tools = args[:tools] if args.key?(:tools)
9880
9942
  @tools_text = args[:tools_text] if args.key?(:tools_text)
9881
9943
  end
@@ -10456,7 +10518,9 @@ module Google
10456
10518
  # @return [String]
10457
10519
  attr_accessor :autorater_model
10458
10520
 
10459
- # Generation config.
10521
+ # Configuration for content generation. This message contains all the parameters
10522
+ # that control how the model generates content. It allows you to influence the
10523
+ # randomness, length, and structure of the output.
10460
10524
  # Corresponds to the JSON property `generationConfig`
10461
10525
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
10462
10526
  attr_accessor :generation_config
@@ -10541,7 +10605,9 @@ module Google
10541
10605
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig]
10542
10606
  attr_accessor :agent_config
10543
10607
 
10544
- # Generation config.
10608
+ # Configuration for content generation. This message contains all the parameters
10609
+ # that control how the model generates content. It allows you to influence the
10610
+ # randomness, length, and structure of the output.
10545
10611
  # Corresponds to the JSON property `generationConfig`
10546
10612
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
10547
10613
  attr_accessor :generation_config
@@ -10570,10 +10636,9 @@ module Google
10570
10636
  class GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig
10571
10637
  include Google::Apis::Core::Hashable
10572
10638
 
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.
10639
+ # The structured data content of a message. A Content message contains a `role`
10640
+ # field, which indicates the producer of the content, and a `parts` field, which
10641
+ # contains the multi-part data of the message.
10577
10642
  # Corresponds to the JSON property `developerInstruction`
10578
10643
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
10579
10644
  attr_accessor :developer_instruction
@@ -10997,7 +11062,9 @@ module Google
10997
11062
  # @return [Hash<String,Object>]
10998
11063
  attr_accessor :custom_metadata
10999
11064
 
11000
- # Metadata returned to client when grounding is enabled.
11065
+ # Information about the sources that support the content of a response. When
11066
+ # grounding is enabled, the model returns citations for claims in the response.
11067
+ # This object contains the retrieved sources.
11001
11068
  # Corresponds to the JSON property `groundingMetadata`
11002
11069
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata]
11003
11070
  attr_accessor :grounding_metadata
@@ -11460,6 +11527,44 @@ module Google
11460
11527
  end
11461
11528
  end
11462
11529
 
11530
+ # Request message for SandboxEnvironmentExecutionService.ExecuteCode.
11531
+ class GoogleCloudAiplatformV1beta1ExecuteCodeRequest
11532
+ include Google::Apis::Core::Hashable
11533
+
11534
+ # Required. The inputs used for the stateless code execution.
11535
+ # Corresponds to the JSON property `inputs`
11536
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk>]
11537
+ attr_accessor :inputs
11538
+
11539
+ def initialize(**args)
11540
+ update!(**args)
11541
+ end
11542
+
11543
+ # Update properties of this object
11544
+ def update!(**args)
11545
+ @inputs = args[:inputs] if args.key?(:inputs)
11546
+ end
11547
+ end
11548
+
11549
+ # Response message for SandboxEnvironmentExecutionService.ExecuteCode.
11550
+ class GoogleCloudAiplatformV1beta1ExecuteCodeResponse
11551
+ include Google::Apis::Core::Hashable
11552
+
11553
+ # The outputs from the sandbox environment.
11554
+ # Corresponds to the JSON property `outputs`
11555
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk>]
11556
+ attr_accessor :outputs
11557
+
11558
+ def initialize(**args)
11559
+ update!(**args)
11560
+ end
11561
+
11562
+ # Update properties of this object
11563
+ def update!(**args)
11564
+ @outputs = args[:outputs] if args.key?(:outputs)
11565
+ end
11566
+ end
11567
+
11463
11568
  # Request message for ExtensionExecutionService.ExecuteExtension.
11464
11569
  class GoogleCloudAiplatformV1beta1ExecuteExtensionRequest
11465
11570
  include Google::Apis::Core::Hashable
@@ -15769,20 +15874,21 @@ module Google
15769
15874
  end
15770
15875
  end
15771
15876
 
15772
- # URI based data.
15877
+ # URI-based data. A FileData message contains a URI pointing to data of a
15878
+ # specific media type. It is used to represent images, audio, and video stored
15879
+ # in Google Cloud Storage.
15773
15880
  class GoogleCloudAiplatformV1beta1FileData
15774
15881
  include Google::Apis::Core::Hashable
15775
15882
 
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.
15883
+ # Optional. The display name of the file. Used to provide a label or filename to
15884
+ # distinguish files. This field is only returned in `PromptMessage` for prompt
15885
+ # management. It is used in the Gemini calls only when server side tools (`
15886
+ # code_execution`, `google_search`, and `url_context`) are enabled.
15781
15887
  # Corresponds to the JSON property `displayName`
15782
15888
  # @return [String]
15783
15889
  attr_accessor :display_name
15784
15890
 
15785
- # Required. URI.
15891
+ # Required. The URI of the file in Google Cloud Storage.
15786
15892
  # Corresponds to the JSON property `fileUri`
15787
15893
  # @return [String]
15788
15894
  attr_accessor :file_uri
@@ -16719,7 +16825,9 @@ module Google
16719
16825
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
16720
16826
  attr_accessor :contents
16721
16827
 
16722
- # Generation config.
16828
+ # Configuration for content generation. This message contains all the parameters
16829
+ # that control how the model generates content. It allows you to influence the
16830
+ # randomness, length, and structure of the output.
16723
16831
  # Corresponds to the JSON property `generationConfig`
16724
16832
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
16725
16833
  attr_accessor :generation_config
@@ -16747,10 +16855,9 @@ module Google
16747
16855
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
16748
16856
  attr_accessor :safety_settings
16749
16857
 
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.
16858
+ # The structured data content of a message. A Content message contains a `role`
16859
+ # field, which indicates the producer of the content, and a `parts` field, which
16860
+ # contains the multi-part data of the message.
16754
16861
  # Corresponds to the JSON property `systemInstruction`
16755
16862
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
16756
16863
  attr_accessor :system_instruction
@@ -16815,10 +16922,9 @@ module Google
16815
16922
  class GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion
16816
16923
  include Google::Apis::Core::Hashable
16817
16924
 
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.
16925
+ # The structured data content of a message. A Content message contains a `role`
16926
+ # field, which indicates the producer of the content, and a `parts` field, which
16927
+ # contains the multi-part data of the message.
16822
16928
  # Corresponds to the JSON property `completion`
16823
16929
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
16824
16930
  attr_accessor :completion
@@ -17011,7 +17117,9 @@ module Google
17011
17117
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
17012
17118
  attr_accessor :contents
17013
17119
 
17014
- # Generation config.
17120
+ # Configuration for content generation. This message contains all the parameters
17121
+ # that control how the model generates content. It allows you to influence the
17122
+ # randomness, length, and structure of the output.
17015
17123
  # Corresponds to the JSON property `generationConfig`
17016
17124
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
17017
17125
  attr_accessor :generation_config
@@ -17025,7 +17133,10 @@ module Google
17025
17133
  # @return [Hash<String,String>]
17026
17134
  attr_accessor :labels
17027
17135
 
17028
- # Configuration for Model Armor integrations of prompt and responses.
17136
+ # Configuration for Model Armor. Model Armor is a Google Cloud service that
17137
+ # provides safety and security filtering for prompts and responses. It helps
17138
+ # protect your AI applications from risks such as harmful content, sensitive
17139
+ # data leakage, and prompt injection attacks.
17029
17140
  # Corresponds to the JSON property `modelArmorConfig`
17030
17141
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelArmorConfig]
17031
17142
  attr_accessor :model_armor_config
@@ -17036,10 +17147,9 @@ module Google
17036
17147
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
17037
17148
  attr_accessor :safety_settings
17038
17149
 
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.
17150
+ # The structured data content of a message. A Content message contains a `role`
17151
+ # field, which indicates the producer of the content, and a `parts` field, which
17152
+ # contains the multi-part data of the message.
17043
17153
  # Corresponds to the JSON property `systemInstruction`
17044
17154
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
17045
17155
  attr_accessor :system_instruction
@@ -17454,10 +17564,9 @@ module Google
17454
17564
  class GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSourceEvent
17455
17565
  include Google::Apis::Core::Hashable
17456
17566
 
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.
17567
+ # The structured data content of a message. A Content message contains a `role`
17568
+ # field, which indicates the producer of the content, and a `parts` field, which
17569
+ # contains the multi-part data of the message.
17461
17570
  # Corresponds to the JSON property `content`
17462
17571
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
17463
17572
  attr_accessor :content
@@ -17682,50 +17791,72 @@ module Google
17682
17791
  end
17683
17792
  end
17684
17793
 
17685
- # Generation config.
17794
+ # Configuration for content generation. This message contains all the parameters
17795
+ # that control how the model generates content. It allows you to influence the
17796
+ # randomness, length, and structure of the output.
17686
17797
  class GoogleCloudAiplatformV1beta1GenerationConfig
17687
17798
  include Google::Apis::Core::Hashable
17688
17799
 
17689
- # Optional. If enabled, audio timestamp will be included in the request to the
17690
- # model.
17800
+ # Optional. If enabled, audio timestamps will be included in the request to the
17801
+ # model. This can be useful for synchronizing audio with other modalities in the
17802
+ # response.
17691
17803
  # Corresponds to the JSON property `audioTimestamp`
17692
17804
  # @return [Boolean]
17693
17805
  attr_accessor :audio_timestamp
17694
17806
  alias_method :audio_timestamp?, :audio_timestamp
17695
17807
 
17696
- # Optional. Number of candidates to generate.
17808
+ # Optional. The number of candidate responses to generate. A higher `
17809
+ # candidate_count` can provide more options to choose from, but it also consumes
17810
+ # more resources. This can be useful for generating a variety of responses and
17811
+ # selecting the best one.
17697
17812
  # Corresponds to the JSON property `candidateCount`
17698
17813
  # @return [Fixnum]
17699
17814
  attr_accessor :candidate_count
17700
17815
 
17701
17816
  # Optional. If enabled, the model will detect emotions and adapt its responses
17702
- # accordingly.
17817
+ # accordingly. For example, if the model detects that the user is frustrated, it
17818
+ # may provide a more empathetic response.
17703
17819
  # Corresponds to the JSON property `enableAffectiveDialog`
17704
17820
  # @return [Boolean]
17705
17821
  attr_accessor :enable_affective_dialog
17706
17822
  alias_method :enable_affective_dialog?, :enable_affective_dialog
17707
17823
 
17708
- # Optional. Frequency penalties.
17824
+ # Optional. Penalizes tokens based on their frequency in the generated text. A
17825
+ # positive value helps to reduce the repetition of words and phrases. Valid
17826
+ # values can range from [-2.0, 2.0].
17709
17827
  # Corresponds to the JSON property `frequencyPenalty`
17710
17828
  # @return [Float]
17711
17829
  attr_accessor :frequency_penalty
17712
17830
 
17713
- # Config for image generation features.
17831
+ # Configuration for image generation. This message allows you to control various
17832
+ # aspects of image generation, such as the output format, aspect ratio, and
17833
+ # whether the model can generate images of people.
17714
17834
  # Corresponds to the JSON property `imageConfig`
17715
17835
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImageConfig]
17716
17836
  attr_accessor :image_config
17717
17837
 
17718
- # Optional. Logit probabilities.
17838
+ # Optional. The number of top log probabilities to return for each token. This
17839
+ # can be used to see which other tokens were considered likely candidates for a
17840
+ # given position. A higher value will return more options, but it will also
17841
+ # increase the size of the response.
17719
17842
  # Corresponds to the JSON property `logprobs`
17720
17843
  # @return [Fixnum]
17721
17844
  attr_accessor :logprobs
17722
17845
 
17723
- # Optional. The maximum number of output tokens to generate per message.
17846
+ # Optional. The maximum number of tokens to generate in the response. A token is
17847
+ # approximately four characters. The default value varies by model. This
17848
+ # parameter can be used to control the length of the generated text and prevent
17849
+ # overly long responses.
17724
17850
  # Corresponds to the JSON property `maxOutputTokens`
17725
17851
  # @return [Fixnum]
17726
17852
  attr_accessor :max_output_tokens
17727
17853
 
17728
- # Optional. If specified, the media resolution specified will be used.
17854
+ # Optional. The token resolution at which input media content is sampled. This
17855
+ # is used to control the trade-off between the quality of the response and the
17856
+ # number of tokens used to represent the media. A higher resolution allows the
17857
+ # model to perceive more detail, which can lead to a more nuanced response, but
17858
+ # it will also use more tokens. This does not affect the image dimensions sent
17859
+ # to the model.
17729
17860
  # Corresponds to the JSON property `mediaResolution`
17730
17861
  # @return [String]
17731
17862
  attr_accessor :media_resolution
@@ -17735,44 +17866,41 @@ module Google
17735
17866
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigModelConfig]
17736
17867
  attr_accessor :model_config
17737
17868
 
17738
- # Optional. Positive penalties.
17869
+ # Optional. Penalizes tokens that have already appeared in the generated text. A
17870
+ # positive value encourages the model to generate more diverse and less
17871
+ # repetitive text. Valid values can range from [-2.0, 2.0].
17739
17872
  # Corresponds to the JSON property `presencePenalty`
17740
17873
  # @return [Float]
17741
17874
  attr_accessor :presence_penalty
17742
17875
 
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.
17876
+ # Optional. When this field is set, response_schema must be omitted and
17877
+ # response_mime_type must be set to `application/json`.
17756
17878
  # Corresponds to the JSON property `responseJsonSchema`
17757
17879
  # @return [Object]
17758
17880
  attr_accessor :response_json_schema
17759
17881
 
17760
- # Optional. If true, export the logprobs results in response.
17882
+ # Optional. If set to true, the log probabilities of the output tokens are
17883
+ # returned. Log probabilities are the logarithm of the probability of a token
17884
+ # appearing in the output. A higher log probability means the token is more
17885
+ # likely to be generated. This can be useful for analyzing the model's
17886
+ # confidence in its own output and for debugging.
17761
17887
  # Corresponds to the JSON property `responseLogprobs`
17762
17888
  # @return [Boolean]
17763
17889
  attr_accessor :response_logprobs
17764
17890
  alias_method :response_logprobs?, :response_logprobs
17765
17891
 
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
17892
+ # Optional. The IANA standard MIME type of the response. The model will generate
17893
+ # output that conforms to this MIME type. Supported values include 'text/plain' (
17894
+ # default) and 'application/json'. The model needs to be prompted to output the
17769
17895
  # appropriate response type, otherwise the behavior is undefined. This is a
17770
17896
  # preview feature.
17771
17897
  # Corresponds to the JSON property `responseMimeType`
17772
17898
  # @return [String]
17773
17899
  attr_accessor :response_mime_type
17774
17900
 
17775
- # Optional. The modalities of the response.
17901
+ # Optional. The modalities of the response. The model will generate a response
17902
+ # that includes all the specified modalities. For example, if this is set to `[
17903
+ # TEXT, IMAGE]`, the response will include both text and an image.
17776
17904
  # Corresponds to the JSON property `responseModalities`
17777
17905
  # @return [Array<String>]
17778
17906
  attr_accessor :response_modalities
@@ -17784,42 +17912,68 @@ module Google
17784
17912
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema]
17785
17913
  attr_accessor :response_schema
17786
17914
 
17787
- # The configuration for routing the request to a specific model.
17915
+ # The configuration for routing the request to a specific model. This can be
17916
+ # used to control which model is used for the generation, either automatically
17917
+ # or by specifying a model name.
17788
17918
  # Corresponds to the JSON property `routingConfig`
17789
17919
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig]
17790
17920
  attr_accessor :routing_config
17791
17921
 
17792
- # Optional. Seed.
17922
+ # Optional. A seed for the random number generator. By setting a seed, you can
17923
+ # make the model's output mostly deterministic. For a given prompt and
17924
+ # parameters (like temperature, top_p, etc.), the model will produce the same
17925
+ # response every time. However, it's not a guaranteed absolute deterministic
17926
+ # behavior. This is different from parameters like `temperature`, which control
17927
+ # the *level* of randomness. `seed` ensures that the "random" choices the model
17928
+ # makes are the same on every run, making it essential for testing and ensuring
17929
+ # reproducible results.
17793
17930
  # Corresponds to the JSON property `seed`
17794
17931
  # @return [Fixnum]
17795
17932
  attr_accessor :seed
17796
17933
 
17797
- # The speech generation config.
17934
+ # Configuration for speech generation.
17798
17935
  # Corresponds to the JSON property `speechConfig`
17799
17936
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpeechConfig]
17800
17937
  attr_accessor :speech_config
17801
17938
 
17802
- # Optional. Stop sequences.
17939
+ # Optional. A list of character sequences that will stop the model from
17940
+ # generating further tokens. If a stop sequence is generated, the output will
17941
+ # end at that point. This is useful for controlling the length and structure of
17942
+ # the output. For example, you can use ["\n", "###"] to stop generation at a new
17943
+ # line or a specific marker.
17803
17944
  # Corresponds to the JSON property `stopSequences`
17804
17945
  # @return [Array<String>]
17805
17946
  attr_accessor :stop_sequences
17806
17947
 
17807
- # Optional. Controls the randomness of predictions.
17948
+ # Optional. Controls the randomness of the output. A higher temperature results
17949
+ # in more creative and diverse responses, while a lower temperature makes the
17950
+ # output more predictable and focused. The valid range is (0.0, 2.0].
17808
17951
  # Corresponds to the JSON property `temperature`
17809
17952
  # @return [Float]
17810
17953
  attr_accessor :temperature
17811
17954
 
17812
- # Config for thinking features.
17955
+ # Configuration for the model's thinking features. "Thinking" is a process where
17956
+ # the model breaks down a complex task into smaller, manageable steps. This
17957
+ # allows the model to reason about the task, plan its approach, and execute the
17958
+ # plan to generate a high-quality response.
17813
17959
  # Corresponds to the JSON property `thinkingConfig`
17814
17960
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig]
17815
17961
  attr_accessor :thinking_config
17816
17962
 
17817
- # Optional. If specified, top-k sampling will be used.
17963
+ # Optional. Specifies the top-k sampling threshold. The model considers only the
17964
+ # top k most probable tokens for the next token. This can be useful for
17965
+ # generating more coherent and less random text. For example, a `top_k` of 40
17966
+ # means the model will choose the next word from the 40 most likely words.
17818
17967
  # Corresponds to the JSON property `topK`
17819
17968
  # @return [Float]
17820
17969
  attr_accessor :top_k
17821
17970
 
17822
- # Optional. If specified, nucleus sampling will be used.
17971
+ # Optional. Specifies the nucleus sampling threshold. The model considers only
17972
+ # the smallest set of tokens whose cumulative probability is at least `top_p`.
17973
+ # This helps generate more diverse and less repetitive responses. For example, a
17974
+ # `top_p` of 0.9 means the model considers tokens until the cumulative
17975
+ # probability of the tokens to select from reaches 0.9. It's recommended to
17976
+ # adjust either temperature or `top_p`, but not both.
17823
17977
  # Corresponds to the JSON property `topP`
17824
17978
  # @return [Float]
17825
17979
  attr_accessor :top_p
@@ -17875,17 +18029,21 @@ module Google
17875
18029
  end
17876
18030
  end
17877
18031
 
17878
- # The configuration for routing the request to a specific model.
18032
+ # The configuration for routing the request to a specific model. This can be
18033
+ # used to control which model is used for the generation, either automatically
18034
+ # or by specifying a model name.
17879
18035
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig
17880
18036
  include Google::Apis::Core::Hashable
17881
18037
 
17882
- # When automated routing is specified, the routing will be determined by the
17883
- # pretrained routing model and customer provided model routing preference.
18038
+ # The configuration for automated routing. When automated routing is specified,
18039
+ # the routing will be determined by the pretrained routing model and customer
18040
+ # provided model routing preference.
17884
18041
  # Corresponds to the JSON property `autoMode`
17885
18042
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode]
17886
18043
  attr_accessor :auto_mode
17887
18044
 
17888
- # When manual routing is set, the specified model will be used directly.
18045
+ # The configuration for manual routing. When manual routing is specified, the
18046
+ # model will be selected based on the model name provided.
17889
18047
  # Corresponds to the JSON property `manualMode`
17890
18048
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode]
17891
18049
  attr_accessor :manual_mode
@@ -17901,8 +18059,9 @@ module Google
17901
18059
  end
17902
18060
  end
17903
18061
 
17904
- # When automated routing is specified, the routing will be determined by the
17905
- # pretrained routing model and customer provided model routing preference.
18062
+ # The configuration for automated routing. When automated routing is specified,
18063
+ # the routing will be determined by the pretrained routing model and customer
18064
+ # provided model routing preference.
17906
18065
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode
17907
18066
  include Google::Apis::Core::Hashable
17908
18067
 
@@ -17921,13 +18080,12 @@ module Google
17921
18080
  end
17922
18081
  end
17923
18082
 
17924
- # When manual routing is set, the specified model will be used directly.
18083
+ # The configuration for manual routing. When manual routing is specified, the
18084
+ # model will be selected based on the model name provided.
17925
18085
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode
17926
18086
  include Google::Apis::Core::Hashable
17927
18087
 
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).
18088
+ # The name of the model to use. Only public LLM models are accepted.
17931
18089
  # Corresponds to the JSON property `modelName`
17932
18090
  # @return [String]
17933
18091
  attr_accessor :model_name
@@ -17942,18 +18100,26 @@ module Google
17942
18100
  end
17943
18101
  end
17944
18102
 
17945
- # Config for thinking features.
18103
+ # Configuration for the model's thinking features. "Thinking" is a process where
18104
+ # the model breaks down a complex task into smaller, manageable steps. This
18105
+ # allows the model to reason about the task, plan its approach, and execute the
18106
+ # plan to generate a high-quality response.
17946
18107
  class GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig
17947
18108
  include Google::Apis::Core::Hashable
17948
18109
 
17949
- # Optional. Indicates whether to include thoughts in the response. If true,
17950
- # thoughts are returned only when available.
18110
+ # Optional. If true, the model will include its thoughts in the response. "
18111
+ # Thoughts" are the intermediate steps the model takes to arrive at the final
18112
+ # response. They can provide insights into the model's reasoning process and
18113
+ # help with debugging. If this is true, thoughts are returned only when
18114
+ # available.
17951
18115
  # Corresponds to the JSON property `includeThoughts`
17952
18116
  # @return [Boolean]
17953
18117
  attr_accessor :include_thoughts
17954
18118
  alias_method :include_thoughts?, :include_thoughts
17955
18119
 
17956
- # Optional. Indicates the thinking budget in tokens.
18120
+ # Optional. The token budget for the model's thinking process. The model will
18121
+ # make a best effort to stay within this budget. This can be used to control the
18122
+ # trade-off between response quality and latency.
17957
18123
  # Corresponds to the JSON property `thinkingBudget`
17958
18124
  # @return [Fixnum]
17959
18125
  attr_accessor :thinking_budget
@@ -18207,21 +18373,30 @@ module Google
18207
18373
  end
18208
18374
  end
18209
18375
 
18210
- # Grounding chunk.
18376
+ # A piece of evidence that supports a claim made by the model. This is used to
18377
+ # show a citation for a claim made by the model. When grounding is enabled, the
18378
+ # model returns a `GroundingChunk` that contains a reference to the source of
18379
+ # the information.
18211
18380
  class GoogleCloudAiplatformV1beta1GroundingChunk
18212
18381
  include Google::Apis::Core::Hashable
18213
18382
 
18214
- # Chunk from Google Maps.
18383
+ # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
18384
+ # information about a place, such as its name, address, and reviews. This is
18385
+ # used to provide the user with rich, location-based information.
18215
18386
  # Corresponds to the JSON property `maps`
18216
18387
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMaps]
18217
18388
  attr_accessor :maps
18218
18389
 
18219
- # Chunk from context retrieved by the retrieval tools.
18390
+ # Context retrieved from a data source to ground the model's response. This is
18391
+ # used when a retrieval tool fetches information from a user-provided corpus or
18392
+ # a public dataset.
18220
18393
  # Corresponds to the JSON property `retrievedContext`
18221
18394
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext]
18222
18395
  attr_accessor :retrieved_context
18223
18396
 
18224
- # Chunk from the web.
18397
+ # A `Web` chunk is a piece of evidence that comes from a web page. It contains
18398
+ # the URI of the web page, the title of the page, and the domain of the page.
18399
+ # This is used to provide the user with a link to the source of the information.
18225
18400
  # Corresponds to the JSON property `web`
18226
18401
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkWeb]
18227
18402
  attr_accessor :web
@@ -18238,32 +18413,36 @@ module Google
18238
18413
  end
18239
18414
  end
18240
18415
 
18241
- # Chunk from Google Maps.
18416
+ # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
18417
+ # information about a place, such as its name, address, and reviews. This is
18418
+ # used to provide the user with rich, location-based information.
18242
18419
  class GoogleCloudAiplatformV1beta1GroundingChunkMaps
18243
18420
  include Google::Apis::Core::Hashable
18244
18421
 
18245
- # Sources used to generate the place answer.
18422
+ # The sources that were used to generate the place answer. This includes review
18423
+ # snippets and photos that were used to generate the answer, as well as URIs to
18424
+ # flag content.
18246
18425
  # Corresponds to the JSON property `placeAnswerSources`
18247
18426
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources]
18248
18427
  attr_accessor :place_answer_sources
18249
18428
 
18250
- # This Place's resource name, in `places/`place_id`` format. Can be used to look
18251
- # up the Place.
18429
+ # This Place's resource name, in `places/`place_id`` format. This can be used to
18430
+ # look up the place in the Google Maps API.
18252
18431
  # Corresponds to the JSON property `placeId`
18253
18432
  # @return [String]
18254
18433
  attr_accessor :place_id
18255
18434
 
18256
- # Text of the place answer.
18435
+ # The text of the place answer.
18257
18436
  # Corresponds to the JSON property `text`
18258
18437
  # @return [String]
18259
18438
  attr_accessor :text
18260
18439
 
18261
- # Title of the place.
18440
+ # The title of the place.
18262
18441
  # Corresponds to the JSON property `title`
18263
18442
  # @return [String]
18264
18443
  attr_accessor :title
18265
18444
 
18266
- # URI reference of the place.
18445
+ # The URI of the place.
18267
18446
  # Corresponds to the JSON property `uri`
18268
18447
  # @return [String]
18269
18448
  attr_accessor :uri
@@ -18282,11 +18461,13 @@ module Google
18282
18461
  end
18283
18462
  end
18284
18463
 
18285
- # Sources used to generate the place answer.
18464
+ # The sources that were used to generate the place answer. This includes review
18465
+ # snippets and photos that were used to generate the answer, as well as URIs to
18466
+ # flag content.
18286
18467
  class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources
18287
18468
  include Google::Apis::Core::Hashable
18288
18469
 
18289
- # Snippets of reviews that are used to generate the answer.
18470
+ # Snippets of reviews that were used to generate the answer.
18290
18471
  # Corresponds to the JSON property `reviewSnippets`
18291
18472
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet>]
18292
18473
  attr_accessor :review_snippets
@@ -18301,7 +18482,7 @@ module Google
18301
18482
  end
18302
18483
  end
18303
18484
 
18304
- # Encapsulates a review snippet.
18485
+ # A review snippet that is used to generate the answer.
18305
18486
  class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
18306
18487
  include Google::Apis::Core::Hashable
18307
18488
 
@@ -18310,12 +18491,12 @@ module Google
18310
18491
  # @return [String]
18311
18492
  attr_accessor :google_maps_uri
18312
18493
 
18313
- # Id of the review referencing the place.
18494
+ # The ID of the review that is being referenced.
18314
18495
  # Corresponds to the JSON property `reviewId`
18315
18496
  # @return [String]
18316
18497
  attr_accessor :review_id
18317
18498
 
18318
- # Title of the review.
18499
+ # The title of the review.
18319
18500
  # Corresponds to the JSON property `title`
18320
18501
  # @return [String]
18321
18502
  attr_accessor :title
@@ -18332,12 +18513,16 @@ module Google
18332
18513
  end
18333
18514
  end
18334
18515
 
18335
- # Chunk from context retrieved by the retrieval tools.
18516
+ # Context retrieved from a data source to ground the model's response. This is
18517
+ # used when a retrieval tool fetches information from a user-provided corpus or
18518
+ # a public dataset.
18336
18519
  class GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext
18337
18520
  include Google::Apis::Core::Hashable
18338
18521
 
18339
- # Output only. The full document name for the referenced Vertex AI Search
18340
- # document.
18522
+ # Output only. The full resource name of the referenced Vertex AI Search
18523
+ # document. This is used to identify the specific document that was retrieved.
18524
+ # The format is `projects/`project`/locations/`location`/collections/`collection`
18525
+ # /dataStores/`data_store`/branches/`branch`/documents/`document``.
18341
18526
  # Corresponds to the JSON property `documentName`
18342
18527
  # @return [String]
18343
18528
  attr_accessor :document_name
@@ -18348,17 +18533,17 @@ module Google
18348
18533
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagChunk]
18349
18534
  attr_accessor :rag_chunk
18350
18535
 
18351
- # Text of the attribution.
18536
+ # The content of the retrieved data source.
18352
18537
  # Corresponds to the JSON property `text`
18353
18538
  # @return [String]
18354
18539
  attr_accessor :text
18355
18540
 
18356
- # Title of the attribution.
18541
+ # The title of the retrieved data source.
18357
18542
  # Corresponds to the JSON property `title`
18358
18543
  # @return [String]
18359
18544
  attr_accessor :title
18360
18545
 
18361
- # URI reference of the attribution.
18546
+ # The URI of the retrieved data source.
18362
18547
  # Corresponds to the JSON property `uri`
18363
18548
  # @return [String]
18364
18549
  attr_accessor :uri
@@ -18377,21 +18562,24 @@ module Google
18377
18562
  end
18378
18563
  end
18379
18564
 
18380
- # Chunk from the web.
18565
+ # A `Web` chunk is a piece of evidence that comes from a web page. It contains
18566
+ # the URI of the web page, the title of the page, and the domain of the page.
18567
+ # This is used to provide the user with a link to the source of the information.
18381
18568
  class GoogleCloudAiplatformV1beta1GroundingChunkWeb
18382
18569
  include Google::Apis::Core::Hashable
18383
18570
 
18384
- # Domain of the (original) URI.
18571
+ # The domain of the web page that contains the evidence. This can be used to
18572
+ # filter out low-quality sources.
18385
18573
  # Corresponds to the JSON property `domain`
18386
18574
  # @return [String]
18387
18575
  attr_accessor :domain
18388
18576
 
18389
- # Title of the chunk.
18577
+ # The title of the web page that contains the evidence.
18390
18578
  # Corresponds to the JSON property `title`
18391
18579
  # @return [String]
18392
18580
  attr_accessor :title
18393
18581
 
18394
- # URI reference of the chunk.
18582
+ # The URI of the web page that contains the evidence.
18395
18583
  # Corresponds to the JSON property `uri`
18396
18584
  # @return [String]
18397
18585
  attr_accessor :uri
@@ -18408,49 +18596,63 @@ module Google
18408
18596
  end
18409
18597
  end
18410
18598
 
18411
- # Metadata returned to client when grounding is enabled.
18599
+ # Information about the sources that support the content of a response. When
18600
+ # grounding is enabled, the model returns citations for claims in the response.
18601
+ # This object contains the retrieved sources.
18412
18602
  class GoogleCloudAiplatformV1beta1GroundingMetadata
18413
18603
  include Google::Apis::Core::Hashable
18414
18604
 
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.
18605
+ # Optional. Output only. A token that can be used to render a Google Maps widget
18606
+ # with the contextual data. This field is populated only when the grounding
18607
+ # source is Google Maps.
18418
18608
  # Corresponds to the JSON property `googleMapsWidgetContextToken`
18419
18609
  # @return [String]
18420
18610
  attr_accessor :google_maps_widget_context_token
18421
18611
 
18422
- # List of supporting references retrieved from specified grounding source.
18612
+ # A list of supporting references retrieved from the grounding source. This
18613
+ # field is populated when the grounding source is Google Search, Vertex AI
18614
+ # Search, or Google Maps.
18423
18615
  # Corresponds to the JSON property `groundingChunks`
18424
18616
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunk>]
18425
18617
  attr_accessor :grounding_chunks
18426
18618
 
18427
- # Optional. List of grounding support.
18619
+ # Optional. A list of grounding supports that connect the generated content to
18620
+ # the grounding chunks. This field is populated when the grounding source is
18621
+ # Google Search or Vertex AI Search.
18428
18622
  # Corresponds to the JSON property `groundingSupports`
18429
18623
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingSupport>]
18430
18624
  attr_accessor :grounding_supports
18431
18625
 
18432
- # Metadata related to retrieval in the grounding flow.
18626
+ # Metadata related to the retrieval grounding source. This is part of the `
18627
+ # GroundingMetadata` returned when grounding is enabled.
18433
18628
  # Corresponds to the JSON property `retrievalMetadata`
18434
18629
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrievalMetadata]
18435
18630
  attr_accessor :retrieval_metadata
18436
18631
 
18437
- # Optional. Queries executed by the retrieval tools.
18632
+ # Optional. The queries that were executed by the retrieval tools. This field is
18633
+ # populated only when the grounding source is a retrieval tool, such as Vertex
18634
+ # AI Search.
18438
18635
  # Corresponds to the JSON property `retrievalQueries`
18439
18636
  # @return [Array<String>]
18440
18637
  attr_accessor :retrieval_queries
18441
18638
 
18442
- # Google search entry point.
18639
+ # An entry point for displaying Google Search results. A `SearchEntryPoint` is
18640
+ # populated when the grounding source for a model's response is Google Search.
18641
+ # It provides information that you can use to display the search results in your
18642
+ # application.
18443
18643
  # Corresponds to the JSON property `searchEntryPoint`
18444
18644
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchEntryPoint]
18445
18645
  attr_accessor :search_entry_point
18446
18646
 
18447
- # Optional. Output only. List of source flagging uris. This is currently
18448
- # populated only for Google Maps grounding.
18647
+ # Optional. Output only. A list of URIs that can be used to flag a place or
18648
+ # review for inappropriate content. This field is populated only when the
18649
+ # grounding source is Google Maps.
18449
18650
  # Corresponds to the JSON property `sourceFlaggingUris`
18450
18651
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri>]
18451
18652
  attr_accessor :source_flagging_uris
18452
18653
 
18453
- # Optional. Web search queries for the following-up web search.
18654
+ # Optional. The web search queries that were used to generate the content. This
18655
+ # field is populated only when the grounding source is Google Search.
18454
18656
  # Corresponds to the JSON property `webSearchQueries`
18455
18657
  # @return [Array<String>]
18456
18658
  attr_accessor :web_search_queries
@@ -18472,17 +18674,17 @@ module Google
18472
18674
  end
18473
18675
  end
18474
18676
 
18475
- # Source content flagging uri for a place or review. This is currently populated
18476
- # only for Google Maps grounding.
18677
+ # A URI that can be used to flag a place or review for inappropriate content.
18678
+ # This is populated only when the grounding source is Google Maps.
18477
18679
  class GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri
18478
18680
  include Google::Apis::Core::Hashable
18479
18681
 
18480
- # A link where users can flag a problem with the source (place or review).
18682
+ # The URI that can be used to flag the content.
18481
18683
  # Corresponds to the JSON property `flagContentUri`
18482
18684
  # @return [String]
18483
18685
  attr_accessor :flag_content_uri
18484
18686
 
18485
- # Id of the place or review.
18687
+ # The ID of the place or review.
18486
18688
  # Corresponds to the JSON property `sourceId`
18487
18689
  # @return [String]
18488
18690
  attr_accessor :source_id
@@ -18498,27 +18700,30 @@ module Google
18498
18700
  end
18499
18701
  end
18500
18702
 
18501
- # Grounding support.
18703
+ # A collection of supporting references for a segment of the model's response.
18502
18704
  class GoogleCloudAiplatformV1beta1GroundingSupport
18503
18705
  include Google::Apis::Core::Hashable
18504
18706
 
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
18707
+ # The confidence scores for the support references. This list is parallel to the
18708
+ # `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a
18709
+ # higher score indicating a higher confidence that the reference supports the
18710
+ # claim. For Gemini 2.0 and before, this list has the same size as `
18711
+ # grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and
18508
18712
  # should be ignored.
18509
18713
  # Corresponds to the JSON property `confidenceScores`
18510
18714
  # @return [Array<Float>]
18511
18715
  attr_accessor :confidence_scores
18512
18716
 
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.
18717
+ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata`
18718
+ # message. These indices specify which grounding chunks support the claim made
18719
+ # in the content segment. For example, if this field has the values `[1, 3]`, it
18720
+ # means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for
18721
+ # the claim in the content segment.
18517
18722
  # Corresponds to the JSON property `groundingChunkIndices`
18518
18723
  # @return [Array<Fixnum>]
18519
18724
  attr_accessor :grounding_chunk_indices
18520
18725
 
18521
- # Segment of the content.
18726
+ # A segment of the content.
18522
18727
  # Corresponds to the JSON property `segment`
18523
18728
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Segment]
18524
18729
  attr_accessor :segment
@@ -18697,7 +18902,9 @@ module Google
18697
18902
  end
18698
18903
  end
18699
18904
 
18700
- # Config for image generation features.
18905
+ # Configuration for image generation. This message allows you to control various
18906
+ # aspects of image generation, such as the output format, aspect ratio, and
18907
+ # whether the model can generate images of people.
18701
18908
  class GoogleCloudAiplatformV1beta1ImageConfig
18702
18909
  include Google::Apis::Core::Hashable
18703
18910
 
@@ -22189,17 +22396,24 @@ module Google
22189
22396
  end
22190
22397
  end
22191
22398
 
22192
- # Logprobs Result
22399
+ # The log probabilities of the tokens generated by the model. This is useful for
22400
+ # understanding the model's confidence in its predictions and for debugging. For
22401
+ # example, you can use log probabilities to identify when the model is making a
22402
+ # less confident prediction or to explore alternative responses that the model
22403
+ # considered. A low log probability can also indicate that the model is "
22404
+ # hallucinating" or generating factually incorrect information.
22193
22405
  class GoogleCloudAiplatformV1beta1LogprobsResult
22194
22406
  include Google::Apis::Core::Hashable
22195
22407
 
22196
- # Length = total number of decoding steps. The chosen candidates may or may not
22197
- # be in top_candidates.
22408
+ # A list of the chosen candidate tokens at each decoding step. The length of
22409
+ # this list is equal to the total number of decoding steps. Note that the chosen
22410
+ # candidate might not be in `top_candidates`.
22198
22411
  # Corresponds to the JSON property `chosenCandidates`
22199
22412
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
22200
22413
  attr_accessor :chosen_candidates
22201
22414
 
22202
- # Length = total number of decoding steps.
22415
+ # A list of the top candidate tokens at each decoding step. The length of this
22416
+ # list is equal to the total number of decoding steps.
22203
22417
  # Corresponds to the JSON property `topCandidates`
22204
22418
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates>]
22205
22419
  attr_accessor :top_candidates
@@ -22215,21 +22429,27 @@ module Google
22215
22429
  end
22216
22430
  end
22217
22431
 
22218
- # Candidate for the logprobs token and score.
22432
+ # A single token and its associated log probability.
22219
22433
  class GoogleCloudAiplatformV1beta1LogprobsResultCandidate
22220
22434
  include Google::Apis::Core::Hashable
22221
22435
 
22222
- # The candidate's log probability.
22436
+ # The log probability of this token. A higher value indicates that the model was
22437
+ # more confident in this token. The log probability can be used to assess the
22438
+ # relative likelihood of different tokens and to identify when the model is
22439
+ # uncertain.
22223
22440
  # Corresponds to the JSON property `logProbability`
22224
22441
  # @return [Float]
22225
22442
  attr_accessor :log_probability
22226
22443
 
22227
- # The candidate's token string value.
22444
+ # The token's string representation.
22228
22445
  # Corresponds to the JSON property `token`
22229
22446
  # @return [String]
22230
22447
  attr_accessor :token
22231
22448
 
22232
- # The candidate's token id value.
22449
+ # The token's numerical ID. While the `token` field provides the string
22450
+ # representation of the token, the `token_id` is the numerical representation
22451
+ # that the model uses internally. This can be useful for developers who want to
22452
+ # build custom logic based on the model's vocabulary.
22233
22453
  # Corresponds to the JSON property `tokenId`
22234
22454
  # @return [Fixnum]
22235
22455
  attr_accessor :token_id
@@ -22246,11 +22466,12 @@ module Google
22246
22466
  end
22247
22467
  end
22248
22468
 
22249
- # Candidates with top log probabilities at each decoding step.
22469
+ # A list of the top candidate tokens and their log probabilities at each
22470
+ # decoding step. This can be used to see what other tokens the model considered.
22250
22471
  class GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates
22251
22472
  include Google::Apis::Core::Hashable
22252
22473
 
22253
- # Sorted by log probability in descending order.
22474
+ # The list of candidate tokens, sorted by log probability in descending order.
22254
22475
  # Corresponds to the JSON property `candidates`
22255
22476
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
22256
22477
  attr_accessor :candidates
@@ -22530,6 +22751,12 @@ module Google
22530
22751
  # @return [String]
22531
22752
  attr_accessor :revision_expire_time
22532
22753
 
22754
+ # Optional. Input only. The labels to apply to the Memory Revision created as a
22755
+ # result of this request.
22756
+ # Corresponds to the JSON property `revisionLabels`
22757
+ # @return [Hash<String,String>]
22758
+ attr_accessor :revision_labels
22759
+
22533
22760
  # Optional. Input only. The TTL for the revision. The expiration time is
22534
22761
  # computed: now + TTL.
22535
22762
  # Corresponds to the JSON property `revisionTtl`
@@ -22573,6 +22800,7 @@ module Google
22573
22800
  @fact = args[:fact] if args.key?(:fact)
22574
22801
  @name = args[:name] if args.key?(:name)
22575
22802
  @revision_expire_time = args[:revision_expire_time] if args.key?(:revision_expire_time)
22803
+ @revision_labels = args[:revision_labels] if args.key?(:revision_labels)
22576
22804
  @revision_ttl = args[:revision_ttl] if args.key?(:revision_ttl)
22577
22805
  @scope = args[:scope] if args.key?(:scope)
22578
22806
  @topics = args[:topics] if args.key?(:topics)
@@ -22670,10 +22898,9 @@ module Google
22670
22898
  class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent
22671
22899
  include Google::Apis::Core::Hashable
22672
22900
 
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.
22901
+ # The structured data content of a message. A Content message contains a `role`
22902
+ # field, which indicates the producer of the content, and a `parts` field, which
22903
+ # contains the multi-part data of the message.
22677
22904
  # Corresponds to the JSON property `content`
22678
22905
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
22679
22906
  attr_accessor :content
@@ -23082,6 +23309,11 @@ module Google
23082
23309
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuSpec]
23083
23310
  attr_accessor :bleu_spec
23084
23311
 
23312
+ # Specificies a metric that is populated by evaluating user-defined Python code.
23313
+ # Corresponds to the JSON property `customCodeExecutionSpec`
23314
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec]
23315
+ attr_accessor :custom_code_execution_spec
23316
+
23085
23317
  # Spec for exact match metric - returns 1 if prediction and reference exactly
23086
23318
  # matches, otherwise 0.
23087
23319
  # Corresponds to the JSON property `exactMatchSpec`
@@ -23122,6 +23354,7 @@ module Google
23122
23354
  def update!(**args)
23123
23355
  @aggregation_metrics = args[:aggregation_metrics] if args.key?(:aggregation_metrics)
23124
23356
  @bleu_spec = args[:bleu_spec] if args.key?(:bleu_spec)
23357
+ @custom_code_execution_spec = args[:custom_code_execution_spec] if args.key?(:custom_code_execution_spec)
23125
23358
  @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec)
23126
23359
  @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
23127
23360
  @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec)
@@ -23692,16 +23925,21 @@ module Google
23692
23925
  end
23693
23926
  end
23694
23927
 
23695
- # Represents token counting info for a single modality.
23928
+ # Represents a breakdown of token usage by modality. This message is used in
23929
+ # CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a
23930
+ # detailed view of how many tokens are used by each modality (e.g., text, image,
23931
+ # video) in a request. This is particularly useful for multimodal models,
23932
+ # allowing you to track and manage token consumption for billing and quota
23933
+ # purposes.
23696
23934
  class GoogleCloudAiplatformV1beta1ModalityTokenCount
23697
23935
  include Google::Apis::Core::Hashable
23698
23936
 
23699
- # The modality associated with this token count.
23937
+ # The modality that this token count applies to.
23700
23938
  # Corresponds to the JSON property `modality`
23701
23939
  # @return [String]
23702
23940
  attr_accessor :modality
23703
23941
 
23704
- # Number of tokens.
23942
+ # The number of tokens counted for this modality.
23705
23943
  # Corresponds to the JSON property `tokenCount`
23706
23944
  # @return [Fixnum]
23707
23945
  attr_accessor :token_count
@@ -24002,17 +24240,29 @@ module Google
24002
24240
  end
24003
24241
  end
24004
24242
 
24005
- # Configuration for Model Armor integrations of prompt and responses.
24243
+ # Configuration for Model Armor. Model Armor is a Google Cloud service that
24244
+ # provides safety and security filtering for prompts and responses. It helps
24245
+ # protect your AI applications from risks such as harmful content, sensitive
24246
+ # data leakage, and prompt injection attacks.
24006
24247
  class GoogleCloudAiplatformV1beta1ModelArmorConfig
24007
24248
  include Google::Apis::Core::Hashable
24008
24249
 
24009
- # Optional. The name of the Model Armor template to use for prompt sanitization.
24250
+ # Optional. The resource name of the Model Armor template to use for prompt
24251
+ # screening. A Model Armor template is a set of customized filters and
24252
+ # thresholds that define how Model Armor screens content. If specified, Model
24253
+ # Armor will use this template to check the user's prompt for safety and
24254
+ # security risks before it is sent to the model. The name must be in the format `
24255
+ # projects/`project`/locations/`location`/templates/`template``.
24010
24256
  # Corresponds to the JSON property `promptTemplateName`
24011
24257
  # @return [String]
24012
24258
  attr_accessor :prompt_template_name
24013
24259
 
24014
- # Optional. The name of the Model Armor template to use for response
24015
- # sanitization.
24260
+ # Optional. The resource name of the Model Armor template to use for response
24261
+ # screening. A Model Armor template is a set of customized filters and
24262
+ # thresholds that define how Model Armor screens content. If specified, Model
24263
+ # Armor will use this template to check the model's response for safety and
24264
+ # security risks before it is returned to the user. The name must be in the
24265
+ # format `projects/`project`/locations/`location`/templates/`template``.
24016
24266
  # Corresponds to the JSON property `responseTemplateName`
24017
24267
  # @return [String]
24018
24268
  attr_accessor :response_template_name
@@ -26753,8 +27003,7 @@ module Google
26753
27003
  end
26754
27004
  end
26755
27005
 
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.
27006
+ # Configuration for a multi-speaker text-to-speech request.
26758
27007
  class GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig
26759
27008
  include Google::Apis::Core::Hashable
26760
27009
 
@@ -28558,10 +28807,9 @@ module Google
28558
28807
  class GoogleCloudAiplatformV1beta1OptimizePromptRequest
28559
28808
  include Google::Apis::Core::Hashable
28560
28809
 
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.
28810
+ # The structured data content of a message. A Content message contains a `role`
28811
+ # field, which indicates the producer of the content, and a `parts` field, which
28812
+ # contains the multi-part data of the message.
28565
28813
  # Corresponds to the JSON property `content`
28566
28814
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
28567
28815
  attr_accessor :content
@@ -28586,10 +28834,9 @@ module Google
28586
28834
  class GoogleCloudAiplatformV1beta1OptimizePromptResponse
28587
28835
  include Google::Apis::Core::Hashable
28588
28836
 
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.
28837
+ # The structured data content of a message. A Content message contains a `role`
28838
+ # field, which indicates the producer of the content, and a `parts` field, which
28839
+ # contains the multi-part data of the message.
28593
28840
  # Corresponds to the JSON property `content`
28594
28841
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
28595
28842
  attr_accessor :content
@@ -29109,11 +29356,11 @@ module Google
29109
29356
  end
29110
29357
  end
29111
29358
 
29112
- # A datatype containing media that is part of a multi-part `Content` message. A `
29359
+ # A datatype containing media that is part of a multi-part Content message. A `
29113
29360
  # 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.
29361
+ # contain one of the accepted types in `Part.data`. For media types that are not
29362
+ # text, `Part` must have a fixed IANA MIME type identifying the type and subtype
29363
+ # of the media if `inline_data` or `file_data` field is filled with raw bytes.
29117
29364
  class GoogleCloudAiplatformV1beta1Part
29118
29365
  include Google::Apis::Core::Hashable
29119
29366
 
@@ -29132,7 +29379,9 @@ module Google
29132
29379
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecutableCode]
29133
29380
  attr_accessor :executable_code
29134
29381
 
29135
- # URI based data.
29382
+ # URI-based data. A FileData message contains a URI pointing to data of a
29383
+ # specific media type. It is used to represent images, audio, and video stored
29384
+ # in Google Cloud Storage.
29136
29385
  # Corresponds to the JSON property `fileData`
29137
29386
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FileData]
29138
29387
  attr_accessor :file_data
@@ -29152,17 +29401,19 @@ module Google
29152
29401
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FunctionResponse]
29153
29402
  attr_accessor :function_response
29154
29403
 
29155
- # Content blob.
29404
+ # A content blob. A Blob contains data of a specific media type. It is used to
29405
+ # represent images, audio, and video.
29156
29406
  # Corresponds to the JSON property `inlineData`
29157
29407
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Blob]
29158
29408
  attr_accessor :inline_data
29159
29409
 
29160
- # Optional. Text part (can be code).
29410
+ # Optional. The text content of the part.
29161
29411
  # Corresponds to the JSON property `text`
29162
29412
  # @return [String]
29163
29413
  attr_accessor :text
29164
29414
 
29165
- # Optional. Indicates if the part is thought from the model.
29415
+ # Optional. Indicates whether the `part` represents the model's thought process
29416
+ # or reasoning.
29166
29417
  # Corresponds to the JSON property `thought`
29167
29418
  # @return [Boolean]
29168
29419
  attr_accessor :thought
@@ -29175,7 +29426,8 @@ module Google
29175
29426
  # @return [String]
29176
29427
  attr_accessor :thought_signature
29177
29428
 
29178
- # Metadata describes the input video content.
29429
+ # Provides metadata for a video, including the start and end offsets for
29430
+ # clipping and the frame rate.
29179
29431
  # Corresponds to the JSON property `videoMetadata`
29180
29432
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VideoMetadata]
29181
29433
  attr_accessor :video_metadata
@@ -30394,11 +30646,11 @@ module Google
30394
30646
  end
30395
30647
  end
30396
30648
 
30397
- # The configuration for the prebuilt speaker to use.
30649
+ # Configuration for a prebuilt voice.
30398
30650
  class GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig
30399
30651
  include Google::Apis::Core::Hashable
30400
30652
 
30401
- # The name of the preset voice to use.
30653
+ # The name of the prebuilt voice to use.
30402
30654
  # Corresponds to the JSON property `voiceName`
30403
30655
  # @return [String]
30404
30656
  attr_accessor :voice_name
@@ -32119,6 +32371,34 @@ module Google
32119
32371
  end
32120
32372
  end
32121
32373
 
32374
+ # Request message for MemoryBankService.PurgeMemories.
32375
+ class GoogleCloudAiplatformV1beta1PurgeMemoriesRequest
32376
+ include Google::Apis::Core::Hashable
32377
+
32378
+ # Required. The standard list filter to determine which memories to purge. More
32379
+ # detail in [AIP-160](https://google.aip.dev/160).
32380
+ # Corresponds to the JSON property `filter`
32381
+ # @return [String]
32382
+ attr_accessor :filter
32383
+
32384
+ # Optional. If true, the memories will actually be purged. If false, the purge
32385
+ # request will be validated but not executed.
32386
+ # Corresponds to the JSON property `force`
32387
+ # @return [Boolean]
32388
+ attr_accessor :force
32389
+ alias_method :force?, :force
32390
+
32391
+ def initialize(**args)
32392
+ update!(**args)
32393
+ end
32394
+
32395
+ # Update properties of this object
32396
+ def update!(**args)
32397
+ @filter = args[:filter] if args.key?(:filter)
32398
+ @force = args[:force] if args.key?(:force)
32399
+ end
32400
+ end
32401
+
32122
32402
  # The spec of a Python packaged code.
32123
32403
  class GoogleCloudAiplatformV1beta1PythonPackageSpec
32124
32404
  include Google::Apis::Core::Hashable
@@ -32981,6 +33261,18 @@ module Google
32981
33261
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig]
32982
33262
  attr_accessor :rag_vector_db_config
32983
33263
 
33264
+ # Output only. Reserved for future use.
33265
+ # Corresponds to the JSON property `satisfiesPzi`
33266
+ # @return [Boolean]
33267
+ attr_accessor :satisfies_pzi
33268
+ alias_method :satisfies_pzi?, :satisfies_pzi
33269
+
33270
+ # Output only. Reserved for future use.
33271
+ # Corresponds to the JSON property `satisfiesPzs`
33272
+ # @return [Boolean]
33273
+ attr_accessor :satisfies_pzs
33274
+ alias_method :satisfies_pzs?, :satisfies_pzs
33275
+
32984
33276
  # Output only. Timestamp when this RagCorpus was last updated.
32985
33277
  # Corresponds to the JSON property `updateTime`
32986
33278
  # @return [String]
@@ -33012,6 +33304,8 @@ module Google
33012
33304
  @rag_embedding_model_config = args[:rag_embedding_model_config] if args.key?(:rag_embedding_model_config)
33013
33305
  @rag_files_count = args[:rag_files_count] if args.key?(:rag_files_count)
33014
33306
  @rag_vector_db_config = args[:rag_vector_db_config] if args.key?(:rag_vector_db_config)
33307
+ @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
33308
+ @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
33015
33309
  @update_time = args[:update_time] if args.key?(:update_time)
33016
33310
  @vector_db_config = args[:vector_db_config] if args.key?(:vector_db_config)
33017
33311
  @vertex_ai_search_config = args[:vertex_ai_search_config] if args.key?(:vertex_ai_search_config)
@@ -34901,6 +35195,13 @@ module Google
34901
35195
  class GoogleCloudAiplatformV1beta1ReasoningEngineSpec
34902
35196
  include Google::Apis::Core::Hashable
34903
35197
 
35198
+ # Optional. The A2A Agent Card for the agent (if available). It follows the
35199
+ # specification at https://a2a-protocol.org/latest/specification/#5-agent-
35200
+ # discovery-the-agent-card.
35201
+ # Corresponds to the JSON property `agentCard`
35202
+ # @return [Hash<String,Object>]
35203
+ attr_accessor :agent_card
35204
+
34904
35205
  # Optional. The OSS agent framework used to develop the agent. Currently
34905
35206
  # supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index",
34906
35207
  # "custom".
@@ -34919,6 +35220,23 @@ module Google
34919
35220
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec]
34920
35221
  attr_accessor :deployment_spec
34921
35222
 
35223
+ # Output only. The identity to use for the Reasoning Engine. It can contain one
35224
+ # of the following values: * service-`project`@gcp-sa-aiplatform-re.googleapis.
35225
+ # com (for SERVICE_AGENT identity type) * `name`@`project`.gserviceaccount.com (
35226
+ # for SERVICE_ACCOUNT identity type) * agents.global.`org`.system.id.goog/
35227
+ # resources/aiplatform/projects/`project`/locations/`location`/reasoningEngines/`
35228
+ # reasoning_engine` (for AGENT_IDENTITY identity type)
35229
+ # Corresponds to the JSON property `effectiveIdentity`
35230
+ # @return [String]
35231
+ attr_accessor :effective_identity
35232
+
35233
+ # Optional. The identity type to use for the Reasoning Engine. If not specified,
35234
+ # the `service_account` field will be used if set, otherwise the default Vertex
35235
+ # AI Reasoning Engine Service Agent in the project will be used.
35236
+ # Corresponds to the JSON property `identityType`
35237
+ # @return [String]
35238
+ attr_accessor :identity_type
35239
+
34922
35240
  # User-provided package specification, containing pickled object and package
34923
35241
  # requirements.
34924
35242
  # Corresponds to the JSON property `packageSpec`
@@ -34945,9 +35263,12 @@ module Google
34945
35263
 
34946
35264
  # Update properties of this object
34947
35265
  def update!(**args)
35266
+ @agent_card = args[:agent_card] if args.key?(:agent_card)
34948
35267
  @agent_framework = args[:agent_framework] if args.key?(:agent_framework)
34949
35268
  @class_methods = args[:class_methods] if args.key?(:class_methods)
34950
35269
  @deployment_spec = args[:deployment_spec] if args.key?(:deployment_spec)
35270
+ @effective_identity = args[:effective_identity] if args.key?(:effective_identity)
35271
+ @identity_type = args[:identity_type] if args.key?(:identity_type)
34951
35272
  @package_spec = args[:package_spec] if args.key?(:package_spec)
34952
35273
  @service_account = args[:service_account] if args.key?(:service_account)
34953
35274
  @source_code_spec = args[:source_code_spec] if args.key?(:source_code_spec)
@@ -35044,8 +35365,8 @@ module Google
35044
35365
  # @return [String]
35045
35366
  attr_accessor :pickle_object_gcs_uri
35046
35367
 
35047
- # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not
35048
- # specified, default value is 3.10.
35368
+ # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13.
35369
+ # If not specified, the default value is 3.10.
35049
35370
  # Corresponds to the JSON property `pythonVersion`
35050
35371
  # @return [String]
35051
35372
  attr_accessor :python_version
@@ -35916,15 +36237,17 @@ module Google
35916
36237
  end
35917
36238
  end
35918
36239
 
35919
- # Metadata related to retrieval in the grounding flow.
36240
+ # Metadata related to the retrieval grounding source. This is part of the `
36241
+ # GroundingMetadata` returned when grounding is enabled.
35920
36242
  class GoogleCloudAiplatformV1beta1RetrievalMetadata
35921
36243
  include Google::Apis::Core::Hashable
35922
36244
 
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.
36245
+ # Optional. A score indicating how likely it is that a Google Search query could
36246
+ # help answer the prompt. The score is in the range of `[0, 1]`. A score of 1
36247
+ # means the model is confident that a search will be helpful, and 0 means it is
36248
+ # not. This score is populated only when Google Search grounding and dynamic
36249
+ # retrieval are enabled. The score is used to determine whether to trigger a
36250
+ # search.
35928
36251
  # Corresponds to the JSON property `googleSearchDynamicRetrievalScore`
35929
36252
  # @return [Float]
35930
36253
  attr_accessor :google_search_dynamic_retrieval_score
@@ -36049,7 +36372,9 @@ module Google
36049
36372
 
36050
36373
  # Optional. The standard list filter that will be applied to the retrieved
36051
36374
  # memories. More detail in [AIP-160](https://google.aip.dev/160). Supported
36052
- # fields: * `fact` * `create_time` * `update_time`
36375
+ # fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.
36376
+ # custom_memory_topic_label: "example topic" OR topics.managed_memory_topic:
36377
+ # USER_PREFERENCES`)
36053
36378
  # Corresponds to the JSON property `filter`
36054
36379
  # @return [String]
36055
36380
  attr_accessor :filter
@@ -36889,18 +37214,18 @@ module Google
36889
37214
  end
36890
37215
  end
36891
37216
 
36892
- # Safety rating corresponding to the generated content.
37217
+ # A safety rating for a piece of content. The safety rating contains the harm
37218
+ # category and the harm probability level.
36893
37219
  class GoogleCloudAiplatformV1beta1SafetyRating
36894
37220
  include Google::Apis::Core::Hashable
36895
37221
 
36896
- # Output only. Indicates whether the content was filtered out because of this
36897
- # rating.
37222
+ # Output only. Indicates whether the content was blocked because of this rating.
36898
37223
  # Corresponds to the JSON property `blocked`
36899
37224
  # @return [Boolean]
36900
37225
  attr_accessor :blocked
36901
37226
  alias_method :blocked?, :blocked
36902
37227
 
36903
- # Output only. Harm category.
37228
+ # Output only. The harm category of this rating.
36904
37229
  # Corresponds to the JSON property `category`
36905
37230
  # @return [String]
36906
37231
  attr_accessor :category
@@ -36912,22 +37237,22 @@ module Google
36912
37237
  # @return [String]
36913
37238
  attr_accessor :overwritten_threshold
36914
37239
 
36915
- # Output only. Harm probability levels in the content.
37240
+ # Output only. The probability of harm for this category.
36916
37241
  # Corresponds to the JSON property `probability`
36917
37242
  # @return [String]
36918
37243
  attr_accessor :probability
36919
37244
 
36920
- # Output only. Harm probability score.
37245
+ # Output only. The probability score of harm for this category.
36921
37246
  # Corresponds to the JSON property `probabilityScore`
36922
37247
  # @return [Float]
36923
37248
  attr_accessor :probability_score
36924
37249
 
36925
- # Output only. Harm severity levels in the content.
37250
+ # Output only. The severity of harm for this category.
36926
37251
  # Corresponds to the JSON property `severity`
36927
37252
  # @return [String]
36928
37253
  attr_accessor :severity
36929
37254
 
36930
- # Output only. Harm severity score.
37255
+ # Output only. The severity score of harm for this category.
36931
37256
  # Corresponds to the JSON property `severityScore`
36932
37257
  # @return [Float]
36933
37258
  attr_accessor :severity_score
@@ -36979,22 +37304,24 @@ module Google
36979
37304
  end
36980
37305
  end
36981
37306
 
36982
- # Safety settings.
37307
+ # A safety setting that affects the safety-blocking behavior. A SafetySetting
37308
+ # consists of a harm category and a threshold for that category.
36983
37309
  class GoogleCloudAiplatformV1beta1SafetySetting
36984
37310
  include Google::Apis::Core::Hashable
36985
37311
 
36986
- # Required. Harm category.
37312
+ # Required. The harm category to be blocked.
36987
37313
  # Corresponds to the JSON property `category`
36988
37314
  # @return [String]
36989
37315
  attr_accessor :category
36990
37316
 
36991
- # Optional. Specify if the threshold is used for probability or severity score.
36992
- # If not specified, the threshold is used for probability score.
37317
+ # Optional. The method for blocking content. If not specified, the default
37318
+ # behavior is to use the probability score.
36993
37319
  # Corresponds to the JSON property `method`
36994
37320
  # @return [String]
36995
37321
  attr_accessor :method_prop
36996
37322
 
36997
- # Required. The harm block threshold.
37323
+ # Required. The threshold for blocking content. If the harm probability exceeds
37324
+ # this threshold, the content will be blocked.
36998
37325
  # Corresponds to the JSON property `threshold`
36999
37326
  # @return [String]
37000
37327
  attr_accessor :threshold
@@ -40568,6 +40895,71 @@ module Google
40568
40895
  end
40569
40896
  end
40570
40897
 
40898
+ # Defines data for an application builder.
40899
+ class GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderData
40900
+ include Google::Apis::Core::Hashable
40901
+
40902
+ # Serialized state of the code repository. This string will typically contain a
40903
+ # JSON representation of the UI's CodeRepositoryService state (files, folders,
40904
+ # content, and any metadata). The UI is responsible for serialization and
40905
+ # deserialization.
40906
+ # Corresponds to the JSON property `codeRepositoryState`
40907
+ # @return [String]
40908
+ attr_accessor :code_repository_state
40909
+
40910
+ # Linked resources attached to the application by the user.
40911
+ # Corresponds to the JSON property `linkedResources`
40912
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderDataLinkedResource>]
40913
+ attr_accessor :linked_resources
40914
+
40915
+ def initialize(**args)
40916
+ update!(**args)
40917
+ end
40918
+
40919
+ # Update properties of this object
40920
+ def update!(**args)
40921
+ @code_repository_state = args[:code_repository_state] if args.key?(:code_repository_state)
40922
+ @linked_resources = args[:linked_resources] if args.key?(:linked_resources)
40923
+ end
40924
+ end
40925
+
40926
+ # A linked resource attached to the application by the user.
40927
+ class GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderDataLinkedResource
40928
+ include Google::Apis::Core::Hashable
40929
+
40930
+ # A user-friendly name for the data source shown in the UI.
40931
+ # Corresponds to the JSON property `displayName`
40932
+ # @return [String]
40933
+ attr_accessor :display_name
40934
+
40935
+ # The unique resource name of the data source. The format is determined by the '
40936
+ # type' field. For type "SAVED_PROMPT": projects/`project`/locations/`location`/
40937
+ # datasets/`dataset` For type "AI_AGENT": projects/`project`/locations/`location`
40938
+ # /agents/`agent`
40939
+ # Corresponds to the JSON property `name`
40940
+ # @return [String]
40941
+ attr_accessor :name
40942
+
40943
+ # The type of the linked resource. e.g., "SAVED_PROMPT", "AI_AGENT" This string
40944
+ # corresponds to the name of the LinkedResourceType enum member. See: google3/
40945
+ # cloud/console/web/ai/platform/llm/prompts/build/services/
40946
+ # specs_repository_service/linked_resources/linked_resource.ts
40947
+ # Corresponds to the JSON property `type`
40948
+ # @return [String]
40949
+ attr_accessor :type
40950
+
40951
+ def initialize(**args)
40952
+ update!(**args)
40953
+ end
40954
+
40955
+ # Update properties of this object
40956
+ def update!(**args)
40957
+ @display_name = args[:display_name] if args.key?(:display_name)
40958
+ @name = args[:name] if args.key?(:name)
40959
+ @type = args[:type] if args.key?(:type)
40960
+ end
40961
+ end
40962
+
40571
40963
  # Prompt variation that embeds preambles to prompt string.
40572
40964
  class GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt
40573
40965
  include Google::Apis::Core::Hashable
@@ -40619,7 +41011,9 @@ module Google
40619
41011
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
40620
41012
  attr_accessor :contents
40621
41013
 
40622
- # Generation config.
41014
+ # Configuration for content generation. This message contains all the parameters
41015
+ # that control how the model generates content. It allows you to influence the
41016
+ # randomness, length, and structure of the output.
40623
41017
  # Corresponds to the JSON property `generationConfig`
40624
41018
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
40625
41019
  attr_accessor :generation_config
@@ -40635,10 +41029,9 @@ module Google
40635
41029
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>]
40636
41030
  attr_accessor :safety_settings
40637
41031
 
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.
41032
+ # The structured data content of a message. A Content message contains a `role`
41033
+ # field, which indicates the producer of the content, and a `parts` field, which
41034
+ # contains the multi-part data of the message.
40642
41035
  # Corresponds to the JSON property `systemInstruction`
40643
41036
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
40644
41037
  attr_accessor :system_instruction
@@ -40720,10 +41113,14 @@ module Google
40720
41113
  class GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt
40721
41114
  include Google::Apis::Core::Hashable
40722
41115
 
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.
41116
+ # Defines data for an application builder.
41117
+ # Corresponds to the JSON property `appBuilderData`
41118
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderData]
41119
+ attr_accessor :app_builder_data
41120
+
41121
+ # The structured data content of a message. A Content message contains a `role`
41122
+ # field, which indicates the producer of the content, and a `parts` field, which
41123
+ # contains the multi-part data of the message.
40727
41124
  # Corresponds to the JSON property `context`
40728
41125
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
40729
41126
  attr_accessor :context
@@ -40771,6 +41168,7 @@ module Google
40771
41168
 
40772
41169
  # Update properties of this object
40773
41170
  def update!(**args)
41171
+ @app_builder_data = args[:app_builder_data] if args.key?(:app_builder_data)
40774
41172
  @context = args[:context] if args.key?(:context)
40775
41173
  @examples = args[:examples] if args.key?(:examples)
40776
41174
  @infill_prefix = args[:infill_prefix] if args.key?(:infill_prefix)
@@ -44493,17 +44891,23 @@ module Google
44493
44891
  end
44494
44892
  end
44495
44893
 
44496
- # Google search entry point.
44894
+ # An entry point for displaying Google Search results. A `SearchEntryPoint` is
44895
+ # populated when the grounding source for a model's response is Google Search.
44896
+ # It provides information that you can use to display the search results in your
44897
+ # application.
44497
44898
  class GoogleCloudAiplatformV1beta1SearchEntryPoint
44498
44899
  include Google::Apis::Core::Hashable
44499
44900
 
44500
- # Optional. Web content snippet that can be embedded in a web page or an app
44501
- # webview.
44901
+ # Optional. An HTML snippet that can be embedded in a web page or an application'
44902
+ # s webview. This snippet displays a search result, including the title, URL,
44903
+ # and a brief description of the search result.
44502
44904
  # Corresponds to the JSON property `renderedContent`
44503
44905
  # @return [String]
44504
44906
  attr_accessor :rendered_content
44505
44907
 
44506
- # Optional. Base64 encoded JSON representing array of tuple.
44908
+ # Optional. A base64-encoded JSON object that contains a list of search queries
44909
+ # and their corresponding search URLs. This information can be used to build a
44910
+ # custom search UI.
44507
44911
  # Corresponds to the JSON property `sdkBlob`
44508
44912
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
44509
44913
  # @return [String]
@@ -45122,28 +45526,31 @@ module Google
45122
45526
  end
45123
45527
  end
45124
45528
 
45125
- # Segment of the content.
45529
+ # A segment of the content.
45126
45530
  class GoogleCloudAiplatformV1beta1Segment
45127
45531
  include Google::Apis::Core::Hashable
45128
45532
 
45129
- # Output only. End index in the given Part, measured in bytes. Offset from the
45130
- # start of the Part, exclusive, starting at zero.
45533
+ # Output only. The end index of the segment in the `Part`, measured in bytes.
45534
+ # This marks the end of the segment and is exclusive, meaning the segment
45535
+ # includes content up to, but not including, the byte at this index.
45131
45536
  # Corresponds to the JSON property `endIndex`
45132
45537
  # @return [Fixnum]
45133
45538
  attr_accessor :end_index
45134
45539
 
45135
- # Output only. The index of a Part object within its parent Content object.
45540
+ # Output only. The index of the `Part` object that this segment belongs to. This
45541
+ # is useful for associating the segment with a specific part of the content.
45136
45542
  # Corresponds to the JSON property `partIndex`
45137
45543
  # @return [Fixnum]
45138
45544
  attr_accessor :part_index
45139
45545
 
45140
- # Output only. Start index in the given Part, measured in bytes. Offset from the
45141
- # start of the Part, inclusive, starting at zero.
45546
+ # Output only. The start index of the segment in the `Part`, measured in bytes.
45547
+ # This marks the beginning of the segment and is inclusive, meaning the byte at
45548
+ # this index is the first byte of the segment.
45142
45549
  # Corresponds to the JSON property `startIndex`
45143
45550
  # @return [Fixnum]
45144
45551
  attr_accessor :start_index
45145
45552
 
45146
- # Output only. The text corresponding to the segment from the response.
45553
+ # Output only. The text of the segment.
45147
45554
  # Corresponds to the JSON property `text`
45148
45555
  # @return [String]
45149
45556
  attr_accessor :text
@@ -45216,6 +45623,15 @@ module Google
45216
45623
  # @return [String]
45217
45624
  attr_accessor :expire_time
45218
45625
 
45626
+ # The labels with user-defined metadata to organize your Sessions. Label keys
45627
+ # and values can be no longer than 64 characters (Unicode codepoints), can only
45628
+ # contain lowercase letters, numeric characters, underscores and dashes.
45629
+ # International characters are allowed. See https://goo.gl/xmQnxf for more
45630
+ # information and examples of labels.
45631
+ # Corresponds to the JSON property `labels`
45632
+ # @return [Hash<String,String>]
45633
+ attr_accessor :labels
45634
+
45219
45635
  # Identifier. The resource name of the session. Format: 'projects/`project`/
45220
45636
  # locations/`location`/reasoningEngines/`reasoning_engine`/sessions/`session`'.
45221
45637
  # Corresponds to the JSON property `name`
@@ -45251,6 +45667,7 @@ module Google
45251
45667
  @create_time = args[:create_time] if args.key?(:create_time)
45252
45668
  @display_name = args[:display_name] if args.key?(:display_name)
45253
45669
  @expire_time = args[:expire_time] if args.key?(:expire_time)
45670
+ @labels = args[:labels] if args.key?(:labels)
45254
45671
  @name = args[:name] if args.key?(:name)
45255
45672
  @session_state = args[:session_state] if args.key?(:session_state)
45256
45673
  @ttl = args[:ttl] if args.key?(:ttl)
@@ -45273,10 +45690,9 @@ module Google
45273
45690
  # @return [String]
45274
45691
  attr_accessor :author
45275
45692
 
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.
45693
+ # The structured data content of a message. A Content message contains a `role`
45694
+ # field, which indicates the producer of the content, and a `parts` field, which
45695
+ # contains the multi-part data of the message.
45280
45696
  # Corresponds to the JSON property `content`
45281
45697
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
45282
45698
  attr_accessor :content
@@ -45588,7 +46004,7 @@ module Google
45588
46004
  end
45589
46005
  end
45590
46006
 
45591
- # Configuration for a single speaker in a multi speaker setup.
46007
+ # Configuration for a single speaker in a multi-speaker setup.
45592
46008
  class GoogleCloudAiplatformV1beta1SpeakerVoiceConfig
45593
46009
  include Google::Apis::Core::Hashable
45594
46010
 
@@ -45598,7 +46014,7 @@ module Google
45598
46014
  # @return [String]
45599
46015
  attr_accessor :speaker
45600
46016
 
45601
- # The configuration for the voice to use.
46017
+ # Configuration for a voice.
45602
46018
  # Corresponds to the JSON property `voiceConfig`
45603
46019
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VoiceConfig]
45604
46020
  attr_accessor :voice_config
@@ -45745,22 +46161,21 @@ module Google
45745
46161
  end
45746
46162
  end
45747
46163
 
45748
- # The speech generation config.
46164
+ # Configuration for speech generation.
45749
46165
  class GoogleCloudAiplatformV1beta1SpeechConfig
45750
46166
  include Google::Apis::Core::Hashable
45751
46167
 
45752
- # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
46168
+ # Optional. The language code (ISO 639-1) for the speech synthesis.
45753
46169
  # Corresponds to the JSON property `languageCode`
45754
46170
  # @return [String]
45755
46171
  attr_accessor :language_code
45756
46172
 
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.
46173
+ # Configuration for a multi-speaker text-to-speech request.
45759
46174
  # Corresponds to the JSON property `multiSpeakerVoiceConfig`
45760
46175
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig]
45761
46176
  attr_accessor :multi_speaker_voice_config
45762
46177
 
45763
- # The configuration for the voice to use.
46178
+ # Configuration for a voice.
45764
46179
  # Corresponds to the JSON property `voiceConfig`
45765
46180
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VoiceConfig]
45766
46181
  attr_accessor :voice_config
@@ -47986,10 +48401,9 @@ module Google
47986
48401
  class GoogleCloudAiplatformV1beta1SyntheticField
47987
48402
  include Google::Apis::Core::Hashable
47988
48403
 
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.
48404
+ # The structured data content of a message. A Content message contains a `role`
48405
+ # field, which indicates the producer of the content, and a `parts` field, which
48406
+ # contains the multi-part data of the message.
47993
48407
  # Corresponds to the JSON property `content`
47994
48408
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
47995
48409
  attr_accessor :content
@@ -51651,11 +52065,13 @@ module Google
51651
52065
  end
51652
52066
  end
51653
52067
 
51654
- # Metadata related to url context retrieval tool.
52068
+ # Metadata returned when the model uses the `url_context` tool to get
52069
+ # information from a user-provided URL.
51655
52070
  class GoogleCloudAiplatformV1beta1UrlContextMetadata
51656
52071
  include Google::Apis::Core::Hashable
51657
52072
 
51658
- # Output only. List of url context.
52073
+ # Output only. A list of URL metadata, with one entry for each URL retrieved by
52074
+ # the tool.
51659
52075
  # Corresponds to the JSON property `urlMetadata`
51660
52076
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UrlMetadata>]
51661
52077
  attr_accessor :url_metadata
@@ -51670,16 +52086,16 @@ module Google
51670
52086
  end
51671
52087
  end
51672
52088
 
51673
- # Context of the a single url retrieval.
52089
+ # The metadata for a single URL retrieval.
51674
52090
  class GoogleCloudAiplatformV1beta1UrlMetadata
51675
52091
  include Google::Apis::Core::Hashable
51676
52092
 
51677
- # Retrieved url by the tool.
52093
+ # The URL retrieved by the tool.
51678
52094
  # Corresponds to the JSON property `retrievedUrl`
51679
52095
  # @return [String]
51680
52096
  attr_accessor :retrieved_url
51681
52097
 
51682
- # Status of the url retrieval.
52098
+ # The status of the URL retrieval.
51683
52099
  # Corresponds to the JSON property `urlRetrievalStatus`
51684
52100
  # @return [String]
51685
52101
  attr_accessor :url_retrieval_status
@@ -52110,7 +52526,8 @@ module Google
52110
52526
  end
52111
52527
  end
52112
52528
 
52113
- # Metadata describes the input video content.
52529
+ # Provides metadata for a video, including the start and end offsets for
52530
+ # clipping and the frame rate.
52114
52531
  class GoogleCloudAiplatformV1beta1VideoMetadata
52115
52532
  include Google::Apis::Core::Hashable
52116
52533
 
@@ -52120,7 +52537,7 @@ module Google
52120
52537
  attr_accessor :end_offset
52121
52538
 
52122
52539
  # 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].
52540
+ # default value is 1.0. The valid range is (0.0, 24.0].
52124
52541
  # Corresponds to the JSON property `fps`
52125
52542
  # @return [Float]
52126
52543
  attr_accessor :fps
@@ -52142,11 +52559,11 @@ module Google
52142
52559
  end
52143
52560
  end
52144
52561
 
52145
- # The configuration for the voice to use.
52562
+ # Configuration for a voice.
52146
52563
  class GoogleCloudAiplatformV1beta1VoiceConfig
52147
52564
  include Google::Apis::Core::Hashable
52148
52565
 
52149
- # The configuration for the prebuilt speaker to use.
52566
+ # Configuration for a prebuilt voice.
52150
52567
  # Corresponds to the JSON property `prebuiltVoiceConfig`
52151
52568
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig]
52152
52569
  attr_accessor :prebuilt_voice_config