# 查看文件解析后的分片内容列表 - ListFileDocs #### 功能介绍 查看当前文件，经过文档解析后的分片列表，包含每个分片的详情。 #### URI GET /v1/{project_id}/applications/{application_id}/uni-search/files/{file_id}/docs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0022.html)。 **约束限制：** 不涉及 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 | | application_id | 是 | String | **参数解释：** 应用ID，获取方法请参见[获取应用ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0021.html)。 **约束限制：** 字符串 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 | | file_id | 是 | String | **参数解释：** 文件ID。 **约束限制：** 不涉及 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | page_size | 否 | Integer | **参数解释：** 每页显示的记录数，表示一次请求返回的数据条数。默认值为10，表示一页展示10条数据。 **约束限制：** 不涉及 **取值范围：** 1-65535 **默认取值：** 10 | | page_num | 否 | Integer | **参数解释：** 当前请求的页码，表示从第几页开始获取数据。默认值为1，表示第一页。 **约束限制：** 不涉及 **取值范围：** 1～65535 **默认取值：** 1 | | file_type | 否 | String | **参数解释：** 文件类型, 长度不能超过64个字符。 **约束限制：** 不涉及 **取值范围：** - pdf - doc **默认取值：** 不涉及 | | repo_id | 否 | String | **参数解释：** 知识库ID, 当请求参数携带时，用于限制查询数据来源指定知识库。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 接口鉴权使用的Token，Token获取方式参考：[获取IAM用户Token](https://support.huaweicloud.com/api-koosearch/koosearch_06_0009.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | docs | Array of [FileDocInfo] objects | **参数解释：** 文件分片列表。 **取值范围：** 不涉及 | | page_num | Long | **参数解释：** 请求中的页码。 **取值范围：** 不涉及 | | page_size | Long | **参数解释：** 请求中的分页大小。 **取值范围：** 不涉及 | | total | Long | **参数解释：** 分片总数。 **取值范围：** 不涉及 | | version | Integer | **参数解释：** 版本信息。 **取值范围：** 不涉及 | 表5FileDocInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 分片ID。 **取值范围：** 不涉及 | | timestamp | String | **参数解释：** 分片创建的时间戳。为保证文档分片在页面上的展示效果，该字段不随分片数据更新而更新。 **取值范围：** 不涉及 | | title | String | **参数解释：** 分片标题。 **取值范围：** 不涉及 | | content | String | **参数解释：** 分片内容。 **取值范围：** 不涉及 | | page_num | Long | **参数解释：** 分片页码，FAQ分片内容中不涉及page_num。 **取值范围：** 不涉及 | | page_num_list | Array of longs | **参数解释：** 分片页码，文件类型为pdf时返回，存在多个页在同一分片中情况。 **取值范围：** 不涉及 | | component_num | Long | **参数解释：** 分片内容序列号，FAQ分片内容中不涉及component_num。 **取值范围：** 不涉及 | | element_id | String | **参数解释：** 文件的元素ID。 **取值范围：** 不涉及 | | elements | Array of strings | **参数解释：** html中的数据元素。 **取值范围：** 不涉及 **约束限制：** 此参数只有25.7.T1及之后版本支持。 | | pdf_coordinate | Object | **参数解释：** 用于pdf解析文本定位的元数据。取值样例如下 \[ \[ 202, 687 \], \[ 1031, 687 \] \] **取值范围：** 不涉及 **约束限制：** 此参数只有25.7.T1及之后版本支持。 | **状态码：404** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。 **取值范围：** 不涉及 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及 | #### 请求示例 查看文件解析后的分片内容列表。 ``` /v1/b25446daeb1a41a7953c5deba2b2677a/applications/cefb2a59-2f9e-4268-b56b-eab15dc0b9d6/uni-search/files/6c95aa82c4f0bb509e30fa017874101b/docs?page_size=10&file_type=pdf&page_num=1 ``` #### 响应示例 **状态码：200** 查询响应体。 ``` { "page_num" : 1, "page_size" : 1, "total" : 1, "docs" : [ { "id" : "065c6b2f47354b3797e14d1e6a013a7e", "timestamp" : "1745827606521", "title" : "全球加速 GA 计费说明", "content" : "按需计费是一种后付费模式，即先使用再付费，按照加速实例实际使用时长计费。详细介绍请参见计费模式。\n、计费项", "page_num" : 1, "component_num" : 1 } ], "version" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询响应体。 | | 404 | 文件不存在。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。