Bilgi Tabanı

Bilgi Tabanı, AI Temsilcinizin uzmanlığının temelidir. AI’ın soruları yanıtlarken kullandığı tüm bilgileri içerir. Bu uç noktalar Bilgi Tabanı yapılandırmasını yönetmenizi ve içeriğinin işlenme durumunu izlemenizi sağlar.

Bilgi Tabanı, oluşturduğunuz, web sitelerinden içe aktardığınız veya dosya olarak yüklediğiniz Makalelerden yararlanır. Yeniden eğitim adımı yoktur: oluşturduğunuz, güncellediğiniz veya sildiğiniz her makale arka planda otomatik işlenir ve işlem tamamlanır tamamlanmaz konuşmalarda geçerli olur.

Ayarları alma

Bilgi Tabanınızın yapılandırmasını alın.

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

Yanıt 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
}

Alan	Açıklama
one_word_description dize	AI Temsilcisinin adı. Kontrol paneli: Kimlik > AI kişiliği > Ad
short_description dize	Sistem istemi / Ana istem. Kontrol paneli: Kimlik > AI kişiliği > Ana istem
ai_commands dize dizisi	Her dizi öğesinde bir davranış yönergesi. Kontrol paneli: Kimlik > AI kişiliği > Yönergeler. En fazla 250 öğe, öğe başına 5.000 ve tüm öğelerde toplam 10.000 karakter.
pending_embed_count tamsayı	Hâlâ işlenen makaleler. 0, gönderdiğiniz her şeyin yayında olduğu anlamına gelir
failed_embed_count tamsayı	İşlenmesi başarısız olan makaleler. Başarısız makaleleri yeniden deneme ile tekrar deneyin

Waiting for content to go live

Bir yazma işleminden sonra bu uç noktayı düzenli aralıklarla sorgulayın ve pending_embed_count değerinin 0 olmasını bekleyin. Makale başına durum, Makalelerdeki embed_state alanında da bulunur.

Not

Bu üç alan (one_word_description, short_description, ai_commands) Chatbot Ayarlarıyla ortaktır. Her iki uç noktadan yapılan güncellemeler aynı temel verileri değiştirir.

Ayarları güncelleme

Kapsam: write_all

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

İstek gövdesi

Parametre	Açıklama
one_word_description dize	AI Temsilcisinin adı
short_description dize	Sistem istemi / AI Temsilcisi açıklaması. API her planda en fazla 25.000 karakter kabul eder; uygulama içi düzenleyici ise planınızın 15.000’den başlayan üst sınırını uygular. Çok büyük değer 422 döndürür.
ai_commands dize dizisi	Her dizi öğesinde bir AI Yönergesi. En fazla 250 öğe, öğe başına 5.000 ve tüm öğelerde toplam 10.000 karakter. Çok büyük değer 422 döndürür.

How guidelines are stored

Her dizi öğesi bir yönergedir ve tam gönderdiğiniz biçimiyle kaydedilir. Noktalı virgül dahil noktalama işaretleri korunur. Eskiden ; içeren bir yönerge iki ayrı yönerge olarak dönerdi. Bu sorunu aşmak için noktalı virgülden kaçınıyorsanız artık bunu yapmanıza gerek yoktur.

Bu uç nokta daha önce her uzunlukta yönerge kabul ediyordu. Yukarıdaki sınırlar artık burada da uygulanır ve Chatbot Ayarlarıyla tam olarak aynıdır.

Yönergeleri değiştirmemek için ai_commands göndermeyin veya null gönderin. Temizlemek için [] gönderin.

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

Yanıt 200 OK: güncellenmiş Bilgi Tabanı ayarlarını döndürür (Ayarları alma ile aynı şema).

Başarısız makaleleri yeniden deneme

İşlenmesi başarısız olan tüm makaleleri yeniden işleyin. Zaten yayında olan veya hâlâ işlenen makalelere dokunulmaz ve çağrı güvenle tekrarlanabilir.

Başarısız makaleler otomatik olarak da yeniden denenir. Bu uç nokta yalnızca bunu beklemek istemediğinizde gerekir.

Kapsam: 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>"},
)

Yanıt 200 OK

{
  "retried": 2
}

Alan	Açıklama
retried tamsayı	Yeniden işlenmek üzere kuyruğa alınan başarısız makale sayısı

Bilgi Tabanını yeniden eğitme Kullanımdan kaldırıldı

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

Yeniden eğitim artık yoktur; makale değişiklikleri otomatik işlenir. Bu uç nokta yalnızca mevcut entegrasyonların çalışmaya devam etmesi için korunur: isteği kabul eder, hiçbir şey yapmaz ve 200 OK döndürür.

Bu çağrıyı entegrasyonunuzdan kaldırabilirsiniz. Yeniden eğitim tamamlanana kadar sorguluyorsanız bunun yerine Ayarları alma işlemindeki pending_embed_count değerinin 0 olmasını bekleyin.

---