文档

参数说明

本文对OpenSearch-LLM智能问答版的自定义进行参数说明和语法说明。

问答参数

参数说明

参数

类型

必需

取值范围

默认值

描述

模型选择

String

-

opensearch-qwen

表示该次搜索使用的LLM大模型。可选择的模型请参考:LLM管理

Prompt

String

-

系统默认模板

表示该次搜索使用的Prompt。可选择的Prompt请参考:Prompt管理

多轮对话

Boolean

-

true

  • false:表示多轮对话关闭;

  • true:表示多轮对话开启,将结合近n轮对话内容返回结果;

  • session:用于标识对话来源,相同的对话来源会根据上下文进行对话。

流式输出

Boolean

-

true

  • false:表示流式输出关闭;

  • true:表示流式输出开启,将实时输出模型回答结果。

Prompt参数

参数说明

参数

类型

必需

取值范围

默认值

描述

attitude

String

-

normal

  • 对话内容的语气,默认为normal

  • normal:无

  • polite:使用和蔼和礼貌的语气

  • patience:使用委婉和耐心的语气

rule

String

-

simple

对话内容的详细程度,默认为detailed

  • detailed:详细和专业

  • stepbystep:详细且按步骤

noanswer

String

-

sorry

无法回答问题时的回复,默认为sorry

  • sorry:抱歉,根据已知信息无法回答该问题

  • uncertain:我不知道

language

String

-

Chinese

回答问题使用的语言,默认为Chinese

  • Chinese:中文

  • English:英语

  • Thai:泰语

  • Korean:韩语

role

Boolean

-

true

开启后,将定制回答的角色。

role_name

String

-

AI小助手

定制回答的角色,例如:AI小助手

out_format

String

-

text

输出内容的形式,默认为text

  • text:文本

  • table:表格

  • list:列项

  • markdown:markdown

文档召回参数

参数说明

参数

类型

必需

取值范围

默认值

描述

filter

String

-

-

召回文档时根据目标字段进行过滤。例:filter = field = value

top_n

Int

(0, 50]

5

召回的文档数。

sf

Float

[0,+∞)

1.3

文档召回的阈值,sf越大则召回文档的向量相似度越小。

dense_weight

Float

(0,1)

0.7

选择稀疏向量模型时可选,表示稠密向量的权重,取值(0,1) 的浮点数,稀疏向量的权重则为 1 - dense_weight。

formula

String

-

向量相似度

文档召回的排序公式。

operator

String

-

AND

文本召回时,文本token之间的关系。

语法说明

参数

语法说明

filter

过滤条件格式为:field=value

示例:

  1. 只从category为value1的doc中获取数据

    "filter" : "category=\"value1\""

  2. 只从category为value1和value2的doc中获取数据

    "filter" : "category=\"value1\" OR category=\"value2\""

  3. category多值过滤

    category字段的多值传参的时候,每个item需要用英文逗号隔开
    eg:category =  类别1,类别2,类别3,类别4
    "filter" : "category=\"类别1\""  //category对应的value可以是传入多值的任意item

top_n

top_n:value eg: top_n = 3 可根据实际需要调节top_n参数大小

sf

sf=value eg:sf = 1.3 可根据预期调节sf参数的值,值越小越相关。

formula

  • 文本相关性

  1. text_relevance: 关键词在字段上的文本匹配度

  2. field_match_ratio: 获取某字段上与查询词匹配的分词词组个数与该字段总词组个数的比值

  3. query_match_ratio:获取查询词中(在某个字段上)命中词组个数与总词组个数的比值

  4. fieldterm_proximity: 用来表示关键词分词词组在字段上的紧密程度

  5. field_length:获取某个字段上的分词词组个数

  6. query_term_count: 返回查询词分词后词组个数

  7. query_term_match_count:获取查询词中(在某个字段上)命中文档的词组个数

  8. field_term_match_count:获取文档中某个字段与查询词匹配的词组个数

  9. query_min_slide_window:查询词在某个字段上命中的分词词组个数与该词组在字段上最小窗口的比值

  • 时效性

  1. timeliness: 时效分,用于衡量文档的新旧程度,单位为秒

  2. timeliness_ms: 时效分,用于衡量文档的新旧程度,单位为毫秒

  • 功能性

  1. tag_match: 用于对查询语句和文档做标签匹配,使用匹配结果对文档进行算分加权

  2. first_phase_score: 获取粗排表达式最终计算分值

  3. kvpairs_value: 获取查询串中kvpairs子句中指定字段的值

  4. normalize:归一化函数,根据不同的算分将数值归一化至[0, 1]

  5. in和notin: 判断字段值是否(不)在指定列表中

参考图片参数

参数说明

参数

类型

必需

取值范围

默认值

描述

sf

Float

[0,+∞)

1

参考图片的阈值,对于稀疏向量模型sf越大则参考图片与内容的向量相似度越大,对于稠密向量模型sf越大则参考图片与内容的向量相似度越小。

dense_weight

Float

(0,1)

0.7

选择稀疏向量模型时可选,表示稠密向量的权重,取值(0,1) 的浮点数,稀疏向量的权重则为 1 - dense_weight。

语法说明

参数

语法说明

sf

sf=value eg:sf = 1 可根据预期调节sf参数的值,需要区分是否为稀疏向量模型

Query理解参数

参数说明

参数

类型

必需

取值范围

默认值

描述

query_extend

Boolean

-

false

开启后会扩展Query,提升召回质量

query_exten_num

Int

(0,+∞)

5

扩展Query的数量

人工干预参数

人工干预参数说明

参数

类型

必需

取值范围

默认值

描述

sf

Float

[0,2]

0.3

人工干预问题的阈值,默认为0.3,sf越大则越容易匹配到人工干预词条

语法说明

参数

语法说明

sf

sf=value eg:sf = 0.3 可根据预期调节sf参数的值,sf越大则越容易匹配到人工干预词条

其它参数

其它参数说明

参数

类型

必需

取值范围

默认值

描述

return_hits

Boolean

-

false

是否在结果中返回文档召回的结果,如果不返回就只有参考链接。

csi_level

String

-

strict

绿网配置

  • none: 表示不需要经过绿网处理

  • loose: 内容需要经过绿网处理,且只有绿网判断确定存在敏感内容,就会被拦截,返回无结果

  • strict: 内容需要经过绿网处理,且一旦绿网判断确定或者疑似存在敏感内容,就会被拦截,返回无结果

history_max

INT

(0,20]

20

多轮对话历史最大轮数,最大20轮

link

Boolean

-

false

是否在结果中返回文档召回的具体来源

语法说明

参数

语法说明

return_hits

return_hits:false eg:return_hits = true 返回对应的搜索结果

link

包含内容的返回信息实例如下:

可以通过在线扩容和离线扩容两种方式扩容ECS云盘容量[^1^]。在线扩容无需重启实例,离线扩容需要重启实例[^1^]。具体操作步骤为:在ECS控制台上选择待扩容的云盘,在操作列选择扩容,然后根据需要选择扩容方式[^1^]。如果需要扩容分区和文件系统,可以通过命令行获取或者通过控制台获取[^2^]。扩容云盘容量后,新容量生效后无法再缩小,建议合理规划存储空间[^3^]。
说明

其中被'[^' 和 '^]' 包括起来的数字表示引用结果中reference里的第几个文档。例如'[^1^]'表示应用reference中的第一个文档。