程序包 io.github.chatpass.dify.api

类 DifyDatasetsApi

java.lang.Object
io.github.chatpass.dify.api.BaseApi
io.github.chatpass.dify.api.DifyDatasetsApi
public class DifyDatasetsApi extends BaseApi

  • 构造器详细资料

    • DifyDatasetsApi

      public DifyDatasetsApi(String baseUrl, String apiKey)

  • 方法详细资料

    • createDataset

      public DatasetResponse createDataset(CreateDatasetRequest request)
      创建空知识库
      参数:
      request - 创建知识库请求参数
      返回:
      知识库详情

    • updateDataset

      public DatasetResponse updateDataset(String datasetId, UpdateDatasetRequest request)
      修改知识库详情
      参数:
      datasetId - 知识库ID
      request - 修改知识库请求参数
      返回:
      知识库详情

    • listDataset

      public DatasetListResponse listDataset(Integer page, Integer limit)
      知识库列表
      参数:
      page - 页码
      limit - 每页限制
      返回:
      数据集列表

    • getDataset

      public DatasetResponse getDataset(String datasetId)
      获取知识库详情
      参数:
      datasetId - 知识库ID
      返回:
      知识库详情

    • deleteDataset

      public void deleteDataset(String datasetId)
      删除知识库
      参数:
      datasetId - 知识库ID

    • createDocumentByText

      public DocumentResponse createDocumentByText(String datasetId, CreateDocumentByTextRequest request)
      通过文本创建文档
      参数:
      datasetId - 知识库ID
      request - 创建文档请求参数
      返回:
      文档详情

    • createDocumentByFile

      public DocumentResponse createDocumentByFile(String datasetId, File file, CreateDocumentByFileRequest request)
      通过文件创建文档
      参数:
      datasetId - 知识库ID
      file - 需要上传的文件
      request - 创建文档请求参数
      返回:
      文档详情

    • updateDocumentByText

      public DocumentResponse updateDocumentByText(String datasetId, String documentId, UpdateDocumentByTextRequest request)
      通过文本更新文档
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      request - 更新文档请求参数
      返回:
      知识库详情

    • updateDocumentByFile

      public DocumentResponse updateDocumentByFile(String datasetId, String documentId, File file, UpdateDocumentByFileRequest request)
      通过文件更新文档
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      file - 需要上传的文件
      request - 更新文档请求参数
      返回:
      知识库详情

    • getDocumentIndexingStatus

      public DocumentIndexingStatusResponse getDocumentIndexingStatus(String datasetId, String batch)
      获取文档嵌入状态（进度）
      参数:
      datasetId - 知识库ID
      batch - 上传文档的批次号
      返回:
      文档索引状态信息

    • deleteDocument

      public void deleteDocument(String datasetId, String documentId)
      删除文档
      参数:
      datasetId - 知识库ID
      documentId - 文档ID

    • listDocuments

      public DocumentListResponse listDocuments(String datasetId, String keyword, Integer page, Integer limit)
      知识库文档列表
      参数:
      datasetId - 知识库ID
      keyword - 搜索关键词，可选，目前仅搜索文档名称
      page - 页码，可选
      limit - 返回条数，可选，默认20，范围1-100
      返回:
      文档列表响应

    • createDocumentSegments

      public CreateSegmentResponse createDocumentSegments(String datasetId, String documentId, CreateSegmentsRequest request)
      新增分段
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      request - 新增分段请求参数
      返回:
      分段响应

    • updateDocumentSegment

      public UpdateSegmentResponse updateDocumentSegment(String datasetId, String documentId, String segmentId, UpdateSegmentsRequest request)
      更新文档分段
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      segmentId - 文档分段ID
      request - 更新分段请求参数
      返回:
      分段更新响应

    • listDocumentSegments

      public SegmentListResponse listDocumentSegments(String datasetId, String documentId, String keyword, String status, Integer page, Integer limit)
      查询文档分段
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      keyword - 搜索关键词，可选
      status - 搜索状态，completed
      page - 页码，可选
      limit - 返回条数，可选，默认20，范围1-100
      返回:
      分段列表响应

    • deleteDocumentSegment

      public void deleteDocumentSegment(String datasetId, String documentId, String segmentId)
      删除文档分段
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      segmentId - 文档分段ID

    • createChildChunk

      public ChildChunkResponse createChildChunk(String datasetId, String documentId, String segmentId, SubmitChildChunkRequest request)
      新增文档子分段
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      segmentId - 分段ID
      request - 新增子分段请求参数
      返回:
      子分段响应

    • updateChildChunk

      public ChildChunkResponse updateChildChunk(String datasetId, String documentId, String segmentId, String childChunkId, SubmitChildChunkRequest request)
      更新文档子分段
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      segmentId - 分段ID
      childChunkId - 子分段ID
      request - 更新子分段请求参数
      返回:
      子分段响应

    • listChildChunks

      public ChildChunkListResponse listChildChunks(String datasetId, String documentId, String segmentId, String keyword, Integer page, Integer limit)
      查询文档子分段
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      segmentId - 分段ID
      keyword - 搜索关键词（选填）
      page - 页码（选填，默认1）
      limit - 每页数量（选填，默认20，最大100）
      返回:
      子分段列表响应

    • deleteChildChunk

      public void deleteChildChunk(String datasetId, String documentId, String segmentId, String childChunkId)
      删除文档子分段
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      segmentId - 分段ID
      childChunkId - 子分段ID

    • getDocumentUploadFile

      public DocumentUploadFileResponse getDocumentUploadFile(String datasetId, String documentId)
      获取上传文件
      参数:
      datasetId - 知识库ID
      documentId - 文档ID
      返回:
      上传文件响应

    • createMetadata

      public MetadataResponse createMetadata(String datasetId, CreateMetadataRequest request)
      新增元数据
      参数:
      datasetId - 知识库ID
      request - 新增元数据请求参数
      返回:
      元数据响应

    • updateMetadata

      public MetadataResponse updateMetadata(String datasetId, String metadataId, UpdateMetadataRequest request)
      更新元数据
      参数:
      datasetId - 知识库ID
      metadataId - 元数据ID
      request - 更新元数据请求参数
      返回:
      元数据响应

    • deleteMetadata

      public void deleteMetadata(String datasetId, String metadataId)
      删除元数据
      参数:
      datasetId - 知识库ID
      metadataId - 元数据ID

    • toggleBuiltInMetadata

      public void toggleBuiltInMetadata(String datasetId, String action)
      启用/禁用内置元数据
      参数:
      datasetId - 知识库ID
      action - 操作类型（disable/enable）

    • updateDocumentMetadata

      public void updateDocumentMetadata(String datasetId, UpdateDocumentMetadataRequest request)
      更新文档元数据
      参数:
      datasetId - 知识库ID
      request - 更新文档元数据请求参数

    • listDatasetMetadata

      public DatasetMetadataResponse listDatasetMetadata(String datasetId)
      查询知识库元数据列表
      参数:
      datasetId - 知识库ID
      返回:
      知识库元数据响应

    • listEmbeddingModels

      public EmbeddingModelListResponse listEmbeddingModels()
      获取嵌入模型列表
      返回:
      嵌入模型列表响应

    • retrieveDataset

      public RetrieveResponse retrieveDataset(String datasetId, RetrieveRequest request)
      检索知识库
      参数:
      datasetId - 知识库ID
      request - 检索请求参数
      返回:
      检索响应

    • createTag

      public TagResponse createTag(CreateTagRequest request)
      创建新标签

    • listTags

      public List<TagResponse> listTags()
      获取标签列表
      返回:
      标签列表响应

    • updateTag

      public TagResponse updateTag(UpdateTagRequest request)
      修改标签名称

    • deleteTag

      public void deleteTag(DeleteTagRequest request)
      删除标签

    • bindingTag

      public void bindingTag(BindingTagRequest request)
      绑定知识库到标签
      参数:
      request - 绑定标签请求参数

    • unbindingTag

      public void unbindingTag(UnbindingTagRequest request)
      解绑知识库和标签
      参数:
      request - 解绑标签请求参数

    • getDatasetTags

      public DatasetTagsResponse getDatasetTags(String datasetId)
      查询知识库已绑定的标签
      参数:
      datasetId - 知识库ID
      返回:
      标签列表响应