
# 查询FAQ列表
#### 功能介绍
获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。
#### URI
GET /v1/koosearch/repos/{repo_id}/faqs
表1路径参数 
| 参数      | 是否必选 | 参数类型   | 描述                                                                                                                     |
|:---|:---|:---|:---|
| repo_id | 是    | String | 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性。 |
表2Query参数 
| 参数        | 是否必选 | 参数类型             | 描述                           |
|:---|:---|:---|:---|
| question  | 否    | String           | 问题关键字。                       |
| answer    | 否    | String           | FAQ答案。                       |
| page_num  | 否    | Integer          | 请求页码。                        |
| page_size | 否    | Integer          | 限定响应体每页返回的数据条数，例如5页/条，10页/条。 |
| ids       | 否    | Array of strings | faq的ID列表。                    |
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                           |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 接口鉴权使用的Token，Token获取方式参考：3.2节 认证鉴权。 **约束限制：** 不涉及。 |
   
#### 响应参数
**状态码：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_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.完整替换，不支持部分更新。 |
| component_num | Integer          | 所在分片位于文档分片的第几个，faq场景中固定为0。                                                                                                               |
| page_num      | Integer          | 所在分片位于文档的第几页，faq场景中固定为0。                                                                                                                 |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
返回成功。
```
{
  "records" : [ {
    "id" : "34dff58c-431a-47f1-96bc-b482f2474e3d",
    "repo_id" : "acd90739-2e22-4870-b2db-35018699b623",
    "question" : "无法登录我的账户怎么办？",
    "answer" : "请确保你使用的是正确的用户名和密码。如果仍然无法登录，请尝试重置密码或联系客服。",
    "status" : 0,
    "update_time" : "1731047738889",
    "component_num" : 0,
    "page_num" : 0
  }, {
    "id" : "4b92ec29-0151-4b33-8e0f-ff104b833099",
    "repo_id" : "acd90739-2e22-4870-b2db-35018699b623",
    "question" : "如何申请入学？",
    "answer" : "请查看我们的官方网站或联系招生办公室，了解入学要求、申请截止日期和所需材料。我们还提供入学顾问服务。",
    "status" : 0,
    "update_time" : "1731047751205",
    "component_num" : 0,
    "page_num" : 0
  } ],
  "total" : 2,
  "size" : 10,
  "current" : 1,
  "pages" : 1
}
```
#### 状态码
| 状态码 | 描述    |
|:---|:---|
| 200 | 返回成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。
