更新时间:2024-08-27 GMT+08:00
分享

获取FAQ

功能介绍

根据ID获取FAQ详情,包括问题、答案。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

faq_id

String

FAQ ID,1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

获取方式:

  1. 账号登录KooSearch体验平台

  2. 左侧导航栏选择:"KooSearch-KooSearch文档问答"

  3. 根据"名称/ID",选择购买的服务,单击"问答",进入KooSearch文档问答管理页面

  4. 左侧导航栏选择:"知识库管理" ,在知识库列表中,选择目标知识库,单击其ID进入

  5. 单击"FAQ管理",即可查看FAQ列表,获取某条FAQ的ID

最小长度:1

最大长度:64

repo_id

String

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

获取方式:

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

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:1000000

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

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

请求示例

响应示例

状态码: 200

成功

{
  "id" : "5323205cfa9244b385ff5968ece0cd9a",
  "repo_id" : "123",
  "question" : "问题",
  "answer" : "答案",
  "status" : 0,
  "create_time" : "1716284755573",
  "update_time" : "1716284755573"
}

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档