google-apis-firebaseml_v2beta 0.34.0 → 0.36.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.
@@ -314,20 +314,21 @@ module Google
314
314
  end
315
315
  end
316
316
 
317
- # Content blob.
317
+ # A content blob. A Blob contains data of a specific media type. It is used to
318
+ # represent images, audio, and video.
318
319
  class GoogleCloudAiplatformV1beta1Blob
319
320
  include Google::Apis::Core::Hashable
320
321
 
321
- # Required. Raw bytes.
322
+ # Required. The raw bytes of the data.
322
323
  # Corresponds to the JSON property `data`
323
324
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
324
325
  # @return [String]
325
326
  attr_accessor :data
326
327
 
327
- # Optional. Display name of the blob. Used to provide a label or filename to
328
- # distinguish blobs. This field is only returned in PromptMessage for prompt
329
- # management. It is currently used in the Gemini GenerateContent calls only when
330
- # server side tools (code_execution, google_search, and url_context) are enabled.
328
+ # Optional. The display name of the blob. Used to provide a label or filename to
329
+ # distinguish blobs. This field is only returned in `PromptMessage` for prompt
330
+ # management. It is used in the Gemini calls only when server-side tools (`
331
+ # code_execution`, `google_search`, and `url_context`) are enabled.
331
332
  # Corresponds to the JSON property `displayName`
332
333
  # @return [String]
333
334
  attr_accessor :display_name
@@ -353,58 +354,70 @@ module Google
353
354
  class GoogleCloudAiplatformV1beta1Candidate
354
355
  include Google::Apis::Core::Hashable
355
356
 
356
- # Output only. Average log probability score of the candidate.
357
+ # Output only. The average log probability of the tokens in this candidate. This
358
+ # is a length-normalized score that can be used to compare the quality of
359
+ # candidates of different lengths. A higher average log probability suggests a
360
+ # more confident and coherent response.
357
361
  # Corresponds to the JSON property `avgLogprobs`
358
362
  # @return [Float]
359
363
  attr_accessor :avg_logprobs
360
364
 
361
- # A collection of source attributions for a piece of content.
365
+ # A collection of citations that apply to a piece of generated content.
362
366
  # Corresponds to the JSON property `citationMetadata`
363
367
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1CitationMetadata]
364
368
  attr_accessor :citation_metadata
365
369
 
366
- # The base structured datatype containing multi-part content of a message. A `
367
- # Content` includes a `role` field designating the producer of the `Content` and
368
- # a `parts` field containing multi-part data that contains the content of the
369
- # message turn.
370
+ # The structured data content of a message. A Content message contains a `role`
371
+ # field, which indicates the producer of the content, and a `parts` field, which
372
+ # contains the multi-part data of the message.
370
373
  # Corresponds to the JSON property `content`
371
374
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content]
372
375
  attr_accessor :content
373
376
 
374
- # Output only. Describes the reason the mode stopped generating tokens in more
375
- # detail. This is only filled when `finish_reason` is set.
377
+ # Output only. Describes the reason the model stopped generating tokens in more
378
+ # detail. This field is returned only when `finish_reason` is set.
376
379
  # Corresponds to the JSON property `finishMessage`
377
380
  # @return [String]
378
381
  attr_accessor :finish_message
379
382
 
380
383
  # Output only. The reason why the model stopped generating tokens. If empty, the
381
- # model has not stopped generating the tokens.
384
+ # model has not stopped generating.
382
385
  # Corresponds to the JSON property `finishReason`
383
386
  # @return [String]
384
387
  attr_accessor :finish_reason
385
388
 
386
- # Metadata returned to client when grounding is enabled.
389
+ # Information about the sources that support the content of a response. When
390
+ # grounding is enabled, the model returns citations for claims in the response.
391
+ # This object contains the retrieved sources.
387
392
  # Corresponds to the JSON property `groundingMetadata`
388
393
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingMetadata]
389
394
  attr_accessor :grounding_metadata
390
395
 
391
- # Output only. Index of the candidate.
396
+ # Output only. The 0-based index of this candidate in the list of generated
397
+ # responses. This is useful for distinguishing between multiple candidates when `
398
+ # candidate_count` > 1.
392
399
  # Corresponds to the JSON property `index`
393
400
  # @return [Fixnum]
394
401
  attr_accessor :index
395
402
 
396
- # Logprobs Result
403
+ # The log probabilities of the tokens generated by the model. This is useful for
404
+ # understanding the model's confidence in its predictions and for debugging. For
405
+ # example, you can use log probabilities to identify when the model is making a
406
+ # less confident prediction or to explore alternative responses that the model
407
+ # considered. A low log probability can also indicate that the model is "
408
+ # hallucinating" or generating factually incorrect information.
397
409
  # Corresponds to the JSON property `logprobsResult`
398
410
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1LogprobsResult]
399
411
  attr_accessor :logprobs_result
400
412
 
401
- # Output only. List of ratings for the safety of a response candidate. There is
402
- # at most one rating per category.
413
+ # Output only. A list of ratings for the safety of a response candidate. There
414
+ # is at most one rating per category.
403
415
  # Corresponds to the JSON property `safetyRatings`
404
416
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SafetyRating>]
405
417
  attr_accessor :safety_ratings
406
418
 
407
- # Metadata related to url context retrieval tool.
419
+ # Metadata returned when the model uses the `url_context` tool to get
420
+ # information from a user-provided URL.
408
421
  # Corresponds to the JSON property `urlContextMetadata`
409
422
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1UrlContextMetadata]
410
423
  attr_accessor :url_context_metadata
@@ -428,16 +441,16 @@ module Google
428
441
  end
429
442
  end
430
443
 
431
- # Source attributions for content.
444
+ # A citation for a piece of generatedcontent.
432
445
  class GoogleCloudAiplatformV1beta1Citation
433
446
  include Google::Apis::Core::Hashable
434
447
 
435
- # Output only. End index into the content.
448
+ # Output only. The end index of the citation in the content.
436
449
  # Corresponds to the JSON property `endIndex`
437
450
  # @return [Fixnum]
438
451
  attr_accessor :end_index
439
452
 
440
- # Output only. License of the attribution.
453
+ # Output only. The license of the source of the citation.
441
454
  # Corresponds to the JSON property `license`
442
455
  # @return [String]
443
456
  attr_accessor :license
@@ -454,17 +467,17 @@ module Google
454
467
  # @return [Google::Apis::FirebasemlV2beta::Date]
455
468
  attr_accessor :publication_date
456
469
 
457
- # Output only. Start index into the content.
470
+ # Output only. The start index of the citation in the content.
458
471
  # Corresponds to the JSON property `startIndex`
459
472
  # @return [Fixnum]
460
473
  attr_accessor :start_index
461
474
 
462
- # Output only. Title of the attribution.
475
+ # Output only. The title of the source of the citation.
463
476
  # Corresponds to the JSON property `title`
464
477
  # @return [String]
465
478
  attr_accessor :title
466
479
 
467
- # Output only. Url reference of the attribution.
480
+ # Output only. The URI of the source of the citation.
468
481
  # Corresponds to the JSON property `uri`
469
482
  # @return [String]
470
483
  attr_accessor :uri
@@ -484,11 +497,11 @@ module Google
484
497
  end
485
498
  end
486
499
 
487
- # A collection of source attributions for a piece of content.
500
+ # A collection of citations that apply to a piece of generated content.
488
501
  class GoogleCloudAiplatformV1beta1CitationMetadata
489
502
  include Google::Apis::Core::Hashable
490
503
 
491
- # Output only. List of citations.
504
+ # Output only. A list of citations for the content.
492
505
  # Corresponds to the JSON property `citations`
493
506
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Citation>]
494
507
  attr_accessor :citations
@@ -531,22 +544,21 @@ module Google
531
544
  end
532
545
  end
533
546
 
534
- # The base structured datatype containing multi-part content of a message. A `
535
- # Content` includes a `role` field designating the producer of the `Content` and
536
- # a `parts` field containing multi-part data that contains the content of the
537
- # message turn.
547
+ # The structured data content of a message. A Content message contains a `role`
548
+ # field, which indicates the producer of the content, and a `parts` field, which
549
+ # contains the multi-part data of the message.
538
550
  class GoogleCloudAiplatformV1beta1Content
539
551
  include Google::Apis::Core::Hashable
540
552
 
541
- # Required. Ordered `Parts` that constitute a single message. Parts may have
542
- # different IANA MIME types.
553
+ # Required. A list of Part objects that make up a single message. Parts of a
554
+ # message can have different MIME types. A Content message must have at least
555
+ # one Part.
543
556
  # Corresponds to the JSON property `parts`
544
557
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Part>]
545
558
  attr_accessor :parts
546
559
 
547
- # Optional. The producer of the content. Must be either 'user' or 'model'.
548
- # Useful to set for multi-turn conversations, otherwise can be left blank or
549
- # unset.
560
+ # Optional. The producer of the content. Must be either 'user' or 'model'. If
561
+ # not set, the service will default to 'user'.
550
562
  # Corresponds to the JSON property `role`
551
563
  # @return [String]
552
564
  attr_accessor :role
@@ -571,7 +583,9 @@ module Google
571
583
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content>]
572
584
  attr_accessor :contents
573
585
 
574
- # Generation config.
586
+ # Configuration for content generation. This message contains all the parameters
587
+ # that control how the model generates content. It allows you to influence the
588
+ # randomness, length, and structure of the output.
575
589
  # Corresponds to the JSON property `generationConfig`
576
590
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfig]
577
591
  attr_accessor :generation_config
@@ -588,10 +602,9 @@ module Google
588
602
  # @return [String]
589
603
  attr_accessor :model
590
604
 
591
- # The base structured datatype containing multi-part content of a message. A `
592
- # Content` includes a `role` field designating the producer of the `Content` and
593
- # a `parts` field containing multi-part data that contains the content of the
594
- # message turn.
605
+ # The structured data content of a message. A Content message contains a `role`
606
+ # field, which indicates the producer of the content, and a `parts` field, which
607
+ # contains the multi-part data of the message.
595
608
  # Corresponds to the JSON property `systemInstruction`
596
609
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content]
597
610
  attr_accessor :system_instruction
@@ -831,20 +844,21 @@ module Google
831
844
  end
832
845
  end
833
846
 
834
- # URI based data.
847
+ # URI-based data. A FileData message contains a URI pointing to data of a
848
+ # specific media type. It is used to represent images, audio, and video stored
849
+ # in Google Cloud Storage.
835
850
  class GoogleCloudAiplatformV1beta1FileData
836
851
  include Google::Apis::Core::Hashable
837
852
 
838
- # Optional. Display name of the file data. Used to provide a label or filename
839
- # to distinguish file datas. This field is only returned in PromptMessage for
840
- # prompt management. It is currently used in the Gemini GenerateContent calls
841
- # only when server side tools (code_execution, google_search, and url_context)
842
- # are enabled.
853
+ # Optional. The display name of the file. Used to provide a label or filename to
854
+ # distinguish files. This field is only returned in `PromptMessage` for prompt
855
+ # management. It is used in the Gemini calls only when server side tools (`
856
+ # code_execution`, `google_search`, and `url_context`) are enabled.
843
857
  # Corresponds to the JSON property `displayName`
844
858
  # @return [String]
845
859
  attr_accessor :display_name
846
860
 
847
- # Required. URI.
861
+ # Required. The URI of the file in Google Cloud Storage.
848
862
  # Corresponds to the JSON property `fileUri`
849
863
  # @return [String]
850
864
  attr_accessor :file_uri
@@ -889,6 +903,19 @@ module Google
889
903
  # @return [String]
890
904
  attr_accessor :name
891
905
 
906
+ # Optional. The partial argument value of the function call. If provided,
907
+ # represents the arguments/fields that are streamed incrementally.
908
+ # Corresponds to the JSON property `partialArgs`
909
+ # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1PartialArg>]
910
+ attr_accessor :partial_args
911
+
912
+ # Optional. Whether this is the last part of the FunctionCall. If true, another
913
+ # partial message for the current FunctionCall is expected to follow.
914
+ # Corresponds to the JSON property `willContinue`
915
+ # @return [Boolean]
916
+ attr_accessor :will_continue
917
+ alias_method :will_continue?, :will_continue
918
+
892
919
  def initialize(**args)
893
920
  update!(**args)
894
921
  end
@@ -898,6 +925,8 @@ module Google
898
925
  @args = args[:args] if args.key?(:args)
899
926
  @id = args[:id] if args.key?(:id)
900
927
  @name = args[:name] if args.key?(:name)
928
+ @partial_args = args[:partial_args] if args.key?(:partial_args)
929
+ @will_continue = args[:will_continue] if args.key?(:will_continue)
901
930
  end
902
931
  end
903
932
 
@@ -917,6 +946,14 @@ module Google
917
946
  # @return [String]
918
947
  attr_accessor :mode
919
948
 
949
+ # Optional. When set to true, arguments of a single function call will be
950
+ # streamed out in multiple parts/contents/responses. Partial parameter results
951
+ # will be returned in the [FunctionCall.partial_args] field.
952
+ # Corresponds to the JSON property `streamFunctionCallArguments`
953
+ # @return [Boolean]
954
+ attr_accessor :stream_function_call_arguments
955
+ alias_method :stream_function_call_arguments?, :stream_function_call_arguments
956
+
920
957
  def initialize(**args)
921
958
  update!(**args)
922
959
  end
@@ -925,6 +962,7 @@ module Google
925
962
  def update!(**args)
926
963
  @allowed_function_names = args[:allowed_function_names] if args.key?(:allowed_function_names)
927
964
  @mode = args[:mode] if args.key?(:mode)
965
+ @stream_function_call_arguments = args[:stream_function_call_arguments] if args.key?(:stream_function_call_arguments)
928
966
  end
929
967
  end
930
968
 
@@ -943,8 +981,8 @@ module Google
943
981
  attr_accessor :description
944
982
 
945
983
  # Required. The name of the function to call. Must start with a letter or an
946
- # underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes,
947
- # with a maximum length of 64.
984
+ # underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and
985
+ # dashes, with a maximum length of 64.
948
986
  # Corresponds to the JSON property `name`
949
987
  # @return [String]
950
988
  attr_accessor :name
@@ -1163,7 +1201,9 @@ module Google
1163
1201
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content>]
1164
1202
  attr_accessor :contents
1165
1203
 
1166
- # Generation config.
1204
+ # Configuration for content generation. This message contains all the parameters
1205
+ # that control how the model generates content. It allows you to influence the
1206
+ # randomness, length, and structure of the output.
1167
1207
  # Corresponds to the JSON property `generationConfig`
1168
1208
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfig]
1169
1209
  attr_accessor :generation_config
@@ -1177,7 +1217,10 @@ module Google
1177
1217
  # @return [Hash<String,String>]
1178
1218
  attr_accessor :labels
1179
1219
 
1180
- # Configuration for Model Armor integrations of prompt and responses.
1220
+ # Configuration for Model Armor. Model Armor is a Google Cloud service that
1221
+ # provides safety and security filtering for prompts and responses. It helps
1222
+ # protect your AI applications from risks such as harmful content, sensitive
1223
+ # data leakage, and prompt injection attacks.
1181
1224
  # Corresponds to the JSON property `modelArmorConfig`
1182
1225
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ModelArmorConfig]
1183
1226
  attr_accessor :model_armor_config
@@ -1188,10 +1231,9 @@ module Google
1188
1231
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SafetySetting>]
1189
1232
  attr_accessor :safety_settings
1190
1233
 
1191
- # The base structured datatype containing multi-part content of a message. A `
1192
- # Content` includes a `role` field designating the producer of the `Content` and
1193
- # a `parts` field containing multi-part data that contains the content of the
1194
- # message turn.
1234
+ # The structured data content of a message. A Content message contains a `role`
1235
+ # field, which indicates the producer of the content, and a `parts` field, which
1236
+ # contains the multi-part data of the message.
1195
1237
  # Corresponds to the JSON property `systemInstruction`
1196
1238
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content]
1197
1239
  attr_accessor :system_instruction
@@ -1406,50 +1448,72 @@ module Google
1406
1448
  end
1407
1449
  end
1408
1450
 
1409
- # Generation config.
1451
+ # Configuration for content generation. This message contains all the parameters
1452
+ # that control how the model generates content. It allows you to influence the
1453
+ # randomness, length, and structure of the output.
1410
1454
  class GoogleCloudAiplatformV1beta1GenerationConfig
1411
1455
  include Google::Apis::Core::Hashable
1412
1456
 
1413
- # Optional. If enabled, audio timestamp will be included in the request to the
1414
- # model.
1457
+ # Optional. If enabled, audio timestamps will be included in the request to the
1458
+ # model. This can be useful for synchronizing audio with other modalities in the
1459
+ # response.
1415
1460
  # Corresponds to the JSON property `audioTimestamp`
1416
1461
  # @return [Boolean]
1417
1462
  attr_accessor :audio_timestamp
1418
1463
  alias_method :audio_timestamp?, :audio_timestamp
1419
1464
 
1420
- # Optional. Number of candidates to generate.
1465
+ # Optional. The number of candidate responses to generate. A higher `
1466
+ # candidate_count` can provide more options to choose from, but it also consumes
1467
+ # more resources. This can be useful for generating a variety of responses and
1468
+ # selecting the best one.
1421
1469
  # Corresponds to the JSON property `candidateCount`
1422
1470
  # @return [Fixnum]
1423
1471
  attr_accessor :candidate_count
1424
1472
 
1425
1473
  # Optional. If enabled, the model will detect emotions and adapt its responses
1426
- # accordingly.
1474
+ # accordingly. For example, if the model detects that the user is frustrated, it
1475
+ # may provide a more empathetic response.
1427
1476
  # Corresponds to the JSON property `enableAffectiveDialog`
1428
1477
  # @return [Boolean]
1429
1478
  attr_accessor :enable_affective_dialog
1430
1479
  alias_method :enable_affective_dialog?, :enable_affective_dialog
1431
1480
 
1432
- # Optional. Frequency penalties.
1481
+ # Optional. Penalizes tokens based on their frequency in the generated text. A
1482
+ # positive value helps to reduce the repetition of words and phrases. Valid
1483
+ # values can range from [-2.0, 2.0].
1433
1484
  # Corresponds to the JSON property `frequencyPenalty`
1434
1485
  # @return [Float]
1435
1486
  attr_accessor :frequency_penalty
1436
1487
 
1437
- # Config for image generation features.
1488
+ # Configuration for image generation. This message allows you to control various
1489
+ # aspects of image generation, such as the output format, aspect ratio, and
1490
+ # whether the model can generate images of people.
1438
1491
  # Corresponds to the JSON property `imageConfig`
1439
1492
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ImageConfig]
1440
1493
  attr_accessor :image_config
1441
1494
 
1442
- # Optional. Logit probabilities.
1495
+ # Optional. The number of top log probabilities to return for each token. This
1496
+ # can be used to see which other tokens were considered likely candidates for a
1497
+ # given position. A higher value will return more options, but it will also
1498
+ # increase the size of the response.
1443
1499
  # Corresponds to the JSON property `logprobs`
1444
1500
  # @return [Fixnum]
1445
1501
  attr_accessor :logprobs
1446
1502
 
1447
- # Optional. The maximum number of output tokens to generate per message.
1503
+ # Optional. The maximum number of tokens to generate in the response. A token is
1504
+ # approximately four characters. The default value varies by model. This
1505
+ # parameter can be used to control the length of the generated text and prevent
1506
+ # overly long responses.
1448
1507
  # Corresponds to the JSON property `maxOutputTokens`
1449
1508
  # @return [Fixnum]
1450
1509
  attr_accessor :max_output_tokens
1451
1510
 
1452
- # Optional. If specified, the media resolution specified will be used.
1511
+ # Optional. The token resolution at which input media content is sampled. This
1512
+ # is used to control the trade-off between the quality of the response and the
1513
+ # number of tokens used to represent the media. A higher resolution allows the
1514
+ # model to perceive more detail, which can lead to a more nuanced response, but
1515
+ # it will also use more tokens. This does not affect the image dimensions sent
1516
+ # to the model.
1453
1517
  # Corresponds to the JSON property `mediaResolution`
1454
1518
  # @return [String]
1455
1519
  attr_accessor :media_resolution
@@ -1459,44 +1523,41 @@ module Google
1459
1523
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigModelConfig]
1460
1524
  attr_accessor :model_config
1461
1525
 
1462
- # Optional. Positive penalties.
1526
+ # Optional. Penalizes tokens that have already appeared in the generated text. A
1527
+ # positive value encourages the model to generate more diverse and less
1528
+ # repetitive text. Valid values can range from [-2.0, 2.0].
1463
1529
  # Corresponds to the JSON property `presencePenalty`
1464
1530
  # @return [Float]
1465
1531
  attr_accessor :presence_penalty
1466
1532
 
1467
- # Optional. Output schema of the generated response. This is an alternative to `
1468
- # response_schema` that accepts [JSON Schema](https://json-schema.org/). If set,
1469
- # `response_schema` must be omitted, but `response_mime_type` is required. While
1470
- # the full JSON Schema may be sent, not all features are supported. Specifically,
1471
- # only the following properties are supported: - `$id` - `$defs` - `$ref` - `$
1472
- # anchor` - `type` - `format` - `title` - `description` - `enum` (for strings
1473
- # and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` -
1474
- # `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties`
1475
- # - `additionalProperties` - `required` The non-standard `propertyOrdering`
1476
- # property may also be set. Cyclic references are unrolled to a limited degree
1477
- # and, as such, may only be used within non-required properties. (Nullable
1478
- # properties are not sufficient.) If `$ref` is set on a sub-schema, no other
1479
- # properties, except for than those starting as a `$`, may be set.
1533
+ # Optional. When this field is set, response_schema must be omitted and
1534
+ # response_mime_type must be set to `application/json`.
1480
1535
  # Corresponds to the JSON property `responseJsonSchema`
1481
1536
  # @return [Object]
1482
1537
  attr_accessor :response_json_schema
1483
1538
 
1484
- # Optional. If true, export the logprobs results in response.
1539
+ # Optional. If set to true, the log probabilities of the output tokens are
1540
+ # returned. Log probabilities are the logarithm of the probability of a token
1541
+ # appearing in the output. A higher log probability means the token is more
1542
+ # likely to be generated. This can be useful for analyzing the model's
1543
+ # confidence in its own output and for debugging.
1485
1544
  # Corresponds to the JSON property `responseLogprobs`
1486
1545
  # @return [Boolean]
1487
1546
  attr_accessor :response_logprobs
1488
1547
  alias_method :response_logprobs?, :response_logprobs
1489
1548
 
1490
- # Optional. Output response mimetype of the generated candidate text. Supported
1491
- # mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON
1492
- # response in the candidates. The model needs to be prompted to output the
1549
+ # Optional. The IANA standard MIME type of the response. The model will generate
1550
+ # output that conforms to this MIME type. Supported values include 'text/plain' (
1551
+ # default) and 'application/json'. The model needs to be prompted to output the
1493
1552
  # appropriate response type, otherwise the behavior is undefined. This is a
1494
1553
  # preview feature.
1495
1554
  # Corresponds to the JSON property `responseMimeType`
1496
1555
  # @return [String]
1497
1556
  attr_accessor :response_mime_type
1498
1557
 
1499
- # Optional. The modalities of the response.
1558
+ # Optional. The modalities of the response. The model will generate a response
1559
+ # that includes all the specified modalities. For example, if this is set to `[
1560
+ # TEXT, IMAGE]`, the response will include both text and an image.
1500
1561
  # Corresponds to the JSON property `responseModalities`
1501
1562
  # @return [Array<String>]
1502
1563
  attr_accessor :response_modalities
@@ -1508,42 +1569,68 @@ module Google
1508
1569
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Schema]
1509
1570
  attr_accessor :response_schema
1510
1571
 
1511
- # The configuration for routing the request to a specific model.
1572
+ # The configuration for routing the request to a specific model. This can be
1573
+ # used to control which model is used for the generation, either automatically
1574
+ # or by specifying a model name.
1512
1575
  # Corresponds to the JSON property `routingConfig`
1513
1576
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig]
1514
1577
  attr_accessor :routing_config
1515
1578
 
1516
- # Optional. Seed.
1579
+ # Optional. A seed for the random number generator. By setting a seed, you can
1580
+ # make the model's output mostly deterministic. For a given prompt and
1581
+ # parameters (like temperature, top_p, etc.), the model will produce the same
1582
+ # response every time. However, it's not a guaranteed absolute deterministic
1583
+ # behavior. This is different from parameters like `temperature`, which control
1584
+ # the *level* of randomness. `seed` ensures that the "random" choices the model
1585
+ # makes are the same on every run, making it essential for testing and ensuring
1586
+ # reproducible results.
1517
1587
  # Corresponds to the JSON property `seed`
1518
1588
  # @return [Fixnum]
1519
1589
  attr_accessor :seed
1520
1590
 
1521
- # The speech generation config.
1591
+ # Configuration for speech generation.
1522
1592
  # Corresponds to the JSON property `speechConfig`
1523
1593
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SpeechConfig]
1524
1594
  attr_accessor :speech_config
1525
1595
 
1526
- # Optional. Stop sequences.
1596
+ # Optional. A list of character sequences that will stop the model from
1597
+ # generating further tokens. If a stop sequence is generated, the output will
1598
+ # end at that point. This is useful for controlling the length and structure of
1599
+ # the output. For example, you can use ["\n", "###"] to stop generation at a new
1600
+ # line or a specific marker.
1527
1601
  # Corresponds to the JSON property `stopSequences`
1528
1602
  # @return [Array<String>]
1529
1603
  attr_accessor :stop_sequences
1530
1604
 
1531
- # Optional. Controls the randomness of predictions.
1605
+ # Optional. Controls the randomness of the output. A higher temperature results
1606
+ # in more creative and diverse responses, while a lower temperature makes the
1607
+ # output more predictable and focused. The valid range is (0.0, 2.0].
1532
1608
  # Corresponds to the JSON property `temperature`
1533
1609
  # @return [Float]
1534
1610
  attr_accessor :temperature
1535
1611
 
1536
- # Config for thinking features.
1612
+ # Configuration for the model's thinking features. "Thinking" is a process where
1613
+ # the model breaks down a complex task into smaller, manageable steps. This
1614
+ # allows the model to reason about the task, plan its approach, and execute the
1615
+ # plan to generate a high-quality response.
1537
1616
  # Corresponds to the JSON property `thinkingConfig`
1538
1617
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig]
1539
1618
  attr_accessor :thinking_config
1540
1619
 
1541
- # Optional. If specified, top-k sampling will be used.
1620
+ # Optional. Specifies the top-k sampling threshold. The model considers only the
1621
+ # top k most probable tokens for the next token. This can be useful for
1622
+ # generating more coherent and less random text. For example, a `top_k` of 40
1623
+ # means the model will choose the next word from the 40 most likely words.
1542
1624
  # Corresponds to the JSON property `topK`
1543
1625
  # @return [Float]
1544
1626
  attr_accessor :top_k
1545
1627
 
1546
- # Optional. If specified, nucleus sampling will be used.
1628
+ # Optional. Specifies the nucleus sampling threshold. The model considers only
1629
+ # the smallest set of tokens whose cumulative probability is at least `top_p`.
1630
+ # This helps generate more diverse and less repetitive responses. For example, a
1631
+ # `top_p` of 0.9 means the model considers tokens until the cumulative
1632
+ # probability of the tokens to select from reaches 0.9. It's recommended to
1633
+ # adjust either temperature or `top_p`, but not both.
1547
1634
  # Corresponds to the JSON property `topP`
1548
1635
  # @return [Float]
1549
1636
  attr_accessor :top_p
@@ -1599,17 +1686,21 @@ module Google
1599
1686
  end
1600
1687
  end
1601
1688
 
1602
- # The configuration for routing the request to a specific model.
1689
+ # The configuration for routing the request to a specific model. This can be
1690
+ # used to control which model is used for the generation, either automatically
1691
+ # or by specifying a model name.
1603
1692
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig
1604
1693
  include Google::Apis::Core::Hashable
1605
1694
 
1606
- # When automated routing is specified, the routing will be determined by the
1607
- # pretrained routing model and customer provided model routing preference.
1695
+ # The configuration for automated routing. When automated routing is specified,
1696
+ # the routing will be determined by the pretrained routing model and customer
1697
+ # provided model routing preference.
1608
1698
  # Corresponds to the JSON property `autoMode`
1609
1699
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode]
1610
1700
  attr_accessor :auto_mode
1611
1701
 
1612
- # When manual routing is set, the specified model will be used directly.
1702
+ # The configuration for manual routing. When manual routing is specified, the
1703
+ # model will be selected based on the model name provided.
1613
1704
  # Corresponds to the JSON property `manualMode`
1614
1705
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode]
1615
1706
  attr_accessor :manual_mode
@@ -1625,8 +1716,9 @@ module Google
1625
1716
  end
1626
1717
  end
1627
1718
 
1628
- # When automated routing is specified, the routing will be determined by the
1629
- # pretrained routing model and customer provided model routing preference.
1719
+ # The configuration for automated routing. When automated routing is specified,
1720
+ # the routing will be determined by the pretrained routing model and customer
1721
+ # provided model routing preference.
1630
1722
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode
1631
1723
  include Google::Apis::Core::Hashable
1632
1724
 
@@ -1645,13 +1737,12 @@ module Google
1645
1737
  end
1646
1738
  end
1647
1739
 
1648
- # When manual routing is set, the specified model will be used directly.
1740
+ # The configuration for manual routing. When manual routing is specified, the
1741
+ # model will be selected based on the model name provided.
1649
1742
  class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode
1650
1743
  include Google::Apis::Core::Hashable
1651
1744
 
1652
- # The model name to use. Only the public LLM models are accepted. See [Supported
1653
- # models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/
1654
- # inference#supported-models).
1745
+ # The name of the model to use. Only public LLM models are accepted.
1655
1746
  # Corresponds to the JSON property `modelName`
1656
1747
  # @return [String]
1657
1748
  attr_accessor :model_name
@@ -1666,22 +1757,35 @@ module Google
1666
1757
  end
1667
1758
  end
1668
1759
 
1669
- # Config for thinking features.
1760
+ # Configuration for the model's thinking features. "Thinking" is a process where
1761
+ # the model breaks down a complex task into smaller, manageable steps. This
1762
+ # allows the model to reason about the task, plan its approach, and execute the
1763
+ # plan to generate a high-quality response.
1670
1764
  class GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig
1671
1765
  include Google::Apis::Core::Hashable
1672
1766
 
1673
- # Optional. Indicates whether to include thoughts in the response. If true,
1674
- # thoughts are returned only when available.
1767
+ # Optional. If true, the model will include its thoughts in the response. "
1768
+ # Thoughts" are the intermediate steps the model takes to arrive at the final
1769
+ # response. They can provide insights into the model's reasoning process and
1770
+ # help with debugging. If this is true, thoughts are returned only when
1771
+ # available.
1675
1772
  # Corresponds to the JSON property `includeThoughts`
1676
1773
  # @return [Boolean]
1677
1774
  attr_accessor :include_thoughts
1678
1775
  alias_method :include_thoughts?, :include_thoughts
1679
1776
 
1680
- # Optional. Indicates the thinking budget in tokens.
1777
+ # Optional. The token budget for the model's thinking process. The model will
1778
+ # make a best effort to stay within this budget. This can be used to control the
1779
+ # trade-off between response quality and latency.
1681
1780
  # Corresponds to the JSON property `thinkingBudget`
1682
1781
  # @return [Fixnum]
1683
1782
  attr_accessor :thinking_budget
1684
1783
 
1784
+ # Optional. The number of thoughts tokens that the model should generate.
1785
+ # Corresponds to the JSON property `thinkingLevel`
1786
+ # @return [String]
1787
+ attr_accessor :thinking_level
1788
+
1685
1789
  def initialize(**args)
1686
1790
  update!(**args)
1687
1791
  end
@@ -1690,6 +1794,7 @@ module Google
1690
1794
  def update!(**args)
1691
1795
  @include_thoughts = args[:include_thoughts] if args.key?(:include_thoughts)
1692
1796
  @thinking_budget = args[:thinking_budget] if args.key?(:thinking_budget)
1797
+ @thinking_level = args[:thinking_level] if args.key?(:thinking_level)
1693
1798
  end
1694
1799
  end
1695
1800
 
@@ -1732,21 +1837,30 @@ module Google
1732
1837
  end
1733
1838
  end
1734
1839
 
1735
- # Grounding chunk.
1840
+ # A piece of evidence that supports a claim made by the model. This is used to
1841
+ # show a citation for a claim made by the model. When grounding is enabled, the
1842
+ # model returns a `GroundingChunk` that contains a reference to the source of
1843
+ # the information.
1736
1844
  class GoogleCloudAiplatformV1beta1GroundingChunk
1737
1845
  include Google::Apis::Core::Hashable
1738
1846
 
1739
- # Chunk from Google Maps.
1847
+ # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
1848
+ # information about a place, such as its name, address, and reviews. This is
1849
+ # used to provide the user with rich, location-based information.
1740
1850
  # Corresponds to the JSON property `maps`
1741
1851
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkMaps]
1742
1852
  attr_accessor :maps
1743
1853
 
1744
- # Chunk from context retrieved by the retrieval tools.
1854
+ # Context retrieved from a data source to ground the model's response. This is
1855
+ # used when a retrieval tool fetches information from a user-provided corpus or
1856
+ # a public dataset.
1745
1857
  # Corresponds to the JSON property `retrievedContext`
1746
1858
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext]
1747
1859
  attr_accessor :retrieved_context
1748
1860
 
1749
- # Chunk from the web.
1861
+ # A `Web` chunk is a piece of evidence that comes from a web page. It contains
1862
+ # the URI of the web page, the title of the page, and the domain of the page.
1863
+ # This is used to provide the user with a link to the source of the information.
1750
1864
  # Corresponds to the JSON property `web`
1751
1865
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkWeb]
1752
1866
  attr_accessor :web
@@ -1763,32 +1877,36 @@ module Google
1763
1877
  end
1764
1878
  end
1765
1879
 
1766
- # Chunk from Google Maps.
1880
+ # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
1881
+ # information about a place, such as its name, address, and reviews. This is
1882
+ # used to provide the user with rich, location-based information.
1767
1883
  class GoogleCloudAiplatformV1beta1GroundingChunkMaps
1768
1884
  include Google::Apis::Core::Hashable
1769
1885
 
1770
- # Sources used to generate the place answer.
1886
+ # The sources that were used to generate the place answer. This includes review
1887
+ # snippets and photos that were used to generate the answer, as well as URIs to
1888
+ # flag content.
1771
1889
  # Corresponds to the JSON property `placeAnswerSources`
1772
1890
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources]
1773
1891
  attr_accessor :place_answer_sources
1774
1892
 
1775
- # This Place's resource name, in `places/`place_id`` format. Can be used to look
1776
- # up the Place.
1893
+ # This Place's resource name, in `places/`place_id`` format. This can be used to
1894
+ # look up the place in the Google Maps API.
1777
1895
  # Corresponds to the JSON property `placeId`
1778
1896
  # @return [String]
1779
1897
  attr_accessor :place_id
1780
1898
 
1781
- # Text of the place answer.
1899
+ # The text of the place answer.
1782
1900
  # Corresponds to the JSON property `text`
1783
1901
  # @return [String]
1784
1902
  attr_accessor :text
1785
1903
 
1786
- # Title of the place.
1904
+ # The title of the place.
1787
1905
  # Corresponds to the JSON property `title`
1788
1906
  # @return [String]
1789
1907
  attr_accessor :title
1790
1908
 
1791
- # URI reference of the place.
1909
+ # The URI of the place.
1792
1910
  # Corresponds to the JSON property `uri`
1793
1911
  # @return [String]
1794
1912
  attr_accessor :uri
@@ -1807,11 +1925,13 @@ module Google
1807
1925
  end
1808
1926
  end
1809
1927
 
1810
- # Sources used to generate the place answer.
1928
+ # The sources that were used to generate the place answer. This includes review
1929
+ # snippets and photos that were used to generate the answer, as well as URIs to
1930
+ # flag content.
1811
1931
  class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources
1812
1932
  include Google::Apis::Core::Hashable
1813
1933
 
1814
- # Snippets of reviews that are used to generate the answer.
1934
+ # Snippets of reviews that were used to generate the answer.
1815
1935
  # Corresponds to the JSON property `reviewSnippets`
1816
1936
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet>]
1817
1937
  attr_accessor :review_snippets
@@ -1826,7 +1946,7 @@ module Google
1826
1946
  end
1827
1947
  end
1828
1948
 
1829
- # Encapsulates a review snippet.
1949
+ # A review snippet that is used to generate the answer.
1830
1950
  class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
1831
1951
  include Google::Apis::Core::Hashable
1832
1952
 
@@ -1835,12 +1955,12 @@ module Google
1835
1955
  # @return [String]
1836
1956
  attr_accessor :google_maps_uri
1837
1957
 
1838
- # Id of the review referencing the place.
1958
+ # The ID of the review that is being referenced.
1839
1959
  # Corresponds to the JSON property `reviewId`
1840
1960
  # @return [String]
1841
1961
  attr_accessor :review_id
1842
1962
 
1843
- # Title of the review.
1963
+ # The title of the review.
1844
1964
  # Corresponds to the JSON property `title`
1845
1965
  # @return [String]
1846
1966
  attr_accessor :title
@@ -1857,12 +1977,16 @@ module Google
1857
1977
  end
1858
1978
  end
1859
1979
 
1860
- # Chunk from context retrieved by the retrieval tools.
1980
+ # Context retrieved from a data source to ground the model's response. This is
1981
+ # used when a retrieval tool fetches information from a user-provided corpus or
1982
+ # a public dataset.
1861
1983
  class GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext
1862
1984
  include Google::Apis::Core::Hashable
1863
1985
 
1864
- # Output only. The full document name for the referenced Vertex AI Search
1865
- # document.
1986
+ # Output only. The full resource name of the referenced Vertex AI Search
1987
+ # document. This is used to identify the specific document that was retrieved.
1988
+ # The format is `projects/`project`/locations/`location`/collections/`collection`
1989
+ # /dataStores/`data_store`/branches/`branch`/documents/`document``.
1866
1990
  # Corresponds to the JSON property `documentName`
1867
1991
  # @return [String]
1868
1992
  attr_accessor :document_name
@@ -1873,17 +1997,17 @@ module Google
1873
1997
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1RagChunk]
1874
1998
  attr_accessor :rag_chunk
1875
1999
 
1876
- # Text of the attribution.
2000
+ # The content of the retrieved data source.
1877
2001
  # Corresponds to the JSON property `text`
1878
2002
  # @return [String]
1879
2003
  attr_accessor :text
1880
2004
 
1881
- # Title of the attribution.
2005
+ # The title of the retrieved data source.
1882
2006
  # Corresponds to the JSON property `title`
1883
2007
  # @return [String]
1884
2008
  attr_accessor :title
1885
2009
 
1886
- # URI reference of the attribution.
2010
+ # The URI of the retrieved data source.
1887
2011
  # Corresponds to the JSON property `uri`
1888
2012
  # @return [String]
1889
2013
  attr_accessor :uri
@@ -1902,21 +2026,24 @@ module Google
1902
2026
  end
1903
2027
  end
1904
2028
 
1905
- # Chunk from the web.
2029
+ # A `Web` chunk is a piece of evidence that comes from a web page. It contains
2030
+ # the URI of the web page, the title of the page, and the domain of the page.
2031
+ # This is used to provide the user with a link to the source of the information.
1906
2032
  class GoogleCloudAiplatformV1beta1GroundingChunkWeb
1907
2033
  include Google::Apis::Core::Hashable
1908
2034
 
1909
- # Domain of the (original) URI.
2035
+ # The domain of the web page that contains the evidence. This can be used to
2036
+ # filter out low-quality sources.
1910
2037
  # Corresponds to the JSON property `domain`
1911
2038
  # @return [String]
1912
2039
  attr_accessor :domain
1913
2040
 
1914
- # Title of the chunk.
2041
+ # The title of the web page that contains the evidence.
1915
2042
  # Corresponds to the JSON property `title`
1916
2043
  # @return [String]
1917
2044
  attr_accessor :title
1918
2045
 
1919
- # URI reference of the chunk.
2046
+ # The URI of the web page that contains the evidence.
1920
2047
  # Corresponds to the JSON property `uri`
1921
2048
  # @return [String]
1922
2049
  attr_accessor :uri
@@ -1933,49 +2060,63 @@ module Google
1933
2060
  end
1934
2061
  end
1935
2062
 
1936
- # Metadata returned to client when grounding is enabled.
2063
+ # Information about the sources that support the content of a response. When
2064
+ # grounding is enabled, the model returns citations for claims in the response.
2065
+ # This object contains the retrieved sources.
1937
2066
  class GoogleCloudAiplatformV1beta1GroundingMetadata
1938
2067
  include Google::Apis::Core::Hashable
1939
2068
 
1940
- # Optional. Output only. Resource name of the Google Maps widget context token
1941
- # to be used with the PlacesContextElement widget to render contextual data.
1942
- # This is populated only for Google Maps grounding.
2069
+ # Optional. Output only. A token that can be used to render a Google Maps widget
2070
+ # with the contextual data. This field is populated only when the grounding
2071
+ # source is Google Maps.
1943
2072
  # Corresponds to the JSON property `googleMapsWidgetContextToken`
1944
2073
  # @return [String]
1945
2074
  attr_accessor :google_maps_widget_context_token
1946
2075
 
1947
- # List of supporting references retrieved from specified grounding source.
2076
+ # A list of supporting references retrieved from the grounding source. This
2077
+ # field is populated when the grounding source is Google Search, Vertex AI
2078
+ # Search, or Google Maps.
1948
2079
  # Corresponds to the JSON property `groundingChunks`
1949
2080
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunk>]
1950
2081
  attr_accessor :grounding_chunks
1951
2082
 
1952
- # Optional. List of grounding support.
2083
+ # Optional. A list of grounding supports that connect the generated content to
2084
+ # the grounding chunks. This field is populated when the grounding source is
2085
+ # Google Search or Vertex AI Search.
1953
2086
  # Corresponds to the JSON property `groundingSupports`
1954
2087
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingSupport>]
1955
2088
  attr_accessor :grounding_supports
1956
2089
 
1957
- # Metadata related to retrieval in the grounding flow.
2090
+ # Metadata related to the retrieval grounding source. This is part of the `
2091
+ # GroundingMetadata` returned when grounding is enabled.
1958
2092
  # Corresponds to the JSON property `retrievalMetadata`
1959
2093
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1RetrievalMetadata]
1960
2094
  attr_accessor :retrieval_metadata
1961
2095
 
1962
- # Optional. Queries executed by the retrieval tools.
2096
+ # Optional. The queries that were executed by the retrieval tools. This field is
2097
+ # populated only when the grounding source is a retrieval tool, such as Vertex
2098
+ # AI Search.
1963
2099
  # Corresponds to the JSON property `retrievalQueries`
1964
2100
  # @return [Array<String>]
1965
2101
  attr_accessor :retrieval_queries
1966
2102
 
1967
- # Google search entry point.
2103
+ # An entry point for displaying Google Search results. A `SearchEntryPoint` is
2104
+ # populated when the grounding source for a model's response is Google Search.
2105
+ # It provides information that you can use to display the search results in your
2106
+ # application.
1968
2107
  # Corresponds to the JSON property `searchEntryPoint`
1969
2108
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SearchEntryPoint]
1970
2109
  attr_accessor :search_entry_point
1971
2110
 
1972
- # Optional. Output only. List of source flagging uris. This is currently
1973
- # populated only for Google Maps grounding.
2111
+ # Optional. Output only. A list of URIs that can be used to flag a place or
2112
+ # review for inappropriate content. This field is populated only when the
2113
+ # grounding source is Google Maps.
1974
2114
  # Corresponds to the JSON property `sourceFlaggingUris`
1975
2115
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri>]
1976
2116
  attr_accessor :source_flagging_uris
1977
2117
 
1978
- # Optional. Web search queries for the following-up web search.
2118
+ # Optional. The web search queries that were used to generate the content. This
2119
+ # field is populated only when the grounding source is Google Search.
1979
2120
  # Corresponds to the JSON property `webSearchQueries`
1980
2121
  # @return [Array<String>]
1981
2122
  attr_accessor :web_search_queries
@@ -1997,17 +2138,17 @@ module Google
1997
2138
  end
1998
2139
  end
1999
2140
 
2000
- # Source content flagging uri for a place or review. This is currently populated
2001
- # only for Google Maps grounding.
2141
+ # A URI that can be used to flag a place or review for inappropriate content.
2142
+ # This is populated only when the grounding source is Google Maps.
2002
2143
  class GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri
2003
2144
  include Google::Apis::Core::Hashable
2004
2145
 
2005
- # A link where users can flag a problem with the source (place or review).
2146
+ # The URI that can be used to flag the content.
2006
2147
  # Corresponds to the JSON property `flagContentUri`
2007
2148
  # @return [String]
2008
2149
  attr_accessor :flag_content_uri
2009
2150
 
2010
- # Id of the place or review.
2151
+ # The ID of the place or review.
2011
2152
  # Corresponds to the JSON property `sourceId`
2012
2153
  # @return [String]
2013
2154
  attr_accessor :source_id
@@ -2023,27 +2164,30 @@ module Google
2023
2164
  end
2024
2165
  end
2025
2166
 
2026
- # Grounding support.
2167
+ # A collection of supporting references for a segment of the model's response.
2027
2168
  class GoogleCloudAiplatformV1beta1GroundingSupport
2028
2169
  include Google::Apis::Core::Hashable
2029
2170
 
2030
- # Confidence score of the support references. Ranges from 0 to 1. 1 is the most
2031
- # confident. For Gemini 2.0 and before, this list must have the same size as the
2032
- # grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and
2171
+ # The confidence scores for the support references. This list is parallel to the
2172
+ # `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a
2173
+ # higher score indicating a higher confidence that the reference supports the
2174
+ # claim. For Gemini 2.0 and before, this list has the same size as `
2175
+ # grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and
2033
2176
  # should be ignored.
2034
2177
  # Corresponds to the JSON property `confidenceScores`
2035
2178
  # @return [Array<Float>]
2036
2179
  attr_accessor :confidence_scores
2037
2180
 
2038
- # A list of indices (into 'grounding_chunk') specifying the citations associated
2039
- # with the claim. For instance [1,3,4] means that grounding_chunk[1],
2040
- # grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to
2041
- # the claim.
2181
+ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata`
2182
+ # message. These indices specify which grounding chunks support the claim made
2183
+ # in the content segment. For example, if this field has the values `[1, 3]`, it
2184
+ # means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for
2185
+ # the claim in the content segment.
2042
2186
  # Corresponds to the JSON property `groundingChunkIndices`
2043
2187
  # @return [Array<Fixnum>]
2044
2188
  attr_accessor :grounding_chunk_indices
2045
2189
 
2046
- # Segment of the content.
2190
+ # A segment of the content.
2047
2191
  # Corresponds to the JSON property `segment`
2048
2192
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Segment]
2049
2193
  attr_accessor :segment
@@ -2060,7 +2204,9 @@ module Google
2060
2204
  end
2061
2205
  end
2062
2206
 
2063
- # Config for image generation features.
2207
+ # Configuration for image generation. This message allows you to control various
2208
+ # aspects of image generation, such as the output format, aspect ratio, and
2209
+ # whether the model can generate images of people.
2064
2210
  class GoogleCloudAiplatformV1beta1ImageConfig
2065
2211
  include Google::Apis::Core::Hashable
2066
2212
 
@@ -2076,6 +2222,12 @@ module Google
2076
2222
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions]
2077
2223
  attr_accessor :image_output_options
2078
2224
 
2225
+ # Optional. Specifies the size of generated images. Supported values are `1K`, `
2226
+ # 2K`, `4K`. If not specified, the model will use default value `1K`.
2227
+ # Corresponds to the JSON property `imageSize`
2228
+ # @return [String]
2229
+ attr_accessor :image_size
2230
+
2079
2231
  # Optional. Controls whether the model can generate people.
2080
2232
  # Corresponds to the JSON property `personGeneration`
2081
2233
  # @return [String]
@@ -2089,6 +2241,7 @@ module Google
2089
2241
  def update!(**args)
2090
2242
  @aspect_ratio = args[:aspect_ratio] if args.key?(:aspect_ratio)
2091
2243
  @image_output_options = args[:image_output_options] if args.key?(:image_output_options)
2244
+ @image_size = args[:image_size] if args.key?(:image_size)
2092
2245
  @person_generation = args[:person_generation] if args.key?(:person_generation)
2093
2246
  end
2094
2247
  end
@@ -2118,17 +2271,24 @@ module Google
2118
2271
  end
2119
2272
  end
2120
2273
 
2121
- # Logprobs Result
2274
+ # The log probabilities of the tokens generated by the model. This is useful for
2275
+ # understanding the model's confidence in its predictions and for debugging. For
2276
+ # example, you can use log probabilities to identify when the model is making a
2277
+ # less confident prediction or to explore alternative responses that the model
2278
+ # considered. A low log probability can also indicate that the model is "
2279
+ # hallucinating" or generating factually incorrect information.
2122
2280
  class GoogleCloudAiplatformV1beta1LogprobsResult
2123
2281
  include Google::Apis::Core::Hashable
2124
2282
 
2125
- # Length = total number of decoding steps. The chosen candidates may or may not
2126
- # be in top_candidates.
2283
+ # A list of the chosen candidate tokens at each decoding step. The length of
2284
+ # this list is equal to the total number of decoding steps. Note that the chosen
2285
+ # candidate might not be in `top_candidates`.
2127
2286
  # Corresponds to the JSON property `chosenCandidates`
2128
2287
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
2129
2288
  attr_accessor :chosen_candidates
2130
2289
 
2131
- # Length = total number of decoding steps.
2290
+ # A list of the top candidate tokens at each decoding step. The length of this
2291
+ # list is equal to the total number of decoding steps.
2132
2292
  # Corresponds to the JSON property `topCandidates`
2133
2293
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates>]
2134
2294
  attr_accessor :top_candidates
@@ -2144,21 +2304,27 @@ module Google
2144
2304
  end
2145
2305
  end
2146
2306
 
2147
- # Candidate for the logprobs token and score.
2307
+ # A single token and its associated log probability.
2148
2308
  class GoogleCloudAiplatformV1beta1LogprobsResultCandidate
2149
2309
  include Google::Apis::Core::Hashable
2150
2310
 
2151
- # The candidate's log probability.
2311
+ # The log probability of this token. A higher value indicates that the model was
2312
+ # more confident in this token. The log probability can be used to assess the
2313
+ # relative likelihood of different tokens and to identify when the model is
2314
+ # uncertain.
2152
2315
  # Corresponds to the JSON property `logProbability`
2153
2316
  # @return [Float]
2154
2317
  attr_accessor :log_probability
2155
2318
 
2156
- # The candidate's token string value.
2319
+ # The token's string representation.
2157
2320
  # Corresponds to the JSON property `token`
2158
2321
  # @return [String]
2159
2322
  attr_accessor :token
2160
2323
 
2161
- # The candidate's token id value.
2324
+ # The token's numerical ID. While the `token` field provides the string
2325
+ # representation of the token, the `token_id` is the numerical representation
2326
+ # that the model uses internally. This can be useful for developers who want to
2327
+ # build custom logic based on the model's vocabulary.
2162
2328
  # Corresponds to the JSON property `tokenId`
2163
2329
  # @return [Fixnum]
2164
2330
  attr_accessor :token_id
@@ -2175,11 +2341,12 @@ module Google
2175
2341
  end
2176
2342
  end
2177
2343
 
2178
- # Candidates with top log probabilities at each decoding step.
2344
+ # A list of the top candidate tokens and their log probabilities at each
2345
+ # decoding step. This can be used to see what other tokens the model considered.
2179
2346
  class GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates
2180
2347
  include Google::Apis::Core::Hashable
2181
2348
 
2182
- # Sorted by log probability in descending order.
2349
+ # The list of candidate tokens, sorted by log probability in descending order.
2183
2350
  # Corresponds to the JSON property `candidates`
2184
2351
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
2185
2352
  attr_accessor :candidates
@@ -2194,16 +2361,21 @@ module Google
2194
2361
  end
2195
2362
  end
2196
2363
 
2197
- # Represents token counting info for a single modality.
2364
+ # Represents a breakdown of token usage by modality. This message is used in
2365
+ # CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a
2366
+ # detailed view of how many tokens are used by each modality (e.g., text, image,
2367
+ # video) in a request. This is particularly useful for multimodal models,
2368
+ # allowing you to track and manage token consumption for billing and quota
2369
+ # purposes.
2198
2370
  class GoogleCloudAiplatformV1beta1ModalityTokenCount
2199
2371
  include Google::Apis::Core::Hashable
2200
2372
 
2201
- # The modality associated with this token count.
2373
+ # The modality that this token count applies to.
2202
2374
  # Corresponds to the JSON property `modality`
2203
2375
  # @return [String]
2204
2376
  attr_accessor :modality
2205
2377
 
2206
- # Number of tokens.
2378
+ # The number of tokens counted for this modality.
2207
2379
  # Corresponds to the JSON property `tokenCount`
2208
2380
  # @return [Fixnum]
2209
2381
  attr_accessor :token_count
@@ -2219,17 +2391,29 @@ module Google
2219
2391
  end
2220
2392
  end
2221
2393
 
2222
- # Configuration for Model Armor integrations of prompt and responses.
2394
+ # Configuration for Model Armor. Model Armor is a Google Cloud service that
2395
+ # provides safety and security filtering for prompts and responses. It helps
2396
+ # protect your AI applications from risks such as harmful content, sensitive
2397
+ # data leakage, and prompt injection attacks.
2223
2398
  class GoogleCloudAiplatformV1beta1ModelArmorConfig
2224
2399
  include Google::Apis::Core::Hashable
2225
2400
 
2226
- # Optional. The name of the Model Armor template to use for prompt sanitization.
2401
+ # Optional. The resource name of the Model Armor template to use for prompt
2402
+ # screening. A Model Armor template is a set of customized filters and
2403
+ # thresholds that define how Model Armor screens content. If specified, Model
2404
+ # Armor will use this template to check the user's prompt for safety and
2405
+ # security risks before it is sent to the model. The name must be in the format `
2406
+ # projects/`project`/locations/`location`/templates/`template``.
2227
2407
  # Corresponds to the JSON property `promptTemplateName`
2228
2408
  # @return [String]
2229
2409
  attr_accessor :prompt_template_name
2230
2410
 
2231
- # Optional. The name of the Model Armor template to use for response
2232
- # sanitization.
2411
+ # Optional. The resource name of the Model Armor template to use for response
2412
+ # screening. A Model Armor template is a set of customized filters and
2413
+ # thresholds that define how Model Armor screens content. If specified, Model
2414
+ # Armor will use this template to check the model's response for safety and
2415
+ # security risks before it is returned to the user. The name must be in the
2416
+ # format `projects/`project`/locations/`location`/templates/`template``.
2233
2417
  # Corresponds to the JSON property `responseTemplateName`
2234
2418
  # @return [String]
2235
2419
  attr_accessor :response_template_name
@@ -2245,8 +2429,7 @@ module Google
2245
2429
  end
2246
2430
  end
2247
2431
 
2248
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
2249
- # to two distinct voices in a single synthesis request.
2432
+ # Configuration for a multi-speaker text-to-speech request.
2250
2433
  class GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig
2251
2434
  include Google::Apis::Core::Hashable
2252
2435
 
@@ -2266,11 +2449,11 @@ module Google
2266
2449
  end
2267
2450
  end
2268
2451
 
2269
- # A datatype containing media that is part of a multi-part `Content` message. A `
2452
+ # A datatype containing media that is part of a multi-part Content message. A `
2270
2453
  # Part` consists of data which has an associated datatype. A `Part` can only
2271
- # contain one of the accepted types in `Part.data`. A `Part` must have a fixed
2272
- # IANA MIME type identifying the type and subtype of the media if `inline_data`
2273
- # or `file_data` field is filled with raw bytes.
2454
+ # contain one of the accepted types in `Part.data`. For media types that are not
2455
+ # text, `Part` must have a fixed IANA MIME type identifying the type and subtype
2456
+ # of the media if `inline_data` or `file_data` field is filled with raw bytes.
2274
2457
  class GoogleCloudAiplatformV1beta1Part
2275
2458
  include Google::Apis::Core::Hashable
2276
2459
 
@@ -2289,7 +2472,9 @@ module Google
2289
2472
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ExecutableCode]
2290
2473
  attr_accessor :executable_code
2291
2474
 
2292
- # URI based data.
2475
+ # URI-based data. A FileData message contains a URI pointing to data of a
2476
+ # specific media type. It is used to represent images, audio, and video stored
2477
+ # in Google Cloud Storage.
2293
2478
  # Corresponds to the JSON property `fileData`
2294
2479
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1FileData]
2295
2480
  attr_accessor :file_data
@@ -2309,17 +2494,24 @@ module Google
2309
2494
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1FunctionResponse]
2310
2495
  attr_accessor :function_response
2311
2496
 
2312
- # Content blob.
2497
+ # A content blob. A Blob contains data of a specific media type. It is used to
2498
+ # represent images, audio, and video.
2313
2499
  # Corresponds to the JSON property `inlineData`
2314
2500
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Blob]
2315
2501
  attr_accessor :inline_data
2316
2502
 
2317
- # Optional. Text part (can be code).
2503
+ # per part media resolution. Media resolution for the input media.
2504
+ # Corresponds to the JSON property `mediaResolution`
2505
+ # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1PartMediaResolution]
2506
+ attr_accessor :media_resolution
2507
+
2508
+ # Optional. The text content of the part.
2318
2509
  # Corresponds to the JSON property `text`
2319
2510
  # @return [String]
2320
2511
  attr_accessor :text
2321
2512
 
2322
- # Optional. Indicates if the part is thought from the model.
2513
+ # Optional. Indicates whether the `part` represents the model's thought process
2514
+ # or reasoning.
2323
2515
  # Corresponds to the JSON property `thought`
2324
2516
  # @return [Boolean]
2325
2517
  attr_accessor :thought
@@ -2332,7 +2524,8 @@ module Google
2332
2524
  # @return [String]
2333
2525
  attr_accessor :thought_signature
2334
2526
 
2335
- # Metadata describes the input video content.
2527
+ # Provides metadata for a video, including the start and end offsets for
2528
+ # clipping and the frame rate.
2336
2529
  # Corresponds to the JSON property `videoMetadata`
2337
2530
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VideoMetadata]
2338
2531
  attr_accessor :video_metadata
@@ -2349,6 +2542,7 @@ module Google
2349
2542
  @function_call = args[:function_call] if args.key?(:function_call)
2350
2543
  @function_response = args[:function_response] if args.key?(:function_response)
2351
2544
  @inline_data = args[:inline_data] if args.key?(:inline_data)
2545
+ @media_resolution = args[:media_resolution] if args.key?(:media_resolution)
2352
2546
  @text = args[:text] if args.key?(:text)
2353
2547
  @thought = args[:thought] if args.key?(:thought)
2354
2548
  @thought_signature = args[:thought_signature] if args.key?(:thought_signature)
@@ -2356,11 +2550,83 @@ module Google
2356
2550
  end
2357
2551
  end
2358
2552
 
2359
- # The configuration for the prebuilt speaker to use.
2553
+ # per part media resolution. Media resolution for the input media.
2554
+ class GoogleCloudAiplatformV1beta1PartMediaResolution
2555
+ include Google::Apis::Core::Hashable
2556
+
2557
+ # The tokenization quality used for given media.
2558
+ # Corresponds to the JSON property `level`
2559
+ # @return [String]
2560
+ attr_accessor :level
2561
+
2562
+ def initialize(**args)
2563
+ update!(**args)
2564
+ end
2565
+
2566
+ # Update properties of this object
2567
+ def update!(**args)
2568
+ @level = args[:level] if args.key?(:level)
2569
+ end
2570
+ end
2571
+
2572
+ # Partial argument value of the function call.
2573
+ class GoogleCloudAiplatformV1beta1PartialArg
2574
+ include Google::Apis::Core::Hashable
2575
+
2576
+ # Optional. Represents a boolean value.
2577
+ # Corresponds to the JSON property `boolValue`
2578
+ # @return [Boolean]
2579
+ attr_accessor :bool_value
2580
+ alias_method :bool_value?, :bool_value
2581
+
2582
+ # Required. A JSON Path (RFC 9535) to the argument being streamed. https://
2583
+ # datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
2584
+ # Corresponds to the JSON property `jsonPath`
2585
+ # @return [String]
2586
+ attr_accessor :json_path
2587
+
2588
+ # Optional. Represents a null value.
2589
+ # Corresponds to the JSON property `nullValue`
2590
+ # @return [String]
2591
+ attr_accessor :null_value
2592
+
2593
+ # Optional. Represents a double value.
2594
+ # Corresponds to the JSON property `numberValue`
2595
+ # @return [Float]
2596
+ attr_accessor :number_value
2597
+
2598
+ # Optional. Represents a string value.
2599
+ # Corresponds to the JSON property `stringValue`
2600
+ # @return [String]
2601
+ attr_accessor :string_value
2602
+
2603
+ # Optional. Whether this is not the last part of the same json_path. If true,
2604
+ # another PartialArg message for the current json_path is expected to follow.
2605
+ # Corresponds to the JSON property `willContinue`
2606
+ # @return [Boolean]
2607
+ attr_accessor :will_continue
2608
+ alias_method :will_continue?, :will_continue
2609
+
2610
+ def initialize(**args)
2611
+ update!(**args)
2612
+ end
2613
+
2614
+ # Update properties of this object
2615
+ def update!(**args)
2616
+ @bool_value = args[:bool_value] if args.key?(:bool_value)
2617
+ @json_path = args[:json_path] if args.key?(:json_path)
2618
+ @null_value = args[:null_value] if args.key?(:null_value)
2619
+ @number_value = args[:number_value] if args.key?(:number_value)
2620
+ @string_value = args[:string_value] if args.key?(:string_value)
2621
+ @will_continue = args[:will_continue] if args.key?(:will_continue)
2622
+ end
2623
+ end
2624
+
2625
+ # Configuration for a prebuilt voice.
2360
2626
  class GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig
2361
2627
  include Google::Apis::Core::Hashable
2362
2628
 
2363
- # The name of the preset voice to use.
2629
+ # The name of the prebuilt voice to use.
2364
2630
  # Corresponds to the JSON property `voiceName`
2365
2631
  # @return [String]
2366
2632
  attr_accessor :voice_name
@@ -2584,6 +2850,34 @@ module Google
2584
2850
  end
2585
2851
  end
2586
2852
 
2853
+ # The configuration for the replicated voice to use.
2854
+ class GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig
2855
+ include Google::Apis::Core::Hashable
2856
+
2857
+ # Optional. The mimetype of the voice sample. Currently only mime_type=audio/pcm
2858
+ # is supported, which is raw mono 16-bit signed little-endian pcm data, with 24k
2859
+ # sampling rate.
2860
+ # Corresponds to the JSON property `mimeType`
2861
+ # @return [String]
2862
+ attr_accessor :mime_type
2863
+
2864
+ # Optional. The sample of the custom voice.
2865
+ # Corresponds to the JSON property `voiceSampleAudio`
2866
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
2867
+ # @return [String]
2868
+ attr_accessor :voice_sample_audio
2869
+
2870
+ def initialize(**args)
2871
+ update!(**args)
2872
+ end
2873
+
2874
+ # Update properties of this object
2875
+ def update!(**args)
2876
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
2877
+ @voice_sample_audio = args[:voice_sample_audio] if args.key?(:voice_sample_audio)
2878
+ end
2879
+ end
2880
+
2587
2881
  # Defines a retrieval tool that model can call to access external knowledge.
2588
2882
  class GoogleCloudAiplatformV1beta1Retrieval
2589
2883
  include Google::Apis::Core::Hashable
@@ -2653,15 +2947,17 @@ module Google
2653
2947
  end
2654
2948
  end
2655
2949
 
2656
- # Metadata related to retrieval in the grounding flow.
2950
+ # Metadata related to the retrieval grounding source. This is part of the `
2951
+ # GroundingMetadata` returned when grounding is enabled.
2657
2952
  class GoogleCloudAiplatformV1beta1RetrievalMetadata
2658
2953
  include Google::Apis::Core::Hashable
2659
2954
 
2660
- # Optional. Score indicating how likely information from Google Search could
2661
- # help answer the prompt. The score is in the range `[0, 1]`, where 0 is the
2662
- # least likely and 1 is the most likely. This score is only populated when
2663
- # Google Search grounding and dynamic retrieval is enabled. It will be compared
2664
- # to the threshold to determine whether to trigger Google Search.
2955
+ # Optional. A score indicating how likely it is that a Google Search query could
2956
+ # help answer the prompt. The score is in the range of `[0, 1]`. A score of 1
2957
+ # means the model is confident that a search will be helpful, and 0 means it is
2958
+ # not. This score is populated only when Google Search grounding and dynamic
2959
+ # retrieval are enabled. The score is used to determine whether to trigger a
2960
+ # search.
2665
2961
  # Corresponds to the JSON property `googleSearchDynamicRetrievalScore`
2666
2962
  # @return [Float]
2667
2963
  attr_accessor :google_search_dynamic_retrieval_score
@@ -2676,18 +2972,18 @@ module Google
2676
2972
  end
2677
2973
  end
2678
2974
 
2679
- # Safety rating corresponding to the generated content.
2975
+ # A safety rating for a piece of content. The safety rating contains the harm
2976
+ # category and the harm probability level.
2680
2977
  class GoogleCloudAiplatformV1beta1SafetyRating
2681
2978
  include Google::Apis::Core::Hashable
2682
2979
 
2683
- # Output only. Indicates whether the content was filtered out because of this
2684
- # rating.
2980
+ # Output only. Indicates whether the content was blocked because of this rating.
2685
2981
  # Corresponds to the JSON property `blocked`
2686
2982
  # @return [Boolean]
2687
2983
  attr_accessor :blocked
2688
2984
  alias_method :blocked?, :blocked
2689
2985
 
2690
- # Output only. Harm category.
2986
+ # Output only. The harm category of this rating.
2691
2987
  # Corresponds to the JSON property `category`
2692
2988
  # @return [String]
2693
2989
  attr_accessor :category
@@ -2699,22 +2995,22 @@ module Google
2699
2995
  # @return [String]
2700
2996
  attr_accessor :overwritten_threshold
2701
2997
 
2702
- # Output only. Harm probability levels in the content.
2998
+ # Output only. The probability of harm for this category.
2703
2999
  # Corresponds to the JSON property `probability`
2704
3000
  # @return [String]
2705
3001
  attr_accessor :probability
2706
3002
 
2707
- # Output only. Harm probability score.
3003
+ # Output only. The probability score of harm for this category.
2708
3004
  # Corresponds to the JSON property `probabilityScore`
2709
3005
  # @return [Float]
2710
3006
  attr_accessor :probability_score
2711
3007
 
2712
- # Output only. Harm severity levels in the content.
3008
+ # Output only. The severity of harm for this category.
2713
3009
  # Corresponds to the JSON property `severity`
2714
3010
  # @return [String]
2715
3011
  attr_accessor :severity
2716
3012
 
2717
- # Output only. Harm severity score.
3013
+ # Output only. The severity score of harm for this category.
2718
3014
  # Corresponds to the JSON property `severityScore`
2719
3015
  # @return [Float]
2720
3016
  attr_accessor :severity_score
@@ -2735,22 +3031,24 @@ module Google
2735
3031
  end
2736
3032
  end
2737
3033
 
2738
- # Safety settings.
3034
+ # A safety setting that affects the safety-blocking behavior. A SafetySetting
3035
+ # consists of a harm category and a threshold for that category.
2739
3036
  class GoogleCloudAiplatformV1beta1SafetySetting
2740
3037
  include Google::Apis::Core::Hashable
2741
3038
 
2742
- # Required. Harm category.
3039
+ # Required. The harm category to be blocked.
2743
3040
  # Corresponds to the JSON property `category`
2744
3041
  # @return [String]
2745
3042
  attr_accessor :category
2746
3043
 
2747
- # Optional. Specify if the threshold is used for probability or severity score.
2748
- # If not specified, the threshold is used for probability score.
3044
+ # Optional. The method for blocking content. If not specified, the default
3045
+ # behavior is to use the probability score.
2749
3046
  # Corresponds to the JSON property `method`
2750
3047
  # @return [String]
2751
3048
  attr_accessor :method_prop
2752
3049
 
2753
- # Required. The harm block threshold.
3050
+ # Required. The threshold for blocking content. If the harm probability exceeds
3051
+ # this threshold, the content will be blocked.
2754
3052
  # Corresponds to the JSON property `threshold`
2755
3053
  # @return [String]
2756
3054
  attr_accessor :threshold
@@ -2953,17 +3251,23 @@ module Google
2953
3251
  end
2954
3252
  end
2955
3253
 
2956
- # Google search entry point.
3254
+ # An entry point for displaying Google Search results. A `SearchEntryPoint` is
3255
+ # populated when the grounding source for a model's response is Google Search.
3256
+ # It provides information that you can use to display the search results in your
3257
+ # application.
2957
3258
  class GoogleCloudAiplatformV1beta1SearchEntryPoint
2958
3259
  include Google::Apis::Core::Hashable
2959
3260
 
2960
- # Optional. Web content snippet that can be embedded in a web page or an app
2961
- # webview.
3261
+ # Optional. An HTML snippet that can be embedded in a web page or an application'
3262
+ # s webview. This snippet displays a search result, including the title, URL,
3263
+ # and a brief description of the search result.
2962
3264
  # Corresponds to the JSON property `renderedContent`
2963
3265
  # @return [String]
2964
3266
  attr_accessor :rendered_content
2965
3267
 
2966
- # Optional. Base64 encoded JSON representing array of tuple.
3268
+ # Optional. A base64-encoded JSON object that contains a list of search queries
3269
+ # and their corresponding search URLs. This information can be used to build a
3270
+ # custom search UI.
2967
3271
  # Corresponds to the JSON property `sdkBlob`
2968
3272
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
2969
3273
  # @return [String]
@@ -2980,28 +3284,31 @@ module Google
2980
3284
  end
2981
3285
  end
2982
3286
 
2983
- # Segment of the content.
3287
+ # A segment of the content.
2984
3288
  class GoogleCloudAiplatformV1beta1Segment
2985
3289
  include Google::Apis::Core::Hashable
2986
3290
 
2987
- # Output only. End index in the given Part, measured in bytes. Offset from the
2988
- # start of the Part, exclusive, starting at zero.
3291
+ # Output only. The end index of the segment in the `Part`, measured in bytes.
3292
+ # This marks the end of the segment and is exclusive, meaning the segment
3293
+ # includes content up to, but not including, the byte at this index.
2989
3294
  # Corresponds to the JSON property `endIndex`
2990
3295
  # @return [Fixnum]
2991
3296
  attr_accessor :end_index
2992
3297
 
2993
- # Output only. The index of a Part object within its parent Content object.
3298
+ # Output only. The index of the `Part` object that this segment belongs to. This
3299
+ # is useful for associating the segment with a specific part of the content.
2994
3300
  # Corresponds to the JSON property `partIndex`
2995
3301
  # @return [Fixnum]
2996
3302
  attr_accessor :part_index
2997
3303
 
2998
- # Output only. Start index in the given Part, measured in bytes. Offset from the
2999
- # start of the Part, inclusive, starting at zero.
3304
+ # Output only. The start index of the segment in the `Part`, measured in bytes.
3305
+ # This marks the beginning of the segment and is inclusive, meaning the byte at
3306
+ # this index is the first byte of the segment.
3000
3307
  # Corresponds to the JSON property `startIndex`
3001
3308
  # @return [Fixnum]
3002
3309
  attr_accessor :start_index
3003
3310
 
3004
- # Output only. The text corresponding to the segment from the response.
3311
+ # Output only. The text of the segment.
3005
3312
  # Corresponds to the JSON property `text`
3006
3313
  # @return [String]
3007
3314
  attr_accessor :text
@@ -3019,7 +3326,7 @@ module Google
3019
3326
  end
3020
3327
  end
3021
3328
 
3022
- # Configuration for a single speaker in a multi speaker setup.
3329
+ # Configuration for a single speaker in a multi-speaker setup.
3023
3330
  class GoogleCloudAiplatformV1beta1SpeakerVoiceConfig
3024
3331
  include Google::Apis::Core::Hashable
3025
3332
 
@@ -3029,7 +3336,7 @@ module Google
3029
3336
  # @return [String]
3030
3337
  attr_accessor :speaker
3031
3338
 
3032
- # The configuration for the voice to use.
3339
+ # Configuration for a voice.
3033
3340
  # Corresponds to the JSON property `voiceConfig`
3034
3341
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VoiceConfig]
3035
3342
  attr_accessor :voice_config
@@ -3045,22 +3352,21 @@ module Google
3045
3352
  end
3046
3353
  end
3047
3354
 
3048
- # The speech generation config.
3355
+ # Configuration for speech generation.
3049
3356
  class GoogleCloudAiplatformV1beta1SpeechConfig
3050
3357
  include Google::Apis::Core::Hashable
3051
3358
 
3052
- # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
3359
+ # Optional. The language code (ISO 639-1) for the speech synthesis.
3053
3360
  # Corresponds to the JSON property `languageCode`
3054
3361
  # @return [String]
3055
3362
  attr_accessor :language_code
3056
3363
 
3057
- # Configuration for a multi-speaker text-to-speech setup. Enables the use of up
3058
- # to two distinct voices in a single synthesis request.
3364
+ # Configuration for a multi-speaker text-to-speech request.
3059
3365
  # Corresponds to the JSON property `multiSpeakerVoiceConfig`
3060
3366
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig]
3061
3367
  attr_accessor :multi_speaker_voice_config
3062
3368
 
3063
- # The configuration for the voice to use.
3369
+ # Configuration for a voice.
3064
3370
  # Corresponds to the JSON property `voiceConfig`
3065
3371
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VoiceConfig]
3066
3372
  attr_accessor :voice_config
@@ -3181,11 +3487,12 @@ module Google
3181
3487
  # @return [String]
3182
3488
  attr_accessor :environment
3183
3489
 
3184
- # Optional. By default, predefined functions are included in the final model
3185
- # call. Some of them can be explicitly excluded from being automatically
3186
- # included. This can serve two purposes: 1. Using a more restricted / different
3187
- # action space. 2. Improving the definitions / instructions of predefined
3188
- # functions.
3490
+ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-
3491
+ # ai/generative-ai/docs/computer-use#supported-actions) are included in the
3492
+ # final model call. Some of them can be explicitly excluded from being
3493
+ # automatically included. This can serve two purposes: 1. Using a more
3494
+ # restricted / different action space. 2. Improving the definitions /
3495
+ # instructions of predefined functions.
3189
3496
  # Corresponds to the JSON property `excludedPredefinedFunctions`
3190
3497
  # @return [Array<String>]
3191
3498
  attr_accessor :excluded_predefined_functions
@@ -3267,11 +3574,13 @@ module Google
3267
3574
  end
3268
3575
  end
3269
3576
 
3270
- # Metadata related to url context retrieval tool.
3577
+ # Metadata returned when the model uses the `url_context` tool to get
3578
+ # information from a user-provided URL.
3271
3579
  class GoogleCloudAiplatformV1beta1UrlContextMetadata
3272
3580
  include Google::Apis::Core::Hashable
3273
3581
 
3274
- # Output only. List of url context.
3582
+ # Output only. A list of URL metadata, with one entry for each URL retrieved by
3583
+ # the tool.
3275
3584
  # Corresponds to the JSON property `urlMetadata`
3276
3585
  # @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1UrlMetadata>]
3277
3586
  attr_accessor :url_metadata
@@ -3286,16 +3595,16 @@ module Google
3286
3595
  end
3287
3596
  end
3288
3597
 
3289
- # Context of the a single url retrieval.
3598
+ # The metadata for a single URL retrieval.
3290
3599
  class GoogleCloudAiplatformV1beta1UrlMetadata
3291
3600
  include Google::Apis::Core::Hashable
3292
3601
 
3293
- # Retrieved url by the tool.
3602
+ # The URL retrieved by the tool.
3294
3603
  # Corresponds to the JSON property `retrievedUrl`
3295
3604
  # @return [String]
3296
3605
  attr_accessor :retrieved_url
3297
3606
 
3298
- # Status of the url retrieval.
3607
+ # The status of the URL retrieval.
3299
3608
  # Corresponds to the JSON property `urlRetrievalStatus`
3300
3609
  # @return [String]
3301
3610
  attr_accessor :url_retrieval_status
@@ -3477,7 +3786,8 @@ module Google
3477
3786
  end
3478
3787
  end
3479
3788
 
3480
- # Metadata describes the input video content.
3789
+ # Provides metadata for a video, including the start and end offsets for
3790
+ # clipping and the frame rate.
3481
3791
  class GoogleCloudAiplatformV1beta1VideoMetadata
3482
3792
  include Google::Apis::Core::Hashable
3483
3793
 
@@ -3487,7 +3797,7 @@ module Google
3487
3797
  attr_accessor :end_offset
3488
3798
 
3489
3799
  # Optional. The frame rate of the video sent to the model. If not specified, the
3490
- # default value will be 1.0. The fps range is (0.0, 24.0].
3800
+ # default value is 1.0. The valid range is (0.0, 24.0].
3491
3801
  # Corresponds to the JSON property `fps`
3492
3802
  # @return [Float]
3493
3803
  attr_accessor :fps
@@ -3509,15 +3819,20 @@ module Google
3509
3819
  end
3510
3820
  end
3511
3821
 
3512
- # The configuration for the voice to use.
3822
+ # Configuration for a voice.
3513
3823
  class GoogleCloudAiplatformV1beta1VoiceConfig
3514
3824
  include Google::Apis::Core::Hashable
3515
3825
 
3516
- # The configuration for the prebuilt speaker to use.
3826
+ # Configuration for a prebuilt voice.
3517
3827
  # Corresponds to the JSON property `prebuiltVoiceConfig`
3518
3828
  # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig]
3519
3829
  attr_accessor :prebuilt_voice_config
3520
3830
 
3831
+ # The configuration for the replicated voice to use.
3832
+ # Corresponds to the JSON property `replicatedVoiceConfig`
3833
+ # @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig]
3834
+ attr_accessor :replicated_voice_config
3835
+
3521
3836
  def initialize(**args)
3522
3837
  update!(**args)
3523
3838
  end
@@ -3525,6 +3840,7 @@ module Google
3525
3840
  # Update properties of this object
3526
3841
  def update!(**args)
3527
3842
  @prebuilt_voice_config = args[:prebuilt_voice_config] if args.key?(:prebuilt_voice_config)
3843
+ @replicated_voice_config = args[:replicated_voice_config] if args.key?(:replicated_voice_config)
3528
3844
  end
3529
3845
  end
3530
3846