Skip to content

Commit

Permalink
Deployed 582dd0c with MkDocs version: 1.4.3
Browse files Browse the repository at this point in the history
  • Loading branch information
squeakymouse committed Aug 2, 2023
1 parent 3709672 commit 759e63d
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 1 deletion.
98 changes: 98 additions & 0 deletions api/python_client/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -579,6 +579,13 @@
get()
</a>

</li>

<li class="md-nav__item">
<a href="#llmengine.file.File.download" class="md-nav__link">
download()
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -828,6 +835,13 @@
get()
</a>

</li>

<li class="md-nav__item">
<a href="#llmengine.file.File.download" class="md-nav__link">
download()
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -2450,6 +2464,90 @@ <h3 id="llmengine.file.File.get" class="doc doc-heading">



<h3 id="llmengine.file.File.download" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">download</span>


<span class="doc doc-labels">
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
</span>

<a href="#llmengine.file.File.download" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%;"><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>download(file_id: <span style="color: #008000">str</span>) <span style="color: #666666">-&gt;</span> GetFileContentResponse
</code></pre></div>

<div class="doc doc-contents ">

<p>Get contents of a file, as a string. (If the uploaded file is in binary, a string encoding will be returned.)</p>

<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>file_id</code></td>
<td>
<code>`str`</code>
</td>
<td><p>ID of the file</p></td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>

<p><strong>Returns:</strong></p>
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>GetFileContentResponse</code></td> <td>
<code><a class="autorefs autorefs-internal" title="llmengine.data_types.GetFileContentResponse" href="../data_types/#llmengine.GetFileContentResponse">GetFileContentResponse</a></code>
</td>
<td><p>an object that contains the ID and content of the file</p></td>
</tr>
</tbody>
</table>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="llmengine.file.File.download--__tabbed_1_1" name="llmengine.file.File.download--__tabbed_1" type="radio" /><input id="llmengine.file.File.download--__tabbed_1_2" name="llmengine.file.File.download--__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="llmengine.file.File.download--__tabbed_1_1">Getting file content in Python</label><label for="llmengine.file.File.download--__tabbed_1_2">Response in JSON</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%;"><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span style="color: #008000; font-weight: bold">from</span> <span style="color: #0000FF; font-weight: bold">llmengine</span> <span style="color: #008000; font-weight: bold">import</span> File
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>response <span style="color: #666666">=</span> File<span style="color: #666666">.</span>download(file_id<span style="color: #666666">=</span><span style="color: #BA2121">&quot;file-abc123&quot;</span>)
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span style="color: #008000">print</span>(response<span style="color: #666666">.</span>json())
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight" style="background: #f8f8f8"><pre style="line-height: 125%;"><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>{
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span style="color: #bbbbbb"> </span><span style="color: #008000; font-weight: bold">&quot;id&quot;</span>:<span style="color: #bbbbbb"> </span><span style="color: #BA2121">&quot;file-abc123&quot;</span>,
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span style="color: #bbbbbb"> </span><span style="color: #008000; font-weight: bold">&quot;content&quot;</span>:<span style="color: #bbbbbb"> </span><span style="color: #BA2121">&quot;Hello world!&quot;</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>}
</code></pre></div>
</div>
</div>
</div>

</div>

</div>

<div class="doc doc-object doc-function">



<h3 id="llmengine.file.File.list" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">list</span>

Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit 759e63d

Please sign in to comment.