集成百炼应用

魔笔平台提供了强大的百炼应用集成功能,允许用户通过简单的配置,实现对百炼应用的无缝连接和数据交互。本文档将指导您如何创建和使用百炼应用集成。

功能介绍

魔笔平台的百炼应用集成功能支持以下特点:

  • 流式传输支持:在配置面板中开启「SSE」后即可支持流式数据传输。

  • 自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。

  • 回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。

  • 高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。

事件相关内容可参考:集成操作事件

使用百炼应用集成

步骤 1:创建百炼应用集成

  1. 登录魔笔平台,进入管控台。

  2. 导航至“资源”->“集成”,点击“创建集成”。

  3. 选择“百炼智能体应用”,并填写集成名称及描述。

  4. 配置不同环境的百炼应用连接信息,包括API-KEY工作空间等。

  5. 点击“确定”以创建百炼应用集成。

说明

关于如何创建百炼智能体应用,可以参考 0代码构建私有知识问答应用

步骤 2:在应用内部创建集成操作

  1. 打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。

    image

  2. 选择之前创建的百炼智能体应用集成作为资源,输入百炼应用 ID 和输入提示词后,根据需求,选择集成操作的触发方式和更加细节的配置内容。

image

  1. 点击“运行”预览查询效果。

配置面板详解

通用配置

  • 参数:定义查询所需的参数,包括类型、默认值和描述。在查询语句中,可通过{{ varName }}的方式引用参数。

  • 启用 SSE 响应:定义了每轮对话是否使用流式数据传输。

  • 应用 ID:定义了预期调用的百炼智能体应用 ID。

  • 提示词:定义了每轮对话中的输入提示词内容。

  • 会话 ID:定义了对话历史会话唯一标识,传入会话 ID 后,将在云端进行对话历史记录,调用大模型将自动携带存储的对话历史。

  • 检索召回过程显示:定义了是否输出检索召回处理过程信息。开启后,将返回文档检索召回和模型推理的过程信息。

  • 知识库检索范围:定义了在使用 RAG 应用时指定检索的知识库 ID 列表,在使用该参数前,请确保您的应用为 RAG 应用且在百炼平台没有配置知识库。关于如何获取知识库 ID,可以参考知识库image

  • 触发方式:选择手动触发或自动运行。手动触发仅在触发集成操作事件或通过 API 调用action.trigger方法时执行。自动运行则在初次加载和依赖项变更时自动执行,例如当集成配置中引用了页面输入框组件 input1 的数据时,当{{input1.value}}改变时,集成将自动触发执行并更新数据。

  • 超时时间:配置操作的最大执行时间。

  • 描述:为集成操作提供详细描述。

回调配置

  • 数据转化:对接口返回的数据进行处理,默认为return data,即不进行处理。

  • 流式接收回调:配置流式调用接口 chunk 数据获取时触发的事件。

  • 成功回调:配置接口调用成功时触发的事件。

  • 失败回调:配置接口调用失败时触发的事件。

高级配置

  • 防抖:设置防抖表达式,避免接口的频繁调用。

  • 禁止执行条件:根据条件表达式确定是否执行此集成操作。

手动触发集成

事件触发

  1. 在需要触发集成操作的组件中,配置事件处理器。

  2. 将动作类型设置为集成操作,并选择相应的集成。

  3. 以对象形式填写已配置的参数。

API 触发

若此集成操作的名称为action1,则在任何可以执行脚本的地方,可以使用action.trigger()方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。