curl --request POST \
--url https://open.bigmodel.cn/api/zrag/retrieval/retrieve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"multimodal": true,
"knows": [
{
"id": "1234567890"
}
],
"query": "介绍一下小智",
"multimodal_parts": [
{
"type": "image_url",
"url": "https://example.com/image.png"
}
],
"top_k": 8,
"top_n": 10,
"recall_method": "mixed",
"recall_ratio": 0.8,
"messages": [
{
"role": "user",
"content": "你是谁"
},
{
"role": "assistant",
"content": "我是小智,一个智能助手"
}
]
}
'{
"data": {
"contents": [
{
"id": "<string>",
"know_id": "<string>",
"doc_id": "<string>",
"text": "<string>",
"medias": [
{
"id": "<string>",
"url": "<string>",
"description": "<string>"
}
],
"image_url": {
"url": "<string>"
},
"video_url": {
"url": "<string>"
},
"index": 123,
"score": 123,
"rerank_index": 123,
"rerank_score": 123,
"metadata": {
"doc_type": "<string>",
"doc_name": "<string>",
"doc_url": "<string>",
"index": 123,
"page_index": 123,
"clip_index": 123,
"start_time": 123,
"end_time": 123,
"duration": 123,
"frames": [
"<string>"
]
}
}
],
"rewritten_query": {
"original_query": "<string>",
"multi_queries": [
"<string>"
]
},
"elapsed_ms": 123,
"total_tokens": 123,
"request_id": "<string>"
},
"code": 123,
"message": "<string>"
}用于检索全模态知识库,支持文本、图片、视频等多模态输入检索,支持向量检索、关键词检索、混合检索,支持查询重写、重排、QA干预等高级功能。
curl --request POST \
--url https://open.bigmodel.cn/api/zrag/retrieval/retrieve \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"multimodal": true,
"knows": [
{
"id": "1234567890"
}
],
"query": "介绍一下小智",
"multimodal_parts": [
{
"type": "image_url",
"url": "https://example.com/image.png"
}
],
"top_k": 8,
"top_n": 10,
"recall_method": "mixed",
"recall_ratio": 0.8,
"messages": [
{
"role": "user",
"content": "你是谁"
},
{
"role": "assistant",
"content": "我是小智,一个智能助手"
}
]
}
'{
"data": {
"contents": [
{
"id": "<string>",
"know_id": "<string>",
"doc_id": "<string>",
"text": "<string>",
"medias": [
{
"id": "<string>",
"url": "<string>",
"description": "<string>"
}
],
"image_url": {
"url": "<string>"
},
"video_url": {
"url": "<string>"
},
"index": 123,
"score": 123,
"rerank_index": 123,
"rerank_score": 123,
"metadata": {
"doc_type": "<string>",
"doc_name": "<string>",
"doc_url": "<string>",
"index": 123,
"page_index": 123,
"clip_index": 123,
"start_time": 123,
"end_time": 123,
"duration": 123,
"frames": [
"<string>"
]
}
}
],
"rewritten_query": {
"original_query": "<string>",
"multi_queries": [
"<string>"
]
},
"elapsed_ms": 123,
"total_tokens": 123,
"request_id": "<string>"
},
"code": 123,
"message": "<string>"
}是否走多模态路径检索,默认值为true
文本查询内容,与多模态查询内容必须传入其中之一
最终召回数量,默认为8
初始召回数量,默认为10
文本检索方式:embedding(向量检索)、keyword(关键词检索)、mixed(混合检索)
embedding, keyword, mixed 混合检索中向量检索的权重,取值范围0~1
是否开启重排,默认不开启
是否开启查询重写,可配合messages参数实现多轮对话改写,默认不开启
是否开启扩召,默认不开启
相似度阈值,低于该阈值的切片会被过滤
过滤条件
Hide child attributes
标签列表
Hide child attributes
标签ID
固定值:fixed,引用变量:ref
fixed, ref 过滤类型:1: >=,2: <=,3: 包含,4: 不包含
1, 2, 3, 4 日期/文本/引用值
选项值列表
业务处理成功
Hide child attributes
检索结果列表
Hide child attributes
切片ID(UUID)
知识库ID
文档ID
文本内容
召回位次
召回分数
重排位次
重排分数
元数据
Hide child attributes
文档类型,如 pdf、docx、jpeg、png、mp4、mp3 等
文档名称
文档URL
切片下标
文档页码
视频切片下标
首帧时间戳
尾帧时间戳
视频切片时长
关键帧列表
请求耗时(毫秒)
消耗的token数量
请求ID
错误码,200为成功
错误信息