Cơ sở kiến thức

Cơ sở kiến thức là nền tảng chuyên môn của AI Agent, chứa toàn bộ thông tin AI dùng để trả lời. Các endpoint này cho phép quản lý cấu hình Cơ sở kiến thức và theo dõi trạng thái xử lý nội dung.

Cơ sở kiến thức lấy dữ liệu từ Bài viết bạn tạo, nhập từ website hoặc tải lên dưới dạng tệp. Không có bước huấn luyện lại: mỗi bài được tạo, cập nhật hoặc xóa đều tự xử lý trong nền và có hiệu lực trong cuộc trò chuyện ngay khi hoàn tất.

Lấy cài đặt

Lấy cấu hình Cơ sở kiến thức.

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

Phản hồi 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
}

Trường	Mô 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
short_description chuỗi	Prompt hệ thống / Prompt chính. Bảng điều khiển: Danh tính > Tính cách AI > Prompt chính
ai_commands mảng chuỗi	Hướng dẫn hành vi, 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.
pending_embed_count số nguyên	Bài viết vẫn đang xử lý. 0 nghĩa là mọi nội dung đã gửi đều có hiệu lực
failed_embed_count số nguyên	Bài viết xử lý thất bại. Thử lại bằng Thử lại bài viết thất bại

Chờ nội dung có hiệu lực

Thăm dò endpoint này sau khi ghi và chờ pending_embed_count về 0. Trạng thái từng bài cũng có trong trường embed_state của Bài viết.

Ghi chú

Ba trường này (one_word_description, short_description, ai_commands) dùng chung với Cài đặt chatbot. Cập nhật qua một trong hai endpoint đều sửa cùng dữ liệu bên dưới.

Cập nhật cài đặt

Phạm vi: write_all

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

Nội dung yêu cầu

Tham số	Mô tả
one_word_description chuỗi	Tên AI Agent
short_description chuỗi	Prompt hệ thống / mô tả AI Agent. 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.

Cách lưu hướng dẫn

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. Trước đây hướng dẫn có ; có thể trả về thành hai hướng dẫn riêng, nên nếu từng tránh dấu chấm phẩy để khắc phục, bạn không cần làm vậy nữa.

Endpoint này trước đây chấp nhận hướng dẫn dài tùy ý. Nay các giới hạn trên cũng được áp dụng và khớp hoàn toàn với Cài đặt chatbot.

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

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

Phản hồi 200 OK: trả về cài đặt Cơ sở kiến thức đã cập nhật (cùng cấu trúc với Lấy cài đặt).

Thử lại bài viết thất bại

Xử lý lại mọi bài viết đã thất bại. Bài đã có hiệu lực hoặc đang xử lý không bị tác động và có thể gọi lặp lại an toàn.

Bài thất bại cũng được tự động thử lại, nên endpoint này chỉ cần khi bạn không muốn chờ.

Phạm vi: 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>"},
)

Phản hồi 200 OK

{
  "retried": 2
}

Trường	Mô tả
retried số nguyên	Số bài thất bại được xếp hàng xử lý lại

Huấn luyện lại Cơ sở kiến thức Không còn dùng

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

Không còn bước huấn luyện lại; thay đổi bài viết được xử lý tự động. Endpoint này chỉ được giữ để các tích hợp hiện có tiếp tục hoạt động: nhận yêu cầu, không làm gì và trả về 200 OK.

Bạn có thể bỏ lệnh gọi này khỏi tích hợp. Nếu từng thăm dò đến khi huấn luyện lại hoàn tất, thay vào đó hãy chờ pending_embed_count về 0 trong Lấy cài đặt.

---