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

接口 DifyWorkflowClient

所有超级接口:

AutoCloseable, DifyBaseClient

所有已知子接口:

DifyClient

所有已知实现类:

DefaultDifyClient

public interface DifyWorkflowClient
extends DifyBaseClient

Dify Workflow应用客户端接口 包含Workflow应用相关的功能

方法概要

修饰符和类型	方法	说明
WorkflowLogsResponse	getWorkflowLogs(String keyword, String status, Integer page, Integer limit)	获取工作流日志
WorkflowRunStatusResponse	getWorkflowRun(String workflowRunId)	获取工作流运行状态
WorkflowRunResponse	runWorkflow(WorkflowRunRequest request)	执行工作流（阻塞模式）
void	runWorkflowStream(WorkflowRunRequest request, WorkflowStreamCallback callback)	执行工作流（流式模式）
WorkflowStopResponse	stopWorkflow(String taskId, String user)	停止工作流

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

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

方法详细资料

runWorkflow

WorkflowRunResponse runWorkflow(WorkflowRunRequest request)
                         throws IOException,
DifyApiException

执行工作流（阻塞模式）

参数:

request - 请求

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

runWorkflowStream

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

执行工作流（流式模式）

参数:

request - 请求

callback - 回调

抛出:

IOException - IO异常

DifyApiException - API异常

stopWorkflow

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

停止工作流

参数:

taskId - 任务 ID

user - 用户标识

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getWorkflowRun

WorkflowRunStatusResponse getWorkflowRun(String workflowRunId)
                                  throws IOException,
DifyApiException

获取工作流运行状态

参数:

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

返回:

工作流执行状态响应

抛出:

IOException - IO异常

DifyApiException - API异常

getWorkflowLogs

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

获取工作流日志

参数:

keyword - 关键字

status - 状态

page - 页码

limit - 每页条数

返回:

日志列表

抛出:

IOException - IO异常

DifyApiException - API异常