Package io.github.guoshiqiufeng.dify.dataset.impl

Class DifyDatasetClientImpl

java.lang.Object

io.github.guoshiqiufeng.dify.dataset.impl.DifyDatasetClientImpl

All Implemented Interfaces:

DifyDataset

public class DifyDatasetClientImpl
extends Object
implements DifyDataset

Since:

2025/4/8 14:44

Version:

0.8.0

Author:

yanghq

Constructor Summary

Constructors

Constructor	Description
DifyDatasetClientImpl(DifyDatasetClient difyDatasetClient)

Method Summary

Modifier and Type	Method	Description
void	actionMetaData(MetaDataActionRequest request)	执行元数据业务操作（如启用/禁用等）
void	bindingTag(TagBindingRequest request)	Bind tags to a resource (such as dataset, model, etc.)
DatasetStatusResponse	changeDocumentStatus(String datasetId, Set<String> documentIds, DocActionEnum status, String apiKey)	更新指定文档状态。
DatasetResponse	create(DatasetCreateRequest request)	创建 知识库。
DocumentCreateResponse	createDocumentByFile(DocumentCreateByFileRequest request)	通过文件创建文档。
DocumentCreateResponse	createDocumentByText(DocumentCreateByTextRequest request)	通过文本创建文档。
MetaDataResponse	createMetaData(MetaDataCreateRequest request)	创建元数据
SegmentResponse	createSegment(SegmentCreateRequest request)	创建分段。
SegmentChildChunkCreateResponse	createSegmentChildChunk(SegmentChildChunkCreateRequest request)	创建子分段
TagInfoResponse	createTag(TagCreateRequest request)	Create a new tag
void	delete(String datasetId, String apiKey)	删除指定 知识库。
void	deleteDocument(String datasetId, String documentId, String apiKey)	删除指定文档。
void	deleteMetaData(String datasetId, String metadataId, String apiKey)	删除元数据
void	deleteSegment(String datasetId, String documentId, String segmentId, String apiKey)	删除指定分段。
void	deleteSegmentChildChunk(SegmentChildChunkDeleteRequest request)	删除指定子分段
void	deleteTag(String tagId, String apiKey)	Delete a tag by tag ID with API key authentication
DocumentIndexingStatusResponse	indexingStatus(DocumentIndexingStatusRequest request)	查询文档索引状态。
DatasetInfoResponse	info(DatasetInfoRequest request)	知识库详情
DataSetTagsResponse	listDatasetTag(String datasetId, String apiKey)	List all tags associated with a specific dataset
MetaDataListResponse	listMetaData(String datasetId, String apiKey)	获取数据集元数据列表
TextEmbeddingListResponse	listRerank(String apiKey)	Lists all rerank
List<TagInfoResponse>	listTag(String apiKey)	List all tags
TextEmbeddingListResponse	listTextEmbedding(String apiKey)	获取嵌入模型列表
io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<DatasetResponse>	page(DatasetPageRequest request)	分页查询 知识库列表。
io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<DocumentInfo>	pageDocument(DatasetPageDocumentRequest request)	分页查询文档列表。
SegmentResponse	pageSegment(SegmentPageRequest request)	分页查询分段列表。
io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<SegmentChildChunkResponse>	pageSegmentChildChunk(SegmentChildChunkPageRequest request)	分页查询子分段列表
RetrieveResponse	retrieve(RetrieveRequest request)	检索数据。
void	unbindingTag(TagUnbindingRequest request)	Unbind tags from a resource
DatasetInfoResponse	update(DatasetUpdateRequest request)	修改知识库
DocumentCreateResponse	updateDocumentByFile(DocumentUpdateByFileRequest request)	通过文件更新文档。
DocumentCreateResponse	updateDocumentByText(DocumentUpdateByTextRequest request)	通过文本更新文档。
void	updateDocumentMetaData(DocumentMetaDataUpdateRequest request)	更新文档关联的元数据
MetaDataResponse	updateMetaData(MetaDataUpdateRequest request)	更新元数据
SegmentUpdateResponse	updateSegment(SegmentUpdateRequest request)	更新分段。
SegmentChildChunkUpdateResponse	updateSegmentChildChunk(SegmentChildChunkUpdateRequest request)	更新子分段
TagInfoResponse	updateTag(TagUpdateRequest request)	Update an existing tag
UploadFileInfoResponse	uploadFileInfo(String datasetId, String documentId, String apiKey)	获取上传文件信息。

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.guoshiqiufeng.dify.dataset.DifyDataset

changeDocumentStatus, delete, deleteDocument, deleteMetaData, deleteSegment, deleteTag, listDatasetTag, listMetaData, listRerank, listTag, listTextEmbedding, uploadFileInfo

Constructor Details

DifyDatasetClientImpl

public DifyDatasetClientImpl(DifyDatasetClient difyDatasetClient)

Method Details

create

public DatasetResponse create(DatasetCreateRequest request)

Description copied from interface: DifyDataset

创建 知识库。

Specified by:

create in interface DifyDataset

Parameters:

request - 知识库创建请求对象，包含创建 知识库所需的信息。

Returns:

返回创建的 知识库响应对象。

page

public io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<DatasetResponse> page(DatasetPageRequest request)

Description copied from interface: DifyDataset

分页查询 知识库列表。

Specified by:

page in interface DifyDataset

Parameters:

request - 分页查询请求对象，包含分页参数和查询条件。

Returns:

返回分页查询结果，包含 知识库信息列表和分页信息。

info

public DatasetInfoResponse info(DatasetInfoRequest request)

Description copied from interface: DifyDataset

知识库详情

Specified by:

info in interface DifyDataset

Parameters:

request - 知识库详情查询请求对象

Returns:

知识库详情

update

public DatasetInfoResponse update(DatasetUpdateRequest request)

Description copied from interface: DifyDataset

修改知识库

Specified by:

update in interface DifyDataset

Parameters:

request - 请求对象

Returns:

知识库详情

delete

public void delete(String datasetId,
 String apiKey)

Description copied from interface: DifyDataset

删除指定 知识库。

Specified by:

delete in interface DifyDataset

Parameters:

datasetId - 知识库的唯一标识符。

apiKey - 知识库的唯一标识符。

createDocumentByText

public DocumentCreateResponse createDocumentByText(DocumentCreateByTextRequest request)

Description copied from interface: DifyDataset

通过文本创建文档。

Specified by:

createDocumentByText in interface DifyDataset

Parameters:

request - 文档创建请求对象，包含通过文本创建文档所需的信息。

Returns:

返回文档创建响应对象。

createDocumentByFile

public DocumentCreateResponse createDocumentByFile(DocumentCreateByFileRequest request)

Description copied from interface: DifyDataset

通过文件创建文档。

Specified by:

createDocumentByFile in interface DifyDataset

Parameters:

request - 文档创建请求对象，包含通过文件创建文档所需的信息。

Returns:

返回文档创建响应对象。

updateDocumentByText

public DocumentCreateResponse updateDocumentByText(DocumentUpdateByTextRequest request)

Description copied from interface: DifyDataset

通过文本更新文档。

Specified by:

updateDocumentByText in interface DifyDataset

Parameters:

request - 文档更新请求对象，包含通过文本更新文档所需的信息。

Returns:

返回文档更新响应对象。

updateDocumentByFile

public DocumentCreateResponse updateDocumentByFile(DocumentUpdateByFileRequest request)

Description copied from interface: DifyDataset

通过文件更新文档。

Specified by:

updateDocumentByFile in interface DifyDataset

Parameters:

request - 文档更新请求对象，包含通过文件更新文档所需的信息。

Returns:

返回文档更新响应对象。

pageDocument

public io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<DocumentInfo> pageDocument(DatasetPageDocumentRequest request)

Description copied from interface: DifyDataset

分页查询文档列表。

Specified by:

pageDocument in interface DifyDataset

Parameters:

request - 分页查询请求对象，包含分页参数和查询条件。

Returns:

返回分页查询结果，包含文档信息列表和分页信息。

indexingStatus

public DocumentIndexingStatusResponse indexingStatus(DocumentIndexingStatusRequest request)

Description copied from interface: DifyDataset

查询文档索引状态。

Specified by:

indexingStatus in interface DifyDataset

Parameters:

request - 索引状态查询请求对象，包含查询所需的信息。

Returns:

返回文档索引状态响应对象。

deleteDocument

public void deleteDocument(String datasetId,
 String documentId,
 String apiKey)

Description copied from interface: DifyDataset

删除指定文档。

Specified by:

deleteDocument in interface DifyDataset

Parameters:

datasetId - 知识库的唯一标识符。

documentId - 文档的唯一标识符。

apiKey - apiKey

createSegment

public SegmentResponse createSegment(SegmentCreateRequest request)

Description copied from interface: DifyDataset

创建分段。

Specified by:

createSegment in interface DifyDataset

Parameters:

request - 分段创建请求对象，包含创建分段所需的信息。

Returns:

返回分段创建响应对象。

pageSegment

public SegmentResponse pageSegment(SegmentPageRequest request)

Description copied from interface: DifyDataset

分页查询分段列表。

Specified by:

pageSegment in interface DifyDataset

Parameters:

request - 分页查询请求对象，包含分页参数和查询条件。

Returns:

返回分段分页查询响应对象。

deleteSegment

public void deleteSegment(String datasetId,
 String documentId,
 String segmentId,
 String apiKey)

Description copied from interface: DifyDataset

删除指定分段。

Specified by:

deleteSegment in interface DifyDataset

Parameters:

datasetId - 知识库的唯一标识符。

documentId - 文档的唯一标识符。

segmentId - 分段的唯一标识符。

apiKey - apiKey

updateSegment

public SegmentUpdateResponse updateSegment(SegmentUpdateRequest request)

Description copied from interface: DifyDataset

更新分段。

Specified by:

updateSegment in interface DifyDataset

Parameters:

request - 分段更新请求对象，包含更新分段所需的信息。

Returns:

返回分段更新响应对象。

createSegmentChildChunk

public SegmentChildChunkCreateResponse createSegmentChildChunk(SegmentChildChunkCreateRequest request)

Description copied from interface: DifyDataset

创建子分段

Specified by:

createSegmentChildChunk in interface DifyDataset

Parameters:

request - 子分段创建请求对象，包含创建分段所需的信息。

Returns:

返回子分段响应对象

pageSegmentChildChunk

public io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<SegmentChildChunkResponse> pageSegmentChildChunk(SegmentChildChunkPageRequest request)

Description copied from interface: DifyDataset

分页查询子分段列表

Specified by:

pageSegmentChildChunk in interface DifyDataset

Parameters:

request - 子分段分页查询请求对象，包含分页参数和查询条件。

Returns:

返回子分段分页查询响应对象

deleteSegmentChildChunk

public void deleteSegmentChildChunk(SegmentChildChunkDeleteRequest request)

Description copied from interface: DifyDataset

删除指定子分段

Specified by:

deleteSegmentChildChunk in interface DifyDataset

Parameters:

request - 子分段删除请求对象

updateSegmentChildChunk

public SegmentChildChunkUpdateResponse updateSegmentChildChunk(SegmentChildChunkUpdateRequest request)

Description copied from interface: DifyDataset

更新子分段

Specified by:

updateSegmentChildChunk in interface DifyDataset

Parameters:

request - 子分段更新请求对象，包含更新子分段所需的信息。

Returns:

返回子分段更新响应对象

uploadFileInfo

public UploadFileInfoResponse uploadFileInfo(String datasetId,
 String documentId,
 String apiKey)

Description copied from interface: DifyDataset

获取上传文件信息。

Specified by:

uploadFileInfo in interface DifyDataset

Parameters:

datasetId - 知识库的唯一标识符。

documentId - 文档的唯一标识符。

apiKey - apiKey

Returns:

返回上传文件信息响应对象。

retrieve

public RetrieveResponse retrieve(RetrieveRequest request)

Description copied from interface: DifyDataset

检索数据。

Specified by:

retrieve in interface DifyDataset

Parameters:

request - 检索请求对象，包含检索所需的信息。

Returns:

返回检索响应对象。

createMetaData

public MetaDataResponse createMetaData(MetaDataCreateRequest request)

Description copied from interface: DifyDataset

创建元数据

Specified by:

createMetaData in interface DifyDataset

Parameters:

request - 元数据创建请求参数（需包含数据集ID和元数据内容）

Returns:

创建成功的元数据详情

updateMetaData

public MetaDataResponse updateMetaData(MetaDataUpdateRequest request)

Description copied from interface: DifyDataset

更新元数据

Specified by:

updateMetaData in interface DifyDataset

Parameters:

request - 元数据更新请求参数（需包含元数据ID和更新内容）

Returns:

更新后的元数据详情

deleteMetaData

public void deleteMetaData(String datasetId,
 String metadataId,
 String apiKey)

Description copied from interface: DifyDataset

删除元数据

Specified by:

deleteMetaData in interface DifyDataset

Parameters:

datasetId - 数据集ID

metadataId - 元数据ID

apiKey - apiKey

actionMetaData

public void actionMetaData(MetaDataActionRequest request)

Description copied from interface: DifyDataset

执行元数据业务操作（如启用/禁用等）

Specified by:

actionMetaData in interface DifyDataset

Parameters:

request - 操作请求参数（需包含操作类型和目标元数据ID）

updateDocumentMetaData

public void updateDocumentMetaData(DocumentMetaDataUpdateRequest request)

Description copied from interface: DifyDataset

更新文档关联的元数据

Specified by:

updateDocumentMetaData in interface DifyDataset

Parameters:

request - 文档元数据更新请求（需包含文档ID和元数据变更内容）

listMetaData

public MetaDataListResponse listMetaData(String datasetId,
 String apiKey)

Description copied from interface: DifyDataset

获取数据集元数据列表

Specified by:

listMetaData in interface DifyDataset

Parameters:

datasetId - 数据集ID

apiKey - apiKey

Returns:

元数据列表及分页信息

listTextEmbedding

public TextEmbeddingListResponse listTextEmbedding(String apiKey)

Description copied from interface: DifyDataset

获取嵌入模型列表

Specified by:

listTextEmbedding in interface DifyDataset

Parameters:

apiKey - apiKey

Returns:

嵌入模型列表

listRerank

public TextEmbeddingListResponse listRerank(String apiKey)

Description copied from interface: DifyDataset

Lists all rerank

Specified by:

listRerank in interface DifyDataset

Parameters:

apiKey - The API key for authentication and authorization to the Dify API

Returns:

The rerank list response

createTag

public TagInfoResponse createTag(TagCreateRequest request)

Description copied from interface: DifyDataset

Create a new tag

Specified by:

createTag in interface DifyDataset

Parameters:

request - Tag creation request containing tag information

Returns:

TagInfoResponse containing the created tag details

listTag

public List<TagInfoResponse> listTag(String apiKey)

Description copied from interface: DifyDataset

List all tags

Specified by:

listTag in interface DifyDataset

Parameters:

apiKey - The API key for authentication and authorization to the Dify API

Returns:

List of TagInfoResponse containing all tag information

updateTag

public TagInfoResponse updateTag(TagUpdateRequest request)

Description copied from interface: DifyDataset

Update an existing tag

Specified by:

updateTag in interface DifyDataset

Parameters:

request - Tag update request containing updated tag information

Returns:

TagInfoResponse containing the updated tag details

deleteTag

public void deleteTag(String tagId,
 String apiKey)

Description copied from interface: DifyDataset

Delete a tag by tag ID with API key authentication

Specified by:

deleteTag in interface DifyDataset

Parameters:

tagId - ID of the tag to be deleted

apiKey - API key for authentication (can be null)

bindingTag

public void bindingTag(TagBindingRequest request)

Description copied from interface: DifyDataset

Bind tags to a resource (such as dataset, model, etc.)

Specified by:

bindingTag in interface DifyDataset

Parameters:

request - Tag binding request containing binding information

unbindingTag

public void unbindingTag(TagUnbindingRequest request)

Description copied from interface: DifyDataset

Unbind tags from a resource

Specified by:

unbindingTag in interface DifyDataset

Parameters:

request - Tag unbinding request containing unbinding information

listDatasetTag

public DataSetTagsResponse listDatasetTag(String datasetId,
 String apiKey)

Description copied from interface: DifyDataset

List all tags associated with a specific dataset

Specified by:

listDatasetTag in interface DifyDataset

Parameters:

datasetId - ID of the dataset to query tags for

apiKey - API key for authentication

Returns:

DataSetTagsResponse containing dataset tag information

changeDocumentStatus

public DatasetStatusResponse changeDocumentStatus(String datasetId,
 Set<String> documentIds,
 DocActionEnum status,
 String apiKey)

Description copied from interface: DifyDataset

更新指定文档状态。

Specified by:

changeDocumentStatus in interface DifyDataset

Parameters:

datasetId - 知识库的唯一标识符。

documentIds - 文档的唯一标识符。

status - 状态

apiKey - apiKey

Returns:

结果 默认成功