Knowledge Base

Knowledge Base は AI Agent の専門知識の中核です。AI が質問に回答する際に使用するすべての情報が含まれます。これらのエンドポイントを使うと、Knowledge Base の設定を管理し、そのコンテンツの処理状況を追跡できます。

Knowledge Base は、作成したり、ウェブサイトからインポートしたり、ファイルとしてアップロードしたりした Articles を参照します。再トレーニングのステップはありません。作成・更新・削除した記事はすべてバックグラウンドで自動的に処理され、完了した時点で会話に反映されます。

Get Settings

Knowledge Base の設定を取得します。

スコープ: read_all

GET https://app.quickchat.ai/v1/api/knowledge_base/

Shell

curl https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

Response 200 OK

{
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"],
  "pending_embed_count": 0,
  "failed_embed_count": 0
}

Field	Description
one_word_description string	AI Agent 名。ダッシュボード：アイデンティティ > AIペルソナ > 名前
short_description string	システムプロンプト / メインプロンプト。ダッシュボード：アイデンティティ > AIペルソナ > メインプロンプト
ai_commands array of strings	行動ガイドライン。配列の 1 要素につき 1 件です。ダッシュボード：アイデンティティ > AIペルソナ > ガイドライン。最大 250 件、1 件あたり 5,000 文字、全件合計で 10,000 文字までです。
pending_embed_count integer	処理中の記事の件数。0 であれば、送信した内容がすべて反映されています
failed_embed_count integer	処理に失敗した記事の件数。Retry Failed Articles で再試行できます

コンテンツの反映を待つ

書き込み後はこのエンドポイントをポーリングし、pending_embed_count が 0 になるのを待ってください。記事ごとのステータスは Articles の embed_state フィールドでも確認できます。

ノート

これら 3 つのフィールド（one_word_description、short_description、ai_commands）は Chatbot Settings と共有されています。どちらのエンドポイントから更新しても同じ基底データが変更されます。

Update Settings

スコープ: write_all

PATCH https://app.quickchat.ai/v1/api/knowledge_base/

Request Body

Parameter	Description
one_word_description string	AI Agent 名
short_description string	システムプロンプト / AI Agent の説明。API はすべてのプランで最大 25,000 文字を受け付けます。アプリ内エディタは、15,000 文字から始まるプランごとの上限に制限します。上限を超える値は 422 を返します。
ai_commands array of strings	AI Guidelines。配列の 1 要素につき 1 件です。最大 250 件、1 件あたり 5,000 文字、全件合計で 10,000 文字までです。上限を超える値は 422 を返します。

ガイドラインの保存方法

配列の各要素が 1 件のガイドラインで、送信したとおりに保存されます。セミコロンを含め、句読点はそのまま保持されます。以前は ; を含むガイドラインが 2 件に分かれて返されていました。そのためにセミコロンを避けていた場合、その必要はなくなりました。

このエンドポイントは以前、長さの制限なくガイドラインを受け付けていました。上記の上限は現在このエンドポイントにも適用され、Chatbot Settings と完全に一致します。

ai_commands を省略するか null を送信すると、ガイドラインは変更されません。[] を送信すると削除されます。

Shell

curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "one_word_description": "Sales Bot"
}'

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"one_word_description": "Sales Bot"},
)
data = response.json()

Response 200 OK — 更新された Knowledge Base 設定を返します（Get Settings と同じスキーマ）。

Retry Failed Articles

処理に失敗したすべての記事を再処理します。すでに反映済みの記事や処理中の記事はそのまま維持され、このリクエストは何度呼び出しても安全です。

失敗した記事は自動でも再試行されるため、このエンドポイントはそれを待ちたくない場合にのみ必要です。

スコープ: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)

Response 200 OK

{
  "retried": 2
}

Field	Description
retried integer	再処理のためにキューに入れられた、失敗記事の件数

Retrain Knowledge Base 非推奨

POST https://app.quickchat.ai/v1/api/knowledge_base/retrain/

再トレーニングという仕組みはなくなりました。記事の変更は自動的に処理されます。このエンドポイントは既存の連携が動作し続けるようにするためだけに残されており、リクエストを受け付けて何もせずに 200 OK を返します。

連携からこの呼び出しは削除して構いません。再トレーニングの完了までポーリングしていた場合は、代わりに Get Settings の pending_embed_count が 0 になるのを待ってください。

---