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

接口 DifyWorkflowApiService

public interface DifyWorkflowApiService

方法概要

修饰符和类型	方法	说明
retrofit2.Call<WorkflowLogListResponse>	getWorkflowLogs(String keyword, String status, Integer page, Integer limit)	获取workflow日志
retrofit2.Call<WorkflowRunStatusResponse>	getWorkflowRunStatus(String workflowRunId)	获取workflow执行情况
retrofit2.Call<WorkflowRunResponse>	runWorkflow(WorkflowRunRequest request)
retrofit2.Call<okhttp3.ResponseBody>	runWorkflowStream(WorkflowRunRequest request)
retrofit2.Call<WorkflowStopResponse>	stopWorkflow(String taskId, SimpleUserRequest request)	停止workflow执行

方法详细资料

runWorkflow

@POST("workflows/run")
retrofit2.Call<WorkflowRunResponse> runWorkflow(@Body
 WorkflowRunRequest request)

runWorkflowStream

@POST("workflows/run")
@Streaming
retrofit2.Call<okhttp3.ResponseBody> runWorkflowStream(@Body
 WorkflowRunRequest request)

getWorkflowRunStatus

@GET("workflows/run/{workflow_run_id}")
retrofit2.Call<WorkflowRunStatusResponse> getWorkflowRunStatus(@Path("workflow_run_id")
 String workflowRunId)

获取workflow执行情况

参数:

workflowRunId - workflow执行ID

返回:

workflow执行状态响应

stopWorkflow

@POST("workflows/tasks/{task_id}/stop")
retrofit2.Call<WorkflowStopResponse> stopWorkflow(@Path("task_id")
 String taskId,
 @Body
 SimpleUserRequest request)

停止workflow执行

参数:

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

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

返回:

停止操作响应

getWorkflowLogs

@GET("workflows/logs")
retrofit2.Call<WorkflowLogListResponse> getWorkflowLogs(@Query("keyword")
 String keyword,
 @Query("status")
 String status,
 @Query("page")
 Integer page,
 @Query("limit")
 Integer limit)

获取workflow日志

参数:

keyword - （可选）关键字

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

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

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

返回:

workflow日志列表响应