Skip to content

docs: Regenerate docs for 1.58.0 #1960

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 15, 2026
+151 −3
Merged

docs: Regenerate docs for 1.58.0 #1960

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
94 changes: 94 additions & 0 deletions docs/genai.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,53 @@ <h1>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">genai.client.</span></span><span class="sig-name descname"><span class="pre">AsyncGeminiNextGenAPIClientAdapter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.AsyncGeminiNextGenAPIClientAdapter" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncGeminiNextGenAPIClientAdapter</span></code></p>
<p>Adapter for the Gemini NextGen API Client.</p>
<dl class="py method">
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter.async_get_auth_headers">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">async_get_auth_headers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.AsyncGeminiNextGenAPIClientAdapter.async_get_auth_headers" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter.get_location">
<span class="sig-name descname"><span class="pre">get_location</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.AsyncGeminiNextGenAPIClientAdapter.get_location" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter.get_project">
<span class="sig-name descname"><span class="pre">get_project</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.AsyncGeminiNextGenAPIClientAdapter.get_project" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter.is_vertex_ai">
<span class="sig-name descname"><span class="pre">is_vertex_ai</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.AsyncGeminiNextGenAPIClientAdapter.is_vertex_ai" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="genai.client.Client">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">genai.client.</span></span><span class="sig-name descname"><span class="pre">Client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">vertexai</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">credentials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">project</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.Client" title="Link to this definition">¶</a></dt>
Expand Down Expand Up @@ -657,6 +704,53 @@ <h1>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">genai.client.</span></span><span class="sig-name descname"><span class="pre">GeminiNextGenAPIClientAdapter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_client</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.GeminiNextGenAPIClientAdapter" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">GeminiNextGenAPIClientAdapter</span></code></p>
<p>Adapter for the Gemini NextGen API Client.</p>
<dl class="py method">
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter.get_auth_headers">
<span class="sig-name descname"><span class="pre">get_auth_headers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.GeminiNextGenAPIClientAdapter.get_auth_headers" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</span></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter.get_location">
<span class="sig-name descname"><span class="pre">get_location</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.GeminiNextGenAPIClientAdapter.get_location" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter.get_project">
<span class="sig-name descname"><span class="pre">get_project</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.GeminiNextGenAPIClientAdapter.get_project" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter.is_vertex_ai">
<span class="sig-name descname"><span class="pre">is_vertex_ai</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#genai.client.GeminiNextGenAPIClientAdapter.is_vertex_ai" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
<section id="module-genai.batches">
<span id="genai-batches-module"></span><h1>genai.batches module<a class="headerlink" href="#module-genai.batches" title="Link to this heading">¶</a></h1>
Expand Down
30 changes: 28 additions & 2 deletions docs/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,14 +468,14 @@ <h2>A</h2>
<li><a href="genai.html#genai.types.FunctionCallDict.args">(genai.types.FunctionCallDict attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="genai.html#genai.types.JSONSchemaType.ARRAY">ARRAY (genai.types.JSONSchemaType attribute)</a>

<ul>
<li><a href="genai.html#genai.types.Type.ARRAY">(genai.types.Type attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="genai.html#genai.types.Blob.as_image">as_image() (genai.types.Blob method)</a>

<ul>
Expand Down Expand Up @@ -508,6 +508,8 @@ <h2>A</h2>
<li><a href="genai.html#genai.types.HttpOptionsDict.async_client_args">(genai.types.HttpOptionsDict attribute)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.async_get_auth_headers">async_get_auth_headers() (genai.client.AsyncGeminiNextGenAPIClientAdapter method)</a>
</li>
<li><a href="genai.html#genai.batches.AsyncBatches">AsyncBatches (class in genai.batches)</a>
</li>
<li><a href="genai.html#genai.caches.AsyncCaches">AsyncCaches (class in genai.caches)</a>
Expand All @@ -519,6 +521,8 @@ <h2>A</h2>
<li><a href="genai.html#genai.client.AsyncClient">AsyncClient (class in genai.client)</a>
</li>
<li><a href="genai.html#genai.files.AsyncFiles">AsyncFiles (class in genai.files)</a>
</li>
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter">AsyncGeminiNextGenAPIClientAdapter (class in genai.client)</a>
</li>
<li><a href="genai.html#genai.live.AsyncLive">AsyncLive (class in genai.live)</a>
</li>
Expand Down Expand Up @@ -2803,6 +2807,8 @@ <h2>G</h2>
</li>
</ul></li>
<li><a href="genai.html#genai.types.GcsDestinationDict">GcsDestinationDict (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter">GeminiNextGenAPIClientAdapter (class in genai.client)</a>
</li>
<li><a href="genai.html#genai.types.GeminiPreferenceExampleCompletionDict">GeminiPreferenceExampleCompletionDict (class in genai.types)</a>
</li>
Expand Down Expand Up @@ -3020,6 +3026,20 @@ <h2>G</h2>
<li><a href="genai.html#genai.tunings.AsyncTunings.get">(genai.tunings.AsyncTunings method)</a>
</li>
<li><a href="genai.html#genai.tunings.Tunings.get">(genai.tunings.Tunings method)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_auth_headers">get_auth_headers() (genai.client.GeminiNextGenAPIClientAdapter method)</a>
</li>
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.get_location">get_location() (genai.client.AsyncGeminiNextGenAPIClientAdapter method)</a>

<ul>
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_location">(genai.client.GeminiNextGenAPIClientAdapter method)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.get_project">get_project() (genai.client.AsyncGeminiNextGenAPIClientAdapter method)</a>

<ul>
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_project">(genai.client.GeminiNextGenAPIClientAdapter method)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.types.GetBatchJobConfigDict">GetBatchJobConfigDict (class in genai.types)</a>
Expand Down Expand Up @@ -3814,6 +3834,12 @@ <h2>I</h2>
</ul></li>
<li><a href="genai.html#genai.types.IntervalDict">IntervalDict (class in genai.types)</a>
</li>
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.is_vertex_ai">is_vertex_ai() (genai.client.AsyncGeminiNextGenAPIClientAdapter method)</a>

<ul>
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.is_vertex_ai">(genai.client.GeminiNextGenAPIClientAdapter method)</a>
</li>
</ul></li>
<li><a href="genai.html#genai.types.JSONSchema.items">items (genai.types.JSONSchema attribute)</a>

<ul>
Expand Down
14 changes: 14 additions & 0 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2036,6 +2036,13 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.AsyncClient.tunings"><code class="docutils literal notranslate"><span class="pre">AsyncClient.tunings</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter"><code class="docutils literal notranslate"><span class="pre">AsyncGeminiNextGenAPIClientAdapter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.async_get_auth_headers"><code class="docutils literal notranslate"><span class="pre">AsyncGeminiNextGenAPIClientAdapter.async_get_auth_headers()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.get_location"><code class="docutils literal notranslate"><span class="pre">AsyncGeminiNextGenAPIClientAdapter.get_location()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.get_project"><code class="docutils literal notranslate"><span class="pre">AsyncGeminiNextGenAPIClientAdapter.get_project()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.is_vertex_ai"><code class="docutils literal notranslate"><span class="pre">AsyncGeminiNextGenAPIClientAdapter.is_vertex_ai()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.client.Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.Client.api_key"><code class="docutils literal notranslate"><span class="pre">Client.api_key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.Client.vertexai"><code class="docutils literal notranslate"><span class="pre">Client.vertexai</span></code></a></li>
Expand Down Expand Up @@ -2065,6 +2072,13 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.DebugConfig.replays_directory"><code class="docutils literal notranslate"><span class="pre">DebugConfig.replays_directory</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="genai.html#genai.client.GeminiNextGenAPIClientAdapter"><code class="docutils literal notranslate"><span class="pre">GeminiNextGenAPIClientAdapter</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_auth_headers"><code class="docutils literal notranslate"><span class="pre">GeminiNextGenAPIClientAdapter.get_auth_headers()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_location"><code class="docutils literal notranslate"><span class="pre">GeminiNextGenAPIClientAdapter.get_location()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_project"><code class="docutils literal notranslate"><span class="pre">GeminiNextGenAPIClientAdapter.get_project()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.is_vertex_ai"><code class="docutils literal notranslate"><span class="pre">GeminiNextGenAPIClientAdapter.is_vertex_ai()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="genai.html#module-genai.batches">genai.batches module</a><ul>
Expand Down
Loading