扣子 Coze 官方文档
Documentation Index
Fetch the complete documentation index at: https://docs.coze.cn/llms.txt Use this file to discover all available pages before exploring further.
在扣子罗盘中注册火山智能体后,你可以在扣子罗盘中观测、调试或评测该火山智能体。
什么是火山智能体 {#3f65dab9}
火山智能体是通过火山引擎智能体框架(VeADK,Volcengine Agent Development Kit)开发的智能体。关于 VeADK 的详细说明可参考 VeADK 帮助文档。目前,仅部署到火山引擎函数服务和火山引擎 AgentKit 的火山智能体可以在扣子罗盘中注册。
- 参考 部署到 VeFaaS 把火山智能体部署到函数服务。
- 参考 部署到 AgentKit 把火山智能体部署到 AgentKit。
:::notice 注意 火山智能体的部署模式必须选择 A2A / MCP Server,才能注册到扣子罗盘进行评测。 ::: 火山智能体的 Trace 数据可以直接上报至扣子罗盘,实现调用链路观测;在扣子罗盘中注册的火山智能体,也可以通过观测功能进行 Agent 评测。
注册火山智能体 {#481f8633}
步骤一(可选):把火山智能体的 Trace 数据上报到扣子罗盘 {#f010ca6f}
如需通过扣子罗盘实现 Trace 观测,在通过 VeADK 开发火山智能体时,你需要通过以下步骤上报 Trace 数据。配置步骤如下:
在 VeADK 配置文件
config.yaml的observability字段中填写cozeloop的属性。关于配置文件的详细说明及示例可参考 配置文件。| | | \
属性 说明 endpoint 固定设置为 https://api.coze.cn/v1/loop/opentelemetry/v1/traces。api_key 扣子罗盘访问密钥,支持个人访问令牌、OAuth 访问令牌和服务访问令牌。获取方式可参考配置个人访问令牌。 service_name 扣子罗盘工作空间的 ID。你可以在登录扣子罗盘之后,左上角切换到想要存放火山智能体数据的工作空间,并在 URL 的 space 关键词之后获取工作空间 ID,例如 https://loop.coze.cn/console/enterprise/personal/space/73917415734092****/pe/prompts中,73917415734092****为工作空间 ID。一个可参考的 config.yaml 示例如下:
YAMLmodel: agent: provider: openai name: doubao-1-5-pro-256k-250115 api_base: https://ark.cn-beijing.volces.com/api/v3/ api_key: 火山方舟模型apikey # 火山引擎认证信息 volcengine: access_key: 填自己的火山ak secret_key: 填自己的火山sk observability: # [optional] for exporting tracing data to Volcengine CozeLoop and APMPlus platform opentelemetry: cozeloop: endpoint: https://api.coze.cn/v1/loop/opentelemetry/v1/traces api_key: 填罗盘的apikey service_name: 填要上报trace的罗盘的空间ID设置云端上报器
exporter,添加 CozeLoopExporter 以记录 Agent 执行过程中的关键路径与中间状态。详细说明及示例代码可参考 VeADK 观测。
步骤二:获取访问域名和 API Key {#ab754735}
如果你的火山智能体部署到了 AgentKit,你可以直接跳到步骤三。 如果你的火山智能体部署到了函数服务,你需要在函数服务的 我的应用 列表中找到已部署的火山智能体的访问域名与 API Key。如下图所示:
- 访问域名:访问地址
?前面的部分。 - API Key:访问地址中请求参数 Token 的值。
步骤三:注册火山智能体 {#e8ca8988}
目前,注册部署到函数服务的火山智能体需要在扣子罗盘操作;注册部署到 AgentKit 的火山智能体需要在 AgentKit 操作。
注册部署到函数服务的火山智能体 {#a5884bfa}
- 登录扣子罗盘。
- 在左侧导航栏中选择 应用 > 应用注册,并在页面右上角单击 注册新应用。
- 把火山部署平台设置为 VeFaaS,然后把你在步骤二获取的访问域名和 API Key 分别填入 火山智能体访问域名 和 火山智能体 API Key。
- 单击获取智能体元信息,测试 Endpoint 是否能正常访问,并获取到对应智能体元信息(ID、名称与描述)。
- 确认无误后,单击确认注册。
说明
若注册的火山智能体的 Trace 未上报到当前工作空间,不影响注册,且注册后可开展评测实验,但在当前空间查询不到此智能体的 Trace 数据。
注册部署到 AgentKit 的火山智能体 {#ba8e6bf8}
参考 接入Cozeloop 在 AgentKit 中把火山智能体注册到扣子罗盘。你暂时无法在扣子罗盘中注册部署到 AgentKit 的火山智能体。
其他操作 {#30e48d1b}
观测火山智能体 {#311a7154}
完成火山智能体的 Trace 数据上报和注册之后,你可以在 应用详情 页面的 观测 页签查看来源为当前火山智能体的 Trace 数据。 关于 Trace 功能的详细说明可参考 查看 Trace 数据。
调试火山智能体 {#b356e035}
你可以在 应用详情 页面的 调试 页签调试在扣子罗盘中注册的火山智能体。
评测火山智能体 {#78a14b7f}
在扣子罗盘中注册火山智能体后,你在 应用详情 页面的 评测 页签查看当前火山智能体的实验列表,也可以单击 新建实验 为当前火山智能体创建评测实验。关于评测实验的详细操作步骤可参考评测概述 。
{#a37114ee}
编辑火山智能体 {#04498615}
若火山智能体迭代变更后,如果 API key 有变更,可通过修改应用配置来重新设置 API key;如果智能体名称或描述有变更,可刷新火山智能体信息。操作步骤如下:
- 在左侧导航栏中单击应用注册,并在列表中找到要修改的火山智能体。
- 在操作列单击编辑。
- 在 编辑应用 页面单击 修改配置。
- 你可以重新设置 API Key,也可以单击 获取智能体原信息 来刷新火山智能体信息。修改完成后,单击确认。