追踪快速入门

1. 配置您的环境。
2. 创建一个能够检索上下文并调用 LLM 的应用程序。
3. 启用追踪以捕获检索步骤和 LLM 调用。
4. 在 LangSmith UI 中查看生成的追踪。

​

先决条件

• LangSmith 账户：在 smith.langchain.com 注册或登录。
• LangSmith API 密钥：按照 创建 API 密钥 指南操作。
• OpenAI API 密钥：从 OpenAI 控制面板 生成。

​

1. 创建目录并安装依赖项

mkdir ls-observability-quickstart && cd ls-observability-quickstart
python -m venv .venv && source .venv/bin/activate
python -m pip install --upgrade pip
pip install -U langsmith openai

​

2. 设置环境变量

• LANGSMITH_TRACING
• LANGSMITH_API_KEY
• OPENAI_API_KEY（或您的 LLM 提供商的 API 密钥）
• （可选）LANGSMITH_WORKSPACE_ID：如果您的 LangSmith API 密钥关联到多个工作空间，请设置此变量以指定要使用的工作空间。

export LANGSMITH_TRACING=true
export LANGSMITH_API_KEY="<your-langsmith-api-key>"
export OPENAI_API_KEY="<your-openai-api-key>"
export LANGSMITH_WORKSPACE_ID="<your-workspace-id>"

​

3. 定义您的应用程序

• 检索器函数：模拟文档检索，始终返回相同的字符串。
• OpenAI 客户端：实例化一个普通的 OpenAI 客户端以发送聊天补全请求。
• RAG 函数：将检索到的文档与用户的问题结合以形成系统提示，使用 gpt-4.1-mini 调用 chat.completions.create() 端点，并返回助手的响应。

from openai import OpenAI

def retriever(query: str):
    # 最小示例检索器
    return ["Harrison worked at Kensho"]

# OpenAI 客户端调用（尚未包装）
client = OpenAI()

def rag(question: str) -> str:
    docs = retriever(question)
    system_message = (
        "仅使用下面提供的信息回答用户的问题：\n"
        + "\n".join(docs)
    )

    # 此调用尚未被追踪
    resp = client.chat.completions.create(
        model="gpt-4.1-mini",
        messages=[
            {"role": "system", "content": system_message},
            {"role": "user", "content": question},
        ],
    )
    return resp.choices[0].message.content

if __name__ == "__main__":
    print(rag("Harrison 在哪里工作？"))

​

4. 追踪 LLM 调用

• Python：wrap_openai
• TypeScript：wrapOpenAI

1. 在您的应用程序文件中包含高亮显示的行：
   Python

   TypeScript

   from openai import OpenAI
   from langsmith.wrappers import wrap_openai  # 追踪 openai 调用
   
   def retriever(query: str):
       return ["Harrison worked at Kensho"]
   
   client = wrap_openai(OpenAI())  # 通过包装模型调用来记录追踪
   
   def rag(question: str) -> str:
       docs = retriever(question)
       system_message = (
           "仅使用下面提供的信息回答用户的问题：\n"
           + "\n".join(docs)
       )
       resp = client.chat.completions.create(
           model="gpt-4.1-mini",
           messages=[
               {"role": "system", "content": system_message},
               {"role": "user", "content": question},
           ],
       )
       return resp.choices[0].message.content
   
   if __name__ == "__main__":
       print(rag("Harrison 在哪里工作？"))
   

2. 调用您的应用程序：
   Python

   TypeScript

   python app.py
   
   您将收到以下输出：
   Harrison worked at Kensho.
   
3. 在 LangSmith UI 中，导航到您工作空间的 默认 追踪项目（或您在 步骤 2 中指定的工作空间）。您将看到刚刚插桩的 OpenAI 调用。

​

5. 追踪整个应用程序

1. 在您的应用程序文件中包含高亮显示的代码：
   Python

   TypeScript

   from openai import OpenAI
   from langsmith.wrappers import wrap_openai
   from langsmith import traceable
   
   def retriever(query: str):
       return ["Harrison worked at Kensho"]
   
   client = wrap_openai(OpenAI())  # 保留此项以捕获来自 LLM 的提示和响应
   
   @traceable
   def rag(question: str) -> str:
       docs = retriever(question)
       system_message = (
           "仅使用下面提供的信息回答用户的问题：\n"
           + "\n".join(docs)
       )
       resp = client.chat.completions.create(
           model="gpt-4.1-mini",
           messages=[
               {"role": "system", "content": system_message},
               {"role": "user", "content": question},
           ],
       )
       return resp.choices[0].message.content
   
   if __name__ == "__main__":
       print(rag("Harrison 在哪里工作？"))
   

2. 再次调用应用程序以创建运行：
   Python

   TypeScript

   python app.py
   
3. 返回 LangSmith UI，导航到您工作空间的 默认 追踪项目（或您在 步骤 2 中指定的工作空间）。您将找到整个应用程序管道的追踪，包含 rag 步骤和 ChatOpenAI LLM 调用。

​

后续步骤

• 追踪集成 为各种 LLM 提供商和代理框架提供支持。
• 过滤追踪 可以帮助您有效地导航和分析包含大量数据的追踪项目中的数据。
• 追踪 RAG 应用程序 是一个完整的教程，它为一个应用程序从开发到生产添加了可观测性。
• 将追踪发送到特定项目 可以更改您追踪的目标项目。