调用本接口在当前应用 Token 绑定用户的个人知识库内召回相关 Chunk;支持限定文档和召回参数。
请求体为 Object 类型,个人知识库召回参数;KB、tenant 和空间归属全部由服务端上下文确定。包含参数说明如下:
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
question | String | 是 | 召回问题 |
doc_ids | Array | 否 | 限定召回的个人库文档;不传或传空列表表示召回当前个人知识库 |
top_k | Number | 否 | 底层最多召回的切片数 |
top_n | Number | 否 | 最终最多返回的切片数 |
similarity_threshold | Number | 否 | 相似度阈值 |
dense_weight | Number | 否 | 向量相似度权重 |
enable_rerank | Boolean | 否 | 是否启用重排序 |
enable_llm_rerank | Boolean | 否 | 是否启用大模型重排序 |
rerank_score_threshold | Number | 否 | 重排分数阈值 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
code | Number | 是 | 响应码:0=成功,非0=失败 |
msg | String | 否 | Code非0时,返回错误信息 |
message | String | 否 | 错误信息 |
data | Object | 是 | 数据,详情请参见下文 data 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
total | Number | 是 | 总数 |
chunks | Array | 是 | 检索结果,包含的检索切片详情请参见下文 chunks 表 |
doc_aggs | Array | 是 | 文档聚合,详情请参见下文 doc_aggs 表 |
summary | String | 否 | 智能检索基于召回内容生成的总结回答 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
kb_id | Array | 是 | 知识库ID |
kb_name | Array | 否 | 知识库名称 |
chunk_id | String | 是 | 切片ID |
content_with_weight | String | 是 | 带权重的文本内容 |
doc_id | String | 是 | 文档ID |
important_kwd | Array | 是 | 重要关键词 |
image_id | String | 是 | 图片ID |
similarity | Number | 是 | 相似度 |
vector_similarity | Number | 是 | 向量相似度 |
term_similarity | Number | 是 | 关键词相似度 |
docnm_kwd | String | 是 | 文档名关键词 |
display_name | String | 否 | 文档展示名称 |
content_ltks | String | 是 | 切片内容词元 |
highlight | String | 否 | 高亮 |
question | String | 否 | 问题 |
extra | Object | 否 | 额外数据 |
rank_score | Number | 否 | 排序分数 |
source | String | 否 | 来源 |
character_count | Number | 否 | 当前切片的字符数 |
duration | String | 否 | 切片时长/定位信息 |
url | String | 否 | 文档文件URL |
title | Array | 否 | 切片标题 |
channel_score | Object | 否 | 召回链路分项明细,key 为 channel 名;value 为 JSON 解析结果或原始字符串 |
channel_name | String | 否 | 召回链路名 |
orig_similarity | Number | 否 | 原始 chunk 召回相似度(融合前) |
orig_rerank_score | Number | 否 | 原始重排分数(融合前) |
doc_meta_recall_similarity | Number | 否 | doc_meta_recall 召回总分(多路融合后) |
doc_meta_recall_scores | Object | 否 | doc_meta_recall 每路分数,key 为 channel name |
doc_meta_recall_channel_name | String | 否 | 命中的 doc_meta_recall channel 名称;strategy=weight 时为多路名逗号分隔,其他策略为分数最高的那路 |
is_personal_kb | Boolean | 否 | 是否来自个人知识库 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
doc_id | String | 是 | 文档ID |
tenant_id | Number | 否 | 租户ID |
kb_id | Number | 否 | 知识库ID |
doc_name | String | 是 | 文档名称 |
display_name | String | 否 | 文档展示名称 |
count | Number | 是 | 数量 |
create_time | String | 否 | 创建时间 |
labels | Array | 否 | 文档标签,详情请参见下文 labels 表 |
avg_score | Number | 否 | 平均分数 |
semantic_score | Number | 否 | 语义分数 |
text | String | 否 | 文本 |
is_personal_kb | Boolean | 否 | 是否来自个人知识库 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
create_time | Number | 否 | 创建时间戳 |
create_date | String | 否 | 创建时间 |
update_time | Number | 否 | 更新时间戳 |
update_date | String | 否 | 更新时间 |
label_id | Number | 是 | 标签ID |
label_name | String | 否 | 标签名称 |
label_type | String | 是 | 标签类型 |
label_values | Array | 否 | 标签值列表,详情请参见下文 label_values 表 |
label_value_builder | String | 否 | 标签值构建器
|
prompt_version | String | 否 | 提示词版本 |
label_usage | Number | 否 | 标签使用次数 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
id | Number | 是 | 标签值ID |
value | String | 否 | 标签值 |
value_usage | Number | 否 | 标签值使用次数 |
label_value_builder | String | 否 | 标签值构建器
|