程序包 io.github.chatpass.dify.api

类 DifyWorkflowApi

java.lang.Object

io.github.chatpass.dify.api.BaseApi

io.github.chatpass.dify.api.DifyWorkflowApi

public class DifyWorkflowApi
extends BaseApi

字段概要

从类继承的字段 io.github.chatpass.dify.api.BaseApi

apiKey, baseUrl, config

构造器概要

构造器

构造器	说明
DifyWorkflowApi(String baseUrl, String apiKey)

方法概要

修饰符和类型	方法	说明
WorkflowLogListResponse	getWorkflowLogs(String keyword, String status, Integer page, Integer limit)	获取workflow日志
WorkflowRunStatusResponse	getWorkflowRunStatus(String workflowRunId)	获取workflow执行状态
WorkflowRunResponse	runWorkflow(WorkflowRunRequest request)
void	runWorkflowStream(WorkflowRunRequest request, WorkflowStreamCallback callback)
WorkflowStopResponse	stopWorkflow(String taskId, SimpleUserRequest request)	停止workflow执行

从类继承的方法 io.github.chatpass.dify.api.BaseApi

createService

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

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

构造器详细资料

DifyWorkflowApi

public DifyWorkflowApi(String baseUrl,
 String apiKey)

方法详细资料

runWorkflow

public WorkflowRunResponse runWorkflow(WorkflowRunRequest request)

runWorkflowStream

public void runWorkflowStream(WorkflowRunRequest request,
 WorkflowStreamCallback callback)

getWorkflowRunStatus

public WorkflowRunStatusResponse getWorkflowRunStatus(String workflowRunId)

获取workflow执行状态

参数:

workflowRunId - workflow执行ID

返回:

workflow执行状态响应

stopWorkflow

public WorkflowStopResponse stopWorkflow(String taskId,
 SimpleUserRequest request)

停止workflow执行

参数:

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

request - 包含用户标识的请求体，必须和执行workflow接口传入的user保持一致

返回:

停止操作响应

getWorkflowLogs

public WorkflowLogListResponse getWorkflowLogs(String keyword,
 String status,
 Integer page,
 Integer limit)

获取workflow日志

参数:

keyword - （可选）关键字

status - （可选）执行状态：succeeded, failed, stopped, running

page - （可选）当前页码，默认1

limit - （可选）每页条数，默认20

返回:

workflow日志列表响应