外部ナレッジベースAPI

知識検索 API

権限を確認するには、認証 HTTP ヘッダーの API キーを使用できます。認証ロジックは、検索 API で次のように定義されます:

Authorization: Bearer {API_KEY}

POSTyour-endpoint/retrieval

Authorization

bearer

Body

application/json

knowledge_id*string

君のナレッジベースの唯一のID

query*string

ユーザーのクエリ

retrival_setting*object

知識検索のパラメータ

Response

200403500

アクション成功の場合、サーバーからのレスポンスは HTTP200.

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"
  }
}