Package io.github.guoshiqiufeng.dify.dataset

Interface DifyDataset

All Known Implementing Classes:
DifyDatasetClientImpl
public interface DifyDataset
Since:
2025/3/13 11:33
Version:
1.0
Author:
yanghq

  • Method Details

    • create

      DatasetResponse create(DatasetCreateRequest request)
      创建 知识库。
      Parameters:
      request - 知识库创建请求对象，包含创建 知识库所需的信息。
      Returns:
      返回创建的 知识库响应对象。

    • page

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<DatasetResponse> page(DatasetPageRequest request)
      分页查询 知识库列表。
      Parameters:
      request - 分页查询请求对象，包含分页参数和查询条件。
      Returns:
      返回分页查询结果，包含 知识库信息列表和分页信息。

    • info

      DatasetInfoResponse info(DatasetInfoRequest request)
      知识库详情
      Parameters:
      request - 知识库详情查询请求对象
      Returns:
      知识库详情

    • update

      DatasetInfoResponse update(DatasetUpdateRequest request)
      修改知识库
      Parameters:
      request - 请求对象
      Returns:
      知识库详情

    • delete

      default void delete(String datasetId)
      删除指定 知识库。
      Parameters:
      datasetId - 知识库的唯一标识符。

    • delete

      void delete(String datasetId, String apiKey)
      删除指定 知识库。
      Parameters:
      datasetId - 知识库的唯一标识符。
      apiKey - 知识库的唯一标识符。

    • createDocumentByText

      DocumentCreateResponse createDocumentByText(DocumentCreateByTextRequest request)
      通过文本创建文档。
      Parameters:
      request - 文档创建请求对象，包含通过文本创建文档所需的信息。
      Returns:
      返回文档创建响应对象。

    • createDocumentByFile

      DocumentCreateResponse createDocumentByFile(DocumentCreateByFileRequest request)
      通过文件创建文档。
      Parameters:
      request - 文档创建请求对象，包含通过文件创建文档所需的信息。
      Returns:
      返回文档创建响应对象。

    • updateDocumentByText

      DocumentCreateResponse updateDocumentByText(DocumentUpdateByTextRequest request)
      通过文本更新文档。
      Parameters:
      request - 文档更新请求对象，包含通过文本更新文档所需的信息。
      Returns:
      返回文档更新响应对象。

    • updateDocumentByFile

      DocumentCreateResponse updateDocumentByFile(DocumentUpdateByFileRequest request)
      通过文件更新文档。
      Parameters:
      request - 文档更新请求对象，包含通过文件更新文档所需的信息。
      Returns:
      返回文档更新响应对象。

    • pageDocument

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<DocumentInfo> pageDocument(DatasetPageDocumentRequest request)
      分页查询文档列表。
      Parameters:
      request - 分页查询请求对象，包含分页参数和查询条件。
      Returns:
      返回分页查询结果，包含文档信息列表和分页信息。

    • indexingStatus

      DocumentIndexingStatusResponse indexingStatus(DocumentIndexingStatusRequest request)
      查询文档索引状态。
      Parameters:
      request - 索引状态查询请求对象，包含查询所需的信息。
      Returns:
      返回文档索引状态响应对象。

    • deleteDocument

      default void deleteDocument(String datasetId, String documentId)
      删除指定文档。
      Parameters:
      datasetId - 知识库的唯一标识符。
      documentId - 文档的唯一标识符。

    • deleteDocument

      void deleteDocument(String datasetId, String documentId, String apiKey)
      删除指定文档。
      Parameters:
      datasetId - 知识库的唯一标识符。
      documentId - 文档的唯一标识符。
      apiKey - apiKey

    • createSegment

      SegmentResponse createSegment(SegmentCreateRequest request)
      创建分段。
      Parameters:
      request - 分段创建请求对象，包含创建分段所需的信息。
      Returns:
      返回分段创建响应对象。

    • pageSegment

      SegmentResponse pageSegment(SegmentPageRequest request)
      分页查询分段列表。
      Parameters:
      request - 分页查询请求对象，包含分页参数和查询条件。
      Returns:
      返回分段分页查询响应对象。

    • deleteSegment

      default void deleteSegment(String datasetId, String documentId, String segmentId)
      删除指定分段。
      Parameters:
      datasetId - 知识库的唯一标识符。
      documentId - 文档的唯一标识符。
      segmentId - 分段的唯一标识符。

    • deleteSegment

      void deleteSegment(String datasetId, String documentId, String segmentId, String apiKey)
      删除指定分段。
      Parameters:
      datasetId - 知识库的唯一标识符。
      documentId - 文档的唯一标识符。
      segmentId - 分段的唯一标识符。
      apiKey - apiKey

    • updateSegment

      SegmentUpdateResponse updateSegment(SegmentUpdateRequest request)
      更新分段。
      Parameters:
      request - 分段更新请求对象，包含更新分段所需的信息。
      Returns:
      返回分段更新响应对象。

    • createSegmentChildChunk

      SegmentChildChunkCreateResponse createSegmentChildChunk(SegmentChildChunkCreateRequest request)
      创建子分段
      Parameters:
      request - 子分段创建请求对象，包含创建分段所需的信息。
      Returns:
      返回子分段响应对象

    • pageSegmentChildChunk

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<SegmentChildChunkResponse> pageSegmentChildChunk(SegmentChildChunkPageRequest request)
      分页查询子分段列表
      Parameters:
      request - 子分段分页查询请求对象，包含分页参数和查询条件。
      Returns:
      返回子分段分页查询响应对象

    • deleteSegmentChildChunk

      void deleteSegmentChildChunk(SegmentChildChunkDeleteRequest request)
      删除指定子分段
      Parameters:
      request - 子分段删除请求对象

    • updateSegmentChildChunk

      SegmentChildChunkUpdateResponse updateSegmentChildChunk(SegmentChildChunkUpdateRequest request)
      更新子分段
      Parameters:
      request - 子分段更新请求对象，包含更新子分段所需的信息。
      Returns:
      返回子分段更新响应对象

    • uploadFileInfo

      default UploadFileInfoResponse uploadFileInfo(String datasetId, String documentId)
      获取上传文件信息。
      Parameters:
      datasetId - 知识库的唯一标识符。
      documentId - 文档的唯一标识符。
      Returns:
      返回上传文件信息响应对象。

    • uploadFileInfo

      UploadFileInfoResponse uploadFileInfo(String datasetId, String documentId, String apiKey)
      获取上传文件信息。
      Parameters:
      datasetId - 知识库的唯一标识符。
      documentId - 文档的唯一标识符。
      apiKey - apiKey
      Returns:
      返回上传文件信息响应对象。

    • retrieve

      RetrieveResponse retrieve(RetrieveRequest request)
      检索数据。
      Parameters:
      request - 检索请求对象，包含检索所需的信息。
      Returns:
      返回检索响应对象。

    • createMetaData

      MetaDataResponse createMetaData(MetaDataCreateRequest request)
      创建元数据
      Parameters:
      request - 元数据创建请求参数（需包含数据集ID和元数据内容）
      Returns:
      创建成功的元数据详情

    • updateMetaData

      MetaDataResponse updateMetaData(MetaDataUpdateRequest request)
      更新元数据
      Parameters:
      request - 元数据更新请求参数（需包含元数据ID和更新内容）
      Returns:
      更新后的元数据详情
      Throws:
      IllegalArgumentException - 参数校验异常

    • deleteMetaData

      default void deleteMetaData(String datasetId, String metadataId)
      删除元数据
      Parameters:
      datasetId - 数据集ID
      metadataId - 元数据ID

    • deleteMetaData

      void deleteMetaData(String datasetId, String metadataId, String apiKey)
      删除元数据
      Parameters:
      datasetId - 数据集ID
      metadataId - 元数据ID
      apiKey - apiKey

    • actionMetaData

      void actionMetaData(MetaDataActionRequest request)
      执行元数据业务操作（如启用/禁用等）
      Parameters:
      request - 操作请求参数（需包含操作类型和目标元数据ID）

    • updateDocumentMetaData

      void updateDocumentMetaData(DocumentMetaDataUpdateRequest request)
      更新文档关联的元数据
      Parameters:
      request - 文档元数据更新请求（需包含文档ID和元数据变更内容）

    • listMetaData

      default MetaDataListResponse listMetaData(String datasetId)
      获取数据集元数据列表
      Parameters:
      datasetId - 数据集ID
      Returns:
      元数据列表及分页信息

    • listMetaData

      MetaDataListResponse listMetaData(String datasetId, String apiKey)
      获取数据集元数据列表
      Parameters:
      datasetId - 数据集ID
      apiKey - apiKey
      Returns:
      元数据列表及分页信息

    • listTextEmbedding

      default TextEmbeddingListResponse listTextEmbedding()
      获取嵌入模型列表
      Returns:
      嵌入模型列表

    • listTextEmbedding

      TextEmbeddingListResponse listTextEmbedding(String apiKey)
      获取嵌入模型列表
      Parameters:
      apiKey - apiKey
      Returns:
      嵌入模型列表

    • listRerank

      default TextEmbeddingListResponse listRerank()
      Lists all rerank
      Returns:
      The rerank list response
      Since:
      1.2.0

    • listRerank

      TextEmbeddingListResponse listRerank(String apiKey)
      Lists all rerank
      Parameters:
      apiKey - The API key for authentication and authorization to the Dify API
      Returns:
      The rerank list response
      Since:
      1.2.0

    • createTag

      TagInfoResponse createTag(TagCreateRequest request)
      Create a new tag
      Parameters:
      request - Tag creation request containing tag information
      Returns:
      TagInfoResponse containing the created tag details
      Since:
      1.3.0

    • listTag

      default List<TagInfoResponse> listTag()
      List all tags
      Returns:
      List of TagInfoResponse containing all tag information
      Since:
      1.3.0

    • listTag

      List<TagInfoResponse> listTag(String apiKey)
      List all tags
      Parameters:
      apiKey - The API key for authentication and authorization to the Dify API
      Returns:
      List of TagInfoResponse containing all tag information
      Since:
      1.3.0

    • updateTag

      TagInfoResponse updateTag(TagUpdateRequest request)
      Update an existing tag
      Parameters:
      request - Tag update request containing updated tag information
      Returns:
      TagInfoResponse containing the updated tag details
      Since:
      1.3.0

    • deleteTag

      default void deleteTag(String tagId)
      Delete a tag by tag ID (default method using null API key)
      Parameters:
      tagId - ID of the tag to be deleted
      Since:
      1.3.0

    • deleteTag

      void deleteTag(String tagId, String apiKey)
      Delete a tag by tag ID with API key authentication
      Parameters:
      tagId - ID of the tag to be deleted
      apiKey - API key for authentication (can be null)
      Since:
      1.3.0

    • bindingTag

      void bindingTag(TagBindingRequest request)
      Bind tags to a resource (such as dataset, model, etc.)
      Parameters:
      request - Tag binding request containing binding information
      Since:
      1.3.0

    • unbindingTag

      void unbindingTag(TagUnbindingRequest request)
      Unbind tags from a resource
      Parameters:
      request - Tag unbinding request containing unbinding information
      Since:
      1.3.0

    • listDatasetTag

      default DataSetTagsResponse listDatasetTag(String datasetId)
      List all tags associated with a specific dataset
      Parameters:
      datasetId - ID of the dataset to query tags for
      Returns:
      DataSetTagsResponse containing dataset tag information
      Since:
      1.3.0

    • listDatasetTag

      DataSetTagsResponse listDatasetTag(String datasetId, String apiKey)
      List all tags associated with a specific dataset
      Parameters:
      datasetId - ID of the dataset to query tags for
      apiKey - API key for authentication
      Returns:
      DataSetTagsResponse containing dataset tag information
      Since:
      1.3.0

    • changeDocumentStatus

      default DatasetStatusResponse changeDocumentStatus(String datasetId, Set<String> documentIds, DocActionEnum status)
      更新指定文档状态。
      Parameters:
      datasetId - 知识库的唯一标识符。
      documentIds - 文档的唯一标识符。
      status - 状态
      Returns:
      结果 默认成功
      Since:
      1.3.3

    • changeDocumentStatus

      DatasetStatusResponse changeDocumentStatus(String datasetId, Set<String> documentIds, DocActionEnum status, String apiKey)
      更新指定文档状态。
      Parameters:
      datasetId - 知识库的唯一标识符。
      documentIds - 文档的唯一标识符。
      status - 状态
      apiKey - apiKey
      Returns:
      结果 默认成功
      Since:
      1.3.3