com.dify.client

接口 IDifyClient

所有已知子接口:

IDifyChatClient, IDifyWorkFlowClient

所有已知实现类:

DifyBaseClientImpl, DifyChatClientImpl, DifyDatasetClientImpl, DifyWorkFlowClientImpl

public interface IDifyClient

基础Dify客户端

方法概要

限定符和类型	方法和说明
String	getAppInfo() 获取应用基础信息
String	getAppMetaInfo() 获取应用元数据
String	getAppParameters() 获取应用参数信息
String	requestJson(DifyRoute route) request by application/json content-type
String	requestJson(DifyRoute route, List<PathVariables> pathVariables) request by application/json content-type
String	requestJson(DifyRoute route, List<PathVariables> pathVariables, Map<String,Object> query) request by application/json content-type
String	requestJson(DifyRoute route, List<PathVariables> pathVariables, Map<String,Object> query, Object params) request by application/json content-type
String	requestJson(DifyRoute route, Map<String,Object> query) request by application/json content-type
String	requestJson(DifyRoute route, Map<String,Object> query, Object params) request by application/json content-type
String	requestJson(String url, HttpMethod method, List<PathVariables> pathVariables, Map<String,Object> query, Object params) request by application/json content-type
String	requestJson(String url, HttpMethod method, Map<String,Object> query, Object params) request by application/json content-type
String	requestMultipart(DifyRoute route, List<PathVariables> pathVariables, Map<String,Object> query, Map<String,Object> params) request by multipart/form-data content-type
String	requestMultipart(DifyRoute route, Map<String,Object> query, Map<String,Object> params) request by multipart/form-data content-type
String	requestMultipart(String url, HttpMethod method, List<PathVariables> pathVariables, Map<String,Object> query, Map<String,Object> params) request by multipart/form-data content-type
String	sendBlocking(DifyRoute route, Map<String,Object> params) 发送同步接口请求
String	sendBlocking(DifyRoute route, Map<String,Object> query, Map<String,Object> params) 发送同步接口请求
CompletableFuture<Void>	sendStreaming(DifyRoute route, List<PathVariables> pathVariables, Map<String,Object> query, Map<String,Object> params, Consumer<String> consumer) 发送流式接口请求
CompletableFuture<Void>	sendStreaming(DifyRoute route, Map<String,Object> params, Consumer<String> consumer) 发送流式接口请求
CompletableFuture<Void>	sendStreaming(DifyRoute route, Map<String,Object> query, Map<String,Object> params, Consumer<String> consumer) 发送流式接口请求
DifyFileResult	uploadFile(File file, String user) 上传文件

方法详细资料

getAppInfo

String getAppInfo()
           throws IOException,
                  InterruptedException

获取应用基础信息

返回:

String

抛出:

IOException - 错误

InterruptedException

getAppParameters

String getAppParameters()
                 throws IOException,
                        InterruptedException

获取应用参数信息

返回:

String

抛出:

IOException - 错误

InterruptedException

getAppMetaInfo

String getAppMetaInfo()
               throws IOException,
                      InterruptedException

获取应用元数据

返回:

String

抛出:

IOException - 错误

InterruptedException

uploadFile

DifyFileResult uploadFile(File file,
                          String user)
                   throws DifyException,
                          IOException,
                          InterruptedException

上传文件

参数:

file - 文件对象

user - 用户标识

返回:

DifyFileResult

抛出:

DifyException - 错误

IOException

InterruptedException

sendBlocking

String sendBlocking(DifyRoute route,
                    Map<String,Object> params)
             throws DifyException,
                    IOException,
                    InterruptedException

发送同步接口请求

参数:

route - DifyRoute

params - Body params

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

sendBlocking

String sendBlocking(DifyRoute route,
                    Map<String,Object> query,
                    Map<String,Object> params)
             throws DifyException,
                    IOException,
                    InterruptedException

发送同步接口请求

参数:

route - DifyRoute

query - Query params

params - Body params

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

sendStreaming

CompletableFuture<Void> sendStreaming(DifyRoute route,
                                      Map<String,Object> params,
                                      Consumer<String> consumer)

发送流式接口请求

参数:

route - DifyRoute

params - Body params

返回:

CompletableFuture

sendStreaming

CompletableFuture<Void> sendStreaming(DifyRoute route,
                                      List<PathVariables> pathVariables,
                                      Map<String,Object> query,
                                      Map<String,Object> params,
                                      Consumer<String> consumer)

发送流式接口请求

参数:

route - DifyRoute

query - Query params

params - Body params

返回:

CompletableFuture

sendStreaming

CompletableFuture<Void> sendStreaming(DifyRoute route,
                                      Map<String,Object> query,
                                      Map<String,Object> params,
                                      Consumer<String> consumer)

发送流式接口请求

参数:

route - DifyRoute

query - Query params

params - Body params

返回:

CompletableFuture

requestJson

String requestJson(DifyRoute route)
            throws DifyException,
                   IOException,
                   InterruptedException

request by application/json content-type

参数:

route - DifyRoute

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestJson

String requestJson(DifyRoute route,
                   Map<String,Object> query)
            throws DifyException,
                   IOException,
                   InterruptedException

request by application/json content-type

参数:

route - DifyRoute

query - Query 查询参数

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestJson

String requestJson(DifyRoute route,
                   Map<String,Object> query,
                   Object params)
            throws DifyException,
                   IOException,
                   InterruptedException

request by application/json content-type

参数:

route - DifyRoute

query - Query 查询参数

params - Body 参数

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestJson

String requestJson(DifyRoute route,
                   List<PathVariables> pathVariables)
            throws DifyException,
                   IOException,
                   InterruptedException

request by application/json content-type

参数:

route - DifyRoute

pathVariables - 路径参数

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestJson

String requestJson(DifyRoute route,
                   List<PathVariables> pathVariables,
                   Map<String,Object> query)
            throws DifyException,
                   IOException,
                   InterruptedException

request by application/json content-type

参数:

route - DifyRoute

pathVariables - 路径参数

query - Query 查询参数

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestJson

String requestJson(DifyRoute route,
                   List<PathVariables> pathVariables,
                   Map<String,Object> query,
                   Object params)
            throws DifyException,
                   IOException,
                   InterruptedException

request by application/json content-type

参数:

route - DifyRoute

query - Query 查询参数

params - Body 参数

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestJson

String requestJson(String url,
                   HttpMethod method,
                   Map<String,Object> query,
                   Object params)
            throws DifyException,
                   IOException,
                   InterruptedException

request by application/json content-type

参数:

url - API URL

method - HTTP请求方法

query - Query 查询参数

params - Body 参数

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestJson

String requestJson(String url,
                   HttpMethod method,
                   List<PathVariables> pathVariables,
                   Map<String,Object> query,
                   Object params)
            throws DifyException,
                   IOException,
                   InterruptedException

request by application/json content-type

参数:

url - API URL

method - HTTP请求方法

query - Query 查询参数

params - Body 参数

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestMultipart

String requestMultipart(DifyRoute route,
                        Map<String,Object> query,
                        Map<String,Object> params)
                 throws DifyException,
                        IOException,
                        InterruptedException

request by multipart/form-data content-type

参数:

route - DifyRoute

query - Query 查询参数

params - Body 参数，文件流需自行在params中传入

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestMultipart

String requestMultipart(DifyRoute route,
                        List<PathVariables> pathVariables,
                        Map<String,Object> query,
                        Map<String,Object> params)
                 throws DifyException,
                        IOException,
                        InterruptedException

request by multipart/form-data content-type

参数:

route - DifyRoute

query - Query 查询参数

params - Body 参数，文件流需自行在params中传入

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException

requestMultipart

String requestMultipart(String url,
                        HttpMethod method,
                        List<PathVariables> pathVariables,
                        Map<String,Object> query,
                        Map<String,Object> params)
                 throws DifyException,
                        IOException,
                        InterruptedException

request by multipart/form-data content-type

参数:

url - API URL

method - HTTP请求方法

query - Query 查询参数

params - Body 参数，文件流需自行在params中传入

返回:

String

抛出:

DifyException - 错误

IOException

InterruptedException