我的工具
您可以在这里,将您需要智能体/工作流调用的 API 包装为工具,供它们使用。一个工具中可以配置多个 API。
创建工具
在我的工具内创建工具,简单填写工具的基本信息,即可完成创建。
在配置工具信息时,可以按照 Swagger OpenAPI 的方式去撰写。
- 名称:工具的名称。
- 描述:工具的具体作用。建议描写地具体一些,便于 LLM 识别并作出正确的调用决策。
在工具创建完毕后,需要继续完成鉴权和API 配置步骤。
鉴权
在鉴权页面中,选择鉴权的类型。当前提供了Bearer
、Basic
、Service
三种类型。
同时,您需要选择是否在此完成鉴权:
- 是:您需要在此填写鉴权信息,完成鉴权。如此一来,当智能体/工作流使用该工具时,就不需要再次鉴权,可以直接使用。
- 否:您无需在此填写鉴权信息,但当智能体/工作流使用该工具时,必须先鉴权,才能使用。您可以在鉴权指引中填写一个 URL,以指引智能体/工作流的开发者进行鉴权。
在下方的 Headers 部分,您可以补充一些该工具的所有 API 所共有的Headers
信息,以免去在每个 API 中重复配置Headers
参数的工作。
API
您可以通过简单的四个步骤,完成对一个工具 API 的配置。
第一步:填写基本信息。
- 名称:API 的名称,必须以 API 命名方式,建议使用驼峰命名法。
- 描述:API 的描述,建议描写地具体一些,便于 LLM 识别并作出正确的调用决策。
- 方法:该 API 的调用方法。
- 路径:该 API 的路径。必须以
/
开头。在路径中,可以使用单花括号{pathVar}
的形式填入Path
类参数。该参数可以在**第二步(入参)**中具体配置。例如/getName/{userId}
,然后在入参中配置一个名为userId
的参数即可。
第二步:配置入参。
您需要将 API 的入参在这里进行配置。
提示:若 API 有对应的文档,则对照着填写即可。
- 名称:字段的名称。
- 描述:字段的描述。
- 类型:字段的类型。
- 方法:该字段所属的方法。
- 必填:该字段是否为必填。
- 默认值:为该字段定义默认值。
第三步:配置出参。
在这里配置 API 的返回结构。
您可以使用自动解析,系统将调用该 API 后,自动地将返回的结构渲染至列表内,省去您手动填写的时间。
第四步:调试。
在此对 API 进行调用与调试,若调用成功,则 API 配置完成。
使用工具
智能体
在普通智能体(Agent),在配置页面找到工具,并进行添加,即可将工具添加至智能体内。
在对话时,智能体会根据对话内容,自主决定工具调用。
在流智能体(FlowAgent),在 LLM 组件配置中找到工具,并进行添加,即可将工具添加至智能体内。
在对话时,智能体会根据对话内容,自主决定工具调用。
工作流
在 LLM 组件中使用,在组件配置中找到工具,并添加需要的工具即可。
在工作流运行时,若运行路径经过 LLM 组件,则 LLM 会自主决定工具调用。
在工具组件中使用,直接添加需要使用的工具的具体 API 即可。
添加后,无需自定义节点入参,节点本身已将 API 入参作为默认入参,您可以直接传值使用。
在工作流运行时,若运行路径经过工具组件,则会调用该 API,并将返回结果传输至下游节点。