openai 0.0.9 → 1.0.0

package/README.md

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

package/dist/index.d.ts

@@ -10,7 +10,8 @@ export declare class OpenAI {
     getEngine(engine: EngineId): Promise<Engine>;
     complete(engine: EngineId, options: CompletionRequest): Promise<Completion>;
     completeFromModel(fineTunedModel: string, options: CompletionRequest): Promise<Completion>;
-    completionTextStream(engine: EngineId, options: CompletionRequest): Promise<Readable>;
+    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>;
@@ -26,4 +27,5 @@ export declare class OpenAI {
     getFinetuneEvents(finetuneId: string): Promise<FineTuneEvent[]>;
     private requestRaw;
     private request;
+    private eventStreamTransformer;
 }

package/dist/index.js

@@ -42,25 +42,17 @@
         completeFromModel(fineTunedModel, options) {
             return this.request(`/completions`, 'POST', { ...options, model: fineTunedModel });
         }
-        async completionTextStream(engine, options) {
+        async completeAndStream(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(this.eventStreamTransformer());
+        }
+        async completeFromModelAndStream(fineTunedModel, options) {
+            const request = await this.requestRaw(`/completions`, 'POST', {
+                ...options,
+                model: fineTunedModel,
+                stream: true,
             });
-            return request.body.pipe(transform);
+            return request.body.pipe(this.eventStreamTransformer());
         }
         async contentFilter(content, user) {
             const completion = await this.complete('content-filter-alpha-c4', {
@@ -159,10 +151,16 @@
             if (!response.ok) {
                 let errorBody;
                 try {
-                    errorBody = await response.text();
+                    const { error: { message }, } = await response.json();
+                    errorBody = message;
                 }
                 catch {
-                    errorBody = 'Failed to get body as text';
+                    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}`);
             }
@@ -172,6 +170,24 @@
             const response = await this.requestRaw(path, method, body);
             return response.json();
         }
+        eventStreamTransformer() {
+            const dataHeader = Buffer.from('data: ');
+            return new stream_1.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();
+                },
+            });
+        }
     }
     exports.OpenAI = OpenAI;
 });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "openai",
-    "version": "0.0.9",
+    "version": "1.0.0",
     "description": "Tiny OpenAI API wrapper",
     "main": "dist/index.js",
     "scripts": {