FLEXUSSEARCHSERVICE-生成答案:请求参数

时间:2025-02-12 14:58:39

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:1000000

表2 请求Body参数

参数

是否必选

参数类型

描述

repo_id

String

知识库ID

获取方式:

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

最小长度:1

最大长度:64

chat_id

String

对话ID

最小长度:1

最大长度:64

messages

Array of ChatMessage objects

对话内容

数组长度:1 - 19

chat_create_flag

String

对话开始标志( 0-否,1-是)

最小长度:1

最大长度:1

refresh_flag

String

问答刷新标志(0-否,1-是)

最小长度:1

最大长度:1

max_tokens

Integer

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

最小值:1

最大值:131072

缺省值:2048

stream

Boolean

流式输出标志

缺省值:false

filter_string

String

RAG搜索环节过滤。

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

例如:tags:(魔都 OR 首都) AND category:"城市(city)"

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

最小长度:4

最大长度:1024

top_p

Float

一种替代温度采样的方法,称为nucleus sampling,其中模型考虑具有top_p 概率质量的标记的结果。通常建议更改此值或温度,但不要同时更改两者。通常建议更改top_p或temperature来调整生成文本的倾向性,但不要同时更改这两个参数。 取值范围:(0, 1]

最小值:0.1

最大值:1

缺省值:0.1

presence_penalty

Float

用于调整模型对新Token的处理方式。即如果一个Token已经在之前的文本中出现过,那么模型在生成这个Token时会受到一定的惩罚。当presence_penalty的值为正数时,模型会更倾向于生成新的、未出现过的Token,即模型会更倾向于谈论新的话题。 最小值:-2 最大值:2

最小值:-2

最大值:2

缺省值:0

search_temperature

Float

搜索增强场景用于控制生成文本的多样性和创造力。 取值接近0表示最低的随机性,1表示最高的随机性。一般来说,temperature越低,适合完成确定性的任务。temperature越高,例如0.9,适合完成创造性的任务。

最小值:0

最大值:1

缺省值:0.3

chat_temperature

Float

非搜索增强场景用于控制生成文本的多样性和创造力。 取值接近0表示最低的随机性,1表示最高的随机性。一般来说,temperature越低,适合完成确定性的任务。temperature越高,例如0.9,适合完成创造性的任务。

最小值:0

最大值:1

缺省值:0.8

extra_repo_ids

Array of strings

多知识库问答

最小长度:1

最大长度:64

数组长度:1 - 10

表3 ChatMessage

参数

是否必选

参数类型

描述

role

String

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

最小长度:1

最大长度:100

content

String

对话内容

最小长度:1

最大长度:4096

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