文档首页/ 华为云Flexus云服务_Flexus企业搜索服务/ API参考/ FAQ管理/ 查询FAQ列表
更新时间：2024-08-27 GMT+08:00
查看PDF
分享

查询FAQ列表

功能介绍

获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。

URI

GET /v1/koosearch/repos/{repo_id}/faqs

表1 路径参数

参数

是否必选

参数类型

描述

repo_id

是

String

知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。

获取方式：

账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性

最小长度：1

最大长度：64
表2 Query参数

参数

是否必选

参数类型

描述

question

否

String

问题关键字

最小长度：0

最大长度：1000

repo_id

是

String

知识库ID

获取方式：

账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性

最小长度：1

最大长度：64

answer

否

String

FAQ答案

最小长度：0

最大长度：10000

page_num

否

Integer

请求页码

最小值：1

最大值：65535

缺省值：1

page_size

否

Integer

限定响应体每页返回的数据条数，例如5页/条，10页/条

最小值：1

最大值：65535

缺省值：10

ids

否

Array

faq id列表

最小长度：1

最大长度：64

数组长度：0 - 65535

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token

最小长度：1

最大长度：1000000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

records

Array of FaqInfo objects

Faq信息

数组长度：0 - 65535

total

Integer

总数量

最小值：0

最大值：65535

size

Integer

每页数量

最小值：0

最大值：65535

current

Integer

当前页码

最小值：0

最大值：65535

optimize_count_sql

Boolean

无实际意义，可忽略

search_count

Boolean

无实际意义，可忽略

pages

Integer

总页数

最小值：0

最大值：65535
表5 FaqInfo

参数

参数类型

描述

id

String

faq的ID

最小长度：1

最大长度：64

repo_id

String

知识库ID

最小长度：1

最大长度：64

question

String

问题

最小长度：1

最大长度：1000

answer

String

答案

最小长度：1

最大长度：10000

status

String

无实际意义，可忽略

最小长度：1

最大长度：64

create_time

String

创建时间

最小长度：0

最大长度：64

update_time

String

更新时间

最小长度：0

最大长度：64

question1

String

相似问1

最小长度：0

最大长度：1000

question2

String

相似问2

最小长度：0

最大长度：1000

question3

String

相似问3

最小长度：0

最大长度：1000

question4

String

相似问4

最小长度：0

最大长度：1000

category

String

目录，单值，对应目录树中的叶子节点

最小长度：0

最大长度：255

tags

Array of strings

标签列表

注意事项： 1文档可以有一个或多个标签 2.建议标签值不区分大小写 3.不要使用保留字符，否则查询时需要转义：+ - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ / 4.完整替换，不支持部分更新。

最小长度：1

最大长度：255

数组长度：0 - 250

请求示例

/v1/12345678/applications/12345678/uni-search/12345678aaa/faq??page_num=1&page_size=10&question=你好&repo_id=a12356455

响应示例

状态码： 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

成功

错误码

请参见错误码。

父主题： FAQ管理

相关文档