מאגר ידע

מאגר הידע הוא בסיס המומחיות של סוכן ה-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. בלוח הבקרה: זהות > אישיות 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 במאמרים.

Note

שלושת השדות (one_word_description, short_description, ai_commands) משותפים עם הגדרות הצ’אטבוט. עדכון בכל אחת מנקודות הקצה משנה את אותם נתונים.

עדכון הגדרות

היקף הרשאות: write_all

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

גוף הבקשה

פרמטר	תיאור
one_word_description מחרוזת	שם סוכן ה-AI
short_description מחרוזת	פרומפט מערכת / תיאור הסוכן. ה-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 בקבלת הגדרות.

---