@proteinjs/conversation 1.5.1 → 1.6.0

package/dist/src/OpenAiStreamProcessor.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="node" />
+import { ChatCompletionMessageToolCall, ChatCompletionChunk } from 'openai/resources/chat';
+import { LogLevel } from '@proteinjs/util';
+import { Stream } from 'openai/streaming';
+import { Readable } from 'stream';
+/**
+ * Processes streaming responses from OpenAI's `ChatCompletions` api.
+ *   - When a tool call is received, it delegates processing to `onToolCalls`; this can happen recursively
+ *   - When a response to the user is received, it writes to `outputStream`
+ */
+export declare class OpenAiStreamProcessor {
+    private onToolCalls;
+    private logger;
+    private accumulatedToolCalls;
+    private toolCallsExecuted;
+    private currentToolCall;
+    private inputStream;
+    private controlStream;
+    private outputStream;
+    constructor(inputStream: Stream<ChatCompletionChunk>, onToolCalls: (toolCalls: ChatCompletionMessageToolCall[], currentFunctionCalls: number) => Promise<Readable>, logLevel: LogLevel);
+    /**
+     * @returns a `Readable` stream that will receive the assistant's text response to the user
+     */
+    getOutputStream(): Readable;
+    /**
+     * @returns a `Transform` that parses the input stream and delegates to tool calls or writes a text response to the user
+     */
+    private createControlStream;
+    /**
+     * Destroy all streams used by `OpenAiStreamProcessor`
+     */
+    private destroyStreams;
+    /**
+     * Accumulates tool call deltas into complete tool calls.
+     * @param toolCallDeltas `ChatCompletionChunk.Choice.Delta.ToolCall` objects that contain part of a complete `ChatCompletionMessageToolCall`
+     */
+    private handleToolCallDelta;
+    /**
+     * Delegates `ChatCompletionMessageToolCall`s to `onToolCalls`.
+     *   - Manages refreshing the `inputStream` and `controlStream`
+     *   - Manages tool call state (such as keeping track of the number of tool calls made)
+     */
+    private handleToolCalls;
+}
+//# sourceMappingURL=OpenAiStreamProcessor.d.ts.map

package/dist/src/OpenAiStreamProcessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAiStreamProcessor.d.ts","sourceRoot":"","sources":["../../src/OpenAiStreamProcessor.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,6BAA6B,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAU,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAA6C,MAAM,QAAQ,CAAC;AAE7E;;;;GAIG;AACH,qBAAa,qBAAqB;IAW9B,OAAO,CAAC,WAAW;IAVrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,oBAAoB,CAAgD;IAC5E,OAAO,CAAC,iBAAiB,CAAK;IAC9B,OAAO,CAAC,eAAe,CAAuD;IAC9E,OAAO,CAAC,WAAW,CAAW;IAC9B,OAAO,CAAC,aAAa,CAAY;IACjC,OAAO,CAAC,YAAY,CAAW;gBAG7B,WAAW,EAAE,MAAM,CAAC,mBAAmB,CAAC,EAChC,WAAW,EAAE,CACnB,SAAS,EAAE,6BAA6B,EAAE,EAC1C,oBAAoB,EAAE,MAAM,KACzB,OAAO,CAAC,QAAQ,CAAC,EACtB,QAAQ,EAAE,QAAQ;IASpB;;OAEG;IACH,eAAe,IAAI,QAAQ;IAI3B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAwC3B;;OAEG;IACH,OAAO,CAAC,cAAc;IAOtB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IA2B3B;;;;OAIG;YACW,eAAe;CA0B9B"}

package/dist/src/OpenAiStreamProcessor.js

@@ -0,0 +1,205 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAiStreamProcessor = void 0;
+var util_1 = require("@proteinjs/util");
+var stream_1 = require("stream");
+/**
+ * Processes streaming responses from OpenAI's `ChatCompletions` api.
+ *   - When a tool call is received, it delegates processing to `onToolCalls`; this can happen recursively
+ *   - When a response to the user is received, it writes to `outputStream`
+ */
+var OpenAiStreamProcessor = /** @class */ (function () {
+    function OpenAiStreamProcessor(inputStream, onToolCalls, logLevel) {
+        this.onToolCalls = onToolCalls;
+        this.accumulatedToolCalls = [];
+        this.toolCallsExecuted = 0;
+        this.currentToolCall = null;
+        this.logger = new util_1.Logger(this.constructor.name, logLevel);
+        this.inputStream = stream_1.Readable.from(inputStream);
+        this.controlStream = this.createControlStream();
+        this.outputStream = new stream_1.PassThrough();
+        this.inputStream.pipe(this.controlStream);
+    }
+    /**
+     * @returns a `Readable` stream that will receive the assistant's text response to the user
+     */
+    OpenAiStreamProcessor.prototype.getOutputStream = function () {
+        return this.outputStream;
+    };
+    /**
+     * @returns a `Transform` that parses the input stream and delegates to tool calls or writes a text response to the user
+     */
+    OpenAiStreamProcessor.prototype.createControlStream = function () {
+        var _this = this;
+        return new stream_1.Transform({
+            objectMode: true,
+            transform: function (chunk, encoding, callback) {
+                var _a, _b, _c, _d, _e, _f, _g, _h;
+                try {
+                    if (_this.outputStream.destroyed) {
+                        _this.logger.warn("Destroying input and control streams since output stream is destroyed");
+                        _this.inputStream.destroy();
+                        _this.controlStream.destroy();
+                        return;
+                    }
+                    if (!chunk || !chunk.choices) {
+                        throw new Error("Received invalid chunk:\n".concat(JSON.stringify(chunk, null, 2)));
+                    }
+                    else if (typeof ((_b = (_a = chunk.choices[0]) === null || _a === void 0 ? void 0 : _a.delta) === null || _b === void 0 ? void 0 : _b.content) === 'string') {
+                        _this.outputStream.push(chunk.choices[0].delta.content);
+                    }
+                    else if ((_d = (_c = chunk.choices[0]) === null || _c === void 0 ? void 0 : _c.delta) === null || _d === void 0 ? void 0 : _d.tool_calls) {
+                        _this.handleToolCallDelta(chunk.choices[0].delta.tool_calls);
+                    }
+                    else if (((_e = chunk.choices[0]) === null || _e === void 0 ? void 0 : _e.finish_reason) === 'tool_calls') {
+                        _this.handleToolCalls();
+                    }
+                    else if (((_f = chunk.choices[0]) === null || _f === void 0 ? void 0 : _f.finish_reason) === 'stop') {
+                        _this.outputStream.push(null);
+                    }
+                    else if (((_g = chunk.choices[0]) === null || _g === void 0 ? void 0 : _g.finish_reason) === 'length') {
+                        _this.logger.warn("The maximum number of tokens specified in the request was reached");
+                        _this.outputStream.push(null);
+                    }
+                    else if (((_h = chunk.choices[0]) === null || _h === void 0 ? void 0 : _h.finish_reason) === 'content_filter') {
+                        _this.logger.error("Content was omitted due to a flag from OpenAI's content filters");
+                        _this.outputStream.push(null);
+                    }
+                    else {
+                        throw new Error("Received invalid finish reason or delta:\n".concat(JSON.stringify(chunk, null, 2)));
+                    }
+                    callback();
+                }
+                catch (error) {
+                    _this.logger.error('Error tranforming chunk', error);
+                    _this.destroyStreams(error);
+                }
+            },
+        });
+    };
+    /**
+     * Destroy all streams used by `OpenAiStreamProcessor`
+     */
+    OpenAiStreamProcessor.prototype.destroyStreams = function (error) {
+        this.inputStream.destroy();
+        this.controlStream.destroy();
+        this.outputStream.emit('error', error);
+        this.outputStream.destroy();
+    };
+    /**
+     * Accumulates tool call deltas into complete tool calls.
+     * @param toolCallDeltas `ChatCompletionChunk.Choice.Delta.ToolCall` objects that contain part of a complete `ChatCompletionMessageToolCall`
+     */
+    OpenAiStreamProcessor.prototype.handleToolCallDelta = function (toolCallDeltas) {
+        var _a, _b, _c, _d;
+        for (var _i = 0, toolCallDeltas_1 = toolCallDeltas; _i < toolCallDeltas_1.length; _i++) {
+            var delta = toolCallDeltas_1[_i];
+            if (delta.id) {
+                // Start of a new tool call
+                if (this.currentToolCall) {
+                    this.accumulatedToolCalls.push(this.currentToolCall);
+                }
+                this.currentToolCall = {
+                    id: delta.id,
+                    type: delta.type || 'function',
+                    function: {
+                        name: ((_a = delta.function) === null || _a === void 0 ? void 0 : _a.name) || '',
+                        arguments: ((_b = delta.function) === null || _b === void 0 ? void 0 : _b.arguments) || '',
+                    },
+                };
+            }
+            else {
+                // Continue building the current tool call
+                if ((_c = delta.function) === null || _c === void 0 ? void 0 : _c.name) {
+                    this.currentToolCall.function.name += delta.function.name;
+                }
+                if ((_d = delta.function) === null || _d === void 0 ? void 0 : _d.arguments) {
+                    this.currentToolCall.function.arguments += delta.function.arguments;
+                }
+            }
+        }
+    };
+    /**
+     * Delegates `ChatCompletionMessageToolCall`s to `onToolCalls`.
+     *   - Manages refreshing the `inputStream` and `controlStream`
+     *   - Manages tool call state (such as keeping track of the number of tool calls made)
+     */
+    OpenAiStreamProcessor.prototype.handleToolCalls = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var completedToolCalls, _a, error_1;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (this.currentToolCall) {
+                            this.accumulatedToolCalls.push(this.currentToolCall);
+                            this.currentToolCall = null;
+                        }
+                        completedToolCalls = this.accumulatedToolCalls.filter(function (tc) {
+                            return tc.id !== undefined && tc.function !== undefined && tc.type !== undefined;
+                        });
+                        this.accumulatedToolCalls = [];
+                        this.inputStream.destroy();
+                        this.controlStream.destroy();
+                        this.controlStream = this.createControlStream();
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 3, , 4]);
+                        _a = this;
+                        return [4 /*yield*/, this.onToolCalls(completedToolCalls, this.toolCallsExecuted)];
+                    case 2:
+                        _a.inputStream = _b.sent();
+                        this.inputStream.on('error', function (error) { return _this.destroyStreams(error); });
+                        this.inputStream.pipe(this.controlStream);
+                        this.toolCallsExecuted += completedToolCalls.length;
+                        return [3 /*break*/, 4];
+                    case 3:
+                        error_1 = _b.sent();
+                        this.logger.error('Error processing tool calls:', error_1);
+                        this.destroyStreams(error_1);
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return OpenAiStreamProcessor;
+}());
+exports.OpenAiStreamProcessor = OpenAiStreamProcessor;
+//# sourceMappingURL=OpenAiStreamProcessor.js.map

package/dist/src/OpenAiStreamProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAiStreamProcessor.js","sourceRoot":"","sources":["../../src/OpenAiStreamProcessor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,wCAAmD;AAEnD,iCAA6E;AAE7E;;;;GAIG;AACH;IASE,+BACE,WAAwC,EAChC,WAGc,EACtB,QAAkB;QAJV,gBAAW,GAAX,WAAW,CAGG;QAZhB,yBAAoB,GAA6C,EAAE,CAAC;QACpE,sBAAiB,GAAG,CAAC,CAAC;QACtB,oBAAe,GAAkD,IAAI,CAAC;QAa5E,IAAI,CAAC,MAAM,GAAG,IAAI,aAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,iBAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAChD,IAAI,CAAC,YAAY,GAAG,IAAI,oBAAW,EAAE,CAAC;QACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,+CAAe,GAAf;QACE,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACK,mDAAmB,GAA3B;QAAA,iBAsCC;QArCC,OAAO,IAAI,kBAAS,CAAC;YACnB,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,UAAC,KAA0B,EAAE,QAAgB,EAAE,QAA2B;;gBACnF,IAAI;oBACF,IAAI,KAAI,CAAC,YAAY,CAAC,SAAS,EAAE;wBAC/B,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uEAAuE,CAAC,CAAC;wBAC1F,KAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;wBAC3B,KAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;wBAC7B,OAAO;qBACR;oBAED,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;wBAC5B,MAAM,IAAI,KAAK,CAAC,mCAA4B,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAE,CAAC,CAAC;qBAC/E;yBAAM,IAAI,OAAO,CAAA,MAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,KAAK,0CAAE,OAAO,CAAA,KAAK,QAAQ,EAAE;wBAC/D,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;qBACxD;yBAAM,IAAI,MAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,KAAK,0CAAE,UAAU,EAAE;wBAC9C,KAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;qBAC7D;yBAAM,IAAI,CAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,aAAa,MAAK,YAAY,EAAE;wBAC3D,KAAI,CAAC,eAAe,EAAE,CAAC;qBACxB;yBAAM,IAAI,CAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,aAAa,MAAK,MAAM,EAAE;wBACrD,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;qBAC9B;yBAAM,IAAI,CAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,aAAa,MAAK,QAAQ,EAAE;wBACvD,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;wBACtF,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;qBAC9B;yBAAM,IAAI,CAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,aAAa,MAAK,gBAAgB,EAAE;wBAC/D,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;wBACrF,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;qBAC9B;yBAAM;wBACL,MAAM,IAAI,KAAK,CAAC,oDAA6C,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAE,CAAC,CAAC;qBAChG;oBACD,QAAQ,EAAE,CAAC;iBACZ;gBAAC,OAAO,KAAU,EAAE;oBACnB,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;oBACpD,KAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;iBAC5B;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,8CAAc,GAAtB,UAAuB,KAAa;QAClC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAC3B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACK,mDAAmB,GAA3B,UAA4B,cAA2D;;QACrF,KAAoB,UAAc,EAAd,iCAAc,EAAd,4BAAc,EAAd,IAAc,EAAE;YAA/B,IAAM,KAAK,uBAAA;YACd,IAAI,KAAK,CAAC,EAAE,EAAE;gBACZ,2BAA2B;gBAC3B,IAAI,IAAI,CAAC,eAAe,EAAE;oBACxB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;iBACtD;gBACD,IAAI,CAAC,eAAe,GAAG;oBACrB,EAAE,EAAE,KAAK,CAAC,EAAE;oBACZ,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,UAAU;oBAC9B,QAAQ,EAAE;wBACR,IAAI,EAAE,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI,KAAI,EAAE;wBAChC,SAAS,EAAE,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,SAAS,KAAI,EAAE;qBAC3C;iBACF,CAAC;aACH;iBAAM;gBACL,0CAA0C;gBAC1C,IAAI,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI,EAAE;oBACxB,IAAI,CAAC,eAAgB,CAAC,QAAS,CAAC,IAAI,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;iBAC7D;gBACD,IAAI,MAAA,KAAK,CAAC,QAAQ,0CAAE,SAAS,EAAE;oBAC7B,IAAI,CAAC,eAAgB,CAAC,QAAS,CAAC,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;iBACvE;aACF;SACF;IACH,CAAC;IAED;;;;OAIG;IACW,+CAAe,GAA7B;;;;;;;wBACE,IAAI,IAAI,CAAC,eAAe,EAAE;4BACxB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;4BACrD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;yBAC7B;wBAEK,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CACzD,UAAC,EAAE;4BACD,OAAA,EAAE,CAAC,EAAE,KAAK,SAAS,IAAI,EAAE,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,CAAC,IAAI,KAAK,SAAS;wBAAzE,CAAyE,CAC5E,CAAC;wBAEF,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;wBAC/B,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;wBAC3B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;wBAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;;;;wBAG9C,KAAA,IAAI,CAAA;wBAAe,qBAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,IAAI,CAAC,iBAAiB,CAAC,EAAA;;wBAArF,GAAK,WAAW,GAAG,SAAkE,CAAC;wBACtF,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,KAAK,IAAK,OAAA,KAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAA1B,CAA0B,CAAC,CAAC;wBACpE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;wBAC1C,IAAI,CAAC,iBAAiB,IAAI,kBAAkB,CAAC,MAAM,CAAC;;;;wBAEpD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,OAAK,CAAC,CAAC;wBACzD,IAAI,CAAC,cAAc,CAAC,OAAK,CAAC,CAAC;;;;;;KAE9B;IACH,4BAAC;AAAD,CAAC,AAlJD,IAkJC;AAlJY,sDAAqB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteinjs/conversation",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -35,5 +35,6 @@
     "readline-sync": "1.4.10",
     "tiktoken": "1.0.15",
     "typescript": "5.2.2"
-  }
-}
+  },
+  "gitHead": "68361629fee0eb5cca527a87c9479fbc85cecf3c"
+}

package/src/Conversation.ts

@@ -58,8 +58,13 @@ export class Conversation {
         continue;
       }
 
+      const moduleSystemMessages = module.getSystemMessages();
+      const formattedSystemMessages = Array.isArray(moduleSystemMessages)
+        ? moduleSystemMessages.join('. ')
+        : moduleSystemMessages;
+
       this.addSystemMessagesToHistory([
-        `The following are instructions from the ${module.getName()} module: ${module.getSystemMessages().join('. ')}`,
+        `The following are instructions from the ${module.getName()} module: ${formattedSystemMessages}`,
       ]);
       this.addFunctions(module.getName(), module.getFunctions());
       this.addMessageModerators(module.getMessageModerators());
@@ -204,6 +209,18 @@ export class Conversation {
     );
   }
 
+  async generateStreamingResponse(messages: (string | ChatCompletionMessageParam)[], model?: TiktokenModel) {
+    await this.enforceTokenLimit(messages, model);
+    return await OpenAi.generateStreamingResponse(
+      messages,
+      model,
+      this.history,
+      this.functions,
+      this.messageModerators,
+      this.params.logLevel
+    );
+  }
+
   async generateCode(description: string[], model?: TiktokenModel) {
     this.logger.info(`Generating code for description:\n${description.join('\n')}`);
     const code = await OpenAi.generateCode(

package/src/ConversationModule.ts

@@ -3,7 +3,8 @@ import { MessageModerator } from './history/MessageModerator';
 
 export interface ConversationModule {
   getName(): string;
-  getSystemMessages(): string[];
+  /** Return array of strings that will be formatted with periods in between or return a preformatted string */
+  getSystemMessages(): string[] | string;
   getFunctions(): Function[];
   getMessageModerators(): MessageModerator[];
 }