cURL
调用前请确保已获取 API Key 和业务空间 ID,详见鉴权说明。
Authorizations
string
header
required
DashScope API Key,在控制台 API Key 页面(https://rag.console.aliyun.com/settings/apikey)获取。
分页查询当前业务空间下的所有知识库
curl -G "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/list" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-d "page_number=1" \
-d "page_size=20"{
"code": "Success",
"status_code": 200,
"data": {
"page_number": 1,
"total_count": 1,
"rows": [
{
"id": "your_kb_id",
"name": "my-knowledge-base",
"description": "示例知识库",
"dataType": "unstructured",
"structureType": "unstructured",
"knowledgeType": null,
"embeddingModelName": "text-embedding-v4",
"embeddingDimension": null,
"multimodalEmbeddingModelName": null,
"rerankModelName": "qwen3-rerank",
"rerankMinScore": 0.2,
"rerankTopN": null,
"rerankMode": null,
"rerankInstruct": null,
"chunkSize": 600,
"overlapSize": 100,
"separator": null,
"chunkMode": null,
"sourceType": "DATA_CENTER_CATEGORY",
"docIds": [
"cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx"
],
"columns": null,
"enableRewrite": true,
"connectorId": null,
"sparseSimilarityTopK": null,
"denseSimilarityTopK": null
}
],
"page_size": 20
},
"success": true,
"message": "success",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "SUCCESS"
}DashScope API Key,在控制台 API Key 页面(https://rag.console.aliyun.com/settings/apikey)获取。
响应码,成功时为 Success。
HTTP 状态码。
请求唯一标识,排查问题时请提供此 ID。
Show child attributes
当前页码。
知识库总数。
知识库列表。
Show child attributes
知识库唯一标识。
知识库名称。
知识库描述信息。
数据类型,如 unstructured。
结构类型:unstructured(非结构化)或 structured(结构化)。
知识库类型。
向量嵌入模型,如 text-embedding-v4。
向量维度。
多模态嵌入模型名称(图片/音视频知识库)。
切片大小(字符数)。
切片重叠大小(字符数)。
切片分隔符。
切片模式。
重排序模型,如 qwen3-rerank。为空表示未启用。
重排序最低分数阈值。
重排序返回数量。
重排序模式。
自定义重排序指令。
数据源类型,如 DATA_CENTER_CATEGORY。
关联的类目/文档 ID 列表。
列信息,结构化知识库时返回。
关联的连接器 ID。
是否启用查询改写。
稀疏检索 TopK。
稠密检索 TopK。
当前每页条数(与请求一致)。
curl -G "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/list" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-d "page_number=1" \
-d "page_size=20"{
"code": "Success",
"status_code": 200,
"data": {
"page_number": 1,
"total_count": 1,
"rows": [
{
"id": "your_kb_id",
"name": "my-knowledge-base",
"description": "示例知识库",
"dataType": "unstructured",
"structureType": "unstructured",
"knowledgeType": null,
"embeddingModelName": "text-embedding-v4",
"embeddingDimension": null,
"multimodalEmbeddingModelName": null,
"rerankModelName": "qwen3-rerank",
"rerankMinScore": 0.2,
"rerankTopN": null,
"rerankMode": null,
"rerankInstruct": null,
"chunkSize": 600,
"overlapSize": 100,
"separator": null,
"chunkMode": null,
"sourceType": "DATA_CENTER_CATEGORY",
"docIds": [
"cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx"
],
"columns": null,
"enableRewrite": true,
"connectorId": null,
"sparseSimilarityTopK": null,
"denseSimilarityTopK": null
}
],
"page_size": 20
},
"success": true,
"message": "success",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "SUCCESS"
}