@proteinjs/conversation 1.7.1 → 1.7.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/LICENSE +21 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/src/OpenAiStreamProcessor.d.ts +6 -1
- package/dist/src/OpenAiStreamProcessor.d.ts.map +1 -1
- package/dist/src/OpenAiStreamProcessor.js +15 -6
- package/dist/src/OpenAiStreamProcessor.js.map +1 -1
- package/index.ts +1 -0
- package/package.json +4 -3
- package/src/OpenAiStreamProcessor.ts +21 -7
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,25 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.7.3](https://github.com/proteinjs/conversation/compare/@proteinjs/conversation@1.7.2...@proteinjs/conversation@1.7.3) (2024-08-07)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @proteinjs/conversation
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## [1.7.2](https://github.com/proteinjs/conversation/compare/@proteinjs/conversation@1.7.1...@proteinjs/conversation@1.7.2) (2024-08-06)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Bug Fixes
|
|
18
|
+
|
|
19
|
+
* making sure all streams get destroyed in all input stream end scenarios ([ab2da7d](https://github.com/proteinjs/conversation/commit/ab2da7dfbc42a0bccae73db9ab49da8c1a01b61b))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
6
25
|
# [1.7.0](https://github.com/proteinjs/conversation/compare/@proteinjs/conversation@1.6.1...@proteinjs/conversation@1.7.0) (2024-08-05)
|
|
7
26
|
|
|
8
27
|
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Brent Bahry
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.d.ts
CHANGED
|
@@ -10,4 +10,5 @@ export * from './src/Function';
|
|
|
10
10
|
export * from './src/history/MessageModerator';
|
|
11
11
|
export * from './src/history/MessageHistory';
|
|
12
12
|
export * from './src/ChatCompletionMessageParamFactory';
|
|
13
|
+
export { AssistantResponseStreamChunk } from './src/OpenAiStreamProcessor';
|
|
13
14
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC"}
|
|
@@ -3,6 +3,10 @@ import { ChatCompletionMessageToolCall, ChatCompletionChunk } from 'openai/resou
|
|
|
3
3
|
import { LogLevel } from '@proteinjs/util';
|
|
4
4
|
import { Stream } from 'openai/streaming';
|
|
5
5
|
import { Readable } from 'stream';
|
|
6
|
+
export interface AssistantResponseStreamChunk {
|
|
7
|
+
content?: string;
|
|
8
|
+
finishReason?: string;
|
|
9
|
+
}
|
|
6
10
|
/**
|
|
7
11
|
* Processes streaming responses from OpenAI's `ChatCompletions` api.
|
|
8
12
|
* - When a tool call is received, it delegates processing to `onToolCalls`; this can happen recursively
|
|
@@ -20,7 +24,8 @@ export declare class OpenAiStreamProcessor {
|
|
|
20
24
|
private outputStream;
|
|
21
25
|
constructor(inputStream: Stream<ChatCompletionChunk>, onToolCalls: (toolCalls: ChatCompletionMessageToolCall[], currentFunctionCalls: number) => Promise<Readable>, logLevel: LogLevel, abortSignal?: AbortSignal | undefined);
|
|
22
26
|
/**
|
|
23
|
-
* @returns a `Readable` stream that will receive the assistant's text response to the user
|
|
27
|
+
* @returns a `Readable` stream, in object mode, that will receive the assistant's text response to the user.
|
|
28
|
+
* The object chunks written to the stream will be of type `AssistantResponseStreamChunk`.
|
|
24
29
|
*/
|
|
25
30
|
getOutputStream(): Readable;
|
|
26
31
|
/**
|
|
@@ -1 +1 @@
|
|
|
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;IAKnB,OAAO,CAAC,WAAW,CAAC;IAftB,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,EACV,WAAW,CAAC,yBAAa;IASnC
|
|
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,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,qBAAqB;IAW9B,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,WAAW,CAAC;IAftB,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,EACV,WAAW,CAAC,yBAAa;IASnC;;;OAGG;IACH,eAAe,IAAI,QAAQ;IAI3B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IA4C3B;;OAEG;IACH,OAAO,CAAC,cAAc;IAStB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IA2B3B;;;;OAIG;YACW,eAAe;CA4B9B"}
|
|
@@ -54,11 +54,12 @@ var OpenAiStreamProcessor = /** @class */ (function () {
|
|
|
54
54
|
this.logger = new util_1.Logger(this.constructor.name, logLevel);
|
|
55
55
|
this.inputStream = stream_1.Readable.from(inputStream);
|
|
56
56
|
this.controlStream = this.createControlStream();
|
|
57
|
-
this.outputStream = new stream_1.PassThrough();
|
|
57
|
+
this.outputStream = new stream_1.PassThrough({ objectMode: true });
|
|
58
58
|
this.inputStream.pipe(this.controlStream);
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
|
-
* @returns a `Readable` stream that will receive the assistant's text response to the user
|
|
61
|
+
* @returns a `Readable` stream, in object mode, that will receive the assistant's text response to the user.
|
|
62
|
+
* The object chunks written to the stream will be of type `AssistantResponseStreamChunk`.
|
|
62
63
|
*/
|
|
63
64
|
OpenAiStreamProcessor.prototype.getOutputStream = function () {
|
|
64
65
|
return this.outputStream;
|
|
@@ -83,7 +84,7 @@ var OpenAiStreamProcessor = /** @class */ (function () {
|
|
|
83
84
|
throw new Error("Received invalid chunk:\n".concat(JSON.stringify(chunk, null, 2)));
|
|
84
85
|
}
|
|
85
86
|
else if ((_b = (_a = chunk.choices[0]) === null || _a === void 0 ? void 0 : _a.delta) === null || _b === void 0 ? void 0 : _b.content) {
|
|
86
|
-
_this.outputStream.push(chunk.choices[0].delta.content);
|
|
87
|
+
_this.outputStream.push({ content: chunk.choices[0].delta.content });
|
|
87
88
|
}
|
|
88
89
|
else if ((_d = (_c = chunk.choices[0]) === null || _c === void 0 ? void 0 : _c.delta) === null || _d === void 0 ? void 0 : _d.tool_calls) {
|
|
89
90
|
_this.handleToolCallDelta(chunk.choices[0].delta.tool_calls);
|
|
@@ -92,15 +93,21 @@ var OpenAiStreamProcessor = /** @class */ (function () {
|
|
|
92
93
|
_this.handleToolCalls();
|
|
93
94
|
}
|
|
94
95
|
else if (((_f = chunk.choices[0]) === null || _f === void 0 ? void 0 : _f.finish_reason) === 'stop') {
|
|
96
|
+
_this.outputStream.push({ finishReason: 'stop' });
|
|
95
97
|
_this.outputStream.push(null);
|
|
98
|
+
_this.destroyStreams();
|
|
96
99
|
}
|
|
97
100
|
else if (((_g = chunk.choices[0]) === null || _g === void 0 ? void 0 : _g.finish_reason) === 'length') {
|
|
98
|
-
_this.logger.
|
|
101
|
+
_this.logger.info("The maximum number of output tokens was reached");
|
|
102
|
+
_this.outputStream.push({ finishReason: 'length' });
|
|
99
103
|
_this.outputStream.push(null);
|
|
104
|
+
_this.destroyStreams();
|
|
100
105
|
}
|
|
101
106
|
else if (((_h = chunk.choices[0]) === null || _h === void 0 ? void 0 : _h.finish_reason) === 'content_filter') {
|
|
102
|
-
_this.logger.
|
|
107
|
+
_this.logger.warn("Content was omitted due to a flag from OpenAI's content filters");
|
|
108
|
+
_this.outputStream.push({ finishReason: 'content_filter' });
|
|
103
109
|
_this.outputStream.push(null);
|
|
110
|
+
_this.destroyStreams();
|
|
104
111
|
}
|
|
105
112
|
callback();
|
|
106
113
|
}
|
|
@@ -117,7 +124,9 @@ var OpenAiStreamProcessor = /** @class */ (function () {
|
|
|
117
124
|
OpenAiStreamProcessor.prototype.destroyStreams = function (error) {
|
|
118
125
|
this.inputStream.destroy();
|
|
119
126
|
this.controlStream.destroy();
|
|
120
|
-
|
|
127
|
+
if (error) {
|
|
128
|
+
this.outputStream.emit('error', error);
|
|
129
|
+
}
|
|
121
130
|
this.outputStream.destroy();
|
|
122
131
|
};
|
|
123
132
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenAiStreamProcessor.js","sourceRoot":"","sources":["../../src/OpenAiStreamProcessor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,wCAAmD;AAEnD,iCAA6E;
|
|
1
|
+
{"version":3,"file":"OpenAiStreamProcessor.js","sourceRoot":"","sources":["../../src/OpenAiStreamProcessor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,wCAAmD;AAEnD,iCAA6E;AAO7E;;;;GAIG;AACH;IASE,+BACE,WAAwC,EAChC,WAGc,EACtB,QAAkB,EACV,WAAyB;QALzB,gBAAW,GAAX,WAAW,CAGG;QAEd,gBAAW,GAAX,WAAW,CAAc;QAd3B,yBAAoB,GAA6C,EAAE,CAAC;QACpE,sBAAiB,GAAG,CAAC,CAAC;QACtB,oBAAe,GAAkD,IAAI,CAAC;QAc5E,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,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,+CAAe,GAAf;QACE,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACK,mDAAmB,GAA3B;QAAA,iBA0CC;QAzCC,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,MAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,KAAK,0CAAE,OAAO,EAAE;wBAC3C,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAkC,CAAC,CAAC;qBACrG;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,EAAE,YAAY,EAAE,MAAM,EAAkC,CAAC,CAAC;wBACjF,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC7B,KAAI,CAAC,cAAc,EAAE,CAAC;qBACvB;yBAAM,IAAI,CAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,aAAa,MAAK,QAAQ,EAAE;wBACvD,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;wBACpE,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAkC,CAAC,CAAC;wBACnF,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC7B,KAAI,CAAC,cAAc,EAAE,CAAC;qBACvB;yBAAM,IAAI,CAAA,MAAA,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,0CAAE,aAAa,MAAK,gBAAgB,EAAE;wBAC/D,KAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC,CAAC;wBACpF,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,gBAAgB,EAAkC,CAAC,CAAC;wBAC3F,KAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC7B,KAAI,CAAC,cAAc,EAAE,CAAC;qBACvB;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,KAAK,EAAE;YACT,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SACxC;QACD,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,CAAA,MAAA,IAAI,CAAC,WAAW,0CAAE,OAAO,CAAA,EAAE;4BAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,OAAK,CAAC,CAAC;yBAC1D;wBACD,IAAI,CAAC,cAAc,CAAC,OAAK,CAAC,CAAC;;;;;;KAE9B;IACH,4BAAC;AAAD,CAAC,AA5JD,IA4JC;AA5JY,sDAAqB"}
|
package/index.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@proteinjs/conversation",
|
|
3
|
-
"version": "1.7.
|
|
3
|
+
"version": "1.7.3",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"publishConfig": {
|
|
@@ -35,5 +35,6 @@
|
|
|
35
35
|
"readline-sync": "1.4.10",
|
|
36
36
|
"tiktoken": "1.0.15",
|
|
37
37
|
"typescript": "5.2.2"
|
|
38
|
-
}
|
|
39
|
-
|
|
38
|
+
},
|
|
39
|
+
"gitHead": "ecfd1ddad16f8257306abead3cfce18a1aae8c78"
|
|
40
|
+
}
|
|
@@ -3,6 +3,11 @@ import { LogLevel, Logger } from '@proteinjs/util';
|
|
|
3
3
|
import { Stream } from 'openai/streaming';
|
|
4
4
|
import { Readable, Transform, TransformCallback, PassThrough } from 'stream';
|
|
5
5
|
|
|
6
|
+
export interface AssistantResponseStreamChunk {
|
|
7
|
+
content?: string;
|
|
8
|
+
finishReason?: string;
|
|
9
|
+
}
|
|
10
|
+
|
|
6
11
|
/**
|
|
7
12
|
* Processes streaming responses from OpenAI's `ChatCompletions` api.
|
|
8
13
|
* - When a tool call is received, it delegates processing to `onToolCalls`; this can happen recursively
|
|
@@ -29,12 +34,13 @@ export class OpenAiStreamProcessor {
|
|
|
29
34
|
this.logger = new Logger(this.constructor.name, logLevel);
|
|
30
35
|
this.inputStream = Readable.from(inputStream);
|
|
31
36
|
this.controlStream = this.createControlStream();
|
|
32
|
-
this.outputStream = new PassThrough();
|
|
37
|
+
this.outputStream = new PassThrough({ objectMode: true });
|
|
33
38
|
this.inputStream.pipe(this.controlStream);
|
|
34
39
|
}
|
|
35
40
|
|
|
36
41
|
/**
|
|
37
|
-
* @returns a `Readable` stream that will receive the assistant's text response to the user
|
|
42
|
+
* @returns a `Readable` stream, in object mode, that will receive the assistant's text response to the user.
|
|
43
|
+
* The object chunks written to the stream will be of type `AssistantResponseStreamChunk`.
|
|
38
44
|
*/
|
|
39
45
|
getOutputStream(): Readable {
|
|
40
46
|
return this.outputStream;
|
|
@@ -58,19 +64,25 @@ export class OpenAiStreamProcessor {
|
|
|
58
64
|
if (!chunk || !chunk.choices) {
|
|
59
65
|
throw new Error(`Received invalid chunk:\n${JSON.stringify(chunk, null, 2)}`);
|
|
60
66
|
} else if (chunk.choices[0]?.delta?.content) {
|
|
61
|
-
this.outputStream.push(chunk.choices[0].delta.content);
|
|
67
|
+
this.outputStream.push({ content: chunk.choices[0].delta.content } as AssistantResponseStreamChunk);
|
|
62
68
|
} else if (chunk.choices[0]?.delta?.tool_calls) {
|
|
63
69
|
this.handleToolCallDelta(chunk.choices[0].delta.tool_calls);
|
|
64
70
|
} else if (chunk.choices[0]?.finish_reason === 'tool_calls') {
|
|
65
71
|
this.handleToolCalls();
|
|
66
72
|
} else if (chunk.choices[0]?.finish_reason === 'stop') {
|
|
73
|
+
this.outputStream.push({ finishReason: 'stop' } as AssistantResponseStreamChunk);
|
|
67
74
|
this.outputStream.push(null);
|
|
75
|
+
this.destroyStreams();
|
|
68
76
|
} else if (chunk.choices[0]?.finish_reason === 'length') {
|
|
69
|
-
this.logger.
|
|
77
|
+
this.logger.info(`The maximum number of output tokens was reached`);
|
|
78
|
+
this.outputStream.push({ finishReason: 'length' } as AssistantResponseStreamChunk);
|
|
70
79
|
this.outputStream.push(null);
|
|
80
|
+
this.destroyStreams();
|
|
71
81
|
} else if (chunk.choices[0]?.finish_reason === 'content_filter') {
|
|
72
|
-
this.logger.
|
|
82
|
+
this.logger.warn(`Content was omitted due to a flag from OpenAI's content filters`);
|
|
83
|
+
this.outputStream.push({ finishReason: 'content_filter' } as AssistantResponseStreamChunk);
|
|
73
84
|
this.outputStream.push(null);
|
|
85
|
+
this.destroyStreams();
|
|
74
86
|
}
|
|
75
87
|
callback();
|
|
76
88
|
} catch (error: any) {
|
|
@@ -84,10 +96,12 @@ export class OpenAiStreamProcessor {
|
|
|
84
96
|
/**
|
|
85
97
|
* Destroy all streams used by `OpenAiStreamProcessor`
|
|
86
98
|
*/
|
|
87
|
-
private destroyStreams(error
|
|
99
|
+
private destroyStreams(error?: Error) {
|
|
88
100
|
this.inputStream.destroy();
|
|
89
101
|
this.controlStream.destroy();
|
|
90
|
-
|
|
102
|
+
if (error) {
|
|
103
|
+
this.outputStream.emit('error', error);
|
|
104
|
+
}
|
|
91
105
|
this.outputStream.destroy();
|
|
92
106
|
}
|
|
93
107
|
|