ドキュメント本文へスキップ
API

ナレッジベースを検索する

質問にいちばんよく答える箇所を、AI と同じ方法で探す。

POST/knowledge/search

実際の呼び出しをワークスペースに対して実行します。

POST /knowledge/search

質問にいちばんよく答える箇所を、AI と同じ方法で探す。

例

knowledge:read が必要。query は最大 500 文字。address を渡すと、そのアドレスのために AI が使うレベルを検索し、最も具体的なレベルを少し上位に置く。scope を渡すと、その 1 つのレベルを検索する。どちらもなければ、見えるすべてのレベルを検索する。limit は最大 25 で既定は 8。

curl
curl -X POST "$OE/knowledge/search" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "query": "How long do refunds take?", "address": "[email protected]" }'
レスポンス
{  "object": "knowledge_search",  "query": "How long do refunds take?",  "hits": [    {      "sourceId": "kb_8c1f4a2b9d7e3f60a5c7b21d",      "title": "Refunds",      "kind": "note",      "scope": "@acme.com",      "level": "domain",      "url": null,      "heading": "",      "text": "Refunds are paid within 14 days of the return reaching our warehouse.",      "score": 0.83    }  ]}

何も変更しないので、再送しても安全。1 つの項目から返る箇所は最大 3 つで、score は 1 つの応答の中で結果を並べるためだけのもの。

項目は、テキストが読み取られた時点で検索対象になる。変更した項目を読み直している間は、前のテキストが検索される。

リファレンス