主题
感知授权的工具响应
格式化工具响应,以触发 OAuth 流程并自动恢复执行。
某些工具需要用户授权(例如 Google、Slack、GitHub)。LangSmith Fleet 包含中间件,可检测工具何时需要授权,并通过清晰的提示暂停运行。用户完成授权后,同一个工具调用会自动重试。
请求授权时返回的结构
如果工具检测到缺少授权,请返回包含以下字段的 JSON 字符串:
json
{
"auth_required": true,
"auth_url": "https://auth.example.com/start",
"auth_id": "opaque-tracking-id"
}auth_required:设为true以表示需要中断。auth_url:应将用户重定向到该地址进行授权。auth_id:可选关联 ID,用于跟踪授权会话。
当 Fleet 检测到此响应时,它会中断运行,向用户显示身份验证界面,并在授权完成后自动重试该工具调用。
如果你希望自定义工具复用相同的「需要身份验证」中断和界面,请确保工具返回相同结构的 JSON。
NOTE
只将此 JSON 作为工具输出返回。避免包含额外文本或内容。Fleet 会解析该响应以触发身份验证流程。