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

接口 DifyDatasetsClient

所有已知实现类:

DefaultDifyDatasetsClient

public interface DifyDatasetsClient

Dify 知识库客户端接口 提供知识库相关的操作

方法概要

修饰符和类型	方法	说明
SimpleResponse	bindTags(TagBindRequest request)	绑定知识库到知识库类型标签
String	builtInMetadata(String datasetId, String action)	启用/禁用内置元数据
ChildChunkResponse	createChildChunk(String datasetId, String documentId, String segmentId, SaveChildChunkRequest request)	创建子分段
DatasetResponse	createDataset(CreateDatasetRequest request)	创建空知识库
DocumentResponse	createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, File file)	通过文件创建文档
DocumentResponse	createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, InputStream inputStream, String fileName)	通过文件创建文档
DocumentResponse	createDocumentByText(String datasetId, CreateDocumentByTextRequest request)	通过文本创建文档
MetadataResponse	createMetadata(String datasetId, CreateMetadataRequest request)	新增元数据
SegmentListResponse	createSegments(String datasetId, String documentId, CreateSegmentsRequest request)	新增文档分段
TagResponse	createTag(CreateTagRequest request)	新增知识库类型标签
void	deleteChildChunks(String datasetId, String documentId, String segmentId, String childChunkId)	删除子分段
SimpleResponse	deleteDataset(String datasetId)	删除知识库
void	deleteDocument(String datasetId, String documentId)	删除文档
String	deleteMetadata(String datasetId, String metadataId)	删除元数据
void	deleteSegment(String datasetId, String documentId, String segmentId)	删除文档分段
SimpleResponse	deleteTag(DeleteTagRequest request)	删除知识库类型标签
ChildChunkListResponse	getChildChunks(String datasetId, String documentId, String segmentId, String keyword, Integer page, Integer limit)	获取子分段
DatasetResponse	getDataset(String datasetId)	获取知识库详情
DatasetListResponse	getDatasets(Integer page, Integer limit)	获取知识库列表
DatasetListResponse	getDatasets(String keyword, Integer page, Integer limit)	根据关键词搜索知识库列表
DatasetListResponse	getDatasets(String keyword, List<String> tagIds, Integer page, Integer limit, Boolean includeAll)	获取知识库列表（支持高级查询参数）
DatasetListResponse	getDatasetsByTags(List<String> tagIds, Integer page, Integer limit)	根据标签ID列表获取知识库列表
TagListResponse	getDatasetTags(String datasetId)	查询知识库已绑定的标签
DocMetadataListResponse	getDocMetadataList(String datasetId)	查询知识库元数据列表
DetailedDocumentResponse	getDocumentDetail(String datasetId, String documentId, String metadata)	获取文档详情
DocumentListResponse	getDocuments(String datasetId, String keyword, Integer page, Integer limit)	获取知识库文档列表
EmbeddingModelListResponse	getEmbeddingModelList()	获取嵌入模型列表
IndexingStatusResponse	getIndexingStatus(String datasetId, String batch)	获取文档嵌入状态
SegmentResponse	getSegment(String datasetId, String documentId, String segmentId)	查看文档分段详情
SegmentListResponse	getSegments(String datasetId, String documentId, String keyword, String status)	查询文档分段
SegmentListResponse	getSegments(String datasetId, String documentId, String keyword, String status, Integer page, Integer limit)	查询文档分段
List<TagResponse>	getTags()	获取知识库类型标签列表
UploadFileResponse	getUploadFile(String datasetId, String documentId)	获取上传文件
RetrieveResponse	retrieveDataset(String datasetId, RetrieveRequest request)	检索知识库
SimpleResponse	unbindTag(TagUnbindRequest request)	解绑知识库和知识库类型标签
ChildChunkResponse	updateChildChunk(String datasetId, String documentId, String segmentId, String childChunkId, SaveChildChunkRequest request)	更新子分段
DatasetResponse	updateDataset(String datasetId, UpdateDatasetRequest request)	更新知识库
DocumentResponse	updateDocumentByFile(String datasetId, String documentId, UpdateDocumentByFileRequest request, File file)	通过文件更新文档
DocumentResponse	updateDocumentByText(String datasetId, String documentId, UpdateDocumentByTextRequest request)	通过文本更新文档
SimpleResponse	updateDocumentMetadata(String datasetId, List<OperationData> operationDataList)	更新文档元数据
SimpleResponse	updateDocumentStatus(String datasetId, String action, UpdateDocumentStatusRequest request)	更新文档状态
MetadataResponse	updateMetadata(String datasetId, String metadataId, UpdateMetadataRequest request)	更新元数据
SegmentResponse	updateSegment(String datasetId, String documentId, String segmentId, UpdateSegmentRequest request)	更新文档分段
TagResponse	updateTag(UpdateTagRequest request)	修改知识库类型标签名称

方法详细资料

createDataset

DatasetResponse createDataset(CreateDatasetRequest request)
                       throws IOException,
DifyApiException

创建空知识库

参数:

request - 创建知识库请求

返回:

知识库信息

抛出:

IOException - IO异常

DifyApiException - API异常

getDatasets

DatasetListResponse getDatasets(Integer page,
 Integer limit)
                         throws IOException,
DifyApiException

获取知识库列表

参数:

page - 页码

limit - 每页数量

返回:

知识库列表

抛出:

IOException - IO异常

DifyApiException - API异常

getDatasets

DatasetListResponse getDatasets(String keyword,
 List<String> tagIds,
 Integer page,
 Integer limit,
 Boolean includeAll)
                         throws IOException,
DifyApiException

获取知识库列表（支持高级查询参数）

参数:

keyword - 搜索关键词，可选

tagIds - 标签 ID 列表，可选

page - 页码，可选，默认为 1

limit - 每页数量，可选，默认 20，范围 1-100

includeAll - 是否包含所有数据集（仅对所有者生效），可选，默认为 false

返回:

知识库列表

抛出:

IOException - IO异常

DifyApiException - API异常

getDatasets

DatasetListResponse getDatasets(String keyword,
 Integer page,
 Integer limit)
                         throws IOException,
DifyApiException

根据关键词搜索知识库列表

参数:

keyword - 搜索关键词

page - 页码

limit - 每页数量

返回:

知识库列表

抛出:

IOException - IO异常

DifyApiException - API异常

getDatasetsByTags

DatasetListResponse getDatasetsByTags(List<String> tagIds,
 Integer page,
 Integer limit)
                               throws IOException,
DifyApiException

根据标签ID列表获取知识库列表

参数:

tagIds - 标签 ID 列表

page - 页码

limit - 每页数量

返回:

知识库列表

抛出:

IOException - IO异常

DifyApiException - API异常

getDataset

DatasetResponse getDataset(String datasetId)
                    throws IOException,
DifyApiException

获取知识库详情

参数:

datasetId - 知识库ID

返回:

知识库详情

抛出:

IOException - IO异常

DifyApiException - API异常

updateDataset

DatasetResponse updateDataset(String datasetId,
 UpdateDatasetRequest request)
                       throws IOException,
DifyApiException

更新知识库

参数:

datasetId - 知识库ID

request - 更新请求

返回:

更新后的知识库信息

抛出:

IOException - IO异常

DifyApiException - API异常

deleteDataset

SimpleResponse deleteDataset(String datasetId)
                      throws IOException,
DifyApiException

删除知识库

参数:

datasetId - 知识库ID

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

createDocumentByText

DocumentResponse createDocumentByText(String datasetId,
 CreateDocumentByTextRequest request)
                               throws IOException,
DifyApiException

通过文本创建文档

参数:

datasetId - 知识库ID

request - 创建文档请求

返回:

文档信息

抛出:

IOException - IO异常

DifyApiException - API异常

createDocumentByFile

DocumentResponse createDocumentByFile(String datasetId,
 CreateDocumentByFileRequest request,
 File file)
                               throws IOException,
DifyApiException

通过文件创建文档

参数:

datasetId - 知识库ID

request - 创建文档请求

file - 文件

返回:

文档信息

抛出:

IOException - IO异常

DifyApiException - API异常

createDocumentByFile

DocumentResponse createDocumentByFile(String datasetId,
 CreateDocumentByFileRequest request,
 InputStream inputStream,
 String fileName)
                               throws IOException,
DifyApiException

通过文件创建文档

参数:

datasetId - 知识库ID

request - 创建文档请求

inputStream - 文件输入流

fileName - 文件名

返回:

文档信息

抛出:

IOException - IO异常

DifyApiException - API异常

updateDocumentByText

DocumentResponse updateDocumentByText(String datasetId,
 String documentId,
 UpdateDocumentByTextRequest request)
                               throws IOException,
DifyApiException

通过文本更新文档

参数:

datasetId - 知识库ID

documentId - 文档ID

request - 更新文档请求

返回:

文档信息

抛出:

IOException - IO异常

DifyApiException - API异常

updateDocumentByFile

DocumentResponse updateDocumentByFile(String datasetId,
 String documentId,
 UpdateDocumentByFileRequest request,
 File file)
                               throws IOException,
DifyApiException

通过文件更新文档

参数:

datasetId - 知识库ID

documentId - 文档ID

request - 更新文档请求

file - 文件

返回:

文档信息

抛出:

IOException - IO异常

DifyApiException - API异常

getIndexingStatus

IndexingStatusResponse getIndexingStatus(String datasetId,
 String batch)
                                  throws IOException,
DifyApiException

获取文档嵌入状态

参数:

datasetId - 知识库ID

batch - 批次号

返回:

文档嵌入状态

抛出:

IOException - IO异常

DifyApiException - API异常

deleteDocument

void deleteDocument(String datasetId,
 String documentId)
             throws IOException,
DifyApiException

删除文档

参数:

datasetId - 知识库ID

documentId - 文档ID

抛出:

IOException - IO异常

DifyApiException - API异常

getDocuments

DocumentListResponse getDocuments(String datasetId,
 String keyword,
 Integer page,
 Integer limit)
                           throws IOException,
DifyApiException

获取知识库文档列表

参数:

datasetId - 知识库ID

keyword - 关键词

page - 页码

limit - 每页数量

返回:

文档列表

抛出:

IOException - IO异常

DifyApiException - API异常

getDocumentDetail

DetailedDocumentResponse getDocumentDetail(String datasetId,
 String documentId,
 String metadata)
                                    throws IOException,
DifyApiException

获取文档详情

参数:

datasetId - 知识库ID

documentId - 文档ID

metadata - 元数据过滤条件 all, only, 或者 without. 默认是 all

返回:

文档详情

抛出:

IOException - IO异常

DifyApiException - API异常

updateDocumentStatus

SimpleResponse updateDocumentStatus(String datasetId,
 String action,
 UpdateDocumentStatusRequest request)
                             throws IOException,
DifyApiException

更新文档状态

参数:

datasetId - 知识库ID

action - 操作类型：enable - 启用文档, disable - 禁用文档, archive - 归档文档, un_archive - 取消归档文档

request - 更新文档状态请求

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

createSegments

SegmentListResponse createSegments(String datasetId,
 String documentId,
 CreateSegmentsRequest request)
                            throws IOException,
DifyApiException

新增文档分段

参数:

datasetId - 知识库ID

documentId - 文档ID

request - 新增分段请求

返回:

分段信息

抛出:

IOException - IO异常

DifyApiException - API异常

getSegments

SegmentListResponse getSegments(String datasetId,
 String documentId,
 String keyword,
 String status)
                         throws IOException,
DifyApiException

查询文档分段

参数:

datasetId - 知识库ID

documentId - 文档ID

keyword - 关键词

status - 状态

返回:

分段列表

抛出:

IOException - IO异常

DifyApiException - API异常

getSegments

SegmentListResponse getSegments(String datasetId,
 String documentId,
 String keyword,
 String status,
 Integer page,
 Integer limit)
                         throws IOException,
DifyApiException

查询文档分段

参数:

datasetId - 知识库ID

documentId - 文档ID

keyword - 关键词

status - 状态

page - 页码

limit - 每页数量

返回:

分段列表

抛出:

IOException - IO异常

DifyApiException - API异常

getSegment

SegmentResponse getSegment(String datasetId,
 String documentId,
 String segmentId)
                    throws IOException,
DifyApiException

查看文档分段详情

参数:

datasetId - 知识库ID

documentId - 文档ID

segmentId - 分段ID

返回:

分段详情

抛出:

IOException - IO异常

DifyApiException - API异常

deleteSegment

void deleteSegment(String datasetId,
 String documentId,
 String segmentId)
            throws IOException,
DifyApiException

删除文档分段

注意：官方文档写的返回 { "result": "success" } ，实际返回的是空

参数:

datasetId - 知识库ID

documentId - 文档ID

segmentId - 分段ID

抛出:

IOException - IO异常

DifyApiException - API异常

updateSegment

SegmentResponse updateSegment(String datasetId,
 String documentId,
 String segmentId,
 UpdateSegmentRequest request)
                       throws IOException,
DifyApiException

更新文档分段

参数:

datasetId - 知识库ID

documentId - 文档ID

segmentId - 分段ID

request - 更新分段请求

返回:

分段信息

抛出:

IOException - IO异常

DifyApiException - API异常

createChildChunk

ChildChunkResponse createChildChunk(String datasetId,
 String documentId,
 String segmentId,
 SaveChildChunkRequest request)
                             throws IOException,
DifyApiException

创建子分段

参数:

datasetId - 知识库ID

documentId - 文档ID

segmentId - 分段ID

request - 子分段请求

返回:

子分段信息

抛出:

IOException - IO异常

DifyApiException - API异常

getChildChunks

ChildChunkListResponse getChildChunks(String datasetId,
 String documentId,
 String segmentId,
 String keyword,
 Integer page,
 Integer limit)
                               throws IOException,
DifyApiException

获取子分段

参数:

datasetId - 知识库ID

documentId - 文档ID

segmentId - 分段ID

keyword - 关键词

page - 页码

limit - 每页数量

返回:

子分段列表

抛出:

IOException - IO异常

DifyApiException - API异常

deleteChildChunks

void deleteChildChunks(String datasetId,
 String documentId,
 String segmentId,
 String childChunkId)
                throws IOException,
DifyApiException

删除子分段

参数:

datasetId - 知识库ID

documentId -

segmentId -

childChunkId -

抛出:

IOException - IO异常

DifyApiException - API异常

updateChildChunk

ChildChunkResponse updateChildChunk(String datasetId,
 String documentId,
 String segmentId,
 String childChunkId,
 SaveChildChunkRequest request)
                             throws IOException,
DifyApiException

更新子分段

参数:

datasetId - 知识库ID

documentId - 文档ID

segmentId - 分段ID

childChunkId - 子分段ID

request - 子分段请求

返回:

子分段信息

抛出:

IOException - IO异常

DifyApiException - API异常

getUploadFile

UploadFileResponse getUploadFile(String datasetId,
 String documentId)
                          throws IOException,
DifyApiException

获取上传文件

参数:

datasetId - 知识库ID

documentId - 文档ID

返回:

文件信息

抛出:

IOException - IO异常

DifyApiException - API异常

retrieveDataset

RetrieveResponse retrieveDataset(String datasetId,
 RetrieveRequest request)
                          throws IOException,
DifyApiException

检索知识库

参数:

datasetId - 知识库ID

request - 检索请求

返回:

检索结果

抛出:

IOException - IO异常

DifyApiException - API异常

createMetadata

MetadataResponse createMetadata(String datasetId,
 CreateMetadataRequest request)
                         throws IOException,
DifyApiException

新增元数据

参数:

datasetId - 知识库ID

request - 新增元数据请求

返回:

元数据信息

抛出:

IOException - IO异常

DifyApiException - API异常

updateMetadata

MetadataResponse updateMetadata(String datasetId,
 String metadataId,
 UpdateMetadataRequest request)
                         throws IOException,
DifyApiException

更新元数据

参数:

datasetId - 知识库ID

metadataId - 元数据 ID

request - 更新元数据请求

返回:

元数据信息

抛出:

IOException - IO异常

DifyApiException - API异常

deleteMetadata

String deleteMetadata(String datasetId,
 String metadataId)
               throws IOException,
DifyApiException

删除元数据

参数:

datasetId - 知识库ID

metadataId - 文档ID

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

builtInMetadata

String builtInMetadata(String datasetId,
 String action)
                throws IOException,
DifyApiException

启用/禁用内置元数据

参数:

datasetId - 知识库 ID

action - 动作，只能是 'enable' 或 'disable'

返回:

结果

抛出:

IOException - IO异常

DifyApiException - Dify API异常

updateDocumentMetadata

SimpleResponse updateDocumentMetadata(String datasetId,
 List<OperationData> operationDataList)
                               throws IOException,
DifyApiException

更新文档元数据

参数:

datasetId - 知识库 ID

operationDataList - 文档元数据集合

返回:

结果

抛出:

IOException - IO异常

DifyApiException - Dify API异常

getDocMetadataList

DocMetadataListResponse getDocMetadataList(String datasetId)
                                    throws IOException,
DifyApiException

查询知识库元数据列表

参数:

datasetId - 知识库 ID

返回:

响应

抛出:

IOException - IO异常

DifyApiException - Dify API异常

getEmbeddingModelList

EmbeddingModelListResponse getEmbeddingModelList()
                                          throws IOException,
DifyApiException

获取嵌入模型列表

返回:

响应

抛出:

IOException - IO异常

DifyApiException - Dify API异常

createTag

TagResponse createTag(CreateTagRequest request)
               throws IOException,
DifyApiException

新增知识库类型标签

参数:

request - 创建标签请求

返回:

标签信息

抛出:

IOException - IO异常

DifyApiException - API异常

getTags

List<TagResponse> getTags()
                   throws IOException,
DifyApiException

获取知识库类型标签列表

返回:

标签列表

抛出:

IOException - IO异常

DifyApiException - API异常

updateTag

TagResponse updateTag(UpdateTagRequest request)
               throws IOException,
DifyApiException

修改知识库类型标签名称

参数:

request - 修改标签请求

返回:

标签信息

抛出:

IOException - IO异常

DifyApiException - API异常

deleteTag

SimpleResponse deleteTag(DeleteTagRequest request)
                  throws IOException,
DifyApiException

删除知识库类型标签

参数:

request - 删除标签请求

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

bindTags

SimpleResponse bindTags(TagBindRequest request)
                 throws IOException,
DifyApiException

绑定知识库到知识库类型标签

参数:

request - 标签绑定请求

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

unbindTag

SimpleResponse unbindTag(TagUnbindRequest request)
                  throws IOException,
DifyApiException

解绑知识库和知识库类型标签

参数:

request - 标签解绑请求

返回:

响应

抛出:

IOException - IO异常

DifyApiException - API异常

getDatasetTags

TagListResponse getDatasetTags(String datasetId)
                        throws IOException,
DifyApiException

查询知识库已绑定的标签

参数:

datasetId - 知识库ID

返回:

标签列表响应

抛出:

IOException - IO异常

DifyApiException - API异常