AIagent 组件 开发规范
目 录
- 应用入口..
- 名词解释.2.1. 什么是插件.2.2. 什么是自定义组件. 22.3. 什么是小程序节点. 3
- 功能操作.3.1. 插件. 33.2. 自定义组件.3.3. 小程序.
1. 应用入口
可点击注册账号使用平台。
2. 名词解释
2.1. 什么是插件
插件是一个工具集，一个插件内可以包含一个或多个工具（API）。
插件作为一个模块化设计的软件部分，它旨在为系统增添额外功能或提升现有性能。其核心优势在于让使用者能依据自身的需求，来定制和扩大系统的功能范围，而无须对系统的基础代码进行改动。借助于各种插件的集成，使用者能够便捷地引入新功能，从而打造出更为灵活且强大的系统架构。支持用户自行开发定制插件，每款插件内部可以整合多种工具，并且所有工具都需要遵循统一的域名规则。每个工具实际上就是单独的一个API 接口。当智能体需要调用插件功能时，其实是在调用该插件中具体的某个工具，即调用特定的 API。
以天气查询服务为例，可能就有如下的两个API：
查询即时天气：http://api.weather.com/current查询天气预报：http://api.weather.com/forecast在这种情况下，每个API 就相当于插件里的一个具体工具。
2.2. 什么是自定义组件
自定义组件是一种允许用户通过编写代码来生成特定输出或执行特定功能的组件。在半云科技有限公司的扳手AI 平台上，这种自定义组件通过代码节点实现。这些代码节点让用户能够利用集成的代码编辑IDE（集成开发环境）工具，根据业务需要编写自定义的代码逻辑。这样，用户可以根据具体的输入参数进行处理，并得到期望的响应结果，从而提高了平台的灵活性和定制化能力。
配置代码节点时，有以下几个关键点需要特别注意：
变量声明与参数传递：首先，你需要在代码中声明你所需要的变量。当添加输入参数时，确保明确指定这些参数的名称以及它们的值。这样做的好处是可以让节点之间传递数据变得非常灵活，因为变量的值既可以设置为固定的数值，也可以引用自上游节点的输出参数。
代码编写方式：在代码节点内，你需要提供一段需要执行的代码片段。这里有两种选择：你可以根据自己的需求手工编写代码，或者利用AI 辅助来自动生成代码。这种灵活性使得开发过程更加高效且精确。另外，代码还可以直接使用输入参数进行操作，并通过返回一个对象的形式输出处理后的结果。
函数限制：值得注意的是，代码节点并不支持编写多个独立的函数。这意味着无论你的逻辑多么复杂，所有功能都必须集成到一个统一的函数中，而且不管有多少个输出值，最终都需要以对象的形式返回结果。
支持的编程语言：当前，该平台支持 JavaScript 和 Python 两种主流的编程语言。这两种语言各有特点，可以根据项目的具体需求和技术团队的熟练程度进行选择。
说明：
1、Python 中暂不支持 os, subprocess, eval, exec, open, globals。
2、locals,pickle,sys,socket,shutil 等存在安全风险的第三方依赖库或者 api 操作。
3、Python 环境使用的 Python 版本为大于等于 3.10 小于 3.12.2。
4、Python 代码需要严格镶嵌在预先定义的函数中，返回实际想要返回的运行结果。
5、Python 节点支持接受、处理传入的参数，详见示例示例如下：def main(*args):arg1 $\underline{{\underline{{\mathbf{\Pi}}}}}$ args[0]['arg1']arg2 $\mathbf{\bar{\rho}}=$ args[0]['arg2']return {"result":"hello ai!"}
2.3. 什么是小程序节点
小程序节点允许开发者或业务方将其功能以小程序的形式封装，并作为模块化的组件集成到AI 系统或其他应用中。通过这种方式，不同的业务逻辑和功能可以被灵活地组装和复用，增强系统的灵活性和扩展性。这种做法不仅提高了开发效率，也使得定制化和个性化的服务成为可能，满足了多样化的用户需求和服务场景。例如：订票功能：一个订票小程序节点可以被集成到AI 聊天机器人中，用户可以通过与机器人的自然语言交互来完成订票操作，而无需跳转到专门的订票网站或APP。查询快递功能：用户可以直接在AI 应用内输入快递单号查询物流信息，简化了用户寻找快递信息的步骤，提升了用户体验。证明申请：对于需要频繁使用证明申请服务的机构或个人，整合到AI 系统的证明申请小程序节点可以提供一站式的服务，节省时间和精力。
3. 功能操作
3.1. 插件
登录扳手AI 智能体平台
在左侧导航栏中选择点击【我的AI 应用】，再选择进入【插件库】进行插件的新增。
平台内置插件可以直接进行使用，或者点击【新增】添加插件。
扳手AI 平台_操作手册
参数说明
【名称】：这是指该组件或API 的唯一标识名。
【图标】：是一个小图片或符号，用于快速识别该组件或API。
【分类】：根据功能或用途将组件或API 进行归类。
【OpenAPI Schema】：指的是用于描述 API 接口的标准格式，如
Swagger 或 OpenAPI 规范，它详细定义了 API 的方法、参数、响应等。
【鉴权方式】：描述了使用此API 需要何种身份验证机制，常见的有OAuth2.0、JWT 等。
【工具】：这里列出了与该组件或API 相关的各种工具，包括它们的名称、简要描述、访问方法（如HTTP 请求方法）和路径，以及可能的操作选项。
3.2. 自定义组件
登录扳手AI 智能体平台
在左侧导航栏中选择点击【我的AI 应用】，再选择进入【技能库】新建技能。
进入技能编排，在左侧的导航栏选择自定义组件。
技能编排中的自定义组件功能，支持用户编写特定的代码逻辑，实现个性化的功能扩展，并将结果输出或返回，以满足特定的业务需求或创新应用场景。
配置示例：
3.3. 小程序
小程序节点是在工作流编排中编写和执行前端页面代码。允许开发者在无需离开对话界面的情况下，快速构建和部署交互式网页应用。通过在智能体工作流中嵌入小程序节点，能够扩展AI 的能力边界，为用户提供更加丰富和个性化的互动体验。
配置示例：
