使用 Instructor 进行追踪（仅限 Python）

我们提供了与 Instructor 便捷的集成，它是一个用于生成 LLM 结构化输出的流行开源库。

要使用此功能，您首先需要设置您的 LangSmith API 密钥。

export LANGSMITH_API_KEY=<your-api-key>

接下来，您需要安装 LangSmith SDK

pip install -U langsmith

使用 langsmith.wrappers.wrap_openai 包装您的 OpenAI 客户端

from openai import OpenAI
from langsmith import wrappers

client = wrappers.wrap_openai(OpenAI())

之后，您可以使用 instructor 修补包装后的 OpenAI 客户端

import instructor

client = instructor.patch(client)

现在，您可以像往常一样使用 instructor，但现在所有内容都将记录到 LangSmith！

from pydantic import BaseModel


class UserDetail(BaseModel):
    name: str
    age: int


user = client.chat.completions.create(
    model="gpt-4o-mini",
    response_model=UserDetail,
    messages=[
        {"role": "user", "content": "Extract Jason is 25 years old"},
    ]
)

通常，您会在其他函数内部使用 instructor。通过使用此包装客户端并用 @traceable 修饰这些函数，您可以获得嵌套追踪。请参阅 本指南，了解如何使用 @traceable 装饰器为追踪注解代码的更多信息。

# You can customize the run name with the `name` keyword argument
@traceable(name="Extract User Details")
def my_function(text: str) -> UserDetail:
    return client.chat.completions.create(
        model="gpt-4o-mini",
        response_model=UserDetail,
        messages=[
            {"role": "user", "content": f"Extract {text}"},
        ]
    )


my_function("Jason is 25 years old")