程序包 io.github.imfangs.dify.client.impl

类 DefaultDifyClient

java.lang.Object

io.github.imfangs.dify.client.impl.AbstractDifyClient

io.github.imfangs.dify.client.impl.DifyBaseClientImpl

io.github.imfangs.dify.client.impl.DefaultDifyClient

所有已实现的接口:

DifyBaseClient, DifyChatClient, DifyChatflowClient, DifyClient, DifyCompletionClient, DifyWorkflowClient, AutoCloseable

public class DefaultDifyClient
extends DifyBaseClientImpl
implements DifyClient

Dify API 客户端默认实现 提供对话型应用、文本生成型应用和工作流应用的完整功能

字段概要

从类继承的字段 io.github.imfangs.dify.client.impl.AbstractDifyClient

apiKey, AUDIO, baseUrl, httpClient, JSON, OCTET_STREAM

构造器概要

构造器

构造器	说明
DefaultDifyClient(String baseUrl, String apiKey)	构造函数
DefaultDifyClient(String baseUrl, String apiKey, okhttp3.OkHttpClient httpClient)	构造函数

方法概要

修饰符和类型	方法	说明
AnnotationReply	annotationReply(String action, String embeddingProviderName, String embeddingModelName, Integer scoreThreshold)	标注回复初始设置
AudioToTextResponse	audioToText(File file, String user)	语音转文字
AudioToTextResponse	audioToText(InputStream inputStream, String fileName, String user)	语音转文字
SimpleResponse	deleteAnnotation(String annotationId)	删除标注
SimpleResponse	deleteConversation(String conversationId, String user)	删除会话
SimpleResponse	feedbackMessage(String messageId, String rating, String user, String content)	消息反馈（点赞）
AnnotationReply	getAnnotationReply(String action, String jobId)	查询标注回复初始设置任务状态
AnnotationListResponse	getAnnotations(Integer page, Integer limit)	获取标注列表
AppMetaResponse	getAppMeta()	获取应用元数据
ConversationListResponse	getConversations(String user, String lastId, Integer limit, String sortBy)	获取会话列表
VariableResponse	getConversationVariables(String conversationId, String user, String lastId, Integer limit, String variableName)	获取对话变量 从特定对话中检索变量。
MessageListResponse	getMessages(String conversationId, String user, String firstId, Integer limit)	获取会话历史消息
SuggestedQuestionsResponse	getSuggestedQuestions(String messageId, String user)	获取下一轮建议问题列表
WorkflowLogsResponse	getWorkflowLogs(String keyword, String status, Integer page, Integer limit)	获取工作流日志
WorkflowRunStatusResponse	getWorkflowRun(String workflowRunId)	获取工作流运行状态
Conversation	renameConversation(String conversationId, String name, Boolean autoGenerate, String user)	会话重命名
WorkflowRunResponse	runWorkflow(WorkflowRunRequest request)	执行工作流（阻塞模式）
void	runWorkflowStream(WorkflowRunRequest request, WorkflowStreamCallback callback)	执行工作流（流式模式）
Annotation	saveAnnotation(String question, String answer)	创建标注
ChatMessageResponse	sendChatMessage(ChatMessage message)	发送对话消息（阻塞模式）
void	sendChatMessageStream(ChatMessage message, ChatflowStreamCallback callback)	发送对话消息（流式模式，支持工作流） 注：Agent模式下不允许blocking
void	sendChatMessageStream(ChatMessage message, ChatStreamCallback callback)	发送对话消息（流式模式） 注：Agent模式下不允许blocking
CompletionResponse	sendCompletionMessage(CompletionRequest request)	发送文本生成请求（阻塞模式）
void	sendCompletionMessageStream(CompletionRequest request, CompletionStreamCallback callback)	发送文本生成请求（流式模式）
SimpleResponse	stopChatMessage(String taskId, String user)	停止对话消息
SimpleResponse	stopCompletion(String taskId, String user)	停止文本生成
WorkflowStopResponse	stopWorkflow(String taskId, String user)	停止工作流
byte[]	textToAudio(String messageId, String text, String user)	文字转语音
Annotation	updateAnnotation(String annotationId, String question, String answer)	更新标注

从类继承的方法 io.github.imfangs.dify.client.impl.DifyBaseClientImpl

close, getAppInfo, getAppParameters, getAppWebAppSettings, previewFile, previewFile, uploadFile, uploadFile, uploadFile

从类继承的方法 io.github.imfangs.dify.client.impl.AbstractDifyClient

addIfNotEmpty, addIfNotNull, buildUrlWithMultiValueParams, buildUrlWithParams, createApiException, createDeleteRequest, createGetRequest, createJsonRequestBody, createPatchRequest, createPostRequest, createPutRequest, executeDelete, executeGet, executePatch, executePost, executePut, executeRequest, executeRequestForBytes, handleResponse

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.github.imfangs.dify.client.DifyBaseClient

close, getAppInfo, getAppParameters, getAppWebAppSettings, previewFile, previewFile, uploadFile, uploadFile, uploadFile

构造器详细资料

DefaultDifyClient

public DefaultDifyClient(String baseUrl,
 String apiKey)

构造函数

参数:

baseUrl - API基础URL

apiKey - API密钥

DefaultDifyClient

public DefaultDifyClient(String baseUrl,
 String apiKey,
 okhttp3.OkHttpClient httpClient)

构造函数

参数:

baseUrl - API基础URL

apiKey - API密钥

httpClient - HTTP客户端

方法详细资料

sendChatMessage

public ChatMessageResponse sendChatMessage(ChatMessage message)
                                    throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

发送对话消息（阻塞模式）

指定者:

sendChatMessage 在接口中 DifyChatClient

参数:

message - 消息

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

sendChatMessageStream

public void sendChatMessageStream(ChatMessage message,
 ChatStreamCallback callback)
                           throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

发送对话消息（流式模式） 注：Agent模式下不允许blocking

指定者:

sendChatMessageStream 在接口中 DifyChatClient

参数:

message - 消息

callback - 回调

抛出:

IOException - IO异常

DifyApiException - API异常

sendChatMessageStream

public void sendChatMessageStream(ChatMessage message,
 ChatflowStreamCallback callback)
                           throws IOException,
DifyApiException

从接口复制的说明: DifyChatflowClient

发送对话消息（流式模式，支持工作流） 注：Agent模式下不允许blocking

指定者:

sendChatMessageStream 在接口中 DifyChatflowClient

参数:

message - 消息

callback - 工作流编排对话回调

抛出:

IOException - IO异常

DifyApiException - API异常

stopChatMessage

public SimpleResponse stopChatMessage(String taskId,
 String user)
                               throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

停止对话消息

指定者:

stopChatMessage 在接口中 DifyChatClient

参数:

taskId - 任务 ID

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

feedbackMessage

public SimpleResponse feedbackMessage(String messageId,
 String rating,
 String user,
 String content)
                               throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

消息反馈（点赞）

指定者:

feedbackMessage 在接口中 DifyChatClient

参数:

messageId - 消息 ID

rating - 评分

user - 用户标识

content - 内容

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getSuggestedQuestions

public SuggestedQuestionsResponse getSuggestedQuestions(String messageId,
 String user)
                                                 throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

获取下一轮建议问题列表

指定者:

getSuggestedQuestions 在接口中 DifyChatClient

参数:

messageId - 消息 ID

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getMessages

public MessageListResponse getMessages(String conversationId,
 String user,
 String firstId,
 Integer limit)
                                throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

获取会话历史消息

指定者:

getMessages 在接口中 DifyChatClient

参数:

conversationId - 会话 ID

user - 用户标识

firstId - 当前页第一条聊天记录的 ID

limit - 一次请求返回多少条聊天记录

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getConversations

public ConversationListResponse getConversations(String user,
 String lastId,
 Integer limit,
 String sortBy)
                                          throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

获取会话列表

指定者:

getConversations 在接口中 DifyChatClient

参数:

user - 用户标识

lastId - 当前页最后面一条记录的 ID

limit - 一次请求返回多少条记录

sortBy - 排序字段

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

deleteConversation

public SimpleResponse deleteConversation(String conversationId,
 String user)
                                  throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

删除会话

指定者:

deleteConversation 在接口中 DifyChatClient

参数:

conversationId - 会话 ID

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

renameConversation

public Conversation renameConversation(String conversationId,
 String name,
 Boolean autoGenerate,
 String user)
                                throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

会话重命名

指定者:

renameConversation 在接口中 DifyChatClient

参数:

conversationId - 会话 ID

name - 名称

autoGenerate - 自动生成标题

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

audioToText

public AudioToTextResponse audioToText(File file,
 String user)
                                throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

语音转文字

指定者:

audioToText 在接口中 DifyChatClient

参数:

file - 文件

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

audioToText

public AudioToTextResponse audioToText(InputStream inputStream,
 String fileName,
 String user)
                                throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

语音转文字

指定者:

audioToText 在接口中 DifyChatClient

参数:

inputStream - 输入流

fileName - 文件名

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

textToAudio

public byte[] textToAudio(String messageId,
 String text,
 String user)
                   throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

文字转语音

指定者:

textToAudio 在接口中 DifyChatClient

指定者:

textToAudio 在接口中 DifyCompletionClient

参数:

messageId - 消息 ID

text - 文本

user - 用户标识

返回:

音频数据

抛出:

IOException - IO异常

DifyApiException - API异常

getAppMeta

public AppMetaResponse getAppMeta()
                           throws IOException,
DifyApiException

从接口复制的说明: DifyChatClient

获取应用元数据

指定者:

getAppMeta 在接口中 DifyChatClient

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

sendCompletionMessage

public CompletionResponse sendCompletionMessage(CompletionRequest request)
                                         throws IOException,
DifyApiException

从接口复制的说明: DifyCompletionClient

发送文本生成请求（阻塞模式）

指定者:

sendCompletionMessage 在接口中 DifyCompletionClient

参数:

request - 请求

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

sendCompletionMessageStream

public void sendCompletionMessageStream(CompletionRequest request,
 CompletionStreamCallback callback)
                                 throws IOException,
DifyApiException

从接口复制的说明: DifyCompletionClient

发送文本生成请求（流式模式）

指定者:

sendCompletionMessageStream 在接口中 DifyCompletionClient

参数:

request - 请求

callback - 回调

抛出:

IOException - IO异常

DifyApiException - API异常

stopCompletion

public SimpleResponse stopCompletion(String taskId,
 String user)
                              throws IOException,
DifyApiException

从接口复制的说明: DifyCompletionClient

停止文本生成

指定者:

stopCompletion 在接口中 DifyCompletionClient

参数:

taskId - 任务 ID

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

runWorkflow

public WorkflowRunResponse runWorkflow(WorkflowRunRequest request)
                                throws IOException,
DifyApiException

从接口复制的说明: DifyWorkflowClient

执行工作流（阻塞模式）

指定者:

runWorkflow 在接口中 DifyWorkflowClient

参数:

request - 请求

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

runWorkflowStream

public void runWorkflowStream(WorkflowRunRequest request,
 WorkflowStreamCallback callback)
                       throws IOException,
DifyApiException

从接口复制的说明: DifyWorkflowClient

执行工作流（流式模式）

指定者:

runWorkflowStream 在接口中 DifyWorkflowClient

参数:

request - 请求

callback - 回调

抛出:

IOException - IO异常

DifyApiException - API异常

stopWorkflow

public WorkflowStopResponse stopWorkflow(String taskId,
 String user)
                                  throws IOException,
DifyApiException

从接口复制的说明: DifyWorkflowClient

停止工作流

指定者:

stopWorkflow 在接口中 DifyWorkflowClient

参数:

taskId - 任务 ID

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getWorkflowRun

public WorkflowRunStatusResponse getWorkflowRun(String workflowRunId)
                                         throws IOException,
DifyApiException

获取工作流运行状态

指定者:

getWorkflowRun 在接口中 DifyWorkflowClient

参数:

workflowRunId - 工作流运行实例 ID（从工作流执行响应中获得的运行实例标识）

返回:

工作流执行状态响应

抛出:

IOException - IO异常

DifyApiException - API异常

getWorkflowLogs

public WorkflowLogsResponse getWorkflowLogs(String keyword,
 String status,
 Integer page,
 Integer limit)
                                     throws IOException,
DifyApiException

从接口复制的说明: DifyWorkflowClient

获取工作流日志

指定者:

getWorkflowLogs 在接口中 DifyWorkflowClient

参数:

keyword - 关键字

status - 状态

page - 页码

limit - 每页条数

返回:

日志列表

抛出:

IOException - IO异常

DifyApiException - API异常

getAnnotations

public AnnotationListResponse getAnnotations(Integer page,
 Integer limit)
                                      throws IOException,
DifyApiException

获取标注列表

指定者:

getAnnotations 在接口中 DifyChatClient

参数:

page - 页码

limit - 每页数量

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

saveAnnotation

public Annotation saveAnnotation(String question,
 String answer)
                          throws IOException,
DifyApiException

创建标注

指定者:

saveAnnotation 在接口中 DifyChatClient

参数:

question - 问题

answer - 答案内容

返回:

标注

抛出:

IOException - IO异常

DifyApiException - API异常

updateAnnotation

public Annotation updateAnnotation(String annotationId,
 String question,
 String answer)
                            throws IOException,
DifyApiException

更新标注

指定者:

updateAnnotation 在接口中 DifyChatClient

参数:

annotationId - 标注 ID

question - 问题

answer - 答案内容

返回:

标注

抛出:

IOException - IO异常

DifyApiException - API异常

deleteAnnotation

public SimpleResponse deleteAnnotation(String annotationId)
                                throws IOException,
DifyApiException

删除标注

指定者:

deleteAnnotation 在接口中 DifyChatClient

参数:

annotationId - 标注 ID

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

annotationReply

public AnnotationReply annotationReply(String action,
 String embeddingProviderName,
 String embeddingModelName,
 Integer scoreThreshold)
                                throws IOException,
DifyApiException

标注回复初始设置

指定者:

annotationReply 在接口中 DifyChatClient

参数:

action - 动作，只能是 'enable' 或 'disable'

embeddingProviderName - 指定的嵌入模型提供商, 必须先在系统内设定好接入的模型，对应的是provider字段

embeddingModelName - 指定的嵌入模型，对应的是model字段

scoreThreshold - 相似度阈值，当相似度大于该阈值时，系统会自动回复，否则不回复

返回:

标注回复

抛出:

IOException - IO异常

DifyApiException - API异常

getAnnotationReply

public AnnotationReply getAnnotationReply(String action,
 String jobId)
                                   throws IOException,
DifyApiException

查询标注回复初始设置任务状态

指定者:

getAnnotationReply 在接口中 DifyChatClient

参数:

action - 动作，只能是 'enable' 或 'disable'，并且必须和标注回复初始设置接口的动作一致

jobId - 任务 ID，从标注回复初始设置接口返回的 jobId

返回:

标注回复

抛出:

IOException - IO异常

DifyApiException - API异常

getConversationVariables

public VariableResponse getConversationVariables(String conversationId,
 String user,
 String lastId,
 Integer limit,
 String variableName)
                                          throws DifyApiException,
IOException

获取对话变量 从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。

指定者:

getConversationVariables 在接口中 DifyChatClient

参数:

conversationId - 会话 ID

user - 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。重要说明: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。

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

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

variableName - （选填）按变量名称筛选。

返回:

抛出:

DifyApiException

IOException