调用本接口按单表范围、精确过滤、语义字段、返回字段和排序参数执行混合检索并返回数据行。
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
kb_id | String | 是 | 结构化知识库 ID,由创建知识库或查询知识库列表接口返回 |
Object 类型,包含参数说明如下:
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
asset_id | String | 是 | 本次召回限定的数据资产 ID,仅支持单表召回 |
filters | Object | 否 | 字段精确过滤条件;支持根节点加一层条件组,最多 10 条叶子条件。详情请参见下文 filters 表 |
timezone | String | 否 | IANA 时区名称,例如 Asia/Shanghai;使用动态日期时必填 |
semantic_query | String | 否 | 语义搜索关键词,最多 200 个字符;纯过滤召回时可不传 |
vector_fields | Array | 否 | 参与语义召回的逻辑字段名,仅可选择已完成向量构建的字段 |
return_fields | Array | 是 | 召回结果需要返回的逻辑字段名,至少选择一个 |
candidate_count | Number | 否 | 进入排序阶段的初筛候选行数,必须大于等于 top_k |
top_k | Number | 否 | 最终返回的召回行数,范围 1 到 100 |
rank_config | Object | 否 | 详情请参见下文 rank_config 表 |
debug | Boolean | 否 | 是否启用调试模式;开放接口响应不会暴露底层编译请求 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
logic | String | 否 |
|
conditions | Array | 否 | 根节点的过滤条件列表。详情请参见下文 conditions 表 |
groups | Array | 否 | 一层嵌套条件组;全部叶子条件合计最多 10 条。详情请参见下文 groups 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
field | String | 是 | 参与过滤的逻辑字段名,字段必须已开启条件过滤 |
operator | String | 是 |
|
value | AnyOf(AnyOf 表示该字段可能返回多种数据结构中的一种或多种的集合 | 否 | 过滤值;is_null/is_not_null 可省略,between 使用双端 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
logic | String | 否 |
|
conditions | Array | 否 | 子组中的叶子条件;子组不能为空且不允许继续嵌套。详情请参见上文 conditions 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
rank_type | String | 否 |
|
vector_weight | Number | 否 | 混合检索中的向量得分权重,范围 0 到 1 |
hybrid_score_threshold | Number | 否 | 混合召回相似度阈值;低于阈值的候选会被过滤 |
rank_score_threshold | Number | 否 | 语义重排分数阈值;仅 semantic_rerank 生效 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
code | Number | 是 | 响应码:0=成功,非0=失败 |
msg | String | 否 | Code非0时,返回错误信息 |
message | String | 否 | 错误信息 |
data | Object | 否 | 数据。详情请参见下文 data 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
rows | Object | 否 | 按相关性排序的召回数据行。详情请参见下文 rows 表 |
summary | Object | 否 | 详情请参见下文 summary 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
rank | Number | 是 | 召回结果排名,从 1 开始 |
row_id | String | 是 | 命中数据行 ID,与 row_key 对应 |
hit_type | String | 否 | 命中类型,例如向量加过滤、仅向量或仅过滤 |
scores | Object | 否 | 混合召回分、向量分或重排分等评分集合,对象内数据类型为 Number |
source_asset | Object | 是 | 详情请参见下文 source_asset 表 |
values | Object | 否 | 按 return_fields 裁剪后的行数据 |
highlight_fields | Array | 否 | 命中过滤或语义召回的逻辑字段名 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
kb_id | String | 否 | 命中行所属的结构化知识库 ID |
asset_id | String | 否 | 命中行所属的数据资产 ID |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
total | Number | 否 | 本次召回返回的数据行数量 |
log_id | String | 否 | 召回链路日志 ID,供问题排查使用 |