You need to enable JavaScript to run this app.
导航
数据智能体 DataAgent（私有化）
  • 文档首页
    • /数据智能体 DataAgent（私有化）/开放与集成/智能营销Agent/OpenAPI/企业知识引擎/智能会话/知识库检索
知识库检索
最近更新时间：2025.10.16 14:55:04首次发布时间：2025.10.16 14:55:04
复制全文
我的收藏
有用
有用
无用
无用

本接口用于调用OpenAPI接口，在智能会话中搜索知识库的内容。

请求方式及路径

请求方式：POST
请求地址： https://console.volcengine.com/cdp/api/v2/rag/chunk/retrieval

请求参数

参数名称

参数值类型

参数示例

说明

备注

kb_id

number

60

知识库id

URL中id=xx
Image

question

string

"大烤鱿鱼的做法"

检索的问题

响应参数

参数名称

参数类型

参数示例

说明

code

number

0

0->成功
非0->失败

msg

string

"success"

当code为非0是包含错误信息

data

RelavantChunks

"data": {
"total": 0,
"chunks":[],
"doc_aggs":[]
}

chunks列表

RelavantChunks

参数名称

参数值类型

参数示例

说明

total

number

0

检索到的chunk数

chunks

List

[]

chunk信息

doc_aggs

List

[]

chunk来源信息

Chunk

参数名称

参数值类型

参数示例

说明

kb_id

number

0

检索到的chunk数

chunk_id

string

"LnyozpYBHKUCVbNEivl9"

chunk信息

content_with_weight

string

"12、韩式烤鱿鱼„13、烤鳗鱼„„14、大烤鱿鱼串„„15、葱烤鲫鱼„B 畜类1、烤猪肉„2、烤叉烧„„3、烤大排„4、烤肉饼„5、菜包肉„6、酿青椒„7、网油卷„"

带权重的内容主体

doc_id

string

"216"

文档 ID

important_kwd

List

[]

重要关键词列表

image_id

string

"290-60-8d84353f810208e24065237025254624.jpeg",

关联图片的 ID

similarity

double

0.6007218485768133

综合相似度得分

vector_similarity

double

0.8634181245234622

向量相似度得分

term_similarity

double

0.4881377303139639

术语相似度得分

docnm_kwd

string

家用烤箱食谱_55道电烤箱食谱.pdf

文档名称关键词

content_ltks

string

1 新奥尔良 烤 翅 烤鸡 腿 diy 做法 更 简便 做法 可 直接 用 味加味 相关 方便 调味料 当地 商 超 菜场 有售 材料 10 个 鸡翅 蜂蜜 酱油 盐 料酒 红酒 也 可 姜 红 干辣椒 五香粉 黑胡椒

内容关键字

DocReference

参数名称

参数值类型

参数示例

说明

doc_id

number

"216"

文档id

doc_name

List

"家用烤箱食谱_55道电烤箱食谱.pdf"

文档名

count

DocAgg

1

响应中属于该文档的chunk数

请求示例
curl 'https://console.volcengine.com/cdp/api/v2/rag/chunk/retrieval' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7' \
  -H 'priority: u=1, i' \
  -H 'referer: https://console.volcengine.com/cdp/knowledge-base/2985149/app/chat?external=true&dialog_id=81' \
  -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "macOS"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \
  -H 'x-org: xxx' \
  -H 'x-tenant: xxx' \
  -H 'X-User: xxx' \
  -H 'Authorization: Bearer xxx'
  --data-raw '{"doc_ids":[],"kb_id":60,"question":"大烤鱿鱼串的做法"}'

响应示例
{
    "code": 0,
    "msg": "success",
    "data": {
        "total": 1,
        "chunks": [
           {
                "kb_id": [
                    "60"
                ],
                "chunk_id": "W3yozpYBHKUCVbNEwvld",
                "content_with_weight": "大烤鱿鱼串14，大烤鱿鱼串主料：鱿鱼、洋葱。酱料：姜、盐、糖、鸡精、料酒、酱油。做法：1、鱿鱼，洗净，去掉肚子里的东西，切成片，将处理好的鱿鱼放入容器中，然后加入洋葱、姜、盐、糖、鸡精、料酒、酱油腌制30分钟，然后用竹签子穿起来。",
                "doc_id": "216",
                "important_kwd": [],
                "image_id": "290-60-ded4837cd852acc49631d5f9e87bdec4.jpeg",
                "similarity": 0.7290769476983295,
                "vector_similarity": 0.9232008767106681,
                "term_similarity": 0.645880978121613,
                "docnm_kwd": "家用烤箱食谱_55道电烤箱食谱.pdf",
                "content_ltks": "大 烤 鱿鱼 串 14 大 烤 鱿鱼 串 主料 鱿鱼 洋葱 酱料 姜 盐 糖 鸡精 料酒 酱油 做法 1 鱿鱼 洗净 去掉 肚子里 的 东西 切 成片 将 处理 好的 鱿鱼 放入 容器 中 然后 加入 洋葱 姜 盐 糖 鸡精 料酒 酱油 腌制 30 分钟 然后 用 竹签子 穿 起来",
                "highlight": null
           }
        ]，
        "doc_aggs": [
            {
                "doc_id": "216",
                "doc_name": "家用烤箱食谱_55道电烤箱食谱.pdf",
                "count": 1
            }
        ]
    }，
    "message": null
}