langsmith 0.1.1 → 0.1.3

package/README.md

@@ -90,6 +90,7 @@ Langsmith's `traceable` wrapper function makes it easy to trace any function or
 ### OpenAI SDK
 
 <!-- markdown-link-check-disable -->
+
 The easiest ways to trace calls from the [OpenAI SDK](https://platform.openai.com/docs/api-reference) with LangSmith
 is using the `traceable` wrapper function available in LangSmith 0.1.0 and up.
 
@@ -105,72 +106,41 @@ Next, you will need to install the LangSmith SDK and the OpenAI SDK:
 npm install langsmith openai
 ```
 
-After that, initialize your OpenAI client:
+After that, initialize your OpenAI client and wrap the client with `wrapOpenAI` method to enable tracing for Completion and Chat completion API:
 
 ```ts
 import { OpenAI } from "openai";
+import { wrapOpenAI } from "langsmith/wrappers";
+
+const openai = wrapOpenAI(new OpenAI());
 
-const client = new OpenAI();
+await openai.chat.completions.create({
+  model: "gpt-3.5-turbo",
+  messages: [{ content: "Hi there!", role: "user" }],
+});
 ```
 
-Then, you can wrap the client methods you want to use by passing it to the `traceable` function like this:
+Alternatively, you can use the `traceable` function to wrap the client methods you want to use:
 
 ```ts
 import { traceable } from "langsmith/traceable";
 
+const openai = new OpenAI();
+
 const createCompletion = traceable(
   openai.chat.completions.create.bind(openai.chat.completions),
   { name: "OpenAI Chat Completion", run_type: "llm" }
 );
-```
-
-Note the use of `.bind` to preserve the function's context. The `run_type` field in the extra config object
-marks the function as an LLM call, and enables token usage tracking for OpenAI.
-
-This new method takes the same exact arguments and has the same return type as the original method,
-but will log everything to LangSmith!
 
-```ts
 await createCompletion({
   model: "gpt-3.5-turbo",
   messages: [{ content: "Hi there!", role: "user" }],
 });
 ```
 
-```
-{
-  id: 'chatcmpl-8sOWEOYVyehDlyPcBiaDtTxWvr9v6',
-  object: 'chat.completion',
-  created: 1707974654,
-  model: 'gpt-3.5-turbo-0613',
-  choices: [
-    {
-      index: 0,
-      message: { role: 'assistant', content: 'Hello! How can I help you today?' },
-      logprobs: null,
-      finish_reason: 'stop'
-    }
-  ],
-  usage: { prompt_tokens: 10, completion_tokens: 9, total_tokens: 19 },
-  system_fingerprint: null
-}
-```
-
-This also works for streaming:
-
-```ts
-const stream = await createCompletion({
-  model: "gpt-3.5-turbo",
-  stream: true,
-  messages: [{ content: "Hi there!", role: "user" }],
-});
-```
-
-```ts
-for await (const chunk of stream) {
-  console.log(chunk);
-}
-```
+Note the use of `.bind` to preserve the function's context. The `run_type` field in the
+extra config object marks the function as an LLM call, and enables token usage tracking
+for OpenAI.
 
 Oftentimes, you use the OpenAI client inside of other functions or as part of a longer
 sequence. You can automatically get nested traces by using this wrapped method
@@ -178,7 +148,7 @@ within other functions wrapped with `traceable`.
 
 ```ts
 const nestedTrace = traceable(async (text: string) => {
-  const completion = await createCompletion({
+  const completion = await openai.chat.completions.create({
     model: "gpt-3.5-turbo",
     messages: [{ content: text, role: "user" }],
   });
@@ -230,25 +200,22 @@ import { NextRequest, NextResponse } from "next/server";
 
 import { OpenAI } from "openai";
 import { traceable } from "langsmith/traceable";
+import { wrapOpenAI } from "langsmith/wrappers";
 
 export const runtime = "edge";
 
 const handler = traceable(
   async function () {
-    const openai = new OpenAI();
-    const createCompletion = traceable(
-      openai.chat.completions.create.bind(openai.chat.completions),
-      { name: "OpenAI Chat Completion", run_type: "llm" }
-    );
+    const openai = wrapOpenAI(new OpenAI());
 
-    const completion = await createCompletion({
+    const completion = await openai.chat.completions.create({
       model: "gpt-3.5-turbo",
       messages: [{ content: "Why is the sky blue?", role: "user" }],
     });
 
     const response1 = completion.choices[0].message.content;
 
-    const completion2 = await createCompletion({
+    const completion2 = await openai.chat.completions.create({
       model: "gpt-3.5-turbo",
       messages: [
         { content: "Why is the sky blue?", role: "user" },
@@ -287,28 +254,25 @@ The [Vercel AI SDK](https://sdk.vercel.ai/docs) contains integrations with a var
 Here's an example of how you can trace outputs in a Next.js handler:
 
 ```ts
-import { traceable } from 'langsmith/traceable';
-import { OpenAIStream, StreamingTextResponse } from 'ai';
+import { traceable } from "langsmith/traceable";
+import { OpenAIStream, StreamingTextResponse } from "ai";
 
 // Note: There are no types for the Mistral API client yet.
-import MistralClient from '@mistralai/mistralai';
+import MistralClient from "@mistralai/mistralai";
 
-const client = new MistralClient(process.env.MISTRAL_API_KEY || '');
+const client = new MistralClient(process.env.MISTRAL_API_KEY || "");
 
 export async function POST(req: Request) {
   // Extract the `messages` from the body of the request
   const { messages } = await req.json();
 
-  const mistralChatStream = traceable(
-    client.chatStream.bind(client),
-    {
-      name: "Mistral Stream",
-      run_type: "llm",
-    }
-  );
+  const mistralChatStream = traceable(client.chatStream.bind(client), {
+    name: "Mistral Stream",
+    run_type: "llm",
+  });
 
   const response = await mistralChatStream({
-    model: 'mistral-tiny',
+    model: "mistral-tiny",
     maxTokens: 1000,
     messages,
   });
@@ -324,7 +288,6 @@ export async function POST(req: Request) {
 
 See the [AI SDK docs](https://sdk.vercel.ai/docs) for more examples.
 
-
 #### 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:
@@ -413,7 +376,7 @@ try {
   await childChainRun.end({
     error: `I errored again ${e.message}`,
   });
-  await childChainRun.patchRun(); 
+  await childChainRun.patchRun();
   throw e;
 }
 
@@ -431,7 +394,7 @@ await parentRun.patchRun();
 
 ## Evaluation
 
-####  Create a Dataset from Existing Runs
+#### Create a Dataset from Existing Runs
 
 Once your runs are stored in LangSmith, you can convert them into a dataset.
 For this example, we will do so using the Client, but you can also do this using

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.1";
+exports.__version__ = "0.1.3";

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

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

package/dist/wrappers.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapOpenAI = void 0;
+const traceable_js_1 = require("./traceable.cjs");
+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;

package/dist/wrappers.d.ts

@@ -0,0 +1,5 @@
+import type { OpenAI } from "openai";
+import type { Client } from "./index.js";
+export declare const wrapOpenAI: (openai: OpenAI, options?: {
+    client?: Client;
+}) => OpenAI;

package/dist/wrappers.js

@@ -0,0 +1,8 @@
+import { traceable } from "./traceable.js";
+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;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langsmith",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform.",
   "packageManager": "yarn@1.22.19",
   "files": [
@@ -20,6 +20,9 @@
     "schemas.cjs",
     "schemas.js",
     "schemas.d.ts",
+    "wrappers.cjs",
+    "wrappers.js",
+    "wrappers.d.ts",
     "index.cjs",
     "index.js",
     "index.d.ts"
@@ -80,6 +83,7 @@
     "eslint-plugin-no-instanceof": "^1.0.1",
     "eslint-plugin-prettier": "^4.2.1",
     "jest": "^29.5.0",
+    "openai": "^4.28.0",
     "prettier": "^2.8.8",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
@@ -129,6 +133,11 @@
       "import": "./schemas.js",
       "require": "./schemas.cjs"
     },
+    "./wrappers": {
+      "types": "./wrappers.d.ts",
+      "import": "./wrappers.js",
+      "require": "./wrappers.cjs"
+    },
     "./package.json": "./package.json"
   }
 }

package/wrappers.cjs

@@ -0,0 +1 @@
+module.exports = require('./dist/wrappers.cjs');

package/wrappers.d.ts

@@ -0,0 +1 @@
+export * from './dist/wrappers.js'

package/wrappers.js

@@ -0,0 +1 @@
+export * from './dist/wrappers.js'