外部知识库 API

知识召回 API

该 API 用于连接团队内独立维护的知识库，如需了解更多操作指引，请参考阅读连接外部知识库。你可以在 Authorization HTTP 头部中使用 API-Key 来验证权限，认证逻辑由开发者在检索 API 中定义，如下所示:

Authorization: Bearer {API_KEY}

POSTyour-endpoint/retrieval

Authorization

bearer

Body

application/json

knowledge_id*string

你的知识库唯一 ID

query*string

用户的提问

retrival_setting*object

知识库的检索参数

Response

200403500

如果操作成功，服务将发回 HTTP 200 响应。

Body

application/json

records*从知识库查询的记录列表

Request

JavaScriptCurlPython

const response = await fetch('your-endpoint/retrieval', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "knowledge_id": "your-knowledge-id",
      "query": "your question",
      "retrival_setting": {
        "top_k": 2,
        "score_threshold": 0.5
      }
    }),
});
const data = await response.json();

Response

200403500

{
  "records": {
    "content": "text",
    "score": 0,
    "title": "text",
    "metadata": "text"
  }
}