跳到主要内容

如何通过工具调用Coze的工作流

Coze是一个强大的工作流自动化工具,可以用来创建各种自动化任务。ConsoleX支持通过工具调用Coze工作流,从而对大模型的能力进行扩展,使其具备完成更加复杂任务的能力。

基本步骤

  1. 在Coze中创建一个workflow,并将其发布,该工作流以Start节点开始并以End节点结束。Coze.com上的工作流调用URL为统一的 https://api.coze.com/v1/workflows/run。为了区分不同的工作流,在ConsoleX中需要在工作流调用URL后面添加工作流的ID,形式如: https://api.coze.com/v1/workflows/run#{workflow_id}。 End节点需要设置为response text方式,并组装成一个JSON对象作为工具的返回结果,该JSON对象中的字段值可以设置为工作流中使用的变量。
  2. 在ConsoleX AI中,点击工具然后再点击添加工具,在工具定义的JSON Schema描述中,输入与Coze工作流中输入参数相对应的JSON Schema描述。描述的格式与penAI标准工具描述格式一致。可以参考实例或者用AI辅助生成。
  3. 接下来点击选择发起工具调用,并选择POST方式,然后工具函数接口类型选择Coze,然后将Coze的工作流调用URL(需包含工作流ID)填入到工具函数接口url中。返回内容处理方式根据情况选择其一,然后点击保存,对应Coze工作流的工具就创建好了。
  4. 最后,在对话中根据需要添加该工具,大模型就会像其他工具一样,根据工具的描述和输入参数,自动调用Coze工作流,并返回结果。

注意事项

  1. 工具的JSON Schema描述需要与Coze工作流中输入参数相对应,否则大模型无法正确调用Coze工作流。可以在Coze的运行历史中查看工作流调用的调试信息。
  2. Coze中的工作流需要发布后才能被调用,在未发布的情况下不能被调用。
  3. Coze国际版和中国版的工作流调用URL不同,
  • 国际版为: https://api.coze.com/v1/workflows/run
  • 中国版为: https://api.coze.cn/v1/workflows/run

常见问题

设置工作流的auth token验证

Coze的所有工作流都使用统一的token验证,需要在Authorization中创建一个token,并设置好使用权限。请注意目前Coze的token有过期时间,最多只能使用30天,所以需要定期更新。