Basis Pengetahuan

Basis Pengetahuan merupakan inti keahlian Agen AI, berisi seluruh informasi yang digunakan AI untuk menjawab pertanyaan. Endpoint ini memungkinkan Anda mengelola konfigurasi Basis Pengetahuan dan memantau status pemrosesan kontennya.

Basis Pengetahuan berasal dari Artikel yang Anda buat, impor dari situs web, atau unggah sebagai file. Tidak ada langkah pelatihan ulang: setiap artikel yang Anda buat, perbarui, atau hapus diproses otomatis di latar belakang dan berlaku dalam percakapan segera setelah selesai.

Mengambil Pengaturan

Ambil konfigurasi Basis Pengetahuan Anda.

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

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

Kolom	Deskripsi
one_word_description string	Nama Agen AI. Dasbor: Identitas > Persona AI > Nama
short_description string	Prompt sistem / Prompt Utama. Dasbor: Identitas > Persona AI > Prompt Utama
ai_commands array of strings	Pedoman perilaku, satu per elemen array. Dasbor: Identitas > Persona AI > Pedoman. Maksimal 250 elemen, 5.000 karakter per elemen, dan total 10.000 karakter.
pending_embed_count integer	Artikel yang masih diproses. 0 berarti seluruh konten yang Anda kirim sudah aktif
failed_embed_count integer	Artikel yang gagal diproses. Coba ulang melalui Mencoba Ulang Artikel yang Gagal

Menunggu konten aktif

Lakukan polling pada endpoint ini setelah operasi penulisan dan tunggu hingga pending_embed_count mencapai 0. Status per artikel juga tersedia dalam kolom embed_state pada Artikel.

Catatan

Ketiga kolom ini (one_word_description, short_description, ai_commands) digunakan bersama dengan Pengaturan Chatbot. Pembaruan melalui salah satu endpoint mengubah data dasar yang sama.

Memperbarui Pengaturan

Cakupan: write_all

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

Isi Permintaan

Parameter	Deskripsi
one_word_description string	Nama Agen AI
short_description string	Prompt sistem / deskripsi Agen AI. API menerima hingga 25.000 karakter pada semua paket; editor aplikasi membatasinya sesuai paket, mulai dari 15.000. Nilai yang terlalu panjang mengembalikan 422.
ai_commands array of strings	Pedoman AI, satu per elemen array. Maksimal 250 elemen, 5.000 karakter per elemen, dan total 10.000 karakter. Nilai yang terlalu panjang mengembalikan 422.

Cara pedoman disimpan

Setiap elemen array adalah satu pedoman yang disimpan persis seperti dikirim. Tanda baca, termasuk titik koma, tetap dipertahankan. Sebelumnya, pedoman berisi ; dikembalikan sebagai dua pedoman terpisah. Jika Anda menghindari titik koma untuk mengatasinya, hal itu tidak diperlukan lagi.

Endpoint ini sebelumnya menerima pedoman sepanjang apa pun. Batas di atas kini juga diberlakukan di sini dan sama persis dengan Pengaturan Chatbot.

Abaikan ai_commands, atau kirim null, agar pedoman tetap seperti semula. Kirim [] untuk mengosongkannya.

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

Respons 200 OK: mengembalikan pengaturan Basis Pengetahuan yang diperbarui (skema sama seperti Mengambil Pengaturan).

Mencoba Ulang Artikel yang Gagal

Proses ulang semua artikel yang gagal diproses. Artikel yang sudah aktif atau masih diproses tidak diubah, dan panggilan ini aman diulang.

Artikel yang gagal juga dicoba ulang secara otomatis, sehingga endpoint ini hanya diperlukan jika Anda tidak ingin menunggu.

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

Respons 200 OK

{
  "retried": 2
}

Kolom	Deskripsi
retried integer	Jumlah artikel yang gagal dan dimasukkan ke antrean pemrosesan ulang

Melatih Ulang Basis Pengetahuan Tidak digunakan lagi

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

Pelatihan ulang tidak lagi diperlukan; perubahan artikel diproses otomatis. Endpoint ini dipertahankan hanya agar integrasi lama tetap berfungsi: endpoint menerima permintaan, tidak melakukan apa pun, dan mengembalikan 200 OK.

Anda dapat menghapus panggilan ini dari integrasi. Jika sebelumnya Anda melakukan polling hingga pelatihan ulang selesai, kini tunggu hingga pending_embed_count mencapai 0 dalam Mengambil Pengaturan.

---