类 DefaultDifyDatasetsClient
java.lang.Object
io.github.imfangs.dify.client.impl.AbstractDifyClient
io.github.imfangs.dify.client.impl.DefaultDifyDatasetsClient
- 所有已实现的接口:
DifyDatasetsClient
Dify 知识库客户端默认实现
提供知识库相关的操作
-
字段概要
从类继承的字段 io.github.imfangs.dify.client.impl.AbstractDifyClient
apiKey, AUDIO, baseUrl, httpClient, JSON, OCTET_STREAM -
构造器概要
构造器构造器说明DefaultDifyDatasetsClient(String baseUrl, String apiKey) 构造函数DefaultDifyDatasetsClient(String baseUrl, String apiKey, okhttp3.OkHttpClient httpClient) 构造函数 -
方法概要
修饰符和类型方法说明bindTags(TagBindRequest request) 绑定知识库到知识库类型标签builtInMetadata(String datasetId, String action) 启用/禁用内置元数据createChildChunk(String datasetId, String documentId, String segmentId, SaveChildChunkRequest request) 创建子分段createDataset(CreateDatasetRequest request) 创建空知识库createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, File file) 通过文件创建文档createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, InputStream inputStream, String fileName) 通过文件创建文档createDocumentByText(String datasetId, CreateDocumentByTextRequest request) 通过文本创建文档createMetadata(String datasetId, CreateMetadataRequest request) 新增元数据createSegments(String datasetId, String documentId, CreateSegmentsRequest request) 新增文档分段createTag(CreateTagRequest request) 新增知识库类型标签voiddeleteChildChunks(String datasetId, String documentId, String segmentId, String childChunkId) 删除子分段deleteDataset(String datasetId) 删除知识库voiddeleteDocument(String datasetId, String documentId) 删除文档deleteMetadata(String datasetId, String metadataId) 删除元数据voiddeleteSegment(String datasetId, String documentId, String segmentId) 删除文档分段deleteTag(DeleteTagRequest request) 删除知识库类型标签getChildChunks(String datasetId, String documentId, String segmentId, String keyword, Integer page, Integer limit) 获取子分段getDataset(String datasetId) 获取知识库详情getDatasets(Integer page, Integer limit) 获取知识库列表getDatasets(String keyword, Integer page, Integer limit) 根据关键词搜索知识库列表获取知识库列表(支持高级查询参数)getDatasetsByTags(List<String> tagIds, Integer page, Integer limit) 根据标签ID列表获取知识库列表getDatasetTags(String datasetId) 查询知识库已绑定的标签getDocMetadataList(String datasetId) 查询知识库元数据列表getDocumentDetail(String datasetId, String documentId, String metadata) 获取文档详情getDocuments(String datasetId, String keyword, Integer page, Integer limit) 获取知识库文档列表获取嵌入模型列表getIndexingStatus(String datasetId, String batch) 获取文档嵌入状态getSegment(String datasetId, String documentId, String segmentId) 查看文档分段详情getSegments(String datasetId, String documentId, String keyword, String status) 查询文档分段getSegments(String datasetId, String documentId, String keyword, String status, Integer page, Integer limit) 查询文档分段getTags()获取知识库类型标签列表getUploadFile(String datasetId, String documentId) 获取上传文件retrieveDataset(String datasetId, RetrieveRequest request) 检索知识库unbindTag(TagUnbindRequest request) 解绑知识库和知识库类型标签updateChildChunk(String datasetId, String documentId, String segmentId, String childChunkId, SaveChildChunkRequest request) 更新子分段updateDataset(String datasetId, UpdateDatasetRequest request) 更新知识库updateDocumentByFile(String datasetId, String documentId, UpdateDocumentByFileRequest request, File file) 通过文件更新文档updateDocumentByText(String datasetId, String documentId, UpdateDocumentByTextRequest request) 通过文本更新文档updateDocumentMetadata(String datasetId, List<OperationData> operationDataList) 更新文档元数据updateDocumentStatus(String datasetId, String action, UpdateDocumentStatusRequest request) 更新文档状态updateMetadata(String datasetId, String metadataId, UpdateMetadataRequest request) 更新元数据updateSegment(String datasetId, String documentId, String segmentId, UpdateSegmentRequest request) 更新文档分段updateTag(UpdateTagRequest request) 修改知识库类型标签名称从类继承的方法 io.github.imfangs.dify.client.impl.AbstractDifyClient
addIfNotEmpty, addIfNotNull, buildUrlWithMultiValueParams, buildUrlWithParams, createApiException, createDeleteRequest, createGetRequest, createJsonRequestBody, createPatchRequest, createPostRequest, createPutRequest, executeDelete, executeGet, executePatch, executePost, executePut, executeRequest, executeRequestForBytes, handleResponse
-
构造器详细资料
-
DefaultDifyDatasetsClient
构造函数- 参数:
baseUrl- API基础URLapiKey- API密钥
-
DefaultDifyDatasetsClient
构造函数- 参数:
baseUrl- API基础URLapiKey- API密钥httpClient- HTTP客户端
-
-
方法详细资料
-
createDataset
public DatasetResponse createDataset(CreateDatasetRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient创建空知识库- 指定者:
createDataset在接口中DifyDatasetsClient- 参数:
request- 创建知识库请求- 返回:
- 知识库信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getDatasets
public DatasetListResponse getDatasets(Integer page, Integer limit) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient获取知识库列表- 指定者:
getDatasets在接口中DifyDatasetsClient- 参数:
page- 页码limit- 每页数量- 返回:
- 知识库列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getDatasets
public DatasetListResponse getDatasets(String keyword, List<String> tagIds, Integer page, Integer limit, Boolean includeAll) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient获取知识库列表(支持高级查询参数)- 指定者:
getDatasets在接口中DifyDatasetsClient- 参数:
keyword- 搜索关键词,可选tagIds- 标签 ID 列表,可选page- 页码,可选,默认为 1limit- 每页数量,可选,默认 20,范围 1-100includeAll- 是否包含所有数据集(仅对所有者生效),可选,默认为 false- 返回:
- 知识库列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getDatasets
public DatasetListResponse getDatasets(String keyword, Integer page, Integer limit) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient根据关键词搜索知识库列表- 指定者:
getDatasets在接口中DifyDatasetsClient- 参数:
keyword- 搜索关键词page- 页码limit- 每页数量- 返回:
- 知识库列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getDatasetsByTags
public DatasetListResponse getDatasetsByTags(List<String> tagIds, Integer page, Integer limit) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient根据标签ID列表获取知识库列表- 指定者:
getDatasetsByTags在接口中DifyDatasetsClient- 参数:
tagIds- 标签 ID 列表page- 页码limit- 每页数量- 返回:
- 知识库列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getDataset
从接口复制的说明:DifyDatasetsClient获取知识库详情- 指定者:
getDataset在接口中DifyDatasetsClient- 参数:
datasetId- 知识库ID- 返回:
- 知识库详情
- 抛出:
IOException- IO异常DifyApiException- API异常
-
updateDataset
public DatasetResponse updateDataset(String datasetId, UpdateDatasetRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient更新知识库- 指定者:
updateDataset在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDrequest- 更新请求- 返回:
- 更新后的知识库信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
deleteDataset
从接口复制的说明:DifyDatasetsClient删除知识库- 指定者:
deleteDataset在接口中DifyDatasetsClient- 参数:
datasetId- 知识库ID- 返回:
- 响应
- 抛出:
IOException- IO异常DifyApiException- API异常
-
createDocumentByText
public DocumentResponse createDocumentByText(String datasetId, CreateDocumentByTextRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient通过文本创建文档- 指定者:
createDocumentByText在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDrequest- 创建文档请求- 返回:
- 文档信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
createDocumentByFile
public DocumentResponse createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, File file) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient通过文件创建文档- 指定者:
createDocumentByFile在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDrequest- 创建文档请求file- 文件- 返回:
- 文档信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
createDocumentByFile
public DocumentResponse createDocumentByFile(String datasetId, CreateDocumentByFileRequest request, InputStream inputStream, String fileName) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient通过文件创建文档- 指定者:
createDocumentByFile在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDrequest- 创建文档请求inputStream- 文件输入流fileName- 文件名- 返回:
- 文档信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
updateDocumentByText
public DocumentResponse updateDocumentByText(String datasetId, String documentId, UpdateDocumentByTextRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient通过文本更新文档- 指定者:
updateDocumentByText在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDrequest- 更新文档请求- 返回:
- 文档信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
updateDocumentByFile
public DocumentResponse updateDocumentByFile(String datasetId, String documentId, UpdateDocumentByFileRequest request, File file) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient通过文件更新文档- 指定者:
updateDocumentByFile在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDrequest- 更新文档请求file- 文件- 返回:
- 文档信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getIndexingStatus
public IndexingStatusResponse getIndexingStatus(String datasetId, String batch) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient获取文档嵌入状态- 指定者:
getIndexingStatus在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDbatch- 批次号- 返回:
- 文档嵌入状态
- 抛出:
IOException- IO异常DifyApiException- API异常
-
deleteDocument
public void deleteDocument(String datasetId, String documentId) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient删除文档- 指定者:
deleteDocument在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档ID- 抛出:
IOException- IO异常DifyApiException- API异常
-
getDocuments
public DocumentListResponse getDocuments(String datasetId, String keyword, Integer page, Integer limit) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient获取知识库文档列表- 指定者:
getDocuments在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDkeyword- 关键词page- 页码limit- 每页数量- 返回:
- 文档列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getDocumentDetail
public DetailedDocumentResponse getDocumentDetail(String datasetId, String documentId, String metadata) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient获取文档详情- 指定者:
getDocumentDetail在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDmetadata- 元数据过滤条件 all, only, 或者 without. 默认是 all- 返回:
- 文档详情
- 抛出:
IOException- IO异常DifyApiException- API异常
-
updateDocumentStatus
public SimpleResponse updateDocumentStatus(String datasetId, String action, UpdateDocumentStatusRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient更新文档状态- 指定者:
updateDocumentStatus在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDaction- 操作类型:enable - 启用文档, disable - 禁用文档, archive - 归档文档, un_archive - 取消归档文档request- 更新文档状态请求- 返回:
- 响应
- 抛出:
IOException- IO异常DifyApiException- API异常
-
createSegments
public SegmentListResponse createSegments(String datasetId, String documentId, CreateSegmentsRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient新增文档分段- 指定者:
createSegments在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDrequest- 新增分段请求- 返回:
- 分段信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getSegments
public SegmentListResponse getSegments(String datasetId, String documentId, String keyword, String status) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient查询文档分段- 指定者:
getSegments在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDkeyword- 关键词status- 状态- 返回:
- 分段列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getSegments
public SegmentListResponse getSegments(String datasetId, String documentId, String keyword, String status, Integer page, Integer limit) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient查询文档分段- 指定者:
getSegments在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDkeyword- 关键词status- 状态page- 页码limit- 每页数量- 返回:
- 分段列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getSegment
public SegmentResponse getSegment(String datasetId, String documentId, String segmentId) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient查看文档分段详情- 指定者:
getSegment在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDsegmentId- 分段ID- 返回:
- 分段详情
- 抛出:
IOException- IO异常DifyApiException- API异常
-
deleteSegment
public void deleteSegment(String datasetId, String documentId, String segmentId) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient删除文档分段注意:官方文档写的返回 { "result": "success" } ,实际返回的是空
- 指定者:
deleteSegment在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDsegmentId- 分段ID- 抛出:
IOException- IO异常DifyApiException- API异常
-
updateSegment
public SegmentResponse updateSegment(String datasetId, String documentId, String segmentId, UpdateSegmentRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient更新文档分段- 指定者:
updateSegment在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDsegmentId- 分段IDrequest- 更新分段请求- 返回:
- 分段信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
createChildChunk
public ChildChunkResponse createChildChunk(String datasetId, String documentId, String segmentId, SaveChildChunkRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient创建子分段- 指定者:
createChildChunk在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDsegmentId- 分段IDrequest- 子分段请求- 返回:
- 子分段信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getChildChunks
public ChildChunkListResponse getChildChunks(String datasetId, String documentId, String segmentId, String keyword, Integer page, Integer limit) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient获取子分段- 指定者:
getChildChunks在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDsegmentId- 分段IDkeyword- 关键词page- 页码limit- 每页数量- 返回:
- 子分段列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
deleteChildChunks
public void deleteChildChunks(String datasetId, String documentId, String segmentId, String childChunkId) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient删除子分段- 指定者:
deleteChildChunks在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId-segmentId-childChunkId-- 抛出:
IOException- IO异常DifyApiException- API异常
-
updateChildChunk
public ChildChunkResponse updateChildChunk(String datasetId, String documentId, String segmentId, String childChunkId, SaveChildChunkRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient更新子分段- 指定者:
updateChildChunk在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档IDsegmentId- 分段IDchildChunkId- 子分段IDrequest- 子分段请求- 返回:
- 子分段信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getUploadFile
public UploadFileResponse getUploadFile(String datasetId, String documentId) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient获取上传文件- 指定者:
getUploadFile在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDdocumentId- 文档ID- 返回:
- 文件信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
retrieveDataset
public RetrieveResponse retrieveDataset(String datasetId, RetrieveRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient检索知识库- 指定者:
retrieveDataset在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDrequest- 检索请求- 返回:
- 检索结果
- 抛出:
IOException- IO异常DifyApiException- API异常
-
createMetadata
public MetadataResponse createMetadata(String datasetId, CreateMetadataRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient新增元数据- 指定者:
createMetadata在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDrequest- 新增元数据请求- 返回:
- 元数据信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
updateMetadata
public MetadataResponse updateMetadata(String datasetId, String metadataId, UpdateMetadataRequest request) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient更新元数据- 指定者:
updateMetadata在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDmetadataId- 元数据 IDrequest- 更新元数据请求- 返回:
- 元数据信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
deleteMetadata
public String deleteMetadata(String datasetId, String metadataId) throws IOException, DifyApiException 从接口复制的说明:DifyDatasetsClient删除元数据- 指定者:
deleteMetadata在接口中DifyDatasetsClient- 参数:
datasetId- 知识库IDmetadataId- 文档ID- 返回:
- 响应
- 抛出:
IOException- IO异常DifyApiException- API异常
-
builtInMetadata
启用/禁用内置元数据- 指定者:
builtInMetadata在接口中DifyDatasetsClient- 参数:
datasetId- 知识库 IDaction- 动作,只能是 'enable' 或 'disable'- 返回:
- 结果
- 抛出:
IOException- IO异常DifyApiException- Dify API异常
-
updateDocumentMetadata
public SimpleResponse updateDocumentMetadata(String datasetId, List<OperationData> operationDataList) throws IOException, DifyApiException 更新文档元数据- 指定者:
updateDocumentMetadata在接口中DifyDatasetsClient- 参数:
datasetId- 知识库 IDoperationDataList- 文档元数据集合- 返回:
- 结果
- 抛出:
IOException- IO异常DifyApiException- Dify API异常
-
getDocMetadataList
public DocMetadataListResponse getDocMetadataList(String datasetId) throws IOException, DifyApiException 查询知识库元数据列表- 指定者:
getDocMetadataList在接口中DifyDatasetsClient- 参数:
datasetId- 知识库 ID- 返回:
- 响应
- 抛出:
IOException- IO异常DifyApiException- Dify API异常
-
getEmbeddingModelList
获取嵌入模型列表- 指定者:
getEmbeddingModelList在接口中DifyDatasetsClient- 返回:
- 响应
- 抛出:
IOException- IO异常DifyApiException- Dify API异常
-
createTag
从接口复制的说明:DifyDatasetsClient新增知识库类型标签- 指定者:
createTag在接口中DifyDatasetsClient- 参数:
request- 创建标签请求- 返回:
- 标签信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getTags
从接口复制的说明:DifyDatasetsClient获取知识库类型标签列表- 指定者:
getTags在接口中DifyDatasetsClient- 返回:
- 标签列表
- 抛出:
IOException- IO异常DifyApiException- API异常
-
updateTag
从接口复制的说明:DifyDatasetsClient修改知识库类型标签名称- 指定者:
updateTag在接口中DifyDatasetsClient- 参数:
request- 修改标签请求- 返回:
- 标签信息
- 抛出:
IOException- IO异常DifyApiException- API异常
-
deleteTag
从接口复制的说明:DifyDatasetsClient删除知识库类型标签- 指定者:
deleteTag在接口中DifyDatasetsClient- 参数:
request- 删除标签请求- 返回:
- 响应
- 抛出:
IOException- IO异常DifyApiException- API异常
-
bindTags
从接口复制的说明:DifyDatasetsClient绑定知识库到知识库类型标签- 指定者:
bindTags在接口中DifyDatasetsClient- 参数:
request- 标签绑定请求- 返回:
- 响应
- 抛出:
IOException- IO异常DifyApiException- API异常
-
unbindTag
从接口复制的说明:DifyDatasetsClient解绑知识库和知识库类型标签- 指定者:
unbindTag在接口中DifyDatasetsClient- 参数:
request- 标签解绑请求- 返回:
- 响应
- 抛出:
IOException- IO异常DifyApiException- API异常
-
getDatasetTags
从接口复制的说明:DifyDatasetsClient查询知识库已绑定的标签- 指定者:
getDatasetTags在接口中DifyDatasetsClient- 参数:
datasetId- 知识库ID- 返回:
- 标签列表响应
- 抛出:
IOException- IO异常DifyApiException- API异常
-