UploadsClient

<p>The Uploads API is designed for files larger than what the Files API
can handle in a single request. You split the file into parts,
upload each part, then finalize the upload to get a standard file object.</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

UploadsClient function

<p></p><p><ol>
<li><p><code>$create()</code> — Initialize the upload session, get an <code>upload_id</code></p></li>
<li><p><code>$add_part()</code> — Upload each chunk of the file (called multiple times)</p></li>
<li><p><code>$complete()</code> — Finalize and assemble the file; returns a File object</p></li>
<li><p>(Optional) <code>$cancel()</code> — Abort if needed</p></li>
</ol>
</p>

Workflow


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/UploadsClient%24new()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::UploadsClient$new()"><code>UploadsClient$new()</code></a></p></li>
<li><p><a href="/link/UploadsClient%24create()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::UploadsClient$create()"><code>UploadsClient$create()</code></a></p></li>
<li><p><a href="/link/UploadsClient%24add_part()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::UploadsClient$add_part()"><code>UploadsClient$add_part()</code></a></p></li>
<li><p><a href="/link/UploadsClient%24complete()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::UploadsClient$complete()"><code>UploadsClient$complete()</code></a></p></li>
<li><p><a href="/link/UploadsClient%24cancel()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::UploadsClient$cancel()"><code>UploadsClient$cancel()</code></a></p></li>
<li><p><a href="/link/UploadsClient%24clone()?package=openaiRtools&version=0.2.2" data-mini-rdoc="openaiRtools::UploadsClient$clone()"><code>UploadsClient$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-UploadsClient-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>UploadsClient$new(parent)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-UploadsClient-create"></a></p><div class="section" id="method-create-">
<h3>Method <code>create()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>UploadsClient$create(purpose, filename, bytes, mime_type = NULL)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-UploadsClient-add_part"></a></p><div class="section" id="method-add-part-">
<h3>Method <code>add_part()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>UploadsClient$add_part(upload_id, data)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-UploadsClient-complete"></a></p><div class="section" id="method-complete-">
<h3>Method <code>complete()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>UploadsClient$complete(upload_id, part_ids, md5 = NULL)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-UploadsClient-cancel"></a></p><div class="section" id="method-cancel-">
<h3>Method <code>cancel()</code></h3><p></p><p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>UploadsClient$cancel(upload_id)</code></pre><p></p></div></p>
</div><p></p><p>
</p><p><hr>
<a id="method-UploadsClient-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>UploadsClient$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

Uploads Client — UploadsClient



<ol>
<li><p><code>$create()</code> — Initialize the upload session, get an <code>upload_id</code></p></li>
<li><p><code>$add_part()</code> — Upload each chunk of the file (called multiple times)</p></li>
<li><p><code>$complete()</code> — Finalize and assemble the file; returns a File object</p></li>
<li><p>(Optional) <code>$cancel()</code> — Abort if needed</p></li>
</ol>



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

<ul>
<li><p><a href='#method-UploadsClient-new'><code>UploadsClient$new()</code></a></p></li>
<li><p><a href='#method-UploadsClient-create'><code>UploadsClient$create()</code></a></p></li>
<li><p><a href='#method-UploadsClient-add_part'><code>UploadsClient$add_part()</code></a></p></li>
<li><p><a href='#method-UploadsClient-complete'><code>UploadsClient$complete()</code></a></p></li>
<li><p><a href='#method-UploadsClient-cancel'><code>UploadsClient$cancel()</code></a></p></li>
<li><p><a href='#method-UploadsClient-clone'><code>UploadsClient$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-UploadsClient-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>UploadsClient$new(parent)</code></pre><p></div></p>
</div>


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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>UploadsClient$create(purpose, filename, bytes, mime_type = NULL)</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-UploadsClient-add_part"></a></p><div class='section' id='method-add-part-'>
<h3>Method <code>add_part()</code></h3>

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>UploadsClient$add_part(upload_id, data)</code></pre><p></div></p>
</div>


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

<div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>UploadsClient$complete(upload_id, part_ids, md5 = NULL)</code></pre><p></div></p>
</div>


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

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


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


UploadsClient: Uploads Client

Description

Arguments

Workflow

Methods

Public methods

Method `new()`

Usage

Method `create()`

Usage

Method `add_part()`

Usage

Method `complete()`

Usage

Method `cancel()`

Usage

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Workflow

Methods

Public methods

Method new()

Usage

Method create()

Usage

Method add_part()

Usage

Method complete()

Usage

Method cancel()

Usage

Method clone()

Usage

Arguments

Details

Method `new()`

Method `create()`

Method `add_part()`

Method `complete()`

Method `cancel()`

Method `clone()`