Package io.github.guoshiqiufeng.dify.client.spring5.dataset

Class DifyDatasetDefaultClient

java.lang.Object
io.github.guoshiqiufeng.dify.client.spring5.base.BaseDifyDefaultClient
io.github.guoshiqiufeng.dify.client.spring5.dataset.DifyDatasetDefaultClient
All Implemented Interfaces:
io.github.guoshiqiufeng.dify.core.client.BaseDifyClient, io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient
public class DifyDatasetDefaultClient extends BaseDifyDefaultClient implements io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient
Since:
2025/4/8 13:46
Version:
0.8.0
Author:
yanghq

  • Field Summary

    Fields inherited from class io.github.guoshiqiufeng.dify.client.spring5.base.BaseDifyDefaultClient

    responseErrorHandler, webClient

    Fields inherited from interface io.github.guoshiqiufeng.dify.core.client.BaseDifyClient

    DEFAULT_BASE_URL, REQUEST_BODY_NULL_ERROR

  • Constructor Summary

    Constructors
    Constructor
    Description
    DifyDatasetDefaultClient()
     
    DifyDatasetDefaultClient(String baseUrl)
     
    DifyDatasetDefaultClient(String baseUrl, io.github.guoshiqiufeng.dify.core.config.DifyProperties.ClientConfig clientConfig, org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    actionMetaData(io.github.guoshiqiufeng.dify.dataset.dto.request.MetaDataActionRequest request)
     
    void
    bindingTag(io.github.guoshiqiufeng.dify.dataset.dto.request.TagBindingRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetStatusResponse
    changeDocumentStatus(String datasetId, Set<String> documentIds, io.github.guoshiqiufeng.dify.dataset.enums.document.DocActionEnum status, String apiKey)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetResponse
    create(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetCreateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentCreateResponse
    createDocumentByFile(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentCreateByFileRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentCreateResponse
    createDocumentByText(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentCreateByTextRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.MetaDataResponse
    createMetaData(io.github.guoshiqiufeng.dify.dataset.dto.request.MetaDataCreateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentResponse
    createSegment(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentCreateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentChildChunkCreateResponse
    createSegmentChildChunk(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentChildChunkCreateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.TagInfoResponse
    createTag(io.github.guoshiqiufeng.dify.dataset.dto.request.TagCreateRequest request)
     
    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(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentChildChunkDeleteRequest request)
     
    void
    deleteTag(String tagId, String apiKey)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentIndexingStatusResponse
    indexingStatus(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentIndexingStatusRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetInfoResponse
    info(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetInfoRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DataSetTagsResponse
    listDatasetTag(String datasetId, String apiKey)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.MetaDataListResponse
    listMetaData(String datasetId, String apiKey)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.TextEmbeddingListResponse
    listRerank(String apiKey)
     
    List<io.github.guoshiqiufeng.dify.dataset.dto.response.TagInfoResponse>
    listTag(String apiKey)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.TextEmbeddingListResponse
    listTextEmbedding(String apiKey)
     
    io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetResponse>
    page(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetPageRequest request)
     
    io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentInfo>
    pageDocument(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetPageDocumentRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentResponse
    pageSegment(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentPageRequest request)
     
    io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentChildChunkResponse>
    pageSegmentChildChunk(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentChildChunkPageRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.RetrieveResponse
    retrieve(io.github.guoshiqiufeng.dify.dataset.dto.request.RetrieveRequest request)
     
    void
    unbindingTag(io.github.guoshiqiufeng.dify.dataset.dto.request.TagUnbindingRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetInfoResponse
    update(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetUpdateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentCreateResponse
    updateDocumentByFile(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentUpdateByFileRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentCreateResponse
    updateDocumentByText(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentUpdateByTextRequest request)
     
    void
    updateDocumentMetaData(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentMetaDataUpdateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.MetaDataResponse
    updateMetaData(io.github.guoshiqiufeng.dify.dataset.dto.request.MetaDataUpdateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentUpdateResponse
    updateSegment(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentUpdateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentChildChunkUpdateResponse
    updateSegmentChildChunk(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentChildChunkUpdateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.TagInfoResponse
    updateTag(io.github.guoshiqiufeng.dify.dataset.dto.request.TagUpdateRequest request)
     
    io.github.guoshiqiufeng.dify.dataset.dto.response.UploadFileInfoResponse
    uploadFileInfo(String datasetId, String documentId, String apiKey)
     

    Methods inherited from class io.github.guoshiqiufeng.dify.client.spring5.base.BaseDifyDefaultClient

    getWebClient

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DifyDatasetDefaultClient

      public DifyDatasetDefaultClient()

    • DifyDatasetDefaultClient

      public DifyDatasetDefaultClient(String baseUrl)

    • DifyDatasetDefaultClient

      public DifyDatasetDefaultClient(String baseUrl, io.github.guoshiqiufeng.dify.core.config.DifyProperties.ClientConfig clientConfig, org.springframework.web.reactive.function.client.WebClient.Builder webClientBuilder)

  • Method Details

    • create

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetResponse create(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetCreateRequest request)
      Specified by:
      create in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • page

      public io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetResponse> page(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetPageRequest request)
      Specified by:
      page in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • info

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetInfoResponse info(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetInfoRequest request)
      Specified by:
      info in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • update

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetInfoResponse update(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetUpdateRequest request)
      Specified by:
      update in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • delete

      public void delete(String datasetId, String apiKey)
      Specified by:
      delete in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • createDocumentByText

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentCreateResponse createDocumentByText(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentCreateByTextRequest request)
      Specified by:
      createDocumentByText in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • createDocumentByFile

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentCreateResponse createDocumentByFile(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentCreateByFileRequest request)
      Specified by:
      createDocumentByFile in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • updateDocumentByText

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentCreateResponse updateDocumentByText(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentUpdateByTextRequest request)
      Specified by:
      updateDocumentByText in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • updateDocumentByFile

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentCreateResponse updateDocumentByFile(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentUpdateByFileRequest request)
      Specified by:
      updateDocumentByFile in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • pageDocument

      public io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentInfo> pageDocument(io.github.guoshiqiufeng.dify.dataset.dto.request.DatasetPageDocumentRequest request)
      Specified by:
      pageDocument in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • indexingStatus

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DocumentIndexingStatusResponse indexingStatus(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentIndexingStatusRequest request)
      Specified by:
      indexingStatus in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • deleteDocument

      public void deleteDocument(String datasetId, String documentId, String apiKey)
      Specified by:
      deleteDocument in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • createSegment

      public io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentResponse createSegment(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentCreateRequest request)
      Specified by:
      createSegment in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • pageSegment

      public io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentResponse pageSegment(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentPageRequest request)
      Specified by:
      pageSegment in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • deleteSegment

      public void deleteSegment(String datasetId, String documentId, String segmentId, String apiKey)
      Specified by:
      deleteSegment in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • updateSegment

      public io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentUpdateResponse updateSegment(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentUpdateRequest request)
      Specified by:
      updateSegment in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • createSegmentChildChunk

      public io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentChildChunkCreateResponse createSegmentChildChunk(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentChildChunkCreateRequest request)
      Specified by:
      createSegmentChildChunk in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • pageSegmentChildChunk

      public io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentChildChunkResponse> pageSegmentChildChunk(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentChildChunkPageRequest request)
      Specified by:
      pageSegmentChildChunk in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • deleteSegmentChildChunk

      public void deleteSegmentChildChunk(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentChildChunkDeleteRequest request)
      Specified by:
      deleteSegmentChildChunk in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • updateSegmentChildChunk

      public io.github.guoshiqiufeng.dify.dataset.dto.response.SegmentChildChunkUpdateResponse updateSegmentChildChunk(io.github.guoshiqiufeng.dify.dataset.dto.request.SegmentChildChunkUpdateRequest request)
      Specified by:
      updateSegmentChildChunk in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • uploadFileInfo

      public io.github.guoshiqiufeng.dify.dataset.dto.response.UploadFileInfoResponse uploadFileInfo(String datasetId, String documentId, String apiKey)
      Specified by:
      uploadFileInfo in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • retrieve

      public io.github.guoshiqiufeng.dify.dataset.dto.response.RetrieveResponse retrieve(io.github.guoshiqiufeng.dify.dataset.dto.request.RetrieveRequest request)
      Specified by:
      retrieve in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • createMetaData

      public io.github.guoshiqiufeng.dify.dataset.dto.response.MetaDataResponse createMetaData(io.github.guoshiqiufeng.dify.dataset.dto.request.MetaDataCreateRequest request)
      Specified by:
      createMetaData in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • updateMetaData

      public io.github.guoshiqiufeng.dify.dataset.dto.response.MetaDataResponse updateMetaData(io.github.guoshiqiufeng.dify.dataset.dto.request.MetaDataUpdateRequest request)
      Specified by:
      updateMetaData in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • deleteMetaData

      public void deleteMetaData(String datasetId, String metadataId, String apiKey)
      Specified by:
      deleteMetaData in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • actionMetaData

      public void actionMetaData(io.github.guoshiqiufeng.dify.dataset.dto.request.MetaDataActionRequest request)
      Specified by:
      actionMetaData in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • updateDocumentMetaData

      public void updateDocumentMetaData(io.github.guoshiqiufeng.dify.dataset.dto.request.DocumentMetaDataUpdateRequest request)
      Specified by:
      updateDocumentMetaData in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • listMetaData

      public io.github.guoshiqiufeng.dify.dataset.dto.response.MetaDataListResponse listMetaData(String datasetId, String apiKey)
      Specified by:
      listMetaData in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • listTextEmbedding

      public io.github.guoshiqiufeng.dify.dataset.dto.response.TextEmbeddingListResponse listTextEmbedding(String apiKey)
      Specified by:
      listTextEmbedding in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • listRerank

      public io.github.guoshiqiufeng.dify.dataset.dto.response.TextEmbeddingListResponse listRerank(String apiKey)
      Specified by:
      listRerank in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • createTag

      public io.github.guoshiqiufeng.dify.dataset.dto.response.TagInfoResponse createTag(io.github.guoshiqiufeng.dify.dataset.dto.request.TagCreateRequest request)
      Specified by:
      createTag in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • listTag

      public List<io.github.guoshiqiufeng.dify.dataset.dto.response.TagInfoResponse> listTag(String apiKey)
      Specified by:
      listTag in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • updateTag

      public io.github.guoshiqiufeng.dify.dataset.dto.response.TagInfoResponse updateTag(io.github.guoshiqiufeng.dify.dataset.dto.request.TagUpdateRequest request)
      Specified by:
      updateTag in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • deleteTag

      public void deleteTag(String tagId, String apiKey)
      Specified by:
      deleteTag in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • bindingTag

      public void bindingTag(io.github.guoshiqiufeng.dify.dataset.dto.request.TagBindingRequest request)
      Specified by:
      bindingTag in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • unbindingTag

      public void unbindingTag(io.github.guoshiqiufeng.dify.dataset.dto.request.TagUnbindingRequest request)
      Specified by:
      unbindingTag in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • listDatasetTag

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DataSetTagsResponse listDatasetTag(String datasetId, String apiKey)
      Specified by:
      listDatasetTag in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient

    • changeDocumentStatus

      public io.github.guoshiqiufeng.dify.dataset.dto.response.DatasetStatusResponse changeDocumentStatus(String datasetId, Set<String> documentIds, io.github.guoshiqiufeng.dify.dataset.enums.document.DocActionEnum status, String apiKey)
      Specified by:
      changeDocumentStatus in interface io.github.guoshiqiufeng.dify.dataset.client.DifyDatasetClient