Skip to content

Commit 39a8b06

Browse files
wanlin31copybara-github
wanlin31
authored and
copybara-github
committed
docs: Regenerate docs for 1.58.0
PiperOrigin-RevId: 856742093
1 parent 79ac880 commit 39a8b06

6 files changed

Lines changed: 151 additions & 3 deletions

File tree

‎docs/genai.html‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,53 @@ <h1>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
361361

362362
</dd></dl>
363363

364+
<dl class="py class">
365+
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter">
366+
<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>
367+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncGeminiNextGenAPIClientAdapter</span></code></p>
368+
<p>Adapter for the Gemini NextGen API Client.</p>
369+
<dl class="py method">
370+
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter.async_get_auth_headers">
371+
<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>
372+
<dd><dl class="field-list simple">
373+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
374+
<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>
375+
</dd>
376+
</dl>
377+
</dd></dl>
378+
379+
<dl class="py method">
380+
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter.get_location">
381+
<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>
382+
<dd><dl class="field-list simple">
383+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
384+
<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>
385+
</dd>
386+
</dl>
387+
</dd></dl>
388+
389+
<dl class="py method">
390+
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter.get_project">
391+
<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>
392+
<dd><dl class="field-list simple">
393+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
394+
<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>
395+
</dd>
396+
</dl>
397+
</dd></dl>
398+
399+
<dl class="py method">
400+
<dt class="sig sig-object py" id="genai.client.AsyncGeminiNextGenAPIClientAdapter.is_vertex_ai">
401+
<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>
402+
<dd><dl class="field-list simple">
403+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
404+
<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>
405+
</dd>
406+
</dl>
407+
</dd></dl>
408+
409+
</dd></dl>
410+
364411
<dl class="py class">
365412
<dt class="sig sig-object py" id="genai.client.Client">
366413
<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>
@@ -657,6 +704,53 @@ <h1>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
657704

658705
</dd></dl>
659706

707+
<dl class="py class">
708+
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter">
709+
<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>
710+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">GeminiNextGenAPIClientAdapter</span></code></p>
711+
<p>Adapter for the Gemini NextGen API Client.</p>
712+
<dl class="py method">
713+
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter.get_auth_headers">
714+
<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>
715+
<dd><dl class="field-list simple">
716+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
717+
<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>
718+
</dd>
719+
</dl>
720+
</dd></dl>
721+
722+
<dl class="py method">
723+
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter.get_location">
724+
<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>
725+
<dd><dl class="field-list simple">
726+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
727+
<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>
728+
</dd>
729+
</dl>
730+
</dd></dl>
731+
732+
<dl class="py method">
733+
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter.get_project">
734+
<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>
735+
<dd><dl class="field-list simple">
736+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
737+
<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>
738+
</dd>
739+
</dl>
740+
</dd></dl>
741+
742+
<dl class="py method">
743+
<dt class="sig sig-object py" id="genai.client.GeminiNextGenAPIClientAdapter.is_vertex_ai">
744+
<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>
745+
<dd><dl class="field-list simple">
746+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
747+
<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>
748+
</dd>
749+
</dl>
750+
</dd></dl>
751+
752+
</dd></dl>
753+
660754
</section>
661755
<section id="module-genai.batches">
662756
<span id="genai-batches-module"></span><h1>genai.batches module<a class="headerlink" href="#module-genai.batches" title="Link to this heading">¶</a></h1>

‎docs/genindex.html‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -468,14 +468,14 @@ <h2>A</h2>
468468
<li><a href="genai.html#genai.types.FunctionCallDict.args">(genai.types.FunctionCallDict attribute)</a>
469469
</li>
470470
</ul></li>
471-
</ul></td>
472-
<td style="width: 33%; vertical-align: top;"><ul>
473471
<li><a href="genai.html#genai.types.JSONSchemaType.ARRAY">ARRAY (genai.types.JSONSchemaType attribute)</a>
474472

475473
<ul>
476474
<li><a href="genai.html#genai.types.Type.ARRAY">(genai.types.Type attribute)</a>
477475
</li>
478476
</ul></li>
477+
</ul></td>
478+
<td style="width: 33%; vertical-align: top;"><ul>
479479
<li><a href="genai.html#genai.types.Blob.as_image">as_image() (genai.types.Blob method)</a>
480480

481481
<ul>
@@ -508,6 +508,8 @@ <h2>A</h2>
508508
<li><a href="genai.html#genai.types.HttpOptionsDict.async_client_args">(genai.types.HttpOptionsDict attribute)</a>
509509
</li>
510510
</ul></li>
511+
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.async_get_auth_headers">async_get_auth_headers() (genai.client.AsyncGeminiNextGenAPIClientAdapter method)</a>
512+
</li>
511513
<li><a href="genai.html#genai.batches.AsyncBatches">AsyncBatches (class in genai.batches)</a>
512514
</li>
513515
<li><a href="genai.html#genai.caches.AsyncCaches">AsyncCaches (class in genai.caches)</a>
@@ -519,6 +521,8 @@ <h2>A</h2>
519521
<li><a href="genai.html#genai.client.AsyncClient">AsyncClient (class in genai.client)</a>
520522
</li>
521523
<li><a href="genai.html#genai.files.AsyncFiles">AsyncFiles (class in genai.files)</a>
524+
</li>
525+
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter">AsyncGeminiNextGenAPIClientAdapter (class in genai.client)</a>
522526
</li>
523527
<li><a href="genai.html#genai.live.AsyncLive">AsyncLive (class in genai.live)</a>
524528
</li>
@@ -2803,6 +2807,8 @@ <h2>G</h2>
28032807
</li>
28042808
</ul></li>
28052809
<li><a href="genai.html#genai.types.GcsDestinationDict">GcsDestinationDict (class in genai.types)</a>
2810+
</li>
2811+
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter">GeminiNextGenAPIClientAdapter (class in genai.client)</a>
28062812
</li>
28072813
<li><a href="genai.html#genai.types.GeminiPreferenceExampleCompletionDict">GeminiPreferenceExampleCompletionDict (class in genai.types)</a>
28082814
</li>
@@ -3020,6 +3026,20 @@ <h2>G</h2>
30203026
<li><a href="genai.html#genai.tunings.AsyncTunings.get">(genai.tunings.AsyncTunings method)</a>
30213027
</li>
30223028
<li><a href="genai.html#genai.tunings.Tunings.get">(genai.tunings.Tunings method)</a>
3029+
</li>
3030+
</ul></li>
3031+
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_auth_headers">get_auth_headers() (genai.client.GeminiNextGenAPIClientAdapter method)</a>
3032+
</li>
3033+
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.get_location">get_location() (genai.client.AsyncGeminiNextGenAPIClientAdapter method)</a>
3034+
3035+
<ul>
3036+
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_location">(genai.client.GeminiNextGenAPIClientAdapter method)</a>
3037+
</li>
3038+
</ul></li>
3039+
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.get_project">get_project() (genai.client.AsyncGeminiNextGenAPIClientAdapter method)</a>
3040+
3041+
<ul>
3042+
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.get_project">(genai.client.GeminiNextGenAPIClientAdapter method)</a>
30233043
</li>
30243044
</ul></li>
30253045
<li><a href="genai.html#genai.types.GetBatchJobConfigDict">GetBatchJobConfigDict (class in genai.types)</a>
@@ -3814,6 +3834,12 @@ <h2>I</h2>
38143834
</ul></li>
38153835
<li><a href="genai.html#genai.types.IntervalDict">IntervalDict (class in genai.types)</a>
38163836
</li>
3837+
<li><a href="genai.html#genai.client.AsyncGeminiNextGenAPIClientAdapter.is_vertex_ai">is_vertex_ai() (genai.client.AsyncGeminiNextGenAPIClientAdapter method)</a>
3838+
3839+
<ul>
3840+
<li><a href="genai.html#genai.client.GeminiNextGenAPIClientAdapter.is_vertex_ai">(genai.client.GeminiNextGenAPIClientAdapter method)</a>
3841+
</li>
3842+
</ul></li>
38173843
<li><a href="genai.html#genai.types.JSONSchema.items">items (genai.types.JSONSchema attribute)</a>
38183844

38193845
<ul>

‎docs/index.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2036,6 +2036,13 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
20362036
<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>
20372037
</ul>
20382038
</li>
2039+
<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>
2040+
<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>
2041+
<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>
2042+
<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>
2043+
<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>
2044+
</ul>
2045+
</li>
20392046
<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>
20402047
<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>
20412048
<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>
@@ -2065,6 +2072,13 @@ <h1>Reference<a class="headerlink" href="#reference" title="Link to this heading
20652072
<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>
20662073
</ul>
20672074
</li>
2075+
<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>
2076+
<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>
2077+
<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>
2078+
<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>
2079+
<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>
2080+
</ul>
2081+
</li>
20682082
</ul>
20692083
</li>
20702084
<li class="toctree-l1"><a class="reference internal" href="genai.html#module-genai.batches">genai.batches module</a><ul>

0 commit comments

Comments
 (0)