类的使用
io.github.imfangs.dify.client.exception.DifyApiException

使用DifyApiException的程序包

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

io.github.imfangs.dify.client中DifyApiException的使用

抛出DifyApiException的io.github.imfangs.dify.client中的方法

修饰符和类型	方法	说明
AnnotationReply	DifyChatClient.annotationReply(String action, String embeddingProviderName, String embeddingModelName, Integer scoreThreshold)	标注回复初始设置
AudioToTextResponse	DifyChatClient.audioToText(File file, String user)	语音转文字
AudioToTextResponse	DifyChatClient.audioToText(InputStream inputStream, String fileName, String user)	语音转文字
SimpleResponse	DifyDatasetsClient.bindTags(TagBindRequest request)	绑定知识库到知识库类型标签
String	DifyDatasetsClient.builtInMetadata(String datasetId, String action)	启用/禁用内置元数据
ChildChunkResponse	DifyDatasetsClient.createChildChunk(String datasetId, String documentId, String segmentId, SaveChildChunkRequest request)	创建子分段
DatasetResponse	DifyDatasetsClient.createDataset(CreateDatasetRequest request)	创建空知识库
DocumentResponse	DifyDatasetsClient.createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, File file)	通过文件创建文档
DocumentResponse	DifyDatasetsClient.createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, InputStream inputStream, String fileName)	通过文件创建文档
DocumentResponse	DifyDatasetsClient.createDocumentByText(String datasetId, CreateDocumentByTextRequest request)	通过文本创建文档
MetadataResponse	DifyDatasetsClient.createMetadata(String datasetId, CreateMetadataRequest request)	新增元数据
SegmentListResponse	DifyDatasetsClient.createSegments(String datasetId, String documentId, CreateSegmentsRequest request)	新增文档分段
TagResponse	DifyDatasetsClient.createTag(CreateTagRequest request)	新增知识库类型标签
SimpleResponse	DifyChatClient.deleteAnnotation(String annotationId)	删除标注
void	DifyDatasetsClient.deleteChildChunks(String datasetId, String documentId, String segmentId, String childChunkId)	删除子分段
SimpleResponse	DifyChatClient.deleteConversation(String conversationId, String user)	删除会话
SimpleResponse	DifyDatasetsClient.deleteDataset(String datasetId)	删除知识库
void	DifyDatasetsClient.deleteDocument(String datasetId, String documentId)	删除文档
String	DifyDatasetsClient.deleteMetadata(String datasetId, String metadataId)	删除元数据
void	DifyDatasetsClient.deleteSegment(String datasetId, String documentId, String segmentId)	删除文档分段
SimpleResponse	DifyDatasetsClient.deleteTag(DeleteTagRequest request)	删除知识库类型标签
SimpleResponse	DifyChatClient.feedbackMessage(String messageId, String rating, String user, String content)	消息反馈（点赞）
AnnotationReply	DifyChatClient.getAnnotationReply(String action, String jobId)	查询标注回复初始设置任务状态
AnnotationListResponse	DifyChatClient.getAnnotations(Integer page, Integer limit)	获取标注列表
AppInfoResponse	DifyBaseClient.getAppInfo()	获取应用基本信息
AppMetaResponse	DifyChatClient.getAppMeta()	获取应用元数据
AppParametersResponse	DifyBaseClient.getAppParameters()	获取应用参数
AppWebAppSettingResponse	DifyBaseClient.getAppWebAppSettings()	获取应用 WebApp 设置
ChildChunkListResponse	DifyDatasetsClient.getChildChunks(String datasetId, String documentId, String segmentId, String keyword, Integer page, Integer limit)	获取子分段
ConversationListResponse	DifyChatClient.getConversations(String user, String lastId, Integer limit, String sortBy)	获取会话列表
VariableResponse	DifyChatClient.getConversationVariables(String conversationId, String user, String lastId, Integer limit, String variableName)	获取对话变量 从特定对话中检索变量。
DatasetResponse	DifyDatasetsClient.getDataset(String datasetId)	获取知识库详情
DatasetListResponse	DifyDatasetsClient.getDatasets(Integer page, Integer limit)	获取知识库列表
DatasetListResponse	DifyDatasetsClient.getDatasets(String keyword, Integer page, Integer limit)	根据关键词搜索知识库列表
DatasetListResponse	DifyDatasetsClient.getDatasets(String keyword, List<String> tagIds, Integer page, Integer limit, Boolean includeAll)	获取知识库列表（支持高级查询参数）
DatasetListResponse	DifyDatasetsClient.getDatasetsByTags(List<String> tagIds, Integer page, Integer limit)	根据标签ID列表获取知识库列表
TagListResponse	DifyDatasetsClient.getDatasetTags(String datasetId)	查询知识库已绑定的标签
DocMetadataListResponse	DifyDatasetsClient.getDocMetadataList(String datasetId)	查询知识库元数据列表
DetailedDocumentResponse	DifyDatasetsClient.getDocumentDetail(String datasetId, String documentId, String metadata)	获取文档详情
DocumentListResponse	DifyDatasetsClient.getDocuments(String datasetId, String keyword, Integer page, Integer limit)	获取知识库文档列表
EmbeddingModelListResponse	DifyDatasetsClient.getEmbeddingModelList()	获取嵌入模型列表
IndexingStatusResponse	DifyDatasetsClient.getIndexingStatus(String datasetId, String batch)	获取文档嵌入状态
MessageListResponse	DifyChatClient.getMessages(String conversationId, String user, String firstId, Integer limit)	获取会话历史消息
SegmentResponse	DifyDatasetsClient.getSegment(String datasetId, String documentId, String segmentId)	查看文档分段详情
SegmentListResponse	DifyDatasetsClient.getSegments(String datasetId, String documentId, String keyword, String status)	查询文档分段
SegmentListResponse	DifyDatasetsClient.getSegments(String datasetId, String documentId, String keyword, String status, Integer page, Integer limit)	查询文档分段
SuggestedQuestionsResponse	DifyChatClient.getSuggestedQuestions(String messageId, String user)	获取下一轮建议问题列表
List<TagResponse>	DifyDatasetsClient.getTags()	获取知识库类型标签列表
UploadFileResponse	DifyDatasetsClient.getUploadFile(String datasetId, String documentId)	获取上传文件
WorkflowLogsResponse	DifyWorkflowClient.getWorkflowLogs(String keyword, String status, Integer page, Integer limit)	获取工作流日志
WorkflowRunStatusResponse	DifyWorkflowClient.getWorkflowRun(String workflowRunId)	获取工作流运行状态
FilePreviewResponse	DifyBaseClient.previewFile(String fileId)	预览文件 预览或下载已上传的文件。
FilePreviewResponse	DifyBaseClient.previewFile(String fileId, boolean asAttachment)	预览或下载文件 预览或下载已上传的文件。
Conversation	DifyChatClient.renameConversation(String conversationId, String name, Boolean autoGenerate, String user)	会话重命名
RetrieveResponse	DifyDatasetsClient.retrieveDataset(String datasetId, RetrieveRequest request)	检索知识库
WorkflowRunResponse	DifyWorkflowClient.runWorkflow(WorkflowRunRequest request)	执行工作流（阻塞模式）
void	DifyWorkflowClient.runWorkflowStream(WorkflowRunRequest request, WorkflowStreamCallback callback)	执行工作流（流式模式）
Annotation	DifyChatClient.saveAnnotation(String question, String answer)	创建标注
ChatMessageResponse	DifyChatClient.sendChatMessage(ChatMessage message)	发送对话消息（阻塞模式）
void	DifyChatClient.sendChatMessageStream(ChatMessage message, ChatStreamCallback callback)	发送对话消息（流式模式） 注：Agent模式下不允许blocking
void	DifyChatflowClient.sendChatMessageStream(ChatMessage message, ChatflowStreamCallback callback)	发送对话消息（流式模式，支持工作流） 注：Agent模式下不允许blocking
CompletionResponse	DifyCompletionClient.sendCompletionMessage(CompletionRequest request)	发送文本生成请求（阻塞模式）
void	DifyCompletionClient.sendCompletionMessageStream(CompletionRequest request, CompletionStreamCallback callback)	发送文本生成请求（流式模式）
SimpleResponse	DifyChatClient.stopChatMessage(String taskId, String user)	停止对话消息
SimpleResponse	DifyCompletionClient.stopCompletion(String taskId, String user)	停止文本生成
WorkflowStopResponse	DifyWorkflowClient.stopWorkflow(String taskId, String user)	停止工作流
byte[]	DifyChatClient.textToAudio(String messageId, String text, String user)	文字转语音
byte[]	DifyCompletionClient.textToAudio(String messageId, String text, String user)	文字转语音
SimpleResponse	DifyDatasetsClient.unbindTag(TagUnbindRequest request)	解绑知识库和知识库类型标签
Annotation	DifyChatClient.updateAnnotation(String annotationId, String question, String answer)	更新标注
ChildChunkResponse	DifyDatasetsClient.updateChildChunk(String datasetId, String documentId, String segmentId, String childChunkId, SaveChildChunkRequest request)	更新子分段
DatasetResponse	DifyDatasetsClient.updateDataset(String datasetId, UpdateDatasetRequest request)	更新知识库
DocumentResponse	DifyDatasetsClient.updateDocumentByFile(String datasetId, String documentId, UpdateDocumentByFileRequest request, File file)	通过文件更新文档
DocumentResponse	DifyDatasetsClient.updateDocumentByText(String datasetId, String documentId, UpdateDocumentByTextRequest request)	通过文本更新文档
SimpleResponse	DifyDatasetsClient.updateDocumentMetadata(String datasetId, List<OperationData> operationDataList)	更新文档元数据
SimpleResponse	DifyDatasetsClient.updateDocumentStatus(String datasetId, String action, UpdateDocumentStatusRequest request)	更新文档状态
MetadataResponse	DifyDatasetsClient.updateMetadata(String datasetId, String metadataId, UpdateMetadataRequest request)	更新元数据
SegmentResponse	DifyDatasetsClient.updateSegment(String datasetId, String documentId, String segmentId, UpdateSegmentRequest request)	更新文档分段
TagResponse	DifyDatasetsClient.updateTag(UpdateTagRequest request)	修改知识库类型标签名称
FileUploadResponse	DifyBaseClient.uploadFile(FileUploadRequest request, File file)	上传文件
FileUploadResponse	DifyBaseClient.uploadFile(FileUploadRequest request, InputStream inputStream, String fileName)	上传文件
FileUploadResponse	DifyBaseClient.uploadFile(File file, String user)	上传文件

io.github.imfangs.dify.client.impl中DifyApiException的使用

返回DifyApiException的io.github.imfangs.dify.client.impl中的方法

修饰符和类型	方法	说明
protected DifyApiException	AbstractDifyClient.createApiException(int code, String message)	创建API异常

抛出DifyApiException的io.github.imfangs.dify.client.impl中的方法

修饰符和类型	方法	说明
AnnotationReply	DefaultDifyClient.annotationReply(String action, String embeddingProviderName, String embeddingModelName, Integer scoreThreshold)	标注回复初始设置
AudioToTextResponse	DefaultDifyClient.audioToText(File file, String user)
AudioToTextResponse	DefaultDifyClient.audioToText(InputStream inputStream, String fileName, String user)
SimpleResponse	DefaultDifyDatasetsClient.bindTags(TagBindRequest request)
String	DefaultDifyDatasetsClient.builtInMetadata(String datasetId, String action)	启用/禁用内置元数据
ChildChunkResponse	DefaultDifyDatasetsClient.createChildChunk(String datasetId, String documentId, String segmentId, SaveChildChunkRequest request)
DatasetResponse	DefaultDifyDatasetsClient.createDataset(CreateDatasetRequest request)
DocumentResponse	DefaultDifyDatasetsClient.createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, File file)
DocumentResponse	DefaultDifyDatasetsClient.createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, InputStream inputStream, String fileName)
DocumentResponse	DefaultDifyDatasetsClient.createDocumentByText(String datasetId, CreateDocumentByTextRequest request)
MetadataResponse	DefaultDifyDatasetsClient.createMetadata(String datasetId, CreateMetadataRequest request)
SegmentListResponse	DefaultDifyDatasetsClient.createSegments(String datasetId, String documentId, CreateSegmentsRequest request)
TagResponse	DefaultDifyDatasetsClient.createTag(CreateTagRequest request)
SimpleResponse	DefaultDifyClient.deleteAnnotation(String annotationId)	删除标注
void	DefaultDifyDatasetsClient.deleteChildChunks(String datasetId, String documentId, String segmentId, String childChunkId)
SimpleResponse	DefaultDifyClient.deleteConversation(String conversationId, String user)
SimpleResponse	DefaultDifyDatasetsClient.deleteDataset(String datasetId)
void	DefaultDifyDatasetsClient.deleteDocument(String datasetId, String documentId)
String	DefaultDifyDatasetsClient.deleteMetadata(String datasetId, String metadataId)
void	DefaultDifyDatasetsClient.deleteSegment(String datasetId, String documentId, String segmentId)
SimpleResponse	DefaultDifyDatasetsClient.deleteTag(DeleteTagRequest request)
protected <T> T	AbstractDifyClient.executeDelete(String path, Object body, Class<T> responseClass)	执行DELETE请求
protected <T> T	AbstractDifyClient.executeGet(String path, Class<T> responseClass)	执行GET请求
protected <T> T	AbstractDifyClient.executePatch(String path, Object body, Class<T> responseClass)	执行Patch请求
protected <T> T	AbstractDifyClient.executePost(String path, Object body, Class<T> responseClass)	执行POST请求
protected <T> T	AbstractDifyClient.executePut(String path, Object body, Class<T> responseClass)	执行PUT请求
protected <T> T	AbstractDifyClient.executeRequest(okhttp3.Request request, Class<T> responseClass)	执行请求并处理响应
protected byte[]	AbstractDifyClient.executeRequestForBytes(okhttp3.Request request)	执行请求并返回字节数组
SimpleResponse	DefaultDifyClient.feedbackMessage(String messageId, String rating, String user, String content)
AnnotationReply	DefaultDifyClient.getAnnotationReply(String action, String jobId)	查询标注回复初始设置任务状态
AnnotationListResponse	DefaultDifyClient.getAnnotations(Integer page, Integer limit)	获取标注列表
AppInfoResponse	DifyBaseClientImpl.getAppInfo()
AppMetaResponse	DefaultDifyClient.getAppMeta()
AppParametersResponse	DifyBaseClientImpl.getAppParameters()
AppWebAppSettingResponse	DifyBaseClientImpl.getAppWebAppSettings()
ChildChunkListResponse	DefaultDifyDatasetsClient.getChildChunks(String datasetId, String documentId, String segmentId, String keyword, Integer page, Integer limit)
ConversationListResponse	DefaultDifyClient.getConversations(String user, String lastId, Integer limit, String sortBy)
VariableResponse	DefaultDifyClient.getConversationVariables(String conversationId, String user, String lastId, Integer limit, String variableName)	获取对话变量 从特定对话中检索变量。
DatasetResponse	DefaultDifyDatasetsClient.getDataset(String datasetId)
DatasetListResponse	DefaultDifyDatasetsClient.getDatasets(Integer page, Integer limit)
DatasetListResponse	DefaultDifyDatasetsClient.getDatasets(String keyword, Integer page, Integer limit)
DatasetListResponse	DefaultDifyDatasetsClient.getDatasets(String keyword, List<String> tagIds, Integer page, Integer limit, Boolean includeAll)
DatasetListResponse	DefaultDifyDatasetsClient.getDatasetsByTags(List<String> tagIds, Integer page, Integer limit)
TagListResponse	DefaultDifyDatasetsClient.getDatasetTags(String datasetId)
DocMetadataListResponse	DefaultDifyDatasetsClient.getDocMetadataList(String datasetId)	查询知识库元数据列表
DetailedDocumentResponse	DefaultDifyDatasetsClient.getDocumentDetail(String datasetId, String documentId, String metadata)
DocumentListResponse	DefaultDifyDatasetsClient.getDocuments(String datasetId, String keyword, Integer page, Integer limit)
EmbeddingModelListResponse	DefaultDifyDatasetsClient.getEmbeddingModelList()	获取嵌入模型列表
IndexingStatusResponse	DefaultDifyDatasetsClient.getIndexingStatus(String datasetId, String batch)
MessageListResponse	DefaultDifyClient.getMessages(String conversationId, String user, String firstId, Integer limit)
SegmentResponse	DefaultDifyDatasetsClient.getSegment(String datasetId, String documentId, String segmentId)
SegmentListResponse	DefaultDifyDatasetsClient.getSegments(String datasetId, String documentId, String keyword, String status)
SegmentListResponse	DefaultDifyDatasetsClient.getSegments(String datasetId, String documentId, String keyword, String status, Integer page, Integer limit)
SuggestedQuestionsResponse	DefaultDifyClient.getSuggestedQuestions(String messageId, String user)
List<TagResponse>	DefaultDifyDatasetsClient.getTags()
UploadFileResponse	DefaultDifyDatasetsClient.getUploadFile(String datasetId, String documentId)
WorkflowLogsResponse	DefaultDifyClient.getWorkflowLogs(String keyword, String status, Integer page, Integer limit)
WorkflowRunStatusResponse	DefaultDifyClient.getWorkflowRun(String workflowRunId)	获取工作流运行状态
protected <T> T	AbstractDifyClient.handleResponse(okhttp3.Response response, Class<T> clazz)	处理HTTP响应
FilePreviewResponse	DifyBaseClientImpl.previewFile(String fileId)
FilePreviewResponse	DifyBaseClientImpl.previewFile(String fileId, boolean asAttachment)
Conversation	DefaultDifyClient.renameConversation(String conversationId, String name, Boolean autoGenerate, String user)
RetrieveResponse	DefaultDifyDatasetsClient.retrieveDataset(String datasetId, RetrieveRequest request)
WorkflowRunResponse	DefaultDifyClient.runWorkflow(WorkflowRunRequest request)
void	DefaultDifyClient.runWorkflowStream(WorkflowRunRequest request, WorkflowStreamCallback callback)
Annotation	DefaultDifyClient.saveAnnotation(String question, String answer)	创建标注
ChatMessageResponse	DefaultDifyClient.sendChatMessage(ChatMessage message)
void	DefaultDifyClient.sendChatMessageStream(ChatMessage message, ChatflowStreamCallback callback)
void	DefaultDifyClient.sendChatMessageStream(ChatMessage message, ChatStreamCallback callback)
CompletionResponse	DefaultDifyClient.sendCompletionMessage(CompletionRequest request)
void	DefaultDifyClient.sendCompletionMessageStream(CompletionRequest request, CompletionStreamCallback callback)
SimpleResponse	DefaultDifyClient.stopChatMessage(String taskId, String user)
SimpleResponse	DefaultDifyClient.stopCompletion(String taskId, String user)
WorkflowStopResponse	DefaultDifyClient.stopWorkflow(String taskId, String user)
byte[]	DefaultDifyClient.textToAudio(String messageId, String text, String user)
SimpleResponse	DefaultDifyDatasetsClient.unbindTag(TagUnbindRequest request)
Annotation	DefaultDifyClient.updateAnnotation(String annotationId, String question, String answer)	更新标注
ChildChunkResponse	DefaultDifyDatasetsClient.updateChildChunk(String datasetId, String documentId, String segmentId, String childChunkId, SaveChildChunkRequest request)
DatasetResponse	DefaultDifyDatasetsClient.updateDataset(String datasetId, UpdateDatasetRequest request)
DocumentResponse	DefaultDifyDatasetsClient.updateDocumentByFile(String datasetId, String documentId, UpdateDocumentByFileRequest request, File file)
DocumentResponse	DefaultDifyDatasetsClient.updateDocumentByText(String datasetId, String documentId, UpdateDocumentByTextRequest request)
SimpleResponse	DefaultDifyDatasetsClient.updateDocumentMetadata(String datasetId, List<OperationData> operationDataList)	更新文档元数据
SimpleResponse	DefaultDifyDatasetsClient.updateDocumentStatus(String datasetId, String action, UpdateDocumentStatusRequest request)
MetadataResponse	DefaultDifyDatasetsClient.updateMetadata(String datasetId, String metadataId, UpdateMetadataRequest request)
SegmentResponse	DefaultDifyDatasetsClient.updateSegment(String datasetId, String documentId, String segmentId, UpdateSegmentRequest request)
TagResponse	DefaultDifyDatasetsClient.updateTag(UpdateTagRequest request)
FileUploadResponse	DifyBaseClientImpl.uploadFile(FileUploadRequest request, File file)
FileUploadResponse	DifyBaseClientImpl.uploadFile(FileUploadRequest request, InputStream inputStream, String fileName)
FileUploadResponse	DifyBaseClientImpl.uploadFile(File file, String user)