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

设置知识库通用无搜索的prompt

功能介绍

设置通用问答prompt。该prompt包含问题占位符{0},和对回答的要求。

URI

POST /v1/koosearch/repos/{repo_id}/common-prompt

表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参数

参数

是否必选

参数类型

描述

prompt

String

无搜索的prompt

最小长度:1

最大长度:8192

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

repo_id

String

响应字段

最小长度:1

最大长度:64

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

配置示例

/v1/koosearch/repos/919e8b10-b0c4-4bcd-9d5a-8ebb69594514/common-prompt

{
  "prompt" : "你是一名问题回答助手,请参考以下给出的文章回答问题。在回答问题之前,请你先仔细判给出的文章是否可以回答问题。如果给出的文章与问题不相关,则直接输出“抱歉,我无法回答此次问题“;如果给出的文章与问题相关,则参考给出的文章回答问题。\n给出的文章:\n{0}\n问题:{1}\n请你按照要求进行仔细判断后,给出你的回答:}"
}

响应示例

状态码: 200

设置通用prompt的知识库ID

{
  "repo_id" : "919e8b10-b0c4-4bcd-9d5a-8ebb69594514"
}

状态码

状态码

描述

200

设置通用prompt的知识库ID

400

请求体参数错误

500

内部异常

错误码

请参见错误码

相关文档