com.dify.client

接口 IDifyWorkFlowClient

所有超级接口:

IDifyClient

所有已知实现类:

DifyWorkFlowClientImpl

public interface IDifyWorkFlowClient
extends IDifyClient

适用于工作流应用的客户端 workflow

方法概要

限定符和类型	方法和说明
com.alibaba.fastjson.JSONObject	getWorkFlowLog(String keyword, WorkflowStatus status, Integer page, Integer limit) 获取工作流日志
com.alibaba.fastjson.JSONObject	getWorkFlowStatus(String workFlowId) 获取工作流执行情况
com.alibaba.fastjson.JSONObject	runBlocking(ParamMessage message) 执行工作流（阻塞模式）
CompletableFuture<Void>	runStreaming(ParamMessage message, Consumer<DifyWorkFlowResult> consumer) 执行工作流（流式模式）
Boolean	stopWorkFlow(String taskId, 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

方法详细资料

runStreaming

CompletableFuture<Void> runStreaming(ParamMessage message,
                                     Consumer<DifyWorkFlowResult> consumer)

执行工作流（流式模式）

参数:

message - ParamMessage

consumer - Consumer

runBlocking

com.alibaba.fastjson.JSONObject runBlocking(ParamMessage message)

执行工作流（阻塞模式）

参数:

message - ParamMessage

返回:

JSONObject

getWorkFlowStatus

com.alibaba.fastjson.JSONObject getWorkFlowStatus(String workFlowId)

获取工作流执行情况

参数:

workFlowId - 工作流ID

返回:

JSONObject

stopWorkFlow

Boolean stopWorkFlow(String taskId,
                     String user)

停止工作流（仅限流式模式）

参数:

taskId - 任务ID（流式返回chunk中获取）

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

返回:

Boolean

getWorkFlowLog

com.alibaba.fastjson.JSONObject getWorkFlowLog(String keyword,
                                               WorkflowStatus status,
                                               Integer page,
                                               Integer limit)

获取工作流日志

参数:

keyword - 关键字

status - 执行状态（succeeded/failed/stopped)

page - 页码

limit - 每页数量

返回:

JSONObject