ナレッジベース

概要

ナレッジベース（KB）により、エージェントが 自社コンテンツから回答を取得できます — 製品ドキュメント、FAQ、ポリシー、ファイルなど。 フロー: KB 作成 → ソース追加（非同期）→ ジョブをポーリング → LLM モデルに kb_id を紐付け → 通話で利用。

エンドポイント一覧

ステップ	メソッド	エンドポイント
1	`POST`	`/v1/knowledge-bases`
2	`POST`	`/v1/knowledge-bases/{kb_id}/sources`
3	`GET`	`/v1/knowledge-bases/{kb_id}/jobs/{job_id}`
4	`PATCH`	`/v1/models/{llm_id}`
—	`GET`	`/v1/knowledge-bases/{kb_id}/sources`
—	`GET`	`/v1/knowledge-bases/{kb_id}/jobs`

検索の仕組み

OneInbox は KB の合計トークン予算（デフォルト 1 万トークン）に応じてモードを選択します:

≤ 1 万トークン — 通話時に LLM システムプロンプトへコンテンツを注入（追加の検索ラウンドトリップなし）
> 1 万トークン — ベクトル検索。LLM が呼び出す合成ツール search_knowledge_base を使用

ソースのアップロードは 202 Accepted を即時返却。job_id をポーリングし、ステータスが completed になるまで待ちます。

1. ナレッジベースを作成

curl -X POST https://api.oneinbox.ai/v1/knowledge-bases \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product Docs",
    "chunk_size": 512,
    "multilingual": false
  }'

2a. ファイルソースを追加

PDF、DOCX、XLSX、TXT、MD をアップロード（1 ファイル最大 50 MiB）。multipart/form-data を使用:

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

2b. URL ソースを追加

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

2c. インラインテキストを追加

curl -X POST "https://api.oneinbox.ai/v1/knowledge-bases/<kb_id>/sources" \
  -H "Authorization: Bearer <api_key>" \
  -F "type=text" \
  -F "source=Our return policy is 30 days, no questions asked."

3. インデックスジョブをポーリング

すべてのソースアップロードは 202 とジョブ ID を返します:

{
  "job": {
    "id": "job_abc123",
    "status": "queued"
  }
}

completed または failed までポーリング:

curl "https://api.oneinbox.ai/v1/knowledge-bases/<kb_id>/jobs/<job_id>" \
  -H "Authorization: Bearer <api_key>"

ステータス: queued → running → completed | failed。成功時、payload に tokens、chunks、vector_indexed が含まれます。最近のジョブ一覧:

curl "https://api.oneinbox.ai/v1/knowledge-bases/<kb_id>/jobs" \
  -H "Authorization: Bearer <api_key>"

4. ソース一覧（任意）

curl "https://api.oneinbox.ai/v1/knowledge-bases/<kb_id>/sources" \
  -H "Authorization: Bearer <api_key>"

各行に status（processing / ready / error）、file_name、token_count、chunk_count、エラー時は error_message が含まれます。

5. LLM モデルに紐付け

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

この llm_id を使うエージェントは、次の通話から KB を利用します。