LangSmith 的 API 支持通过 API 密钥以编程方式访问 UI 中可用的所有操作,只有少数例外情况已在仅限用户的端点中注明。
偏好使用基础设施即代码?请使用 LangSmith Terraform 提供程序 来声明式地管理工作区、角色、成员、评估器和警报。
在深入了解此内容之前,阅读以下内容可能会有所帮助:
存在一些限制,这些限制很快将被解除:
  • LangSmith SDK 尚不支持这些组织管理操作。
  • 具有组织管理员权限的、组织范围的 服务密钥 可用于执行这些操作。
使用 X-Tenant-Id 请求头来指定要操作哪个工作区。如果该请求头不存在,并且密钥不是组织范围的,操作将默认针对该密钥最初创建时所在的工作区。如果使用组织范围的服务密钥访问工作区范围的资源时未指定 X-Tenant-Id,请求将以 403 Forbidden 错误失败。
下面列出了一些常用的端点和用例。有关可用端点的完整列表,请参阅 API 文档。所有请求都应包含 X-Organization-Id 请求头,而针对特定工作区的请求则应包含 X-Tenant-Id 请求头。

工作区

用户管理

基于角色的访问控制 (RBAC)

成员管理

下方 RBAC 部分的 列出角色 应用于检索这些操作的角色 ID。列出 [组织|工作区] 成员 端点(如下)响应中的 "id" 应在这些操作中用作 identity_id。 组织级别: 工作区级别:
应省略以下参数:read_only(已弃用)、password 和 full_name(仅用于 基本认证)。

API 密钥

安全设置

执行这些更改需要组织管理员权限。
此处的 “共享资源” 是指 公开提示词、共享运行记录 和 共享数据集。
更新这些设置会影响组织中的所有资源。
您可以在工作区的 设置 > 共享 选项卡下更新这些设置,或通过 API:
  • 更新组织共享设置
    • 使用 unshare_all 来取消共享所选工作区的所有共享资源 - 使用 disable_public_sharing 来阻止未来共享资源
这些设置只能通过 API 编辑:

仅限用户的端点

这些端点是用户范围的,需要已登录用户的 JWT,因此应仅通过 UI 执行。
  • /api-key/current 端点:这些与用户的个人访问令牌 (PAT) 相关
  • /sso/email-verification/send(仅限云版本):此端点与 SAML SSO 相关

示例代码

下面的示例代码演示了与组织管理相关的一些常见工作流。请确保在代码中出现 <replace_me> 的地方进行必要的替换。