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

接口 DifyBaseClient

所有超级接口:

AutoCloseable

所有已知子接口:

DifyChatClient, DifyChatflowClient, DifyClient, DifyCompletionClient, DifyWorkflowClient

所有已知实现类:

DefaultDifyClient, DifyBaseClientImpl

public interface DifyBaseClient
extends AutoCloseable

Dify 基础客户端接口 包含所有客户端共用的基础功能

方法概要

修饰符和类型	方法	说明
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)	上传文件

方法详细资料

uploadFile

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

上传文件

参数:

file - 文件

user - 用户标识

返回:

上传响应

抛出:

IOException - IO异常

DifyApiException - API异常

uploadFile

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

上传文件

参数:

request - 请求

file - 文件

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

uploadFile

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

上传文件

参数:

request - 请求

inputStream - 输入流

fileName - 文件名

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getAppInfo

AppInfoResponse getAppInfo()
                    throws IOException,
DifyApiException

获取应用基本信息

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getAppParameters

AppParametersResponse getAppParameters()
                                throws IOException,
DifyApiException

获取应用参数

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getAppWebAppSettings

AppWebAppSettingResponse getAppWebAppSettings()
                                       throws IOException,
DifyApiException

获取应用 WebApp 设置

返回:

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

抛出:

IOException - IO异常

DifyApiException - API异常

previewFile

FilePreviewResponse previewFile(String fileId)
                         throws IOException,
DifyApiException

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

参数:

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

返回:

文件预览响应

抛出:

IOException - IO异常

DifyApiException - API异常

previewFile

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

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

参数:

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

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

返回:

文件预览响应

抛出:

IOException - IO异常

DifyApiException - API异常

close

void close()

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

指定者:

close 在接口中 AutoCloseable