以编程方式使用文档

要开始使用 LangSmith,您需要创建一个账户。您可以在以下位置注册免费账户 LangSmith UI。LangSmith 支持使用 Google、GitHub 和电子邮件登录。

API 密钥

LangSmith 支持两种类型的 API 密钥。您可以使用这两种令牌来验证对 LangSmith API 的请求,但它们有不同的用例:

要使用 LangSmith 记录追踪并运行评估,请创建 API 密钥来验证您的请求。

Open API Keys settings

导航至 设置页面 并选择 **API 密钥** section.

Configure the key type

对于服务密钥,请在组织限定密钥和工作区限定密钥之间进行选择。如果密钥是工作区限定的,您必须指定工作区。

企业版 用户还可以 为服务密钥分配特定的工作区角色 ,这会独立于任何用户调整其权限。

Set expiration

设置密钥的过期时间。密钥在选定的天数后失效,如果选择了相应选项,则永不过期。

Create the key

点击 **创建 API 密钥。** LangSmith 将仅显示一次 API 密钥,因此请务必复制并将其存储在安全的地方。

配置 SDK

安装适用于您语言的 SDK:

Python

      pip install langsmith
      
      uv add langsmith
      

TypeScript

    npm install langsmith
    

有关完整详情,请参阅 Python SDK or JS/TS SDK reference.

然后,设置您的 API 密钥并启用追踪:

您可能还需要以下额外环境变量。

LANGSMITH_ENDPOINT 控制 SDK 向哪个 LangSmith 服务器发送数据。默认为 https://api.smith.langchain.com (GCP 美国)。仅在您使用不同部署时才设置此项。对于区域性 SaaS,请将其设置为您所在区域的 API URL:

LANGSMITH_WORKSPACE_ID 仅在您的 API 密钥作用域超过一个时才需要 工作区。在以下位置找到您的工作区 ID 设置页面 位于 **常规**:

LANGSMITH_WORKSPACE_ID=

要跨本地 shell 或远程运行时重复使用端点、API 密钥和工作区设置,请参阅 配置文件.

在 SDK 外部使用 API 密钥

请参阅 通过 API 管理组织的说明.