Skip to content

docs: Regenerate docs for 1.57.0 #1925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Jan 7, 2026
+1,161 −668
Merged

docs: Regenerate docs for 1.57.0 #1925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,715 changes: 1,072 additions & 643 deletions docs/genai.html
View file
Open in desktop

Large diffs are not rendered by default.

52 changes: 38 additions & 14 deletions docs/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2508,6 +2508,10 @@ <h2>F</h2>
<li><a href="genai.html#genai.types.ListFilesResponse.files">(genai.types.ListFilesResponse attribute)</a>
</li>
<li><a href="genai.html#genai.types.ListFilesResponseDict.files">(genai.types.ListFilesResponseDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesResponse.files">(genai.types.RegisterFilesResponse attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesResponseDict.files">(genai.types.RegisterFilesResponseDict attribute)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.types.FileSearchDict">FileSearchDict (class in genai.types)</a>
Expand Down Expand Up @@ -2580,14 +2584,14 @@ <h2>F</h2>
</ul></li>
<li><a href="genai.html#genai.types.FinishReason">FinishReason (class in genai.types)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="genai.html#genai.types.RagChunkPageSpan.first_page">first_page (genai.types.RagChunkPageSpan attribute)</a>

<ul>
<li><a href="genai.html#genai.types.RagChunkPageSpanDict.first_page">(genai.types.RagChunkPageSpanDict attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="genai.html#genai.types.GroundingChunkMapsPlaceAnswerSources.flag_content_uri">flag_content_uri (genai.types.GroundingChunkMapsPlaceAnswerSources attribute)</a>

<ul>
Expand Down Expand Up @@ -3452,6 +3456,10 @@ <h2>H</h2>
<li><a href="genai.html#genai.types.RecontextImageConfig.http_options">(genai.types.RecontextImageConfig attribute)</a>
</li>
<li><a href="genai.html#genai.types.RecontextImageConfigDict.http_options">(genai.types.RecontextImageConfigDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesConfig.http_options">(genai.types.RegisterFilesConfig attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesConfigDict.http_options">(genai.types.RegisterFilesConfigDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.SegmentImageConfig.http_options">(genai.types.SegmentImageConfig attribute)</a>
</li>
Expand Down Expand Up @@ -4699,8 +4707,6 @@ <h2>M</h2>
</li>
</ul></li>
<li><a href="genai.html#genai.types.ModalityTokenCountDict">ModalityTokenCountDict (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.types.Mode">Mode (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.types.DynamicRetrievalConfig.mode">mode (genai.types.DynamicRetrievalConfig attribute)</a>

Expand All @@ -4717,17 +4723,11 @@ <h2>M</h2>
</li>
</ul></li>
<li><a href="genai.html#genai.types.DynamicRetrievalConfigMode.MODE_DYNAMIC">MODE_DYNAMIC (genai.types.DynamicRetrievalConfigMode attribute)</a>

<ul>
<li><a href="genai.html#genai.types.Mode.MODE_DYNAMIC">(genai.types.Mode attribute)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.types.DynamicRetrievalConfigMode.MODE_UNSPECIFIED">MODE_UNSPECIFIED (genai.types.DynamicRetrievalConfigMode attribute)</a>

<ul>
<li><a href="genai.html#genai.types.FunctionCallingConfigMode.MODE_UNSPECIFIED">(genai.types.FunctionCallingConfigMode attribute)</a>
</li>
<li><a href="genai.html#genai.types.Mode.MODE_UNSPECIFIED">(genai.types.Mode attribute)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.types.BatchJob.model">model (genai.types.BatchJob attribute)</a>
Expand Down Expand Up @@ -5563,6 +5563,10 @@ <h2>P</h2>
<li><a href="genai.html#genai.types.GenerateVideosConfig.person_generation">(genai.types.GenerateVideosConfig attribute)</a>
</li>
<li><a href="genai.html#genai.types.GenerateVideosConfigDict.person_generation">(genai.types.GenerateVideosConfigDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.ImageConfig.person_generation">(genai.types.ImageConfig attribute)</a>
</li>
<li><a href="genai.html#genai.types.ImageConfigDict.person_generation">(genai.types.ImageConfigDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.RecontextImageConfig.person_generation">(genai.types.RecontextImageConfig attribute)</a>
</li>
Expand All @@ -5580,11 +5584,11 @@ <h2>P</h2>
</li>
</ul></li>
<li><a href="genai.html#genai.types.PersonGeneration">PersonGeneration (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.types.PhishBlockThreshold.PHISH_BLOCK_THRESHOLD_UNSPECIFIED">PHISH_BLOCK_THRESHOLD_UNSPECIFIED (genai.types.PhishBlockThreshold attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="genai.html#genai.types.PhishBlockThreshold.PHISH_BLOCK_THRESHOLD_UNSPECIFIED">PHISH_BLOCK_THRESHOLD_UNSPECIFIED (genai.types.PhishBlockThreshold attribute)</a>
</li>
<li><a href="genai.html#genai.types.PhishBlockThreshold">PhishBlockThreshold (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.types.GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution.photo_uri">photo_uri (genai.types.GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution attribute)</a>
Expand Down Expand Up @@ -6065,6 +6069,18 @@ <h2>R</h2>
<li><a href="genai.html#genai.types.VideoGenerationReferenceImageDict.reference_type">(genai.types.VideoGenerationReferenceImageDict attribute)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.files.AsyncFiles.register_files">register_files() (genai.files.AsyncFiles method)</a>

<ul>
<li><a href="genai.html#genai.files.Files.register_files">(genai.files.Files method)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.types.FileSource.REGISTERED">REGISTERED (genai.types.FileSource attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesConfigDict">RegisterFilesConfigDict (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesResponseDict">RegisterFilesResponseDict (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.types.GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.relative_publish_time_description">relative_publish_time_description (genai.types.GroundingChunkMapsPlaceAnswerSourcesReviewSnippet attribute)</a>

<ul>
Expand Down Expand Up @@ -6097,6 +6113,8 @@ <h2>R</h2>
</li>
<li><a href="genai.html#genai.types.ReplayResponseDict">ReplayResponseDict (class in genai.types)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="genai.html#genai.client.DebugConfig.replays_directory">replays_directory (genai.client.DebugConfig attribute)</a>
</li>
<li><a href="genai.html#genai.types.VoiceConfig.replicated_voice_config">replicated_voice_config (genai.types.VoiceConfig attribute)</a>
Expand All @@ -6105,8 +6123,6 @@ <h2>R</h2>
<li><a href="genai.html#genai.types.VoiceConfigDict.replicated_voice_config">(genai.types.VoiceConfigDict attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="genai.html#genai.types.ReplicatedVoiceConfigDict">ReplicatedVoiceConfigDict (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.types.ReplayInteraction.request">request (genai.types.ReplayInteraction attribute)</a>
Expand Down Expand Up @@ -6581,6 +6597,10 @@ <h2>S</h2>
<li><a href="genai.html#genai.types.ListTuningJobsResponse.sdk_http_response">(genai.types.ListTuningJobsResponse attribute)</a>
</li>
<li><a href="genai.html#genai.types.ListTuningJobsResponseDict.sdk_http_response">(genai.types.ListTuningJobsResponseDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesResponse.sdk_http_response">(genai.types.RegisterFilesResponse attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesResponseDict.sdk_http_response">(genai.types.RegisterFilesResponseDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.TuningJob.sdk_http_response">(genai.types.TuningJob attribute)</a>
</li>
Expand Down Expand Up @@ -6809,6 +6829,10 @@ <h2>S</h2>
<li><a href="genai.html#genai.types.GenerateContentConfig.should_return_http_response">(genai.types.GenerateContentConfig attribute)</a>
</li>
<li><a href="genai.html#genai.types.GenerateContentConfigDict.should_return_http_response">(genai.types.GenerateContentConfigDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesConfig.should_return_http_response">(genai.types.RegisterFilesConfig attribute)</a>
</li>
<li><a href="genai.html#genai.types.RegisterFilesConfigDict.should_return_http_response">(genai.types.RegisterFilesConfigDict attribute)</a>
</li>
<li><a href="genai.html#genai.types.UploadToFileSearchStoreConfig.should_return_http_response">(genai.types.UploadToFileSearchStoreConfig attribute)</a>
</li>
Expand Down
30 changes: 25 additions & 5 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2134,6 +2134,7 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.AsyncFiles.download"><code class="docutils literal notranslate"><span class="pre">AsyncFiles.download()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.AsyncFiles.get"><code class="docutils literal notranslate"><span class="pre">AsyncFiles.get()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.AsyncFiles.list"><code class="docutils literal notranslate"><span class="pre">AsyncFiles.list()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.AsyncFiles.register_files"><code class="docutils literal notranslate"><span class="pre">AsyncFiles.register_files()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.AsyncFiles.upload"><code class="docutils literal notranslate"><span class="pre">AsyncFiles.upload()</span></code></a></li>
</ul>
</li>
Expand All @@ -2142,6 +2143,7 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.Files.download"><code class="docutils literal notranslate"><span class="pre">Files.download()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.Files.get"><code class="docutils literal notranslate"><span class="pre">Files.get()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.Files.list"><code class="docutils literal notranslate"><span class="pre">Files.list()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.Files.register_files"><code class="docutils literal notranslate"><span class="pre">Files.register_files()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.files.Files.upload"><code class="docutils literal notranslate"><span class="pre">Files.upload()</span></code></a></li>
</ul>
</li>
Expand Down Expand Up @@ -3530,6 +3532,7 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.FileSource"><code class="docutils literal notranslate"><span class="pre">FileSource</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.FileSource.GENERATED"><code class="docutils literal notranslate"><span class="pre">FileSource.GENERATED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.FileSource.REGISTERED"><code class="docutils literal notranslate"><span class="pre">FileSource.REGISTERED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.FileSource.SOURCE_UNSPECIFIED"><code class="docutils literal notranslate"><span class="pre">FileSource.SOURCE_UNSPECIFIED</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.FileSource.UPLOADED"><code class="docutils literal notranslate"><span class="pre">FileSource.UPLOADED</span></code></a></li>
</ul>
Expand Down Expand Up @@ -4483,13 +4486,15 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfig.image_size"><code class="docutils literal notranslate"><span class="pre">ImageConfig.image_size</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfig.output_compression_quality"><code class="docutils literal notranslate"><span class="pre">ImageConfig.output_compression_quality</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfig.output_mime_type"><code class="docutils literal notranslate"><span class="pre">ImageConfig.output_mime_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfig.person_generation"><code class="docutils literal notranslate"><span class="pre">ImageConfig.person_generation</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.ImageConfigDict"><code class="docutils literal notranslate"><span class="pre">ImageConfigDict</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfigDict.aspect_ratio"><code class="docutils literal notranslate"><span class="pre">ImageConfigDict.aspect_ratio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfigDict.image_size"><code class="docutils literal notranslate"><span class="pre">ImageConfigDict.image_size</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfigDict.output_compression_quality"><code class="docutils literal notranslate"><span class="pre">ImageConfigDict.output_compression_quality</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfigDict.output_mime_type"><code class="docutils literal notranslate"><span class="pre">ImageConfigDict.output_mime_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ImageConfigDict.person_generation"><code class="docutils literal notranslate"><span class="pre">ImageConfigDict.person_generation</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.ImageDict"><code class="docutils literal notranslate"><span class="pre">ImageDict</span></code></a><ul>
Expand Down Expand Up @@ -5351,11 +5356,6 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ModalityTokenCountDict.token_count"><code class="docutils literal notranslate"><span class="pre">ModalityTokenCountDict.token_count</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.Mode"><code class="docutils literal notranslate"><span class="pre">Mode</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.Mode.MODE_DYNAMIC"><code class="docutils literal notranslate"><span class="pre">Mode.MODE_DYNAMIC</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.Mode.MODE_UNSPECIFIED"><code class="docutils literal notranslate"><span class="pre">Mode.MODE_UNSPECIFIED</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.Model"><code class="docutils literal notranslate"><span class="pre">Model</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.Model.checkpoints"><code class="docutils literal notranslate"><span class="pre">Model.checkpoints</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.Model.default_checkpoint_id"><code class="docutils literal notranslate"><span class="pre">Model.default_checkpoint_id</span></code></a></li>
Expand Down Expand Up @@ -5829,6 +5829,26 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RecontextImageSourceDict.prompt"><code class="docutils literal notranslate"><span class="pre">RecontextImageSourceDict.prompt</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.RegisterFilesConfig"><code class="docutils literal notranslate"><span class="pre">RegisterFilesConfig</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RegisterFilesConfig.http_options"><code class="docutils literal notranslate"><span class="pre">RegisterFilesConfig.http_options</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RegisterFilesConfig.should_return_http_response"><code class="docutils literal notranslate"><span class="pre">RegisterFilesConfig.should_return_http_response</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.RegisterFilesConfigDict"><code class="docutils literal notranslate"><span class="pre">RegisterFilesConfigDict</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RegisterFilesConfigDict.http_options"><code class="docutils literal notranslate"><span class="pre">RegisterFilesConfigDict.http_options</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RegisterFilesConfigDict.should_return_http_response"><code class="docutils literal notranslate"><span class="pre">RegisterFilesConfigDict.should_return_http_response</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.RegisterFilesResponse"><code class="docutils literal notranslate"><span class="pre">RegisterFilesResponse</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RegisterFilesResponse.files"><code class="docutils literal notranslate"><span class="pre">RegisterFilesResponse.files</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RegisterFilesResponse.sdk_http_response"><code class="docutils literal notranslate"><span class="pre">RegisterFilesResponse.sdk_http_response</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.RegisterFilesResponseDict"><code class="docutils literal notranslate"><span class="pre">RegisterFilesResponseDict</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RegisterFilesResponseDict.files"><code class="docutils literal notranslate"><span class="pre">RegisterFilesResponseDict.files</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.RegisterFilesResponseDict.sdk_http_response"><code class="docutils literal notranslate"><span class="pre">RegisterFilesResponseDict.sdk_http_response</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.types.ReplayFile"><code class="docutils literal notranslate"><span class="pre">ReplayFile</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ReplayFile.interactions"><code class="docutils literal notranslate"><span class="pre">ReplayFile.interactions</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.types.ReplayFile.replay_id"><code class="docutils literal notranslate"><span class="pre">ReplayFile.replay_id</span></code></a></li>
Expand Down
Loading