-
Notifications
You must be signed in to change notification settings - Fork 337
/
builders.ts
392 lines (356 loc) · 10.5 KB
/
builders.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
import type { LLM } from "../llm/index.js";
import { streamConverter } from "../llm/utils.js";
import type {
RefinePrompt,
SimplePrompt,
TextQaPrompt,
TreeSummarizePrompt,
} from "../Prompt.js";
import {
defaultRefinePrompt,
defaultTextQaPrompt,
defaultTreeSummarizePrompt,
} from "../Prompt.js";
import type { PromptHelper } from "../PromptHelper.js";
import { getBiggestPrompt } from "../PromptHelper.js";
import { PromptMixin } from "../prompts/Mixin.js";
import type { ServiceContext } from "../ServiceContext.js";
import {
llmFromSettingsOrContext,
promptHelperFromSettingsOrContext,
} from "../Settings.js";
import type {
ResponseBuilder,
ResponseBuilderParamsNonStreaming,
ResponseBuilderParamsStreaming,
} from "./types.js";
/**
* Response modes of the response synthesizer
*/
enum ResponseMode {
REFINE = "refine",
COMPACT = "compact",
TREE_SUMMARIZE = "tree_summarize",
SIMPLE = "simple",
}
/**
* A response builder that just concatenates responses.
*/
export class SimpleResponseBuilder implements ResponseBuilder {
llm: LLM;
textQATemplate: TextQaPrompt;
constructor(serviceContext?: ServiceContext, textQATemplate?: TextQaPrompt) {
this.llm = llmFromSettingsOrContext(serviceContext);
this.textQATemplate = textQATemplate ?? defaultTextQaPrompt;
}
getResponse(
params: ResponseBuilderParamsStreaming,
): Promise<AsyncIterable<string>>;
getResponse(params: ResponseBuilderParamsNonStreaming): Promise<string>;
async getResponse({
query,
textChunks,
stream,
}:
| ResponseBuilderParamsStreaming
| ResponseBuilderParamsNonStreaming): Promise<
AsyncIterable<string> | string
> {
const input = {
query,
context: textChunks.join("\n\n"),
};
const prompt = this.textQATemplate(input);
if (stream) {
const response = await this.llm.complete({ prompt, stream });
return streamConverter(response, (chunk) => chunk.text);
} else {
const response = await this.llm.complete({ prompt, stream });
return response.text;
}
}
}
/**
* A response builder that uses the query to ask the LLM generate a better response using multiple text chunks.
*/
export class Refine extends PromptMixin implements ResponseBuilder {
llm: LLM;
promptHelper: PromptHelper;
textQATemplate: TextQaPrompt;
refineTemplate: RefinePrompt;
constructor(
serviceContext?: ServiceContext,
textQATemplate?: TextQaPrompt,
refineTemplate?: RefinePrompt,
) {
super();
this.llm = llmFromSettingsOrContext(serviceContext);
this.promptHelper = promptHelperFromSettingsOrContext(serviceContext);
this.textQATemplate = textQATemplate ?? defaultTextQaPrompt;
this.refineTemplate = refineTemplate ?? defaultRefinePrompt;
}
protected _getPrompts(): {
textQATemplate: RefinePrompt;
refineTemplate: RefinePrompt;
} {
return {
textQATemplate: this.textQATemplate,
refineTemplate: this.refineTemplate,
};
}
protected _updatePrompts(prompts: {
textQATemplate: RefinePrompt;
refineTemplate: RefinePrompt;
}): void {
if (prompts.textQATemplate) {
this.textQATemplate = prompts.textQATemplate;
}
if (prompts.refineTemplate) {
this.refineTemplate = prompts.refineTemplate;
}
}
getResponse(
params: ResponseBuilderParamsStreaming,
): Promise<AsyncIterable<string>>;
getResponse(params: ResponseBuilderParamsNonStreaming): Promise<string>;
async getResponse({
query,
textChunks,
prevResponse,
stream,
}:
| ResponseBuilderParamsStreaming
| ResponseBuilderParamsNonStreaming): Promise<
AsyncIterable<string> | string
> {
let response: AsyncIterable<string> | string | undefined = prevResponse;
for (let i = 0; i < textChunks.length; i++) {
const chunk = textChunks[i];
const lastChunk = i === textChunks.length - 1;
if (!response) {
response = await this.giveResponseSingle(
query,
chunk,
!!stream && lastChunk,
);
} else {
response = await this.refineResponseSingle(
response as string,
query,
chunk,
!!stream && lastChunk,
);
}
}
return response ?? "Empty Response";
}
private async giveResponseSingle(
queryStr: string,
textChunk: string,
stream: boolean,
) {
const textQATemplate: SimplePrompt = (input) =>
this.textQATemplate({ ...input, query: queryStr });
const textChunks = this.promptHelper.repack(textQATemplate, [textChunk]);
let response: AsyncIterable<string> | string | undefined = undefined;
for (let i = 0; i < textChunks.length; i++) {
const chunk = textChunks[i];
const lastChunk = i === textChunks.length - 1;
if (!response) {
response = await this.complete({
prompt: textQATemplate({
context: chunk,
}),
stream: stream && lastChunk,
});
} else {
response = await this.refineResponseSingle(
response as string,
queryStr,
chunk,
stream && lastChunk,
);
}
}
return response;
}
// eslint-disable-next-line max-params
private async refineResponseSingle(
initialReponse: string,
queryStr: string,
textChunk: string,
stream: boolean,
) {
const refineTemplate: SimplePrompt = (input) =>
this.refineTemplate({ ...input, query: queryStr });
const textChunks = this.promptHelper.repack(refineTemplate, [textChunk]);
let response: AsyncIterable<string> | string = initialReponse;
for (let i = 0; i < textChunks.length; i++) {
const chunk = textChunks[i];
const lastChunk = i === textChunks.length - 1;
response = await this.complete({
prompt: refineTemplate({
context: chunk,
existingAnswer: response as string,
}),
stream: stream && lastChunk,
});
}
return response;
}
async complete(params: {
prompt: string;
stream: boolean;
}): Promise<AsyncIterable<string> | string> {
if (params.stream) {
const response = await this.llm.complete({ ...params, stream: true });
return streamConverter(response, (chunk) => chunk.text);
} else {
const response = await this.llm.complete({ ...params, stream: false });
return response.text;
}
}
}
/**
* CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks.
*/
export class CompactAndRefine extends Refine {
getResponse(
params: ResponseBuilderParamsStreaming,
): Promise<AsyncIterable<string>>;
getResponse(params: ResponseBuilderParamsNonStreaming): Promise<string>;
async getResponse({
query,
textChunks,
prevResponse,
stream,
}:
| ResponseBuilderParamsStreaming
| ResponseBuilderParamsNonStreaming): Promise<
AsyncIterable<string> | string
> {
const textQATemplate: SimplePrompt = (input) =>
this.textQATemplate({ ...input, query: query });
const refineTemplate: SimplePrompt = (input) =>
this.refineTemplate({ ...input, query: query });
const maxPrompt = getBiggestPrompt([textQATemplate, refineTemplate]);
const newTexts = this.promptHelper.repack(maxPrompt, textChunks);
const params = {
query,
textChunks: newTexts,
prevResponse,
};
if (stream) {
return super.getResponse({
...params,
stream,
});
}
return super.getResponse(params);
}
}
/**
* TreeSummarize repacks the text chunks into the smallest possible number of chunks and then summarizes them, then recursively does so until there's one chunk left.
*/
export class TreeSummarize extends PromptMixin implements ResponseBuilder {
llm: LLM;
promptHelper: PromptHelper;
summaryTemplate: TreeSummarizePrompt;
constructor(
serviceContext?: ServiceContext,
summaryTemplate?: TreeSummarizePrompt,
) {
super();
this.llm = llmFromSettingsOrContext(serviceContext);
this.promptHelper = promptHelperFromSettingsOrContext(serviceContext);
this.summaryTemplate = summaryTemplate ?? defaultTreeSummarizePrompt;
}
protected _getPrompts(): { summaryTemplate: TreeSummarizePrompt } {
return {
summaryTemplate: this.summaryTemplate,
};
}
protected _updatePrompts(prompts: {
summaryTemplate: TreeSummarizePrompt;
}): void {
if (prompts.summaryTemplate) {
this.summaryTemplate = prompts.summaryTemplate;
}
}
getResponse(
params: ResponseBuilderParamsStreaming,
): Promise<AsyncIterable<string>>;
getResponse(params: ResponseBuilderParamsNonStreaming): Promise<string>;
async getResponse({
query,
textChunks,
stream,
}:
| ResponseBuilderParamsStreaming
| ResponseBuilderParamsNonStreaming): Promise<
AsyncIterable<string> | string
> {
if (!textChunks || textChunks.length === 0) {
throw new Error("Must have at least one text chunk");
}
// Should we send the query here too?
const packedTextChunks = this.promptHelper.repack(
this.summaryTemplate,
textChunks,
);
if (packedTextChunks.length === 1) {
const params = {
prompt: this.summaryTemplate({
context: packedTextChunks[0],
query,
}),
};
if (stream) {
const response = await this.llm.complete({ ...params, stream });
return streamConverter(response, (chunk) => chunk.text);
}
return (await this.llm.complete(params)).text;
} else {
const summaries = await Promise.all(
packedTextChunks.map((chunk) =>
this.llm.complete({
prompt: this.summaryTemplate({
context: chunk,
query,
}),
}),
),
);
const params = {
query,
textChunks: summaries.map((s) => s.text),
};
if (stream) {
return this.getResponse({
...params,
stream,
});
}
return this.getResponse(params);
}
}
}
export function getResponseBuilder(
serviceContext?: ServiceContext,
responseMode?: ResponseMode,
): ResponseBuilder {
switch (responseMode) {
case ResponseMode.SIMPLE:
return new SimpleResponseBuilder(serviceContext);
case ResponseMode.REFINE:
return new Refine(serviceContext);
case ResponseMode.TREE_SUMMARIZE:
return new TreeSummarize(serviceContext);
default:
return new CompactAndRefine(serviceContext);
}
}
export type ResponseBuilderPrompts =
| TextQaPrompt
| TreeSummarizePrompt
| RefinePrompt;