ข้ามไปยังเนื้อหา

การตั้งค่าแชตบอต

ดึงและอัปเดตการตั้งค่าทั้งหมดของ AI Agent ผ่าน REST API

ดึงและอัปเดตการตั้งค่าทั้งหมดของ AI Agent รวมถึงบุคลิก รูปแบบการสนทนา และพรอมป์ต์ระบบ

การตั้งค่าพฤติกรรมอยู่ที่ ตัวตน > บุคลิก AI ในแดชบอร์ด ส่วนข้อความที่ผู้เยี่ยมชมเห็นอยู่ที่ ช่องทาง > เว็บไซต์ของคุณ > เนื้อหาข้อความ ตารางฟิลด์ด้านล่างระบุตำแหน่งของแต่ละการตั้งค่า

ขอบเขตสิทธิ์: read_all

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

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

การตอบกลับ 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) ในแดชบอร์ด: ช่องทาง > เว็บไซต์ของคุณ > เนื้อหาข้อความ > ข้อความต้อนรับ (สูงสุด 1,000 อักขระ) เป็นฟิลด์เดียวกับ welcome_message ในการตั้งค่าวิดเจ็ต
greeting2
สตริง
ข้อความทักทายรอง (HTML) ใช้ได้ผ่าน API แต่ไม่มีฟิลด์แก้ไขในแดชบอร์ด
header
สตริง
ข้อความส่วนหัวของแชต ในแดชบอร์ด: ช่องทาง > เว็บไซต์ของคุณ > เนื้อหาข้อความ > ข้อความส่วนหัว (สูงสุด 200 อักขระ)
header2
สตริง
ข้อความส่วนหัวรอง (สูงสุด 200 อักขระ) ใช้ผ่าน API เป็น header2 หรือ 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 สูงสุด 1,000 อักขระ)
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 เพื่อคงแนวทางเดิม ส่ง [] เพื่อล้างแนวทาง

Terminal window
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
}'

การตอบกลับ 200 OK ส่งกลับการตั้งค่าแชตบอตที่อัปเดตแล้ว (โครงสร้างเดียวกับการตอบกลับของ ดึงการตั้งค่าแชตบอต)