Skip to content

Commit

Permalink
Deployed 5f6cd32 with MkDocs version: 1.4.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Mar 21, 2024
1 parent b6c4a9d commit adc789b
Show file tree
Hide file tree
Showing 4 changed files with 204 additions and 13 deletions.
144 changes: 132 additions & 12 deletions api/python_client/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1000,12 +1000,16 @@ <h3 id="llmengine.Completion.create" class="doc doc-heading">
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> frequency_penalty: Optional[<span style="color: #008000">float</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> top_k: Optional[<span style="color: #008000">int</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> top_p: Optional[<span style="color: #008000">float</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> timeout: <span style="color: #008000">int</span> <span style="color: #666666">=</span> COMPLETION_TIMEOUT,
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> stream: <span style="color: #008000">bool</span> <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">False</span>,
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>) <span style="color: #666666">-&gt;</span> Union[
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> CompletionSyncResponse,
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> Iterator[CompletionStreamResponse],
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>]
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> include_stop_str_in_output: Optional[<span style="color: #008000">bool</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">False</span>,
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> guided_json: Optional[Dict[<span style="color: #008000">str</span>, Any]] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> guided_regex: Optional[<span style="color: #008000">str</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> guided_choice: Optional[List[<span style="color: #008000">str</span>]] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> timeout: <span style="color: #008000">int</span> <span style="color: #666666">=</span> COMPLETION_TIMEOUT,
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> stream: <span style="color: #008000">bool</span> <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">False</span>,
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>) <span style="color: #666666">-&gt;</span> Union[
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> CompletionSyncResponse,
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> Iterator[CompletionStreamResponse],
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>]
</code></pre></div>

<div class="doc doc-contents ">
Expand Down Expand Up @@ -1186,6 +1190,62 @@ <h3 id="llmengine.Completion.create" class="doc doc-heading">
<code>None</code>
</td>
</tr>
<tr>
<td><code>include_stop_str_in_output</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[bool]</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether to include the stop sequence in the output. Default to False.</p>
</div>
</td>
<td>
<code>False</code>
</td>
</tr>
<tr>
<td><code>guided_json</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[<span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]]</code>
</td>
<td>
<div class="doc-md-description">
<p>If specified, the output will follow the JSON schema.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>guided_regex</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>If specified, the output will follow the regex pattern.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>guided_choice</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[<span title="typing.List">List</span>[str]]</code>
</td>
<td>
<div class="doc-md-description">
<p>If specified, the output will be exactly one of the choices.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>timeout</code></td>
<td>
Expand Down Expand Up @@ -1328,12 +1388,16 @@ <h3 id="llmengine.Completion.acreate" class="doc doc-heading">
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> frequency_penalty: Optional[<span style="color: #008000">float</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> top_k: Optional[<span style="color: #008000">int</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> top_p: Optional[<span style="color: #008000">float</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> timeout: <span style="color: #008000">int</span> <span style="color: #666666">=</span> COMPLETION_TIMEOUT,
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> stream: <span style="color: #008000">bool</span> <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">False</span>,
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>) <span style="color: #666666">-&gt;</span> Union[
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> CompletionSyncResponse,
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> AsyncIterable[CompletionStreamResponse],
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>]
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> include_stop_str_in_output: Optional[<span style="color: #008000">bool</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">False</span>,
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> guided_json: Optional[Dict[<span style="color: #008000">str</span>, Any]] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> guided_regex: Optional[<span style="color: #008000">str</span>] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> guided_choice: Optional[List[<span style="color: #008000">str</span>]] <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">None</span>,
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> timeout: <span style="color: #008000">int</span> <span style="color: #666666">=</span> COMPLETION_TIMEOUT,
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> stream: <span style="color: #008000">bool</span> <span style="color: #666666">=</span> <span style="color: #008000; font-weight: bold">False</span>,
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>) <span style="color: #666666">-&gt;</span> Union[
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> CompletionSyncResponse,
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> AsyncIterable[CompletionStreamResponse],
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>]
</code></pre></div>

<div class="doc doc-contents ">
Expand Down Expand Up @@ -1514,6 +1578,62 @@ <h3 id="llmengine.Completion.acreate" class="doc doc-heading">
<code>None</code>
</td>
</tr>
<tr>
<td><code>include_stop_str_in_output</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[bool]</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether to include the stop sequence in the output. Default to False.</p>
</div>
</td>
<td>
<code>False</code>
</td>
</tr>
<tr>
<td><code>guided_json</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[<span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]]</code>
</td>
<td>
<div class="doc-md-description">
<p>If specified, the output will follow the JSON schema. For examples see https://json-schema.org/learn/miscellaneous-examples.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>guided_regex</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>If specified, the output will follow the regex pattern.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>guided_choice</code></td>
<td>
<code><span title="typing.Optional">Optional</span>[<span title="typing.List">List</span>[str]]</code>
</td>
<td>
<div class="doc-md-description">
<p>If specified, the output will be exactly one of the choices.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr>
<td><code>timeout</code></td>
<td>
Expand Down
Loading

0 comments on commit adc789b

Please sign in to comment.