Skip to main content
文档管理

查询文档列表

查询指定知识库中的文档列表

GET
/api/v1/indices/rag/index/files
cURL
curl -G "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/files" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -d "index_id=your_index_id" \
  -d "page_number=1" \
  -d "page_size=20"
{
  "code": "Success",
  "status_code": 200,
  "data": {
    "page_number": 1,
    "total_count": 1,
    "rows": [
      {
        "code": "FINISH",
        "connectorId": "conn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "dataSync": false,
        "doc_type": "md",
        "gmt_modified": 1782184640000,
        "message": "索引构建成功",
        "doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "categoryName": "默认类目",
        "tags": [],
        "ingestion_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "size": 21,
        "doc_name": "a",
        "canDelete": true,
        "source_id": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "meta_extract_info": [],
        "categoryId": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "status": "FINISH"
      }
    ],
    "page_size": 1
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

Authorizations

string
header
required

DashScope API Key,在控制台 API Key 页面(https://agent.console.aliyun.com/settings/apikey)获取。

Query Parameters

string
required

知识库 ID,对应创建知识库时返回的 pipelineId

length >= 1
integer
default1

页码,从 1 开始。

x >= 1
integer
default10

每页返回的文档数量,默认 10,最大 100。

1 <= x <= 100

Response

200-application/json
string

响应码,成功时为 Success

integer

HTTP 状态码。

string

请求唯一标识,排查问题时请提供此 ID。

object
Managed Agent API
RAG API
Connector API
Memory API
框架集成
  • 框架