开始使用 LangSmith 之前,您需要创建一个账户。您可以在 LangSmith 界面中免费注册账户。LangSmith 支持使用 Google、GitHub 和电子邮件登录。

API 密钥

LangSmith 支持两种类型的 API 密钥。您可以使用这两种令牌来验证对 LangSmith API 的请求,但它们的使用场景不同: 要使用 LangSmith记录跟踪记录并运行评估,请创建 API 密钥来验证请求。

Open API Keys settings

转到 Settings 页面,然后选择 API Keys 部分。

Configure the key type

对于服务密钥,您可以选择组织范围密钥或工作区范围密钥。如果密钥的作用范围是工作区,则必须指定工作区。Enterprise 用户还可以为服务密钥分配特定的工作区角色,从而独立于任何用户调整其权限。

Set expiration

设置密钥的有效期。达到所选天数后,密钥将无法使用;如果选择永不过期,则不会失效。

Create the key

点击 Create API Key。 LangSmith 只会显示一次 API 密钥,因此请务必复制并将其存放在安全的位置。
要删除 API 密钥,请转到 Settings 页面,在 API Keys 部分找到该密钥,然后在 Actions 列中选择垃圾桶图标 。
Enterprise 组织管理员可以编辑现有服务密钥的角色,而无需轮换密钥。在 Settings 页面的 API Keys 部分,切换到 Service 选项卡,然后点击任意服务密钥行以打开编辑对话框。更新工作区角色(对于组织范围密钥,还需更新组织角色),然后点击 Save。密钥字符串本身不会改变。

配置 SDK

安装适用于您所用语言的 SDK:
有关完整详细信息,请参阅 Python SDK 或 JS/TS SDK 参考文档。 然后,设置 API 密钥并启用跟踪:
您可能还需要设置以下其他环境变量:
  • LANGSMITH_ENDPOINT 控制 SDK 将数据发送到哪个 LangSmith 服务器。默认值为 https://api.smith.langchain.com(GCP US)。只有在使用其他部署时才需要设置此变量。对于区域 SaaS,请将其设置为所在区域的 API URL:
    Region
    GCP US
    GCP EU
    GCP APAC
    AWS US
  • LANGSMITH_WORKSPACE_ID 仅当您的 API 密钥的作用范围超过一个工作区时才需要设置。在 Settings 页面的 General 下找到 Workspace ID: LANGSMITH_WORKSPACE_ID=<Workspace ID>
如需在本地 shell 或远程运行时之间复用终端节点、API 密钥和工作区设置,请参阅配置 Profile。

在 SDK 外部使用 API 密钥

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