知识库
知识库检索
在指定知识库中按查询文本进行检索，支持向量/全文/混合模式
鉴权方式
AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。
版本
请求地址
Header 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
HAP-Appkey | string | 是 | HAP应用密钥 |
HAP-Sign | string | 是 | HAP签名 |
Body 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
knowledgeIds | string[] | 是 | 指定检索的知识库 ID 列表；空数组表示全部；非空则仅检索指定知识库 |
query | string | 是 | 查询文本 |
searchMode | string | 是 | 检索模式：vector=向量检索，keyword=全文检索，hybrid=混合检索 可选值： "vector""keyword""hybrid" |
topK | integer | 否 | 返回命中上限（默认 10，>=1） |
minRelevance | number | 否 | 仅 vector 生效；低于阈值的不返回（范围 0~1） |
rrfK | integer | 否 | 仅 hybrid 生效；RRF 参数 k（默认 60） |
filter | object | 否 | — |
filter.worksheetIds | string[] | 否 | 工作表范围 |
filter.types | string[] | 否 | 内容范围：record 记录 / record_attachment 记录附件 / discussion_attachment 讨论附件 / discussion 讨论；不传则检索所有 |
响应参数
200检索成功，返回命中内容块列表| 名称 | 类型 | 描述 |
|---|---|---|
success | boolean | 是否成功 |
error_code | integer | 业务错误码；0 表示成功 |
data | object | — |
data.chunks | object[] | — |
data.chunks.score | number | 排序得分 |
data.chunks.knowledgeId | string | 命中结果所属的知识库 id |
data.chunks.knowledgeName | string | 命中结果所属的知识库名称 |
data.chunks.chunkId | string | 内容块唯一 ID |
data.chunks.content | string | 命中的文本内容 |
data.chunks.type | string | 内容类型 可选值： "record""record_attachment""discussion_attachment""discussion" |
data.chunks.rowId | string | 记录 ID（命中记录或其附件时返回） |
data.chunks.appId | string | 应用 ID |
data.chunks.worksheetId | string | 工作表 ID |
data.chunks.worksheetName | string | 工作表名称 |
data.chunks.field | string | 字段 ID（仅命中附件块时返回） |
data.chunks.fieldName | string | 字段名称（仅命中附件块时返回） |
data.chunks.updatedAt | string | 更新时间 |
data.chunks.recordTitle | string | 记录标题 |
data.chunks.attachmentId | string | 附件 ID（仅命中附件块时返回） |
data.chunks.attachmentName | string | 附件名称（命中附件时返回） |
data.chunks.match | string | 命中类型：raw=原块命中，enhanced=增强块命中 可选值： "raw""enhanced" |
curl -X POST "https://example.com/v3/app/knowledge/search" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}" \ -H "Content-Type: application/json" \ -d '{ "knowledgeIds": [ "string" ], "query": "如何恢复删除的工作表？", "searchMode": "hybrid" }'{ "success": true, "error_code": 0, "data": { "chunks": [ { "score": 0, "knowledgeId": "string", "knowledgeName": "string", "chunkId": "string", "content": "string", "type": "record", "rowId": "string", "appId": "string", "worksheetId": "string", "worksheetName": "string", "field": "string", "fieldName": "string", "updatedAt": "string", "recordTitle": "string", "attachmentId": "string", "attachmentName": "string", "match": "raw" } ] }}