moderations

<p>moderations Class</p>
<p>moderations 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

moderations function

<p><code>openaistream::openai</code> -&gt; <code>moderations</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/moderations%24create()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::moderations$create()"><code>moderations$create()</code></a></p></li>
<li><p><a href="/link/moderations%24clone()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::moderations$clone()"><code>moderations$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="openaistream" data-topic="openai" data-id="initialize"><a href="/link/openaistream%3A%3Aopenai%24initialize()?package=openaistream&version=0.2.0" data-mini-rdoc="openaistream::openaistream::openai$initialize()"><code>openaistream::openai$initialize()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-moderations-create"></a></p><div class="section" id="method-create-">
<h3>Method <code>create()</code></h3>
<p>Classifies if text violates OpenAI's Content Policy.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>moderations$create(input, ..., verbosity = 0)</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>input</code></dt>
<dd><p>character Required. The input text to classify.</p></dd></dl></div></p><p>
<dt><code>...</code></dt>
<dd><p>Additional parameters as required by the OpenAI API.For example:model...</p></dd></p><p>
<dt><code>verbosity</code></dt>
<dd><p>numeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>Returns a list of image objects.</p>
</div><p></p><p></p><p><hr>
<a id="method-moderations-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>moderations$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

moderations Class — moderations


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

<ul>
<li><p><a href='#method-moderations-create'><code>moderations$create()</code></a></p></li>
<li><p><a href='#method-moderations-clone'><code>moderations$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="openaistream" data-topic="openai" data-id="initialize"><a href='../../openaistream/html/openai.html#method-openai-initialize'><code>openaistream::openai$initialize()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-moderations-create"></a></p><div class='section' id='method-create-'>
<h3>Method <code>create()</code></h3>
<p>Classifies if text violates OpenAI's Content Policy.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>moderations$create(input, ..., verbosity = 0)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>input</code></dt>
<dd><p>character Required. The input text to classify.</p></dd>


<dt><code>...</code></dt>
<dd><p>Additional parameters as required by the OpenAI API.For example:model...</p></dd>


<dt><code>verbosity</code></dt>
<dd><p>numeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>Returns a list of image objects.</p>
</div>

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


moderations: moderations Class

Description

Arguments

Super class

Methods

Public methods

Method `create()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Super class

Methods

Public methods

Method create()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Method `create()`

Method `clone()`