魔笔平台提供了强大的 Dify 应用集成功能,允许用户通过简单的配置,实现对 Dify 应用的无缝连接和数据交互。本文档将指导您如何创建和使用 Dify 应用集成。
功能介绍
魔笔平台的 Dify 应用集成功能支持以下特点:
流式传输支持:在配置面板中开启「SSE」后即可支持流式数据传输。
自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。
回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。
高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。
事件相关内容可参考:集成操作事件
使用 Dify 应用集成
步骤 1:创建 Dify 应用集成
登录魔笔平台,进入管控台。
导航至“资源”->“集成”,点击“创建集成”。
选择“Dify”,并填写集成名称及描述。
配置不同环境的 Dify 应用连接信息,包括
Dify Base URL
、API-KEY
等。点击“确定”以创建 Dify 应用集成。
关于如何创建 Dify 应用,可以参考构建 Dify 应用。不同的应用需要配置不同的API-KEY
。
步骤 2:在应用内部创建集成操作
打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。
选择之前创建的 Dify 应用集成作为资源,根据需求配置参数,选择集成操作的触发方式和更加细节的配置内容。
点击“运行”预览查询效果。
配置面板详解
通用配置
根据不同的操作类型,需要配置不同的参数,操作类型包括:
对话型应用-发送对话消息:调用 Dify 的对话型应用(包括聊天助手和 Agent)发送消息接口,具体参数如下:
提问内容:发送给 Dify 应用的问题。
输入变量:Dify 应用配置的输入变量,例如 Dify 应用配置了输入变量
city
,则按下面形式进行传递。如果没有配置输入变量,则此项不填。用户标识:用于标识此次对话的用户。Dify 应用需要标识用户记录日志。
sse:是否启用流式响应。
重要Dify 的对话型应用必须开启 sse 流式开关,否则会响应失败。
工作流应用-执行工作流:调用 Dify 的工作流应用进行工作流的执行,具体参数如下:
输入变量:Dify 应用配置的输入变量,例如 Dify 应用配置了输入变量
city
,则按下面形式进行传递。如果没有配置输入变量,则此项不填。用户标识:用于标识此次对话的用户。Dify 应用需要标识用户记录日志。
sse:是否启用流式响应。
重要Dify 工作流应用回调数据转换需要设置为
return data
以返回全部的工作流响应内容,不推荐打开 sse 流式开关执行工作流。
文本生成应用-发送消息:调用 Dify 的文本生成应用发送消息,具体参数如下:
输入变量:Dify 应用配置的输入变量,例如 Dify 应用配置了输入变量
city
,则按下面形式进行传递。如果没有配置输入变量,则此项不填。用户标识:用于标识此次对话的用户。Dify 应用需要标识用户记录日志。
sse:是否启用流式响应。
回调配置
数据转化:对接口返回的数据进行处理,默认为
return data
,即不进行处理。流式接收回调:配置流式调用接口 chunk 数据获取时触发的事件。
成功回调:配置接口调用成功时触发的事件。
失败回调:配置接口调用失败时触发的事件。
高级配置
防抖:设置防抖表达式,避免接口的频繁调用。
禁止执行条件:根据条件表达式确定是否执行此集成操作。
手动触发集成
事件触发
在需要触发集成操作的组件中,配置事件处理器。
将动作类型设置为集成操作,并选择相应的集成。
以对象形式填写已配置的参数。
API 触发
若此集成操作的名称为action1
,则在任何可以执行脚本的地方,可以使用action1.trigger()
方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。