获取FAQ文件切片信息
功能介绍
获取FAQ文件切片信息。
URI
GET /v1/{project_id}/applications/{application_id}/uni-search/faq/batch/{file_id}/docs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
application_id |
是 |
String |
参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
file_id |
是 |
String |
参数解释: 文件ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_num |
否 |
Integer |
参数解释: 当前请求的页码,表示从第几页开始获取数据。默认值为1,表示第一页。 约束限制: 不涉及 取值范围: 1~65535 默认取值: 1 |
page_size |
否 |
Integer |
参数解释: 每页显示的记录数,表示一次请求返回的数据条数。默认值为10,表示一页展示10条数据。 约束限制: 不涉及 取值范围: 1-65535 默认取值: 10 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
docs |
Array of FileDocInfo objects |
参数解释: 文件分片列表。 取值范围: 不涉及 |
page_num |
Long |
参数解释: 请求中的页码。 取值范围: 不涉及 |
page_size |
Long |
参数解释: 请求中的分页大小。 取值范围: 不涉及 |
total |
Long |
参数解释: 分片总数。 取值范围: 不涉及 |
version |
Integer |
参数解释: 版本信息。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 取值范围: 不涉及 |
请求示例
获取FAQ文件切片信息。
/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/faq/batch/7d91f97d-5e31-443a-bfe4-1707985e0d0a/docs?page_size=10&page_num=1
响应示例
状态码:200
获取FAQ文件切片信息响应体。
{ "page_num" : 1, "page_size" : 10, "total" : 2, "docs" : [ { "id" : "b2c69a8e-1c6d-4f38-b9d9-7e92e0f681f2_0", "timestamp" : "1716792840094", "title" : "无法登录我的账户怎么办?", "content" : "请确保你使用的是正确的用户名和密码。如果仍然无法登录,请尝试重置密码或联系客服。" }, { "id" : "9ac75dd7-5f5d-407e-a99a-05255c20c40a_0", "timestamp" : "1716792840094", "title" : "如何申请入学?", "content" : "请查看我们的官方网站或联系招生办公室,了解入学要求、申请截止日期和所需材料。我们还提供入学顾问服务。" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
获取FAQ文件切片信息响应体。 |
错误码
请参见错误码。