Skip to main content
POST
/
llm-application
/
open
/
knowledge
/
retrieve
知识库检索
curl --request POST \
  --url https://open.bigmodel.cn/api/llm-application/open/knowledge/retrieve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "request_id": "<string>",
  "query": "<string>",
  "knowledge_ids": [
    "<string>"
  ],
  "document_ids": [
    "<string>"
  ],
  "top_k": 123,
  "top_n": 123,
  "recall_method": "<string>",
  "recall_ratio": 123,
  "rerank_status": 123,
  "rerank_model": "<string>",
  "fractional_threshold": 123
}'
{
  "data": [
    {
      "text": "<string>",
      "score": 123,
      "metadata": {
        "_id": "<string>",
        "knowledge_id": "<string>",
        "doc_id": "<string>",
        "doc_name": "<string>",
        "doc_url": "<string>",
        "contextual_text": "<string>"
      }
    }
  ],
  "code": 123,
  "message": "<string>",
  "timestamp": 123
}

Authorizations

​
Authorization
string
header
required

使用以下格式进行身份验证：Bearer <your api key>

Body

application/json
​
query
string
required

查询内容，限制在1000字以内

​
knowledge_ids
string[]
required

知识库ID列表

​
request_id
string

请求唯一id，用于定位日志

​
document_ids
string[]

文档ID列表

​
top_k
integer

最终召回数量，取值范围为[1~20]，默认为8

​
top_n
integer

初始召回数量，取值范围为[1~100]，默认为10

​
recall_method
string

检索类型 embedding: 向量化检索(默认)， keyword:关键词检索， mixed: 混合检索

​
recall_ratio
integer

混合检索中向量检索的权重，取值范围(0~100)，默认为80

​
rerank_status
integer

是否开启重排，0: 不开启，1: 开启，默认不开启

​
rerank_model
string

重排模型，支持rerank、rerank-pro

​
fractional_threshold
number

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

Response

业务处理成功

​
data
object[]

检索结果列表

​
code
integer

响应码，200为成功

​
message
string

响应信息

​
timestamp
integer

响应时间戳