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

创建FAQ

功能介绍

输入问题、相似问题、答案,创建单条FAQ。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

repo_id

String

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

获取方式:

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

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:1000000

表3 请求Body参数

参数

是否必选

参数类型

描述

question

String

问题

最小长度:1

最大长度:1000

answer

String

答案

最小长度:1

最大长度:10000

repo_id

String

知识库ID

获取方式:

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

最小长度:1

最大长度:64

question1

String

相似问题

最小长度:0

最大长度:1000

question2

String

相似问题

最小长度:0

最大长度:1000

question3

String

相似问题

最小长度:0

最大长度:1000

question4

String

相似问题

最小长度:0

最大长度:1000

category

String

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

最小长度:0

最大长度:255

tags

String

标签列表,多个标签以逗号分隔。

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

最小长度:0

最大长度:4096

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

faq_id

String

创建的FAQ的ID

最小长度:1

最大长度:64

请求示例

响应示例

状态码: 200

成功

{
  "faq_id" : "64b4a1bc-3e60-43dd-981c-d24828ddc8ac"
}

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档