知识库检索
在指定的知识库里,检索并提取相关的信息片段。
权限说明
调用本API,需使用API Key鉴权方式。Authorization的值为Bearer
请求参数
多选一,只需要符合下列任意一组子节点
用户查询内容。
显示子属性
隐藏子属性
Object类型示例:
[ { "type": "text", "text": "北京天气如何?" } ]
显示子属性
隐藏子属性
内容类型,目前仅支持text类型。
用户需要查询的内容。
String类型示例:
"query": "北京天气如何?"
多选一,只需要符合下列任意一组子节点
指定要检索的知识库ID。
显示子属性
隐藏子属性
知识库ID列表。
["knowledgebase_id1", "knowledgebase_id2"]
显示子属性
隐藏子属性
知识库ID。
"knowledgebase_id1"
筛选检索范围。
显示子属性
隐藏子属性
过滤条件,与tag_filters参数二选一。
显示子属性
隐藏子属性
显示子属性
隐藏子属性
操作符名称:
==:文档id(doc_id)等于value。in:文档id(doc_id)符合数组中的任一值。not_in:文档id(doc_id)不在数组中。
过滤字段,field仅为doc_id。
多选一,只需要符合下列任意一组子节点
取值。
显示子属性
隐藏子属性
当operator为==时,value为string类型。
当operator为in或not_in时,value为array类型。
显示子属性
隐藏子属性
标签过滤条件,与filters参数二选一。
显示子属性
隐藏子属性
显示子属性
隐藏子属性
操作符名称:
==:field等于value。in:field符合数组中的任一值。not_in:field不在数组中。
过滤字段,field不限制。
多选一,只需要符合下列任意一组子节点
取值。
显示子属性
隐藏子属性
当operator为==时,value为string类型。
当operator为in或not_in时,value为array类型。
显示子属性
隐藏子属性
筛选条件。
and:所有条件均满足,才会返回结果。or:任一条件满足,则返回结果。
检索策略配置。
在RAG流程中的召回阶段所采用的策略。召回的目标是从海量的知识库中,快速、准确地找出与用户问题最相关的一批信息片段(Chunks)。
显示子属性
隐藏子属性
召回策略类型,默认值hybrid
fulltext:全文检索semantic:向量检索hybrid:混合检索
召回策略返回的条目数:
type=hybrid,范围[1,200]type=semantic,范围[1,200]type=fulltext,范围[1,400]
混合检索模式下的权重,与type=hybrid搭配使用,范围[0-1]。
重排序配置。
显示子属性
隐藏子属性
是否启用重排序,默认开启。
重排后保留的条目数量。范围[1,40],默认值20。
是否开启图谱检索,默认不开启。
是否开启扩展切片(上下文扩展),默认不开启。
最终返回给用户的检索内容条数。范围[1,40],默认值6。 如果检索结果的数量未达到top_k值,则按实际检索到的结果数量返回。
综合得分阈值,只有得分大于等于该值的切片才会被筛选出来。范围[0,1],默认值0.4。
POST /v2/knowledgebases/search HTTP/1.1
Host: qianfan.baidubce.com
Authorization: Bearer <您的API Key>
Content-Type: application/json
{
"query": [
{
"type": "text",
"text": "请介绍下千帆大模型知识库"
}
],
"knowledgebase_ids": [
"a5f3bcb7-xxxx-xxxx-ad50-351c64dc49f1"
],
"metadata_filters": {
"condition": "or",
"filters": [
{
"operator": "in",
"field": "doc_id",
"value": [
"70192f8c-xxxx-xxxx-9eda-dcb92f3308af",
"c382fb13-xxxx-xxxx-8c91-2e13ad12cf2a"
]
}
]
},
"recall": {
"type": "hybrid",
"top_k": 50,
"vec_weight": 0.8
},
"rerank": {
"enable": true,
"top_n": 6
}
}
示例代码
curl -X POST "https://qianfan.baidubce.com/v2/knowledgebases/search" \
-H "Host: qianfan.baidubce.com" \
-H "Authorization: Bearer <您的API Key>" \
-H "Content-Type: application/json" \
-d '{
"query": [{"type":"text","text":"请介绍下千帆大模型知识库"}],
"knowledgebase_ids": ["a5f3bcb7-xxxx-xxxx-ad50-351c64dc49f1"],
"metadata_filters": {
"condition": "or",
"filters": [{
"operator": "in",
"field": "doc_id",
"value": [
"70192f8c-xxxx-xxxx-9eda-dcb92f3308af",
"c382fb13-xxxx-xxxx-8c91-2e13ad12cf2a"
]
}]
},
"recall": {"type":"hybrid","top_k":50,"vec_weight":0.8},
"rerank": {"enable":true,"top_n":6}
}'
返回响应
检索内容,本次请求的唯一标识,可用于排查问题;无论请求成功与否必须返回。
本次请求的时间戳。
本次返回chunk数量,由top_k和score_threshold及实际召回的切片数量共同决定。
切片信息,检索结果按相关性从高到低排序显示。
显示子属性
隐藏子属性
显示子属性
隐藏子属性
唯一标识信息块的ID
信息块的重排得分(当请求参数的 enable_graph 为 true 时,图谱切片无此参数)
显示子属性
隐藏子属性
重排得分的具体数值
信息块重排的的排序
信息块的召回得分(当请求参数的 enable_graph 为 true 时,图谱切片无此参数)
显示子属性
隐藏子属性
召回得分的具体数值
信息块召回的排序
包含信息块的具体内容
显示子属性
隐藏子属性
显示子属性
隐藏子属性
切片数据类型,如 文本/图片/表格/混合
text(文本)
figure(图片)
table (表格)
graph (图谱)
type=text 返回的值。
当其他格式解析失败时,系统通过text字段返回。
type=graph 时存在,图谱信息
type=figure 时存在,图片标题
type=figure 时存在,图片详情
type=figure 时存在,图片地址
type=table 时存在,表头
显示子属性
隐藏子属性
显示子属性
隐藏子属性
type=table 时存在,行数据
关于信息块的元数据(当请求参数的 enable_graph 为 true 时,图谱切片没有除了 chunk_type 之外的参数)
显示子属性
隐藏子属性
信息块的类型,text(文本)| figure(图片)| table (表格)| mix(混合)
信息块的token数
信息块的字数
信息块的更新时间
关于文档的信息
显示子属性
隐藏子属性
文档的ID
文档的名称
文档的创建时间
文档的类型,如"pdf"
显示子属性
隐藏子属性
相关的信息块
显示子属性
隐藏子属性
关联 chunk 的 ID
关联 chunk 的距离
关联 chunk 内容对象
显示子属性
隐藏子属性
{
"chunks": [
{
"chunk_id": "fc153abf-e275-4458-87a3-e7aa3b69b1fe",
"rerank": {
"score": 0.4689730405807495,
"position": 1
},
"recall": {
"score": 0.4280477621739982,
"position": 7
},
"meta": {
"chunk_type": "text",
"tokens": 438,
"word_count": 570,
"update_time": 1755578217038,
"doc_info": {
"doc_id": "c9265ed3-d512-4f6e-86aa-3ced6fe938b0",
"doc_name": "AppBuilder",
"create_time": 1755578217038,
"doc_type": "pdf"
}
},
"content": [
{
"type": "text",
"text": "知识库管理\nAPI介绍\n本文介绍了千帆Appbuilder提供的知识库相关API能力,以及如何调用API的流程等。\n①API列表\n平台提供了覆盖知识检索、知识库管理等API能力,您可以根据具体需求在下表中选择使用。\n知识库检索:从指定的知识库中进行切片检索召回。\n创建知识库:为当前用户创建知识库。\n知识库详情:获取指定知识库详情。\n知识库列表:获取知识库列表。\n更新知识库:更新指定知识库。\n删除知识库:删除指定知识库。\n查询知识库文档列表:该接口用于查询指定知识库中的文档列表。\n上传文件到知识库:上传文件到知识库。\n导入url到知识库:导入到知识库,当前仅支持单个web的url导入。\n新增切片:为当前知识库中指定文档新增切片。\n获取切片列表:获取文件的切片列表。\n获取切片详情 :获取指定切片详情。\n更新切片:更新指定切片内容。\n删除切片:删除指定切片。\n①在线调试\n千帆AppBuilder提供了 API在线调试平台-示例代码 ,用于帮助开发者调试接口,平台集成快速检索、查看开发文档、查看在线\n调用的请求内容和返回结果、复制和下载示例代码等功能,简单易用,更多内容请查看API在线调试介绍。\n①错误码\n970\nBaidu 百度智能云文档\n在调用API请求后,可以通过返回的错误码、错误信息及排查建议等进行问题排查,请参考错误码。"
}
],
"neighbors": []
},
{
"chunk_id": "a1897622-9f59-438e-9340-8b1af24f1f32",
"rerank": {
"score": 0.465934157371521,
"position": 2
},
"recall": {
"score": 0.38351445838110804,
"position": 19
},
"meta": {
"chunk_type": "text",
"tokens": 286,
"word_count": 373,
"update_time": 1755578217038,
"doc_info": {
"doc_id": "c9265ed3-d512-4f6e-86aa-3ced6fe938b0",
"doc_name": "AppBuilder",
"create_time": 1755578217038,
"doc_type": "pdf"
}
},
"content": [
{
"type": "text",
"text": "\n①RAG概述\nRAG(Retrieval-Augmented Generation,检索增强生成)是一种结合了信息检索与生成式大语言模型(LLM)的AI框架。核心逻辑是:\n通过检索外部知识库获取相关信息,辅助生成模型生成更准确、相关、实时的内容\n它解决了传统生成模型的两大痛点——\n知识更新滞后\n(依赖训练数据,无法获取实时/私有知识)和\n幻觉问题\n(生成不准确或\n而知识库便是RAG的数据基础。\nRAG在Agent工作流程中的作用如下:\n821\nBaidu 百度智能云文档\nDoc\n解析分片\n向量化\nDB\nquery\n检索\n召回结果\nRAG检索\n用户输入\nAgent分析\n需要查询资料库?\n调用API/工具\n结果整合\n生成响应\n最终输出\n否\n需要其他工具调\n用?\n否千帆知识库模块提供丰富功能可供选择,覆盖多种业务场景。"
}
],
"neighbors": []
},
{
"chunk_id": "2a3fa272-c7f9-4ae5-8696-fc20c08af84b",
"rerank": {
"score": 0.46581268310546875,
"position": 3
},
"recall": {
"score": 0.39411397420664707,
"position": 13
},
"meta": {
"chunk_type": "text",
"tokens": 453,
"word_count": 590,
"update_time": 1755578217038,
"doc_info": {
"doc_id": "c9265ed3-d512-4f6e-86aa-3ced6fe938b0",
"doc_name": "AppBuilder",
"create_time": 1755578217038,
"doc_type": "pdf"
}
},
"content": [
{
"type": "text",
"text": "千帆\nAppBuilder支持应用添加知识库,大模型将基于你上传的知识文档回答问题,你可以通过引用知识库文件实现知识问答的功\n能。\n1. 知识库定义\n知识库定义:在知识库中依次点击添加知识库—创建知识库,进入知识库创建页面。填写知识库名称及知识库描述,方便知\n识库管理。案例将知识库命名为飞行行李计算。\n知识知识库高级配置飞行行李计算LRZ数据库+添加知识库已添加1个/共计可添加50个全部托管资源√索知识关键创建知识库知识库群组添加新增文件查看全部群组1/3有效文件/总数:3个/5个托管资源:共享资源移新增文件查看有效文件/总数:23个/23个托管资源:共享资源.添加新增文件查看有效文件/总数:208个/208个托管资源:共享资源定义知识库知识库名称:飞行行李计算LRZ9/50仅支持中文、英文、数字、下划线()、中划线(-)、英文点(。)知识库描述:请输入知识库描述,建议按照模板内容来填写0/400使用模板所属群组:全部群组√2. 托管切片\n托管切片:可以选择知识切片的托管及检索资源,App Builder共享资源是默认的小规模检索资源,百度\nElasticsearch(BES)支持检索更大的文件数量规模,配合BOS使用不限制上传文档数量,并且数据隔离,更加安全,百度\n向量数据库VectorDB与BES类似,但性能更优。案例使用App Builder共享资源。"
}
],
"neighbors": []
},
{
"chunk_id": "9b3fd947-aad4-4435-88a3-aa5427c40e5e",
"rerank": {
"score": 0.46077415347099304,
"position": 4
},
"recall": {
"score": 0.3923012914808096,
"position": 14
},
"meta": {
"chunk_type": "text",
"tokens": 443,
"word_count": 576,
"update_time": 1755578217038,
"doc_info": {
"doc_id": "c9265ed3-d512-4f6e-86aa-3ced6fe938b0",
"doc_name": "AppBuilder",
"create_time": 1755578217038,
"doc_type": "pdf"
}
},
"content": [
{
"type": "text",
"text": "参考资料年的2.(2)的点.4.[4度白更发度走上一的7请县人8.18国家博物古代中国一中国国物产业发的理,热.:工控共122国物库中国——中国建化艺术.白的化之的代中国6都大地文6.店204中陶地力多热之道业应.南闻县人民政府调试至效果满意后即可点击右上角“发布”至渠道。\n计费说明\n概述\n概述\n千帆AppBuilder提供了高效的企业级AI原生应用开发工具链,并支持在开发工具链的每一环灵活升降配资源,最大程度保障服务\n的可用性和性能。主要涵盖:开发过程中所需要的大模型资源、知识管理涉及的bos、vdb、bes资源,平台预置组件资源限时\n免费中,如有您的业务有更高并发需求可提交工单联系我们。单个用户在平台上的所有服务请求总和不得超过 10 QPS,如您\n有更高并发需求也可以提交工单联系我们。\n模型服务\n资源选择\n千帆AppBuilder打通了千帆ModelBuilder,为您提供在应用开发过程中所需要的一切大模型资源(文心一言底层模型、第三方开\n源大模型、客户定制模型),在应用开发过程中,平台提供了可供您免费体验测试的【平台赠送资源】,以及服务稳定按需付\n费的【专享资源】。您可根据实际业务需求,在确定模型后,选择对应的资源进行使用。模型资源的tokens消耗通常由输入、\n输出两部分的内容长度决定,您可使用模型token计算器进行测算。"
}
],
"neighbors": []
},
{
"chunk_id": "51c5f2ce-eca6-41c6-b1d0-a0ed8eb8cf93",
"rerank": {
"score": 0.4589245319366455,
"position": 5
},
"recall": {
"score": 0.3872341493454061,
"position": 17
},
"meta": {
"chunk_type": "text",
"tokens": 451,
"word_count": 587,
"update_time": 1755578217038,
"doc_info": {
"doc_id": "c9265ed3-d512-4f6e-86aa-3ced6fe938b0",
"doc_name": "AppBuilder",
"create_time": 1755578217038,
"doc_type": "pdf"
}
},
"content": [
{
"type": "text",
"text": "\n文档中心百度智能云千帆AppBuilderAgent新增长短期记忆,回复模式灵活配置!Q搜索本产品文档关键词13所有文档14评价此篇文章千帆AppBuilder多有帮助请求头域搜索本产品文档目录除公共头域外,无其它特殊头域。建知车本页目录请求参数创建数据库接口描述字段类型必填说明团队协作在线调试权限说明app_idstring是API&SDKapp_ld,来源于个人空间-应用-应用ID,应用分为自主规划agent和工作流agent。接口定义开发概述使用记忆时为终端用户ID,由用户自行定义与维护,限制6-64字符;该字段为记忆提供存储标识,若需完整使用记忆功能end_user_id必end_user_idstring请求结构是须输入。OpenAPI请求头城querystring是用户query文字,长度限制2000字符。请求参数概述streambool是是否以流式接口的形式返回数据,默认false。响应头城通用说明响应参数conversation_API服务域名string是对话ld,可通过新建会话接口创建。d请求curl示例错误码正确响应示例hle_ldsllst[string]如果在对话中上传了文件,可以将文件id放入该字段,目前只处理第一个文件。错误鸣应示例应用tool_choiceobject否控制大模型使用组件的方式,仅对自主规划Agent生效。"
}
],
"neighbors": []
},
{
"chunk_id": "f02d2f8b-d6a6-4b57-a922-0b43fc3702f7",
"rerank": {
"score": 0.45816683769226074,
"position": 6
},
"recall": {
"score": 0.4635895051233002,
"position": 1
},
"meta": {
"chunk_type": "text",
"tokens": 85,
"word_count": 111,
"update_time": 1755578217038,
"doc_info": {
"doc_id": "c9265ed3-d512-4f6e-86aa-3ced6fe938b0",
"doc_name": "AppBuilder",
"create_time": 1755578217038,
"doc_type": "pdf"
}
},
"content": [
{
"type": "text",
"text": "接口概览\n千帆AppBuilder在提供零代码、低代码的AI原生应用搭建功能之外,也提供全代码灵活开发与集成能力。千帆AppBuilder所提供\n的API包括应用、组件、知识库管理等类型,具体场景、使用方式如下。\n①应用\n"
}
],
"neighbors": []
}
],
"created_at": 1760613965964,
"total_count": 6,
"requestId": "f350c13a-b8b1-412a-9a82-63400859c644"
}
{
"code": "InvalidRequestArgumentError",
"message": "Invalid format for 'recall.vec_weight': expected float",
"request_id": "83babc8b-8f2d-4fee-b4b3-51da0bf9dbcc"
}
