langsmith 0.1.12 → 0.1.13

package/README.md

@@ -292,6 +292,38 @@ export async function POST(req: Request) {
 
 See the [AI SDK docs](https://sdk.vercel.ai/docs) for more examples.
 
+## Arbitrary SDKs
+
+You can use the generic `wrapSDK` method to add tracing for arbitrary SDKs.
+
+Do note that this will trace ALL methods in the SDK, not just chat completion endpoints.
+If the SDK you are wrapping has other methods, we recommend using it for only LLM calls.
+
+Here's an example using the Anthropic SDK:
+
+```ts
+import { wrapSDK } from "langsmith/wrappers";
+import { Anthropic } from "@anthropic-ai/sdk";
+
+const originalSDK = new Anthropic();
+const sdkWithTracing = wrapSDK(originalSDK);
+
+const response = await sdkWithTracing.messages.create({
+  messages: [
+    {
+      role: "user",
+      content: `What is 1 + 1? Respond only with "2" and nothing else.`,
+    },
+  ],
+  model: "claude-3-sonnet-20240229",
+  max_tokens: 1024,
+});
+```
+
+:::tip
+[Click here](https://smith.langchain.com/public/0e7248af-bbed-47cf-be9f-5967fea1dec1/r) to see an example LangSmith trace of the above.
+:::
+
 #### Alternatives: **Log traces using a RunTree.**
 
 A RunTree tracks your application. Each RunTree object is required to have a name and run_type. These and other important attributes are as follows:

package/dist/client.cjs

@@ -1260,6 +1260,27 @@ class Client {
         }
         return result;
     }
+    async diffDatasetVersions({ datasetId, datasetName, fromVersion, toVersion, }) {
+        let datasetId_ = datasetId;
+        if (datasetId_ === undefined && datasetName === undefined) {
+            throw new Error("Must provide either datasetName or datasetId");
+        }
+        else if (datasetId_ !== undefined && datasetName !== undefined) {
+            throw new Error("Must provide either datasetName or datasetId, not both");
+        }
+        else if (datasetId_ === undefined) {
+            const dataset = await this.readDataset({ datasetName });
+            datasetId_ = dataset.id;
+        }
+        const urlParams = new URLSearchParams({
+            from_version: typeof fromVersion === "string"
+                ? fromVersion
+                : fromVersion.toISOString(),
+            to_version: typeof toVersion === "string" ? toVersion : toVersion.toISOString(),
+        });
+        const response = await this._get(`/datasets/${datasetId_}/versions/diff`, urlParams);
+        return response;
+    }
     async readDatasetOpenaiFinetuning({ datasetId, datasetName, }) {
         const path = "/datasets";
         if (datasetId !== undefined) {
@@ -1413,7 +1434,7 @@ class Client {
         const path = `/examples/${exampleId}`;
         return await this._get(path);
     }
-    async *listExamples({ datasetId, datasetName, exampleIds, } = {}) {
+    async *listExamples({ datasetId, datasetName, exampleIds, asOf, inlineS3Urls, } = {}) {
         let datasetId_;
         if (datasetId !== undefined && datasetName !== undefined) {
             throw new Error("Must provide either datasetName or datasetId, not both");
@@ -1429,6 +1450,16 @@ class Client {
             throw new Error("Must provide a datasetName or datasetId");
         }
         const params = new URLSearchParams({ dataset: datasetId_ });
+        const dataset_version = asOf
+            ? typeof asOf === "string"
+                ? asOf
+                : asOf?.toISOString()
+            : undefined;
+        if (dataset_version) {
+            params.append("as_of", dataset_version);
+        }
+        const inlineS3Urls_ = inlineS3Urls ?? true;
+        params.append("inline_s3_urls", inlineS3Urls_.toString());
         if (exampleIds !== undefined) {
             for (const id_ of exampleIds) {
                 params.append("id", id_);

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { AsyncCallerParams } from "./utils/async_caller.js";
-import { DataType, Dataset, DatasetShareSchema, Example, ExampleUpdate, Feedback, FeedbackConfig, FeedbackIngestToken, KVMap, LangChainBaseMessage, Run, RunCreate, RunUpdate, ScoreType, TimeDelta, TracerSession, TracerSessionResult, ValueType } from "./schemas.js";
+import { DataType, Dataset, DatasetDiffInfo, 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;
@@ -344,6 +344,12 @@ export declare class Client {
         datasetId?: string;
         datasetName?: string;
     }): Promise<Dataset>;
+    diffDatasetVersions({ datasetId, datasetName, fromVersion, toVersion, }: {
+        datasetId?: string;
+        datasetName?: string;
+        fromVersion: string | Date;
+        toVersion: string | Date;
+    }): Promise<DatasetDiffInfo>;
     readDatasetOpenaiFinetuning({ datasetId, datasetName, }: {
         datasetId?: string;
         datasetName?: string;
@@ -371,10 +377,12 @@ export declare class Client {
     createLLMExample(input: string, generation: string | undefined, options: CreateExampleOptions): Promise<Example>;
     createChatExample(input: KVMap[] | LangChainBaseMessage[], generations: KVMap | LangChainBaseMessage | undefined, options: CreateExampleOptions): Promise<Example>;
     readExample(exampleId: string): Promise<Example>;
-    listExamples({ datasetId, datasetName, exampleIds, }?: {
+    listExamples({ datasetId, datasetName, exampleIds, asOf, inlineS3Urls, }?: {
         datasetId?: string;
         datasetName?: string;
         exampleIds?: string[];
+        asOf?: string | Date;
+        inlineS3Urls?: boolean;
     }): AsyncIterable<Example>;
     deleteExample(exampleId: string): Promise<void>;
     updateExample(exampleId: string, update: ExampleUpdate): Promise<object>;

package/dist/client.js

@@ -1233,6 +1233,27 @@ export class Client {
         }
         return result;
     }
+    async diffDatasetVersions({ datasetId, datasetName, fromVersion, toVersion, }) {
+        let datasetId_ = datasetId;
+        if (datasetId_ === undefined && datasetName === undefined) {
+            throw new Error("Must provide either datasetName or datasetId");
+        }
+        else if (datasetId_ !== undefined && datasetName !== undefined) {
+            throw new Error("Must provide either datasetName or datasetId, not both");
+        }
+        else if (datasetId_ === undefined) {
+            const dataset = await this.readDataset({ datasetName });
+            datasetId_ = dataset.id;
+        }
+        const urlParams = new URLSearchParams({
+            from_version: typeof fromVersion === "string"
+                ? fromVersion
+                : fromVersion.toISOString(),
+            to_version: typeof toVersion === "string" ? toVersion : toVersion.toISOString(),
+        });
+        const response = await this._get(`/datasets/${datasetId_}/versions/diff`, urlParams);
+        return response;
+    }
     async readDatasetOpenaiFinetuning({ datasetId, datasetName, }) {
         const path = "/datasets";
         if (datasetId !== undefined) {
@@ -1386,7 +1407,7 @@ export class Client {
         const path = `/examples/${exampleId}`;
         return await this._get(path);
     }
-    async *listExamples({ datasetId, datasetName, exampleIds, } = {}) {
+    async *listExamples({ datasetId, datasetName, exampleIds, asOf, inlineS3Urls, } = {}) {
         let datasetId_;
         if (datasetId !== undefined && datasetName !== undefined) {
             throw new Error("Must provide either datasetName or datasetId, not both");
@@ -1402,6 +1423,16 @@ export class Client {
             throw new Error("Must provide a datasetName or datasetId");
         }
         const params = new URLSearchParams({ dataset: datasetId_ });
+        const dataset_version = asOf
+            ? typeof asOf === "string"
+                ? asOf
+                : asOf?.toISOString()
+            : undefined;
+        if (dataset_version) {
+            params.append("as_of", dataset_version);
+        }
+        const inlineS3Urls_ = inlineS3Urls ?? true;
+        params.append("inline_s3_urls", inlineS3Urls_.toString());
         if (exampleIds !== undefined) {
             for (const id_ of exampleIds) {
                 params.append("id", id_);

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.12";
+exports.__version__ = "0.1.13";

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.12";
+export declare const __version__ = "0.1.13";

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

package/dist/schemas.d.ts

@@ -247,3 +247,8 @@ export interface FeedbackConfig {
      */
     categories?: FeedbackCategory[] | null;
 }
+export interface DatasetDiffInfo {
+    examples_modified: string[];
+    examples_added: string[];
+    examples_removed: string[];
+}

package/dist/wrappers.cjs

@@ -1,12 +1,54 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapOpenAI = void 0;
+exports.wrapSDK = exports.wrapOpenAI = void 0;
 const traceable_js_1 = require("./traceable.cjs");
+/**
+ * Wraps an OpenAI client's completion methods, enabling automatic LangSmith
+ * tracing. Method signatures are unchanged.
+ * @param openai An OpenAI client instance.
+ * @param options LangSmith options.
+ * @returns
+ */
 const wrapOpenAI = (openai, options) => {
-    // @ts-expect-error Promise<APIPromise<...>> != APIPromise<...>
     openai.chat.completions.create = (0, traceable_js_1.traceable)(openai.chat.completions.create.bind(openai.chat.completions), Object.assign({ name: "ChatOpenAI", run_type: "llm" }, options?.client));
-    // @ts-expect-error Promise<APIPromise<...>> != APIPromise<...>
     openai.completions.create = (0, traceable_js_1.traceable)(openai.completions.create.bind(openai.completions), Object.assign({ name: "OpenAI", run_type: "llm" }, options?.client));
     return openai;
 };
 exports.wrapOpenAI = wrapOpenAI;
+const _wrapClient = (sdk, runName, options) => {
+    return new Proxy(sdk, {
+        get(target, propKey, receiver) {
+            const originalValue = target[propKey];
+            if (typeof originalValue === "function") {
+                return (0, traceable_js_1.traceable)(originalValue.bind(target), Object.assign({ name: [runName, propKey.toString()].join("."), run_type: "llm" }, options?.client));
+            }
+            else if (originalValue != null &&
+                !Array.isArray(originalValue) &&
+                // eslint-disable-next-line no-instanceof/no-instanceof
+                !(originalValue instanceof Date) &&
+                typeof originalValue === "object") {
+                return _wrapClient(originalValue, [runName, propKey.toString()].join("."), options);
+            }
+            else {
+                return Reflect.get(target, propKey, receiver);
+            }
+        },
+    });
+};
+/**
+ * Wrap an arbitrary SDK, enabling automatic LangSmith tracing.
+ * Method signatures are unchanged.
+ *
+ * Note that this will wrap and trace ALL SDK methods, not just
+ * LLM completion methods. If the passed SDK contains other methods,
+ * we recommend using the wrapped instance for LLM calls only.
+ * @param sdk An arbitrary SDK instance.
+ * @param options LangSmith options.
+ * @returns
+ */
+const wrapSDK = (sdk, options) => {
+    return _wrapClient(sdk, options?.runName ?? sdk.constructor?.name, {
+        client: options?.client,
+    });
+};
+exports.wrapSDK = wrapSDK;

package/dist/wrappers.d.ts

@@ -1,5 +1,37 @@
-import type { OpenAI } from "openai";
 import type { Client } from "./index.js";
-export declare const wrapOpenAI: (openai: OpenAI, options?: {
+type OpenAIType = {
+    chat: {
+        completions: {
+            create: (...args: any[]) => any;
+        };
+    };
+    completions: {
+        create: (...args: any[]) => any;
+    };
+};
+/**
+ * Wraps an OpenAI client's completion methods, enabling automatic LangSmith
+ * tracing. Method signatures are unchanged.
+ * @param openai An OpenAI client instance.
+ * @param options LangSmith options.
+ * @returns
+ */
+export declare const wrapOpenAI: <T extends OpenAIType>(openai: T, options?: {
     client?: Client;
-}) => OpenAI;
+}) => T;
+/**
+ * Wrap an arbitrary SDK, enabling automatic LangSmith tracing.
+ * Method signatures are unchanged.
+ *
+ * Note that this will wrap and trace ALL SDK methods, not just
+ * LLM completion methods. If the passed SDK contains other methods,
+ * we recommend using the wrapped instance for LLM calls only.
+ * @param sdk An arbitrary SDK instance.
+ * @param options LangSmith options.
+ * @returns
+ */
+export declare const wrapSDK: <T extends object>(sdk: T, options?: {
+    client?: Client;
+    runName?: string;
+}) => T;
+export {};

package/dist/wrappers.js

@@ -1,8 +1,49 @@
 import { traceable } from "./traceable.js";
+/**
+ * Wraps an OpenAI client's completion methods, enabling automatic LangSmith
+ * tracing. Method signatures are unchanged.
+ * @param openai An OpenAI client instance.
+ * @param options LangSmith options.
+ * @returns
+ */
 export const wrapOpenAI = (openai, options) => {
-    // @ts-expect-error Promise<APIPromise<...>> != APIPromise<...>
     openai.chat.completions.create = traceable(openai.chat.completions.create.bind(openai.chat.completions), Object.assign({ name: "ChatOpenAI", run_type: "llm" }, options?.client));
-    // @ts-expect-error Promise<APIPromise<...>> != APIPromise<...>
     openai.completions.create = traceable(openai.completions.create.bind(openai.completions), Object.assign({ name: "OpenAI", run_type: "llm" }, options?.client));
     return openai;
 };
+const _wrapClient = (sdk, runName, options) => {
+    return new Proxy(sdk, {
+        get(target, propKey, receiver) {
+            const originalValue = target[propKey];
+            if (typeof originalValue === "function") {
+                return traceable(originalValue.bind(target), Object.assign({ name: [runName, propKey.toString()].join("."), run_type: "llm" }, options?.client));
+            }
+            else if (originalValue != null &&
+                !Array.isArray(originalValue) &&
+                // eslint-disable-next-line no-instanceof/no-instanceof
+                !(originalValue instanceof Date) &&
+                typeof originalValue === "object") {
+                return _wrapClient(originalValue, [runName, propKey.toString()].join("."), options);
+            }
+            else {
+                return Reflect.get(target, propKey, receiver);
+            }
+        },
+    });
+};
+/**
+ * Wrap an arbitrary SDK, enabling automatic LangSmith tracing.
+ * Method signatures are unchanged.
+ *
+ * Note that this will wrap and trace ALL SDK methods, not just
+ * LLM completion methods. If the passed SDK contains other methods,
+ * we recommend using the wrapped instance for LLM calls only.
+ * @param sdk An arbitrary SDK instance.
+ * @param options LangSmith options.
+ * @returns
+ */
+export const wrapSDK = (sdk, options) => {
+    return _wrapClient(sdk, options?.runName ?? sdk.constructor?.name, {
+        client: options?.client,
+    });
+};

package/package.json

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