知识库详情

接口说明

返回知识库元数据与默认检索配置摘要。检索配置中的 top_k 与 score_threshold 等字段，是平台为该知识库保存的默认值，调用 retrieve 接口时如不显式覆盖即生效。

• 接口路径：GET /v1/openapi/knowledge/:knowledge_id

请求头

参数名	必填	说明
Authorization	是	鉴权凭证，格式 Bearer sk_xxx

请求参数

路径参数

参数	类型	必填	说明
knowledge_id	string	是	知识库 ID（UUID），可通过 知识库列表 接口获取

请求体

本接口为 GET 请求，无请求体，仅需鉴权头。

成功响应示例

{
  "code": 200,
  "data": {
    "id": "1368b2d9-60ff-48fc-9f14-0c39711896ef",
    "name": "华西医疗百科",
    "description": "华西医院常见疾病百科知识库",
    "icon": "https://oss.example.com/knowledge/icon/default.png",
    "type": 1,
    "status": 1,
    "dataset_num": 12,
    "words_num": 384521,
    "retriever_config": {
      "retriever_type": 1,
      "top_k": 5,
      "score_threshold_enabled": 1,
      "score_threshold": 0.5
    }
  },
  "message": "success",
  "trace_id": "ece1bfa480da3a5bb346cf83cfc29454"
}

data 字段说明

字段	类型	说明
id	string	知识库 ID
name	string	知识库名称
description	string	知识库描述
icon	string	知识库图标完整 URL（用户未设置时返回默认图标）
type	int	知识库类型：1=文档集、2=表格集、3=图片集
status	int	启用状态：0=禁用、1=启用
dataset_num	int	数据集数量
words_num	int	累计字符数
retriever_config	object	默认检索配置摘要
retriever_config.retriever_type	int	检索类型：1=混合、2=向量、3=全文
retriever_config.top_k	int	命中条数（1-10）
retriever_config.score_threshold_enabled	int	是否开启分数阈值：0=否、1=是；全文检索恒为 0
retriever_config.score_threshold	float	分数阈值（0-1）；score_threshold_enabled=0 时该字段无意义

失败响应示例

{
  "code": 0,
  "data": null,
  "message": "知识库不存在",
  "trace_id": "e3302bb5788035dec7160e58d2261824"
}

调用示例

curl -X GET 'https://runtime-api.invalid/v1/openapi/knowledge/1368b2d9-60ff-48fc-9f14-0c39711896ef' \
  -H 'Authorization: Bearer sk_your_api_key'

注意事项

• retriever_config 描述的是平台为该知识库保存的默认检索配置，知识检索 接口允许通过 retrieval_model 字段临时覆盖。
• 当 retriever_config.retriever_type=3（全文检索）时，score_threshold_enabled 恒为 0，全文检索原生不支持基于 score 的阈值过滤。
• 若返回 知识库不存在，请通过 知识库列表 确认 knowledge_id 与当前 workspace 的归属关系。