云搜索服务 CSS_企业搜索服务 KOOSEARCH-生成答案:请求参数

时间:2025-07-23 16:05:55

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

接口鉴权使用的Token,Token获取方式参考:3.2节 认证鉴权。

约束限制:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

repo_id

String

参数解释:

知识库ID。

获取方式:

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

约束限制:

不显示。

extra_repo_ids

Array of strings

参数解释:

引用知识库标识列表,用于支持多个知识库联合检索的场景。

约束限制:

不限制。

chat_id

String

参数解释:

当前对话ID。

约束显示:

不涉及。

messages

Array of ChatMessage objects

对话内容。

chat_create_flag

String

参数解释:

是否开启一轮新的对话( 0-否,1-是)。

1:清空历史对话,开始一轮新的对话。

0:延续chat_id所在的对话上下文。

约束限制:

不涉及。

refresh_flag

String

参数解释:

是否清空问答历史(0-否,1-是)。

1:清空历史对会话。

0:不清空历史会话。

约束限制:

不涉及。

max_tokens

Integer

参数解释:

模型生成文本的最大token数量。

约束限制:

输入的文本加上生成的文本总量不能超过模型所能处理的最大长度。

最小值:1

stream

Boolean

参数解释:

是否使用流式输出模式。

约束限制:

不涉及。

filter_string

String

参数解释:

RAG搜索环节,指定过滤字段。

带语法的查询字符串,使用具有严格语法的解析器,根据提供的查询字符串返回文档。

例如:tags:(教育 OR 金融) AND category:"行业知识"

注意事项:

1.支持布尔运算符 AND、OR 和 NOT(也写为 &&、|| 和 !),但请注意它们不遵守通常的优先级规则,因此只要一起使用多个运算符,就应使用括号。

2.详细语法参考query_string语法

约束限制:

不涉及。

top_p

Float

参数解释:

一种替代温度采样的方法,称为nucleus sampling,通过限制词汇的选择范围来控制生成文本的多样性。top_p值越高,候选单词越多,文本多样性越高。

约束限制:

通常建议更改top_p或temperature来调整生成文本的倾向性,但不要同时更改这两个参数。

取值范围:

0.1 ~ 1

默认取值:

0.1

presence_penalty

Float

参数解释:

控制生成的文本中重复内容的程度。presence_penalty的目的是减少模型在生成文本时重复使用相同或类似的内容,以提高生成文本的多样性。即如果一个Token已经在之前的文本中出现过,那么模型在生成这个Token时会受到一定的惩罚。

presence_penalty越小,模型考虑之前生成的Token越少,可能导致文本中出现重复内容。

presence_penalty越大,模型会更倾向于生成新的、未出现过的Token,生成的文本会更加多样化。

取值范围:

-2 ~ 2,具体的取值需要权衡,盘古NLP模型一般情况下可以取1.1。

默认取值:

0

search_temperature

Float

参数解释:

搜索增强场景下,控制模型生成文本的多样性和创造力。

取值接近0表示最低的随机性,1表示最高的随机性。一般来说,temperature越低,适合完成确定性的任务。temperature越高,例如0.9,适合完成创造性的任务。

约束限制:

不涉及。

取值范围:

0 ~ 1,盘古NLP模型一般设置为0.2/0.3。

默认取值:

0.3

chat_temperature

Float

参数解释:

非搜索增强场景下,用于控制模型生成文本的多样性和创造力。

取值接近0表示最低的随机性,1表示最高的随机性。一般来说,temperature越低,适合完成确定性的任务。temperature越高,例如0.9,适合完成创造性的任务。

约束限制:

不涉及。

取值范围:

0 ~ 1。

表3 ChatMessage

参数

是否必选

参数类型

描述

role

String

参数解释:

~~对话的角色,取值为system、user。~~

待删除字段,无需使用。

约束限制:

待删除字段,无需使用。

content

String

参数解释:

用户输入的对话内容。

约束限制:

不涉及。

support.huaweicloud.com/api-koosearch/GenerateAnswer.html