ナレッジベース

仕組み

ナレッジベースを手動で作成する必要はありません。コンテンツ（URL、ファイル、テキスト）を追加すると自動的に作成され、ID が返されます。

アップロードされたコンテンツは通話中に自動的にインデックス化・検索されます — 設定は不要です。対応ファイル形式：PDF、Excel、Word 文書。最大ファイルサイズ：20 MB。

クイックスタート — 1 回の API 呼び出しでコンテンツを追加

ナレッジベース ID を手動で作成する必要はありません。POST /v1/knowledge-bases/sources（パスに kb_id なし）でソース名から新しいナレッジベースが自動作成され、すぐにインデックス処理が開始されます。レスポンスに knowledge_base_id が含まれます — エージェントに紐付けるためにこれを保存してください。

URL を追加

公開 URL を指定します — ドキュメントページ、FAQ、ブログ記事、製品ページなど。OneInbox がページを取得してコンテンツを自動的にインデックスします。

curl -X POST https://api-tokyo.oneinbox.ai/v1/knowledge-bases/sources \
  -H "Authorization: Bearer <api_key>" \
  -F "type=url" \
  -F "source=https://docs.yourproduct.com/faq"

ファイルをアップロード

ドキュメントを直接アップロードします。対応フォーマット：PDF、Excel、Word 文書。file フィールドのみを使用してください — ファイルをアップロードする際は type フィールドを含めないでください。

curl -X POST https://api-tokyo.oneinbox.ai/v1/knowledge-bases/sources \
  -H "Authorization: Bearer <api_key>" \
  -F "file=@/path/to/your-document.pdf"

インラインテキストを追加

プレーンテキストとしてコンテンツを直接貼り付けます — ポリシー、スクリプト、FAQ、または手元にある任意のテキストに便利です。

curl -X POST https://api-tokyo.oneinbox.ai/v1/knowledge-bases/sources \
  -H "Authorization: Bearer <api_key>" \
  -F "type=text" \
  -F "source=Our refund policy is 30 days. Customers must provide proof of purchase to receive a refund."

3 つのエンドポイントはすべて同じレスポンス構造を返します：

{
  "source": { "source_id": "kbs_xyz", "kb_id": "kb_abc123", "status": "processing" },
  "job": { "job_id": "kbj_xyz", "kb_id": "kb_abc123", "status": "queued" },
  "message": "Source accepted. Ingestion is running in the background."
}

source.kb_id — 自動作成されたナレッジベースの ID。これを保存して、ステップ 3 でエージェントに KB を紐付けます。
source.source_id — 追加された個別のコンテンツソース。
job.job_id — 処理ジョブ。これをポーリングしてインデックス進捗を追跡します。

KB はURL ドメインまたはファイル名にちなんで命名されます。

ステップ 2 — 処理状況を確認する

コンテンツは非同期でインデックスされます。エージェントに KB を紐付ける前にジョブが完了するまで待ちます — エージェントは処理が完了したコンテンツのみ使用できます。

# この KB のすべてのジョブを一覧表示
curl https://api-tokyo.oneinbox.ai/v1/knowledge-bases/<kb_id>/jobs \
  -H "Authorization: Bearer <api_key>"

# 特定のジョブを取得
curl https://api-tokyo.oneinbox.ai/v1/knowledge-bases/<kb_id>/jobs/<job_id> \
  -H "Authorization: Bearer <api_key>"

ジョブはこの順序で進みます：queued → running → completed または failed ステップ 3 に進む前に "status": "completed" になるまで待ってください。

ステップ 3 — LLM モデルに紐付ける

これがナレッジベースをエージェントで利用可能にするステップです。LLM モデルに紐付けます（エージェントに直接ではなく）。llm_id はエージェント作成時に返されます — 持っていない場合は GET /v1/agents/<agent_id> で取得してください。

curl -X PATCH https://api-tokyo.oneinbox.ai/v1/models/<llm_id> \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "knowledge_base_ids": ["<kb_id>"]
  }'

この LLM モデルを使用するすべてのエージェントがナレッジベースにアクセスできるようになります。複数のナレッジベースを一度に紐付けるには：

{ "knowledge_base_ids": ["kb_abc123", "kb_def456"] }

モデルから KB を切り離す

KB のリスト全体を置き換えずに LLM モデルから KB を削除するには、remove_knowledge_base_ids を使用します：

curl -X PATCH https://api-tokyo.oneinbox.ai/v1/models/<llm_id> \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "remove_knowledge_base_ids": ["<kb_id_to_remove>"]
  }'

同一リクエストで KB の追加と削除を同時に行えます — knowledge_base_ids で追加し、remove_knowledge_base_ids で切り離します。