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

类 DifyBaseClientImpl

java.lang.Object

io.github.imfangs.dify.client.impl.AbstractDifyClient

io.github.imfangs.dify.client.impl.DifyBaseClientImpl

所有已实现的接口:

DifyBaseClient, AutoCloseable

直接已知子类:

DefaultDifyClient

public class DifyBaseClientImpl
extends AbstractDifyClient
implements DifyBaseClient

Dify 基础客户端实现类

字段概要

从类继承的字段 io.github.imfangs.dify.client.impl.AbstractDifyClient

apiKey, AUDIO, baseUrl, httpClient, JSON, OCTET_STREAM

构造器概要

构造器

构造器	说明
DifyBaseClientImpl(String baseUrl, String apiKey)	构造函数
DifyBaseClientImpl(String baseUrl, String apiKey, okhttp3.OkHttpClient httpClient)	构造函数

方法概要

修饰符和类型	方法	说明
void	close()	关闭客户端资源 重写AutoCloseable.close()方法，确保不抛出受检异常
AppInfoResponse	getAppInfo()	获取应用基本信息
AppParametersResponse	getAppParameters()	获取应用参数
AppWebAppSettingResponse	getAppWebAppSettings()	获取应用 WebApp 设置
FilePreviewResponse	previewFile(String fileId)	预览文件 预览或下载已上传的文件。
FilePreviewResponse	previewFile(String fileId, boolean asAttachment)	预览或下载文件 预览或下载已上传的文件。
FileUploadResponse	uploadFile(FileUploadRequest request, File file)	上传文件
FileUploadResponse	uploadFile(FileUploadRequest request, InputStream inputStream, String fileName)	上传文件
FileUploadResponse	uploadFile(File file, String user)	上传文件

从类继承的方法 io.github.imfangs.dify.client.impl.AbstractDifyClient

addIfNotEmpty, addIfNotNull, buildUrlWithMultiValueParams, buildUrlWithParams, createApiException, createDeleteRequest, createGetRequest, createJsonRequestBody, createPatchRequest, createPostRequest, createPutRequest, executeDelete, executeGet, executePatch, executePost, executePut, executeRequest, executeRequestForBytes, handleResponse

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

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

构造器详细资料

DifyBaseClientImpl

public DifyBaseClientImpl(String baseUrl,
 String apiKey)

构造函数

参数:

baseUrl - API基础URL

apiKey - API密钥

DifyBaseClientImpl

public DifyBaseClientImpl(String baseUrl,
 String apiKey,
 okhttp3.OkHttpClient httpClient)

构造函数

参数:

baseUrl - API基础URL

apiKey - API密钥

httpClient - HTTP客户端

方法详细资料

uploadFile

public FileUploadResponse uploadFile(File file,
 String user)
                              throws IOException,
DifyApiException

从接口复制的说明: DifyBaseClient

上传文件

指定者:

uploadFile 在接口中 DifyBaseClient

参数:

file - 文件

user - 用户标识

返回:

上传响应

抛出:

IOException - IO异常

DifyApiException - API异常

uploadFile

public FileUploadResponse uploadFile(FileUploadRequest request,
 File file)
                              throws IOException,
DifyApiException

从接口复制的说明: DifyBaseClient

上传文件

指定者:

uploadFile 在接口中 DifyBaseClient

参数:

request - 请求

file - 文件

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

uploadFile

public FileUploadResponse uploadFile(FileUploadRequest request,
 InputStream inputStream,
 String fileName)
                              throws IOException,
DifyApiException

从接口复制的说明: DifyBaseClient

上传文件

指定者:

uploadFile 在接口中 DifyBaseClient

参数:

request - 请求

inputStream - 输入流

fileName - 文件名

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getAppInfo

public AppInfoResponse getAppInfo()
                           throws IOException,
DifyApiException

从接口复制的说明: DifyBaseClient

获取应用基本信息

指定者:

getAppInfo 在接口中 DifyBaseClient

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getAppParameters

public AppParametersResponse getAppParameters()
                                       throws IOException,
DifyApiException

从接口复制的说明: DifyBaseClient

获取应用参数

指定者:

getAppParameters 在接口中 DifyBaseClient

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getAppWebAppSettings

public AppWebAppSettingResponse getAppWebAppSettings()
                                              throws IOException,
DifyApiException

从接口复制的说明: DifyBaseClient

获取应用 WebApp 设置

指定者:

getAppWebAppSettings 在接口中 DifyBaseClient

返回:

io.github.imfangs.dify.client.model.chat.AppWebAppSettingResponse

抛出:

IOException - IO异常

DifyApiException - API异常

previewFile

public FilePreviewResponse previewFile(String fileId)
                                throws IOException,
DifyApiException

从接口复制的说明: DifyBaseClient

预览文件 预览或下载已上传的文件。文件只能在属于请求应用程序的消息范围内访问。

指定者:

previewFile 在接口中 DifyBaseClient

参数:

fileId - 文件ID，从文件上传 API 响应中获得的唯一标识符

返回:

文件预览响应

抛出:

IOException - IO异常

DifyApiException - API异常

previewFile

public FilePreviewResponse previewFile(String fileId,
 boolean asAttachment)
                                throws IOException,
DifyApiException

从接口复制的说明: DifyBaseClient

预览或下载文件 预览或下载已上传的文件。文件只能在属于请求应用程序的消息范围内访问。

指定者:

previewFile 在接口中 DifyBaseClient

参数:

fileId - 文件ID，从文件上传 API 响应中获得的唯一标识符

asAttachment - 是否强制将文件作为附件下载，默认为 false（在浏览器中预览）

返回:

文件预览响应

抛出:

IOException - IO异常

DifyApiException - API异常

close

public void close()

从接口复制的说明: DifyBaseClient

关闭客户端资源 重写AutoCloseable.close()方法，确保不抛出受检异常

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 DifyBaseClient