openai 0.0.8 → 1.1.0

package/README.md

@@ -1,3 +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).
@@ -58,12 +62,18 @@ const completion = await openai.complete('curie', {
 
 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
-// Very experimental! Don't use on production!!!
-// This API may change at any time
-const stream = await openai.completionTextStream('curie', {
+const stream = await openai.completeAndStream('curie', { // or completeFromModelAndStream
     prompt: 'Q: Hello\nA:',
     user: 'user-123'
 });
@@ -191,4 +201,4 @@ Get fine-tune events of a fine-tune:
 
 ```js
 const events = await openai.getFinetuneEvents('ftjob-AF1WoRqd3aJ');
-```
+```

package/dist/index.d.ts

@@ -1,27 +1,2 @@
-/// <reference types="node" />
-import { Answer, AnswerRequest, Classification, ClassificationRequest, Completion, CompletionRequest, ContentLabel, Engine, EngineId, File, FilePurpose, FineTune, FineTuneEvent, FineTuneRequest, JsonLines, SearchDocument, SearchRequest } from './types';
-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>;
-    completionTextStream(engine: EngineId, 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;
-}
+export * from './lib.js';
+export * from './types.js';

package/dist/index.js

@@ -1,173 +1,2 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "tslib", "stream", "form-data", "node-fetch"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    exports.OpenAI = void 0;
-    const tslib_1 = require("tslib");
-    const stream_1 = require("stream");
-    const form_data_1 = tslib_1.__importDefault(require("form-data"));
-    const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
-    const baseUrl = 'https://api.openai.com';
-    const defaultVersion = 'v1';
-    class OpenAI {
-        url;
-        headers;
-        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);
-        }
-        async completionTextStream(engine, options) {
-            const request = await this.requestRaw(`/engines/${engine}/completions`, 'POST', { ...options, stream: true });
-            console.warn("Stream completion is an experimental feature, don't use on production");
-            const transform = new stream_1.Transform({
-                transform: (chunk, _, callback) => {
-                    const body = chunk.slice(6).toString().trim();
-                    if (body && body[0] !== '[') {
-                        try {
-                            const completion = JSON.parse(body);
-                            return callback(undefined, completion.choices[0].text);
-                        }
-                        catch (e) {
-                            throw new Error(`Faile to parse: "${chunk.toString()}"`);
-                        }
-                    }
-                    callback();
-                },
-            });
-            return request.body.pipe(transform);
-        }
-        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 === 2) {
-                const logprobs = completion.choices[0].logprobs.top_logprobs[0];
-                if (logprobs['2'] < -0.355) {
-                    if (logprobs['0'] && logprobs['1']) {
-                        label = logprobs['0'] >= logprobs['1'] ? 0 : 1;
-                    }
-                    else if (logprobs['0']) {
-                        label = 0;
-                    }
-                    else if (logprobs['1']) {
-                        label = 1;
-                    }
-                }
-            }
-            if (![0, 1, 2].includes(label)) {
-                label = 2;
-            }
-            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 form_data_1.default();
-            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 form_data_1.default) {
-                delete headers['content-type'];
-                headers = body.getHeaders(headers);
-            }
-            else if (!['string', 'undefined'].includes(typeof body)) {
-                body = JSON.stringify(body);
-            }
-            const response = await node_fetch_1.default(this.url + path, {
-                headers,
-                method,
-                body: body,
-            });
-            if (!response.ok) {
-                let errorBody;
-                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();
-        }
-    }
-    exports.OpenAI = OpenAI;
-});
+export * from './lib.js';
+export * from './types.js';

package/dist/lib.d.ts

@@ -0,0 +1,31 @@
+/// <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

@@ -0,0 +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);
+    }
+    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

@@ -13,6 +13,7 @@ export interface Engine {
 export interface List<T> {
     object: 'list';
     data: T[];
+    model?: string;
 }
 export interface CompletionRequest {
     prompt?: string | string[];
@@ -38,7 +39,7 @@ export interface LogProbs {
 export interface Choice {
     text: string;
     index: number;
-    logprobs: LogProbs;
+    logprobs: LogProbs | null;
     finish_reason: string | null;
 }
 export interface Completion {
@@ -48,6 +49,11 @@ export interface Completion {
     model: string;
     choices: Choice[];
 }
+export declare enum ContentLabel {
+    Safe = 0,
+    Sensitive = 1,
+    Unsafe = 2
+}
 export interface SearchRequest {
     query: string;
     documents?: string[];
@@ -168,8 +174,11 @@ export interface FineTune {
     updated_at: number;
     user_id: string;
 }
-export declare const enum ContentLabel {
-    Safe = 0,
-    Sensitive = 1,
-    Unsafe = 2
+export interface EmbeddingRequest {
+    input: string | string[];
+}
+export interface Embedding {
+    object: 'embedding';
+    embedding: number[];
+    index: number;
 }

package/dist/types.js

@@ -1,12 +1,6 @@
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-});
+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,7 +1,8 @@
 {
     "name": "openai",
-    "version": "0.0.8",
+    "version": "1.1.0",
     "description": "Tiny OpenAI API wrapper",
+    "type": "module",
     "main": "dist/index.js",
     "scripts": {
         "start": "tsc -d --watch",
@@ -26,20 +27,18 @@
     },
     "homepage": "https://github.com/ceifa/openai#readme",
     "devDependencies": {
-        "@types/node": "16.7.0",
-        "@types/node-fetch": "2.5.12",
-        "@typescript-eslint/eslint-plugin": "4.29.2",
-        "@typescript-eslint/parser": "4.29.2",
-        "eslint": "7.32.0",
+        "@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": "3.4.0",
+        "eslint-plugin-prettier": "4.0.0",
         "eslint-plugin-sort-imports-es6-autofix": "0.6.0",
-        "prettier": "2.3.2",
-        "typescript": "4.3.5"
+        "prettier": "2.5.0",
+        "typescript": "4.5.2"
     },
     "dependencies": {
         "form-data": "4.0.0",
-        "node-fetch": "2.6.1",
-        "tslib": "2.3.1"
+        "node-fetch": "3.1.0"
     }
 }