GET
/
api
/
knowledgebases
/
{knowledgebaseId}
/
query
查询文本片段
curl --request GET \
  --url https://app.pathors.com/api/knowledgebases/{knowledgebaseId}/query \
  --header 'x-api-key: <x-api-key>'
{
  "id": "<string>",
  "content": "<string>",
  "contentLength": 123,
  "isEnabled": true
}

​
查询文本片段

基于语义搜索查询从指定知识库中获取相关的文本片段。

​
接口

GET /api/knowledgebases/{knowledgebaseId}/query

​
路径参数

​
knowledgebaseId
string
required
要查询的知识库的唯一标识符

​
请求头

​
x-api-key
string
required
用于认证的项目 API 密钥

​
查询参数

​
q
string
required
用于匹配知识库内容的搜索查询
​
topK
number
返回结果的最大数量。默认为 5
​
scoreThreshold
number
返回结果的最低相关性分数阈值。默认为 0.3
请求示例： 
GET /api/knowledgebases/kb_abc123/query?q=搜索关键词&topK=5&scoreThreshold=0.3

​
响应

返回与查询匹配的文本片段数组，按相关性排序。
​
id
string
文本片段的唯一标识符
​
content
string
文本片段的内容
​
contentLength
number
文本片段的内容长度
​
isEnabled
boolean
文本片段是否启用搜索
响应示例： 
[
  {
    "id": "chunk_abc123",
    "content": "产品功能包括实时分析...",
    "contentLength": 82,
    "isEnabled": true
  }
]

​
错误响应

状态码描述
400无效的查询参数或缺少知识库 ID
401无效的 API 密钥
404未找到知识库或访问被拒绝
500内部服务器错误

​
工作原理

  1. 验证知识库是否存在并属于您的项目
  2. 查询文本使用与知识库相同的模型转换为嵌入向量
  3. 使用嵌入向量对存储的文本片段进行语义相似度搜索
  4. 返回最相关的文本片段，按相似度分数排序
  5. 结果数量限制为指定的 topK 参数值

​
使用说明

  • 查询使用语义搜索处理，而不是精确文本匹配
  • 结果按与查询的相关性排序返回
  • 响应包含来自指定知识库中最相关的文本片段
  • 使用 topK 参数控制返回结果的数量
  • 制定查询时请考虑上下文以获得最佳结果
  • 知识库必须属于与您的 API 密钥相关联的项目

​
相关接口