public interface DifyDatasetsApiService

知识库 API

字段概要

字段

修饰符和类型

字段

说明

static final String

DATASETS_EMBEDDING_MODELS_PATH

static final String

DATASETS_PATH
方法概要

修饰符和类型

方法

说明

retrofit2.Call<Void>

bindingTag(BindingTagRequest request)

绑定知识库到知识库类型标签

retrofit2.Call<ChildChunkResponse>

createChildChunk(String datasetId, String documentId, String segmentId, SubmitChildChunkRequest request)

新增文档子分段

retrofit2.Call<DatasetResponse>

createDataset(CreateDatasetRequest request)

创建空知识库

retrofit2.Call<DocumentResponse>

createDocumentByFile(String datasetId, okhttp3.MultipartBody.Part file, okhttp3.MultipartBody.Part data)

通过文件创建文档

retrofit2.Call<DocumentResponse>

createDocumentByText(String datasetId, CreateDocumentByTextRequest request)

通过文本创建文档

retrofit2.Call<CreateSegmentResponse>

createDocumentSegments(String datasetId, String documentId, CreateSegmentsRequest request)

新增分段

retrofit2.Call<MetadataResponse>

createMetadata(String datasetId, CreateMetadataRequest request)

新增元数据

retrofit2.Call<TagResponse>

createTag(CreateTagRequest request)

新增知识库类型标签

retrofit2.Call<Void>

deleteChildChunk(String datasetId, String documentId, String segmentId, String childChunkId)

删除文档子分段

retrofit2.Call<Void>

deleteDataset(String datasetId)

删除知识库

retrofit2.Call<Void>

deleteDocument(String datasetId, String documentId)

删除文档

retrofit2.Call<Void>

deleteDocumentSegment(String datasetId, String documentId, String segmentId)

删除文档分段

retrofit2.Call<Void>

deleteMetadata(String datasetId, String metadataId)

删除元数据

retrofit2.Call<Void>

deleteTag(DeleteTagRequest request)

删除知识库类型标签

retrofit2.Call<DatasetResponse>

getDataset(String datasetId)

获取知识库详情

retrofit2.Call<DatasetTagsResponse>

getDatasetTags(String datasetId)

查询知识库已绑定的标签

retrofit2.Call<DocumentIndexingStatusResponse>

getDocumentIndexingStatus(String datasetId, String batch)

获取文档嵌入状态（进度）

retrofit2.Call<DocumentUploadFileResponse>

getDocumentUploadFile(String datasetId, String documentId)

获取上传文件

retrofit2.Call<ChildChunkListResponse>

listChildChunks(String datasetId, String documentId, String segmentId, String keyword, Integer page, Integer limit)

查询文档子分段

retrofit2.Call<DatasetListResponse>

listDataset(Integer page, Integer limit)

知识库列表

retrofit2.Call<DatasetMetadataResponse>

listDatasetMetadata(String datasetId)

查询知识库元数据列表

retrofit2.Call<DocumentListResponse>

listDocuments(String datasetId, String keyword, Integer page, Integer limit)

知识库文档列表

retrofit2.Call<SegmentListResponse>

listDocumentSegments(String datasetId, String documentId, String keyword, String status, Integer page, Integer limit)

查询文档分段

retrofit2.Call<EmbeddingModelListResponse>

listEmbeddingModels()

获取嵌入模型列表

retrofit2.Call<List<TagResponse>>

listTags()

获取知识库类型标签列表

retrofit2.Call<RetrieveResponse>

retrieveDataset(String datasetId, RetrieveRequest request)

检索知识库

retrofit2.Call<Void>

toggleBuiltInMetadata(String datasetId, String action)

启用/禁用内置元数据

retrofit2.Call<Void>

unbindingTag(UnbindingTagRequest request)

解绑知识库和知识库类型标签

retrofit2.Call<ChildChunkResponse>

updateChildChunk(String datasetId, String documentId, String segmentId, String childChunkId, SubmitChildChunkRequest request)

更新文档子分段

retrofit2.Call<DatasetResponse>

updateDataset(String datasetId, UpdateDatasetRequest request)

修改知识库详情

retrofit2.Call<DocumentResponse>

updateDocumentByFile(String datasetId, String documentId, okhttp3.MultipartBody.Part file, okhttp3.MultipartBody.Part data)

通过文件更新文档

retrofit2.Call<DocumentResponse>

updateDocumentByText(String datasetId, String documentId, UpdateDocumentByTextRequest request)

通过文本更新文档

retrofit2.Call<Void>

updateDocumentMetadata(String datasetId, UpdateDocumentMetadataRequest request)

更新文档元数据

retrofit2.Call<UpdateSegmentResponse>

updateDocumentSegment(String datasetId, String documentId, String segmentId, UpdateSegmentsRequest request)

更新文档分段

retrofit2.Call<MetadataResponse>

updateMetadata(String datasetId, String metadataId, UpdateMetadataRequest request)

更新元数据

retrofit2.Call<TagResponse>

updateTag(UpdateTagRequest request)

修改知识库类型标签名称

字段详细资料
- DATASETS_PATH
  
  static final String DATASETS_PATH
  另请参阅:
  
  常量字段值
- DATASETS_EMBEDDING_MODELS_PATH
  
  static final String DATASETS_EMBEDDING_MODELS_PATH
  另请参阅:
  
  常量字段值
方法详细资料
- createDataset
  
  @POST("datasets") retrofit2.Call<DatasetResponse> createDataset(@Body CreateDatasetRequest request)
  
  创建空知识库
  
  参数:
  
  request - 创建知识库请求参数
  
  返回:
  
  知识库详情
- updateDataset
  
  @PATCH("datasets/{dataset_id}") retrofit2.Call<DatasetResponse> updateDataset(@Path("dataset_id") String datasetId, @Body UpdateDatasetRequest request)
  
  修改知识库详情
  
  参数:
  
  datasetId - 知识库ID
  
  request - 修改知识库请求参数
  
  返回:
  
  知识库详情
- listDataset
  
  @GET("datasets") retrofit2.Call<DatasetListResponse> listDataset(@Query("page") Integer page, @Query("limit") Integer limit)
  
  知识库列表
  
  参数:
  
  page - 页码
  
  limit - 每页限制
  
  返回:
  
  数据集列表
- getDataset
  
  @GET("datasets/{dataset_id}") retrofit2.Call<DatasetResponse> getDataset(@Path("dataset_id") String datasetId)
  
  获取知识库详情
  
  参数:
  
  datasetId - 知识库ID
  
  返回:
  
  知识库详情
- deleteDataset
  
  @DELETE("datasets/{dataset_id}") retrofit2.Call<Void> deleteDataset(@Path("dataset_id") String datasetId)
  
  删除知识库
  
  参数:
  
  datasetId - 知识库ID
  
  返回:
  
  无返回内容
- createDocumentByText
  
  @POST("datasets/{dataset_id}/document/create-by-text") retrofit2.Call<DocumentResponse> createDocumentByText(@Path("dataset_id") String datasetId, @Body CreateDocumentByTextRequest request)
  
  通过文本创建文档
  
  参数:
  
  datasetId - 知识库ID
  
  request - 创建文档请求参数
  
  返回:
  
  文档详情
- createDocumentByFile
  
  @Multipart @POST("datasets/{dataset_id}/document/create-by-file") retrofit2.Call<DocumentResponse> createDocumentByFile(@Path("dataset_id") String datasetId, @Part okhttp3.MultipartBody.Part file, @Part okhttp3.MultipartBody.Part data)
  
  通过文件创建文档
  
  参数:
  
  datasetId - 知识库ID
  
  返回:
  
  文档详情
- updateDocumentByText
  
  @POST("datasets/{dataset_id}/documents/{document_id}/update-by-text") retrofit2.Call<DocumentResponse> updateDocumentByText(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Body UpdateDocumentByTextRequest request)
  
  通过文本更新文档
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  request - 更新文档请求参数
  
  返回:
  
  知识库详情
- updateDocumentByFile
  
  @Multipart @POST("datasets/{dataset_id}/documents/{document_id}/update-by-file") retrofit2.Call<DocumentResponse> updateDocumentByFile(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Part okhttp3.MultipartBody.Part file, @Part okhttp3.MultipartBody.Part data)
  
  通过文件更新文档
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  file - 需要上传的文件
  
  返回:
  
  知识库详情
- getDocumentIndexingStatus
  
  @GET("datasets/{dataset_id}/documents/{batch}/indexing-status") retrofit2.Call<DocumentIndexingStatusResponse> getDocumentIndexingStatus(@Path("dataset_id") String datasetId, @Path("batch") String batch)
  
  获取文档嵌入状态（进度）
  
  参数:
  
  datasetId - 知识库ID
  
  batch - 上传文档的批次号
  
  返回:
  
  文档索引状态信息
- deleteDocument
  
  @DELETE("datasets/{dataset_id}/documents/{document_id}") retrofit2.Call<Void> deleteDocument(@Path("dataset_id") String datasetId, @Path("document_id") String documentId)
  
  删除文档
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  返回:
  
  无返回内容
- listDocuments
  
  @GET("datasets/{dataset_id}/documents") retrofit2.Call<DocumentListResponse> listDocuments(@Path("dataset_id") String datasetId, @Query("keyword") String keyword, @Query("page") Integer page, @Query("limit") Integer limit)
  
  知识库文档列表
  
  参数:
  
  datasetId - 知识库ID
  
  keyword - 搜索关键词，可选，目前仅搜索文档名称
  
  page - 页码，可选
  
  limit - 返回条数，可选，默认20，范围1-100
  
  返回:
  
  文档列表响应
- createDocumentSegments
  
  @POST("datasets/{dataset_id}/documents/{document_id}/segments") retrofit2.Call<CreateSegmentResponse> createDocumentSegments(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Body CreateSegmentsRequest request)
  
  新增分段
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  request - 新增分段请求参数
  
  返回:
  
  分段响应
- updateDocumentSegment
  
  @POST("datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}") retrofit2.Call<UpdateSegmentResponse> updateDocumentSegment(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Path("segment_id") String segmentId, @Body UpdateSegmentsRequest request)
  
  更新文档分段
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  segmentId - 文档分段ID
  
  request - 更新分段请求参数
  
  返回:
  
  分段更新响应
- listDocumentSegments
  
  @GET("datasets/{dataset_id}/documents/{document_id}/segments") retrofit2.Call<SegmentListResponse> listDocumentSegments(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Query("keyword") String keyword, @Query("status") String status, @Query("page") Integer page, @Query("limit") Integer limit)
  
  查询文档分段
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  keyword - 搜索关键词，可选
  
  status - 搜索状态，completed
  
  page - 页码，可选
  
  limit - 返回条数，可选，默认20，范围1-100
  
  返回:
  
  分段列表响应
- deleteDocumentSegment
  
  @DELETE("datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}") retrofit2.Call<Void> deleteDocumentSegment(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Path("segment_id") String segmentId)
  
  删除文档分段
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  segmentId - 文档分段ID
  
  返回:
  
  无返回内容
- createChildChunk
  
  @POST("datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks") retrofit2.Call<ChildChunkResponse> createChildChunk(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Path("segment_id") String segmentId, @Body SubmitChildChunkRequest request)
  
  新增文档子分段
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  segmentId - 分段ID
  
  request - 新增子分段请求参数
  
  返回:
  
  子分段响应
- updateChildChunk
  
  @PATCH("datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}") retrofit2.Call<ChildChunkResponse> updateChildChunk(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Path("segment_id") String segmentId, @Path("child_chunk_id") String childChunkId, @Body SubmitChildChunkRequest request)
  
  更新文档子分段
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  segmentId - 分段ID
  
  childChunkId - 子分段ID
  
  request - 更新子分段请求参数
  
  返回:
  
  子分段响应
- listChildChunks
  
  @GET("datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks") retrofit2.Call<ChildChunkListResponse> listChildChunks(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Path("segment_id") String segmentId, @Query("keyword") String keyword, @Query("page") Integer page, @Query("limit") Integer limit)
  
  查询文档子分段
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  segmentId - 分段ID
  
  keyword - 搜索关键词（选填）
  
  page - 页码（选填，默认1）
  
  limit - 每页数量（选填，默认20，最大100）
  
  返回:
  
  子分段列表响应
- deleteChildChunk
  
  @DELETE("datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}") retrofit2.Call<Void> deleteChildChunk(@Path("dataset_id") String datasetId, @Path("document_id") String documentId, @Path("segment_id") String segmentId, @Path("child_chunk_id") String childChunkId)
  
  删除文档子分段
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  segmentId - 分段ID
  
  childChunkId - 子分段ID
  
  返回:
  
  无返回内容
- getDocumentUploadFile
  
  @GET("datasets/{dataset_id}/documents/{document_id}/upload-file") retrofit2.Call<DocumentUploadFileResponse> getDocumentUploadFile(@Path("dataset_id") String datasetId, @Path("document_id") String documentId)
  
  获取上传文件
  
  参数:
  
  datasetId - 知识库ID
  
  documentId - 文档ID
  
  返回:
  
  上传文件响应
- createMetadata
  
  @POST("datasets/{dataset_id}/metadata") retrofit2.Call<MetadataResponse> createMetadata(@Path("dataset_id") String datasetId, @Body CreateMetadataRequest request)
  
  新增元数据
  
  参数:
  
  datasetId - 知识库ID
  
  request - 新增元数据请求参数
  
  返回:
  
  元数据响应
- updateMetadata
  
  @PATCH("datasets/{dataset_id}/metadata/{metadata_id}") retrofit2.Call<MetadataResponse> updateMetadata(@Path("dataset_id") String datasetId, @Path("metadata_id") String metadataId, @Body UpdateMetadataRequest request)
  
  更新元数据
  
  参数:
  
  datasetId - 知识库ID
  
  metadataId - 元数据ID
  
  request - 更新元数据请求参数
  
  返回:
  
  元数据响应
- deleteMetadata
  
  @DELETE("datasets/{dataset_id}/metadata/{metadata_id}") retrofit2.Call<Void> deleteMetadata(@Path("dataset_id") String datasetId, @Path("metadata_id") String metadataId)
  
  删除元数据
  
  参数:
  
  datasetId - 知识库ID
  
  metadataId - 元数据ID
  
  返回:
  
  无返回内容
- toggleBuiltInMetadata
  
  @POST("datasets/{dataset_id}/metadata/built-in/{action}") retrofit2.Call<Void> toggleBuiltInMetadata(@Path("dataset_id") String datasetId, @Path("action") String action)
  
  启用/禁用内置元数据
  
  参数:
  
  datasetId - 知识库ID
  
  action - 操作类型（disable/enable）
  
  返回:
  
  无返回内容
- updateDocumentMetadata
  
  @POST("datasets/{dataset_id}/documents/metadata") retrofit2.Call<Void> updateDocumentMetadata(@Path("dataset_id") String datasetId, @Body UpdateDocumentMetadataRequest request)
  
  更新文档元数据
  
  参数:
  
  datasetId - 知识库ID
  
  request - 更新文档元数据请求参数
  
  返回:
  
  无返回内容
- listDatasetMetadata
  
  @GET("datasets/{dataset_id}/metadata") retrofit2.Call<DatasetMetadataResponse> listDatasetMetadata(@Path("dataset_id") String datasetId)
  
  查询知识库元数据列表
  
  参数:
  
  datasetId - 知识库ID
  
  返回:
  
  知识库元数据响应
- listEmbeddingModels
  
  @GET("workspaces/current/models/model-types/text-embedding") retrofit2.Call<EmbeddingModelListResponse> listEmbeddingModels()
  
  获取嵌入模型列表
  
  返回:
  
  嵌入模型列表响应
- retrieveDataset
  
  @POST("datasets/{dataset_id}/retrieve") retrofit2.Call<RetrieveResponse> retrieveDataset(@Path("dataset_id") String datasetId, @Body RetrieveRequest request)
  
  检索知识库
  
  参数:
  
  datasetId - 知识库ID
  
  request - 检索请求参数
  
  返回:
  
  检索响应
- createTag
  
  @POST("datasets/tags") retrofit2.Call<TagResponse> createTag(@Body CreateTagRequest request)
  
  新增知识库类型标签
  
  参数:
  
  request - 新增标签请求参数
  
  返回:
  
  标签响应
- listTags
  
  @GET("datasets/tags") retrofit2.Call<List<TagResponse>> listTags()
  
  获取知识库类型标签列表
  
  返回:
  
  标签列表
- updateTag
  
  @PATCH("datasets/tags") retrofit2.Call<TagResponse> updateTag(@Body UpdateTagRequest request)
  
  修改知识库类型标签名称
  
  参数:
  
  request - 修改标签请求参数
  
  返回:
  
  标签响应
- deleteTag
  
  @HTTP(method="DELETE", path="datasets/tags", hasBody=true) retrofit2.Call<Void> deleteTag(@Body DeleteTagRequest request)
  
  删除知识库类型标签
  
  参数:
  
  request - 删除标签请求参数
  
  返回:
  
  无返回内容
- bindingTag
  
  @POST("datasets/tags/binding") retrofit2.Call<Void> bindingTag(@Body BindingTagRequest request)
  
  绑定知识库到知识库类型标签
  
  参数:
  
  request - 绑定标签请求参数
  
  返回:
  
  无返回内容
- unbindingTag
  
  @POST("datasets/tags/unbinding") retrofit2.Call<Void> unbindingTag(@Body UnbindingTagRequest request)
  
  解绑知识库和知识库类型标签
  
  参数:
  
  request - 解绑标签请求参数
  
  返回:
  
  无返回内容
- getDatasetTags
  
  @GET("datasets/{dataset_id}/tags") retrofit2.Call<DatasetTagsResponse> getDatasetTags(@Path("dataset_id") String datasetId)
  
  查询知识库已绑定的标签
  
  参数:
  
  datasetId - 知识库ID
  
  返回:
  
  知识库标签响应

接口 DifyDatasetsApiService

字段概要

方法概要

字段详细资料

DATASETS_PATH

DATASETS_EMBEDDING_MODELS_PATH

方法详细资料

createDataset

updateDataset

listDataset

getDataset

deleteDataset

createDocumentByText

createDocumentByFile

updateDocumentByText

updateDocumentByFile

getDocumentIndexingStatus

deleteDocument

listDocuments

createDocumentSegments

updateDocumentSegment

listDocumentSegments

deleteDocumentSegment

createChildChunk

updateChildChunk

listChildChunks

deleteChildChunk

getDocumentUploadFile

createMetadata

updateMetadata

deleteMetadata

toggleBuiltInMetadata

updateDocumentMetadata

listDatasetMetadata

listEmbeddingModels

retrieveDataset

createTag

listTags

updateTag

deleteTag

bindingTag

unbindingTag

getDatasetTags