# 查询FAQ列表 - ListFaqs #### 功能介绍 获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。 #### URI GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/faq 表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个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 | | repo_id | 是 | String | **参数解释：** 知识库ID。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性。 **约束限制：** 不涉及 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | question | 否 | String | **参数解释：** 问题关键字。 **约束限制：** 不涉及 **取值范围：** 长度不能超过1000个字符。 **默认取值：** 不涉及 | | answer | 否 | String | **参数解释：** FAQ答案。 **约束限制：** 不涉及 **取值范围：** 长度不能超过10000个字符。 **默认取值：** 不涉及 | | page_num | 否 | Integer | **参数解释：** 当前请求的页码，表示从第几页开始获取数据。默认值为1，表示第一页。 **约束限制：** 不涉及 **取值范围：** 1～65535 **默认取值：** 1 | | page_size | 否 | Integer | **参数解释：** 每页显示的记录数，表示一次请求返回的数据条数。默认值为10，表示一页展示10条数据。 **约束限制：** 不涉及 **取值范围：** 1-65535 **默认取值：** 10 | | ids | 否 | Array of strings | **参数解释：** faq id列表。 **约束限制：** 不涉及 **取值范围：** 每个ID只能包含1到64位数字、字母、中划线和下划线。 **默认取值：** 不涉及 | | create_user | 否 | String | **参数解释：** 创建者名字 **约束限制：** 不涉及 **取值范围：** 用户名长度1-64位 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 接口鉴权使用的Token，Token获取方式参考：[获取IAM用户Token](https://support.huaweicloud.com/api-koosearch/koosearch_06_0009.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | records | Array of [FaqInfo] objects | **参数解释：** Faq信息。 **取值范围：** 不涉及 | | total | Integer | **参数解释：** 总数量。 **取值范围：** 不涉及 | | size | Integer | **参数解释：** 每页数量。 **取值范围：** 不涉及 | | current | Integer | **参数解释：** 当前页码。 **取值范围：** 不涉及 | | optimize_count_sql | Boolean | **参数解释：** 无实际意义，可忽略。 **取值范围：** 不涉及 | | search_count | Boolean | **参数解释：** 无实际意义，可忽略。 **取值范围：** 不涉及 | | pages | Integer | **参数解释：** 总页数。 **取值范围：** 不涉及 | 表5FaqInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** faq的ID。 **取值范围：** 不涉及 | | repo_id | String | **参数解释：** 知识库ID。 **取值范围：** 不涉及 | | question | String | **参数解释：** 问题。 **取值范围：** 不涉及 | | answer | String | **参数解释：** 答案。 **取值范围：** 不涉及 | | status | String | **参数解释：** 无实际意义，可忽略。 **取值范围：** 不涉及 | | create_user | String | **参数解释：** 创建人。 **取值范围：** 不涉及 | | create_time | String | **参数解释：** 创建时间。 **取值范围：** 不涉及 | | update_time | String | **参数解释：** 更新时间。 **取值范围：** 不涉及 | | question1 | String | **参数解释：** 相似问1。 **取值范围：** 不涉及 | | question2 | String | **参数解释：** 相似问2。 **取值范围：** 不涉及 | | question3 | String | **参数解释：** 相似问3 **取值范围：** 不涉及 | | question4 | String | **参数解释：** 相似问4。 **取值范围：** 不涉及 | | category | String | **参数解释：** 目录，单值，对应目录树中的叶子节点。 **取值范围：** 不涉及 | | tags | Array of strings | **参数解释：** 标签列表。 1. 文档可以有一个或多个标签 2. 建议标签值不区分大小写 3. 不要使用保留字符，否则查询时需要转义：*+ - = \&\& \|\| \> \< ! ( ) { } \[ \] \^ " \~ \* ? : \\ /* 4. 完整替换，不支持部分更新。 **取值范围：** 不涉及 | | file_id | String | **参数解释：** 文件ID。 **取值范围：** 不涉及 | | project_id | String | **参数解释：** 项目ID **取值范围：** 不涉及 | | component_num | Integer | **参数解释：** 切片顺序 **取值范围：** 不涉及 | | page_num | Integer | **参数解释：** 页码数量。 **取值范围：** 不涉及 | #### 请求示例 查询FAQ列表实例。 ``` /v1/12345678/applications/12345678/uni-search/12345678aaa/faq?page_num=1&page_size=10&question=你好 ``` #### 响应示例 **状态码：200** 查询成功。 ``` { "records" : [ { "id" : "991a482a-8330-4338-bdda-32852504bb38", "repo_id" : "b4254b30-f241-476c-b003-63df8f1cc221", "question" : "无法登录我的账户怎么办？", "answer" : "请确保你使用的是正确的用户名和密码。如果仍然无法登录，请尝试重置密码或联系客服。", "status" : 0, "create_time" : "1700807345932", "update_time" : "1700807345932" }, { "id" : "d3477f5c-f7d7-409c-a709-b56df8a7341c", "repo_id" : "b4254b30-f241-476c-b003-63df8f1cc221", "question" : "如何申请入学？", "answer" : "请查看我们的官方网站或联系招生办公室，了解入学要求、申请截止日期和所需材料。我们还提供入学顾问服务。", "status" : 0, "create_time" : "1700807328240", "update_time" : "1700807328240" } ], "total" : 2, "size" : 10, "current" : 1, "optimize_count_sql" : true, "search_count" : true, "pages" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。