callTool
调用当前应用的 Tool。
豆包会根据当前应用插件页面或会话 Widget 确定应用和版本,开发者只需传入 Tool 名称和参数。
Tool 正常结果通过 toolResult 返回,Tool 业务错误通过 toolError 返回,两者都会正常
resolve;调用前校验、鉴权或返回结构校验失败时 Promise reject。
支持版本
前端库版本不低于 0.0.42。
支持平台
支持场景
接入准备
前置条件
- Android:在当前应用的应用插件页面或由当前应用真实生成的会话 Widget 内调用,且目标 Tool 已在当前应用版本中配置
- iOS:在当前应用的应用插件页面或由当前应用真实生成的会话 Widget 内调用,且目标 Tool 已在当前应用版本中配置
使用说明
- toolResult 与 toolError 互斥;toolError 是正常返回的 Tool 业务错误,不会导致 Promise reject。skipWidgetUpdate 为 true 时不执行 Widget 更新阶段,因此不会返回 cardUpdateError;否则 cardUpdateError 表示 Tool 已执行但当前 Widget 更新失败。reloadWidget 默认为 true,仅影响更新后的 Widget 是否重建。重试会再次执行 Tool,请避免重复触发。
调用方式
异步 API
入参
调用示例
成功返回
返回示例
错误处理
错误对象和通用错误码见 通用错误处理。
失败示例
错误码
通用错误码
平台差异
- 非应用插件页面、Widget 容器返回 103;参数非法返回 104;返回结构无效返回 112;上下文无效、网络或服务端调用失败返回 102。