StreamIterator

<p>R6 class for iterating over streaming response chunks.</p>

Complete R implementation of the 'OpenAI' Python 'SDK'. Provides
full compatibility with the 'OpenAI' API including chat completions,
'embeddings', images, audio, fine-tuning, and model management.

Chaoyang Luo

openaiRtools

R Client for the 'OpenAI' API

StreamIterator function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/StreamIterator%24new()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::StreamIterator$new()"><code>StreamIterator$new()</code></a></p></li>
<li><p><a href="/link/StreamIterator%24next_chunk()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::StreamIterator$next_chunk()"><code>StreamIterator$next_chunk()</code></a></p></li>
<li><p><a href="/link/StreamIterator%24has_more()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::StreamIterator$has_more()"><code>StreamIterator$has_more()</code></a></p></li>
<li><p><a href="/link/StreamIterator%24reset()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::StreamIterator$reset()"><code>StreamIterator$reset()</code></a></p></li>
<li><p><a href="/link/StreamIterator%24as_list()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::StreamIterator$as_list()"><code>StreamIterator$as_list()</code></a></p></li>
<li><p><a href="/link/StreamIterator%24get_full_text()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::StreamIterator$get_full_text()"><code>StreamIterator$get_full_text()</code></a></p></li>
<li><p><a href="/link/StreamIterator%24clone()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::StreamIterator$clone()"><code>StreamIterator$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-StreamIterator-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamIterator$new(chunks)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-StreamIterator-next_chunk"></a></p><div class="section" id="method-next-chunk-">
<h3>Method <code>next_chunk()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamIterator$next_chunk()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-StreamIterator-has_more"></a></p><div class="section" id="method-has-more-">
<h3>Method <code>has_more()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamIterator$has_more()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-StreamIterator-reset"></a></p><div class="section" id="method-reset-">
<h3>Method <code>reset()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamIterator$reset()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-StreamIterator-as_list"></a></p><div class="section" id="method-as-list-">
<h3>Method <code>as_list()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamIterator$as_list()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-StreamIterator-get_full_text"></a></p><div class="section" id="method-get-full-text-">
<h3>Method <code>get_full_text()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>StreamIterator$get_full_text()</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-StreamIterator-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>StreamIterator$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

Stream Iterator Class — StreamIterator


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

<ul>
<li><p><a href='#method-StreamIterator-new'><code>StreamIterator$new()</code></a></p></li>
<li><p><a href='#method-StreamIterator-next_chunk'><code>StreamIterator$next_chunk()</code></a></p></li>
<li><p><a href='#method-StreamIterator-has_more'><code>StreamIterator$has_more()</code></a></p></li>
<li><p><a href='#method-StreamIterator-reset'><code>StreamIterator$reset()</code></a></p></li>
<li><p><a href='#method-StreamIterator-as_list'><code>StreamIterator$as_list()</code></a></p></li>
<li><p><a href='#method-StreamIterator-get_full_text'><code>StreamIterator$get_full_text()</code></a></p></li>
<li><p><a href='#method-StreamIterator-clone'><code>StreamIterator$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-StreamIterator-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamIterator$new(chunks)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-StreamIterator-next_chunk"></a></p><div class='section' id='method-next-chunk-'>
<h3>Method <code>next_chunk()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamIterator$next_chunk()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-StreamIterator-has_more"></a></p><div class='section' id='method-has-more-'>
<h3>Method <code>has_more()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamIterator$has_more()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-StreamIterator-reset"></a></p><div class='section' id='method-reset-'>
<h3>Method <code>reset()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamIterator$reset()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-StreamIterator-as_list"></a></p><div class='section' id='method-as-list-'>
<h3>Method <code>as_list()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamIterator$as_list()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-StreamIterator-get_full_text"></a></p><div class='section' id='method-get-full-text-'>
<h3>Method <code>get_full_text()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>StreamIterator$get_full_text()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-StreamIterator-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>StreamIterator$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>


StreamIterator: Stream Iterator Class

Description

Arguments

Methods

Public methods

Method `new()`

Usage

Method `next_chunk()`

Usage

Method `has_more()`

Usage

Method `reset()`

Usage

Method `as_list()`

Usage

Method `get_full_text()`

Usage

Method `clone()`

Usage

Arguments

Description

Arguments

Methods

Public methods

Method new()

Usage

Method next_chunk()

Usage

Method has_more()

Usage

Method reset()

Usage

Method as_list()

Usage

Method get_full_text()

Usage

Method clone()

Usage

Arguments

Method `new()`

Method `next_chunk()`

Method `has_more()`

Method `reset()`

Method `as_list()`

Method `get_full_text()`

Method `clone()`