authorization

String

否

"Bearer b6adc01e819c4ad****"

开放平台网关鉴权；直连 VeraG 时使用 /system/api_key 生成的 Bearer API Key。

app_id

Number

否

1

已发布检索应用 ID。开放调用时必填；未传 app_id 时可使用 dialog_id。

dialog_id

Number

是

1

检索应用 ID。开放调用必填，且必须与 API Key 绑定的应用一致。

question

String

是

"今日天气"

检索关键词或问题。

rag_setting

Object

是

{}

本次调用的召回参数。开放调用必填。详细参数说明参见下文 rag_setting 表

metadata

Object

否

{}

扩展参数。支持通过 metadata.rag_setting 覆盖召回参数。

kb_ids

Array

否

[1, 2, 3]

知识库 ID 列表，开放调用必填且不能为空。

doc_ids

Array

否

[1, 2, 3]

限定检索的文档 ID 列表；为空表示不按文档限定。

graph_ids

Array

否

[1, 2, 3]

知识图谱 ID 列表，当前为预留字段。

ontology_ids

Array

否

[1, 2, 3]

本体 ID 列表，当前为预留字段。

enable_kb_priority

Boolean

否

false

是否启用知识库优先级。启用后按 kb_priority 的 P0/P1/P2 分组优先召回。

kb_priority

Object

否

{
p0: [1, 2, 3],
p1: [4, 5, 6],
p2: [7, 8, 9]
}

知识库优先级配置，key 固定为 p0、p1、p2，value 为知识库 ID 列表。

similarity_threshold

Number

否

0.2

混合相似度阈值，仅召回综合得分大于等于该阈值的切片。

dense_weight

Number

否

0.5

向量检索权重。值越低越偏关键词匹配，值越高越偏语义向量匹配。

top_k

Number

否

30

初筛候选切片数。

top_n

Number

否

30

最终返回切片数。

enable_rerank

Boolean

否

false

是否启用语义重排序模型。

enable_llm_rerank

Boolean

否

false

是否启用大模型重排序。

rank_score_threshold

Number

否

0.5

重排序分数阈值，仅在重排序场景生效。

label_value_ids

Array

否

[100]

知识标签值 ID 列表。同一标签内多个值为或，不同标签之间为且。

enable_agent_enhance_search

Boolean

否

false

是否开启智能检索。开启后会通过大模型增强检索关键词。

extra

Object

否

{}

透传给底层召回服务的扩展参数。

code

Number

是

0

响应码：0=成功，非0=失败

msg

String

否

"success"

Code非0时，返回错误信息

message

String

否

"success"

消息内容

data

Object

是

{}

数据，详细参数说明参见下文 data 表

total

Number

是

5

总数

chunks

Array

是

[]

检索结果，详细参数说明参见下文 chunks 表

doc_aggs

Array

是

[]

文档聚合，详细参数说明参见下文 doc_aggs 表

summary

String

否

"天气情况如下：..."

智能检索基于召回内容生成的总结回答

kb_ids

Array

是

["1"]

知识库标识符

chunk_id

String

是

"1"

分段标识符

content_with_weight

String

是

"1"

分段权重

doc_id

String

是

"1"

文档 ID

important_kwd

Array

是

["天气"]

核心关键词

image_id

String

是

"1"

图片 ID

similarity

Number

是

1

相似度

vector_similarity

Number

是

1

向量相似度

term_similarity

Number

是

1

词条相似度

docnm_kwd

String

是

""

文档相关数据

content_ltks

String

是

""

内容标签

highlight

String

否

""

高亮片段

question

String

否

""

检索关键词或问题

extra

Object

否

{}

扩展参数

rank_score

Number

否

1

排名分数

source

String

否

""

数据源

character_count

Number

否

1

当前切片的字符数

duration

String

否

""

切片时长/定位信息

url

String

否

""

文档文件 URL

title

String

否

""

从表格表头中提取出的分段标题

doc_id

String

是

"1"

文档 ID

doc_name

String

是

"测试文档"

文档名称

count

Number

是

1

数量

create_time

String

否

""

创建时间

labels

Array

否

[]

文档标签

avg_score

Number

否

1

平均分

semantic_score

Number

否

1

语义分

text

String

否

""

文本