-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
base.ts
2550 lines (2369 loc) Β· 80.8 KB
/
base.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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { z } from "zod";
import pRetry from "p-retry";
import type { RunnableInterface, RunnableBatchOptions } from "./types.js";
import {
CallbackManager,
CallbackManagerForChainRun,
} from "../callbacks/manager.js";
import {
LogStreamCallbackHandler,
LogStreamCallbackHandlerInput,
RunLog,
RunLogPatch,
StreamEvent,
StreamEventData,
} from "../tracers/log_stream.js";
import { Serializable } from "../load/serializable.js";
import {
IterableReadableStream,
concat,
atee,
pipeGeneratorWithSetup,
AsyncGeneratorWithSetup,
} from "../utils/stream.js";
import {
DEFAULT_RECURSION_LIMIT,
RunnableConfig,
ensureConfig,
getCallbackManagerForConfig,
mergeConfigs,
patchConfig,
} from "./config.js";
import { AsyncCaller } from "../utils/async_caller.js";
import { Run } from "../tracers/base.js";
import { RootListenersTracer } from "../tracers/root_listener.js";
import { BaseCallbackHandler } from "../callbacks/base.js";
import { _RootEventFilter, isRunnableInterface } from "./utils.js";
import { AsyncLocalStorageProviderSingleton } from "../singletons/index.js";
import { Graph } from "./graph.js";
import { convertToHttpEventStream } from "./wrappers.js";
import {
consumeAsyncIterableInContext,
consumeIteratorInContext,
isAsyncIterable,
isIterator,
} from "./iter.js";
export { type RunnableInterface, RunnableBatchOptions };
// TODO: Make `options` just take `RunnableConfig`
export type RunnableFunc<RunInput, RunOutput> = (
input: RunInput,
options?:
| ({ config?: RunnableConfig } & RunnableConfig)
// eslint-disable-next-line @typescript-eslint/no-explicit-any
| Record<string, any>
// eslint-disable-next-line @typescript-eslint/no-explicit-any
| (Record<string, any> & { config: RunnableConfig } & RunnableConfig)
) => RunOutput | Promise<RunOutput>;
export type RunnableMapLike<RunInput, RunOutput> = {
[K in keyof RunOutput]: RunnableLike<RunInput, RunOutput[K]>;
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type RunnableLike<RunInput = any, RunOutput = any> =
| RunnableInterface<RunInput, RunOutput>
| RunnableFunc<RunInput, RunOutput>
| RunnableMapLike<RunInput, RunOutput>;
export type RunnableRetryFailedAttemptHandler = (
// eslint-disable-next-line @typescript-eslint/no-explicit-any
error: any,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
input: any
// eslint-disable-next-line @typescript-eslint/no-explicit-any
) => any;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function _coerceToDict(value: any, defaultKey: string) {
return value &&
!Array.isArray(value) &&
// eslint-disable-next-line no-instanceof/no-instanceof
!(value instanceof Date) &&
typeof value === "object"
? value
: { [defaultKey]: value };
}
/**
* A Runnable is a generic unit of work that can be invoked, batched, streamed, and/or
* transformed.
*/
export abstract class Runnable<
// eslint-disable-next-line @typescript-eslint/no-explicit-any
RunInput = any,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
RunOutput = any,
CallOptions extends RunnableConfig = RunnableConfig
>
extends Serializable
implements RunnableInterface<RunInput, RunOutput, CallOptions>
{
protected lc_runnable = true;
name?: string;
getName(suffix?: string): string {
const name =
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this.name ?? (this.constructor as any).lc_name() ?? this.constructor.name;
return suffix ? `${name}${suffix}` : name;
}
abstract invoke(
input: RunInput,
options?: Partial<CallOptions>
): Promise<RunOutput>;
/**
* Bind arguments to a Runnable, returning a new Runnable.
* @param kwargs
* @returns A new RunnableBinding that, when invoked, will apply the bound args.
*/
bind(
kwargs: Partial<CallOptions>
): Runnable<RunInput, RunOutput, CallOptions> {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
return new RunnableBinding({ bound: this, kwargs, config: {} });
}
/**
* Return a new Runnable that maps a list of inputs to a list of outputs,
* by calling invoke() with each input.
*/
map(): Runnable<RunInput[], RunOutput[], CallOptions> {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
return new RunnableEach({ bound: this });
}
/**
* Add retry logic to an existing runnable.
* @param kwargs
* @returns A new RunnableRetry that, when invoked, will retry according to the parameters.
*/
withRetry(fields?: {
stopAfterAttempt?: number;
onFailedAttempt?: RunnableRetryFailedAttemptHandler;
}): RunnableRetry<RunInput, RunOutput, CallOptions> {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
return new RunnableRetry({
bound: this,
kwargs: {},
config: {},
maxAttemptNumber: fields?.stopAfterAttempt,
...fields,
});
}
/**
* Bind config to a Runnable, returning a new Runnable.
* @param config New configuration parameters to attach to the new runnable.
* @returns A new RunnableBinding with a config matching what's passed.
*/
withConfig(
config: RunnableConfig
): RunnableBinding<RunInput, RunOutput, CallOptions> {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
return new RunnableBinding({
bound: this,
config,
kwargs: {},
});
}
/**
* Create a new runnable from the current one that will try invoking
* other passed fallback runnables if the initial invocation fails.
* @param fields.fallbacks Other runnables to call if the runnable errors.
* @returns A new RunnableWithFallbacks.
*/
withFallbacks(fields: {
fallbacks: Runnable<RunInput, RunOutput>[];
}): RunnableWithFallbacks<RunInput, RunOutput> {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
return new RunnableWithFallbacks<RunInput, RunOutput>({
runnable: this,
fallbacks: fields.fallbacks,
});
}
protected _getOptionsList<O extends CallOptions & { runType?: string }>(
options: Partial<O> | Partial<O>[],
length = 0
): Partial<O>[] {
if (Array.isArray(options) && options.length !== length) {
throw new Error(
`Passed "options" must be an array with the same length as the inputs, but got ${options.length} options for ${length} inputs`
);
}
if (Array.isArray(options)) {
return options.map(ensureConfig);
}
if (length > 1 && !Array.isArray(options) && options.runId) {
console.warn(
"Provided runId will be used only for the first element of the batch."
);
const subsequent = Object.fromEntries(
Object.entries(options).filter(([key]) => key !== "runId")
);
return Array.from({ length }, (_, i) =>
ensureConfig(i === 0 ? options : subsequent)
) as Partial<O>[];
}
return Array.from({ length }, () => ensureConfig(options));
}
/**
* Default implementation of batch, which calls invoke N times.
* Subclasses should override this method if they can batch more efficiently.
* @param inputs Array of inputs to each batch call.
* @param options Either a single call options object to apply to each batch call or an array for each call.
* @param batchOptions.returnExceptions Whether to return errors rather than throwing on the first one
* @returns An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
*/
async batch(
inputs: RunInput[],
options?: Partial<CallOptions> | Partial<CallOptions>[],
batchOptions?: RunnableBatchOptions & { returnExceptions?: false }
): Promise<RunOutput[]>;
async batch(
inputs: RunInput[],
options?: Partial<CallOptions> | Partial<CallOptions>[],
batchOptions?: RunnableBatchOptions & { returnExceptions: true }
): Promise<(RunOutput | Error)[]>;
async batch(
inputs: RunInput[],
options?: Partial<CallOptions> | Partial<CallOptions>[],
batchOptions?: RunnableBatchOptions
): Promise<(RunOutput | Error)[]>;
async batch(
inputs: RunInput[],
options?: Partial<CallOptions> | Partial<CallOptions>[],
batchOptions?: RunnableBatchOptions
): Promise<(RunOutput | Error)[]> {
const configList = this._getOptionsList(options ?? {}, inputs.length);
const maxConcurrency =
configList[0]?.maxConcurrency ?? batchOptions?.maxConcurrency;
const caller = new AsyncCaller({
maxConcurrency,
onFailedAttempt: (e) => {
throw e;
},
});
const batchCalls = inputs.map((input, i) =>
caller.call(async () => {
try {
const result = await this.invoke(input, configList[i]);
return result;
} catch (e) {
if (batchOptions?.returnExceptions) {
return e as Error;
}
throw e;
}
})
);
return Promise.all(batchCalls);
}
/**
* Default streaming implementation.
* Subclasses should override this method if they support streaming output.
* @param input
* @param options
*/
async *_streamIterator(
input: RunInput,
options?: Partial<CallOptions>
): AsyncGenerator<RunOutput> {
yield this.invoke(input, options);
}
/**
* Stream output in chunks.
* @param input
* @param options
* @returns A readable stream that is also an iterable.
*/
async stream(
input: RunInput,
options?: Partial<CallOptions>
): Promise<IterableReadableStream<RunOutput>> {
// Buffer the first streamed chunk to allow for initial errors
// to surface immediately.
const wrappedGenerator = new AsyncGeneratorWithSetup(
this._streamIterator(input, ensureConfig(options))
);
await wrappedGenerator.setup;
return IterableReadableStream.fromAsyncGenerator(wrappedGenerator);
}
protected _separateRunnableConfigFromCallOptions(
options?: Partial<CallOptions>
): [RunnableConfig, Omit<Partial<CallOptions>, keyof RunnableConfig>] {
let runnableConfig;
if (options === undefined) {
runnableConfig = ensureConfig(options);
} else {
runnableConfig = ensureConfig({
callbacks: options.callbacks,
tags: options.tags,
metadata: options.metadata,
runName: options.runName,
configurable: options.configurable,
recursionLimit: options.recursionLimit,
maxConcurrency: options.maxConcurrency,
runId: options.runId,
});
}
const callOptions = { ...(options as Partial<CallOptions>) };
delete callOptions.callbacks;
delete callOptions.tags;
delete callOptions.metadata;
delete callOptions.runName;
delete callOptions.configurable;
delete callOptions.recursionLimit;
delete callOptions.maxConcurrency;
delete callOptions.runId;
return [runnableConfig, callOptions];
}
protected async _callWithConfig<T extends RunInput>(
func:
| ((input: T) => Promise<RunOutput>)
| ((
input: T,
config?: Partial<CallOptions>,
runManager?: CallbackManagerForChainRun
) => Promise<RunOutput>),
input: T,
options?: Partial<CallOptions> & { runType?: string }
) {
const config = ensureConfig(options);
const callbackManager_ = await getCallbackManagerForConfig(config);
const runManager = await callbackManager_?.handleChainStart(
this.toJSON(),
_coerceToDict(input, "input"),
config.runId,
config?.runType,
undefined,
undefined,
config?.runName ?? this.getName()
);
delete config.runId;
let output;
try {
output = await func.call(this, input, config, runManager);
} catch (e) {
await runManager?.handleChainError(e);
throw e;
}
await runManager?.handleChainEnd(_coerceToDict(output, "output"));
return output;
}
/**
* Internal method that handles batching and configuration for a runnable
* It takes a function, input values, and optional configuration, and
* returns a promise that resolves to the output values.
* @param func The function to be executed for each input value.
* @param input The input values to be processed.
* @param config Optional configuration for the function execution.
* @returns A promise that resolves to the output values.
*/
async _batchWithConfig<T extends RunInput>(
func: (
inputs: T[],
options?: Partial<CallOptions>[],
runManagers?: (CallbackManagerForChainRun | undefined)[],
batchOptions?: RunnableBatchOptions
) => Promise<(RunOutput | Error)[]>,
inputs: T[],
options?:
| Partial<CallOptions & { runType?: string }>
| Partial<CallOptions & { runType?: string }>[],
batchOptions?: RunnableBatchOptions
): Promise<(RunOutput | Error)[]> {
const optionsList = this._getOptionsList(options ?? {}, inputs.length);
const callbackManagers = await Promise.all(
optionsList.map(getCallbackManagerForConfig)
);
const runManagers = await Promise.all(
callbackManagers.map(async (callbackManager, i) => {
const handleStartRes = await callbackManager?.handleChainStart(
this.toJSON(),
_coerceToDict(inputs[i], "input"),
optionsList[i].runId,
optionsList[i].runType,
undefined,
undefined,
optionsList[i].runName ?? this.getName()
);
delete optionsList[i].runId;
return handleStartRes;
})
);
let outputs: (RunOutput | Error)[];
try {
outputs = await func.call(
this,
inputs,
optionsList,
runManagers,
batchOptions
);
} catch (e) {
await Promise.all(
runManagers.map((runManager) => runManager?.handleChainError(e))
);
throw e;
}
await Promise.all(
runManagers.map((runManager) =>
runManager?.handleChainEnd(_coerceToDict(outputs, "output"))
)
);
return outputs;
}
/**
* Helper method to transform an Iterator of Input values into an Iterator of
* Output values, with callbacks.
* Use this to implement `stream()` or `transform()` in Runnable subclasses.
*/
protected async *_transformStreamWithConfig<
I extends RunInput,
O extends RunOutput
>(
inputGenerator: AsyncGenerator<I>,
transformer: (
generator: AsyncGenerator<I>,
runManager?: CallbackManagerForChainRun,
options?: Partial<CallOptions>
) => AsyncGenerator<O>,
options?: CallOptions & { runType?: string }
): AsyncGenerator<O> {
let finalInput: I | undefined;
let finalInputSupported = true;
let finalOutput: O | undefined;
let finalOutputSupported = true;
const config = ensureConfig(options);
const callbackManager_ = await getCallbackManagerForConfig(config);
async function* wrapInputForTracing() {
for await (const chunk of inputGenerator) {
if (finalInputSupported) {
if (finalInput === undefined) {
finalInput = chunk;
} else {
try {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
finalInput = concat(finalInput, chunk as any);
} catch {
finalInput = undefined;
finalInputSupported = false;
}
}
}
yield chunk;
}
}
let runManager: CallbackManagerForChainRun | undefined;
try {
const pipe = await pipeGeneratorWithSetup(
transformer.bind(this),
wrapInputForTracing(),
async () =>
callbackManager_?.handleChainStart(
this.toJSON(),
{ input: "" },
config.runId,
config.runType,
undefined,
undefined,
config.runName ?? this.getName()
),
config
);
delete config.runId;
runManager = pipe.setup;
const isLogStreamHandler = (
handler: BaseCallbackHandler
): handler is LogStreamCallbackHandler =>
handler.name === "log_stream_tracer";
const streamLogHandler = runManager?.handlers.find(isLogStreamHandler);
let iterator = pipe.output;
if (streamLogHandler !== undefined && runManager !== undefined) {
iterator = await streamLogHandler.tapOutputIterable(
runManager.runId,
pipe.output
);
}
for await (const chunk of iterator) {
yield chunk;
if (finalOutputSupported) {
if (finalOutput === undefined) {
finalOutput = chunk;
} else {
try {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
finalOutput = concat(finalOutput, chunk as any);
} catch {
finalOutput = undefined;
finalOutputSupported = false;
}
}
}
}
} catch (e) {
await runManager?.handleChainError(e, undefined, undefined, undefined, {
inputs: _coerceToDict(finalInput, "input"),
});
throw e;
}
await runManager?.handleChainEnd(
finalOutput ?? {},
undefined,
undefined,
undefined,
{ inputs: _coerceToDict(finalInput, "input") }
);
}
getGraph(_?: RunnableConfig): Graph {
const graph = new Graph();
// TODO: Add input schema for runnables
const inputNode = graph.addNode({
name: `${this.getName()}Input`,
schema: z.any(),
});
const runnableNode = graph.addNode(this);
// TODO: Add output schemas for runnables
const outputNode = graph.addNode({
name: `${this.getName()}Output`,
schema: z.any(),
});
graph.addEdge(inputNode, runnableNode);
graph.addEdge(runnableNode, outputNode);
return graph;
}
/**
* Create a new runnable sequence that runs each individual runnable in series,
* piping the output of one runnable into another runnable or runnable-like.
* @param coerceable A runnable, function, or object whose values are functions or runnables.
* @returns A new runnable sequence.
*/
pipe<NewRunOutput>(
coerceable: RunnableLike<RunOutput, NewRunOutput>
): Runnable<RunInput, Exclude<NewRunOutput, Error>> {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
return new RunnableSequence({
first: this,
last: _coerceToRunnable(coerceable),
});
}
/**
* Pick keys from the dict output of this runnable. Returns a new runnable.
*/
pick(keys: string | string[]): Runnable {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
return this.pipe(new RunnablePick(keys) as Runnable);
}
/**
* Assigns new fields to the dict output of this runnable. Returns a new runnable.
*/
assign(
mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>
): Runnable {
return this.pipe(
// eslint-disable-next-line @typescript-eslint/no-use-before-define
new RunnableAssign(
// eslint-disable-next-line @typescript-eslint/no-use-before-define
new RunnableMap<Record<string, unknown>>({ steps: mapping })
) as Runnable
);
}
/**
* Default implementation of transform, which buffers input and then calls stream.
* Subclasses should override this method if they can start producing output while
* input is still being generated.
* @param generator
* @param options
*/
async *transform(
generator: AsyncGenerator<RunInput>,
options: Partial<CallOptions>
): AsyncGenerator<RunOutput> {
let finalChunk;
for await (const chunk of generator) {
if (finalChunk === undefined) {
finalChunk = chunk;
} else {
// Make a best effort to gather, for any type that supports concat.
// This method should throw an error if gathering fails.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
finalChunk = concat(finalChunk, chunk as any);
}
}
yield* this._streamIterator(finalChunk, ensureConfig(options));
}
/**
* Stream all output from a runnable, as reported to the callback system.
* This includes all inner runs of LLMs, Retrievers, Tools, etc.
* Output is streamed as Log objects, which include a list of
* jsonpatch ops that describe how the state of the run has changed in each
* step, and the final state of the run.
* The jsonpatch ops can be applied in order to construct state.
* @param input
* @param options
* @param streamOptions
*/
async *streamLog(
input: RunInput,
options?: Partial<CallOptions>,
streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">
): AsyncGenerator<RunLogPatch> {
const logStreamCallbackHandler = new LogStreamCallbackHandler({
...streamOptions,
autoClose: false,
_schemaFormat: "original",
});
const config = ensureConfig(options);
yield* this._streamLog(input, logStreamCallbackHandler, config);
}
protected async *_streamLog(
input: RunInput,
logStreamCallbackHandler: LogStreamCallbackHandler,
config: Partial<CallOptions>
): AsyncGenerator<RunLogPatch> {
const { callbacks } = config;
if (callbacks === undefined) {
// eslint-disable-next-line no-param-reassign
config.callbacks = [logStreamCallbackHandler];
} else if (Array.isArray(callbacks)) {
// eslint-disable-next-line no-param-reassign
config.callbacks = callbacks.concat([logStreamCallbackHandler]);
} else {
const copiedCallbacks = callbacks.copy();
copiedCallbacks.inheritableHandlers.push(logStreamCallbackHandler);
// eslint-disable-next-line no-param-reassign
config.callbacks = copiedCallbacks;
}
const runnableStreamPromise = this.stream(input, config);
async function consumeRunnableStream() {
try {
const runnableStream = await runnableStreamPromise;
for await (const chunk of runnableStream) {
const patch = new RunLogPatch({
ops: [
{
op: "add",
path: "/streamed_output/-",
value: chunk,
},
],
});
await logStreamCallbackHandler.writer.write(patch);
}
} finally {
await logStreamCallbackHandler.writer.close();
}
}
const runnableStreamConsumePromise = consumeRunnableStream();
try {
for await (const log of logStreamCallbackHandler) {
yield log;
}
} finally {
await runnableStreamConsumePromise;
}
}
/**
* Generate a stream of events emitted by the internal steps of the runnable.
*
* Use to create an iterator over StreamEvents that provide real-time information
* about the progress of the runnable, including StreamEvents from intermediate
* results.
*
* A StreamEvent is a dictionary with the following schema:
*
* - `event`: string - Event names are of the format: on_[runnable_type]_(start|stream|end).
* - `name`: string - The name of the runnable that generated the event.
* - `run_id`: string - Randomly generated ID associated with the given execution of
* the runnable that emitted the event. A child runnable that gets invoked as part of the execution of a
* parent runnable is assigned its own unique ID.
* - `tags`: string[] - The tags of the runnable that generated the event.
* - `metadata`: Record<string, any> - The metadata of the runnable that generated the event.
* - `data`: Record<string, any>
*
* Below is a table that illustrates some events that might be emitted by various
* chains. Metadata fields have been omitted from the table for brevity.
* Chain definitions have been included after the table.
*
* | event | name | chunk | input | output |
* |----------------------|------------------|------------------------------------|-----------------------------------------------|-------------------------------------------------|
* | on_llm_start | [model name] | | {'input': 'hello'} | |
* | on_llm_stream | [model name] | 'Hello' OR AIMessageChunk("hello") | | |
* | on_llm_end | [model name] | | 'Hello human!' |
* | on_chain_start | format_docs | | | |
* | on_chain_stream | format_docs | "hello world!, goodbye world!" | | |
* | on_chain_end | format_docs | | [Document(...)] | "hello world!, goodbye world!" |
* | on_tool_start | some_tool | | {"x": 1, "y": "2"} | |
* | on_tool_stream | some_tool | {"x": 1, "y": "2"} | | |
* | on_tool_end | some_tool | | | {"x": 1, "y": "2"} |
* | on_retriever_start | [retriever name] | | {"query": "hello"} | |
* | on_retriever_chunk | [retriever name] | {documents: [...]} | | |
* | on_retriever_end | [retriever name] | | {"query": "hello"} | {documents: [...]} |
* | on_prompt_start | [template_name] | | {"question": "hello"} | |
* | on_prompt_end | [template_name] | | {"question": "hello"} | ChatPromptValue(messages: [SystemMessage, ...]) |
*/
streamEvents(
input: RunInput,
options: Partial<CallOptions> & { version: "v1" },
streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">
): AsyncGenerator<StreamEvent>;
streamEvents(
input: RunInput,
options: Partial<CallOptions> & {
version: "v1";
encoding: "text/event-stream";
},
streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">
): AsyncGenerator<Uint8Array>;
async *streamEvents(
input: RunInput,
options: Partial<CallOptions> & {
version: "v1";
encoding?: "text/event-stream" | undefined;
},
streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">
): AsyncGenerator<StreamEvent | Uint8Array> {
if (options.encoding === "text/event-stream") {
const stream = await this._streamEvents(input, options, streamOptions);
yield* convertToHttpEventStream(stream);
} else {
yield* this._streamEvents(input, options, streamOptions);
}
}
async *_streamEvents(
input: RunInput,
options: Partial<CallOptions> & { version: "v1" },
streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">
): AsyncGenerator<StreamEvent> {
if (options.version !== "v1") {
throw new Error(
`Only version "v1" of the events schema is currently supported.`
);
}
let runLog;
let hasEncounteredStartEvent = false;
const config = ensureConfig(options);
const rootTags = config.tags ?? [];
const rootMetadata = config.metadata ?? {};
const rootName = config.runName ?? this.getName();
const logStreamCallbackHandler = new LogStreamCallbackHandler({
...streamOptions,
autoClose: false,
_schemaFormat: "streaming_events",
});
const rootEventFilter = new _RootEventFilter({
...streamOptions,
});
const logStream = this._streamLog(input, logStreamCallbackHandler, config);
for await (const log of logStream) {
if (!runLog) {
runLog = RunLog.fromRunLogPatch(log);
} else {
runLog = runLog.concat(log);
}
if (runLog.state === undefined) {
throw new Error(
`Internal error: "streamEvents" state is missing. Please open a bug report.`
);
}
// Yield the start event for the root runnable if it hasn't been seen.
// The root run is never filtered out
if (!hasEncounteredStartEvent) {
hasEncounteredStartEvent = true;
const state = { ...runLog.state };
const event: StreamEvent = {
run_id: state.id,
event: `on_${state.type}_start`,
name: rootName,
tags: rootTags,
metadata: rootMetadata,
data: {
input,
},
};
if (rootEventFilter.includeEvent(event, state.type)) {
yield event;
}
}
const paths = log.ops
.filter((op) => op.path.startsWith("/logs/"))
.map((op) => op.path.split("/")[2]);
const dedupedPaths = [...new Set(paths)];
for (const path of dedupedPaths) {
let eventType;
let data: StreamEventData = {};
const logEntry = runLog.state.logs[path];
if (logEntry.end_time === undefined) {
if (logEntry.streamed_output.length > 0) {
eventType = "stream";
} else {
eventType = "start";
}
} else {
eventType = "end";
}
if (eventType === "start") {
// Include the inputs with the start event if they are available.
// Usually they will NOT be available for components that operate
// on streams, since those components stream the input and
// don't know its final value until the end of the stream.
if (logEntry.inputs !== undefined) {
data.input = logEntry.inputs;
}
} else if (eventType === "end") {
if (logEntry.inputs !== undefined) {
data.input = logEntry.inputs;
}
data.output = logEntry.final_output;
} else if (eventType === "stream") {
const chunkCount = logEntry.streamed_output.length;
if (chunkCount !== 1) {
throw new Error(
`Expected exactly one chunk of streamed output, got ${chunkCount} instead. Encountered in: "${logEntry.name}"`
);
}
data = { chunk: logEntry.streamed_output[0] };
// Clean up the stream, we don't need it anymore.
// And this avoids duplicates as well!
logEntry.streamed_output = [];
}
yield {
event: `on_${logEntry.type}_${eventType}`,
name: logEntry.name,
run_id: logEntry.id,
tags: logEntry.tags,
metadata: logEntry.metadata,
data,
};
}
// Finally, we take care of the streaming output from the root chain
// if there is any.
const { state } = runLog;
if (state.streamed_output.length > 0) {
const chunkCount = state.streamed_output.length;
if (chunkCount !== 1) {
throw new Error(
`Expected exactly one chunk of streamed output, got ${chunkCount} instead. Encountered in: "${state.name}"`
);
}
const data = { chunk: state.streamed_output[0] };
// Clean up the stream, we don't need it anymore.
state.streamed_output = [];
const event = {
event: `on_${state.type}_stream`,
run_id: state.id,
tags: rootTags,
metadata: rootMetadata,
name: rootName,
data,
};
if (rootEventFilter.includeEvent(event, state.type)) {
yield event;
}
}
}
const state = runLog?.state;
if (state !== undefined) {
// Finally, yield the end event for the root runnable.
const event = {
event: `on_${state.type}_end`,
name: rootName,
run_id: state.id,
tags: rootTags,
metadata: rootMetadata,
data: {
output: state.final_output,
},
};
if (rootEventFilter.includeEvent(event, state.type)) yield event;
}
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
static isRunnable(thing: any): thing is Runnable {
return isRunnableInterface(thing);
}
/**
* Bind lifecycle listeners to a Runnable, returning a new Runnable.
* The Run object contains information about the run, including its id,
* type, input, output, error, startTime, endTime, and any tags or metadata
* added to the run.
*
* @param {Object} params - The object containing the callback functions.
* @param {(run: Run) => void} params.onStart - Called before the runnable starts running, with the Run object.
* @param {(run: Run) => void} params.onEnd - Called after the runnable finishes running, with the Run object.
* @param {(run: Run) => void} params.onError - Called if the runnable throws an error, with the Run object.
*/
withListeners({
onStart,
onEnd,
onError,
}: {
onStart?: (run: Run, config?: RunnableConfig) => void | Promise<void>;
onEnd?: (run: Run, config?: RunnableConfig) => void | Promise<void>;
onError?: (run: Run, config?: RunnableConfig) => void | Promise<void>;
}): Runnable<RunInput, RunOutput, CallOptions> {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
return new RunnableBinding<RunInput, RunOutput, CallOptions>({
bound: this,
config: {},
configFactories: [
(config) => ({
callbacks: [
new RootListenersTracer({
config,
onStart,
onEnd,
onError,
}),
],
}),
],
});
}
}
export type RunnableBindingArgs<
RunInput,
RunOutput,
CallOptions extends RunnableConfig = RunnableConfig
> = {
bound: Runnable<RunInput, RunOutput, CallOptions>;
kwargs?: Partial<CallOptions>;
config: RunnableConfig;
configFactories?: Array<(config: RunnableConfig) => RunnableConfig>;
};
/**
* A runnable that delegates calls to another runnable with a set of kwargs.
*/
export class RunnableBinding<
RunInput,
RunOutput,
CallOptions extends RunnableConfig = RunnableConfig
> extends Runnable<RunInput, RunOutput, CallOptions> {
static lc_name() {
return "RunnableBinding";
}
lc_namespace = ["langchain_core", "runnables"];
lc_serializable = true;
bound: Runnable<RunInput, RunOutput, CallOptions>;
config: RunnableConfig;
kwargs?: Partial<CallOptions>;
configFactories?: Array<
(config: RunnableConfig) => RunnableConfig | Promise<RunnableConfig>
>;