langsmith-sdk

环境要求

• Python 环境，可使用 pip 安装包
• 有效的 LangSmith API Key（形如 ls_...）
• 使用 org-scoped key 时需提供 Workspace ID
• 可选：Node.js 环境与 pnpm，用于 JavaScript/TypeScript SDK

安装与启动步骤

1. 1安装 Python SDK

   用 pip 安装或升级官方 langsmith 包，这是追踪与评估功能的基础依赖。

   pip install -U langsmith

   复制

2. 2配置环境变量

   开启追踪并填入 API Key；若用 org-scoped key 还需填 Workspace ID。注意不要把真实密钥提交到代码仓库。

   export LANGSMITH_TRACING=true
   export LANGSMITH_API_KEY=ls_xxxxxxxx
   export LANGSMITH_WORKSPACE_ID=

   复制

3. 3包装 OpenAI 客户端

   用 wrap_openai 包装 OpenAI 客户端，之后所有 chat.completions 调用会被自动记录为 trace。

   import openai
   from langsmith import traceable
   from langsmith.wrappers import wrap_openai
   
   client = wrap_openai(openai.Client())
   
   client.chat.completions.create(
       messages=[{"role": "user", "content": "Hello, world"}],
       model="gpt-5.4"
   )

   复制

4. 4（可选）安装 JS SDK

   如使用 JavaScript / TypeScript，用 pnpm 添加 langsmith 包，环境变量配置方式与 Python 相同。

   pnpm add langsmith

   复制

5. 5（可选）JS 追踪示例

   用 wrapOpenAI 包装 OpenAI 客户端并调用接口，即可在平台上看到对应的 trace 记录。

   import { OpenAI } from "openai";
   import { traceable } from "langsmith/traceable";
   import { wrapOpenAI } from "langsmith/wrappers";
   
   const client = wrapOpenAI(new OpenAI());
   
   await client.chat.completions.create({
     model: "gpt-5.4",
     messages: [{ content: "Hi there!", role: "user" }],
   });

   复制

关键配置

如何确认成功

脚本能正常返回 chat.completion 结果（含 usage token 统计），并可在 smith.langchain.com 平台看到对应 trace。

常见问题

注意事项

• API Key 属于敏感凭证，不要硬编码进源码或提交到仓库。
• 本仓库同时包含 Python 与 JavaScript 两个 SDK，按需查阅对应目录的 README。