知識庫

知識庫是 AI Agent 專業知識的核心，包含 AI 回答問題所用的所有資訊。這些端點可管理知識庫設定並追蹤內容的處理狀態。

知識庫的內容來自您建立、從網站匯入或以檔案上傳的文章。不需要重新訓練：每篇新增、更新或刪除的文章都會在背景自動處理，完成後立即在對話中生效。

取得設定

取得知識庫設定。

權限範圍：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()

回應 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
}

欄位	說明
one_word_description 字串	AI Agent 名稱。控制台：身分設定 > AI 人格 > 名稱
short_description 字串	系統提示詞 / 主要提示詞。控制台：身分設定 > AI 人格 > 主要提示詞
ai_commands 字串陣列	行為指引，每個陣列項目一條。控制台：身分設定 > AI 人格 > 指引。最多 250 項，每項 5,000 個字元，全部合計最多 10,000 個字元。
pending_embed_count 整數	仍在處理的文章數。0 表示您提交的所有內容都已上線
failed_embed_count 整數	處理失敗的文章數。使用重試失敗文章重新處理

等待內容上線

寫入後輪詢此端點，等待 pending_embed_count 變成 0。也可透過文章的 embed_state 欄位取得逐篇文章的狀態。

注意

這三個欄位（one_word_description、short_description、ai_commands）與聊天機器人設定共用。透過任一端點更新都會修改相同的底層資料。

更新設定

權限範圍：write_all

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

請求本文

參數	說明
one_word_description 字串	AI Agent 名稱
short_description 字串	系統提示詞 / AI Agent 描述。API 在每個方案皆接受最多 25,000 個字元；應用程式內編輯器則受方案上限限制，起始為 15,000 個字元。超過大小限制會傳回 422。
ai_commands 字串陣列	AI 指引，每個陣列項目一條。最多 250 項，每項 5,000 個字元，全部合計最多 10,000 個字元。超過大小限制會傳回 422。

指引的儲存方式

每個陣列項目是一條指引，會完全依您傳送的內容儲存。標點符號（含分號）會保留。過去含 ; 的指引會被拆成兩條傳回；如果您曾為了避開這個問題而不使用分號，現在不必再避開。

此端點過去接受任何長度的指引。目前也會套用上述限制，且與聊天機器人設定完全相同。

省略 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()

回應 200 OK：傳回更新後的知識庫設定，結構與取得設定相同。

重試失敗文章

重新處理每篇處理失敗的文章。已上線或仍在處理的文章不受影響，此呼叫可安全重複執行。

失敗文章也會自動重試，因此只有不想等待自動重試時才需要此端點。

權限範圍：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>"},
)

回應 200 OK

{
  "retried": 2
}

欄位	說明
retried 整數	已排入重新處理佇列的失敗文章數

重新訓練知識庫 已棄用

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

重新訓練已不再存在，文章變更會自動處理。保留此端點只是為了讓現有整合繼續運作：它接受請求，但不執行任何操作，並傳回 200 OK。

您可以從整合中移除此呼叫。若原本輪詢等待重新訓練完成，請改為等待取得設定中的 pending_embed_count 變成 0。

---