google-apis-firebaseml_v2beta 0.34.0 → 0.35.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/firebaseml_v2beta/classes.rb +407 -240
- data/lib/google/apis/firebaseml_v2beta/gem_version.rb +2 -2
- metadata +2 -2
|
@@ -314,20 +314,21 @@ module Google
|
|
|
314
314
|
end
|
|
315
315
|
end
|
|
316
316
|
|
|
317
|
-
#
|
|
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.
|
|
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.
|
|
328
|
-
# distinguish blobs. This field is only returned in PromptMessage for prompt
|
|
329
|
-
# management. It is
|
|
330
|
-
#
|
|
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.
|
|
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
|
|
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
|
|
367
|
-
#
|
|
368
|
-
#
|
|
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
|
|
375
|
-
# detail. This is only
|
|
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
|
|
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
|
-
#
|
|
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.
|
|
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
|
-
#
|
|
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.
|
|
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
|
|
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
|
-
#
|
|
444
|
+
# A citation for a piece of generatedcontent.
|
|
432
445
|
class GoogleCloudAiplatformV1beta1Citation
|
|
433
446
|
include Google::Apis::Core::Hashable
|
|
434
447
|
|
|
435
|
-
# Output only.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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
|
|
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.
|
|
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
|
|
535
|
-
#
|
|
536
|
-
#
|
|
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.
|
|
542
|
-
# different
|
|
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
|
-
#
|
|
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
|
-
#
|
|
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
|
|
592
|
-
#
|
|
593
|
-
#
|
|
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
|
|
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.
|
|
839
|
-
#
|
|
840
|
-
#
|
|
841
|
-
#
|
|
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
|
|
@@ -1163,7 +1177,9 @@ module Google
|
|
|
1163
1177
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content>]
|
|
1164
1178
|
attr_accessor :contents
|
|
1165
1179
|
|
|
1166
|
-
#
|
|
1180
|
+
# Configuration for content generation. This message contains all the parameters
|
|
1181
|
+
# that control how the model generates content. It allows you to influence the
|
|
1182
|
+
# randomness, length, and structure of the output.
|
|
1167
1183
|
# Corresponds to the JSON property `generationConfig`
|
|
1168
1184
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfig]
|
|
1169
1185
|
attr_accessor :generation_config
|
|
@@ -1177,7 +1193,10 @@ module Google
|
|
|
1177
1193
|
# @return [Hash<String,String>]
|
|
1178
1194
|
attr_accessor :labels
|
|
1179
1195
|
|
|
1180
|
-
# Configuration for Model Armor
|
|
1196
|
+
# Configuration for Model Armor. Model Armor is a Google Cloud service that
|
|
1197
|
+
# provides safety and security filtering for prompts and responses. It helps
|
|
1198
|
+
# protect your AI applications from risks such as harmful content, sensitive
|
|
1199
|
+
# data leakage, and prompt injection attacks.
|
|
1181
1200
|
# Corresponds to the JSON property `modelArmorConfig`
|
|
1182
1201
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ModelArmorConfig]
|
|
1183
1202
|
attr_accessor :model_armor_config
|
|
@@ -1188,10 +1207,9 @@ module Google
|
|
|
1188
1207
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SafetySetting>]
|
|
1189
1208
|
attr_accessor :safety_settings
|
|
1190
1209
|
|
|
1191
|
-
# The
|
|
1192
|
-
#
|
|
1193
|
-
#
|
|
1194
|
-
# message turn.
|
|
1210
|
+
# The structured data content of a message. A Content message contains a `role`
|
|
1211
|
+
# field, which indicates the producer of the content, and a `parts` field, which
|
|
1212
|
+
# contains the multi-part data of the message.
|
|
1195
1213
|
# Corresponds to the JSON property `systemInstruction`
|
|
1196
1214
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Content]
|
|
1197
1215
|
attr_accessor :system_instruction
|
|
@@ -1406,50 +1424,72 @@ module Google
|
|
|
1406
1424
|
end
|
|
1407
1425
|
end
|
|
1408
1426
|
|
|
1409
|
-
#
|
|
1427
|
+
# Configuration for content generation. This message contains all the parameters
|
|
1428
|
+
# that control how the model generates content. It allows you to influence the
|
|
1429
|
+
# randomness, length, and structure of the output.
|
|
1410
1430
|
class GoogleCloudAiplatformV1beta1GenerationConfig
|
|
1411
1431
|
include Google::Apis::Core::Hashable
|
|
1412
1432
|
|
|
1413
|
-
# Optional. If enabled, audio
|
|
1414
|
-
# model.
|
|
1433
|
+
# Optional. If enabled, audio timestamps will be included in the request to the
|
|
1434
|
+
# model. This can be useful for synchronizing audio with other modalities in the
|
|
1435
|
+
# response.
|
|
1415
1436
|
# Corresponds to the JSON property `audioTimestamp`
|
|
1416
1437
|
# @return [Boolean]
|
|
1417
1438
|
attr_accessor :audio_timestamp
|
|
1418
1439
|
alias_method :audio_timestamp?, :audio_timestamp
|
|
1419
1440
|
|
|
1420
|
-
# Optional.
|
|
1441
|
+
# Optional. The number of candidate responses to generate. A higher `
|
|
1442
|
+
# candidate_count` can provide more options to choose from, but it also consumes
|
|
1443
|
+
# more resources. This can be useful for generating a variety of responses and
|
|
1444
|
+
# selecting the best one.
|
|
1421
1445
|
# Corresponds to the JSON property `candidateCount`
|
|
1422
1446
|
# @return [Fixnum]
|
|
1423
1447
|
attr_accessor :candidate_count
|
|
1424
1448
|
|
|
1425
1449
|
# Optional. If enabled, the model will detect emotions and adapt its responses
|
|
1426
|
-
# accordingly.
|
|
1450
|
+
# accordingly. For example, if the model detects that the user is frustrated, it
|
|
1451
|
+
# may provide a more empathetic response.
|
|
1427
1452
|
# Corresponds to the JSON property `enableAffectiveDialog`
|
|
1428
1453
|
# @return [Boolean]
|
|
1429
1454
|
attr_accessor :enable_affective_dialog
|
|
1430
1455
|
alias_method :enable_affective_dialog?, :enable_affective_dialog
|
|
1431
1456
|
|
|
1432
|
-
# Optional.
|
|
1457
|
+
# Optional. Penalizes tokens based on their frequency in the generated text. A
|
|
1458
|
+
# positive value helps to reduce the repetition of words and phrases. Valid
|
|
1459
|
+
# values can range from [-2.0, 2.0].
|
|
1433
1460
|
# Corresponds to the JSON property `frequencyPenalty`
|
|
1434
1461
|
# @return [Float]
|
|
1435
1462
|
attr_accessor :frequency_penalty
|
|
1436
1463
|
|
|
1437
|
-
#
|
|
1464
|
+
# Configuration for image generation. This message allows you to control various
|
|
1465
|
+
# aspects of image generation, such as the output format, aspect ratio, and
|
|
1466
|
+
# whether the model can generate images of people.
|
|
1438
1467
|
# Corresponds to the JSON property `imageConfig`
|
|
1439
1468
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ImageConfig]
|
|
1440
1469
|
attr_accessor :image_config
|
|
1441
1470
|
|
|
1442
|
-
# Optional.
|
|
1471
|
+
# Optional. The number of top log probabilities to return for each token. This
|
|
1472
|
+
# can be used to see which other tokens were considered likely candidates for a
|
|
1473
|
+
# given position. A higher value will return more options, but it will also
|
|
1474
|
+
# increase the size of the response.
|
|
1443
1475
|
# Corresponds to the JSON property `logprobs`
|
|
1444
1476
|
# @return [Fixnum]
|
|
1445
1477
|
attr_accessor :logprobs
|
|
1446
1478
|
|
|
1447
|
-
# Optional. The maximum number of
|
|
1479
|
+
# Optional. The maximum number of tokens to generate in the response. A token is
|
|
1480
|
+
# approximately four characters. The default value varies by model. This
|
|
1481
|
+
# parameter can be used to control the length of the generated text and prevent
|
|
1482
|
+
# overly long responses.
|
|
1448
1483
|
# Corresponds to the JSON property `maxOutputTokens`
|
|
1449
1484
|
# @return [Fixnum]
|
|
1450
1485
|
attr_accessor :max_output_tokens
|
|
1451
1486
|
|
|
1452
|
-
# Optional.
|
|
1487
|
+
# Optional. The token resolution at which input media content is sampled. This
|
|
1488
|
+
# is used to control the trade-off between the quality of the response and the
|
|
1489
|
+
# number of tokens used to represent the media. A higher resolution allows the
|
|
1490
|
+
# model to perceive more detail, which can lead to a more nuanced response, but
|
|
1491
|
+
# it will also use more tokens. This does not affect the image dimensions sent
|
|
1492
|
+
# to the model.
|
|
1453
1493
|
# Corresponds to the JSON property `mediaResolution`
|
|
1454
1494
|
# @return [String]
|
|
1455
1495
|
attr_accessor :media_resolution
|
|
@@ -1459,44 +1499,41 @@ module Google
|
|
|
1459
1499
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigModelConfig]
|
|
1460
1500
|
attr_accessor :model_config
|
|
1461
1501
|
|
|
1462
|
-
# Optional.
|
|
1502
|
+
# Optional. Penalizes tokens that have already appeared in the generated text. A
|
|
1503
|
+
# positive value encourages the model to generate more diverse and less
|
|
1504
|
+
# repetitive text. Valid values can range from [-2.0, 2.0].
|
|
1463
1505
|
# Corresponds to the JSON property `presencePenalty`
|
|
1464
1506
|
# @return [Float]
|
|
1465
1507
|
attr_accessor :presence_penalty
|
|
1466
1508
|
|
|
1467
|
-
# Optional.
|
|
1468
|
-
#
|
|
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.
|
|
1509
|
+
# Optional. When this field is set, response_schema must be omitted and
|
|
1510
|
+
# response_mime_type must be set to `application/json`.
|
|
1480
1511
|
# Corresponds to the JSON property `responseJsonSchema`
|
|
1481
1512
|
# @return [Object]
|
|
1482
1513
|
attr_accessor :response_json_schema
|
|
1483
1514
|
|
|
1484
|
-
# Optional. If true,
|
|
1515
|
+
# Optional. If set to true, the log probabilities of the output tokens are
|
|
1516
|
+
# returned. Log probabilities are the logarithm of the probability of a token
|
|
1517
|
+
# appearing in the output. A higher log probability means the token is more
|
|
1518
|
+
# likely to be generated. This can be useful for analyzing the model's
|
|
1519
|
+
# confidence in its own output and for debugging.
|
|
1485
1520
|
# Corresponds to the JSON property `responseLogprobs`
|
|
1486
1521
|
# @return [Boolean]
|
|
1487
1522
|
attr_accessor :response_logprobs
|
|
1488
1523
|
alias_method :response_logprobs?, :response_logprobs
|
|
1489
1524
|
|
|
1490
|
-
# Optional.
|
|
1491
|
-
#
|
|
1492
|
-
#
|
|
1525
|
+
# Optional. The IANA standard MIME type of the response. The model will generate
|
|
1526
|
+
# output that conforms to this MIME type. Supported values include 'text/plain' (
|
|
1527
|
+
# default) and 'application/json'. The model needs to be prompted to output the
|
|
1493
1528
|
# appropriate response type, otherwise the behavior is undefined. This is a
|
|
1494
1529
|
# preview feature.
|
|
1495
1530
|
# Corresponds to the JSON property `responseMimeType`
|
|
1496
1531
|
# @return [String]
|
|
1497
1532
|
attr_accessor :response_mime_type
|
|
1498
1533
|
|
|
1499
|
-
# Optional. The modalities of the response.
|
|
1534
|
+
# Optional. The modalities of the response. The model will generate a response
|
|
1535
|
+
# that includes all the specified modalities. For example, if this is set to `[
|
|
1536
|
+
# TEXT, IMAGE]`, the response will include both text and an image.
|
|
1500
1537
|
# Corresponds to the JSON property `responseModalities`
|
|
1501
1538
|
# @return [Array<String>]
|
|
1502
1539
|
attr_accessor :response_modalities
|
|
@@ -1508,42 +1545,68 @@ module Google
|
|
|
1508
1545
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Schema]
|
|
1509
1546
|
attr_accessor :response_schema
|
|
1510
1547
|
|
|
1511
|
-
# The configuration for routing the request to a specific model.
|
|
1548
|
+
# The configuration for routing the request to a specific model. This can be
|
|
1549
|
+
# used to control which model is used for the generation, either automatically
|
|
1550
|
+
# or by specifying a model name.
|
|
1512
1551
|
# Corresponds to the JSON property `routingConfig`
|
|
1513
1552
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig]
|
|
1514
1553
|
attr_accessor :routing_config
|
|
1515
1554
|
|
|
1516
|
-
# Optional.
|
|
1555
|
+
# Optional. A seed for the random number generator. By setting a seed, you can
|
|
1556
|
+
# make the model's output mostly deterministic. For a given prompt and
|
|
1557
|
+
# parameters (like temperature, top_p, etc.), the model will produce the same
|
|
1558
|
+
# response every time. However, it's not a guaranteed absolute deterministic
|
|
1559
|
+
# behavior. This is different from parameters like `temperature`, which control
|
|
1560
|
+
# the *level* of randomness. `seed` ensures that the "random" choices the model
|
|
1561
|
+
# makes are the same on every run, making it essential for testing and ensuring
|
|
1562
|
+
# reproducible results.
|
|
1517
1563
|
# Corresponds to the JSON property `seed`
|
|
1518
1564
|
# @return [Fixnum]
|
|
1519
1565
|
attr_accessor :seed
|
|
1520
1566
|
|
|
1521
|
-
#
|
|
1567
|
+
# Configuration for speech generation.
|
|
1522
1568
|
# Corresponds to the JSON property `speechConfig`
|
|
1523
1569
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SpeechConfig]
|
|
1524
1570
|
attr_accessor :speech_config
|
|
1525
1571
|
|
|
1526
|
-
# Optional.
|
|
1572
|
+
# Optional. A list of character sequences that will stop the model from
|
|
1573
|
+
# generating further tokens. If a stop sequence is generated, the output will
|
|
1574
|
+
# end at that point. This is useful for controlling the length and structure of
|
|
1575
|
+
# the output. For example, you can use ["\n", "###"] to stop generation at a new
|
|
1576
|
+
# line or a specific marker.
|
|
1527
1577
|
# Corresponds to the JSON property `stopSequences`
|
|
1528
1578
|
# @return [Array<String>]
|
|
1529
1579
|
attr_accessor :stop_sequences
|
|
1530
1580
|
|
|
1531
|
-
# Optional. Controls the randomness of
|
|
1581
|
+
# Optional. Controls the randomness of the output. A higher temperature results
|
|
1582
|
+
# in more creative and diverse responses, while a lower temperature makes the
|
|
1583
|
+
# output more predictable and focused. The valid range is (0.0, 2.0].
|
|
1532
1584
|
# Corresponds to the JSON property `temperature`
|
|
1533
1585
|
# @return [Float]
|
|
1534
1586
|
attr_accessor :temperature
|
|
1535
1587
|
|
|
1536
|
-
#
|
|
1588
|
+
# Configuration for the model's thinking features. "Thinking" is a process where
|
|
1589
|
+
# the model breaks down a complex task into smaller, manageable steps. This
|
|
1590
|
+
# allows the model to reason about the task, plan its approach, and execute the
|
|
1591
|
+
# plan to generate a high-quality response.
|
|
1537
1592
|
# Corresponds to the JSON property `thinkingConfig`
|
|
1538
1593
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig]
|
|
1539
1594
|
attr_accessor :thinking_config
|
|
1540
1595
|
|
|
1541
|
-
# Optional.
|
|
1596
|
+
# Optional. Specifies the top-k sampling threshold. The model considers only the
|
|
1597
|
+
# top k most probable tokens for the next token. This can be useful for
|
|
1598
|
+
# generating more coherent and less random text. For example, a `top_k` of 40
|
|
1599
|
+
# means the model will choose the next word from the 40 most likely words.
|
|
1542
1600
|
# Corresponds to the JSON property `topK`
|
|
1543
1601
|
# @return [Float]
|
|
1544
1602
|
attr_accessor :top_k
|
|
1545
1603
|
|
|
1546
|
-
# Optional.
|
|
1604
|
+
# Optional. Specifies the nucleus sampling threshold. The model considers only
|
|
1605
|
+
# the smallest set of tokens whose cumulative probability is at least `top_p`.
|
|
1606
|
+
# This helps generate more diverse and less repetitive responses. For example, a
|
|
1607
|
+
# `top_p` of 0.9 means the model considers tokens until the cumulative
|
|
1608
|
+
# probability of the tokens to select from reaches 0.9. It's recommended to
|
|
1609
|
+
# adjust either temperature or `top_p`, but not both.
|
|
1547
1610
|
# Corresponds to the JSON property `topP`
|
|
1548
1611
|
# @return [Float]
|
|
1549
1612
|
attr_accessor :top_p
|
|
@@ -1599,17 +1662,21 @@ module Google
|
|
|
1599
1662
|
end
|
|
1600
1663
|
end
|
|
1601
1664
|
|
|
1602
|
-
# The configuration for routing the request to a specific model.
|
|
1665
|
+
# The configuration for routing the request to a specific model. This can be
|
|
1666
|
+
# used to control which model is used for the generation, either automatically
|
|
1667
|
+
# or by specifying a model name.
|
|
1603
1668
|
class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig
|
|
1604
1669
|
include Google::Apis::Core::Hashable
|
|
1605
1670
|
|
|
1606
|
-
# When automated routing is specified,
|
|
1607
|
-
#
|
|
1671
|
+
# The configuration for automated routing. When automated routing is specified,
|
|
1672
|
+
# the routing will be determined by the pretrained routing model and customer
|
|
1673
|
+
# provided model routing preference.
|
|
1608
1674
|
# Corresponds to the JSON property `autoMode`
|
|
1609
1675
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode]
|
|
1610
1676
|
attr_accessor :auto_mode
|
|
1611
1677
|
|
|
1612
|
-
# When manual routing is
|
|
1678
|
+
# The configuration for manual routing. When manual routing is specified, the
|
|
1679
|
+
# model will be selected based on the model name provided.
|
|
1613
1680
|
# Corresponds to the JSON property `manualMode`
|
|
1614
1681
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode]
|
|
1615
1682
|
attr_accessor :manual_mode
|
|
@@ -1625,8 +1692,9 @@ module Google
|
|
|
1625
1692
|
end
|
|
1626
1693
|
end
|
|
1627
1694
|
|
|
1628
|
-
# When automated routing is specified,
|
|
1629
|
-
#
|
|
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.
|
|
1630
1698
|
class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode
|
|
1631
1699
|
include Google::Apis::Core::Hashable
|
|
1632
1700
|
|
|
@@ -1645,13 +1713,12 @@ module Google
|
|
|
1645
1713
|
end
|
|
1646
1714
|
end
|
|
1647
1715
|
|
|
1648
|
-
# When manual routing is
|
|
1716
|
+
# The configuration for manual routing. When manual routing is specified, the
|
|
1717
|
+
# model will be selected based on the model name provided.
|
|
1649
1718
|
class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode
|
|
1650
1719
|
include Google::Apis::Core::Hashable
|
|
1651
1720
|
|
|
1652
|
-
# The model
|
|
1653
|
-
# models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/
|
|
1654
|
-
# inference#supported-models).
|
|
1721
|
+
# The name of the model to use. Only public LLM models are accepted.
|
|
1655
1722
|
# Corresponds to the JSON property `modelName`
|
|
1656
1723
|
# @return [String]
|
|
1657
1724
|
attr_accessor :model_name
|
|
@@ -1666,18 +1733,26 @@ module Google
|
|
|
1666
1733
|
end
|
|
1667
1734
|
end
|
|
1668
1735
|
|
|
1669
|
-
#
|
|
1736
|
+
# Configuration for the model's thinking features. "Thinking" is a process where
|
|
1737
|
+
# the model breaks down a complex task into smaller, manageable steps. This
|
|
1738
|
+
# allows the model to reason about the task, plan its approach, and execute the
|
|
1739
|
+
# plan to generate a high-quality response.
|
|
1670
1740
|
class GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig
|
|
1671
1741
|
include Google::Apis::Core::Hashable
|
|
1672
1742
|
|
|
1673
|
-
# Optional.
|
|
1674
|
-
#
|
|
1743
|
+
# Optional. If true, the model will include its thoughts in the response. "
|
|
1744
|
+
# Thoughts" are the intermediate steps the model takes to arrive at the final
|
|
1745
|
+
# response. They can provide insights into the model's reasoning process and
|
|
1746
|
+
# help with debugging. If this is true, thoughts are returned only when
|
|
1747
|
+
# available.
|
|
1675
1748
|
# Corresponds to the JSON property `includeThoughts`
|
|
1676
1749
|
# @return [Boolean]
|
|
1677
1750
|
attr_accessor :include_thoughts
|
|
1678
1751
|
alias_method :include_thoughts?, :include_thoughts
|
|
1679
1752
|
|
|
1680
|
-
# Optional.
|
|
1753
|
+
# Optional. The token budget for the model's thinking process. The model will
|
|
1754
|
+
# make a best effort to stay within this budget. This can be used to control the
|
|
1755
|
+
# trade-off between response quality and latency.
|
|
1681
1756
|
# Corresponds to the JSON property `thinkingBudget`
|
|
1682
1757
|
# @return [Fixnum]
|
|
1683
1758
|
attr_accessor :thinking_budget
|
|
@@ -1732,21 +1807,30 @@ module Google
|
|
|
1732
1807
|
end
|
|
1733
1808
|
end
|
|
1734
1809
|
|
|
1735
|
-
#
|
|
1810
|
+
# A piece of evidence that supports a claim made by the model. This is used to
|
|
1811
|
+
# show a citation for a claim made by the model. When grounding is enabled, the
|
|
1812
|
+
# model returns a `GroundingChunk` that contains a reference to the source of
|
|
1813
|
+
# the information.
|
|
1736
1814
|
class GoogleCloudAiplatformV1beta1GroundingChunk
|
|
1737
1815
|
include Google::Apis::Core::Hashable
|
|
1738
1816
|
|
|
1739
|
-
#
|
|
1817
|
+
# A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
|
|
1818
|
+
# information about a place, such as its name, address, and reviews. This is
|
|
1819
|
+
# used to provide the user with rich, location-based information.
|
|
1740
1820
|
# Corresponds to the JSON property `maps`
|
|
1741
1821
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkMaps]
|
|
1742
1822
|
attr_accessor :maps
|
|
1743
1823
|
|
|
1744
|
-
#
|
|
1824
|
+
# Context retrieved from a data source to ground the model's response. This is
|
|
1825
|
+
# used when a retrieval tool fetches information from a user-provided corpus or
|
|
1826
|
+
# a public dataset.
|
|
1745
1827
|
# Corresponds to the JSON property `retrievedContext`
|
|
1746
1828
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext]
|
|
1747
1829
|
attr_accessor :retrieved_context
|
|
1748
1830
|
|
|
1749
|
-
#
|
|
1831
|
+
# A `Web` chunk is a piece of evidence that comes from a web page. It contains
|
|
1832
|
+
# the URI of the web page, the title of the page, and the domain of the page.
|
|
1833
|
+
# This is used to provide the user with a link to the source of the information.
|
|
1750
1834
|
# Corresponds to the JSON property `web`
|
|
1751
1835
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkWeb]
|
|
1752
1836
|
attr_accessor :web
|
|
@@ -1763,32 +1847,36 @@ module Google
|
|
|
1763
1847
|
end
|
|
1764
1848
|
end
|
|
1765
1849
|
|
|
1766
|
-
#
|
|
1850
|
+
# A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains
|
|
1851
|
+
# information about a place, such as its name, address, and reviews. This is
|
|
1852
|
+
# used to provide the user with rich, location-based information.
|
|
1767
1853
|
class GoogleCloudAiplatformV1beta1GroundingChunkMaps
|
|
1768
1854
|
include Google::Apis::Core::Hashable
|
|
1769
1855
|
|
|
1770
|
-
#
|
|
1856
|
+
# The sources that were used to generate the place answer. This includes review
|
|
1857
|
+
# snippets and photos that were used to generate the answer, as well as URIs to
|
|
1858
|
+
# flag content.
|
|
1771
1859
|
# Corresponds to the JSON property `placeAnswerSources`
|
|
1772
1860
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources]
|
|
1773
1861
|
attr_accessor :place_answer_sources
|
|
1774
1862
|
|
|
1775
|
-
# This Place's resource name, in `places/`place_id`` format.
|
|
1776
|
-
# up the
|
|
1863
|
+
# This Place's resource name, in `places/`place_id`` format. This can be used to
|
|
1864
|
+
# look up the place in the Google Maps API.
|
|
1777
1865
|
# Corresponds to the JSON property `placeId`
|
|
1778
1866
|
# @return [String]
|
|
1779
1867
|
attr_accessor :place_id
|
|
1780
1868
|
|
|
1781
|
-
#
|
|
1869
|
+
# The text of the place answer.
|
|
1782
1870
|
# Corresponds to the JSON property `text`
|
|
1783
1871
|
# @return [String]
|
|
1784
1872
|
attr_accessor :text
|
|
1785
1873
|
|
|
1786
|
-
#
|
|
1874
|
+
# The title of the place.
|
|
1787
1875
|
# Corresponds to the JSON property `title`
|
|
1788
1876
|
# @return [String]
|
|
1789
1877
|
attr_accessor :title
|
|
1790
1878
|
|
|
1791
|
-
# URI
|
|
1879
|
+
# The URI of the place.
|
|
1792
1880
|
# Corresponds to the JSON property `uri`
|
|
1793
1881
|
# @return [String]
|
|
1794
1882
|
attr_accessor :uri
|
|
@@ -1807,11 +1895,13 @@ module Google
|
|
|
1807
1895
|
end
|
|
1808
1896
|
end
|
|
1809
1897
|
|
|
1810
|
-
#
|
|
1898
|
+
# The sources that were used to generate the place answer. This includes review
|
|
1899
|
+
# snippets and photos that were used to generate the answer, as well as URIs to
|
|
1900
|
+
# flag content.
|
|
1811
1901
|
class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources
|
|
1812
1902
|
include Google::Apis::Core::Hashable
|
|
1813
1903
|
|
|
1814
|
-
# Snippets of reviews that
|
|
1904
|
+
# Snippets of reviews that were used to generate the answer.
|
|
1815
1905
|
# Corresponds to the JSON property `reviewSnippets`
|
|
1816
1906
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet>]
|
|
1817
1907
|
attr_accessor :review_snippets
|
|
@@ -1826,7 +1916,7 @@ module Google
|
|
|
1826
1916
|
end
|
|
1827
1917
|
end
|
|
1828
1918
|
|
|
1829
|
-
#
|
|
1919
|
+
# A review snippet that is used to generate the answer.
|
|
1830
1920
|
class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
|
|
1831
1921
|
include Google::Apis::Core::Hashable
|
|
1832
1922
|
|
|
@@ -1835,12 +1925,12 @@ module Google
|
|
|
1835
1925
|
# @return [String]
|
|
1836
1926
|
attr_accessor :google_maps_uri
|
|
1837
1927
|
|
|
1838
|
-
#
|
|
1928
|
+
# The ID of the review that is being referenced.
|
|
1839
1929
|
# Corresponds to the JSON property `reviewId`
|
|
1840
1930
|
# @return [String]
|
|
1841
1931
|
attr_accessor :review_id
|
|
1842
1932
|
|
|
1843
|
-
#
|
|
1933
|
+
# The title of the review.
|
|
1844
1934
|
# Corresponds to the JSON property `title`
|
|
1845
1935
|
# @return [String]
|
|
1846
1936
|
attr_accessor :title
|
|
@@ -1857,12 +1947,16 @@ module Google
|
|
|
1857
1947
|
end
|
|
1858
1948
|
end
|
|
1859
1949
|
|
|
1860
|
-
#
|
|
1950
|
+
# Context retrieved from a data source to ground the model's response. This is
|
|
1951
|
+
# used when a retrieval tool fetches information from a user-provided corpus or
|
|
1952
|
+
# a public dataset.
|
|
1861
1953
|
class GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext
|
|
1862
1954
|
include Google::Apis::Core::Hashable
|
|
1863
1955
|
|
|
1864
|
-
# Output only. The full
|
|
1865
|
-
# document.
|
|
1956
|
+
# Output only. The full resource name of the referenced Vertex AI Search
|
|
1957
|
+
# document. This is used to identify the specific document that was retrieved.
|
|
1958
|
+
# The format is `projects/`project`/locations/`location`/collections/`collection`
|
|
1959
|
+
# /dataStores/`data_store`/branches/`branch`/documents/`document``.
|
|
1866
1960
|
# Corresponds to the JSON property `documentName`
|
|
1867
1961
|
# @return [String]
|
|
1868
1962
|
attr_accessor :document_name
|
|
@@ -1873,17 +1967,17 @@ module Google
|
|
|
1873
1967
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1RagChunk]
|
|
1874
1968
|
attr_accessor :rag_chunk
|
|
1875
1969
|
|
|
1876
|
-
#
|
|
1970
|
+
# The content of the retrieved data source.
|
|
1877
1971
|
# Corresponds to the JSON property `text`
|
|
1878
1972
|
# @return [String]
|
|
1879
1973
|
attr_accessor :text
|
|
1880
1974
|
|
|
1881
|
-
#
|
|
1975
|
+
# The title of the retrieved data source.
|
|
1882
1976
|
# Corresponds to the JSON property `title`
|
|
1883
1977
|
# @return [String]
|
|
1884
1978
|
attr_accessor :title
|
|
1885
1979
|
|
|
1886
|
-
# URI
|
|
1980
|
+
# The URI of the retrieved data source.
|
|
1887
1981
|
# Corresponds to the JSON property `uri`
|
|
1888
1982
|
# @return [String]
|
|
1889
1983
|
attr_accessor :uri
|
|
@@ -1902,21 +1996,24 @@ module Google
|
|
|
1902
1996
|
end
|
|
1903
1997
|
end
|
|
1904
1998
|
|
|
1905
|
-
#
|
|
1999
|
+
# A `Web` chunk is a piece of evidence that comes from a web page. It contains
|
|
2000
|
+
# the URI of the web page, the title of the page, and the domain of the page.
|
|
2001
|
+
# This is used to provide the user with a link to the source of the information.
|
|
1906
2002
|
class GoogleCloudAiplatformV1beta1GroundingChunkWeb
|
|
1907
2003
|
include Google::Apis::Core::Hashable
|
|
1908
2004
|
|
|
1909
|
-
#
|
|
2005
|
+
# The domain of the web page that contains the evidence. This can be used to
|
|
2006
|
+
# filter out low-quality sources.
|
|
1910
2007
|
# Corresponds to the JSON property `domain`
|
|
1911
2008
|
# @return [String]
|
|
1912
2009
|
attr_accessor :domain
|
|
1913
2010
|
|
|
1914
|
-
#
|
|
2011
|
+
# The title of the web page that contains the evidence.
|
|
1915
2012
|
# Corresponds to the JSON property `title`
|
|
1916
2013
|
# @return [String]
|
|
1917
2014
|
attr_accessor :title
|
|
1918
2015
|
|
|
1919
|
-
# URI
|
|
2016
|
+
# The URI of the web page that contains the evidence.
|
|
1920
2017
|
# Corresponds to the JSON property `uri`
|
|
1921
2018
|
# @return [String]
|
|
1922
2019
|
attr_accessor :uri
|
|
@@ -1933,49 +2030,63 @@ module Google
|
|
|
1933
2030
|
end
|
|
1934
2031
|
end
|
|
1935
2032
|
|
|
1936
|
-
#
|
|
2033
|
+
# Information about the sources that support the content of a response. When
|
|
2034
|
+
# grounding is enabled, the model returns citations for claims in the response.
|
|
2035
|
+
# This object contains the retrieved sources.
|
|
1937
2036
|
class GoogleCloudAiplatformV1beta1GroundingMetadata
|
|
1938
2037
|
include Google::Apis::Core::Hashable
|
|
1939
2038
|
|
|
1940
|
-
# Optional. Output only.
|
|
1941
|
-
#
|
|
1942
|
-
#
|
|
2039
|
+
# Optional. Output only. A token that can be used to render a Google Maps widget
|
|
2040
|
+
# with the contextual data. This field is populated only when the grounding
|
|
2041
|
+
# source is Google Maps.
|
|
1943
2042
|
# Corresponds to the JSON property `googleMapsWidgetContextToken`
|
|
1944
2043
|
# @return [String]
|
|
1945
2044
|
attr_accessor :google_maps_widget_context_token
|
|
1946
2045
|
|
|
1947
|
-
#
|
|
2046
|
+
# A list of supporting references retrieved from the grounding source. This
|
|
2047
|
+
# field is populated when the grounding source is Google Search, Vertex AI
|
|
2048
|
+
# Search, or Google Maps.
|
|
1948
2049
|
# Corresponds to the JSON property `groundingChunks`
|
|
1949
2050
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingChunk>]
|
|
1950
2051
|
attr_accessor :grounding_chunks
|
|
1951
2052
|
|
|
1952
|
-
# Optional.
|
|
2053
|
+
# Optional. A list of grounding supports that connect the generated content to
|
|
2054
|
+
# the grounding chunks. This field is populated when the grounding source is
|
|
2055
|
+
# Google Search or Vertex AI Search.
|
|
1953
2056
|
# Corresponds to the JSON property `groundingSupports`
|
|
1954
2057
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingSupport>]
|
|
1955
2058
|
attr_accessor :grounding_supports
|
|
1956
2059
|
|
|
1957
|
-
# Metadata related to retrieval
|
|
2060
|
+
# Metadata related to the retrieval grounding source. This is part of the `
|
|
2061
|
+
# GroundingMetadata` returned when grounding is enabled.
|
|
1958
2062
|
# Corresponds to the JSON property `retrievalMetadata`
|
|
1959
2063
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1RetrievalMetadata]
|
|
1960
2064
|
attr_accessor :retrieval_metadata
|
|
1961
2065
|
|
|
1962
|
-
# Optional.
|
|
2066
|
+
# Optional. The queries that were executed by the retrieval tools. This field is
|
|
2067
|
+
# populated only when the grounding source is a retrieval tool, such as Vertex
|
|
2068
|
+
# AI Search.
|
|
1963
2069
|
# Corresponds to the JSON property `retrievalQueries`
|
|
1964
2070
|
# @return [Array<String>]
|
|
1965
2071
|
attr_accessor :retrieval_queries
|
|
1966
2072
|
|
|
1967
|
-
#
|
|
2073
|
+
# An entry point for displaying Google Search results. A `SearchEntryPoint` is
|
|
2074
|
+
# populated when the grounding source for a model's response is Google Search.
|
|
2075
|
+
# It provides information that you can use to display the search results in your
|
|
2076
|
+
# application.
|
|
1968
2077
|
# Corresponds to the JSON property `searchEntryPoint`
|
|
1969
2078
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SearchEntryPoint]
|
|
1970
2079
|
attr_accessor :search_entry_point
|
|
1971
2080
|
|
|
1972
|
-
# Optional. Output only.
|
|
1973
|
-
# populated only
|
|
2081
|
+
# Optional. Output only. A list of URIs that can be used to flag a place or
|
|
2082
|
+
# review for inappropriate content. This field is populated only when the
|
|
2083
|
+
# grounding source is Google Maps.
|
|
1974
2084
|
# Corresponds to the JSON property `sourceFlaggingUris`
|
|
1975
2085
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri>]
|
|
1976
2086
|
attr_accessor :source_flagging_uris
|
|
1977
2087
|
|
|
1978
|
-
# Optional.
|
|
2088
|
+
# Optional. The web search queries that were used to generate the content. This
|
|
2089
|
+
# field is populated only when the grounding source is Google Search.
|
|
1979
2090
|
# Corresponds to the JSON property `webSearchQueries`
|
|
1980
2091
|
# @return [Array<String>]
|
|
1981
2092
|
attr_accessor :web_search_queries
|
|
@@ -1997,17 +2108,17 @@ module Google
|
|
|
1997
2108
|
end
|
|
1998
2109
|
end
|
|
1999
2110
|
|
|
2000
|
-
#
|
|
2001
|
-
# only
|
|
2111
|
+
# A URI that can be used to flag a place or review for inappropriate content.
|
|
2112
|
+
# This is populated only when the grounding source is Google Maps.
|
|
2002
2113
|
class GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri
|
|
2003
2114
|
include Google::Apis::Core::Hashable
|
|
2004
2115
|
|
|
2005
|
-
#
|
|
2116
|
+
# The URI that can be used to flag the content.
|
|
2006
2117
|
# Corresponds to the JSON property `flagContentUri`
|
|
2007
2118
|
# @return [String]
|
|
2008
2119
|
attr_accessor :flag_content_uri
|
|
2009
2120
|
|
|
2010
|
-
#
|
|
2121
|
+
# The ID of the place or review.
|
|
2011
2122
|
# Corresponds to the JSON property `sourceId`
|
|
2012
2123
|
# @return [String]
|
|
2013
2124
|
attr_accessor :source_id
|
|
@@ -2023,27 +2134,30 @@ module Google
|
|
|
2023
2134
|
end
|
|
2024
2135
|
end
|
|
2025
2136
|
|
|
2026
|
-
#
|
|
2137
|
+
# A collection of supporting references for a segment of the model's response.
|
|
2027
2138
|
class GoogleCloudAiplatformV1beta1GroundingSupport
|
|
2028
2139
|
include Google::Apis::Core::Hashable
|
|
2029
2140
|
|
|
2030
|
-
#
|
|
2031
|
-
#
|
|
2032
|
-
#
|
|
2141
|
+
# The confidence scores for the support references. This list is parallel to the
|
|
2142
|
+
# `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a
|
|
2143
|
+
# higher score indicating a higher confidence that the reference supports the
|
|
2144
|
+
# claim. For Gemini 2.0 and before, this list has the same size as `
|
|
2145
|
+
# grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and
|
|
2033
2146
|
# should be ignored.
|
|
2034
2147
|
# Corresponds to the JSON property `confidenceScores`
|
|
2035
2148
|
# @return [Array<Float>]
|
|
2036
2149
|
attr_accessor :confidence_scores
|
|
2037
2150
|
|
|
2038
|
-
# A list of indices
|
|
2039
|
-
#
|
|
2040
|
-
#
|
|
2041
|
-
# the
|
|
2151
|
+
# A list of indices into the `grounding_chunks` field of the `GroundingMetadata`
|
|
2152
|
+
# message. These indices specify which grounding chunks support the claim made
|
|
2153
|
+
# in the content segment. For example, if this field has the values `[1, 3]`, it
|
|
2154
|
+
# means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for
|
|
2155
|
+
# the claim in the content segment.
|
|
2042
2156
|
# Corresponds to the JSON property `groundingChunkIndices`
|
|
2043
2157
|
# @return [Array<Fixnum>]
|
|
2044
2158
|
attr_accessor :grounding_chunk_indices
|
|
2045
2159
|
|
|
2046
|
-
#
|
|
2160
|
+
# A segment of the content.
|
|
2047
2161
|
# Corresponds to the JSON property `segment`
|
|
2048
2162
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Segment]
|
|
2049
2163
|
attr_accessor :segment
|
|
@@ -2060,7 +2174,9 @@ module Google
|
|
|
2060
2174
|
end
|
|
2061
2175
|
end
|
|
2062
2176
|
|
|
2063
|
-
#
|
|
2177
|
+
# Configuration for image generation. This message allows you to control various
|
|
2178
|
+
# aspects of image generation, such as the output format, aspect ratio, and
|
|
2179
|
+
# whether the model can generate images of people.
|
|
2064
2180
|
class GoogleCloudAiplatformV1beta1ImageConfig
|
|
2065
2181
|
include Google::Apis::Core::Hashable
|
|
2066
2182
|
|
|
@@ -2118,17 +2234,24 @@ module Google
|
|
|
2118
2234
|
end
|
|
2119
2235
|
end
|
|
2120
2236
|
|
|
2121
|
-
#
|
|
2237
|
+
# The log probabilities of the tokens generated by the model. This is useful for
|
|
2238
|
+
# understanding the model's confidence in its predictions and for debugging. For
|
|
2239
|
+
# example, you can use log probabilities to identify when the model is making a
|
|
2240
|
+
# less confident prediction or to explore alternative responses that the model
|
|
2241
|
+
# considered. A low log probability can also indicate that the model is "
|
|
2242
|
+
# hallucinating" or generating factually incorrect information.
|
|
2122
2243
|
class GoogleCloudAiplatformV1beta1LogprobsResult
|
|
2123
2244
|
include Google::Apis::Core::Hashable
|
|
2124
2245
|
|
|
2125
|
-
#
|
|
2126
|
-
#
|
|
2246
|
+
# A list of the chosen candidate tokens at each decoding step. The length of
|
|
2247
|
+
# this list is equal to the total number of decoding steps. Note that the chosen
|
|
2248
|
+
# candidate might not be in `top_candidates`.
|
|
2127
2249
|
# Corresponds to the JSON property `chosenCandidates`
|
|
2128
2250
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
|
|
2129
2251
|
attr_accessor :chosen_candidates
|
|
2130
2252
|
|
|
2131
|
-
#
|
|
2253
|
+
# A list of the top candidate tokens at each decoding step. The length of this
|
|
2254
|
+
# list is equal to the total number of decoding steps.
|
|
2132
2255
|
# Corresponds to the JSON property `topCandidates`
|
|
2133
2256
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates>]
|
|
2134
2257
|
attr_accessor :top_candidates
|
|
@@ -2144,21 +2267,27 @@ module Google
|
|
|
2144
2267
|
end
|
|
2145
2268
|
end
|
|
2146
2269
|
|
|
2147
|
-
#
|
|
2270
|
+
# A single token and its associated log probability.
|
|
2148
2271
|
class GoogleCloudAiplatformV1beta1LogprobsResultCandidate
|
|
2149
2272
|
include Google::Apis::Core::Hashable
|
|
2150
2273
|
|
|
2151
|
-
# The
|
|
2274
|
+
# The log probability of this token. A higher value indicates that the model was
|
|
2275
|
+
# more confident in this token. The log probability can be used to assess the
|
|
2276
|
+
# relative likelihood of different tokens and to identify when the model is
|
|
2277
|
+
# uncertain.
|
|
2152
2278
|
# Corresponds to the JSON property `logProbability`
|
|
2153
2279
|
# @return [Float]
|
|
2154
2280
|
attr_accessor :log_probability
|
|
2155
2281
|
|
|
2156
|
-
# The
|
|
2282
|
+
# The token's string representation.
|
|
2157
2283
|
# Corresponds to the JSON property `token`
|
|
2158
2284
|
# @return [String]
|
|
2159
2285
|
attr_accessor :token
|
|
2160
2286
|
|
|
2161
|
-
# The
|
|
2287
|
+
# The token's numerical ID. While the `token` field provides the string
|
|
2288
|
+
# representation of the token, the `token_id` is the numerical representation
|
|
2289
|
+
# that the model uses internally. This can be useful for developers who want to
|
|
2290
|
+
# build custom logic based on the model's vocabulary.
|
|
2162
2291
|
# Corresponds to the JSON property `tokenId`
|
|
2163
2292
|
# @return [Fixnum]
|
|
2164
2293
|
attr_accessor :token_id
|
|
@@ -2175,11 +2304,12 @@ module Google
|
|
|
2175
2304
|
end
|
|
2176
2305
|
end
|
|
2177
2306
|
|
|
2178
|
-
#
|
|
2307
|
+
# A list of the top candidate tokens and their log probabilities at each
|
|
2308
|
+
# decoding step. This can be used to see what other tokens the model considered.
|
|
2179
2309
|
class GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates
|
|
2180
2310
|
include Google::Apis::Core::Hashable
|
|
2181
2311
|
|
|
2182
|
-
#
|
|
2312
|
+
# The list of candidate tokens, sorted by log probability in descending order.
|
|
2183
2313
|
# Corresponds to the JSON property `candidates`
|
|
2184
2314
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1LogprobsResultCandidate>]
|
|
2185
2315
|
attr_accessor :candidates
|
|
@@ -2194,16 +2324,21 @@ module Google
|
|
|
2194
2324
|
end
|
|
2195
2325
|
end
|
|
2196
2326
|
|
|
2197
|
-
# Represents
|
|
2327
|
+
# Represents a breakdown of token usage by modality. This message is used in
|
|
2328
|
+
# CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a
|
|
2329
|
+
# detailed view of how many tokens are used by each modality (e.g., text, image,
|
|
2330
|
+
# video) in a request. This is particularly useful for multimodal models,
|
|
2331
|
+
# allowing you to track and manage token consumption for billing and quota
|
|
2332
|
+
# purposes.
|
|
2198
2333
|
class GoogleCloudAiplatformV1beta1ModalityTokenCount
|
|
2199
2334
|
include Google::Apis::Core::Hashable
|
|
2200
2335
|
|
|
2201
|
-
# The modality
|
|
2336
|
+
# The modality that this token count applies to.
|
|
2202
2337
|
# Corresponds to the JSON property `modality`
|
|
2203
2338
|
# @return [String]
|
|
2204
2339
|
attr_accessor :modality
|
|
2205
2340
|
|
|
2206
|
-
#
|
|
2341
|
+
# The number of tokens counted for this modality.
|
|
2207
2342
|
# Corresponds to the JSON property `tokenCount`
|
|
2208
2343
|
# @return [Fixnum]
|
|
2209
2344
|
attr_accessor :token_count
|
|
@@ -2219,17 +2354,29 @@ module Google
|
|
|
2219
2354
|
end
|
|
2220
2355
|
end
|
|
2221
2356
|
|
|
2222
|
-
# Configuration for Model Armor
|
|
2357
|
+
# Configuration for Model Armor. Model Armor is a Google Cloud service that
|
|
2358
|
+
# provides safety and security filtering for prompts and responses. It helps
|
|
2359
|
+
# protect your AI applications from risks such as harmful content, sensitive
|
|
2360
|
+
# data leakage, and prompt injection attacks.
|
|
2223
2361
|
class GoogleCloudAiplatformV1beta1ModelArmorConfig
|
|
2224
2362
|
include Google::Apis::Core::Hashable
|
|
2225
2363
|
|
|
2226
|
-
# Optional. The name of the Model Armor template to use for prompt
|
|
2364
|
+
# Optional. The resource name of the Model Armor template to use for prompt
|
|
2365
|
+
# screening. A Model Armor template is a set of customized filters and
|
|
2366
|
+
# thresholds that define how Model Armor screens content. If specified, Model
|
|
2367
|
+
# Armor will use this template to check the user's prompt for safety and
|
|
2368
|
+
# security risks before it is sent to the model. The name must be in the format `
|
|
2369
|
+
# projects/`project`/locations/`location`/templates/`template``.
|
|
2227
2370
|
# Corresponds to the JSON property `promptTemplateName`
|
|
2228
2371
|
# @return [String]
|
|
2229
2372
|
attr_accessor :prompt_template_name
|
|
2230
2373
|
|
|
2231
|
-
# Optional. The name of the Model Armor template to use for response
|
|
2232
|
-
#
|
|
2374
|
+
# Optional. The resource name of the Model Armor template to use for response
|
|
2375
|
+
# screening. A Model Armor template is a set of customized filters and
|
|
2376
|
+
# thresholds that define how Model Armor screens content. If specified, Model
|
|
2377
|
+
# Armor will use this template to check the model's response for safety and
|
|
2378
|
+
# security risks before it is returned to the user. The name must be in the
|
|
2379
|
+
# format `projects/`project`/locations/`location`/templates/`template``.
|
|
2233
2380
|
# Corresponds to the JSON property `responseTemplateName`
|
|
2234
2381
|
# @return [String]
|
|
2235
2382
|
attr_accessor :response_template_name
|
|
@@ -2245,8 +2392,7 @@ module Google
|
|
|
2245
2392
|
end
|
|
2246
2393
|
end
|
|
2247
2394
|
|
|
2248
|
-
# Configuration for a multi-speaker text-to-speech
|
|
2249
|
-
# to two distinct voices in a single synthesis request.
|
|
2395
|
+
# Configuration for a multi-speaker text-to-speech request.
|
|
2250
2396
|
class GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig
|
|
2251
2397
|
include Google::Apis::Core::Hashable
|
|
2252
2398
|
|
|
@@ -2266,11 +2412,11 @@ module Google
|
|
|
2266
2412
|
end
|
|
2267
2413
|
end
|
|
2268
2414
|
|
|
2269
|
-
# A datatype containing media that is part of a multi-part
|
|
2415
|
+
# A datatype containing media that is part of a multi-part Content message. A `
|
|
2270
2416
|
# Part` consists of data which has an associated datatype. A `Part` can only
|
|
2271
|
-
# contain one of the accepted types in `Part.data`.
|
|
2272
|
-
# IANA MIME type identifying the type and subtype
|
|
2273
|
-
# or `file_data` field is filled with raw bytes.
|
|
2417
|
+
# contain one of the accepted types in `Part.data`. For media types that are not
|
|
2418
|
+
# text, `Part` must have a fixed IANA MIME type identifying the type and subtype
|
|
2419
|
+
# of the media if `inline_data` or `file_data` field is filled with raw bytes.
|
|
2274
2420
|
class GoogleCloudAiplatformV1beta1Part
|
|
2275
2421
|
include Google::Apis::Core::Hashable
|
|
2276
2422
|
|
|
@@ -2289,7 +2435,9 @@ module Google
|
|
|
2289
2435
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ExecutableCode]
|
|
2290
2436
|
attr_accessor :executable_code
|
|
2291
2437
|
|
|
2292
|
-
# URI
|
|
2438
|
+
# URI-based data. A FileData message contains a URI pointing to data of a
|
|
2439
|
+
# specific media type. It is used to represent images, audio, and video stored
|
|
2440
|
+
# in Google Cloud Storage.
|
|
2293
2441
|
# Corresponds to the JSON property `fileData`
|
|
2294
2442
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1FileData]
|
|
2295
2443
|
attr_accessor :file_data
|
|
@@ -2309,17 +2457,19 @@ module Google
|
|
|
2309
2457
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1FunctionResponse]
|
|
2310
2458
|
attr_accessor :function_response
|
|
2311
2459
|
|
|
2312
|
-
#
|
|
2460
|
+
# A content blob. A Blob contains data of a specific media type. It is used to
|
|
2461
|
+
# represent images, audio, and video.
|
|
2313
2462
|
# Corresponds to the JSON property `inlineData`
|
|
2314
2463
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Blob]
|
|
2315
2464
|
attr_accessor :inline_data
|
|
2316
2465
|
|
|
2317
|
-
# Optional.
|
|
2466
|
+
# Optional. The text content of the part.
|
|
2318
2467
|
# Corresponds to the JSON property `text`
|
|
2319
2468
|
# @return [String]
|
|
2320
2469
|
attr_accessor :text
|
|
2321
2470
|
|
|
2322
|
-
# Optional. Indicates
|
|
2471
|
+
# Optional. Indicates whether the `part` represents the model's thought process
|
|
2472
|
+
# or reasoning.
|
|
2323
2473
|
# Corresponds to the JSON property `thought`
|
|
2324
2474
|
# @return [Boolean]
|
|
2325
2475
|
attr_accessor :thought
|
|
@@ -2332,7 +2482,8 @@ module Google
|
|
|
2332
2482
|
# @return [String]
|
|
2333
2483
|
attr_accessor :thought_signature
|
|
2334
2484
|
|
|
2335
|
-
#
|
|
2485
|
+
# Provides metadata for a video, including the start and end offsets for
|
|
2486
|
+
# clipping and the frame rate.
|
|
2336
2487
|
# Corresponds to the JSON property `videoMetadata`
|
|
2337
2488
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VideoMetadata]
|
|
2338
2489
|
attr_accessor :video_metadata
|
|
@@ -2356,11 +2507,11 @@ module Google
|
|
|
2356
2507
|
end
|
|
2357
2508
|
end
|
|
2358
2509
|
|
|
2359
|
-
#
|
|
2510
|
+
# Configuration for a prebuilt voice.
|
|
2360
2511
|
class GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig
|
|
2361
2512
|
include Google::Apis::Core::Hashable
|
|
2362
2513
|
|
|
2363
|
-
# The name of the
|
|
2514
|
+
# The name of the prebuilt voice to use.
|
|
2364
2515
|
# Corresponds to the JSON property `voiceName`
|
|
2365
2516
|
# @return [String]
|
|
2366
2517
|
attr_accessor :voice_name
|
|
@@ -2653,15 +2804,17 @@ module Google
|
|
|
2653
2804
|
end
|
|
2654
2805
|
end
|
|
2655
2806
|
|
|
2656
|
-
# Metadata related to retrieval
|
|
2807
|
+
# Metadata related to the retrieval grounding source. This is part of the `
|
|
2808
|
+
# GroundingMetadata` returned when grounding is enabled.
|
|
2657
2809
|
class GoogleCloudAiplatformV1beta1RetrievalMetadata
|
|
2658
2810
|
include Google::Apis::Core::Hashable
|
|
2659
2811
|
|
|
2660
|
-
# Optional.
|
|
2661
|
-
# help answer the prompt. The score is in the range `[0, 1]
|
|
2662
|
-
#
|
|
2663
|
-
#
|
|
2664
|
-
#
|
|
2812
|
+
# Optional. A score indicating how likely it is that a Google Search query could
|
|
2813
|
+
# help answer the prompt. The score is in the range of `[0, 1]`. A score of 1
|
|
2814
|
+
# means the model is confident that a search will be helpful, and 0 means it is
|
|
2815
|
+
# not. This score is populated only when Google Search grounding and dynamic
|
|
2816
|
+
# retrieval are enabled. The score is used to determine whether to trigger a
|
|
2817
|
+
# search.
|
|
2665
2818
|
# Corresponds to the JSON property `googleSearchDynamicRetrievalScore`
|
|
2666
2819
|
# @return [Float]
|
|
2667
2820
|
attr_accessor :google_search_dynamic_retrieval_score
|
|
@@ -2676,18 +2829,18 @@ module Google
|
|
|
2676
2829
|
end
|
|
2677
2830
|
end
|
|
2678
2831
|
|
|
2679
|
-
#
|
|
2832
|
+
# A safety rating for a piece of content. The safety rating contains the harm
|
|
2833
|
+
# category and the harm probability level.
|
|
2680
2834
|
class GoogleCloudAiplatformV1beta1SafetyRating
|
|
2681
2835
|
include Google::Apis::Core::Hashable
|
|
2682
2836
|
|
|
2683
|
-
# Output only. Indicates whether the content was
|
|
2684
|
-
# rating.
|
|
2837
|
+
# Output only. Indicates whether the content was blocked because of this rating.
|
|
2685
2838
|
# Corresponds to the JSON property `blocked`
|
|
2686
2839
|
# @return [Boolean]
|
|
2687
2840
|
attr_accessor :blocked
|
|
2688
2841
|
alias_method :blocked?, :blocked
|
|
2689
2842
|
|
|
2690
|
-
# Output only.
|
|
2843
|
+
# Output only. The harm category of this rating.
|
|
2691
2844
|
# Corresponds to the JSON property `category`
|
|
2692
2845
|
# @return [String]
|
|
2693
2846
|
attr_accessor :category
|
|
@@ -2699,22 +2852,22 @@ module Google
|
|
|
2699
2852
|
# @return [String]
|
|
2700
2853
|
attr_accessor :overwritten_threshold
|
|
2701
2854
|
|
|
2702
|
-
# Output only.
|
|
2855
|
+
# Output only. The probability of harm for this category.
|
|
2703
2856
|
# Corresponds to the JSON property `probability`
|
|
2704
2857
|
# @return [String]
|
|
2705
2858
|
attr_accessor :probability
|
|
2706
2859
|
|
|
2707
|
-
# Output only.
|
|
2860
|
+
# Output only. The probability score of harm for this category.
|
|
2708
2861
|
# Corresponds to the JSON property `probabilityScore`
|
|
2709
2862
|
# @return [Float]
|
|
2710
2863
|
attr_accessor :probability_score
|
|
2711
2864
|
|
|
2712
|
-
# Output only.
|
|
2865
|
+
# Output only. The severity of harm for this category.
|
|
2713
2866
|
# Corresponds to the JSON property `severity`
|
|
2714
2867
|
# @return [String]
|
|
2715
2868
|
attr_accessor :severity
|
|
2716
2869
|
|
|
2717
|
-
# Output only.
|
|
2870
|
+
# Output only. The severity score of harm for this category.
|
|
2718
2871
|
# Corresponds to the JSON property `severityScore`
|
|
2719
2872
|
# @return [Float]
|
|
2720
2873
|
attr_accessor :severity_score
|
|
@@ -2735,22 +2888,24 @@ module Google
|
|
|
2735
2888
|
end
|
|
2736
2889
|
end
|
|
2737
2890
|
|
|
2738
|
-
#
|
|
2891
|
+
# A safety setting that affects the safety-blocking behavior. A SafetySetting
|
|
2892
|
+
# consists of a harm category and a threshold for that category.
|
|
2739
2893
|
class GoogleCloudAiplatformV1beta1SafetySetting
|
|
2740
2894
|
include Google::Apis::Core::Hashable
|
|
2741
2895
|
|
|
2742
|
-
# Required.
|
|
2896
|
+
# Required. The harm category to be blocked.
|
|
2743
2897
|
# Corresponds to the JSON property `category`
|
|
2744
2898
|
# @return [String]
|
|
2745
2899
|
attr_accessor :category
|
|
2746
2900
|
|
|
2747
|
-
# Optional.
|
|
2748
|
-
#
|
|
2901
|
+
# Optional. The method for blocking content. If not specified, the default
|
|
2902
|
+
# behavior is to use the probability score.
|
|
2749
2903
|
# Corresponds to the JSON property `method`
|
|
2750
2904
|
# @return [String]
|
|
2751
2905
|
attr_accessor :method_prop
|
|
2752
2906
|
|
|
2753
|
-
# Required. The harm
|
|
2907
|
+
# Required. The threshold for blocking content. If the harm probability exceeds
|
|
2908
|
+
# this threshold, the content will be blocked.
|
|
2754
2909
|
# Corresponds to the JSON property `threshold`
|
|
2755
2910
|
# @return [String]
|
|
2756
2911
|
attr_accessor :threshold
|
|
@@ -2953,17 +3108,23 @@ module Google
|
|
|
2953
3108
|
end
|
|
2954
3109
|
end
|
|
2955
3110
|
|
|
2956
|
-
#
|
|
3111
|
+
# An entry point for displaying Google Search results. A `SearchEntryPoint` is
|
|
3112
|
+
# populated when the grounding source for a model's response is Google Search.
|
|
3113
|
+
# It provides information that you can use to display the search results in your
|
|
3114
|
+
# application.
|
|
2957
3115
|
class GoogleCloudAiplatformV1beta1SearchEntryPoint
|
|
2958
3116
|
include Google::Apis::Core::Hashable
|
|
2959
3117
|
|
|
2960
|
-
# Optional.
|
|
2961
|
-
# webview.
|
|
3118
|
+
# Optional. An HTML snippet that can be embedded in a web page or an application'
|
|
3119
|
+
# s webview. This snippet displays a search result, including the title, URL,
|
|
3120
|
+
# and a brief description of the search result.
|
|
2962
3121
|
# Corresponds to the JSON property `renderedContent`
|
|
2963
3122
|
# @return [String]
|
|
2964
3123
|
attr_accessor :rendered_content
|
|
2965
3124
|
|
|
2966
|
-
# Optional.
|
|
3125
|
+
# Optional. A base64-encoded JSON object that contains a list of search queries
|
|
3126
|
+
# and their corresponding search URLs. This information can be used to build a
|
|
3127
|
+
# custom search UI.
|
|
2967
3128
|
# Corresponds to the JSON property `sdkBlob`
|
|
2968
3129
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
2969
3130
|
# @return [String]
|
|
@@ -2980,28 +3141,31 @@ module Google
|
|
|
2980
3141
|
end
|
|
2981
3142
|
end
|
|
2982
3143
|
|
|
2983
|
-
#
|
|
3144
|
+
# A segment of the content.
|
|
2984
3145
|
class GoogleCloudAiplatformV1beta1Segment
|
|
2985
3146
|
include Google::Apis::Core::Hashable
|
|
2986
3147
|
|
|
2987
|
-
# Output only.
|
|
2988
|
-
#
|
|
3148
|
+
# Output only. The end index of the segment in the `Part`, measured in bytes.
|
|
3149
|
+
# This marks the end of the segment and is exclusive, meaning the segment
|
|
3150
|
+
# includes content up to, but not including, the byte at this index.
|
|
2989
3151
|
# Corresponds to the JSON property `endIndex`
|
|
2990
3152
|
# @return [Fixnum]
|
|
2991
3153
|
attr_accessor :end_index
|
|
2992
3154
|
|
|
2993
|
-
# Output only. The index of
|
|
3155
|
+
# Output only. The index of the `Part` object that this segment belongs to. This
|
|
3156
|
+
# is useful for associating the segment with a specific part of the content.
|
|
2994
3157
|
# Corresponds to the JSON property `partIndex`
|
|
2995
3158
|
# @return [Fixnum]
|
|
2996
3159
|
attr_accessor :part_index
|
|
2997
3160
|
|
|
2998
|
-
# Output only.
|
|
2999
|
-
#
|
|
3161
|
+
# Output only. The start index of the segment in the `Part`, measured in bytes.
|
|
3162
|
+
# This marks the beginning of the segment and is inclusive, meaning the byte at
|
|
3163
|
+
# this index is the first byte of the segment.
|
|
3000
3164
|
# Corresponds to the JSON property `startIndex`
|
|
3001
3165
|
# @return [Fixnum]
|
|
3002
3166
|
attr_accessor :start_index
|
|
3003
3167
|
|
|
3004
|
-
# Output only. The text
|
|
3168
|
+
# Output only. The text of the segment.
|
|
3005
3169
|
# Corresponds to the JSON property `text`
|
|
3006
3170
|
# @return [String]
|
|
3007
3171
|
attr_accessor :text
|
|
@@ -3019,7 +3183,7 @@ module Google
|
|
|
3019
3183
|
end
|
|
3020
3184
|
end
|
|
3021
3185
|
|
|
3022
|
-
# Configuration for a single speaker in a multi
|
|
3186
|
+
# Configuration for a single speaker in a multi-speaker setup.
|
|
3023
3187
|
class GoogleCloudAiplatformV1beta1SpeakerVoiceConfig
|
|
3024
3188
|
include Google::Apis::Core::Hashable
|
|
3025
3189
|
|
|
@@ -3029,7 +3193,7 @@ module Google
|
|
|
3029
3193
|
# @return [String]
|
|
3030
3194
|
attr_accessor :speaker
|
|
3031
3195
|
|
|
3032
|
-
#
|
|
3196
|
+
# Configuration for a voice.
|
|
3033
3197
|
# Corresponds to the JSON property `voiceConfig`
|
|
3034
3198
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VoiceConfig]
|
|
3035
3199
|
attr_accessor :voice_config
|
|
@@ -3045,22 +3209,21 @@ module Google
|
|
|
3045
3209
|
end
|
|
3046
3210
|
end
|
|
3047
3211
|
|
|
3048
|
-
#
|
|
3212
|
+
# Configuration for speech generation.
|
|
3049
3213
|
class GoogleCloudAiplatformV1beta1SpeechConfig
|
|
3050
3214
|
include Google::Apis::Core::Hashable
|
|
3051
3215
|
|
|
3052
|
-
# Optional.
|
|
3216
|
+
# Optional. The language code (ISO 639-1) for the speech synthesis.
|
|
3053
3217
|
# Corresponds to the JSON property `languageCode`
|
|
3054
3218
|
# @return [String]
|
|
3055
3219
|
attr_accessor :language_code
|
|
3056
3220
|
|
|
3057
|
-
# Configuration for a multi-speaker text-to-speech
|
|
3058
|
-
# to two distinct voices in a single synthesis request.
|
|
3221
|
+
# Configuration for a multi-speaker text-to-speech request.
|
|
3059
3222
|
# Corresponds to the JSON property `multiSpeakerVoiceConfig`
|
|
3060
3223
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig]
|
|
3061
3224
|
attr_accessor :multi_speaker_voice_config
|
|
3062
3225
|
|
|
3063
|
-
#
|
|
3226
|
+
# Configuration for a voice.
|
|
3064
3227
|
# Corresponds to the JSON property `voiceConfig`
|
|
3065
3228
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VoiceConfig]
|
|
3066
3229
|
attr_accessor :voice_config
|
|
@@ -3181,11 +3344,12 @@ module Google
|
|
|
3181
3344
|
# @return [String]
|
|
3182
3345
|
attr_accessor :environment
|
|
3183
3346
|
|
|
3184
|
-
# Optional. By default, predefined functions
|
|
3185
|
-
#
|
|
3186
|
-
#
|
|
3187
|
-
#
|
|
3188
|
-
#
|
|
3347
|
+
# Optional. By default, [predefined functions](https://cloud.google.com/vertex-
|
|
3348
|
+
# ai/generative-ai/docs/computer-use#supported-actions) are included in the
|
|
3349
|
+
# final model call. Some of them can be explicitly excluded from being
|
|
3350
|
+
# automatically included. This can serve two purposes: 1. Using a more
|
|
3351
|
+
# restricted / different action space. 2. Improving the definitions /
|
|
3352
|
+
# instructions of predefined functions.
|
|
3189
3353
|
# Corresponds to the JSON property `excludedPredefinedFunctions`
|
|
3190
3354
|
# @return [Array<String>]
|
|
3191
3355
|
attr_accessor :excluded_predefined_functions
|
|
@@ -3267,11 +3431,13 @@ module Google
|
|
|
3267
3431
|
end
|
|
3268
3432
|
end
|
|
3269
3433
|
|
|
3270
|
-
# Metadata
|
|
3434
|
+
# Metadata returned when the model uses the `url_context` tool to get
|
|
3435
|
+
# information from a user-provided URL.
|
|
3271
3436
|
class GoogleCloudAiplatformV1beta1UrlContextMetadata
|
|
3272
3437
|
include Google::Apis::Core::Hashable
|
|
3273
3438
|
|
|
3274
|
-
# Output only.
|
|
3439
|
+
# Output only. A list of URL metadata, with one entry for each URL retrieved by
|
|
3440
|
+
# the tool.
|
|
3275
3441
|
# Corresponds to the JSON property `urlMetadata`
|
|
3276
3442
|
# @return [Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1UrlMetadata>]
|
|
3277
3443
|
attr_accessor :url_metadata
|
|
@@ -3286,16 +3452,16 @@ module Google
|
|
|
3286
3452
|
end
|
|
3287
3453
|
end
|
|
3288
3454
|
|
|
3289
|
-
#
|
|
3455
|
+
# The metadata for a single URL retrieval.
|
|
3290
3456
|
class GoogleCloudAiplatformV1beta1UrlMetadata
|
|
3291
3457
|
include Google::Apis::Core::Hashable
|
|
3292
3458
|
|
|
3293
|
-
#
|
|
3459
|
+
# The URL retrieved by the tool.
|
|
3294
3460
|
# Corresponds to the JSON property `retrievedUrl`
|
|
3295
3461
|
# @return [String]
|
|
3296
3462
|
attr_accessor :retrieved_url
|
|
3297
3463
|
|
|
3298
|
-
#
|
|
3464
|
+
# The status of the URL retrieval.
|
|
3299
3465
|
# Corresponds to the JSON property `urlRetrievalStatus`
|
|
3300
3466
|
# @return [String]
|
|
3301
3467
|
attr_accessor :url_retrieval_status
|
|
@@ -3477,7 +3643,8 @@ module Google
|
|
|
3477
3643
|
end
|
|
3478
3644
|
end
|
|
3479
3645
|
|
|
3480
|
-
#
|
|
3646
|
+
# Provides metadata for a video, including the start and end offsets for
|
|
3647
|
+
# clipping and the frame rate.
|
|
3481
3648
|
class GoogleCloudAiplatformV1beta1VideoMetadata
|
|
3482
3649
|
include Google::Apis::Core::Hashable
|
|
3483
3650
|
|
|
@@ -3487,7 +3654,7 @@ module Google
|
|
|
3487
3654
|
attr_accessor :end_offset
|
|
3488
3655
|
|
|
3489
3656
|
# Optional. The frame rate of the video sent to the model. If not specified, the
|
|
3490
|
-
# default value
|
|
3657
|
+
# default value is 1.0. The valid range is (0.0, 24.0].
|
|
3491
3658
|
# Corresponds to the JSON property `fps`
|
|
3492
3659
|
# @return [Float]
|
|
3493
3660
|
attr_accessor :fps
|
|
@@ -3509,11 +3676,11 @@ module Google
|
|
|
3509
3676
|
end
|
|
3510
3677
|
end
|
|
3511
3678
|
|
|
3512
|
-
#
|
|
3679
|
+
# Configuration for a voice.
|
|
3513
3680
|
class GoogleCloudAiplatformV1beta1VoiceConfig
|
|
3514
3681
|
include Google::Apis::Core::Hashable
|
|
3515
3682
|
|
|
3516
|
-
#
|
|
3683
|
+
# Configuration for a prebuilt voice.
|
|
3517
3684
|
# Corresponds to the JSON property `prebuiltVoiceConfig`
|
|
3518
3685
|
# @return [Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig]
|
|
3519
3686
|
attr_accessor :prebuilt_voice_config
|