langsmith 0.3.29 → 0.3.30

package/dist/client.cjs

@@ -1083,7 +1083,7 @@ class Client {
     async readRun(runId, { loadChildRuns } = { loadChildRuns: false }) {
         (0, _uuid_js_1.assertUuid)(runId);
         let run = await this._get(`/runs/${runId}`);
-        if (loadChildRuns && run.child_run_ids) {
+        if (loadChildRuns) {
             run = await this._loadChildRuns(run);
         }
         return run;
@@ -1122,7 +1122,11 @@ class Client {
         }
     }
     async _loadChildRuns(run) {
-        const childRuns = await toArray(this.listRuns({ id: run.child_run_ids }));
+        const childRuns = await toArray(this.listRuns({
+            isRoot: false,
+            projectId: run.session_id,
+            traceId: run.trace_id,
+        }));
         const treemap = {};
         const runs = {};
         // TODO: make dotted order required when the migration finishes
@@ -1132,11 +1136,14 @@ class Client {
                 childRun.parent_run_id === undefined) {
                 throw new Error(`Child run ${childRun.id} has no parent`);
             }
-            if (!(childRun.parent_run_id in treemap)) {
-                treemap[childRun.parent_run_id] = [];
+            if (childRun.dotted_order?.startsWith(run.dotted_order ?? "") &&
+                childRun.id !== run.id) {
+                if (!(childRun.parent_run_id in treemap)) {
+                    treemap[childRun.parent_run_id] = [];
+                }
+                treemap[childRun.parent_run_id].push(childRun);
+                runs[childRun.id] = childRun;
             }
-            treemap[childRun.parent_run_id].push(childRun);
-            runs[childRun.id] = childRun;
         }
         run.child_runs = treemap[run.id] || [];
         for (const runId in treemap) {
@@ -1243,7 +1250,6 @@ class Client {
         }
         const default_select = [
             "app_path",
-            "child_run_ids",
             "completion_cost",
             "completion_tokens",
             "dotted_order",

package/dist/client.js

@@ -1045,7 +1045,7 @@ export class Client {
     async readRun(runId, { loadChildRuns } = { loadChildRuns: false }) {
         assertUuid(runId);
         let run = await this._get(`/runs/${runId}`);
-        if (loadChildRuns && run.child_run_ids) {
+        if (loadChildRuns) {
             run = await this._loadChildRuns(run);
         }
         return run;
@@ -1084,7 +1084,11 @@ export class Client {
         }
     }
     async _loadChildRuns(run) {
-        const childRuns = await toArray(this.listRuns({ id: run.child_run_ids }));
+        const childRuns = await toArray(this.listRuns({
+            isRoot: false,
+            projectId: run.session_id,
+            traceId: run.trace_id,
+        }));
         const treemap = {};
         const runs = {};
         // TODO: make dotted order required when the migration finishes
@@ -1094,11 +1098,14 @@ export class Client {
                 childRun.parent_run_id === undefined) {
                 throw new Error(`Child run ${childRun.id} has no parent`);
             }
-            if (!(childRun.parent_run_id in treemap)) {
-                treemap[childRun.parent_run_id] = [];
+            if (childRun.dotted_order?.startsWith(run.dotted_order ?? "") &&
+                childRun.id !== run.id) {
+                if (!(childRun.parent_run_id in treemap)) {
+                    treemap[childRun.parent_run_id] = [];
+                }
+                treemap[childRun.parent_run_id].push(childRun);
+                runs[childRun.id] = childRun;
             }
-            treemap[childRun.parent_run_id].push(childRun);
-            runs[childRun.id] = childRun;
         }
         run.child_runs = treemap[run.id] || [];
         for (const runId in treemap) {
@@ -1205,7 +1212,6 @@ export class Client {
         }
         const default_select = [
             "app_path",
-            "child_run_ids",
             "completion_cost",
             "completion_tokens",
             "dotted_order",

package/dist/index.cjs

@@ -8,4 +8,4 @@ Object.defineProperty(exports, "RunTree", { enumerable: true, get: function () {
 var fetch_js_1 = require("./singletons/fetch.cjs");
 Object.defineProperty(exports, "overrideFetchImplementation", { enumerable: true, get: function () { return fetch_js_1.overrideFetchImplementation; } });
 // Update using yarn bump-version
-exports.__version__ = "0.3.29";
+exports.__version__ = "0.3.30";

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export { Client, type ClientConfig, type LangSmithTracingClientInterface, } from
 export type { Dataset, Example, TracerSession, Run, Feedback, RetrieverOutput, } from "./schemas.js";
 export { RunTree, type RunTreeConfig } from "./run_trees.js";
 export { overrideFetchImplementation } from "./singletons/fetch.js";
-export declare const __version__ = "0.3.29";
+export declare const __version__ = "0.3.30";

package/dist/index.js

@@ -2,4 +2,4 @@ export { Client, } from "./client.js";
 export { RunTree } from "./run_trees.js";
 export { overrideFetchImplementation } from "./singletons/fetch.js";
 // Update using yarn bump-version
-export const __version__ = "0.3.29";
+export const __version__ = "0.3.30";

package/dist/run_trees.cjs

@@ -292,6 +292,18 @@ class RunTree {
             }
         }
     }
+    set metadata(metadata) {
+        this.extra = {
+            ...this.extra,
+            metadata: {
+                ...this.extra?.metadata,
+                ...metadata,
+            },
+        };
+    }
+    get metadata() {
+        return this.extra?.metadata;
+    }
     static getDefaultConfig() {
         return {
             id: uuid.v4(),

package/dist/run_trees.d.ts

@@ -79,6 +79,8 @@ export declare class RunTree implements BaseRun {
      */
     attachments?: Attachments;
     constructor(originalConfig: RunTreeConfig | RunTree);
+    set metadata(metadata: KVMap);
+    get metadata(): KVMap;
     private static getDefaultConfig;
     private static getSharedClient;
     createChild(config: RunTreeConfig): RunTree;

package/dist/run_trees.js

@@ -253,6 +253,18 @@ export class RunTree {
             }
         }
     }
+    set metadata(metadata) {
+        this.extra = {
+            ...this.extra,
+            metadata: {
+                ...this.extra?.metadata,
+                ...metadata,
+            },
+        };
+    }
+    get metadata() {
+        return this.extra?.metadata;
+    }
     static getDefaultConfig() {
         return {
             id: uuid.v4(),

package/dist/schemas.d.ts

@@ -531,5 +531,26 @@ export type UsageMetadata = {
      * Does *not* need to sum to full output token count. Does *not* need to have all keys.
      */
     output_token_details?: OutputTokenDetails;
+    /**
+     * The cost of the input tokens.
+     */
+    input_cost?: number;
+    /**
+     * The cost of the output tokens.
+     */
+    output_cost?: number;
+    /**
+     * The total cost of the tokens.
+     */
+    total_cost?: number;
+    /**
+     * The cost details of the input tokens.
+     */
+    input_cost_details?: Record<string, unknown>;
+    /**
+     * The cost details of the output tokens.
+     */
+    output_cost_details?: Record<string, unknown>;
 };
+export type ExtractedUsageMetadata = Partial<UsageMetadata>;
 export {};

package/dist/traceable.cjs

@@ -35,22 +35,64 @@ const handleRunInputs = (inputs, processInputs) => {
         return inputs;
     }
 };
-const handleRunOutputs = (rawOutputs, processOutputs) => {
+const _extractUsage = (runData) => {
+    const usageMetadataFromMetadata = (runData.runTree.extra.metadata ?? {})
+        .usage_metadata;
+    return runData.outputs.usage_metadata ?? usageMetadataFromMetadata;
+};
+function validateExtractedUsageMetadata(data) {
+    const allowedKeys = new Set([
+        "input_tokens",
+        "output_tokens",
+        "total_tokens",
+        "input_token_details",
+        "output_token_details",
+        "input_cost",
+        "output_cost",
+        "total_cost",
+        "input_cost_details",
+        "output_cost_details",
+    ]);
+    const extraKeys = Object.keys(data).filter((key) => !allowedKeys.has(key));
+    if (extraKeys.length > 0) {
+        throw new Error(`Unexpected keys in usage metadata: ${extraKeys.join(", ")}`);
+    }
+    return data;
+}
+// Note: This mutates the run tree
+function handleRunOutputs(params) {
+    const { runTree, rawOutputs, processOutputsFn } = params;
     let outputs;
     if ((0, asserts_js_1.isKVMap)(rawOutputs)) {
-        outputs = rawOutputs;
+        outputs = { ...rawOutputs };
     }
     else {
         outputs = { outputs: rawOutputs };
     }
     try {
-        return processOutputs(outputs);
+        outputs = processOutputsFn(outputs);
     }
     catch (e) {
-        console.error("Error occurred during processOutputs. Sending raw outputs:", e);
-        return outputs;
+        console.error("Error occurred during processOutputs. Sending unprocessed outputs:", e);
     }
-};
+    if (runTree !== undefined) {
+        let usageMetadata;
+        try {
+            usageMetadata = _extractUsage({ runTree, outputs });
+        }
+        catch (e) {
+            console.error("Error occurred while extracting usage metadata:", e);
+        }
+        if (usageMetadata !== undefined) {
+            runTree.extra.metadata = {
+                ...runTree.extra.metadata,
+                usage_metadata: validateExtractedUsageMetadata(usageMetadata),
+            };
+            outputs.usage_metadata = usageMetadata;
+        }
+    }
+    return outputs;
+}
 const handleRunAttachments = (rawInputs, extractAttachments) => {
     if (!extractAttachments) {
         return [undefined, rawInputs];
@@ -358,7 +400,12 @@ function traceable(wrappedFunc, config) {
                                 : reader.read());
                             if (result.done) {
                                 finished = true;
-                                await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
+                                const processedOutputs = handleRunOutputs({
+                                    runTree: currentRunTree,
+                                    rawOutputs: await handleChunks(chunks),
+                                    processOutputsFn,
+                                });
+                                await currentRunTree?.end(processedOutputs);
                                 await handleEnd();
                                 controller.close();
                                 break;
@@ -377,7 +424,12 @@ function traceable(wrappedFunc, config) {
                     async cancel(reason) {
                         if (!finished)
                             await currentRunTree?.end(undefined, "Cancelled");
-                        await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
+                        const processedOutputs = handleRunOutputs({
+                            runTree: currentRunTree,
+                            rawOutputs: await handleChunks(chunks),
+                            processOutputsFn,
+                        });
+                        await currentRunTree?.end(processedOutputs);
                         await handleEnd();
                         return reader.cancel(reason);
                     },
@@ -414,7 +466,12 @@ function traceable(wrappedFunc, config) {
                 finally {
                     if (!finished)
                         await currentRunTree?.end(undefined, "Cancelled");
-                    await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
+                    const processedOutputs = handleRunOutputs({
+                        runTree: currentRunTree,
+                        rawOutputs: await handleChunks(chunks),
+                        processOutputsFn,
+                    });
+                    await currentRunTree?.end(processedOutputs);
                     await handleEnd();
                 }
             }
@@ -494,12 +551,17 @@ function traceable(wrappedFunc, config) {
                     if ((0, asserts_js_1.isGenerator)(wrappedFunc) && (0, asserts_js_1.isIteratorLike)(rawOutput)) {
                         const chunks = gatherAll(rawOutput);
                         try {
-                            await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks.reduce((memo, { value, done }) => {
-                                if (!done || typeof value !== "undefined") {
-                                    memo.push(value);
-                                }
-                                return memo;
-                            }, [])), processOutputsFn));
+                            const processedOutputs = handleRunOutputs({
+                                runTree: currentRunTree,
+                                rawOutputs: await handleChunks(chunks.reduce((memo, { value, done }) => {
+                                    if (!done || typeof value !== "undefined") {
+                                        memo.push(value);
+                                    }
+                                    return memo;
+                                }, [])),
+                                processOutputsFn,
+                            });
+                            await currentRunTree?.end(processedOutputs);
                             await handleEnd();
                         }
                         catch (e) {
@@ -514,7 +576,12 @@ function traceable(wrappedFunc, config) {
                         })();
                     }
                     try {
-                        await currentRunTree?.end(handleRunOutputs(rawOutput, processOutputsFn));
+                        const processedOutputs = handleRunOutputs({
+                            runTree: currentRunTree,
+                            rawOutputs: rawOutput,
+                            processOutputsFn,
+                        });
+                        await currentRunTree?.end(processedOutputs);
                         await handleEnd();
                     }
                     finally {

package/dist/traceable.js

@@ -31,22 +31,64 @@ const handleRunInputs = (inputs, processInputs) => {
         return inputs;
     }
 };
-const handleRunOutputs = (rawOutputs, processOutputs) => {
+const _extractUsage = (runData) => {
+    const usageMetadataFromMetadata = (runData.runTree.extra.metadata ?? {})
+        .usage_metadata;
+    return runData.outputs.usage_metadata ?? usageMetadataFromMetadata;
+};
+function validateExtractedUsageMetadata(data) {
+    const allowedKeys = new Set([
+        "input_tokens",
+        "output_tokens",
+        "total_tokens",
+        "input_token_details",
+        "output_token_details",
+        "input_cost",
+        "output_cost",
+        "total_cost",
+        "input_cost_details",
+        "output_cost_details",
+    ]);
+    const extraKeys = Object.keys(data).filter((key) => !allowedKeys.has(key));
+    if (extraKeys.length > 0) {
+        throw new Error(`Unexpected keys in usage metadata: ${extraKeys.join(", ")}`);
+    }
+    return data;
+}
+// Note: This mutates the run tree
+function handleRunOutputs(params) {
+    const { runTree, rawOutputs, processOutputsFn } = params;
     let outputs;
     if (isKVMap(rawOutputs)) {
-        outputs = rawOutputs;
+        outputs = { ...rawOutputs };
     }
     else {
         outputs = { outputs: rawOutputs };
     }
     try {
-        return processOutputs(outputs);
+        outputs = processOutputsFn(outputs);
     }
     catch (e) {
-        console.error("Error occurred during processOutputs. Sending raw outputs:", e);
-        return outputs;
+        console.error("Error occurred during processOutputs. Sending unprocessed outputs:", e);
     }
-};
+    if (runTree !== undefined) {
+        let usageMetadata;
+        try {
+            usageMetadata = _extractUsage({ runTree, outputs });
+        }
+        catch (e) {
+            console.error("Error occurred while extracting usage metadata:", e);
+        }
+        if (usageMetadata !== undefined) {
+            runTree.extra.metadata = {
+                ...runTree.extra.metadata,
+                usage_metadata: validateExtractedUsageMetadata(usageMetadata),
+            };
+            outputs.usage_metadata = usageMetadata;
+        }
+    }
+    return outputs;
+}
 const handleRunAttachments = (rawInputs, extractAttachments) => {
     if (!extractAttachments) {
         return [undefined, rawInputs];
@@ -354,7 +396,12 @@ export function traceable(wrappedFunc, config) {
                                 : reader.read());
                             if (result.done) {
                                 finished = true;
-                                await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
+                                const processedOutputs = handleRunOutputs({
+                                    runTree: currentRunTree,
+                                    rawOutputs: await handleChunks(chunks),
+                                    processOutputsFn,
+                                });
+                                await currentRunTree?.end(processedOutputs);
                                 await handleEnd();
                                 controller.close();
                                 break;
@@ -373,7 +420,12 @@ export function traceable(wrappedFunc, config) {
                     async cancel(reason) {
                         if (!finished)
                             await currentRunTree?.end(undefined, "Cancelled");
-                        await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
+                        const processedOutputs = handleRunOutputs({
+                            runTree: currentRunTree,
+                            rawOutputs: await handleChunks(chunks),
+                            processOutputsFn,
+                        });
+                        await currentRunTree?.end(processedOutputs);
                         await handleEnd();
                         return reader.cancel(reason);
                     },
@@ -410,7 +462,12 @@ export function traceable(wrappedFunc, config) {
                 finally {
                     if (!finished)
                         await currentRunTree?.end(undefined, "Cancelled");
-                    await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
+                    const processedOutputs = handleRunOutputs({
+                        runTree: currentRunTree,
+                        rawOutputs: await handleChunks(chunks),
+                        processOutputsFn,
+                    });
+                    await currentRunTree?.end(processedOutputs);
                     await handleEnd();
                 }
             }
@@ -490,12 +547,17 @@ export function traceable(wrappedFunc, config) {
                     if (isGenerator(wrappedFunc) && isIteratorLike(rawOutput)) {
                         const chunks = gatherAll(rawOutput);
                         try {
-                            await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks.reduce((memo, { value, done }) => {
-                                if (!done || typeof value !== "undefined") {
-                                    memo.push(value);
-                                }
-                                return memo;
-                            }, [])), processOutputsFn));
+                            const processedOutputs = handleRunOutputs({
+                                runTree: currentRunTree,
+                                rawOutputs: await handleChunks(chunks.reduce((memo, { value, done }) => {
+                                    if (!done || typeof value !== "undefined") {
+                                        memo.push(value);
+                                    }
+                                    return memo;
+                                }, [])),
+                                processOutputsFn,
+                            });
+                            await currentRunTree?.end(processedOutputs);
                             await handleEnd();
                         }
                         catch (e) {
@@ -510,7 +572,12 @@ export function traceable(wrappedFunc, config) {
                         })();
                     }
                     try {
-                        await currentRunTree?.end(handleRunOutputs(rawOutput, processOutputsFn));
+                        const processedOutputs = handleRunOutputs({
+                            runTree: currentRunTree,
+                            rawOutputs: rawOutput,
+                            processOutputsFn,
+                        });
+                        await currentRunTree?.end(processedOutputs);
                         await handleEnd();
                     }
                     finally {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langsmith",
-  "version": "0.3.29",
+  "version": "0.3.30",
   "description": "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform.",
   "packageManager": "yarn@1.22.19",
   "files": [