openai 1.0.0-next.1 → 1.1.3

package/README.md

@@ -1,204 +1,7 @@
-[![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
 
-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**
-
-## Installation
-
-### Via npm
-
-```sh
-npm install openai
-```
-
-### Via yarn
-
-```sh
-yarn add 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
-
-Classify a document:
-
-```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'
-});
-```
-
-The argument properties follow the exactly same names as shown on official docs.
-
-### Answer
-
-Answer a question:
-
-```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.']],
-});
-```
-
-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
-
-Fine-tune from a file:
-
-```js
-const result = await openai.finetune({
-    training_file: 'file-29u89djwq'
-});
-```
-
-The argument properties follow the exactly same names as shown on official docs.
-
-Get all fine-tunes:
-
-```js
-const finetunes = await openai.getFinetunes();
-```
-
-Get a specific fine-tune:
-
-```js
-const finetune = await openai.getFinetune('ftjob-AF1WoRqd3aJ');
-```
-
-Cancel a fine-tune:
-
-```js
-await openai.cancelFinetune('ftjob-AF1WoRqd3aJ');
-```
+> tl;dr: Please consider using [GPT-X](https://www.npmjs.com/package/gpt-x) instead
 
-Get fine-tune events of a fine-tune:
+This package will be replaced soon by an official one from OpenAI. If you still want to use the unofficial version package, just switch to the new one called [GPT-X](https://www.npmjs.com/package/gpt-x), it will remain the same API for compatibility reasons.
 
-```js
-const events = await openai.getFinetuneEvents('ftjob-AF1WoRqd3aJ');
-```
+Enter in our community about Natural language generation to share and learn about OpenAI, prompt engineering and other providers: https://discord.gg/8ZwcSt9XkD

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export * from './lib.js';
-export * from './types.js';
+export * from './lib.js';
+export * from './types.js';

package/dist/index.js

@@ -1,2 +1,2 @@
-export * from './lib.js';
-export * from './types.js';
+export * from './lib.js';
+export * from './types.js';

package/dist/lib.d.ts

@@ -1,30 +1,31 @@
-/// <reference types="node" />
-import { Answer, AnswerRequest, Classification, ClassificationRequest, Completion, CompletionRequest, ContentLabel, Engine, EngineId, File, FilePurpose, FineTune, FineTuneEvent, FineTuneRequest, JsonLines, SearchDocument, SearchRequest } from './types.js';
-import { Readable } from 'stream';
-export declare class OpenAI {
-    private readonly url;
-    private readonly headers;
-    constructor(apiKey: string, organizationId?: string, version?: string);
-    getEngines(): Promise<Engine[]>;
-    getEngine(engine: EngineId): Promise<Engine>;
-    complete(engine: EngineId, options: CompletionRequest): Promise<Completion>;
-    completeFromModel(fineTunedModel: string, options: CompletionRequest): Promise<Completion>;
-    completeAndStream(engine: EngineId, options: CompletionRequest): Promise<Readable>;
-    completeFromModelAndStream(fineTunedModel: string, options: CompletionRequest): Promise<Readable>;
-    contentFilter(content: string, user?: string): Promise<ContentLabel>;
-    search(engine: EngineId, options: SearchRequest): Promise<SearchDocument[]>;
-    classify(options: ClassificationRequest): Promise<Classification>;
-    answer(options: AnswerRequest): Promise<Answer>;
-    getFiles(): Promise<File[]>;
-    uploadFile(file: string, jsonlines: JsonLines, purpose: FilePurpose): Promise<File>;
-    getFile(fileId: string): Promise<File>;
-    deleteFile(fileId: string): Promise<void>;
-    finetune(options: FineTuneRequest): Promise<FineTune>;
-    getFinetunes(): Promise<FineTune[]>;
-    getFinetune(finetuneId: string): Promise<FineTune>;
-    cancelFinetune(finetuneId: string): Promise<FineTune>;
-    getFinetuneEvents(finetuneId: string): Promise<FineTuneEvent[]>;
-    private requestRaw;
-    private request;
-    private eventStreamTransformer;
-}
+/// <reference types="node" />
+import { Answer, AnswerRequest, Classification, ClassificationRequest, Completion, CompletionRequest, ContentLabel, Embedding, EmbeddingRequest, Engine, EngineId, File, FilePurpose, FineTune, FineTuneEvent, FineTuneRequest, JsonLines, List, SearchDocument, SearchRequest } from './types.js';
+import { Readable } from 'stream';
+export declare class OpenAI {
+    private readonly url;
+    private readonly headers;
+    constructor(apiKey: string, organizationId?: string, version?: string);
+    getEngines(): Promise<Engine[]>;
+    getEngine(engine: EngineId): Promise<Engine>;
+    complete(engine: EngineId, options: CompletionRequest): Promise<Completion>;
+    completeFromModel(fineTunedModel: string, options: CompletionRequest): Promise<Completion>;
+    completeAndStream(engine: EngineId, options: CompletionRequest): Promise<Readable>;
+    completeFromModelAndStream(fineTunedModel: string, options: CompletionRequest): Promise<Readable>;
+    contentFilter(content: string, user?: string): Promise<ContentLabel>;
+    search(engine: EngineId, options: SearchRequest): Promise<SearchDocument[]>;
+    classify(options: ClassificationRequest): Promise<Classification>;
+    answer(options: AnswerRequest): Promise<Answer>;
+    getFiles(): Promise<File[]>;
+    uploadFile(file: string, jsonlines: JsonLines, purpose: FilePurpose): Promise<File>;
+    getFile(fileId: string): Promise<File>;
+    deleteFile(fileId: string): Promise<void>;
+    finetune(options: FineTuneRequest): Promise<FineTune>;
+    getFinetunes(): Promise<FineTune[]>;
+    getFinetune(finetuneId: string): Promise<FineTune>;
+    cancelFinetune(finetuneId: string): Promise<FineTune>;
+    getFinetuneEvents(finetuneId: string): Promise<FineTuneEvent[]>;
+    createEmbedding(engine: EngineId, options: EmbeddingRequest): Promise<List<Embedding>>;
+    private requestRaw;
+    private request;
+    private eventStreamTransformer;
+}

package/dist/lib.js

@@ -1,176 +1,179 @@
-import { ContentLabel, } from './types.js';
-import { Transform } from 'stream';
-import FormData from 'form-data';
-import fetch from 'node-fetch';
-const baseUrl = 'https://api.openai.com';
-const defaultVersion = 'v1';
-export class OpenAI {
-    constructor(apiKey, organizationId, version = defaultVersion) {
-        this.headers = {
-            'authorization': `Bearer ${apiKey}`,
-            'content-type': 'application/json',
-        };
-        if (organizationId) {
-            this.headers['openai-organization'] = organizationId;
-        }
-        this.url = `${baseUrl}/${version}`;
-    }
-    getEngines() {
-        return this.request('/engines', 'GET').then((r) => r.data);
-    }
-    getEngine(engine) {
-        return this.request(`/engines/${engine}`, 'GET');
-    }
-    complete(engine, options) {
-        return this.request(`/engines/${engine}/completions`, 'POST', options);
-    }
-    completeFromModel(fineTunedModel, options) {
-        return this.request(`/completions`, 'POST', { ...options, model: fineTunedModel });
-    }
-    async completeAndStream(engine, options) {
-        const request = await this.requestRaw(`/engines/${engine}/completions`, 'POST', { ...options, stream: true });
-        return request.body.pipe(this.eventStreamTransformer());
-    }
-    async completeFromModelAndStream(fineTunedModel, options) {
-        const request = await this.requestRaw(`/completions`, 'POST', {
-            ...options,
-            model: fineTunedModel,
-            stream: true,
-        });
-        return request.body.pipe(this.eventStreamTransformer());
-    }
-    async contentFilter(content, user) {
-        const completion = await this.complete('content-filter-alpha-c4', {
-            prompt: `<|endoftext|>${content}\n--\nLabel:`,
-            temperature: 0,
-            max_tokens: 1,
-            top_p: 1,
-            frequency_penalty: 0,
-            presence_penalty: 0,
-            logprobs: 10,
-            user,
-        });
-        let label = Number(completion.choices[0].text);
-        if (label === ContentLabel.Unsafe) {
-            const logprobs = completion.choices[0].logprobs?.top_logprobs[0];
-            if (logprobs && logprobs['2'] < -0.355) {
-                if (logprobs['0'] && logprobs['1']) {
-                    label = logprobs['0'] >= logprobs['1'] ? ContentLabel.Safe : ContentLabel.Sensitive;
-                }
-                else if (logprobs['0']) {
-                    label = ContentLabel.Safe;
-                }
-                else if (logprobs['1']) {
-                    label = ContentLabel.Sensitive;
-                }
-            }
-        }
-        if (![0, 1, 2].includes(label)) {
-            label = ContentLabel.Unsafe;
-        }
-        return label;
-    }
-    search(engine, options) {
-        return this.request(`/engines/${engine}/search`, 'POST', options).then((r) => r.data);
-    }
-    classify(options) {
-        return this.request('/classifications', 'POST', options);
-    }
-    answer(options) {
-        return this.request('/answers', 'POST', options);
-    }
-    getFiles() {
-        return this.request('/files', 'GET').then((r) => r.data);
-    }
-    uploadFile(file, jsonlines, purpose) {
-        const data = new FormData();
-        let fileJsonlines;
-        if (Array.isArray(jsonlines)) {
-            if (typeof jsonlines[0] === 'object') {
-                jsonlines = jsonlines.map((j) => JSON.stringify(j));
-            }
-            fileJsonlines = jsonlines.join('\n');
-        }
-        else {
-            fileJsonlines = jsonlines;
-        }
-        data.append('file', fileJsonlines, file);
-        data.append('purpose', purpose);
-        return this.request('/files', 'POST', data);
-    }
-    getFile(fileId) {
-        return this.request(`/files/${fileId}`, 'GET');
-    }
-    deleteFile(fileId) {
-        return this.request(`/files/${fileId}`, 'DELETE');
-    }
-    finetune(options) {
-        return this.request(`/fine-tunes`, 'POST', options);
-    }
-    getFinetunes() {
-        return this.request('/fine-tunes', 'GET').then((r) => r.data);
-    }
-    getFinetune(finetuneId) {
-        return this.request(`/fine-tunes/${finetuneId}`, 'GET');
-    }
-    cancelFinetune(finetuneId) {
-        return this.request(`/fine-tunes/${finetuneId}/cancel`, 'POST');
-    }
-    getFinetuneEvents(finetuneId) {
-        return this.request(`/fine-tunes/${finetuneId}/events`, 'GET').then((r) => r.data);
-    }
-    async requestRaw(path, method, body) {
-        let headers = { ...this.headers };
-        if (body instanceof FormData) {
-            delete headers['content-type'];
-            headers = body.getHeaders(headers);
-        }
-        else if (!['string', 'undefined'].includes(typeof body)) {
-            body = JSON.stringify(body);
-        }
-        const response = await fetch(this.url + path, {
-            headers,
-            method,
-            body: body,
-        });
-        if (!response.ok) {
-            let errorBody;
-            try {
-                const { error: { message }, } = (await response.json());
-                errorBody = message;
-            }
-            catch {
-                try {
-                    errorBody = await response.text();
-                }
-                catch {
-                    errorBody = 'Failed to get body as text';
-                }
-            }
-            throw new Error(`OpenAI did not return ok: ${response.status} ~ Error body: ${errorBody}`);
-        }
-        return response;
-    }
-    async request(path, method, body) {
-        const response = await this.requestRaw(path, method, body);
-        return response.json();
-    }
-    eventStreamTransformer() {
-        const dataHeader = Buffer.from('data: ');
-        return new Transform({
-            transform: function (chunk, _, callback) {
-                if (chunk.length >= dataHeader.length &&
-                    dataHeader.compare(chunk, undefined, dataHeader.length) === 0) {
-                    if (this.prevChunk) {
-                        const completion = JSON.parse(this.prevChunk.toString());
-                        this.push(completion.choices[0].text);
-                        this.prevChunk = undefined;
-                    }
-                    chunk = chunk.slice(dataHeader.length);
-                }
-                this.prevChunk = this.prevChunk ? Buffer.concat([this.prevChunk, chunk]) : chunk;
-                callback();
-            },
-        });
-    }
-}
+import { ContentLabel, } from './types.js';
+import { Transform } from 'stream';
+import FormData from 'form-data';
+import fetch from 'node-fetch';
+const baseUrl = 'https://api.openai.com';
+const defaultVersion = 'v1';
+export class OpenAI {
+    constructor(apiKey, organizationId, version = defaultVersion) {
+        this.headers = {
+            'authorization': `Bearer ${apiKey}`,
+            'content-type': 'application/json',
+        };
+        if (organizationId) {
+            this.headers['openai-organization'] = organizationId;
+        }
+        this.url = `${baseUrl}/${version}`;
+    }
+    getEngines() {
+        return this.request('/engines', 'GET').then((r) => r.data);
+    }
+    getEngine(engine) {
+        return this.request(`/engines/${engine}`, 'GET');
+    }
+    complete(engine, options) {
+        return this.request(`/engines/${engine}/completions`, 'POST', options);
+    }
+    completeFromModel(fineTunedModel, options) {
+        return this.request(`/completions`, 'POST', { ...options, model: fineTunedModel });
+    }
+    async completeAndStream(engine, options) {
+        const request = await this.requestRaw(`/engines/${engine}/completions`, 'POST', { ...options, stream: true });
+        return request.body.pipe(this.eventStreamTransformer());
+    }
+    async completeFromModelAndStream(fineTunedModel, options) {
+        const request = await this.requestRaw(`/completions`, 'POST', {
+            ...options,
+            model: fineTunedModel,
+            stream: true,
+        });
+        return request.body.pipe(this.eventStreamTransformer());
+    }
+    async contentFilter(content, user) {
+        const completion = await this.complete('content-filter-alpha-c4', {
+            prompt: `<|endoftext|>${content}\n--\nLabel:`,
+            temperature: 0,
+            max_tokens: 1,
+            top_p: 1,
+            frequency_penalty: 0,
+            presence_penalty: 0,
+            logprobs: 10,
+            user,
+        });
+        let label = Number(completion.choices[0].text);
+        if (label === ContentLabel.Unsafe) {
+            const logprobs = completion.choices[0].logprobs?.top_logprobs[0];
+            if (logprobs && logprobs['2'] < -0.355) {
+                if (logprobs['0'] && logprobs['1']) {
+                    label = logprobs['0'] >= logprobs['1'] ? ContentLabel.Safe : ContentLabel.Sensitive;
+                }
+                else if (logprobs['0']) {
+                    label = ContentLabel.Safe;
+                }
+                else if (logprobs['1']) {
+                    label = ContentLabel.Sensitive;
+                }
+            }
+        }
+        if (![0, 1, 2].includes(label)) {
+            label = ContentLabel.Unsafe;
+        }
+        return label;
+    }
+    search(engine, options) {
+        return this.request(`/engines/${engine}/search`, 'POST', options).then((r) => r.data);
+    }
+    classify(options) {
+        return this.request('/classifications', 'POST', options);
+    }
+    answer(options) {
+        return this.request('/answers', 'POST', options);
+    }
+    getFiles() {
+        return this.request('/files', 'GET').then((r) => r.data);
+    }
+    uploadFile(file, jsonlines, purpose) {
+        const data = new FormData();
+        let fileJsonlines;
+        if (Array.isArray(jsonlines)) {
+            if (typeof jsonlines[0] === 'object') {
+                jsonlines = jsonlines.map((j) => JSON.stringify(j));
+            }
+            fileJsonlines = jsonlines.join('\n');
+        }
+        else {
+            fileJsonlines = jsonlines;
+        }
+        data.append('file', fileJsonlines, file);
+        data.append('purpose', purpose);
+        return this.request('/files', 'POST', data);
+    }
+    getFile(fileId) {
+        return this.request(`/files/${fileId}`, 'GET');
+    }
+    deleteFile(fileId) {
+        return this.request(`/files/${fileId}`, 'DELETE');
+    }
+    finetune(options) {
+        return this.request(`/fine-tunes`, 'POST', options);
+    }
+    getFinetunes() {
+        return this.request('/fine-tunes', 'GET').then((r) => r.data);
+    }
+    getFinetune(finetuneId) {
+        return this.request(`/fine-tunes/${finetuneId}`, 'GET');
+    }
+    cancelFinetune(finetuneId) {
+        return this.request(`/fine-tunes/${finetuneId}/cancel`, 'POST');
+    }
+    getFinetuneEvents(finetuneId) {
+        return this.request(`/fine-tunes/${finetuneId}/events`, 'GET').then((r) => r.data);
+    }
+    createEmbedding(engine, options) {
+        return this.request(`/engines/${engine}/embeddings`, 'POST', options);
+    }
+    async requestRaw(path, method, body) {
+        let headers = { ...this.headers };
+        if (body instanceof FormData) {
+            delete headers['content-type'];
+            headers = body.getHeaders(headers);
+        }
+        else if (!['string', 'undefined'].includes(typeof body)) {
+            body = JSON.stringify(body);
+        }
+        const response = await fetch(this.url + path, {
+            headers,
+            method,
+            body: body,
+        });
+        if (!response.ok) {
+            let errorBody;
+            try {
+                const { error: { message }, } = (await response.json());
+                errorBody = message;
+            }
+            catch {
+                try {
+                    errorBody = await response.text();
+                }
+                catch {
+                    errorBody = 'Failed to get body as text';
+                }
+            }
+            throw new Error(`OpenAI did not return ok: ${response.status} ~ Error body: ${errorBody}`);
+        }
+        return response;
+    }
+    async request(path, method, body) {
+        const response = await this.requestRaw(path, method, body);
+        return response.json();
+    }
+    eventStreamTransformer() {
+        const dataHeader = Buffer.from('data: ');
+        return new Transform({
+            transform: function (chunk, _, callback) {
+                if (chunk.length >= dataHeader.length &&
+                    dataHeader.compare(chunk, undefined, dataHeader.length) === 0) {
+                    if (this.prevChunk) {
+                        const completion = JSON.parse(this.prevChunk.toString());
+                        this.push(completion.choices[0].text);
+                        this.prevChunk = undefined;
+                    }
+                    chunk = chunk.slice(dataHeader.length);
+                }
+                this.prevChunk = this.prevChunk ? Buffer.concat([this.prevChunk, chunk]) : chunk;
+                callback();
+            },
+        });
+    }
+}

package/dist/types.d.ts

@@ -1,175 +1,186 @@
-export declare type EngineId = 'davinci' | 'curie' | 'babbage' | 'ada' | string;
-export interface Engine {
-    id: EngineId;
-    object: 'engine';
-    created?: Date;
-    max_replicas?: number;
-    owner: string;
-    permissions: unknown;
-    ready: boolean;
-    ready_replicas: unknown;
-    replicas: unknown;
-}
-export interface List<T> {
-    object: 'list';
-    data: T[];
-}
-export interface CompletionRequest {
-    prompt?: string | string[];
-    max_tokens?: number;
-    temperature?: number;
-    top_p?: number;
-    n?: number;
-    logprobs?: number;
-    echo?: boolean;
-    stop?: string | string[];
-    presence_penalty?: number;
-    frequency_penalty?: number;
-    best_of?: number;
-    logit_bias?: Record<string, unknown>;
-    user?: string;
-}
-export interface LogProbs {
-    tokens: string[];
-    token_logprobs: number[];
-    top_logprobs: Array<Record<string, number>>;
-    text_offset: number[];
-}
-export interface Choice {
-    text: string;
-    index: number;
-    logprobs: LogProbs | null;
-    finish_reason: string | null;
-}
-export interface Completion {
-    id: string;
-    object: 'text_completion';
-    created: number;
-    model: string;
-    choices: Choice[];
-}
-export interface SearchRequest {
-    query: string;
-    documents?: string[];
-    file?: string;
-    max_rerank?: number;
-    return_metadata?: boolean;
-}
-export interface SearchDocument {
-    document: number;
-    object: 'search_result';
-    score: number;
-}
-export interface ClassificationRequest {
-    model: string;
-    query: string;
-    examples?: string[];
-    file?: string;
-    labels?: string[] | null;
-    search_model?: string;
-    temperature?: number;
-    logprobs?: number;
-    max_examples?: number;
-    logit_bias?: Record<string, unknown>;
-    return_prompt?: boolean;
-    return_metadata?: boolean;
-    expand?: string[];
-}
-export interface ClassificationExample {
-    document: number;
-    label: string;
-    text: string;
-}
-export interface Classification {
-    completion: string;
-    label: string;
-    model: string;
-    object: 'classification';
-    search_model: string;
-    selected_examples: ClassificationExample[];
-}
-export interface AnswerRequest {
-    model: string;
-    question: string;
-    examples: Array<[string, string]>;
-    examples_context: string;
-    documents?: string[];
-    file?: string;
-    search_model?: string;
-    max_rerank?: number;
-    temperature?: number;
-    logprobs?: number;
-    max_tokens?: number;
-    stop?: string | string[];
-    n?: number;
-    logit_bias?: Record<string, unknown>;
-    return_metadata?: boolean;
-    return_prompt?: boolean;
-    expand?: string[];
-}
-export interface AnswerDocument {
-    document: number;
-    text: string;
-}
-export interface Answer {
-    answers: string[];
-    completion: string | Completion;
-    model: string;
-    object: 'answer';
-    search_model: string;
-    prompt: string;
-    selected_documents: AnswerDocument[];
-}
-export declare type FilePurpose = 'search' | 'answers' | 'classifications' | 'fine-tune';
-export declare type JsonLines = string | string[] | unknown[];
-export interface File {
-    id: string;
-    object: string;
-    bytes: number;
-    created_at: number;
-    filename: string;
-    purpose: FilePurpose;
-}
-export interface Hyperparams {
-    n_epochs?: number;
-    batch_size?: number;
-    learning_rate_multiplier?: number;
-    use_packing?: boolean;
-    prompt_loss_weight?: number;
-}
-export interface FineTuneRequest extends Hyperparams {
-    training_file: string;
-    validation_file?: string;
-    model?: string;
-    compute_classification_metrics?: boolean;
-    classification_n_classes?: number;
-    classification_positive_class?: string;
-    classification_betas?: number[];
-}
-export interface FineTuneEvent {
-    object: 'fine-tune-event';
-    created_at: number;
-    level: string;
-    message: string;
-}
-export interface FineTune {
-    id: string;
-    object: 'fine-tune';
-    model: string;
-    created_at: number;
-    events: FineTuneEvent[];
-    fine_tuned_model: string;
-    hyperparams: Hyperparams;
-    organization_id: string;
-    result_files: File[];
-    status: string;
-    validation_files: File[];
-    training_files: File[];
-    updated_at: number;
-    user_id: string;
-}
-export declare enum ContentLabel {
-    Safe = 0,
-    Sensitive = 1,
-    Unsafe = 2
-}
+declare type LiteralUnion<T extends U, U = string> = T | (U & {});
+export declare type EngineId = LiteralUnion<'davinci' | 'curie' | 'babbage' | 'ada'>;
+export interface Engine {
+    id: EngineId;
+    object: 'engine';
+    created?: Date;
+    max_replicas?: number;
+    owner: string;
+    permissions: unknown;
+    ready: boolean;
+    ready_replicas: unknown;
+    replicas: unknown;
+}
+export interface List<T> {
+    object: 'list';
+    data: T[];
+    model?: string;
+}
+export interface CompletionRequest {
+    prompt?: string | string[];
+    max_tokens?: number;
+    temperature?: number;
+    top_p?: number;
+    n?: number;
+    logprobs?: number;
+    echo?: boolean;
+    stop?: string | string[];
+    presence_penalty?: number;
+    frequency_penalty?: number;
+    best_of?: number;
+    logit_bias?: Record<string, number>;
+    user?: string;
+}
+export interface LogProbs {
+    tokens: string[];
+    token_logprobs: number[];
+    top_logprobs: Array<Record<string, number>>;
+    text_offset: number[];
+}
+export interface Choice {
+    text: string;
+    index: number;
+    logprobs: LogProbs | null;
+    finish_reason: string | null;
+}
+export interface Completion {
+    id: string;
+    object: 'text_completion';
+    created: number;
+    model: string;
+    choices: Choice[];
+}
+export declare enum ContentLabel {
+    Safe = 0,
+    Sensitive = 1,
+    Unsafe = 2
+}
+export interface SearchRequest {
+    query: string;
+    documents?: string[];
+    file?: string;
+    max_rerank?: number;
+    return_metadata?: boolean;
+}
+export interface SearchDocument {
+    document: number;
+    object: 'search_result';
+    score: number;
+}
+export interface ClassificationRequest {
+    model: string;
+    query: string;
+    examples?: string[];
+    file?: string;
+    labels?: string[] | null;
+    search_model?: string;
+    temperature?: number;
+    logprobs?: number;
+    max_examples?: number;
+    logit_bias?: Record<string, number>;
+    return_prompt?: boolean;
+    return_metadata?: boolean;
+    expand?: string[];
+}
+export interface ClassificationExample {
+    document: number;
+    label: string;
+    text: string;
+}
+export interface Classification {
+    completion: string;
+    label: string;
+    model: string;
+    object: 'classification';
+    search_model: string;
+    selected_examples: ClassificationExample[];
+}
+export interface AnswerRequest {
+    model: string;
+    question: string;
+    examples: Array<[string, string]>;
+    examples_context: string;
+    documents?: string[];
+    file?: string;
+    search_model?: string;
+    max_rerank?: number;
+    temperature?: number;
+    logprobs?: number;
+    max_tokens?: number;
+    stop?: string | string[];
+    n?: number;
+    logit_bias?: Record<string, number>;
+    return_metadata?: boolean;
+    return_prompt?: boolean;
+    expand?: string[];
+}
+export interface AnswerDocument {
+    document: number;
+    text: string;
+}
+export interface Answer {
+    answers: string[];
+    completion: string | Completion;
+    model: string;
+    object: 'answer';
+    search_model: string;
+    prompt: string;
+    selected_documents: AnswerDocument[];
+}
+export declare type FilePurpose = 'search' | 'answers' | 'classifications' | 'fine-tune';
+export declare type JsonLines = string | string[] | unknown[];
+export interface File {
+    id: string;
+    object: string;
+    bytes: number;
+    created_at: number;
+    filename: string;
+    purpose: FilePurpose;
+}
+export interface Hyperparams {
+    n_epochs?: number;
+    batch_size?: number;
+    learning_rate_multiplier?: number;
+    use_packing?: boolean;
+    prompt_loss_weight?: number;
+}
+export interface FineTuneRequest extends Hyperparams {
+    training_file: string;
+    validation_file?: string;
+    model?: string;
+    compute_classification_metrics?: boolean;
+    classification_n_classes?: number;
+    classification_positive_class?: string;
+    classification_betas?: number[];
+}
+export interface FineTuneEvent {
+    object: 'fine-tune-event';
+    created_at: number;
+    level: string;
+    message: string;
+}
+export interface FineTune {
+    id: string;
+    object: 'fine-tune';
+    model: string;
+    created_at: number;
+    events: FineTuneEvent[];
+    fine_tuned_model: string;
+    hyperparams: Hyperparams;
+    organization_id: string;
+    result_files: File[];
+    status: string;
+    validation_files: File[];
+    training_files: File[];
+    updated_at: number;
+    user_id: string;
+}
+export interface EmbeddingRequest {
+    input: string | string[];
+}
+export interface Embedding {
+    object: 'embedding';
+    embedding: number[];
+    index: number;
+}
+export {};

package/dist/types.js

@@ -1,6 +1,6 @@
-export var ContentLabel;
-(function (ContentLabel) {
-    ContentLabel[ContentLabel["Safe"] = 0] = "Safe";
-    ContentLabel[ContentLabel["Sensitive"] = 1] = "Sensitive";
-    ContentLabel[ContentLabel["Unsafe"] = 2] = "Unsafe";
-})(ContentLabel || (ContentLabel = {}));
+export var ContentLabel;
+(function (ContentLabel) {
+    ContentLabel[ContentLabel["Safe"] = 0] = "Safe";
+    ContentLabel[ContentLabel["Sensitive"] = 1] = "Sensitive";
+    ContentLabel[ContentLabel["Unsafe"] = 2] = "Unsafe";
+})(ContentLabel || (ContentLabel = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "openai",
-    "version": "1.0.0-next.1",
+    "version": "1.1.3",
     "description": "Tiny OpenAI API wrapper",
     "type": "module",
     "main": "dist/index.js",
@@ -9,7 +9,8 @@
         "build": "tsc -d",
         "clean": "rm -rf dist",
         "lint": "eslint . --fix --cache && prettier --write src",
-        "lint:nofix": "eslint . && prettier --check src"
+        "lint:nofix": "eslint . && prettier --check src",
+        "postinstall": "node ./postinstall.js"
     },
     "repository": {
         "type": "git",
@@ -20,25 +21,27 @@
     "keywords": [
         "gpt-3",
         "gpt",
-        "ai"
+        "ai",
+        "openai"
     ],
     "bugs": {
         "url": "https://github.com/ceifa/openai/issues"
     },
     "homepage": "https://github.com/ceifa/openai#readme",
     "devDependencies": {
-        "@types/node": "16.10.9",
-        "@typescript-eslint/eslint-plugin": "5.0.0",
-        "@typescript-eslint/parser": "5.0.0",
-        "eslint": "8.0.1",
+        "@types/node": "16.11.11",
+        "@typescript-eslint/eslint-plugin": "5.5.0",
+        "@typescript-eslint/parser": "5.5.0",
+        "eslint": "8.3.0",
         "eslint-config-prettier": "8.3.0",
         "eslint-plugin-prettier": "4.0.0",
         "eslint-plugin-sort-imports-es6-autofix": "0.6.0",
-        "prettier": "2.4.1",
-        "typescript": "4.4.4"
+        "prettier": "2.5.0",
+        "typescript": "4.5.2"
     },
     "dependencies": {
         "form-data": "4.0.0",
-        "node-fetch": "3.0.0"
+        "node-fetch": "3.1.0",
+        "openai": "^1.1.2"
     }
 }

package/postinstall.js

@@ -0,0 +1 @@
+console.log(`\u001b[0m\u001b[96mEnter in our community about Natural language generation to share and learn about OpenAI, prompt engineering and other providers: \u001b[94mhttps://discord.gg/8ZwcSt9XkD\u001b[0m\u001b[22m\u001b[39m`);