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

Interface DifyDatasetClient

public interface DifyDatasetClient
Dify Dataset Client Interface Provides methods to interact with Dify's dataset API for managing datasets, documents, segments, and related operations.
Since:
2025/4/8 13:46
Version:
0.8.0
Author:
yanghq

  • Method Details

    • create

      DatasetResponse create(DatasetCreateRequest request)
      Creates a new dataset
      Parameters:
      request - The dataset creation request containing dataset details
      Returns:
      The created dataset response

    • page

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<DatasetResponse> page(DatasetPageRequest request)
      Retrieves a paginated list of datasets
      Parameters:
      request - The request parameters for fetching datasets
      Returns:
      Paginated result containing dataset data

    • info

      DatasetInfoResponse info(DatasetInfoRequest request)
      info
      Parameters:
      request - request parameters
      Returns:
      dataset data

    • update

      DatasetInfoResponse update(DatasetUpdateRequest request)
      update
      Parameters:
      request - request parameters
      Returns:
      dataset data

    • delete

      void delete(String datasetId, String apiKey)
      Deletes a dataset
      Parameters:
      datasetId - The ID of the dataset to delete
      apiKey - The API key for authentication and authorization to the Dify API

    • createDocumentByText

      DocumentCreateResponse createDocumentByText(DocumentCreateByTextRequest request)
      Creates a document in a dataset using text content
      Parameters:
      request - The document creation request containing text data
      Returns:
      The created document response

    • createDocumentByFile

      DocumentCreateResponse createDocumentByFile(DocumentCreateByFileRequest request)
      Creates a document in a dataset using a file
      Parameters:
      request - The document creation request containing file data
      Returns:
      The created document response

    • updateDocumentByText

      DocumentCreateResponse updateDocumentByText(DocumentUpdateByTextRequest request)
      Updates an existing document with new text content
      Parameters:
      request - The document update request containing new text data
      Returns:
      The updated document response

    • updateDocumentByFile

      DocumentCreateResponse updateDocumentByFile(DocumentUpdateByFileRequest request)
      Updates an existing document with a new file
      Parameters:
      request - The document update request containing new file data
      Returns:
      The updated document response

    • pageDocument

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<DocumentInfo> pageDocument(DatasetPageDocumentRequest request)
      Retrieves a paginated list of documents in a dataset
      Parameters:
      request - The request parameters for fetching documents
      Returns:
      Paginated result containing document information

    • indexingStatus

      DocumentIndexingStatusResponse indexingStatus(DocumentIndexingStatusRequest request)
      Checks the indexing status of a document
      Parameters:
      request - The request parameters for checking indexing status
      Returns:
      The document indexing status response

    • deleteDocument

      void deleteDocument(String datasetId, String documentId, String apiKey)
      Deletes a document from a dataset
      Parameters:
      datasetId - The ID of the dataset containing the document
      documentId - The ID of the document to delete
      apiKey - The API key for authentication and authorization to the Dify API

    • createSegment

      SegmentResponse createSegment(SegmentCreateRequest request)
      Creates a segment within a document
      Parameters:
      request - The segment creation request
      Returns:
      The created segment response

    • pageSegment

      SegmentResponse pageSegment(SegmentPageRequest request)
      Retrieves a paginated list of segments
      Parameters:
      request - The request parameters for fetching segments
      Returns:
      The segment response containing paginated segments

    • deleteSegment

      void deleteSegment(String datasetId, String documentId, String segmentId, String apiKey)
      Deletes a segment from a document
      Parameters:
      datasetId - The ID of the dataset containing the document
      documentId - The ID of the document containing the segment
      segmentId - The ID of the segment to delete
      apiKey - The API key for authentication and authorization to the Dify API

    • updateSegment

      SegmentUpdateResponse updateSegment(SegmentUpdateRequest request)
      Updates an existing segment
      Parameters:
      request - The segment update request
      Returns:
      The segment update response

    • createSegmentChildChunk

      SegmentChildChunkCreateResponse createSegmentChildChunk(SegmentChildChunkCreateRequest request)
      Creates a child chunk within a segment
      Parameters:
      request - The segment child chunk creation request
      Returns:
      The segment child chunk creation response

    • pageSegmentChildChunk

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<SegmentChildChunkResponse> pageSegmentChildChunk(SegmentChildChunkPageRequest request)
      Retrieves a paginated list of child chunks within a segment
      Parameters:
      request - The request parameters for fetching segment child chunks
      Returns:
      Paginated result containing segment child chunk data

    • deleteSegmentChildChunk

      void deleteSegmentChildChunk(SegmentChildChunkDeleteRequest request)
      Deletes a child chunk from a segment
      Parameters:
      request - The segment child chunk deletion request

    • updateSegmentChildChunk

      SegmentChildChunkUpdateResponse updateSegmentChildChunk(SegmentChildChunkUpdateRequest request)
      Updates an existing child chunk within a segment
      Parameters:
      request - The segment child chunk update request
      Returns:
      The segment child chunk update response

    • uploadFileInfo

      UploadFileInfoResponse uploadFileInfo(String datasetId, String documentId, String apiKey)
      Retrieves file upload information for a document in a dataset
      Parameters:
      datasetId - The ID of the dataset
      documentId - The ID of the document
      apiKey - The API key for authentication and authorization to the Dify API
      Returns:
      The upload file information response

    • retrieve

      RetrieveResponse retrieve(RetrieveRequest request)
      Retrieves data from the dataset
      Parameters:
      request - The retrieve request parameters
      Returns:
      The retrieve response

    • createMetaData

      MetaDataResponse createMetaData(MetaDataCreateRequest request)
      Creates metadata for a dataset
      Parameters:
      request - The metadata creation request
      Returns:
      The metadata response

    • updateMetaData

      MetaDataResponse updateMetaData(MetaDataUpdateRequest request)
      Updates existing metadata for a dataset
      Parameters:
      request - The metadata update request
      Returns:
      The metadata response

    • deleteMetaData

      void deleteMetaData(String datasetId, String metadataId, String apiKey)
      Deletes metadata from a dataset
      Parameters:
      datasetId - The ID of the dataset
      metadataId - The ID of the metadata to delete
      apiKey - The API key for authentication and authorization to the Dify API

    • actionMetaData

      void actionMetaData(MetaDataActionRequest request)
      Performs an action on metadata
      Parameters:
      request - The metadata action request

    • updateDocumentMetaData

      void updateDocumentMetaData(DocumentMetaDataUpdateRequest request)
      Updates metadata for a document
      Parameters:
      request - The document metadata update request

    • listMetaData

      MetaDataListResponse listMetaData(String datasetId, String apiKey)
      Lists all metadata for a dataset
      Parameters:
      datasetId - The ID of the dataset
      apiKey - The API key for authentication and authorization to the Dify API
      Returns:
      The metadata list response

    • listTextEmbedding

      TextEmbeddingListResponse listTextEmbedding(String apiKey)
      Lists all text embeddings available
      Parameters:
      apiKey - The API key for authentication and authorization to the Dify API
      Returns:
      The text embedding list response

    • 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

    • 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

      List<TagInfoResponse> listTag(String apiKey)
      List all tags
      Parameters:
      apiKey - API key for authentication (can be null)
      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

      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

      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

      DatasetStatusResponse changeDocumentStatus(String datasetId, Set<String> documentIds, DocActionEnum status, String apiKey)
      Change the status of a document
      Parameters:
      datasetId - ID of the dataset containing the document
      documentIds - ID of the document to change status
      status - New status for the document
      apiKey - API key for authentication (can be null)
      Returns:
      DatasetStatusResponse containing the updated document status
      Since:
      1.3.3