com.dify.client.impl

类 DifyDatasetClientImpl

java.lang.Object

com.dify.client.impl.DifyBaseClientImpl

com.dify.client.impl.DifyDatasetClientImpl

所有已实现的接口:

IDifyClient, IDifyDatasetClient

public class DifyDatasetClientImpl
extends DifyBaseClientImpl
implements IDifyDatasetClient

构造器概要

构造器

构造器和说明
DifyDatasetClientImpl(String server, String apiKey)

方法概要

限定符和类型	方法和说明
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) 更新分段

从类继承的方法 com.dify.client.impl.DifyBaseClientImpl

getAppInfo, getAppMetaInfo, getAppParameters, requestJson, requestJson, requestJson, requestJson, requestJson, requestJson, requestJson, requestJson, requestMultipart, requestMultipart, requestMultipart, sendBlocking, sendBlocking, sendStreaming, sendStreaming, sendStreaming, uploadFile

从类继承的方法 java.lang.Object

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

构造器详细资料

DifyDatasetClientImpl

public DifyDatasetClientImpl(String server,
                             String apiKey)

方法详细资料

getDatasets

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

从接口复制的说明: IDifyDatasetClient

知识库列表

指定者:

getDatasets 在接口中 IDifyDatasetClient

参数:

page - 页码

limit - 每页数量

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

keyword - 搜索关键词，可选

tagIds - 标签 ID 列表，可选

返回:

DatasetResponse

抛出:

IOException - 错误

createDocumentByText

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

从接口复制的说明: IDifyDatasetClient

通过文本创建文档

指定者:

createDocumentByText 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

addDocumentRequest - 创建文档请求

返回:

DocumentCreateResponse

抛出:

IOException - 错误

InterruptedException

updateDocumentByText

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

从接口复制的说明: IDifyDatasetClient

通过文本更新文档

指定者:

updateDocumentByText 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

documentId - 文档 ID

addDocumentRequest - 创建文档请求

返回:

DocumentCreateResponse

抛出:

IOException - 错误

InterruptedException

getDocumentList

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

从接口复制的说明: IDifyDatasetClient

知识库文档列表

指定者:

getDocumentList 在接口中 IDifyDatasetClient

参数:

page - 页码

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

datasetId - 知识库 ID

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

返回:

DatasetResponse

抛出:

IOException - 错误

InterruptedException

deleteDocument

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

从接口复制的说明: IDifyDatasetClient

删除文档

指定者:

deleteDocument 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

documentId - 文档 ID

抛出:

IOException - 错误

InterruptedException

getDocumentInfo

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

从接口复制的说明: IDifyDatasetClient

文档详情

指定者:

getDocumentInfo 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

documentId - 文档 ID

返回:

Document

抛出:

IOException - 错误

InterruptedException

createSegment

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

从接口复制的说明: IDifyDatasetClient

新增分段

指定者:

createSegment 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

documentId - 文档 ID

返回:

DatasetResponse>

抛出:

IOException - 错误

InterruptedException

updateSegment

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

从接口复制的说明: IDifyDatasetClient

更新分段

指定者:

updateSegment 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

documentId - 文档 ID

返回:

DatasetResponse

抛出:

IOException - 错误

InterruptedException

getSegments

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

从接口复制的说明: IDifyDatasetClient

查询文档分段列表

指定者:

getSegments 在接口中 IDifyDatasetClient

参数:

page - 页码

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

datasetId - 知识库 ID

documentId - 文档 ID

keyword - 搜索关键词，可选

status - 搜索状态，completed

返回:

DatasetResponse

抛出:

IOException - 错误

InterruptedException

getSegmentInfo

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

从接口复制的说明: IDifyDatasetClient

查询文档分段详情

指定者:

getSegmentInfo 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

documentId - 文档 ID

segmentId - 文档分段 ID

返回:

DatasetResponse

抛出:

IOException - 错误

InterruptedException

deleteSegment

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

从接口复制的说明: IDifyDatasetClient

删除文档分段

指定者:

deleteSegment 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

documentId - 文档 ID

segmentId - 文档分段 ID

抛出:

IOException - 错误

InterruptedException

updateDocumentMeta

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

从接口复制的说明: IDifyDatasetClient

更新文档元数据

指定者:

updateDocumentMeta 在接口中 IDifyDatasetClient

参数:

datasetId - 知识库 ID

updateDocumentMetadata - 文档元数据

抛出:

IOException - 错误

InterruptedException