Skip to content

Commit 68ed088

Browse files
speedstorm1copybara-github
speedstorm1
authored and
copybara-github
committed
docs: Update python docs for 1.72.0
PiperOrigin-RevId: 897747257
1 parent 9742f2c commit 68ed088

6 files changed

Lines changed: 1567 additions & 29 deletions

File tree

‎docs/genai.html‎

Lines changed: 1312 additions & 18 deletions
Large diffs are not rendered by default.

‎docs/genindex.html‎

Lines changed: 132 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -510,8 +510,6 @@ <h2>A</h2>
510510
<li><a href="genai.html#genai.types.HttpOptionsDict.api_version">(genai.types.HttpOptionsDict attribute)</a>
511511
</li>
512512
</ul></li>
513-
</ul></td>
514-
<td style="width: 33%; vertical-align: top;"><ul>
515513
<li><a href="genai.html#genai.types.ApiAuthApiKeyConfigDict">ApiAuthApiKeyConfigDict (class in genai.types)</a>
516514
</li>
517515
<li><a href="genai.html#genai.types.ApiAuthDict">ApiAuthDict (class in genai.types)</a>
@@ -520,6 +518,8 @@ <h2>A</h2>
520518
</li>
521519
<li><a href="genai.html#genai.types.ApiSpec">ApiSpec (class in genai.types)</a>
522520
</li>
521+
</ul></td>
522+
<td style="width: 33%; vertical-align: top;"><ul>
523523
<li><a href="genai.html#genai.types.FunctionCall.args">args (genai.types.FunctionCall attribute)</a>
524524

525525
<ul>
@@ -618,6 +618,12 @@ <h2>A</h2>
618618

619619
<ul>
620620
<li><a href="genai.html#genai.types.Modality.AUDIO">(genai.types.Modality attribute)</a>
621+
</li>
622+
</ul></li>
623+
<li><a href="genai.html#genai.types.AvatarConfig.audio_bitrate_bps">audio_bitrate_bps (genai.types.AvatarConfig attribute)</a>
624+
625+
<ul>
626+
<li><a href="genai.html#genai.types.AvatarConfigDict.audio_bitrate_bps">(genai.types.AvatarConfigDict attribute)</a>
621627
</li>
622628
</ul></li>
623629
<li><a href="genai.html#genai.types.LiveMusicServerContent.audio_chunks">audio_chunks (genai.types.LiveMusicServerContent attribute)</a>
@@ -650,6 +656,12 @@ <h2>A</h2>
650656
<li><a href="genai.html#genai.types.GenerationConfig.audio_timestamp">(genai.types.GenerationConfig attribute)</a>
651657
</li>
652658
<li><a href="genai.html#genai.types.GenerationConfigDict.audio_timestamp">(genai.types.GenerationConfigDict attribute)</a>
659+
</li>
660+
</ul></li>
661+
<li><a href="genai.html#genai.types.EmbedContentConfig.audio_track_extraction">audio_track_extraction (genai.types.EmbedContentConfig attribute)</a>
662+
663+
<ul>
664+
<li><a href="genai.html#genai.types.EmbedContentConfigDict.audio_track_extraction">(genai.types.EmbedContentConfigDict attribute)</a>
653665
</li>
654666
</ul></li>
655667
<li><a href="genai.html#genai.types.AudioChunkDict">AudioChunkDict (class in genai.types)</a>
@@ -747,6 +759,24 @@ <h2>A</h2>
747759
</li>
748760
</ul></li>
749761
<li><a href="genai.html#genai.types.AutoraterConfigDict">AutoraterConfigDict (class in genai.types)</a>
762+
</li>
763+
<li><a href="genai.html#genai.types.LiveClientSetup.avatar_config">avatar_config (genai.types.LiveClientSetup attribute)</a>
764+
765+
<ul>
766+
<li><a href="genai.html#genai.types.LiveClientSetupDict.avatar_config">(genai.types.LiveClientSetupDict attribute)</a>
767+
</li>
768+
<li><a href="genai.html#genai.types.LiveConnectConfig.avatar_config">(genai.types.LiveConnectConfig attribute)</a>
769+
</li>
770+
<li><a href="genai.html#genai.types.LiveConnectConfigDict.avatar_config">(genai.types.LiveConnectConfigDict attribute)</a>
771+
</li>
772+
</ul></li>
773+
<li><a href="genai.html#genai.types.AvatarConfig.avatar_name">avatar_name (genai.types.AvatarConfig attribute)</a>
774+
775+
<ul>
776+
<li><a href="genai.html#genai.types.AvatarConfigDict.avatar_name">(genai.types.AvatarConfigDict attribute)</a>
777+
</li>
778+
</ul></li>
779+
<li><a href="genai.html#genai.types.AvatarConfigDict">AvatarConfigDict (class in genai.types)</a>
750780
</li>
751781
<li><a href="genai.html#genai.types.AggregationMetric.AVERAGE">AVERAGE (genai.types.AggregationMetric attribute)</a>
752782
</li>
@@ -910,14 +940,14 @@ <h2>B</h2>
910940
<li><a href="genai.html#genai.types.EmbedContentMetadataDict.billable_character_count">(genai.types.EmbedContentMetadataDict attribute)</a>
911941
</li>
912942
</ul></li>
913-
</ul></td>
914-
<td style="width: 33%; vertical-align: top;"><ul>
915943
<li><a href="genai.html#genai.types.SupervisedTuningDatasetDistribution.billable_sum">billable_sum (genai.types.SupervisedTuningDatasetDistribution attribute)</a>
916944

917945
<ul>
918946
<li><a href="genai.html#genai.types.SupervisedTuningDatasetDistributionDict.billable_sum">(genai.types.SupervisedTuningDatasetDistributionDict attribute)</a>
919947
</li>
920948
</ul></li>
949+
</ul></td>
950+
<td style="width: 33%; vertical-align: top;"><ul>
921951
<li><a href="genai.html#genai.types.SegmentImageConfig.binary_color_threshold">binary_color_threshold (genai.types.SegmentImageConfig attribute)</a>
922952

923953
<ul>
@@ -1020,6 +1050,8 @@ <h2>B</h2>
10201050

10211051
<ul>
10221052
<li><a href="genai.html#genai.types.FinishReason.BLOCKLIST">(genai.types.FinishReason attribute)</a>
1053+
</li>
1054+
<li><a href="genai.html#genai.types.TurnCompleteReason.BLOCKLIST">(genai.types.TurnCompleteReason attribute)</a>
10231055
</li>
10241056
</ul></li>
10251057
<li><a href="genai.html#genai.types.HttpResponse.body">body (genai.types.HttpResponse attribute)</a>
@@ -1767,6 +1799,14 @@ <h2>C</h2>
17671799
<li><a href="genai.html#genai.types.CustomCodeExecutionResultDict">CustomCodeExecutionResultDict (class in genai.types)</a>
17681800
</li>
17691801
<li><a href="genai.html#genai.types.CustomCodeExecutionSpecDict">CustomCodeExecutionSpecDict (class in genai.types)</a>
1802+
</li>
1803+
<li><a href="genai.html#genai.types.AvatarConfig.customized_avatar">customized_avatar (genai.types.AvatarConfig attribute)</a>
1804+
1805+
<ul>
1806+
<li><a href="genai.html#genai.types.AvatarConfigDict.customized_avatar">(genai.types.AvatarConfigDict attribute)</a>
1807+
</li>
1808+
</ul></li>
1809+
<li><a href="genai.html#genai.types.CustomizedAvatarDict">CustomizedAvatarDict (class in genai.types)</a>
17701810
</li>
17711811
<li><a href="genai.html#genai.types.CustomMetadataDict">CustomMetadataDict (class in genai.types)</a>
17721812
</li>
@@ -2122,6 +2162,12 @@ <h2>D</h2>
21222162
<li><a href="genai.html#genai.types.UploadToFileSearchStoreResponse.document_name">(genai.types.UploadToFileSearchStoreResponse attribute)</a>
21232163
</li>
21242164
<li><a href="genai.html#genai.types.UploadToFileSearchStoreResponseDict.document_name">(genai.types.UploadToFileSearchStoreResponseDict attribute)</a>
2165+
</li>
2166+
</ul></li>
2167+
<li><a href="genai.html#genai.types.EmbedContentConfig.document_ocr">document_ocr (genai.types.EmbedContentConfig attribute)</a>
2168+
2169+
<ul>
2170+
<li><a href="genai.html#genai.types.EmbedContentConfigDict.document_ocr">(genai.types.EmbedContentConfigDict attribute)</a>
21252171
</li>
21262172
</ul></li>
21272173
<li><a href="genai.html#genai.types.DocumentDict">DocumentDict (class in genai.types)</a>
@@ -3335,6 +3381,26 @@ <h2>G</h2>
33353381
<li><a href="genai.html#genai.types.GenerateContentResponseUsageMetadataDict">GenerateContentResponseUsageMetadataDict (class in genai.types)</a>
33363382
</li>
33373383
<li><a href="genai.html#genai.types.FileSource.GENERATED">GENERATED (genai.types.FileSource attribute)</a>
3384+
</li>
3385+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_AUDIO_SAFETY">GENERATED_AUDIO_SAFETY (genai.types.TurnCompleteReason attribute)</a>
3386+
</li>
3387+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_CONTENT_BLOCKLIST">GENERATED_CONTENT_BLOCKLIST (genai.types.TurnCompleteReason attribute)</a>
3388+
</li>
3389+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_CONTENT_PROHIBITED">GENERATED_CONTENT_PROHIBITED (genai.types.TurnCompleteReason attribute)</a>
3390+
</li>
3391+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_CONTENT_SAFETY">GENERATED_CONTENT_SAFETY (genai.types.TurnCompleteReason attribute)</a>
3392+
</li>
3393+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_IMAGE_CELEBRITY">GENERATED_IMAGE_CELEBRITY (genai.types.TurnCompleteReason attribute)</a>
3394+
</li>
3395+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_IMAGE_IDENTIFIABLE_PEOPLE">GENERATED_IMAGE_IDENTIFIABLE_PEOPLE (genai.types.TurnCompleteReason attribute)</a>
3396+
</li>
3397+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_IMAGE_MINORS">GENERATED_IMAGE_MINORS (genai.types.TurnCompleteReason attribute)</a>
3398+
</li>
3399+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_IMAGE_PROHIBITED">GENERATED_IMAGE_PROHIBITED (genai.types.TurnCompleteReason attribute)</a>
3400+
</li>
3401+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER">GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER (genai.types.TurnCompleteReason attribute)</a>
3402+
</li>
3403+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_IMAGE_SAFETY">GENERATED_IMAGE_SAFETY (genai.types.TurnCompleteReason attribute)</a>
33383404
</li>
33393405
<li><a href="genai.html#genai.types.EditImageResponse.generated_images">generated_images (genai.types.EditImageResponse attribute)</a>
33403406

@@ -3360,6 +3426,10 @@ <h2>G</h2>
33603426
<li><a href="genai.html#genai.types.SegmentImageResponseDict.generated_masks">(genai.types.SegmentImageResponseDict attribute)</a>
33613427
</li>
33623428
</ul></li>
3429+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_OTHER">GENERATED_OTHER (genai.types.TurnCompleteReason attribute)</a>
3430+
</li>
3431+
<li><a href="genai.html#genai.types.TurnCompleteReason.GENERATED_VIDEO_SAFETY">GENERATED_VIDEO_SAFETY (genai.types.TurnCompleteReason attribute)</a>
3432+
</li>
33633433
<li><a href="genai.html#genai.types.GenerateVideosResponse.generated_videos">generated_videos (genai.types.GenerateVideosResponse attribute)</a>
33643434

33653435
<ul>
@@ -3388,6 +3458,8 @@ <h2>G</h2>
33883458
<li><a href="genai.html#genai.types.LiveServerContentDict.generation_complete">(genai.types.LiveServerContentDict attribute)</a>
33893459
</li>
33903460
</ul></li>
3461+
</ul></td>
3462+
<td style="width: 33%; vertical-align: top;"><ul>
33913463
<li><a href="genai.html#genai.types.AutoraterConfig.generation_config">generation_config (genai.types.AutoraterConfig attribute)</a>
33923464

33933465
<ul>
@@ -3406,8 +3478,6 @@ <h2>G</h2>
34063478
<li><a href="genai.html#genai.types.LiveConnectConfigDict.generation_config">(genai.types.LiveConnectConfigDict attribute)</a>
34073479
</li>
34083480
</ul></li>
3409-
</ul></td>
3410-
<td style="width: 33%; vertical-align: top;"><ul>
34113481
<li><a href="genai.html#genai.types.GenerationConfigDict">GenerationConfigDict (class in genai.types)</a>
34123482
</li>
34133483
<li><a href="genai.html#genai.types.GenerationConfigRoutingConfigAutoRoutingModeDict">GenerationConfigRoutingConfigAutoRoutingModeDict (class in genai.types)</a>
@@ -4124,6 +4194,18 @@ <h2>I</h2>
41244194

41254195
<ul>
41264196
<li><a href="genai.html#genai.types.CachedContentUsageMetadataDict.image_count">(genai.types.CachedContentUsageMetadataDict attribute)</a>
4197+
</li>
4198+
</ul></li>
4199+
<li><a href="genai.html#genai.types.CustomizedAvatar.image_data">image_data (genai.types.CustomizedAvatar attribute)</a>
4200+
4201+
<ul>
4202+
<li><a href="genai.html#genai.types.CustomizedAvatarDict.image_data">(genai.types.CustomizedAvatarDict attribute)</a>
4203+
</li>
4204+
</ul></li>
4205+
<li><a href="genai.html#genai.types.CustomizedAvatar.image_mime_type">image_mime_type (genai.types.CustomizedAvatar attribute)</a>
4206+
4207+
<ul>
4208+
<li><a href="genai.html#genai.types.CustomizedAvatarDict.image_mime_type">(genai.types.CustomizedAvatarDict attribute)</a>
41274209
</li>
41284210
</ul></li>
41294211
<li><a href="genai.html#genai.types.FinishReason.IMAGE_OTHER">IMAGE_OTHER (genai.types.FinishReason attribute)</a>
@@ -4141,6 +4223,8 @@ <h2>I</h2>
41414223
</li>
41424224
</ul></li>
41434225
<li><a href="genai.html#genai.types.FinishReason.IMAGE_PROHIBITED_CONTENT">IMAGE_PROHIBITED_CONTENT (genai.types.FinishReason attribute)</a>
4226+
</li>
4227+
<li><a href="genai.html#genai.types.TurnCompleteReason.IMAGE_PROHIBITED_INPUT_CONTENT">IMAGE_PROHIBITED_INPUT_CONTENT (genai.types.TurnCompleteReason attribute)</a>
41444228
</li>
41454229
<li><a href="genai.html#genai.types.FinishReason.IMAGE_RECITATION">IMAGE_RECITATION (genai.types.FinishReason attribute)</a>
41464230
</li>
@@ -4322,6 +4406,18 @@ <h2>I</h2>
43224406
<li><a href="genai.html#genai.types.LiveConnectConfigDict.input_audio_transcription">(genai.types.LiveConnectConfigDict attribute)</a>
43234407
</li>
43244408
</ul></li>
4409+
<li><a href="genai.html#genai.types.TurnCompleteReason.INPUT_IMAGE_CELEBRITY">INPUT_IMAGE_CELEBRITY (genai.types.TurnCompleteReason attribute)</a>
4410+
</li>
4411+
<li><a href="genai.html#genai.types.TurnCompleteReason.INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED">INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED (genai.types.TurnCompleteReason attribute)</a>
4412+
</li>
4413+
<li><a href="genai.html#genai.types.TurnCompleteReason.INPUT_IP_PROHIBITED">INPUT_IP_PROHIBITED (genai.types.TurnCompleteReason attribute)</a>
4414+
</li>
4415+
<li><a href="genai.html#genai.types.TurnCompleteReason.INPUT_OTHER">INPUT_OTHER (genai.types.TurnCompleteReason attribute)</a>
4416+
</li>
4417+
<li><a href="genai.html#genai.types.TurnCompleteReason.INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED">INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED (genai.types.TurnCompleteReason attribute)</a>
4418+
</li>
4419+
<li><a href="genai.html#genai.types.TurnCompleteReason.INPUT_TEXT_NCII_PROHIBITED">INPUT_TEXT_NCII_PROHIBITED (genai.types.TurnCompleteReason attribute)</a>
4420+
</li>
43254421
<li><a href="genai.html#genai.types.Model.input_token_limit">input_token_limit (genai.types.Model attribute)</a>
43264422

43274423
<ul>
@@ -5008,6 +5104,8 @@ <h2>M</h2>
50085104
<li><a href="genai.html#genai.types.SchemaDict.max_properties">(genai.types.SchemaDict attribute)</a>
50095105
</li>
50105106
</ul></li>
5107+
<li><a href="genai.html#genai.types.TurnCompleteReason.MAX_REGENERATION_REACHED">MAX_REGENERATION_REACHED (genai.types.TurnCompleteReason attribute)</a>
5108+
</li>
50115109
<li><a href="genai.html#genai.types.VertexAISearch.max_results">max_results (genai.types.VertexAISearch attribute)</a>
50125110

50135111
<ul>
@@ -6009,6 +6107,8 @@ <h2>O</h2>
60096107
<li><a href="genai.html#genai.types.UpscaleImageConfigDict.output_gcs_uri">(genai.types.UpscaleImageConfigDict attribute)</a>
60106108
</li>
60116109
</ul></li>
6110+
<li><a href="genai.html#genai.types.TurnCompleteReason.OUTPUT_IMAGE_IP_PROHIBITED">OUTPUT_IMAGE_IP_PROHIBITED (genai.types.TurnCompleteReason attribute)</a>
6111+
</li>
60126112
<li><a href="genai.html#genai.types.EvaluateDatasetResponse.output_info">output_info (genai.types.EvaluateDatasetResponse attribute)</a>
60136113

60146114
<ul>
@@ -6555,6 +6655,8 @@ <h2>P</h2>
65556655
<li><a href="genai.html#genai.types.FinishReason.PROHIBITED_CONTENT">(genai.types.FinishReason attribute)</a>
65566656
</li>
65576657
</ul></li>
6658+
<li><a href="genai.html#genai.types.TurnCompleteReason.PROHIBITED_INPUT_CONTENT">PROHIBITED_INPUT_CONTENT (genai.types.TurnCompleteReason attribute)</a>
6659+
</li>
65586660
<li><a href="genai.html#genai.client.Client.project">project (genai.client.Client attribute)</a>
65596661
</li>
65606662
<li><a href="genai.html#genai.types.ProjectOperationDict">ProjectOperationDict (class in genai.types)</a>
@@ -7365,6 +7467,14 @@ <h2>S</h2>
73657467

73667468
<ul>
73677469
<li><a href="genai.html#genai.types.GenerateContentConfigDict.safety_settings">(genai.types.GenerateContentConfigDict attribute)</a>
7470+
</li>
7471+
<li><a href="genai.html#genai.types.LiveClientSetup.safety_settings">(genai.types.LiveClientSetup attribute)</a>
7472+
</li>
7473+
<li><a href="genai.html#genai.types.LiveClientSetupDict.safety_settings">(genai.types.LiveClientSetupDict attribute)</a>
7474+
</li>
7475+
<li><a href="genai.html#genai.types.LiveConnectConfig.safety_settings">(genai.types.LiveConnectConfig attribute)</a>
7476+
</li>
7477+
<li><a href="genai.html#genai.types.LiveConnectConfigDict.safety_settings">(genai.types.LiveConnectConfigDict attribute)</a>
73687478
</li>
73697479
</ul></li>
73707480
<li><a href="genai.html#genai.types.SafetyAttributesDict">SafetyAttributesDict (class in genai.types)</a>
@@ -7775,14 +7885,14 @@ <h2>S</h2>
77757885
<li><a href="genai.html#genai.types.SafetyRatingDict.severity">(genai.types.SafetyRatingDict attribute)</a>
77767886
</li>
77777887
</ul></li>
7888+
</ul></td>
7889+
<td style="width: 33%; vertical-align: top;"><ul>
77787890
<li><a href="genai.html#genai.types.SafetyRating.severity_score">severity_score (genai.types.SafetyRating attribute)</a>
77797891

77807892
<ul>
77817893
<li><a href="genai.html#genai.types.SafetyRatingDict.severity_score">(genai.types.SafetyRatingDict attribute)</a>
77827894
</li>
77837895
</ul></li>
7784-
</ul></td>
7785-
<td style="width: 33%; vertical-align: top;"><ul>
77867896
<li><a href="genai.html#genai.types.CreateTuningJobConfig.sft_loss_weight_multiplier">sft_loss_weight_multiplier (genai.types.CreateTuningJobConfig attribute)</a>
77877897

77887898
<ul>
@@ -9150,6 +9260,8 @@ <h2>U</h2>
91509260
<li><a href="genai.html#genai.types.UnifiedMetricDict">UnifiedMetricDict (class in genai.types)</a>
91519261
</li>
91529262
<li><a href="genai.html#genai.types.JSONSchema.unique_items">unique_items (genai.types.JSONSchema attribute)</a>
9263+
</li>
9264+
<li><a href="genai.html#genai.types.TurnCompleteReason.UNSAFE_PROMPT_FOR_IMAGE_GENERATION">UNSAFE_PROMPT_FOR_IMAGE_GENERATION (genai.types.TurnCompleteReason attribute)</a>
91539265
</li>
91549266
<li><a href="genai.html#genai.types.Behavior.UNSPECIFIED">UNSPECIFIED (genai.types.Behavior attribute)</a>
91559267

@@ -9563,10 +9675,10 @@ <h2>V</h2>
95639675
<li><a href="genai.html#id0">(genai.client.Client property)</a>
95649676
</li>
95659677
</ul></li>
9566-
</ul></td>
9567-
<td style="width: 33%; vertical-align: top;"><ul>
95689678
<li><a href="genai.html#genai.types.VertexAISearchDataStoreSpecDict">VertexAISearchDataStoreSpecDict (class in genai.types)</a>
95699679
</li>
9680+
</ul></td>
9681+
<td style="width: 33%; vertical-align: top;"><ul>
95709682
<li><a href="genai.html#genai.types.VertexAISearchDict">VertexAISearchDict (class in genai.types)</a>
95719683
</li>
95729684
<li><a href="genai.html#genai.types.VertexRagStoreDict">VertexRagStoreDict (class in genai.types)</a>
@@ -9592,7 +9704,17 @@ <h2>V</h2>
95929704
</li>
95939705
</ul></li>
95949706
<li><a href="genai.html#genai.types.MediaModality.VIDEO">VIDEO (genai.types.MediaModality attribute)</a>
9707+
9708+
<ul>
9709+
<li><a href="genai.html#genai.types.Modality.VIDEO">(genai.types.Modality attribute)</a>
95959710
</li>
9711+
</ul></li>
9712+
<li><a href="genai.html#genai.types.AvatarConfig.video_bitrate_bps">video_bitrate_bps (genai.types.AvatarConfig attribute)</a>
9713+
9714+
<ul>
9715+
<li><a href="genai.html#genai.types.AvatarConfigDict.video_bitrate_bps">(genai.types.AvatarConfigDict attribute)</a>
9716+
</li>
9717+
</ul></li>
95969718
<li><a href="genai.html#genai.types.Video.video_bytes">video_bytes (genai.types.Video attribute)</a>
95979719

95989720
<ul>

0 commit comments

Comments
 (0)