openai 1.1.1 → 2.0.2

package/.openapi-generator/FILES

@@ -0,0 +1,6 @@
+.npmignore
+api.ts
+base.ts
+common.ts
+configuration.ts
+index.ts

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+5.3.1

package/.openapi-generator-ignore

@@ -0,0 +1,5 @@
+.gitignore
+README.md
+git_push.sh
+package.json
+package-lock.json

package/LICENSE

@@ -1,6 +1,6 @@
-MIT License
+The MIT License
 
-Copyright (c) 2021 Gabriel Francisco
+Copyright (c) OpenAI (https://openai.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,204 +1,75 @@
-[![Build Status](https://github.com/ceifa/openai/actions/workflows/publish.yml/badge.svg)](https://github.com/ceifa/openai/actions/workflows/publish.yml)
-[![npm](https://img.shields.io/npm/v/openai.svg)](https://npmjs.com/package/openai)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+# OpenAI Node.js Library
 
-# OpenAI
+The OpenAI Node.js library provides convenient access to the OpenAI API from Node.js applications. Most of the code in this library is generated from our [OpenAPI specification](https://github.com/openai/openai-openapi).
 
-A tiny async production-ready wrapper for [OpenAI GPT-3 API](https://beta.openai.com/docs/api-reference/introduction).
-
-**This is an unofficial library and has no affiliations with OpenAI**
+**Important note: this library is meant for server-side usage only, as using it in client-side browser code will expose your secret API key. [See here](https://beta.openai.com/docs/api-reference/authentication) for more details.**
 
 ## Installation
 
-### Via npm
-
-```sh
-npm install openai
-```
-
-### Via yarn
-
-```sh
-yarn add openai
+```bash
+$ npm install openai
 ```
 
 ## Usage
 
-### Initialize OpenAI
-
-```js
-import { OpenAI } from 'openai';
-// or the commonJS way:
-const { OpenAI } = require('openai');
-
-// new OpenAI(apikey: string, organization?: string, version?: string)
-const openai = new OpenAI(process.env.API_KEY, 'my-organization');
-```
-
-### Engine
-
-Get all engines:
-
-```js
-const engines = await openai.getEngines();
-```
-
-Get specific engine:
-
-```js
-const engine = await openai.getEngine('curie');
-```
-
-### Completion
-
-Make a completion:
-
-```js
-const completion = await openai.complete('curie', {
-    prompt: 'Q: Hello\nA:',
-    user: 'user-123'
-});
-```
-
-The options argument(2nd) properties follow the exactly same names as shown on official docs.
-
-Make a completion from a fine-tuned model:
-
-```js
-const completion = await openai.completeFromModel('FINE_TUNED_MODEL', {
-    prompt: 'Q: Hello\nA:'
-});
-```
-
-Make a completion and stream the response:
-
-```js
-const stream = await openai.completeAndStream('curie', { // or completeFromModelAndStream
-    prompt: 'Q: Hello\nA:',
-    user: 'user-123'
-});
-
-stream.pipe(response)
-```
-
-Make a content filter:
-
-```js
-const isSafe = (await openai.contentFilter('hi I am cool')) === 0;
-```
-
-### Search
-
-Make a search:
-
-```js
-const search = await openai.search('curie', {
-    query: 'the president',
-    documents: [
-        'whitehouse',
-        'school',
-        'hospital'
-    ]
-});
-```
-
-The options argument(2nd) properties follow the exactly same names as shown on official docs.
-
-### Classification
+The library needs to be configured with your account's secret key, which is available on the [website](https://beta.openai.com/account/api-keys). We recommend setting it as an environment variable. Here's an example of initializing the library with the API key loaded from an environment variable and creating a completion:
 
-Classify a document:
+```javascript
+const { Configuration, OpenAIApi } = require("openai");
 
-```js
-const classification = await openai.classify({
-    examples: [
-        ['A happy moment', 'Positive'],
-        ['I am sad.', 'Negative'],
-        ['I am feeling awesome', 'Positive']
-    ],
-    labels: ['Positive', 'Negative', 'Neutral'],
-    query: 'It is a raining day :(',
-    search_model: 'ada',
-    model: 'curie'
+const configuration = new Configuration({
+  apiKey: process.env.OPENAI_API_KEY,
 });
-```
-
-The argument properties follow the exactly same names as shown on official docs.
-
-### Answer
-
-Answer a question:
+const openai = new OpenAIApi(configuration);
 
-```js
-const answer = await openai.answer({
-    documents: ['Puppy A is happy.', 'Puppy B is sad.'],
-    question: 'which puppy is happy?',
-    search_model: 'ada',
-    model: 'curie',
-    examples_context: 'In 2017, U.S. life expectancy was 78.6 years.',
-    examples: [['What is human life expectancy in the United States?','78 years.']],
+const completion = await openai.createCompletion("text-davinci-001", {
+  prompt: "Hello world",
 });
+console.log(completion.data.choices[0].text);
 ```
 
-The argument properties follow the exactly same names as shown on official docs.
-
-### File
-
-Get all files:
-
-```js
-const files = await openai.getFiles();
-```
-
-Upload a single file:
-
-```js
-const result = await openai.uploadFile('filename.json', await fs.readFileSync('somefile.json'), 'fine-tune');
-```
-
-Get a single file by id:
-
-```js
-const file = await openai.getFile('file-29u89djwq');
-```
-
-Delete a single file by id:
-
-```js
-await openai.deleteFile('file-29u89djwq');
-```
-
-### Fine-tuning
+Check out the [full API documentation](https://beta.openai.com/docs/api-reference?lang=node.js) for examples of all the available functions.
 
-Fine-tune from a file:
-
-```js
-const result = await openai.finetune({
-    training_file: 'file-29u89djwq'
-});
-```
+### Request options
 
-The argument properties follow the exactly same names as shown on official docs.
+All of the available API request functions additionally contain an optional final parameter where you can pass custom [axios request options](https://axios-http.com/docs/req_config), for example:
 
-Get all fine-tunes:
 
-```js
-const finetunes = await openai.getFinetunes();
+```javascript
+const completion = await openai.createCompletion(
+  "text-davinci-001",
+  {
+    prompt: "Hello world",
+  },
+  {
+    timeout: 1000,
+    headers: {
+      "Example-Header": "example",
+    },
+  }
+);
 ```
 
-Get a specific fine-tune:
-
-```js
-const finetune = await openai.getFinetune('ftjob-AF1WoRqd3aJ');
-```
+### Error handling
 
-Cancel a fine-tune:
+API requests can potentially return errors due to invalid inputs or other issues. These errors can be handled with a `try...catch` statement, and the error details can be found in either `error.response` or `error.message`:
 
-```js
-await openai.cancelFinetune('ftjob-AF1WoRqd3aJ');
+```javascript
+try {
+  const completion = await openai.createCompletion("text-davinci-001", {
+    prompt: "Hello world",
+  });
+  console.log(completion.data.choices[0].text);
+} catch (error) {
+  if (error.response) {
+    console.log(error.response.status);
+    console.log(error.response.data);
+  } else {
+    console.log(error.message);
+  }
+}
 ```
 
-Get fine-tune events of a fine-tune:
+## Thanks
 
-```js
-const events = await openai.getFinetuneEvents('ftjob-AF1WoRqd3aJ');
-```
+Thank you to [ceifa](https://github.com/ceifa) for creating and maintaining the original unofficial `openai` npm package before we released this official library! ceifa's original package has been renamed to [gpt-x](https://www.npmjs.com/package/gpt-x).