Bỏ qua để đến nội dung

Lấy và cập nhật toàn bộ cấu hình AI Agent qua REST API.

Lấy và cập nhật toàn bộ cấu hình AI Agent, gồm tính cách, phong cách hội thoại và prompt hệ thống.

Cài đặt hành vi nằm tại Danh tính > Tính cách AI trong bảng điều khiển. Văn bản khách nhìn thấy nằm tại Kênh > Trang web của bạn > Nội dung văn bản. Bảng dưới đây chỉ đúng vị trí từng cài đặt.

Phạm vi: 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>'

Phản hồi 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"]
}
TrườngMô tả
one_word_description
chuỗi
Tên AI Agent. Bảng điều khiển: Danh tính > Tính cách AI > Tên. API nhận tối đa 200 ký tự; trường trong ứng dụng giới hạn 40.
short_description
chuỗi
Prompt chính (prompt hệ thống). Bảng điều khiển: Danh tính > Tính cách AI > Prompt chính. API nhận tối đa 25.000 ký tự trên mọi gói; trình soạn thảo trong ứng dụng giới hạn theo gói, bắt đầu từ 15.000.
ai_commands
mảng chuỗi
Hướng dẫn hành vi cho AI, mỗi phần tử mảng là một hướng dẫn. Bảng điều khiển: Danh tính > Tính cách AI > Hướng dẫn. Tối đa 250 mục, 5.000 ký tự mỗi mục và 10.000 ký tự tổng cộng.
personality
số nguyên (0–13)
Cấu hình tính cách AI. Bảng điều khiển: Danh tính > Tính cách AI > Tính cách. Xem bảng bên dưới
profession
chuỗi
Vai trò/chuyên môn AI. Bảng điều khiển: Danh tính > Tính cách AI > Vai trò (tối đa 200 ký tự). Xem bảng bên dưới
creativity_level
số nguyên (0–2)
Bảng điều khiển: Danh tính > Tính cách AI > Mức độ sáng tạo. 0 = Thấp, 1 = Bình thường, 2 = Cao
reply_length
số nguyên (0–2)
Bảng điều khiển: Danh tính > Tính cách AI > Độ dài phản hồi. 0 = Ngắn, 1 = Bình thường, 2 = Dài hơn
greeting
chuỗi
Lời chào chính (HTML). Bảng điều khiển: Kênh > Trang web của bạn > Nội dung văn bản > Lời chào (tối đa 1.000 ký tự). Đây là cùng trường với welcome_message trong Cấu hình Widget.
greeting2
chuỗi
Lời chào phụ (HTML). Có qua API; không có trường chỉnh sửa trong bảng điều khiển.
header
chuỗi
Văn bản phần đầu chat. Bảng điều khiển: Kênh > Trang web của bạn > Nội dung văn bản > Văn bản phần đầu (tối đa 200 ký tự)
header2
chuỗi
Văn bản phần đầu phụ (tối đa 200 ký tự). Có qua API dưới tên header2 hoặc subtitle trong Cấu hình Widget; không có trường chỉnh sửa trong bảng điều khiển.
language_chosen
chuỗi
Mã ngôn ngữ phân cách bằng dấu phẩy (ví dụ "en,es,de"). Bảng điều khiển: Danh tính > Tính cách AI > Ngôn ngữ (tổng tối đa 200 ký tự; mã vượt giới hạn 30 ngôn ngữ bị bỏ)

Giá trị tính cách:

Giá trịNhãnMô tả
0Cổ điểnToàn diện, cân bằng giữa chuyên nghiệp và gần gũi (mặc định)
1Hài hướcGiọng dí dỏm với chơi chữ và chuyện vui để tương tác thú vị
2Trang trọngTrang trọng, nghiêm túc, thông tin thực tế ngắn gọn cho môi trường kinh doanh
3Thân thiệnTrò chuyện tự nhiên, mang nét cá nhân và dễ gần
4Hóm hỉnh, sắc sảoTự tin, vui tươi và hài hước
5Thông minhThông tin chi tiết, chính xác để hiểu toàn diện
6Đồng cảmTương tác quan tâm, cảm thông và chú ý cảm xúc
7Mạnh dạnQuan điểm và đề xuất rõ ràng, tự tin
9Hào hứngTương tác sống động và tràn năng lượng
10Bí ẩnCâu trả lời khó đoán, hấp dẫn cho trải nghiệm khác biệt
11Truyền cảm hứngKhuyến khích tư duy tích cực và đạt mục tiêu như huấn luyện viên
12Ưa khám pháKhuyến khích ra khỏi vùng an toàn, khám phá cơ hội mới
13Thanh lịchTrải nghiệm tinh tế cho thương hiệu độc đáo và cao cấp

Giá trị vai trò:

Giá trịNhãn trong bảng điều khiểnMô tả
helpful_assistantTrợ lý hữu íchLinh hoạt, đa mục đích. Đề xuất cho phần lớn trường hợp
customer_support_representativeNhân viên hỗ trợĐồng cảm, đưa ra giải pháp từng bước và xử lý sự cố
shopping_assistantTrợ lý mua sắmChủ động gợi ý sản phẩm kèm liên kết
field_expertChuyên gia lĩnh vựcTư vấn chuyên nghiệp, hỏi làm rõ và hướng dẫn chuyên sâu
interviewerNgười phỏng vấnĐặt câu hỏi thay vì trả lời. Dành cho khảo sát, phỏng vấn, phản hồi

Các trường one_word_description, short_description và ai_commands cũng có qua endpoint Cài đặt Cơ sở kiến thức. Đây là trường dùng chung; cập nhật qua một trong hai endpoint đều sửa cùng dữ liệu bên dưới.

Phạm vi: write_all

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

Nội dung yêu cầu: mọi trường đều tùy chọn. Chỉ đưa vào những trường muốn cập nhật.

Tham sốMô tả
personality
số nguyên (0–13)
Cấu hình tính cách AI
profession
chuỗi
Vai trò/chuyên môn AI (tối đa 200 ký tự)
creativity_level
số nguyên (0–2)
0 = Thấp, 1 = Bình thường, 2 = Cao
greeting
chuỗi
Lời chào chính (HTML, tối đa 1.000 ký tự)
greeting2
chuỗi
Lời chào phụ
header
chuỗi
Văn bản phần đầu chat (tối đa 200 ký tự)
header2
chuỗi
Văn bản phần đầu phụ (tối đa 200 ký tự)
language_chosen
chuỗi
Mã ngôn ngữ phân cách dấu phẩy (tổng tối đa 200 ký tự; mã vượt giới hạn 30 ngôn ngữ bị bỏ)
reply_length
số nguyên (0–2)
0 = Ngắn, 1 = Bình thường, 2 = Dài hơn
one_word_description
chuỗi
Tên AI Agent. API tối đa 200 ký tự; trường trong ứng dụng giới hạn 40.
short_description
chuỗi
Prompt chính của AI (prompt hệ thống). API nhận tối đa 25.000 ký tự trên mọi gói; trình soạn thảo trong ứng dụng giới hạn theo gói, bắt đầu từ 15.000. Giá trị quá dài trả về 422.
ai_commands
mảng chuỗi
Hướng dẫn AI, mỗi phần tử là một hướng dẫn. Tối đa 250 mục, 5.000 ký tự mỗi mục và 10.000 ký tự tổng cộng. Giá trị quá dài trả về 422.

Mỗi phần tử mảng là một hướng dẫn, lưu đúng như bạn gửi. Dấu câu, kể cả dấu chấm phẩy, được giữ nguyên. Endpoint này từng xóa ; khỏi văn bản trước khi lưu; nếu từng loại bỏ hoặc thay dấu chấm phẩy để khắc phục, bạn không cần làm vậy nữa.

Bỏ qua ai_commands hoặc gửi null để giữ nguyên hướng dẫn. Gửi [] để xóa.

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

Phản hồi 200 OK: trả về cài đặt chatbot đã cập nhật (cùng cấu trúc với phản hồi Lấy cài đặt chatbot).