@langchain/core 0.2.0-rc.0 → 0.2.1

package/dist/runnables/base.cjs

@@ -6,8 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunnablePick = exports.RunnableAssign = exports._coerceToRunnable = exports.RunnableWithFallbacks = exports.RunnableParallel = exports.RunnableLambda = exports.RunnableMap = exports.RunnableSequence = exports.RunnableRetry = exports.RunnableEach = exports.RunnableBinding = exports.Runnable = exports._coerceToDict = void 0;
 const zod_1 = require("zod");
 const p_retry_1 = __importDefault(require("p-retry"));
+const uuid_1 = require("uuid");
 const manager_js_1 = require("../callbacks/manager.cjs");
 const log_stream_js_1 = require("../tracers/log_stream.cjs");
+const event_stream_js_1 = require("../tracers/event_stream.cjs");
 const serializable_js_1 = require("../load/serializable.cjs");
 const stream_js_1 = require("../utils/stream.cjs");
 const config_js_1 = require("./config.cjs");
@@ -17,6 +19,7 @@ const utils_js_1 = require("./utils.cjs");
 const index_js_1 = require("../singletons/index.cjs");
 const graph_js_1 = require("./graph.cjs");
 const wrappers_js_1 = require("./wrappers.cjs");
+const iter_js_1 = require("./iter.cjs");
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function _coerceToDict(value, defaultKey) {
     return value &&
@@ -167,7 +170,11 @@ class Runnable extends serializable_js_1.Serializable {
     async stream(input, options) {
         // Buffer the first streamed chunk to allow for initial errors
         // to surface immediately.
-        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup(this._streamIterator(input, (0, config_js_1.ensureConfig)(options)));
+        const config = (0, config_js_1.ensureConfig)(options);
+        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup({
+            generator: this._streamIterator(input, config),
+            config,
+        });
         await wrappedGenerator.setup;
         return stream_js_1.IterableReadableStream.fromAsyncGenerator(wrappedGenerator);
     }
@@ -280,11 +287,16 @@ class Runnable extends serializable_js_1.Serializable {
             const pipe = await (0, stream_js_1.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 isStreamEventsHandler = (handler) => handler.name === "event_stream_tracer";
+            const streamEventsHandler = runManager?.handlers.find(isStreamEventsHandler);
+            let iterator = pipe.output;
+            if (streamEventsHandler !== undefined && runManager !== undefined) {
+                iterator = streamEventsHandler.tapOutputIterable(runManager.runId, iterator);
+            }
             const isLogStreamHandler = (handler) => 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);
+                iterator = streamLogHandler.tapOutputIterable(runManager.runId, iterator);
             }
             for await (const chunk of iterator) {
                 yield chunk;
@@ -449,19 +461,93 @@ class Runnable extends serializable_js_1.Serializable {
             await runnableStreamConsumePromise;
         }
     }
-    async *streamEvents(input, options, streamOptions) {
+    streamEvents(input, options, streamOptions) {
+        let stream;
+        if (options.version === "v1") {
+            stream = this._streamEventsV1(input, options, streamOptions);
+        }
+        else if (options.version === "v2") {
+            stream = this._streamEventsV2(input, options, streamOptions);
+        }
+        else {
+            throw new Error(`Only versions "v1" and "v2" of the schema are currently supported.`);
+        }
         if (options.encoding === "text/event-stream") {
-            const stream = await this._streamEvents(input, options, streamOptions);
-            yield* (0, wrappers_js_1.convertToHttpEventStream)(stream);
+            return (0, wrappers_js_1.convertToHttpEventStream)(stream);
         }
         else {
-            yield* this._streamEvents(input, options, streamOptions);
+            return stream_js_1.IterableReadableStream.fromAsyncGenerator(stream);
         }
     }
-    async *_streamEvents(input, options, streamOptions) {
-        if (options.version !== "v1") {
-            throw new Error(`Only version "v1" of the events schema is currently supported.`);
+    async *_streamEventsV2(input, options, streamOptions) {
+        const eventStreamer = new event_stream_js_1.EventStreamCallbackHandler({
+            ...streamOptions,
+            autoClose: false,
+        });
+        const config = (0, config_js_1.ensureConfig)(options);
+        const runId = config.runId ?? (0, uuid_1.v4)();
+        config.runId = runId;
+        const callbacks = config.callbacks;
+        if (callbacks === undefined) {
+            config.callbacks = [eventStreamer];
+        }
+        else if (Array.isArray(callbacks)) {
+            config.callbacks = callbacks.concat(eventStreamer);
         }
+        else {
+            const copiedCallbacks = callbacks.copy();
+            copiedCallbacks.inheritableHandlers.push(eventStreamer);
+            // eslint-disable-next-line no-param-reassign
+            config.callbacks = copiedCallbacks;
+        }
+        // Call the runnable in streaming mode,
+        // add each chunk to the output stream
+        const outerThis = this;
+        async function consumeRunnableStream() {
+            try {
+                const runnableStream = await outerThis.stream(input, config);
+                const tappedStream = eventStreamer.tapOutputIterable(runId, runnableStream);
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                for await (const _ of tappedStream) {
+                    // Just iterate so that the callback handler picks up events
+                }
+            }
+            finally {
+                await eventStreamer.writer.close();
+            }
+        }
+        const runnableStreamConsumePromise = consumeRunnableStream();
+        let firstEventSent = false;
+        let firstEventRunId;
+        try {
+            for await (const event of eventStreamer) {
+                // This is a work-around an issue where the inputs into the
+                // chain are not available until the entire input is consumed.
+                // As a temporary solution, we'll modify the input to be the input
+                // that was passed into the chain.
+                if (!firstEventSent) {
+                    event.data.input = input;
+                    firstEventSent = true;
+                    firstEventRunId = event.run_id;
+                    yield event;
+                    continue;
+                }
+                if (event.run_id === firstEventRunId && event.event.endsWith("_end")) {
+                    // If it's the end event corresponding to the root runnable
+                    // we dont include the input in the event since it's guaranteed
+                    // to be included in the first event.
+                    if (event.data?.input) {
+                        delete event.data.input;
+                    }
+                }
+                yield event;
+            }
+        }
+        finally {
+            await runnableStreamConsumePromise;
+        }
+    }
+    async *_streamEventsV1(input, options, streamOptions) {
         let runLog;
         let hasEncounteredStartEvent = false;
         const config = (0, config_js_1.ensureConfig)(options);
@@ -739,11 +825,16 @@ class RunnableBinding extends Runnable {
     generator, options) {
         yield* this.bound.transform(generator, await this._mergeConfig((0, config_js_1.ensureConfig)(options), this.kwargs));
     }
-    async *streamEvents(input, options, streamOptions) {
-        yield* this.bound.streamEvents(input, {
-            ...(await this._mergeConfig((0, config_js_1.ensureConfig)(options), this.kwargs)),
-            version: options.version,
-        }, streamOptions);
+    streamEvents(input, options, streamOptions) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const outerThis = this;
+        const generator = async function* () {
+            yield* outerThis.bound.streamEvents(input, {
+                ...(await outerThis._mergeConfig((0, config_js_1.ensureConfig)(options), outerThis.kwargs)),
+                version: options.version,
+            }, streamOptions);
+        };
+        return stream_js_1.IterableReadableStream.fromAsyncGenerator(generator());
     }
     static isRunnableBinding(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1291,7 +1382,11 @@ class RunnableMap extends Runnable {
         async function* generator() {
             yield input;
         }
-        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup(this.transform(generator(), options));
+        const config = (0, config_js_1.ensureConfig)(options);
+        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup({
+            generator: this.transform(generator(), config),
+            config,
+        });
         await wrappedGenerator.setup;
         return stream_js_1.IterableReadableStream.fromAsyncGenerator(wrappedGenerator);
     }
@@ -1346,6 +1441,44 @@ class RunnableLambda extends Runnable {
                             recursionLimit: (childConfig.recursionLimit ?? config_js_1.DEFAULT_RECURSION_LIMIT) - 1,
                         });
                     }
+                    else if ((0, iter_js_1.isAsyncIterable)(output)) {
+                        let finalOutput;
+                        for await (const chunk of (0, iter_js_1.consumeAsyncIterableInContext)(childConfig, output)) {
+                            if (finalOutput === undefined) {
+                                finalOutput = chunk;
+                            }
+                            else {
+                                // Make a best effort to gather, for any type that supports concat.
+                                try {
+                                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                                    finalOutput = (0, stream_js_1.concat)(finalOutput, chunk);
+                                }
+                                catch (e) {
+                                    finalOutput = chunk;
+                                }
+                            }
+                        }
+                        output = finalOutput;
+                    }
+                    else if ((0, iter_js_1.isIterator)(output)) {
+                        let finalOutput;
+                        for (const chunk of (0, iter_js_1.consumeIteratorInContext)(childConfig, output)) {
+                            if (finalOutput === undefined) {
+                                finalOutput = chunk;
+                            }
+                            else {
+                                // Make a best effort to gather, for any type that supports concat.
+                                try {
+                                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                                    finalOutput = (0, stream_js_1.concat)(finalOutput, chunk);
+                                }
+                                catch (e) {
+                                    finalOutput = chunk;
+                                }
+                            }
+                        }
+                        output = finalOutput;
+                    }
                     resolve(output);
                 }
                 catch (e) {
@@ -1400,6 +1533,16 @@ class RunnableLambda extends Runnable {
                 yield chunk;
             }
         }
+        else if ((0, iter_js_1.isAsyncIterable)(output)) {
+            for await (const chunk of (0, iter_js_1.consumeAsyncIterableInContext)(config, output)) {
+                yield chunk;
+            }
+        }
+        else if ((0, iter_js_1.isIterator)(output)) {
+            for (const chunk of (0, iter_js_1.consumeIteratorInContext)(config, output)) {
+                yield chunk;
+            }
+        }
         else {
             yield output;
         }
@@ -1411,7 +1554,11 @@ class RunnableLambda extends Runnable {
         async function* generator() {
             yield input;
         }
-        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup(this.transform(generator(), options));
+        const config = (0, config_js_1.ensureConfig)(options);
+        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup({
+            generator: this.transform(generator(), config),
+            config,
+        });
         await wrappedGenerator.setup;
         return stream_js_1.IterableReadableStream.fromAsyncGenerator(wrappedGenerator);
     }
@@ -1615,7 +1762,11 @@ class RunnableAssign extends Runnable {
         async function* generator() {
             yield input;
         }
-        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup(this.transform(generator(), options));
+        const config = (0, config_js_1.ensureConfig)(options);
+        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup({
+            generator: this.transform(generator(), config),
+            config,
+        });
         await wrappedGenerator.setup;
         return stream_js_1.IterableReadableStream.fromAsyncGenerator(wrappedGenerator);
     }
@@ -1683,7 +1834,11 @@ class RunnablePick extends Runnable {
         async function* generator() {
             yield input;
         }
-        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup(this.transform(generator(), options));
+        const config = (0, config_js_1.ensureConfig)(options);
+        const wrappedGenerator = new stream_js_1.AsyncGeneratorWithSetup({
+            generator: this.transform(generator(), config),
+            config,
+        });
         await wrappedGenerator.setup;
         return stream_js_1.IterableReadableStream.fromAsyncGenerator(wrappedGenerator);
     }

package/dist/runnables/base.d.ts

@@ -1,6 +1,7 @@
 import type { RunnableInterface, RunnableBatchOptions } from "./types.js";
 import { CallbackManagerForChainRun } from "../callbacks/manager.js";
-import { LogStreamCallbackHandler, LogStreamCallbackHandlerInput, RunLogPatch, StreamEvent } from "../tracers/log_stream.js";
+import { LogStreamCallbackHandler, LogStreamCallbackHandlerInput, RunLogPatch } from "../tracers/log_stream.js";
+import { EventStreamCallbackHandlerInput, StreamEvent } from "../tracers/event_stream.js";
 import { Serializable } from "../load/serializable.js";
 import { IterableReadableStream } from "../utils/stream.js";
 import { RunnableConfig } from "./config.js";
@@ -179,33 +180,51 @@ export declare abstract class Runnable<RunInput = any, RunOutput = any, CallOpti
      * 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, ...]) |
+     * **ATTENTION** This reference table is for the V2 version of the schema.
+     *
+     * +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
+     * | event                | name             | chunk                           | input                                         | output                                          |
+     * +======================+==================+=================================+===============================================+=================================================+
+     * | on_chat_model_start  | [model name]     |                                 | {"messages": [[SystemMessage, HumanMessage]]} |                                                 |
+     * +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
+     * | on_chat_model_stream | [model name]     | AIMessageChunk(content="hello") |                                               |                                                 |
+     * +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
+     * | on_chat_model_end    | [model name]     |                                 | {"messages": [[SystemMessage, HumanMessage]]} | AIMessageChunk(content="hello world")           |
+     * +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
+     * | on_llm_start         | [model name]     |                                 | {'input': 'hello'}                            |                                                 |
+     * +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
+     * | on_llm_stream        | [model name]     | '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_end          | some_tool        |                                 |                                               | {"x": 1, "y": "2"}                              |
+     * +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
+     * | on_retriever_start   | [retriever name] |                                 | {"query": "hello"}                            |                                                 |
+     * +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
+     * | on_retriever_end     | [retriever name] |                                 | {"query": "hello"}                            | [Document(...), ..]                             |
+     * +----------------------+------------------+---------------------------------+-----------------------------------------------+-------------------------------------------------+
+     * | 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>;
+        version: "v1" | "v2";
+    }, streamOptions?: Omit<EventStreamCallbackHandlerInput, "autoClose">): IterableReadableStream<StreamEvent>;
     streamEvents(input: RunInput, options: Partial<CallOptions> & {
-        version: "v1";
+        version: "v1" | "v2";
         encoding: "text/event-stream";
-    }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): AsyncGenerator<Uint8Array>;
-    _streamEvents(input: RunInput, options: Partial<CallOptions> & {
-        version: "v1";
-    }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): AsyncGenerator<StreamEvent>;
+    }, streamOptions?: Omit<EventStreamCallbackHandlerInput, "autoClose">): IterableReadableStream<Uint8Array>;
+    private _streamEventsV2;
+    private _streamEventsV1;
     static isRunnable(thing: any): thing is Runnable;
     /**
      * Bind lifecycle listeners to a Runnable, returning a new Runnable.
@@ -262,12 +281,12 @@ export declare class RunnableBinding<RunInput, RunOutput, CallOptions extends Ru
     stream(input: RunInput, options?: Partial<CallOptions> | undefined): Promise<IterableReadableStream<RunOutput>>;
     transform(generator: AsyncGenerator<RunInput>, options: Partial<CallOptions>): AsyncGenerator<RunOutput>;
     streamEvents(input: RunInput, options: Partial<CallOptions> & {
-        version: "v1";
-    }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): AsyncGenerator<StreamEvent>;
+        version: "v1" | "v2";
+    }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): IterableReadableStream<StreamEvent>;
     streamEvents(input: RunInput, options: Partial<CallOptions> & {
-        version: "v1";
+        version: "v1" | "v2";
         encoding: "text/event-stream";
-    }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): AsyncGenerator<Uint8Array>;
+    }, streamOptions?: Omit<LogStreamCallbackHandlerInput, "autoClose">): IterableReadableStream<Uint8Array>;
     static isRunnableBinding(thing: any): thing is RunnableBinding<any, any, any>;
     /**
      * Bind lifecycle listeners to a Runnable, returning a new Runnable.