langsmith 0.1.65 → 0.1.66

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.1.65";
+exports.__version__ = "0.1.66";

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export { Client, type ClientConfig } from "./client.js";
 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.1.65";
+export declare const __version__ = "0.1.66";

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.1.65";
+export const __version__ = "0.1.66";

package/dist/schemas.d.ts

@@ -391,4 +391,75 @@ export interface RunWithAnnotationQueueInfo extends BaseRun {
     /** The time this run was added to the queue. */
     added_at?: string;
 }
+/**
+ * Breakdown of input token counts.
+ *
+ * Does not *need* to sum to full input token count. Does *not* need to have all keys.
+ */
+export type InputTokenDetails = {
+    /**
+     * Audio input tokens.
+     */
+    audio?: number;
+    /**
+     * Input tokens that were cached and there was a cache hit.
+     *
+     * Since there was a cache hit, the tokens were read from the cache.
+     * More precisely, the model state given these tokens was read from the cache.
+     */
+    cache_read?: number;
+    /**
+     * Input tokens that were cached and there was a cache miss.
+     *
+     * Since there was a cache miss, the cache was created from these tokens.
+     */
+    cache_creation?: number;
+};
+/**
+ * Breakdown of output token counts.
+ *
+ * Does *not* need to sum to full output token count. Does *not* need to have all keys.
+ */
+export type OutputTokenDetails = {
+    /**
+     * Audio output tokens
+     */
+    audio?: number;
+    /**
+     * Reasoning output tokens.
+     *
+     * Tokens generated by the model in a chain of thought process (i.e. by
+     * OpenAI's o1 models) that are not returned as part of model output.
+     */
+    reasoning?: number;
+};
+/**
+ * Usage metadata for a message, such as token counts.
+ */
+export type UsageMetadata = {
+    /**
+     * Count of input (or prompt) tokens. Sum of all input token types.
+     */
+    input_tokens: number;
+    /**
+     * Count of output (or completion) tokens. Sum of all output token types.
+     */
+    output_tokens: number;
+    /**
+     * Total token count. Sum of input_tokens + output_tokens.
+     */
+    total_tokens: number;
+    /**
+     * Breakdown of input token counts.
+     *
+     * Does *not* need to sum to full input token count. Does *not* need to have all keys.
+     */
+    input_token_details?: InputTokenDetails;
+    /**
+     * Breakdown of output token counts.
+     *
+     * Does *not* need to sum to full output token count. Does *not* need to have all keys.
+     */
+    output_token_details?: OutputTokenDetails;
+};
 export {};

package/dist/traceable.cjs

@@ -8,30 +8,50 @@ const traceable_js_1 = require("./singletons/traceable.cjs");
 const constants_js_1 = require("./singletons/constants.cjs");
 const asserts_js_1 = require("./utils/asserts.cjs");
 traceable_js_1.AsyncLocalStorageProviderSingleton.initializeGlobalInstance(new node_async_hooks_1.AsyncLocalStorage());
-const handleRunInputs = (rawInputs) => {
+const handleRunInputs = (rawInputs, processInputs) => {
     const firstInput = rawInputs[0];
+    let inputs;
     if (firstInput == null) {
-        return {};
+        inputs = {};
     }
-    if (rawInputs.length > 1) {
-        return { args: rawInputs };
+    else if (rawInputs.length > 1) {
+        inputs = { args: rawInputs };
     }
-    if ((0, asserts_js_1.isKVMap)(firstInput)) {
-        return firstInput;
+    else if ((0, asserts_js_1.isKVMap)(firstInput)) {
+        inputs = firstInput;
+    }
+    else {
+        inputs = { input: firstInput };
+    }
+    try {
+        return processInputs(inputs);
+    }
+    catch (e) {
+        console.error("Error occurred during processInputs. Sending raw inputs:", e);
+        return inputs;
     }
-    return { input: firstInput };
 };
-const handleRunOutputs = (rawOutputs) => {
+const handleRunOutputs = (rawOutputs, processOutputs) => {
+    let outputs;
     if ((0, asserts_js_1.isKVMap)(rawOutputs)) {
-        return rawOutputs;
+        outputs = rawOutputs;
+    }
+    else {
+        outputs = { outputs: rawOutputs };
+    }
+    try {
+        return processOutputs(outputs);
+    }
+    catch (e) {
+        console.error("Error occurred during processOutputs. Sending raw outputs:", e);
+        return outputs;
     }
-    return { outputs: rawOutputs };
 };
-const getTracingRunTree = (runTree, inputs, getInvocationParams) => {
+const getTracingRunTree = (runTree, inputs, getInvocationParams, processInputs) => {
     if (!(0, env_js_1.isTracingEnabled)(runTree.tracingEnabled)) {
         return undefined;
     }
-    runTree.inputs = handleRunInputs(inputs);
+    runTree.inputs = handleRunInputs(inputs, processInputs);
     const invocationParams = getInvocationParams?.(...inputs);
     if (invocationParams != null) {
         runTree.extra ??= {};
@@ -193,7 +213,9 @@ const convertSerializableArg = (arg) => {
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function traceable(wrappedFunc, config) {
-    const { aggregator, argsConfigPath, __finalTracedIteratorKey, ...runTreeConfig } = config ?? {};
+    const { aggregator, argsConfigPath, __finalTracedIteratorKey, processInputs, processOutputs, ...runTreeConfig } = config ?? {};
+    const processInputsFn = processInputs ?? ((x) => x);
+    const processOutputsFn = processOutputs ?? ((x) => x);
     const traceableFunc = (...args) => {
         let ensuredConfig;
         try {
@@ -251,7 +273,7 @@ function traceable(wrappedFunc, config) {
             // used for handoff between LangChain.JS and traceable functions
             if ((0, run_trees_js_1.isRunnableConfigLike)(firstArg)) {
                 return [
-                    getTracingRunTree(run_trees_js_1.RunTree.fromRunnableConfig(firstArg, ensuredConfig), restArgs, config?.getInvocationParams),
+                    getTracingRunTree(run_trees_js_1.RunTree.fromRunnableConfig(firstArg, ensuredConfig), restArgs, config?.getInvocationParams, processInputsFn),
                     restArgs,
                 ];
             }
@@ -267,7 +289,7 @@ function traceable(wrappedFunc, config) {
             if (firstArg === traceable_js_1.ROOT || (0, run_trees_js_1.isRunTree)(firstArg)) {
                 const currentRunTree = getTracingRunTree(firstArg === traceable_js_1.ROOT
                     ? new run_trees_js_1.RunTree(ensuredConfig)
-                    : firstArg.createChild(ensuredConfig), restArgs, config?.getInvocationParams);
+                    : firstArg.createChild(ensuredConfig), restArgs, config?.getInvocationParams, processInputsFn);
                 return [currentRunTree, [currentRunTree, ...restArgs]];
             }
             // Node.JS uses AsyncLocalStorage (ALS) and AsyncResource
@@ -275,11 +297,11 @@ function traceable(wrappedFunc, config) {
             const prevRunFromStore = asyncLocalStorage.getStore();
             if ((0, run_trees_js_1.isRunTree)(prevRunFromStore)) {
                 return [
-                    getTracingRunTree(prevRunFromStore.createChild(ensuredConfig), processedArgs, config?.getInvocationParams),
+                    getTracingRunTree(prevRunFromStore.createChild(ensuredConfig), processedArgs, config?.getInvocationParams, processInputsFn),
                     processedArgs,
                 ];
             }
-            const currentRunTree = getTracingRunTree(new run_trees_js_1.RunTree(ensuredConfig), processedArgs, config?.getInvocationParams);
+            const currentRunTree = getTracingRunTree(new run_trees_js_1.RunTree(ensuredConfig), processedArgs, config?.getInvocationParams, processInputsFn);
             // If a context var is set by LangChain outside of a traceable,
             // it will be an object with a single property and we should copy
             // context vars over into the new run tree.
@@ -317,7 +339,7 @@ function traceable(wrappedFunc, config) {
                                 : reader.read());
                             if (result.done) {
                                 finished = true;
-                                await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks)));
+                                await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
                                 await handleEnd();
                                 controller.close();
                                 break;
@@ -329,7 +351,7 @@ function traceable(wrappedFunc, config) {
                     async cancel(reason) {
                         if (!finished)
                             await currentRunTree?.end(undefined, "Cancelled");
-                        await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks)));
+                        await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
                         await handleEnd();
                         return reader.cancel(reason);
                     },
@@ -359,7 +381,7 @@ function traceable(wrappedFunc, config) {
                 finally {
                     if (!finished)
                         await currentRunTree?.end(undefined, "Cancelled");
-                    await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks)));
+                    await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
                     await handleEnd();
                 }
             }
@@ -444,7 +466,7 @@ function traceable(wrappedFunc, config) {
                                     memo.push(value);
                                 }
                                 return memo;
-                            }, []))));
+                            }, [])), processOutputsFn));
                             await handleEnd();
                         }
                         catch (e) {
@@ -459,7 +481,7 @@ function traceable(wrappedFunc, config) {
                         })();
                     }
                     try {
-                        await currentRunTree?.end(handleRunOutputs(rawOutput));
+                        await currentRunTree?.end(handleRunOutputs(rawOutput, processOutputsFn));
                         await handleEnd();
                     }
                     finally {

package/dist/traceable.d.ts

@@ -1,5 +1,5 @@
 import { RunTreeConfig } from "./run_trees.js";
-import { InvocationParamsSchema } from "./schemas.js";
+import { InvocationParamsSchema, KVMap } from "./schemas.js";
 import { TraceableFunction } from "./singletons/types.js";
 /**
  * Higher-order function that takes function as input and returns a
@@ -28,6 +28,24 @@ export declare function traceable<Func extends (...args: any[]) => any>(wrappedF
      * @returns Key-value map of the invocation parameters, which will be merged with the existing metadata
      */
     getInvocationParams?: (...args: Parameters<Func>) => InvocationParamsSchema | undefined;
+    /**
+     * Apply transformations to the inputs before logging.
+     * This function should NOT mutate the inputs.
+     * `processInputs` is not inherited by nested traceable functions.
+     *
+     * @param inputs Key-value map of the function inputs.
+     * @returns Transformed key-value map
+     */
+    processInputs?: (inputs: Readonly<KVMap>) => KVMap;
+    /**
+     * Apply transformations to the outputs before logging.
+     * This function should NOT mutate the outputs.
+     * `processOutputs` is not inherited by nested traceable functions.
+     *
+     * @param outputs Key-value map of the function outputs
+     * @returns Transformed key-value map
+     */
+    processOutputs?: (outputs: Readonly<KVMap>) => KVMap;
 }): TraceableFunction<Func>;
 export { getCurrentRunTree, isTraceableFunction, withRunTree, ROOT, } from "./singletons/traceable.js";
 export type { RunTreeLike, TraceableFunction } from "./singletons/types.js";

package/dist/traceable.js

@@ -5,30 +5,50 @@ import { ROOT, AsyncLocalStorageProviderSingleton, } from "./singletons/traceabl
 import { _LC_CONTEXT_VARIABLES_KEY } from "./singletons/constants.js";
 import { isKVMap, isReadableStream, isAsyncIterable, isIteratorLike, isThenable, isGenerator, isPromiseMethod, } from "./utils/asserts.js";
 AsyncLocalStorageProviderSingleton.initializeGlobalInstance(new AsyncLocalStorage());
-const handleRunInputs = (rawInputs) => {
+const handleRunInputs = (rawInputs, processInputs) => {
     const firstInput = rawInputs[0];
+    let inputs;
     if (firstInput == null) {
-        return {};
+        inputs = {};
     }
-    if (rawInputs.length > 1) {
-        return { args: rawInputs };
+    else if (rawInputs.length > 1) {
+        inputs = { args: rawInputs };
     }
-    if (isKVMap(firstInput)) {
-        return firstInput;
+    else if (isKVMap(firstInput)) {
+        inputs = firstInput;
+    }
+    else {
+        inputs = { input: firstInput };
+    }
+    try {
+        return processInputs(inputs);
+    }
+    catch (e) {
+        console.error("Error occurred during processInputs. Sending raw inputs:", e);
+        return inputs;
     }
-    return { input: firstInput };
 };
-const handleRunOutputs = (rawOutputs) => {
+const handleRunOutputs = (rawOutputs, processOutputs) => {
+    let outputs;
     if (isKVMap(rawOutputs)) {
-        return rawOutputs;
+        outputs = rawOutputs;
+    }
+    else {
+        outputs = { outputs: rawOutputs };
+    }
+    try {
+        return processOutputs(outputs);
+    }
+    catch (e) {
+        console.error("Error occurred during processOutputs. Sending raw outputs:", e);
+        return outputs;
     }
-    return { outputs: rawOutputs };
 };
-const getTracingRunTree = (runTree, inputs, getInvocationParams) => {
+const getTracingRunTree = (runTree, inputs, getInvocationParams, processInputs) => {
     if (!isTracingEnabled(runTree.tracingEnabled)) {
         return undefined;
     }
-    runTree.inputs = handleRunInputs(inputs);
+    runTree.inputs = handleRunInputs(inputs, processInputs);
     const invocationParams = getInvocationParams?.(...inputs);
     if (invocationParams != null) {
         runTree.extra ??= {};
@@ -190,7 +210,9 @@ const convertSerializableArg = (arg) => {
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function traceable(wrappedFunc, config) {
-    const { aggregator, argsConfigPath, __finalTracedIteratorKey, ...runTreeConfig } = config ?? {};
+    const { aggregator, argsConfigPath, __finalTracedIteratorKey, processInputs, processOutputs, ...runTreeConfig } = config ?? {};
+    const processInputsFn = processInputs ?? ((x) => x);
+    const processOutputsFn = processOutputs ?? ((x) => x);
     const traceableFunc = (...args) => {
         let ensuredConfig;
         try {
@@ -248,7 +270,7 @@ export function traceable(wrappedFunc, config) {
             // used for handoff between LangChain.JS and traceable functions
             if (isRunnableConfigLike(firstArg)) {
                 return [
-                    getTracingRunTree(RunTree.fromRunnableConfig(firstArg, ensuredConfig), restArgs, config?.getInvocationParams),
+                    getTracingRunTree(RunTree.fromRunnableConfig(firstArg, ensuredConfig), restArgs, config?.getInvocationParams, processInputsFn),
                     restArgs,
                 ];
             }
@@ -264,7 +286,7 @@ export function traceable(wrappedFunc, config) {
             if (firstArg === ROOT || isRunTree(firstArg)) {
                 const currentRunTree = getTracingRunTree(firstArg === ROOT
                     ? new RunTree(ensuredConfig)
-                    : firstArg.createChild(ensuredConfig), restArgs, config?.getInvocationParams);
+                    : firstArg.createChild(ensuredConfig), restArgs, config?.getInvocationParams, processInputsFn);
                 return [currentRunTree, [currentRunTree, ...restArgs]];
             }
             // Node.JS uses AsyncLocalStorage (ALS) and AsyncResource
@@ -272,11 +294,11 @@ export function traceable(wrappedFunc, config) {
             const prevRunFromStore = asyncLocalStorage.getStore();
             if (isRunTree(prevRunFromStore)) {
                 return [
-                    getTracingRunTree(prevRunFromStore.createChild(ensuredConfig), processedArgs, config?.getInvocationParams),
+                    getTracingRunTree(prevRunFromStore.createChild(ensuredConfig), processedArgs, config?.getInvocationParams, processInputsFn),
                     processedArgs,
                 ];
             }
-            const currentRunTree = getTracingRunTree(new RunTree(ensuredConfig), processedArgs, config?.getInvocationParams);
+            const currentRunTree = getTracingRunTree(new RunTree(ensuredConfig), processedArgs, config?.getInvocationParams, processInputsFn);
             // If a context var is set by LangChain outside of a traceable,
             // it will be an object with a single property and we should copy
             // context vars over into the new run tree.
@@ -314,7 +336,7 @@ export function traceable(wrappedFunc, config) {
                                 : reader.read());
                             if (result.done) {
                                 finished = true;
-                                await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks)));
+                                await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
                                 await handleEnd();
                                 controller.close();
                                 break;
@@ -326,7 +348,7 @@ export function traceable(wrappedFunc, config) {
                     async cancel(reason) {
                         if (!finished)
                             await currentRunTree?.end(undefined, "Cancelled");
-                        await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks)));
+                        await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
                         await handleEnd();
                         return reader.cancel(reason);
                     },
@@ -356,7 +378,7 @@ export function traceable(wrappedFunc, config) {
                 finally {
                     if (!finished)
                         await currentRunTree?.end(undefined, "Cancelled");
-                    await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks)));
+                    await currentRunTree?.end(handleRunOutputs(await handleChunks(chunks), processOutputsFn));
                     await handleEnd();
                 }
             }
@@ -441,7 +463,7 @@ export function traceable(wrappedFunc, config) {
                                     memo.push(value);
                                 }
                                 return memo;
-                            }, []))));
+                            }, [])), processOutputsFn));
                             await handleEnd();
                         }
                         catch (e) {
@@ -456,7 +478,7 @@ export function traceable(wrappedFunc, config) {
                         })();
                     }
                     try {
-                        await currentRunTree?.end(handleRunOutputs(rawOutput));
+                        await currentRunTree?.end(handleRunOutputs(rawOutput, processOutputsFn));
                         await handleEnd();
                     }
                     finally {

package/dist/wrappers/openai.cjs

@@ -113,6 +113,43 @@ const textAggregator = (allChunks
     ];
     return aggregatedOutput;
 };
+function processChatCompletion(outputs) {
+    const chatCompletion = outputs;
+    // copy the original object, minus usage
+    const result = { ...chatCompletion };
+    const usage = chatCompletion.usage;
+    if (usage) {
+        const inputTokenDetails = {
+            ...(usage.prompt_tokens_details?.audio_tokens !== null && {
+                audio: usage.prompt_tokens_details?.audio_tokens,
+            }),
+            ...(usage.prompt_tokens_details?.cached_tokens !== null && {
+                cache_read: usage.prompt_tokens_details?.cached_tokens,
+            }),
+        };
+        const outputTokenDetails = {
+            ...(usage.completion_tokens_details?.audio_tokens !== null && {
+                audio: usage.completion_tokens_details?.audio_tokens,
+            }),
+            ...(usage.completion_tokens_details?.reasoning_tokens !== null && {
+                reasoning: usage.completion_tokens_details?.reasoning_tokens,
+            }),
+        };
+        result.usage_metadata = {
+            input_tokens: usage.prompt_tokens ?? 0,
+            output_tokens: usage.completion_tokens ?? 0,
+            total_tokens: usage.total_tokens ?? 0,
+            ...(Object.keys(inputTokenDetails).length > 0 && {
+                input_token_details: inputTokenDetails,
+            }),
+            ...(Object.keys(outputTokenDetails).length > 0 && {
+                output_token_details: outputTokenDetails,
+            }),
+        };
+    }
+    delete result.usage;
+    return result;
+}
 /**
  * Wraps an OpenAI client's completion methods, enabling automatic LangSmith
  * tracing. Method signatures are unchanged, with the exception that you can pass
@@ -208,6 +245,7 @@ const wrapOpenAI = (openai, options) => {
                         ls_stop,
                     };
                 },
+                processOutputs: processChatCompletion,
                 ...options,
             }),
         },

package/dist/wrappers/openai.js

@@ -110,6 +110,43 @@ const textAggregator = (allChunks
     ];
     return aggregatedOutput;
 };
+function processChatCompletion(outputs) {
+    const chatCompletion = outputs;
+    // copy the original object, minus usage
+    const result = { ...chatCompletion };
+    const usage = chatCompletion.usage;
+    if (usage) {
+        const inputTokenDetails = {
+            ...(usage.prompt_tokens_details?.audio_tokens !== null && {
+                audio: usage.prompt_tokens_details?.audio_tokens,
+            }),
+            ...(usage.prompt_tokens_details?.cached_tokens !== null && {
+                cache_read: usage.prompt_tokens_details?.cached_tokens,
+            }),
+        };
+        const outputTokenDetails = {
+            ...(usage.completion_tokens_details?.audio_tokens !== null && {
+                audio: usage.completion_tokens_details?.audio_tokens,
+            }),
+            ...(usage.completion_tokens_details?.reasoning_tokens !== null && {
+                reasoning: usage.completion_tokens_details?.reasoning_tokens,
+            }),
+        };
+        result.usage_metadata = {
+            input_tokens: usage.prompt_tokens ?? 0,
+            output_tokens: usage.completion_tokens ?? 0,
+            total_tokens: usage.total_tokens ?? 0,
+            ...(Object.keys(inputTokenDetails).length > 0 && {
+                input_token_details: inputTokenDetails,
+            }),
+            ...(Object.keys(outputTokenDetails).length > 0 && {
+                output_token_details: outputTokenDetails,
+            }),
+        };
+    }
+    delete result.usage;
+    return result;
+}
 /**
  * Wraps an OpenAI client's completion methods, enabling automatic LangSmith
  * tracing. Method signatures are unchanged, with the exception that you can pass
@@ -205,6 +242,7 @@ export const wrapOpenAI = (openai, options) => {
                         ls_stop,
                     };
                 },
+                processOutputs: processChatCompletion,
                 ...options,
             }),
         },

package/package.json

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