openai-nodejs
Version:
A non-official OpenAI API wrapper for node.
4,474 lines • 60.4 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenAI NodeJS: Global</title>
<link type="text/css" rel="stylesheet" href="styles/vendor/prism-tomorrow-night.css">
<link type="text/css" rel="stylesheet" href="styles/styles.css">
</head>
<body>
<header class="layout-header">
<h1>
<a href="./index.html">
OpenAI NodeJS
</a>
</h1>
<nav class="layout-nav">
<ul><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class" title="class">C</span><span class="nav-item-name is-class"><a href="OpenAI.html">OpenAI</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#answer">answer</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#classificate">classificate</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#complete">complete</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#decode">decode</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#deleteFile">deleteFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#encode">encode</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#getEngine">getEngine</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#getEngines">getEngines</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#getFile">getFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#getFiles">getFiles</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#search">search</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#tokens">tokens</a></span></li><li class="nav-item"><span class="nav-item-type type-function" title="function">F</span><span class="nav-item-name is-function"><a href="OpenAI.html#uploadFile">uploadFile</a></span></li></ul><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#Answer">Answer</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#AnswerBody">AnswerBody</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#AnswerDocument">AnswerDocument</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#Classification">Classification</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#ClassificationBody">ClassificationBody</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#ClassificationExample">ClassificationExample</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#Completion">Completion</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#CompletionBody">CompletionBody</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#CompletionChoice">CompletionChoice</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#DeletedFile">DeletedFile</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#Engine">Engine</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#File">File</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#Search">Search</a></span></li><li class="nav-item"><span class="nav-item-type type-typedef" title="typedef">T</span><span class="nav-item-name is-typedef"><a href="global.html#SearchBody">SearchBody</a></span></li>
</nav>
</header>
<main class="layout-main ">
<div class="container">
<p class="page-kind"></p>
<h1 class="page-title">Global</h1>
<section>
<header class="not-class">
<!-- <h2></h2> -->
</header>
<article>
<div class="container-overview">
<div class="details">
</div>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="Answer">Answer</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">answers</span>
<span class="param-type">
<code>Array.<String></code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">completion</span>
<span class="param-type">
<code>String</code>
</span>
|
<span class="param-type">
<code><a href="global.html#Completion">Completion</a></code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">model</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">object</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">search_model</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">prompt</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">selected_documents</span>
<span class="param-type">
<code>Array.<<a href="global.html#AnswerDocument">AnswerDocument</a>></code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/answers">https://beta.openai.com/docs/api-reference/answers</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.343">, line 343</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="AnswerBody">AnswerBody</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">examples</span>
<span class="param-type">
<code>Array.<Array.<String>></code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
<p>List of (question, answer) pairs that will help steer the model towards the tone and answer format you'd like.</p>
</div>
</li>
<li>
<span class="param-name">examples_context</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
<p>A text snippet containing the contextual information used to generate the answers for the examples you provide.</p>
</div>
</li>
<li>
<span class="param-name">documents</span>
<span class="param-type">
<code>Array.<String></code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>List of documents from which the answer for the input question should be derived.</p>
</div>
</li>
<li>
<span class="param-name">file</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The ID of an uploaded file that contains documents to search over.</p>
</div>
</li>
<li>
<span class="param-name">search_model</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>ID of the engine to use for Search.</p>
</div>
</li>
<li>
<span class="param-name">return_prompt</span>
<span class="param-type">
<code>Boolean</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>If set to true, the returned JSON will include a "prompt" field containing the final prompt that was used to request a completion.</p>
</div>
</li>
<li>
<span class="param-name">expand</span>
<span class="param-type">
<code>Array.<String></code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>If an object name is in the list, we provide the full information of the object; otherwise, we only provide the object ID.</p>
</div>
</li>
<li>
<span class="param-name">max_rerank</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The maximum number of documents to be ranked by Search when using file.</p>
</div>
</li>
<li>
<span class="param-name">return_metadata</span>
<span class="param-type">
<code>Boolean</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>A special boolean flag for showing metadata.</p>
</div>
</li>
<li>
<span class="param-name">max_tokens</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The maximum number of tokens allowed for the generated answer.</p>
</div>
</li>
<li>
<span class="param-name">temperature</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>What sampling temperature to use.</p>
</div>
</li>
<li>
<span class="param-name">n</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>How many answers to generate for each question.</p>
</div>
</li>
<li>
<span class="param-name">logprobs</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens.</p>
</div>
</li>
<li>
<span class="param-name">stop</span>
<span class="param-type">
<code>String</code>
</span>
|
<span class="param-type">
<code>Array.<String></code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Up to 4 sequences where the API will stop generating further tokens.</p>
</div>
</li>
<li>
<span class="param-name">logit_bias</span>
<span class="param-type">
<code>Object</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Modify the likelihood of specified tokens appearing in the completion.</p>
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/answers">https://beta.openai.com/docs/api-reference/answers</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.356">, line 356</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="AnswerDocument">AnswerDocument</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">document</span>
<span class="param-type">
<code>Number</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">text</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/answers">https://beta.openai.com/docs/api-reference/answers</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.378">, line 378</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="Classification">Classification</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">completion</span>
<span class="param-type">
<code>String</code>
</span>
|
<span class="param-type">
<code><a href="global.html#Completion">Completion</a></code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">label</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">model</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">object</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">search_model</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">prompt</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">selected_examples</span>
<span class="param-type">
<code>Array.<<a href="global.html#ClassificationExample">ClassificationExample</a>></code>
</span>
<span class="param-attributes">
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/classifications">https://beta.openai.com/docs/api-reference/classifications</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.263">, line 263</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="ClassificationBody">ClassificationBody</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">examples</span>
<span class="param-type">
<code>Array.<Array.<String>></code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>A list of examples with labels.</p>
</div>
</li>
<li>
<span class="param-name">file</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The ID of the uploaded file that contains training examples.</p>
</div>
</li>
<li>
<span class="param-name">labels</span>
<span class="param-type">
<code>Array.<String></code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The set of categories being classified.</p>
</div>
</li>
<li>
<span class="param-name">search_model</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>ID of the engine to use for Search.</p>
</div>
</li>
<li>
<span class="param-name">temperature</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>What sampling temperature to use.</p>
</div>
</li>
<li>
<span class="param-name">logprobs</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens.</p>
</div>
</li>
<li>
<span class="param-name">max_examples</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The maximum number of examples to be ranked by Search when using file.</p>
</div>
</li>
<li>
<span class="param-name">logit_bias</span>
<span class="param-type">
<code>Object</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Modify the likelihood of specified tokens appearing in the completion.</p>
</div>
</li>
<li>
<span class="param-name">return_prompt</span>
<span class="param-type">
<code>Boolean</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>If set to true, the returned JSON will include a "prompt" field containing the final prompt that was used to request a completion.</p>
</div>
</li>
<li>
<span class="param-name">return_metadata</span>
<span class="param-type">
<code>Boolean</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>A special boolean flag for showing metadata.</p>
</div>
</li>
<li>
<span class="param-name">expand</span>
<span class="param-type">
<code>Array.<String></code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>If an object name is in the list, we provide the full information of the object; otherwise, we only provide the object ID.</p>
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/classifications">https://beta.openai.com/docs/api-reference/classifications</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.276">, line 276</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="ClassificationExample">ClassificationExample</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">document</span>
<span class="param-type">
<code>Number</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">label</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">text</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/classifications">https://beta.openai.com/docs/api-reference/classifications</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.293">, line 293</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="Completion">Completion</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">id</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">object</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">created</span>
<span class="param-type">
<code>Number</code>
</span>
|
<span class="param-type">
<code>null</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">model</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">choices</span>
<span class="param-type">
<code>array.<<a href="global.html#CompletionChoice">CompletionChoice</a>></code>
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/completions">https://beta.openai.com/docs/api-reference/completions</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.134">, line 134</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="CompletionBody">CompletionBody</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">max_tokens</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The maximum number of tokens to generate.</p>
</div>
</li>
<li>
<span class="param-name">temperature</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>What sampling temperature to use.</p>
</div>
</li>
<li>
<span class="param-name">top_p</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.</p>
</div>
</li>
<li>
<span class="param-name">n</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>How many completions to generate for each prompt.</p>
</div>
</li>
<li>
<span class="param-name">stream</span>
<span class="param-type">
<code>Boolean</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Whether to stream back partial progress.</p>
</div>
</li>
<li>
<span class="param-name">logprobs</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens.</p>
</div>
</li>
<li>
<span class="param-name">echo</span>
<span class="param-type">
<code>Boolean</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Echo back the prompt in addition to the completion</p>
</div>
</li>
<li>
<span class="param-name">stop</span>
<span class="param-type">
<code>String</code>
</span>
|
<span class="param-type">
<code>Array.<String></code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Up to 4 sequences where the API will stop generating further tokens.</p>
</div>
</li>
<li>
<span class="param-name">presence_penalty</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Number between 0 and 1 that penalizes new tokens based on whether they appear in the text so far.</p>
</div>
</li>
<li>
<span class="param-name">frequency_penalty</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Number between 0 and 1 that penalizes new tokens based on their existing frequency in the text so far.</p>
</div>
</li>
<li>
<span class="param-name">best_of</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Generates best_of completions server-side and returns the "best" (the one with the lowest log probability per token).</p>
</div>
</li>
<li>
<span class="param-name">logit_bias</span>
<span class="param-type">
<code>Object</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Modify the likelihood of specified tokens appearing in the completion.</p>
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/completions">https://beta.openai.com/docs/api-reference/completions</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.145">, line 145</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="CompletionChoice">CompletionChoice</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">text</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">index</span>
<span class="param-type">
<code>Number</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">logprobs</span>
<span class="param-type">
<code>Number</code>
</span>
|
<span class="param-type">
<code>null</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">finish_reason</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/completions">https://beta.openai.com/docs/api-reference/completions</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.163">, line 163</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="DeletedFile">DeletedFile</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">id</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">object</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">deleted</span>
<span class="param-type">
<code>Boolean</code>
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/files">https://beta.openai.com/docs/api-reference/files</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.484">, line 484</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="Engine">Engine</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">id</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">object</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">created</span>
<span class="param-type">
<code>Number</code>
</span>
|
<span class="param-type">
<code>null</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">max_replicas</span>
<span class="param-type">
<code>Number</code>
</span>
|
<span class="param-type">
<code>null</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">owner</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">permissions</span>
<span class="param-type">
<code>any</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">ready</span>
<span class="param-type">
<code>boolean</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">ready_replicas</span>
<span class="param-type">
<code>boolean</code>
</span>
|
<span class="param-type">
<code>null</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">ready_replicas</span>
<span class="param-type">
<code>any</code>
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/engines">https://beta.openai.com/docs/api-reference/engines</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.70">, line 70</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="File">File</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">id</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">object</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">bytes</span>
<span class="param-type">
<code>Number</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">created_at</span>
<span class="param-type">
<code>Number</code>
</span>
|
<span class="param-type">
<code>null</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">filename</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">purpose</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">status</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">status_details</span>
<span class="param-type">
<code>String</code>
</span>
|
<span class="param-type">
<code>null</code>
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/files">https://beta.openai.com/docs/api-reference/files</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.427">, line 427</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="Search">Search</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">document</span>
<span class="param-type">
<code>Number</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">object</span>
<span class="param-type">
<code>String</code>
</span>
<div class="param-description">
</div>
</li>
<li>
<span class="param-name">score</span>
<span class="param-type">
<code>Number</code>
</span>
<div class="param-description">
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/searches">https://beta.openai.com/docs/api-reference/searches</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.207">, line 207</a>
</li>
</ul>
</article>
<article class="member">
<div class="method-type">
</div>
<h4 class="member-name" id="SearchBody">SearchBody</h4>
<h4>Type</h4>
<ul>
<li>
<span class="param-type">
<code>Object</code>
</span>
</li>
</ul>
<h4 class="method-heading">Properties</h4>
<ul class="method-params">
<li>
<span class="param-name">documents</span>
<span class="param-type">
<code>Array.<String></code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>Up to 200 documents to search over, provided as a list of strings.</p>
</div>
</li>
<li>
<span class="param-name">file</span>
<span class="param-type">
<code>String</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The ID of an uploaded file that contains documents to search over.</p>
</div>
</li>
<li>
<span class="param-name">max_rerank</span>
<span class="param-type">
<code>Number</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>The maximum number of documents to be re-ranked and returned by search.</p>
</div>
</li>
<li>
<span class="param-name">return_metadata</span>
<span class="param-type">
<code>Boolean</code>
</span>
<span class="param-attributes">
<optional><br>
</span>
<div class="param-description">
<p>A special boolean flag for showing metadata.</p>
</div>
</li>
</ul>
<div class="details">
<h4 class="method-heading">See</h4>
<ul>
<li><a href="https://beta.openai.com/docs/api-reference/searches">https://beta.openai.com/docs/api-reference/searches</a></li>
</ul>
</div>
<h4>Source</h4>
<ul>
<li class="method-source">
<a href="index.js.html">index.js</a><a href="index.js.html#source.216">, line 216</a>
</li>
</ul>
</article>
</article>
</section>
</div>
</main>
<footer class="layout-footer">
<div class="container">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
</div>
</footer>
<script src="scripts/prism.dev.js"></script>
</body>
</html>