ฐานความรู้

ฐานความรู้คือหัวใจของความเชี่ยวชาญของ 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 ใน ดึงการตั้งค่า แทน

---