获取指定知识库中一个或多个文档的详细信息。
接口说明
- RAM 用户（子账号）需要首先获取百炼的数据权限（需要
AliyunBailianDataFullAccess，已包括 sfm:ListIndexFiles 权限点），然后才能调用本接口，详见为 RAM 用户授予数据权限。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。 - 调用本接口前，请确保您的知识库已经创建完成且未被删除（即知识库 ID
IndexId有效）。 - 本接口具有幂等性。
限流说明： 本接口频繁调用会被限流，频率请勿超过 15 次/秒。如遇限流，请稍后重试。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| sfm:ListIndexFiles | list | *全部资源 * |
| 无 |
请求语法
GET /{WorkspaceId}/index/list_index_documents HTTP/1.1请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| IndexId | string | 是 | 知识库 ID，即 CreateIndex 接口返回的 | 79c0alxxxx |
| DocumentStatus | string | 否 | 即通过文档导入状态对接口返回的文档列表进行过滤。取值范围：
默认值为空，即不使用文档导入状态对结果进行过滤。 | FINISH |
| DocumentName | string | 否 | 即通过文档名称对接口返回的文档列表进行过滤。默认值为空，即不使用文档名称对结果进行过滤。 | 翻译平台运维文档 |
| PageNumber | integer | 否 | 指定要查询的页码。起始值为 1。默认值为 1。 | 1 |
| PageSize | integer | 否 | 指定分页查询时每页展示的文档数量。最大值不限。 默认值为 10。 | 10 |
| WorkspaceId | string | 是 | 知识库所属的业务空间 ID。获取方式请参见如何使用业务空间。 | llm-3z7uw7fwz0vexxxx |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
"Code": "InvalidParameter",
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"Success": true,
"Data": {
"Documents": [
{
"SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx",
"Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx",
"Name": "翻译平台运维文档",
"Size": 996764,
"DocumentType": "pdf",
"Status": "RUNNING",
"Code": "110002",
"Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
"GmtModified": 0
}
],
"IndexId": "pno97txxxx",
"TotalCount": 2437,
"PageNumber": 1,
"PageSize": 10
},
"Status": "200"
}错误码
访问错误中心查看更多错误码。