com.dify.client

接口 IDifyDatasetClient

所有已知实现类:

DifyDatasetClientImpl

public interface IDifyDatasetClient

知识库接口

方法概要

限定符和类型	方法和说明
DocumentCreateResponse	createDocumentByText(String datasetId, AddDocumentRequest addDocumentRequest) 通过文本创建文档
DatasetResponse<List<Segment>>	createSegment(String datasetId, String documentId, SegmentAddRequest segment) 新增分段
void	deleteDocument(String datasetId, String documentId) 删除文档
void	deleteSegment(String datasetId, String documentId, String segmentId) 删除文档分段
DatasetResponse<List<com.alibaba.fastjson.JSONObject>>	getDatasets(Integer page, Integer limit, Boolean includeAll, String keyword, List<String> tagIds) 知识库列表
Document	getDocumentInfo(String datasetId, String documentId) 文档详情
DatasetResponse<List<Document>>	getDocumentList(Integer page, Integer limit, String datasetId, String keyword) 知识库文档列表
DatasetResponse<Segment>	getSegmentInfo(String datasetId, String documentId, String segmentId) 查询文档分段详情
DatasetResponse<List<Segment>>	getSegments(Integer page, Integer limit, String datasetId, String documentId, String keyword, String status) 查询文档分段列表
DocumentCreateResponse	updateDocumentByText(String datasetId, String documentId, AddDocumentRequest addDocumentRequest) 通过文本更新文档
void	updateDocumentMeta(String datasetId, UpdateDocumentMetadata updateDocumentMetadata) 更新文档元数据
DatasetResponse<Segment>	updateSegment(String datasetId, String documentId, String segmentId, SegmentUpdateRequest segment) 更新分段

方法详细资料

getDatasets

DatasetResponse<List<com.alibaba.fastjson.JSONObject>> getDatasets(Integer page,
                                                                   Integer limit,
                                                                   Boolean includeAll,
                                                                   String keyword,
                                                                   List<String> tagIds)
                                                            throws IOException

知识库列表

参数:

page - 页码

limit - 每页数量

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

keyword - 搜索关键词，可选

tagIds - 标签 ID 列表，可选

返回:

DatasetResponse

抛出:

IOException - 错误

createDocumentByText

DocumentCreateResponse createDocumentByText(String datasetId,
                                            AddDocumentRequest addDocumentRequest)
                                     throws IOException,
                                            InterruptedException

通过文本创建文档

参数:

datasetId - 知识库 ID

addDocumentRequest - 创建文档请求

返回:

DocumentCreateResponse

抛出:

IOException - 错误

InterruptedException

updateDocumentByText

DocumentCreateResponse updateDocumentByText(String datasetId,
                                            String documentId,
                                            AddDocumentRequest addDocumentRequest)
                                     throws IOException,
                                            InterruptedException

通过文本更新文档

参数:

datasetId - 知识库 ID

documentId - 文档 ID

addDocumentRequest - 创建文档请求

返回:

DocumentCreateResponse

抛出:

IOException - 错误

InterruptedException

getDocumentList

DatasetResponse<List<Document>> getDocumentList(Integer page,
                                                Integer limit,
                                                String datasetId,
                                                String keyword)
                                         throws IOException,
                                                InterruptedException

知识库文档列表

参数:

page - 页码

limit - 返回条数，可选，默认 20，范围 1-100

datasetId - 知识库 ID

keyword - 搜索关键词，可选，目前仅搜索文档名称

返回:

DatasetResponse

抛出:

IOException - 错误

InterruptedException

deleteDocument

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

删除文档

参数:

datasetId - 知识库 ID

documentId - 文档 ID

抛出:

IOException - 错误

InterruptedException

getDocumentInfo

Document getDocumentInfo(String datasetId,
                         String documentId)
                  throws IOException,
                         InterruptedException

文档详情

参数:

datasetId - 知识库 ID

documentId - 文档 ID

返回:

Document

抛出:

IOException - 错误

InterruptedException

createSegment

DatasetResponse<List<Segment>> createSegment(String datasetId,
                                             String documentId,
                                             SegmentAddRequest segment)
                                      throws IOException,
                                             InterruptedException

新增分段

参数:

datasetId - 知识库 ID

documentId - 文档 ID

返回:

DatasetResponse>

抛出:

IOException - 错误

InterruptedException

updateSegment

DatasetResponse<Segment> updateSegment(String datasetId,
                                       String documentId,
                                       String segmentId,
                                       SegmentUpdateRequest segment)
                                throws IOException,
                                       InterruptedException

更新分段

参数:

datasetId - 知识库 ID

documentId - 文档 ID

返回:

DatasetResponse

抛出:

IOException - 错误

InterruptedException

getSegments

DatasetResponse<List<Segment>> getSegments(Integer page,
                                           Integer limit,
                                           String datasetId,
                                           String documentId,
                                           String keyword,
                                           String status)
                                    throws IOException,
                                           InterruptedException

查询文档分段列表

参数:

page - 页码

limit - 返回条数，可选，默认 20，范围 1-100

datasetId - 知识库 ID

documentId - 文档 ID

keyword - 搜索关键词，可选

status - 搜索状态，completed

返回:

DatasetResponse

抛出:

IOException - 错误

InterruptedException

getSegmentInfo

DatasetResponse<Segment> getSegmentInfo(String datasetId,
                                        String documentId,
                                        String segmentId)
                                 throws IOException,
                                        InterruptedException

查询文档分段详情

参数:

datasetId - 知识库 ID

documentId - 文档 ID

segmentId - 文档分段 ID

返回:

DatasetResponse

抛出:

IOException - 错误

InterruptedException

deleteSegment

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

删除文档分段

参数:

datasetId - 知识库 ID

documentId - 文档 ID

segmentId - 文档分段 ID

抛出:

IOException - 错误

InterruptedException

updateDocumentMeta

void updateDocumentMeta(String datasetId,
                        UpdateDocumentMetadata updateDocumentMetadata)
                 throws IOException,
                        InterruptedException

更新文档元数据

参数:

datasetId - 知识库 ID

updateDocumentMetadata - 文档元数据

抛出:

IOException - 错误

InterruptedException