com.dify.client

接口 IDifyChatClient

所有超级接口:

IDifyClient

所有已知实现类:

DifyChatClientImpl

public interface IDifyChatClient
extends IDifyClient

适用于对话应用的客户端 ChatBot、Agent、ChatFlow

方法概要

限定符和类型	方法和说明
String	audioToText(File file, String user) 语音转文字
com.alibaba.fastjson.JSONObject	conversations(String user, Integer limit, String sortBy, String lastId) 获取会话列表
Boolean	deleteConversation(String conversationId, String user) 删除会话
com.alibaba.fastjson.JSONObject	history(String conversationId, String user, Integer limit, String firstId) 获取会话历史消息
com.alibaba.fastjson.JSONObject	renameConversation(String conversationId, String user, String name) 会话重命名
DifyChatResult	sendMessages(ParamMessage message) 发送对话消息（同步接收）
CompletableFuture<Void>	sendMessagesAsync(ParamMessage message, Consumer<DifyChatResult> consumer) 发送对话消息（流式接收）
Boolean	stopResponse(String taskId, String user) 停止响应(仅支持流式模式)
List<String>	suggestedList(String messageId, String user) 获取下一轮建议问题列表

从接口继承的方法 com.dify.client.IDifyClient

getAppInfo, getAppMetaInfo, getAppParameters, requestJson, requestJson, requestJson, requestJson, requestJson, requestJson, requestJson, requestJson, requestMultipart, requestMultipart, requestMultipart, sendBlocking, sendBlocking, sendStreaming, sendStreaming, sendStreaming, uploadFile

方法详细资料

sendMessages

DifyChatResult sendMessages(ParamMessage message)

发送对话消息（同步接收）

参数:

message - ParamMessage

返回:

DifyChatResult

sendMessagesAsync

CompletableFuture<Void> sendMessagesAsync(ParamMessage message,
                                          Consumer<DifyChatResult> consumer)

发送对话消息（流式接收）

参数:

message - ParamMessage

consumer - consumer

返回:

CompletableFuture

stopResponse

Boolean stopResponse(String taskId,
                     String user)

停止响应(仅支持流式模式)

参数:

taskId - 任务 ID，可在流式返回 Chunk 中获取

user - 用户标识，用于定义终端用户的身份，必须和发送消息接口传入 user 保持一致。

返回:

Boolean

suggestedList

List<String> suggestedList(String messageId,
                           String user)

获取下一轮建议问题列表

参数:

messageId - 消息ID

user - 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。

返回:

List

history

com.alibaba.fastjson.JSONObject history(String conversationId,
                                        String user,
                                        Integer limit,
                                        String firstId)

获取会话历史消息

参数:

conversationId - 会话ID

user - 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。

limit - 一次请求返回多少条聊天记录，默认 20 条。

firstId - 当前页第一条聊天记录的 ID，默认为空，表示获取第一页数据

返回:

JSONObject

conversations

com.alibaba.fastjson.JSONObject conversations(String user,
                                              Integer limit,
                                              String sortBy,
                                              String lastId)

获取会话列表

参数:

user - 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。

lastId - （选填）当前页最后面一条记录的 ID，默认 null

sortBy - （选填）排序字段，默认 -updated_at(按更新时间倒序排列) 可选值：created_at, -created_at, updated_at, -updated_at 字段前面的符号代表顺序或倒序，-代表倒序

limit - （选填）一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。

返回:

JSONObject

deleteConversation

Boolean deleteConversation(String conversationId,
                           String user)

删除会话

参数:

conversationId - 会话 ID

user - 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。

返回:

Boolean

renameConversation

com.alibaba.fastjson.JSONObject renameConversation(String conversationId,
                                                   String user,
                                                   String name)

会话重命名

参数:

conversationId - 会话ID

user - 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。

name - 会话名称

返回:

JSONObject

audioToText

String audioToText(File file,
                   String user)
            throws DifyException,
                   IOException,
                   InterruptedException

语音转文字

参数:

file - 语音文件。 支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm'] 文件 大小限制：15MB

user - 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException