api_config

<p>api_config Class</p>
<p>api_config Class</p>

Based on the 'httr2' framework, the 'OpenAI' interface supports streaming calls and model training.
For more details on the API methods implemented, see the 'OpenAI' platform documentation at <https://platform.openai.com/docs/api-reference>.

Li Gen

openaistream

Streaming Capabilities for 'OpenAI API' Interactions

api_config function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/api_config%24new()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::api_config$new()"><code>api_config$new()</code></a></p></li>
<li><p><a href="/link/api_config%24set_api_key()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::api_config$set_api_key()"><code>api_config$set_api_key()</code></a></p></li>
<li><p><a href="/link/api_config%24set_proxy()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::api_config$set_proxy()"><code>api_config$set_proxy()</code></a></p></li>
<li><p><a href="/link/api_config%24get_proxy()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::api_config$get_proxy()"><code>api_config$get_proxy()</code></a></p></li>
<li><p><a href="/link/api_config%24get_api_key()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::api_config$get_api_key()"><code>api_config$get_api_key()</code></a></p></li>
<li><p><a href="/link/api_config%24get_api_endpoints()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::api_config$get_api_endpoints()"><code>api_config$get_api_endpoints()</code></a></p></li>
<li><p><a href="/link/api_config%24clone()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::api_config$clone()"><code>api_config$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-api_config-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Initialize the api_config object</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>api_config$new()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-api_config-set_api_key"></a></p><div class="section" id="method-set-api-key-">
<h3>Method <code>set_api_key()</code></h3>
<p>Configure the api_key settings.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>api_config$set_api_key(api_key)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>api_key</code></dt>
<dd><p>your openai_key</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-api_config-set_proxy"></a></p><div class="section" id="method-set-proxy-">
<h3>Method <code>set_proxy()</code></h3>
<p>Configure the proxy settings.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>api_config$set_proxy(proxy_ip, proxy_port)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>proxy_ip</code></dt>
<dd><p>character Required. The IP address of the proxy.</p></dd></dl></div></p><p>
<dt><code>proxy_port</code></dt>
<dd><p>character Required. The port number of the proxy.</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-api_config-get_proxy"></a></p><div class="section" id="method-get-proxy-">
<h3>Method <code>get_proxy()</code></h3>
<p>Configure the proxy gettings.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>api_config$get_proxy()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-api_config-get_api_key"></a></p><div class="section" id="method-get-api-key-">
<h3>Method <code>get_api_key()</code></h3>
<p>Api key gettings.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>api_config$get_api_key()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-api_config-get_api_endpoints"></a></p><div class="section" id="method-get-api-endpoints-">
<h3>Method <code>get_api_endpoints()</code></h3>
<p>Endpoints gettings.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>api_config$get_api_endpoints()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-api_config-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>api_config$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

api_config Class — api_config


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-api_config-new'><code>api_config$new()</code></a></p></li>
<li><p><a href='#method-api_config-set_api_key'><code>api_config$set_api_key()</code></a></p></li>
<li><p><a href='#method-api_config-set_proxy'><code>api_config$set_proxy()</code></a></p></li>
<li><p><a href='#method-api_config-get_proxy'><code>api_config$get_proxy()</code></a></p></li>
<li><p><a href='#method-api_config-get_api_key'><code>api_config$get_api_key()</code></a></p></li>
<li><p><a href='#method-api_config-get_api_endpoints'><code>api_config$get_api_endpoints()</code></a></p></li>
<li><p><a href='#method-api_config-clone'><code>api_config$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-api_config-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Initialize the api_config object</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>api_config$new()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-api_config-set_api_key"></a></p><div class='section' id='method-set-api-key-'>
<h3>Method <code>set_api_key()</code></h3>
<p>Configure the api_key settings.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>api_config$set_api_key(api_key)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>api_key</code></dt>
<dd><p>your openai_key</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-api_config-set_proxy"></a></p><div class='section' id='method-set-proxy-'>
<h3>Method <code>set_proxy()</code></h3>
<p>Configure the proxy settings.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>api_config$set_proxy(proxy_ip, proxy_port)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>proxy_ip</code></dt>
<dd><p>character Required. The IP address of the proxy.</p></dd>


<dt><code>proxy_port</code></dt>
<dd><p>character Required. The port number of the proxy.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-api_config-get_proxy"></a></p><div class='section' id='method-get-proxy-'>
<h3>Method <code>get_proxy()</code></h3>
<p>Configure the proxy gettings.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>api_config$get_proxy()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-api_config-get_api_key"></a></p><div class='section' id='method-get-api-key-'>
<h3>Method <code>get_api_key()</code></h3>
<p>Api key gettings.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>api_config$get_api_key()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-api_config-get_api_endpoints"></a></p><div class='section' id='method-get-api-endpoints-'>
<h3>Method <code>get_api_endpoints()</code></h3>
<p>Endpoints gettings.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>api_config$get_api_endpoints()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-api_config-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>api_config$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


api_config: api_config Class

Description

Arguments

Methods

Public methods

Method `new()`

Usage

Method `set_api_key()`

Usage

Arguments

Method `set_proxy()`

Usage

Arguments

Method `get_proxy()`

Usage

Method `get_api_key()`

Usage

Method `get_api_endpoints()`

Usage

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Methods

Public methods

Method new()

Usage

Method set_api_key()

Usage

Arguments

Method set_proxy()

Usage

Arguments

Method get_proxy()

Usage

Method get_api_key()

Usage

Method get_api_endpoints()

Usage

Method clone()

Usage

Arguments

Details

Method `new()`

Method `set_api_key()`

Method `set_proxy()`

Method `get_proxy()`

Method `get_api_key()`

Method `get_api_endpoints()`

Method `clone()`