主题
创建账户和 API 密钥
要开始使用 LangSmith,你需要创建一个账户。你可以在 LangSmith UI 中注册免费账户。LangSmith 支持使用 Google、GitHub 和电子邮件登录。
API 密钥
LangSmith 支持两种类型的 API 密钥。你可以使用这两种 token 对 LangSmith API 请求进行身份验证,但它们有不同的用例:
- 个人访问 token (PAT) 继承创建它们的用户的权限。将 PAT 用于个人脚本或工具。
- 服务密钥作用域为特定工作区或整个组织。将服务密钥用于应用和生产服务。
要使用 LangSmith 记录追踪并运行评估,请创建 API 密钥以对你的请求进行身份验证。
Open API Keys settings
导航到 Settings 页面并选择 API Keys 部分。
Configure the key type
对于服务密钥,请在组织作用域和基于工作区作用域的密钥之间选择。如果密钥是工作区作用域的,则必须指定工作区。
企业版用户还可以为服务密钥分配特定的工作区角色,从而独立于任何用户调整其权限。
Set expiration
设置密钥的过期时间。所选天数过后密钥将不可用;如果选择「永不过期」,则永不过期。
Create the key
点击 Create API Key。LangSmith 只会显示一次 API 密钥,因此请务必复制并存储在安全的地方。
TIP
企业版 Organization Admin 可以在不轮换密钥的情况下编辑现有服务密钥的角色。在 Settings 页面的 API Keys 部分,切换到 Service 选项卡,点击任意服务密钥行以打开编辑对话框。更新工作区角色(对于组织作用域的密钥,还需更新组织角色),然后点击 Save。密钥字符串本身不变。
停用或删除个人访问 token
停用会暂时阻止 PAT 进行身份验证;删除会永久移除它。当你需要保留记录并稍后重新激活时,请停用 token。
成员可以停用、重新激活和删除自己的 PAT。Organization Admin 和 Organization Operator 也可以管理每个成员的 PAT。
| 操作 | 效果 | 可逆 |
|---|---|---|
| 停用 | 停止身份验证并保留记录、所有者和上次使用信息,并显示 Deactivated 徽章。 | 是。选择 Reactivate key 以再次使用同一 token。 |
| 重新激活 | 允许使用同一 token 及其原始过期日期再次进行身份验证。 | 是。可随时再次停用该 token。 |
| 删除 | 永久移除 token 及其记录。 | 否。如果你需要再次访问,请创建新 token。 |
停用不会更改 token 的过期日期,一旦该日期过去,Reactivate key 将不可用。请改为创建新 token。
要停用或删除 PAT:
- 转到 Settings > API Keys,然后打开 Personal 选项卡。
- 在 My keys 下找到该 token。要管理另一个成员的 token,请切换到 All members。
- 在 Actions 列中,选择 Deactivate key 或 Delete key。每个操作都会打开各自的确认对话框。
- 输入对话框显示的 token 描述。对于没有描述的 token,请改为输入 Key 列中的短密钥。
- 选择 Deactivate 或 Delete 进行确认。成功通知会确认该操作。
要重新激活已停用的 PAT,请在 Actions 列中选择 Reactivate key。重新激活只需一次点击,无需确认对话框,并会显示成功通知。
身份验证结果会被缓存,因此已停用或删除的 token 会在一分钟内停止工作,而不是立即停止。已重新激活的 token 在缓存拒绝过期之前可能仍不可用。
审计日志将停用记录为 revoke_personal_access_token,将重新激活记录为 reinstate_personal_access_token。
服务密钥只能删除,不能停用。打开 Service 选项卡,在 Actions 列中选择 Delete key,然后输入删除 PAT 所需的描述进行确认。
配置 SDK
为你的语言安装 SDK:
bash
pip install langsmithbash
uv add langsmith有关完整详情,请参阅 Python SDK 或 JS/TS SDK 参考。
然后,设置你的 API 密钥并启用追踪:
bash
export LANGSMITH_API_KEY=<your-api-key>
export LANGSMITH_TRACING=true你可能还需要以下额外的环境变量:
LANGSMITH_ENDPOINT控制 SDK 将数据发送到哪个 LangSmith 服务器。它默认为https://api.smith.langchain.com(GCP US)。仅当你使用不同的部署时才设置它。对于区域 SaaS,请将其设置为你的区域对应的 API URL:区域 主机 / URL GCP US {`$ / https://${prefix_0 || "api.smith"}.langchain.com${suffix_0 || ""}`}GCP EU {`$ / https://eu.${prefix_0 || "api.smith"}.langchain.com${suffix_0 || ""}`}GCP APAC {`$ / https://apac.${prefix_0 || "api.smith"}.langchain.com${suffix_0 || ""}`}AWS US {`$ / https://aws.${prefix_0 || "api.smith"}.langchain.com${suffix_0 || ""}`}LANGSMITH_WORKSPACE_ID仅当你的 API 密钥作用域为多个工作区时才需要。在 Settings 页面的 General 下查找你的 Workspace ID:LANGSMITH_WORKSPACE_ID=<Workspace ID>
要在本地 shell 或远程运行时之间复用端点、API 密钥和工作区设置,请参阅配置文件。
在 SDK 之外使用 API 密钥
请参阅通过 API 管理组织的说明。