Skip to main content
POST
/
zrag
/
retrieval
/
retrieve
全模态知识库检索
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>"
}

Authorizations

Authorization
string
header
required

使用以下格式进行身份验证:Bearer

Body

application/json
knows
object[]
required

查询的知识库列表

multimodal
boolean
default:true

是否走多模态路径检索,默认值为true

query
string

文本查询内容,与多模态查询内容必须传入其中之一

multimodal_parts
object[]

多模态查询内容,与文本查询内容必须传入其中之一

top_k
integer
default:8

最终召回数量,默认为8

top_n
integer
default:10

初始召回数量,默认为10

recall_method
enum<string>
default:mixed

文本检索方式:embedding(向量检索)、keyword(关键词检索)、mixed(混合检索)

Available options:
embedding,
keyword,
mixed
recall_ratio
number
default:0.8

混合检索中向量检索的权重,取值范围0~1

enable_rerank
boolean
default:false

是否开启重排,默认不开启

enable_rewrite
boolean
default:false

是否开启查询重写,可配合messages参数实现多轮对话改写,默认不开启

enable_expansion
boolean
default:false

是否开启扩召,默认不开启

similarity_threshold
number
default:0.2

相似度阈值,低于该阈值的切片会被过滤

messages
object[]

当前对话消息列表,用于多轮对话改写

search_filters
object

过滤条件

Response

业务处理成功

data
object
code
integer

错误码,200为成功

message
string

错误信息