Skip to main content

知识库检索

该接口仅支持对上传的知识库文件进行检索,返回当前知识库文件相关的信息和段落内容。不会经过大模型进行归纳生成。

请求地址:

POST https://${domain}/openapi/paas/v1/knowledge/retrieval

注意:如果您在试用系统环境中,请将api.torchv.com替换成demo.torchv.com

请求Header

参数名称类型必填描述
Content-Typestring请求的数据格式,目前仅支持 JSON 格式,固定填写"application/json"
Authorizationstring请求鉴权的应用AccessToken,创建应用后获取。Bearer 开头,例如:Bearer ak_xxxx

请求内容

{
// 三种检索方式,keyword-关键字检索(BM25),Vector-向量检索,Hybrid-混合检索
"mode":"hybrid",
// 知识库Id,在平台的:知识库 功能列表可以查看,该参数可为空
"containerId":["1751484246895214593","1751484246895214595"],
// 检索结果是否基于ReRank模型进行重排序
"rerank":true,
// 检索的内容,不能超过2048个字符
"q":"请介绍一下杭州西湖?"
}

响应参数

返回当前搜索相关的文本和片段


{
"code": 8200,
"message": "SUCCESS",
"data": {
// 引用段落信息
"paragraphs":[
{
// 知识库code
"containerId":"" ,
// 知识库名称
"containerName":"",
// 数据集id
"dataId":"",
// 数据集名称
"dataSetName":"",
// 所属页码
"page":12,
// 原文内容
"content":"西湖位于杭州......"
}
],
// 引用来源主题信息
"references":[
{
// 知识库code
"containerId":"" ,
// 知识库名称
"containerName":"",
// 数据集id
"dataId":"",
// 数据集名称
"dataSetName":"",
// 数据集的url地址
"dataSetUrl":"http://xxx.com/1.pdf",
// 数据集后缀类型,eg:pdf、docx、txt等等
"suffix":"pdf"
}
]
}

}