BIbigmodel
知识库 API

知识库检索

用于检索个人知识库，支持向量检索、关键词检索、混合检索，支持自定义重排模型。点击 Try it 按钮可快速试用。

post/llm-application/open/knowledge/retrieve

Request

  • Base URL
    https://open.bigmodel.cn/api
  • Auth
    HTTP bearer

Request body

request_idstring

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

querystring required

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

knowledge_idsstring[] required

知识库ID列表

document_idsstring[]

文档ID列表

top_kinteger

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

top_ninteger

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

recall_method'embedding' | 'keyword' | 'mixed'

检索类型

  • embedding: 向量化检索
  • keyword:关键词检索
  • mixed: 混合检索（默认）
recall_ratiointeger

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

rerank_status0 | 1

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

rerank_model'rerank' | 'rerank-pro'

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

fractional_thresholdnumber

相似度阈值，低于该阈值的切片会被过滤，取值范围为(0~1)

Response

业务处理成功

codeinteger

响应码，200为成功

messagestring

响应信息

timestampinteger

响应时间戳

Changes

No recorded changes to this operation across all 3 revisions of this API.