langsmith 0.1.8 → 0.1.11

package/README.md

@@ -1,5 +1,9 @@
 # LangSmith Client SDK
 
+![NPM Version](https://img.shields.io/npm/v/langsmith?logo=npm)
+[![JS Downloads](https://img.shields.io/npm/dm/langsmith)](https://www.npmjs.com/package/langsmith)
+
+
 This package contains the TypeScript client for interacting with the [LangSmith platform](https://smith.langchain.com/).
 
 To install:

package/dist/client.cjs

@@ -328,15 +328,27 @@ class Client {
         return headers;
     }
     processInputs(inputs) {
-        if (this.hideInputs) {
+        if (this.hideInputs === false) {
+            return inputs;
+        }
+        if (this.hideInputs === true) {
             return {};
         }
+        if (typeof this.hideInputs === "function") {
+            return this.hideInputs(inputs);
+        }
         return inputs;
     }
     processOutputs(outputs) {
-        if (this.hideOutputs) {
+        if (this.hideOutputs === false) {
+            return outputs;
+        }
+        if (this.hideOutputs === true) {
             return {};
         }
+        if (typeof this.hideOutputs === "function") {
+            return this.hideOutputs(outputs);
+        }
         return outputs;
     }
     prepareRunCreateOrUpdateInputs(run) {
@@ -825,7 +837,7 @@ class Client {
      * });
      */
     async *listRuns(props) {
-        const { projectId, projectName, parentRunId, traceId, referenceExampleId, startTime, executionOrder, runType, error, id, query, filter, traceFilter, limit, } = props;
+        const { projectId, projectName, parentRunId, traceId, referenceExampleId, startTime, executionOrder, runType, error, id, query, filter, traceFilter, treeFilter, limit, } = props;
         let projectIds = [];
         if (projectId) {
             projectIds = Array.isArray(projectId) ? projectId : [projectId];
@@ -844,8 +856,9 @@ class Client {
             query,
             filter,
             trace_filter: traceFilter,
+            tree_filter: treeFilter,
             execution_order: executionOrder,
-            parent_run: parentRunId ? [parentRunId] : null,
+            parent_run: parentRunId,
             start_time: startTime ? startTime.toISOString() : null,
             error,
             id,
@@ -1483,7 +1496,7 @@ class Client {
             sourceRunId: feedbackResult?.sourceRunId,
         });
     }
-    async createFeedback(runId, key, { score, value, correction, comment, sourceInfo, feedbackSourceType = "api", sourceRunId, feedbackId, eager = false, }) {
+    async createFeedback(runId, key, { score, value, correction, comment, sourceInfo, feedbackSourceType = "api", sourceRunId, feedbackId, feedbackConfig, }) {
         const feedback_source = {
             type: feedbackSourceType ?? "api",
             metadata: sourceInfo ?? {},
@@ -1506,8 +1519,9 @@ class Client {
             correction,
             comment,
             feedback_source: feedback_source,
+            feedbackConfig,
         };
-        const url = `${this.apiUrl}/feedback` + (eager ? "/eager" : "");
+        const url = `${this.apiUrl}/feedback`;
         const response = await this.caller.call(fetch, url, {
             method: "POST",
             headers: { ...this.headers, "Content-Type": "application/json" },
@@ -1578,5 +1592,60 @@ class Client {
             yield* feedbacks;
         }
     }
+    /**
+     * Creates a presigned feedback token and URL.
+     *
+     * The token can be used to authorize feedback metrics without
+     * needing an API key. This is useful for giving browser-based
+     * applications the ability to submit feedback without needing
+     * to expose an API key.
+     *
+     * @param runId - The ID of the run.
+     * @param feedbackKey - The feedback key.
+     * @param options - Additional options for the token.
+     * @param options.expiration - The expiration time for the token.
+     *
+     * @returns A promise that resolves to a FeedbackIngestToken.
+     */
+    async createPresignedFeedbackToken(runId, feedbackKey, { expiration, feedbackConfig, } = {}) {
+        const body = {
+            run_id: runId,
+            feedback_key: feedbackKey,
+            feedback_config: feedbackConfig,
+        };
+        if (expiration) {
+            if (typeof expiration === "string") {
+                body["expires_at"] = expiration;
+            }
+            else if (expiration?.hours || expiration?.minutes || expiration?.days) {
+                body["expires_in"] = expiration;
+            }
+        }
+        else {
+            body["expires_in"] = {
+                hours: 3,
+            };
+        }
+        const response = await this.caller.call(fetch, `${this.apiUrl}/feedback/tokens`, {
+            method: "POST",
+            headers: { ...this.headers, "Content-Type": "application/json" },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(this.timeout_ms),
+        });
+        const result = await response.json();
+        return result;
+    }
+    /**
+     * Retrieves a list of presigned feedback tokens for a given run ID.
+     * @param runId The ID of the run.
+     * @returns An async iterable of FeedbackIngestToken objects.
+     */
+    async *listPresignedFeedbackTokens(runId) {
+        assertUuid(runId);
+        const params = new URLSearchParams({ run_id: runId });
+        for await (const tokens of this._getPaginated("/feedback/tokens", params)) {
+            yield* tokens;
+        }
+    }
 }
 exports.Client = Client;

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { AsyncCallerParams } from "./utils/async_caller.js";
-import { DataType, Dataset, DatasetShareSchema, Example, ExampleUpdate, Feedback, KVMap, LangChainBaseMessage, Run, RunCreate, RunUpdate, ScoreType, TracerSession, TracerSessionResult, ValueType } from "./schemas.js";
+import { DataType, Dataset, DatasetShareSchema, Example, ExampleUpdate, Feedback, FeedbackConfig, FeedbackIngestToken, KVMap, LangChainBaseMessage, Run, RunCreate, RunUpdate, ScoreType, TimeDelta, TracerSession, TracerSessionResult, ValueType } from "./schemas.js";
 import { RunEvaluator } from "./evaluation/evaluator.js";
 interface ClientConfig {
     apiUrl?: string;
@@ -85,9 +85,16 @@ interface ListRunsParams {
      */
     filter?: string;
     /**
-     * The trace filter string to apply. Uses the same grammar as the filter string.
+     * Filter to apply to the ROOT run in the trace tree. This is meant to be used in conjunction with the regular
+     *  `filter` parameter to let you filter runs by attributes of the root run within a trace. Example is filtering by
+     * feedback assigned to the trace.
      */
     traceFilter?: string;
+    /**
+     * Filter to apply to OTHER runs in the trace tree, including sibling and child runs. This is meant to be used in
+     * conjunction with the regular `filter` parameter to let you filter runs by attributes of any run within a trace.
+     */
+    treeFilter?: string;
 }
 interface UploadCSVParams {
     csvFile: Blob;
@@ -376,13 +383,14 @@ export declare class Client {
         loadChildRuns: boolean;
         referenceExample?: Example;
     }): Promise<Feedback>;
-    createFeedback(runId: string, key: string, { score, value, correction, comment, sourceInfo, feedbackSourceType, sourceRunId, feedbackId, eager, }: {
+    createFeedback(runId: string, key: string, { score, value, correction, comment, sourceInfo, feedbackSourceType, sourceRunId, feedbackId, feedbackConfig, }: {
         score?: ScoreType;
         value?: ValueType;
         correction?: object;
         comment?: string;
         sourceInfo?: object;
         feedbackSourceType?: FeedbackSourceType;
+        feedbackConfig?: FeedbackConfig;
         sourceRunId?: string;
         feedbackId?: string;
         eager?: boolean;
@@ -400,5 +408,30 @@ export declare class Client {
         feedbackKeys?: string[];
         feedbackSourceTypes?: FeedbackSourceType[];
     }): AsyncIterable<Feedback>;
+    /**
+     * Creates a presigned feedback token and URL.
+     *
+     * The token can be used to authorize feedback metrics without
+     * needing an API key. This is useful for giving browser-based
+     * applications the ability to submit feedback without needing
+     * to expose an API key.
+     *
+     * @param runId - The ID of the run.
+     * @param feedbackKey - The feedback key.
+     * @param options - Additional options for the token.
+     * @param options.expiration - The expiration time for the token.
+     *
+     * @returns A promise that resolves to a FeedbackIngestToken.
+     */
+    createPresignedFeedbackToken(runId: string, feedbackKey: string, { expiration, feedbackConfig, }?: {
+        expiration?: string | TimeDelta;
+        feedbackConfig?: FeedbackConfig;
+    }): Promise<FeedbackIngestToken>;
+    /**
+     * Retrieves a list of presigned feedback tokens for a given run ID.
+     * @param runId The ID of the run.
+     * @returns An async iterable of FeedbackIngestToken objects.
+     */
+    listPresignedFeedbackTokens(runId: string): AsyncIterable<FeedbackIngestToken>;
 }
 export {};

package/dist/client.js

@@ -301,15 +301,27 @@ export class Client {
         return headers;
     }
     processInputs(inputs) {
-        if (this.hideInputs) {
+        if (this.hideInputs === false) {
+            return inputs;
+        }
+        if (this.hideInputs === true) {
             return {};
         }
+        if (typeof this.hideInputs === "function") {
+            return this.hideInputs(inputs);
+        }
         return inputs;
     }
     processOutputs(outputs) {
-        if (this.hideOutputs) {
+        if (this.hideOutputs === false) {
+            return outputs;
+        }
+        if (this.hideOutputs === true) {
             return {};
         }
+        if (typeof this.hideOutputs === "function") {
+            return this.hideOutputs(outputs);
+        }
         return outputs;
     }
     prepareRunCreateOrUpdateInputs(run) {
@@ -798,7 +810,7 @@ export class Client {
      * });
      */
     async *listRuns(props) {
-        const { projectId, projectName, parentRunId, traceId, referenceExampleId, startTime, executionOrder, runType, error, id, query, filter, traceFilter, limit, } = props;
+        const { projectId, projectName, parentRunId, traceId, referenceExampleId, startTime, executionOrder, runType, error, id, query, filter, traceFilter, treeFilter, limit, } = props;
         let projectIds = [];
         if (projectId) {
             projectIds = Array.isArray(projectId) ? projectId : [projectId];
@@ -817,8 +829,9 @@ export class Client {
             query,
             filter,
             trace_filter: traceFilter,
+            tree_filter: treeFilter,
             execution_order: executionOrder,
-            parent_run: parentRunId ? [parentRunId] : null,
+            parent_run: parentRunId,
             start_time: startTime ? startTime.toISOString() : null,
             error,
             id,
@@ -1456,7 +1469,7 @@ export class Client {
             sourceRunId: feedbackResult?.sourceRunId,
         });
     }
-    async createFeedback(runId, key, { score, value, correction, comment, sourceInfo, feedbackSourceType = "api", sourceRunId, feedbackId, eager = false, }) {
+    async createFeedback(runId, key, { score, value, correction, comment, sourceInfo, feedbackSourceType = "api", sourceRunId, feedbackId, feedbackConfig, }) {
         const feedback_source = {
             type: feedbackSourceType ?? "api",
             metadata: sourceInfo ?? {},
@@ -1479,8 +1492,9 @@ export class Client {
             correction,
             comment,
             feedback_source: feedback_source,
+            feedbackConfig,
         };
-        const url = `${this.apiUrl}/feedback` + (eager ? "/eager" : "");
+        const url = `${this.apiUrl}/feedback`;
         const response = await this.caller.call(fetch, url, {
             method: "POST",
             headers: { ...this.headers, "Content-Type": "application/json" },
@@ -1551,4 +1565,59 @@ export class Client {
             yield* feedbacks;
         }
     }
+    /**
+     * Creates a presigned feedback token and URL.
+     *
+     * The token can be used to authorize feedback metrics without
+     * needing an API key. This is useful for giving browser-based
+     * applications the ability to submit feedback without needing
+     * to expose an API key.
+     *
+     * @param runId - The ID of the run.
+     * @param feedbackKey - The feedback key.
+     * @param options - Additional options for the token.
+     * @param options.expiration - The expiration time for the token.
+     *
+     * @returns A promise that resolves to a FeedbackIngestToken.
+     */
+    async createPresignedFeedbackToken(runId, feedbackKey, { expiration, feedbackConfig, } = {}) {
+        const body = {
+            run_id: runId,
+            feedback_key: feedbackKey,
+            feedback_config: feedbackConfig,
+        };
+        if (expiration) {
+            if (typeof expiration === "string") {
+                body["expires_at"] = expiration;
+            }
+            else if (expiration?.hours || expiration?.minutes || expiration?.days) {
+                body["expires_in"] = expiration;
+            }
+        }
+        else {
+            body["expires_in"] = {
+                hours: 3,
+            };
+        }
+        const response = await this.caller.call(fetch, `${this.apiUrl}/feedback/tokens`, {
+            method: "POST",
+            headers: { ...this.headers, "Content-Type": "application/json" },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(this.timeout_ms),
+        });
+        const result = await response.json();
+        return result;
+    }
+    /**
+     * Retrieves a list of presigned feedback tokens for a given run ID.
+     * @param runId The ID of the run.
+     * @returns An async iterable of FeedbackIngestToken objects.
+     */
+    async *listPresignedFeedbackTokens(runId) {
+        assertUuid(runId);
+        const params = new URLSearchParams({ run_id: runId });
+        for await (const tokens of this._getPaginated("/feedback/tokens", params)) {
+            yield* tokens;
+        }
+    }
 }

package/dist/index.cjs

@@ -6,4 +6,4 @@ Object.defineProperty(exports, "Client", { enumerable: true, get: function () {
 var run_trees_js_1 = require("./run_trees.cjs");
 Object.defineProperty(exports, "RunTree", { enumerable: true, get: function () { return run_trees_js_1.RunTree; } });
 // Update using yarn bump-version
-exports.__version__ = "0.1.8";
+exports.__version__ = "0.1.11";

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { Client } from "./client.js";
 export type { Dataset, Example, TracerSession, Run, Feedback, } from "./schemas.js";
 export { RunTree, type RunTreeConfig } from "./run_trees.js";
-export declare const __version__ = "0.1.8";
+export declare const __version__ = "0.1.11";

package/dist/index.js

@@ -1,4 +1,4 @@
 export { Client } from "./client.js";
 export { RunTree } from "./run_trees.js";
 // Update using yarn bump-version
-export const __version__ = "0.1.8";
+export const __version__ = "0.1.11";

package/dist/schemas.d.ts

@@ -209,3 +209,41 @@ export interface LangChainBaseMessage {
     content: string;
     additional_kwargs?: KVMap;
 }
+export interface FeedbackIngestToken {
+    id: string;
+    url: string;
+    expires_at: string;
+}
+export interface TimeDelta {
+    days?: number;
+    hours?: number;
+    minutes?: number;
+}
+export interface FeedbackCategory {
+    value: number;
+    label?: string | null;
+}
+/**
+ * Represents the configuration for feedback.
+ * This determines how the LangSmith service interprets feedback
+ * values of the associated key.
+ */
+export interface FeedbackConfig {
+    /**
+     * The type of feedback.
+     */
+    type: "continuous" | "categorical" | "freeform";
+    /**
+     * The minimum value for continuous feedback.
+     */
+    min?: number | null;
+    /**
+     * The maximum value for continuous feedback.
+     */
+    max?: number | null;
+    /**
+     * If feedback is categorical, this defines the valid categories the server will accept.
+     * Not applicable to continuous or freeform feedback types.
+     */
+    categories?: FeedbackCategory[] | null;
+}

package/package.json

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