cURL
Authorizations
string
header
required
DashScope API Key,在控制台 API Key 页面(https://agent.console.aliyun.com/settings/apikey)获取。
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
分页查询知识库中的切片
curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/chunklist" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"indexId": "your_index_id",
"pageNum": 1,
"pageSize": 10
}'{
"code": "Success",
"status_code": 200,
"data": {
"total": 106,
"nodes": [
{
"score": 0,
"text": "这是切片的文本内容示例...",
"metadata": {
"_id": "llm-xxxxxxxxxxxx_your_kb_id_file_xxxxxxxx_0_0",
"doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"doc_name": "sample_document",
"title": "产品概述",
"content": "这是切片的文本内容示例...",
"hier_title": "产品概述|功能介绍",
"doc_url": "https://oss-example.aliyuncs.com/...",
"file_path": "https://oss-example.aliyuncs.com/.../docJson/sample.json",
"image_url": [],
"_chunk_id": 0,
"_block_id": 0,
"pipeline_id": "your_kb_id",
"workspace_id": "llm-xxxxxxxxxxxx",
"_chunk_status": 0,
"_chunk_status_message": "成功",
"is_displayed_chunk_content": true
}
}
],
"isDowngrade": false
},
"success": true,
"message": "success",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "SUCCESS"
}DashScope API Key,在控制台 API Key 页面(https://agent.console.aliyun.com/settings/apikey)获取。
响应码,成功时为 Success。
HTTP 状态码。
业务数据。
Show child attributes
切片总数。
切片节点列表。
Show child attributes
相关性分数(列表查询时通常为 0)。
切片文本内容。
是否发生检索降级。
请求是否成功。
响应消息。
请求唯一标识,排查问题时请提供此 ID。
请求状态,成功时为 SUCCESS。
curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/chunklist" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"indexId": "your_index_id",
"pageNum": 1,
"pageSize": 10
}'{
"code": "Success",
"status_code": 200,
"data": {
"total": 106,
"nodes": [
{
"score": 0,
"text": "这是切片的文本内容示例...",
"metadata": {
"_id": "llm-xxxxxxxxxxxx_your_kb_id_file_xxxxxxxx_0_0",
"doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"doc_name": "sample_document",
"title": "产品概述",
"content": "这是切片的文本内容示例...",
"hier_title": "产品概述|功能介绍",
"doc_url": "https://oss-example.aliyuncs.com/...",
"file_path": "https://oss-example.aliyuncs.com/.../docJson/sample.json",
"image_url": [],
"_chunk_id": 0,
"_block_id": 0,
"pipeline_id": "your_kb_id",
"workspace_id": "llm-xxxxxxxxxxxx",
"_chunk_status": 0,
"_chunk_status_message": "成功",
"is_displayed_chunk_content": true
}
}
],
"isDowngrade": false
},
"success": true,
"message": "success",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "SUCCESS"
}