public interface DifyDatasetsApiService
| 限定符和类型 | 字段和说明 |
|---|---|
static String |
DATASETS_EMBEDDING_MODELS_PATH |
static String |
DATASETS_PATH |
| 限定符和类型 | 方法和说明 |
|---|---|
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<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<DatasetResponse> |
getDataset(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<RetrieveResponse> |
retrieveDataset(String datasetId,
RetrieveRequest request)
检索知识库
|
retrofit2.Call<Void> |
toggleBuiltInMetadata(String datasetId,
String action)
启用/禁用内置元数据
|
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)
更新元数据
|
@POST(value="datasets") retrofit2.Call<DatasetResponse> createDataset(@Body CreateDatasetRequest request)
request - 创建知识库请求参数@PATCH(value="datasets/{dataset_id}")
retrofit2.Call<DatasetResponse> updateDataset(@Path(value="dataset_id")
String datasetId,
@Body
UpdateDatasetRequest request)
datasetId - 知识库IDrequest - 修改知识库请求参数@GET(value="datasets") retrofit2.Call<DatasetListResponse> listDataset(@Query(value="page") Integer page, @Query(value="limit") Integer limit)
page - 页码limit - 每页限制@GET(value="datasets/{dataset_id}")
retrofit2.Call<DatasetResponse> getDataset(@Path(value="dataset_id")
String datasetId)
datasetId - 知识库ID@DELETE(value="datasets/{dataset_id}")
retrofit2.Call<Void> deleteDataset(@Path(value="dataset_id")
String datasetId)
datasetId - 知识库ID@POST(value="datasets/{dataset_id}/document/create-by-text")
retrofit2.Call<DocumentResponse> createDocumentByText(@Path(value="dataset_id")
String datasetId,
@Body
CreateDocumentByTextRequest request)
datasetId - 知识库IDrequest - 创建文档请求参数@Multipart
@POST(value="datasets/{dataset_id}/document/create-by-file")
retrofit2.Call<DocumentResponse> createDocumentByFile(@Path(value="dataset_id")
String datasetId,
@Part
okhttp3.MultipartBody.Part file,
@Part
okhttp3.MultipartBody.Part data)
datasetId - 知识库IDrequest - 创建文档请求参数@POST(value="datasets/{dataset_id}/documents/{document_id}/update-by-text")
retrofit2.Call<DocumentResponse> updateDocumentByText(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Body
UpdateDocumentByTextRequest request)
datasetId - 知识库IDdocumentId - 文档IDrequest - 更新文档请求参数@Multipart
@POST(value="datasets/{dataset_id}/documents/{document_id}/update-by-file")
retrofit2.Call<DocumentResponse> updateDocumentByFile(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Part
okhttp3.MultipartBody.Part file,
@Part
okhttp3.MultipartBody.Part data)
datasetId - 知识库IDdocumentId - 文档IDfile - 需要上传的文件request - 更新文档请求参数@GET(value="datasets/{dataset_id}/documents/{batch}/indexing-status")
retrofit2.Call<DocumentIndexingStatusResponse> getDocumentIndexingStatus(@Path(value="dataset_id")
String datasetId,
@Path(value="batch")
String batch)
datasetId - 知识库IDbatch - 上传文档的批次号@DELETE(value="datasets/{dataset_id}/documents/{document_id}")
retrofit2.Call<Void> deleteDocument(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId)
datasetId - 知识库IDdocumentId - 文档ID@GET(value="datasets/{dataset_id}/documents")
retrofit2.Call<DocumentListResponse> listDocuments(@Path(value="dataset_id")
String datasetId,
@Query(value="keyword")
String keyword,
@Query(value="page")
Integer page,
@Query(value="limit")
Integer limit)
datasetId - 知识库IDkeyword - 搜索关键词，可选，目前仅搜索文档名称page - 页码，可选limit - 返回条数，可选，默认20，范围1-100@POST(value="datasets/{dataset_id}/documents/{document_id}/segments")
retrofit2.Call<CreateSegmentResponse> createDocumentSegments(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Body
CreateSegmentsRequest request)
datasetId - 知识库IDdocumentId - 文档IDrequest - 新增分段请求参数@POST(value="datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}")
retrofit2.Call<UpdateSegmentResponse> updateDocumentSegment(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Path(value="segment_id")
String segmentId,
@Body
UpdateSegmentsRequest request)
datasetId - 知识库IDdocumentId - 文档IDsegmentId - 文档分段IDrequest - 更新分段请求参数@GET(value="datasets/{dataset_id}/documents/{document_id}/segments")
retrofit2.Call<SegmentListResponse> listDocumentSegments(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Query(value="keyword")
String keyword,
@Query(value="status")
String status,
@Query(value="page")
Integer page,
@Query(value="limit")
Integer limit)
datasetId - 知识库IDdocumentId - 文档IDkeyword - 搜索关键词，可选status - 搜索状态，completedpage - 页码，可选limit - 返回条数，可选，默认20，范围1-100@DELETE(value="datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}")
retrofit2.Call<Void> deleteDocumentSegment(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Path(value="segment_id")
String segmentId)
datasetId - 知识库IDdocumentId - 文档IDsegmentId - 文档分段ID@POST(value="datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks")
retrofit2.Call<ChildChunkResponse> createChildChunk(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Path(value="segment_id")
String segmentId,
@Body
SubmitChildChunkRequest request)
datasetId - 知识库IDdocumentId - 文档IDsegmentId - 分段IDrequest - 新增子分段请求参数@PATCH(value="datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}")
retrofit2.Call<ChildChunkResponse> updateChildChunk(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Path(value="segment_id")
String segmentId,
@Path(value="child_chunk_id")
String childChunkId,
@Body
SubmitChildChunkRequest request)
datasetId - 知识库IDdocumentId - 文档IDsegmentId - 分段IDchildChunkId - 子分段IDrequest - 更新子分段请求参数@GET(value="datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks")
retrofit2.Call<ChildChunkListResponse> listChildChunks(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Path(value="segment_id")
String segmentId,
@Query(value="keyword")
String keyword,
@Query(value="page")
Integer page,
@Query(value="limit")
Integer limit)
datasetId - 知识库IDdocumentId - 文档IDsegmentId - 分段IDkeyword - 搜索关键词（选填）page - 页码（选填，默认1）limit - 每页数量（选填，默认20，最大100）@DELETE(value="datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}")
retrofit2.Call<Void> deleteChildChunk(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId,
@Path(value="segment_id")
String segmentId,
@Path(value="child_chunk_id")
String childChunkId)
datasetId - 知识库IDdocumentId - 文档IDsegmentId - 分段IDchildChunkId - 子分段ID@GET(value="datasets/{dataset_id}/documents/{document_id}/upload-file")
retrofit2.Call<DocumentUploadFileResponse> getDocumentUploadFile(@Path(value="dataset_id")
String datasetId,
@Path(value="document_id")
String documentId)
datasetId - 知识库IDdocumentId - 文档ID@POST(value="datasets/{dataset_id}/metadata")
retrofit2.Call<MetadataResponse> createMetadata(@Path(value="dataset_id")
String datasetId,
@Body
CreateMetadataRequest request)
datasetId - 知识库IDrequest - 新增元数据请求参数@PATCH(value="datasets/{dataset_id}/metadata/{metadata_id}")
retrofit2.Call<MetadataResponse> updateMetadata(@Path(value="dataset_id")
String datasetId,
@Path(value="metadata_id")
String metadataId,
@Body
UpdateMetadataRequest request)
datasetId - 知识库IDmetadataId - 元数据IDrequest - 更新元数据请求参数@DELETE(value="datasets/{dataset_id}/metadata/{metadata_id}")
retrofit2.Call<Void> deleteMetadata(@Path(value="dataset_id")
String datasetId,
@Path(value="metadata_id")
String metadataId)
datasetId - 知识库IDmetadataId - 元数据ID@POST(value="datasets/{dataset_id}/metadata/built-in/{action}")
retrofit2.Call<Void> toggleBuiltInMetadata(@Path(value="dataset_id")
String datasetId,
@Path(value="action")
String action)
datasetId - 知识库IDaction - 操作类型（disable/enable）@POST(value="datasets/{dataset_id}/documents/metadata")
retrofit2.Call<Void> updateDocumentMetadata(@Path(value="dataset_id")
String datasetId,
@Body
UpdateDocumentMetadataRequest request)
datasetId - 知识库IDrequest - 更新文档元数据请求参数@GET(value="datasets/{dataset_id}/metadata")
retrofit2.Call<DatasetMetadataResponse> listDatasetMetadata(@Path(value="dataset_id")
String datasetId)
datasetId - 知识库ID@GET(value="workspaces/current/models/model-types/text-embedding") retrofit2.Call<EmbeddingModelListResponse> listEmbeddingModels()
@POST(value="datasets/{dataset_id}/retrieve")
retrofit2.Call<RetrieveResponse> retrieveDataset(@Path(value="dataset_id")
String datasetId,
@Body
RetrieveRequest request)
datasetId - 知识库IDrequest - 检索请求参数Copyright © 2025. All rights reserved.