所有类和接口
类
说明
Dify API 客户端抽象基类
提供通用的 HTTP 请求处理方法
Agent 日志事件
Agent 日志事件数据
Agent模式下返回文本块事件
Agent模式下思考步骤事件
标注
标注列表响应
标注回复
应用信息响应
应用元数据响应
应用参数响应
标记回复
文件上传配置
图片设置
引用和归属
语音转文本
启用回答后给出推荐问题
系统参数
应用 WebApp 设置
语音转文字响应
所有事件的基类
消息事件的基类
对话流式回调接口
工作流事件的基类
工作流编排对话型应用流式回调接口
继承自 ChatStreamCallback，增加工作流相关回调方法
对话消息请求
对话消息响应（阻塞模式）
对话流式回调接口
子分段响应
示例：
{
"data": [{
"id": "",
"position": 1,
"document_id": "",
"content": "1",
"answer": "1",
"word_count": 25,
"tokens": 0,
"keywords": ["a"],
"index_node_id": "",
"index_node_hash": "",
"hit_count": 0,
"enabled": true,
"disabled_at": null,
"disabled_by": null,
"status": "completed",
"created_by": "",
"created_at": 1695312007,
"indexing_at": 1695312007,
"completed_at": 1695312007,
"error": null,
"stopped_at": null
}],
"doc_form": "text_model",
"has_more": false,
"limit": 20,
"total": 9,
"page": 1
}
子分段信息
子分段响应
示例：
{
"data": {
"id": "",
"segment_id": "",
"content": "子分段内容",
"word_count": 25,
"tokens": 0,
"index_node_id": "",
"index_node_hash": "",
"status": "completed",
"created_by": "",
"created_at": 1695312007,
"indexing_at": 1695312007,
"completed_at": 1695312007,
"error": null,
"stopped_at": null
}
}
子分段信息
文本生成请求
文本生成响应（阻塞模式）
文本生成流式响应回调接口
对话会话
对话会话列表响应
创建知识库请求
通过文件创建文档请求
通过文本创建文档请求
新增元数据
新增文档分段请求
分段信息
创建标签请求
知识库列表响应
知识库信息
知识库响应
外部知识库信息
外部检索模型
重排序模型
检索模型字典
Dify API 客户端默认实现
提供对话型应用、文本生成型应用和工作流应用的完整功能
Dify 知识库客户端默认实现
提供知识库相关的操作
删除标签请求
详细文档响应（用于获取文档详情接口）
文档处理规则信息
处理规则信息
Dify API 异常
用于表示 API 业务逻辑错误，如参数错误、权限不足、资源不存在等
Dify 基础客户端接口
包含所有客户端共用的基础功能
Dify 基础客户端实现类
Dify 对话型应用客户端接口
包含对话型应用相关的功能
Dify 工作流编排对话型应用客户端接口
继承自 DifyChatClient，支持工作流编排对话型应用的特性
Dify API 客户端接口
继承所有细分客户端接口，提供完整的功能
Dify客户端工厂类
Dify 文本生成型应用客户端接口
包含文本生成型应用相关的功能
Dify客户端配置
Dify 知识库客户端接口
提供知识库相关的操作
Dify Workflow应用客户端接口
包含Workflow应用相关的功能
文档元数据列表响应
文档元数据
文档列表响应
文档信息
文档响应
数据源信息
文档信息
嵌入模型列表响应
嵌入模型
语言
模型
模型属性
错误事件
Dify API 事件类型枚举
文件信息
文件预览响应
文件传输方式
文件类型
文件上传请求
文件上传响应
HTTP客户端工具类
文档嵌入状态响应
嵌入状态
迭代器执行完成事件
迭代器执行完成事件数据
迭代器下一次执行事件
迭代器下一次执行事件数据
迭代器开始执行事件
迭代器开始执行事件数据
JSON工具类
关键词设置
循环执行完成事件
循环执行完成事件数据
循环下一次执行事件
循环下一次执行事件数据
循环开始执行事件
循环开始执行事件数据
消息结束事件
LLM 返回文本块事件
文件事件
消息列表响应
Agent 思考内容
反馈信息
消息
消息文件
消息内容替换事件
元数据信息
元数据响应
node 执行结束事件
node 执行结束事件数据
node 开始执行事件
node 开始执行事件数据
元数据请求数据
元数据
心跳事件
处理规则
预处理规则
自定义规则
分段规则
子分段规则
Dify 响应模式
检索模式
过滤条件
元数据过滤条件
Rerank 模型配置
检索请求
检索响应
文档信息
查询信息
记录
分段信息
引用和归属分段信息
创建或者更新子分段请求
分段列表响应
分段信息
分段响应
分段信息
简单响应
流式事件分发器
负责将事件分发到对应的回调方法
建议问题响应
标签绑定请求
标签列表响应
标签响应
标签解绑请求
TTS 音频流结束事件
TTS 音频流事件
更新知识库请求
Rerank 模型配置
检索模型
通过文件更新文档请求
通过文本更新文档请求
更新文档状态请求
更新元数据
更新分段请求
分段信息
修改标签请求
上传文件响应
模型用量信息
向量设置
混合检索模式下的权重设置
workflow 执行结束事件
workflow 执行结束事件数据
工作流日志响应
终端用户
工作流日志项
工作流执行信息
Workflow 执行请求
Workflow 执行响应（阻塞模式）
Workflow 执行数据
工作流执行状态响应
workflow 开始执行事件
workflow 开始执行事件数据
工作流停止响应
Workflow 流式响应回调接口
workflow llm执行过程
workflow llm执行过程内容