聊天機器人設定

透過 REST API 取得及更新 AI Agent 的完整設定。

聊天機器人設定

取得及更新 AI Agent 的完整設定，包括個性、對話風格與系統提示詞。

行為設定位於控制台的身分設定 > AI 人格。訪客看到的文字位於通路 > 您的網站 > 文字內容。下方欄位表列出每項設定的確切位置。

取得聊天機器人設定

權限範圍：read_all

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

Shell
Python

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

import requests

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

回應 200 OK

{
  "personality": 0,
  "profession": "helpful_assistant",
  "creativity_level": 1,
  "greeting": "<p>Hello! How can I help you today?</p>",
  "greeting2": "",
  "header": "Support Assistant",
  "header2": "",
  "language_chosen": "en",
  "reply_length": 1,
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"]
}

欄位	說明
`one_word_description` 字串	AI Agent 名稱。控制台：身分設定 > AI 人格 > 名稱。API 接受最多 200 個字元，應用程式欄位限制為 40 個。
`short_description` 字串	主要提示詞（系統提示詞）。控制台：身分設定 > AI 人格 > 主要提示詞。API 在所有方案接受最多 25,000 個字元，應用程式內編輯器則依方案上限，起始為 15,000 個。
`ai_commands` 字串陣列	AI 行為指引，每個陣列項目一條。控制台：身分設定 > AI 人格 > 指引。最多 250 項，每項 5,000 個字元，全部合計最多 10,000 個字元。
`personality` 整數（0–13）	AI 個性預設。控制台：身分設定 > AI 人格 > 個性。請見下表
`profession` 字串	AI 職責/角色。控制台：身分設定 > AI 人格 > 職責（最多 200 個字元）。請見下表
`creativity_level` 整數（0–2）	控制台：身分設定 > AI 人格 > 創意程度。`0` = 低、`1` = 一般、`2` = 高
`reply_length` 整數（0–2）	控制台：身分設定 > AI 人格 > 回覆長度。`0` = 短、`1` = 一般、`2` = 較長
`greeting` 字串	主要歡迎訊息（HTML）。控制台：通路 > 您的網站 > 文字內容 > 歡迎訊息（最多 1000 個字元）。與 Widget 設定的 `welcome_message` 為相同欄位。
`greeting2` 字串	次要歡迎訊息（HTML）。可透過 API 使用，控制台沒有對應編輯欄位。
`header` 字串	聊天頂部文字。控制台：通路 > 您的網站 > 文字內容 > 頂部文字（最多 200 個字元）
`header2` 字串	次要頂部文字（最多 200 個字元）。可透過 API 的 `header2` 或 Widget 設定的 `subtitle` 使用，控制台沒有對應編輯欄位。
`language_chosen` 字串	以逗號分隔的語言代碼，例如 `"en,es,de"`。控制台：身分設定 > AI 人格 > 語言（合計最多 200 個字元，超過 30 種語言的代碼會捨棄）

個性值：

值	標籤	說明
0	經典	全面均衡，兼具專業與親和力（預設）
1	幽默	以機智語氣、雙關與笑話帶來有趣互動
2	正式	正式嚴謹，以簡潔事實資訊適用於商務情境
3	友善	輕鬆對話，帶有親切且容易接近的感受
4	俏皮犀利	自信、活潑且幽默
5	睿智	提供詳盡準確的資訊，協助全面理解
6	富有同理心	關懷且體貼的互動，重視對方感受
7	大膽	自信地提出鮮明觀點與建議
9	熱情	活潑且充滿活力的互動
10	神祕	隱晦且引人好奇的回覆，帶來獨特體驗
11	鼓舞人心	如教練般鼓勵正向思考與達成目標
12	勇於冒險	鼓勵走出舒適圈並探索新機會
13	優雅	為獨特精緻品牌提供講究的體驗

職責值：

值	控制台標籤	說明
`helpful_assistant`	實用助手	靈活多用途，建議用於大多數情境
`customer_support_representative`	客服人員	富有同理心，提供逐步解法與疑難排解
`shopping_assistant`	購物助理	主動提供商品推薦與連結
`field_expert`	領域專家	專業顧問，提出釐清問題並提供專業指導
`interviewer`	訪談人員	提出問題而非提供答案。適用於問卷、訪談與意見收集

one_word_description、short_description 與 ai_commands 欄位也可透過知識庫設定端點存取。這些欄位共用資料，透過任一端點更新都會修改相同的底層資料。

更新聊天機器人設定

權限範圍：write_all

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

請求本文：所有欄位皆為選填。僅包含要更新的欄位。

參數	說明
`personality` 整數（0–13）	AI 個性預設
`profession` 字串	AI 職責/角色（最多 200 個字元）
`creativity_level` 整數（0–2）	`0` = 低、`1` = 一般、`2` = 高
`greeting` 字串	主要歡迎訊息（HTML，最多 1000 個字元）
`greeting2` 字串	次要歡迎訊息
`header` 字串	聊天頂部文字（最多 200 個字元）
`header2` 字串	次要頂部文字（最多 200 個字元）
`language_chosen` 字串	以逗號分隔的語言代碼（合計最多 200 個字元，超過 30 種語言的代碼會捨棄）
`reply_length` 整數（0–2）	`0` = 短、`1` = 一般、`2` = 較長
`one_word_description` 字串	AI Agent 名稱。API 最多 200 個字元，應用程式欄位限制為 40 個。
`short_description` 字串	AI 主要提示詞（系統提示詞）。API 在所有方案接受最多 25,000 個字元，應用程式內編輯器則依方案上限，起始為 15,000 個。超過大小限制會傳回 `422`。
`ai_commands` 字串陣列	AI 指引，每個陣列項目一條。最多 250 項，每項 5,000 個字元，全部合計最多 10,000 個字元。超過大小限制會傳回 `422`。

每個陣列項目是一條指引，完全依傳送內容儲存。標點符號（包含分號）會保留。此端點過去會在儲存前移除文字中的 ;；如果您曾為了避開該問題而刪除或替換分號，現在不必再這樣做。

省略 ai_commands 或傳送 null，可保留原有指引。傳送 [] 可清空。

Shell
Python

curl -X PATCH https://app.quickchat.ai/v1/api/chatbot_settings \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "greeting": "<p>Welcome! Ask me anything.</p>",
  "creativity_level": 2
}'

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/chatbot_settings",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "greeting": "<p>Welcome! Ask me anything.</p>",
        "creativity_level": 2,
    },
)
data = response.json()

回應 200 OK：傳回更新後的聊天機器人設定，結構與取得聊天機器人設定回應相同。

聊天機器人設定