@langchain/core 0.2.4 → 0.2.5

package/dist/messages/ai.cjs

@@ -76,11 +76,21 @@ class AIMessage extends base_js_1.BaseMessage {
             writable: true,
             value: []
         });
+        /**
+         * If provided, token usage information associated with the message.
+         */
+        Object.defineProperty(this, "usage_metadata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         if (typeof initParams !== "string") {
             this.tool_calls = initParams.tool_calls ?? this.tool_calls;
             this.invalid_tool_calls =
                 initParams.invalid_tool_calls ?? this.invalid_tool_calls;
         }
+        this.usage_metadata = initParams.usage_metadata;
     }
     static lc_name() {
         return "AIMessage";
@@ -172,11 +182,21 @@ class AIMessageChunk extends base_js_1.BaseMessageChunk {
             writable: true,
             value: []
         });
+        /**
+         * If provided, token usage information associated with the message.
+         */
+        Object.defineProperty(this, "usage_metadata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.tool_call_chunks =
-            initParams?.tool_call_chunks ?? this.tool_call_chunks;
-        this.tool_calls = initParams?.tool_calls ?? this.tool_calls;
+            initParams.tool_call_chunks ?? this.tool_call_chunks;
+        this.tool_calls = initParams.tool_calls ?? this.tool_calls;
         this.invalid_tool_calls =
-            initParams?.invalid_tool_calls ?? this.invalid_tool_calls;
+            initParams.invalid_tool_calls ?? this.invalid_tool_calls;
+        this.usage_metadata = initParams.usage_metadata;
     }
     get lc_aliases() {
         // exclude snake case conversion to pascal case
@@ -207,6 +227,25 @@ class AIMessageChunk extends base_js_1.BaseMessageChunk {
                 combinedFields.tool_call_chunks = rawToolCalls;
             }
         }
+        if (this.usage_metadata !== undefined ||
+            chunk.usage_metadata !== undefined) {
+            const left = this.usage_metadata ?? {
+                input_tokens: 0,
+                output_tokens: 0,
+                total_tokens: 0,
+            };
+            const right = chunk.usage_metadata ?? {
+                input_tokens: 0,
+                output_tokens: 0,
+                total_tokens: 0,
+            };
+            const usage_metadata = {
+                input_tokens: left.input_tokens + right.input_tokens,
+                output_tokens: left.output_tokens + right.output_tokens,
+                total_tokens: left.total_tokens + right.total_tokens,
+            };
+            combinedFields.usage_metadata = usage_metadata;
+        }
         return new AIMessageChunk(combinedFields);
     }
 }

package/dist/messages/ai.d.ts

@@ -3,6 +3,24 @@ import { InvalidToolCall, ToolCall, ToolCallChunk } from "./tool.js";
 export type AIMessageFields = BaseMessageFields & {
     tool_calls?: ToolCall[];
     invalid_tool_calls?: InvalidToolCall[];
+    usage_metadata?: UsageMetadata;
+};
+/**
+ * Usage metadata for a message, such as token counts.
+ */
+export type UsageMetadata = {
+    /**
+     * The count of input (or prompt) tokens.
+     */
+    input_tokens: number;
+    /**
+     * The count of output (or completion) tokens
+     */
+    output_tokens: number;
+    /**
+     * The total token count
+     */
+    total_tokens: number;
 };
 /**
  * Represents an AI message in a conversation.
@@ -10,6 +28,10 @@ export type AIMessageFields = BaseMessageFields & {
 export declare class AIMessage extends BaseMessage {
     tool_calls?: ToolCall[];
     invalid_tool_calls?: InvalidToolCall[];
+    /**
+     * If provided, token usage information associated with the message.
+     */
+    usage_metadata?: UsageMetadata;
     get lc_aliases(): Record<string, string>;
     constructor(fields: string | AIMessageFields, 
     /** @deprecated */
@@ -29,6 +51,10 @@ export declare class AIMessageChunk extends BaseMessageChunk {
     tool_calls?: ToolCall[];
     invalid_tool_calls?: InvalidToolCall[];
     tool_call_chunks?: ToolCallChunk[];
+    /**
+     * If provided, token usage information associated with the message.
+     */
+    usage_metadata?: UsageMetadata;
     constructor(fields: string | AIMessageChunkFields);
     get lc_aliases(): Record<string, string>;
     static lc_name(): string;

package/dist/messages/ai.js

@@ -73,11 +73,21 @@ export class AIMessage extends BaseMessage {
             writable: true,
             value: []
         });
+        /**
+         * If provided, token usage information associated with the message.
+         */
+        Object.defineProperty(this, "usage_metadata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         if (typeof initParams !== "string") {
             this.tool_calls = initParams.tool_calls ?? this.tool_calls;
             this.invalid_tool_calls =
                 initParams.invalid_tool_calls ?? this.invalid_tool_calls;
         }
+        this.usage_metadata = initParams.usage_metadata;
     }
     static lc_name() {
         return "AIMessage";
@@ -167,11 +177,21 @@ export class AIMessageChunk extends BaseMessageChunk {
             writable: true,
             value: []
         });
+        /**
+         * If provided, token usage information associated with the message.
+         */
+        Object.defineProperty(this, "usage_metadata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.tool_call_chunks =
-            initParams?.tool_call_chunks ?? this.tool_call_chunks;
-        this.tool_calls = initParams?.tool_calls ?? this.tool_calls;
+            initParams.tool_call_chunks ?? this.tool_call_chunks;
+        this.tool_calls = initParams.tool_calls ?? this.tool_calls;
         this.invalid_tool_calls =
-            initParams?.invalid_tool_calls ?? this.invalid_tool_calls;
+            initParams.invalid_tool_calls ?? this.invalid_tool_calls;
+        this.usage_metadata = initParams.usage_metadata;
     }
     get lc_aliases() {
         // exclude snake case conversion to pascal case
@@ -202,6 +222,25 @@ export class AIMessageChunk extends BaseMessageChunk {
                 combinedFields.tool_call_chunks = rawToolCalls;
             }
         }
+        if (this.usage_metadata !== undefined ||
+            chunk.usage_metadata !== undefined) {
+            const left = this.usage_metadata ?? {
+                input_tokens: 0,
+                output_tokens: 0,
+                total_tokens: 0,
+            };
+            const right = chunk.usage_metadata ?? {
+                input_tokens: 0,
+                output_tokens: 0,
+                total_tokens: 0,
+            };
+            const usage_metadata = {
+                input_tokens: left.input_tokens + right.input_tokens,
+                output_tokens: left.output_tokens + right.output_tokens,
+                total_tokens: left.total_tokens + right.total_tokens,
+            };
+            combinedFields.usage_metadata = usage_metadata;
+        }
         return new AIMessageChunk(combinedFields);
     }
 }

package/dist/runnables/base.cjs

@@ -481,7 +481,7 @@ class Runnable extends serializable_js_1.Serializable {
     async *_streamEventsV2(input, options, streamOptions) {
         const eventStreamer = new event_stream_js_1.EventStreamCallbackHandler({
             ...streamOptions,
-            autoClose: true,
+            autoClose: false,
         });
         const config = (0, config_js_1.ensureConfig)(options);
         const runId = config.runId ?? (0, uuid_1.v4)();
@@ -503,11 +503,16 @@ class Runnable extends serializable_js_1.Serializable {
         // add each chunk to the output stream
         const outerThis = this;
         async function consumeRunnableStream() {
-            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
+            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.finish();
             }
         }
         const runnableStreamConsumePromise = consumeRunnableStream();

package/dist/runnables/base.js

@@ -474,7 +474,7 @@ export class Runnable extends Serializable {
     async *_streamEventsV2(input, options, streamOptions) {
         const eventStreamer = new EventStreamCallbackHandler({
             ...streamOptions,
-            autoClose: true,
+            autoClose: false,
         });
         const config = ensureConfig(options);
         const runId = config.runId ?? uuidv4();
@@ -496,11 +496,16 @@ export class Runnable extends Serializable {
         // add each chunk to the output stream
         const outerThis = this;
         async function consumeRunnableStream() {
-            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
+            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.finish();
             }
         }
         const runnableStreamConsumePromise = consumeRunnableStream();

package/dist/runnables/remote.cjs

@@ -310,7 +310,8 @@ class RemoteRunnable extends base_js_1.Runnable {
     async *_streamIterator(input, options) {
         const [config, kwargs] = this._separateRunnableConfigFromCallOptions(options);
         const callbackManager_ = await (0, config_js_1.getCallbackManagerForConfig)(options);
-        const runManager = await callbackManager_?.handleChainStart(this.toJSON(), (0, base_js_1._coerceToDict)(input, "input"), undefined, undefined, undefined, undefined, options?.runName);
+        const runManager = await callbackManager_?.handleChainStart(this.toJSON(), (0, base_js_1._coerceToDict)(input, "input"), config.runId, undefined, undefined, undefined, config.runName);
+        delete config.runId;
         let finalOutput;
         let finalOutputSupported = true;
         try {
@@ -360,7 +361,8 @@ class RemoteRunnable extends base_js_1.Runnable {
     async *streamLog(input, options, streamOptions) {
         const [config, kwargs] = this._separateRunnableConfigFromCallOptions(options);
         const callbackManager_ = await (0, config_js_1.getCallbackManagerForConfig)(options);
-        const runManager = await callbackManager_?.handleChainStart(this.toJSON(), (0, base_js_1._coerceToDict)(input, "input"), undefined, undefined, undefined, undefined, options?.runName);
+        const runManager = await callbackManager_?.handleChainStart(this.toJSON(), (0, base_js_1._coerceToDict)(input, "input"), config.runId, undefined, undefined, undefined, config.runName);
+        delete config.runId;
         // The type is in camelCase but the API only accepts snake_case.
         const camelCaseStreamOptions = {
             include_names: streamOptions?.includeNames,
@@ -411,7 +413,8 @@ class RemoteRunnable extends base_js_1.Runnable {
         const generator = async function* () {
             const [config, kwargs] = outerThis._separateRunnableConfigFromCallOptions(options);
             const callbackManager_ = await (0, config_js_1.getCallbackManagerForConfig)(options);
-            const runManager = await callbackManager_?.handleChainStart(outerThis.toJSON(), (0, base_js_1._coerceToDict)(input, "input"), undefined, undefined, undefined, undefined, options?.runName);
+            const runManager = await callbackManager_?.handleChainStart(outerThis.toJSON(), (0, base_js_1._coerceToDict)(input, "input"), config.runId, undefined, undefined, undefined, config.runName);
+            delete config.runId;
             // The type is in camelCase but the API only accepts snake_case.
             const camelCaseStreamOptions = {
                 include_names: streamOptions?.includeNames,

package/dist/runnables/remote.js

@@ -307,7 +307,8 @@ export class RemoteRunnable extends Runnable {
     async *_streamIterator(input, options) {
         const [config, kwargs] = this._separateRunnableConfigFromCallOptions(options);
         const callbackManager_ = await getCallbackManagerForConfig(options);
-        const runManager = await callbackManager_?.handleChainStart(this.toJSON(), _coerceToDict(input, "input"), undefined, undefined, undefined, undefined, options?.runName);
+        const runManager = await callbackManager_?.handleChainStart(this.toJSON(), _coerceToDict(input, "input"), config.runId, undefined, undefined, undefined, config.runName);
+        delete config.runId;
         let finalOutput;
         let finalOutputSupported = true;
         try {
@@ -357,7 +358,8 @@ export class RemoteRunnable extends Runnable {
     async *streamLog(input, options, streamOptions) {
         const [config, kwargs] = this._separateRunnableConfigFromCallOptions(options);
         const callbackManager_ = await getCallbackManagerForConfig(options);
-        const runManager = await callbackManager_?.handleChainStart(this.toJSON(), _coerceToDict(input, "input"), undefined, undefined, undefined, undefined, options?.runName);
+        const runManager = await callbackManager_?.handleChainStart(this.toJSON(), _coerceToDict(input, "input"), config.runId, undefined, undefined, undefined, config.runName);
+        delete config.runId;
         // The type is in camelCase but the API only accepts snake_case.
         const camelCaseStreamOptions = {
             include_names: streamOptions?.includeNames,
@@ -408,7 +410,8 @@ export class RemoteRunnable extends Runnable {
         const generator = async function* () {
             const [config, kwargs] = outerThis._separateRunnableConfigFromCallOptions(options);
             const callbackManager_ = await getCallbackManagerForConfig(options);
-            const runManager = await callbackManager_?.handleChainStart(outerThis.toJSON(), _coerceToDict(input, "input"), undefined, undefined, undefined, undefined, options?.runName);
+            const runManager = await callbackManager_?.handleChainStart(outerThis.toJSON(), _coerceToDict(input, "input"), config.runId, undefined, undefined, undefined, config.runName);
+            delete config.runId;
             // The type is in camelCase but the API only accepts snake_case.
             const camelCaseStreamOptions = {
                 include_names: streamOptions?.includeNames,

package/dist/tracers/event_stream.cjs

@@ -70,12 +70,6 @@ class EventStreamCallbackHandler extends base_js_1.BaseTracer {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "rootId", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         Object.defineProperty(this, "runInfoMap", {
             enumerable: true,
             configurable: true,
@@ -164,7 +158,10 @@ class EventStreamCallbackHandler extends base_js_1.BaseTracer {
             return;
         }
         const runInfo = this.runInfoMap.get(runId);
-        // run has finished, don't issue any stream events
+        // Run has finished, don't issue any stream events.
+        // An example of this is for runnables that use the default
+        // implementation of .stream(), which delegates to .invoke()
+        // and calls .onChainEnd() before passing it to the iterator.
         if (runInfo === undefined) {
             yield firstChunk.value;
             return;
@@ -207,7 +204,7 @@ class EventStreamCallbackHandler extends base_js_1.BaseTracer {
             finally {
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 tappedPromiseResolver();
-                // Don't delete from the map to keep track of which runs have been tapped.
+                // Don't delete from the promises map to keep track of which runs have been tapped.
             }
         }
         else {
@@ -492,18 +489,11 @@ class EventStreamCallbackHandler extends base_js_1.BaseTracer {
             metadata: runInfo.metadata,
         }, runInfo);
     }
-    async onRunCreate(run) {
-        if (this.rootId === undefined) {
-            this.rootId = run.id;
-        }
-    }
-    async onRunUpdate(run) {
-        if (run.id === this.rootId && this.autoClose) {
-            const pendingPromises = [...this.tappedPromises.values()];
-            void Promise.all(pendingPromises).finally(() => {
-                void this.writer.close();
-            });
-        }
+    async finish() {
+        const pendingPromises = [...this.tappedPromises.values()];
+        void Promise.all(pendingPromises).finally(() => {
+            void this.writer.close();
+        });
     }
 }
 exports.EventStreamCallbackHandler = EventStreamCallbackHandler;

package/dist/tracers/event_stream.d.ts

@@ -109,7 +109,6 @@ export declare class EventStreamCallbackHandler extends BaseTracer {
     protected excludeNames?: string[];
     protected excludeTypes?: string[];
     protected excludeTags?: string[];
-    protected rootId?: string;
     private runInfoMap;
     private tappedPromises;
     protected transformStream: TransformStream;
@@ -134,7 +133,6 @@ export declare class EventStreamCallbackHandler extends BaseTracer {
     onToolEnd(run: Run): Promise<void>;
     onRetrieverStart(run: Run): Promise<void>;
     onRetrieverEnd(run: Run): Promise<void>;
-    onRunCreate(run: Run): Promise<void>;
-    onRunUpdate(run: Run): Promise<void>;
+    finish(): Promise<void>;
 }
 export {};

package/dist/tracers/event_stream.js

@@ -66,12 +66,6 @@ export class EventStreamCallbackHandler extends BaseTracer {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "rootId", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         Object.defineProperty(this, "runInfoMap", {
             enumerable: true,
             configurable: true,
@@ -160,7 +154,10 @@ export class EventStreamCallbackHandler extends BaseTracer {
             return;
         }
         const runInfo = this.runInfoMap.get(runId);
-        // run has finished, don't issue any stream events
+        // Run has finished, don't issue any stream events.
+        // An example of this is for runnables that use the default
+        // implementation of .stream(), which delegates to .invoke()
+        // and calls .onChainEnd() before passing it to the iterator.
         if (runInfo === undefined) {
             yield firstChunk.value;
             return;
@@ -203,7 +200,7 @@ export class EventStreamCallbackHandler extends BaseTracer {
             finally {
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 tappedPromiseResolver();
-                // Don't delete from the map to keep track of which runs have been tapped.
+                // Don't delete from the promises map to keep track of which runs have been tapped.
             }
         }
         else {
@@ -488,17 +485,10 @@ export class EventStreamCallbackHandler extends BaseTracer {
             metadata: runInfo.metadata,
         }, runInfo);
     }
-    async onRunCreate(run) {
-        if (this.rootId === undefined) {
-            this.rootId = run.id;
-        }
-    }
-    async onRunUpdate(run) {
-        if (run.id === this.rootId && this.autoClose) {
-            const pendingPromises = [...this.tappedPromises.values()];
-            void Promise.all(pendingPromises).finally(() => {
-                void this.writer.close();
-            });
-        }
+    async finish() {
+        const pendingPromises = [...this.tappedPromises.values()];
+        void Promise.all(pendingPromises).finally(() => {
+            void this.writer.close();
+        });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/core",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Core LangChain.js abstractions and schemas",
   "type": "module",
   "engines": {