Search API
Buka di CMSLayar Knowledge Search API memungkinkan sistem Anda sendiri mencari knowledge agent ini dengan API key dan menerima chunk yang cocok, tanpa jawaban buatan AI. Ada di sidebar agent pada Channels → Search API. Fitur ini hanya untuk service agent; di personal agent, sebuah notice menjelaskannya dan kontrolnya tetap mati.
Halaman ini punya tiga tab: Access, Permissions, dan Log. Switch dan key langsung berlaku. Tab Permissions dan Log masing-masing punya form kecil yang disimpan dengan bar Save all changes di bagian bawah; berpindah tab saat ada perubahan yang belum disimpan akan meminta konfirmasi dulu.
Tab Access
| Allow search through the API | Mati secara default. Jika mati, setiap pencarian ditolak, meskipun key-nya valid. Hint menunjukkan kapan terakhir diubah. Jika menyala tanpa key aktif, sebuah notice meminta Anda membuat key. |
| Endpoint | Alamat tujuan sistem Anda mengirim query (POST), dengan tombol salin. |
| Agent ID | ID agent, dengan tombol salin. |
| cURL | Contoh request yang siap dijalankan. Key dibaca dari environment variable QLAR_SEARCH_KEY. |
| Keep the key on your server | Peringatan: siapa pun yang memegang key bisa mengirim kode permission apa saja, jadi panggil API hanya dari back-end Anda sendiri. |
| API docs | Membuka API Pencarian Knowledge di tab baru. |
| Cost | Setiap pencarian memakai 1 kredit, juga jika tidak menemukan apa pun. Gratis jika model embedding milik organisasi Anda yang melayani pencarian. Request yang ditolak tidak dikenai biaya. |
Key Primary dan Secondary
Dua slot, supaya Anda bisa merotasi key tanpa downtime. Setiap slot menampilkan chip status: Active, Expired, Revoked, atau Empty.
| Name, Key, Created, Expires | Nama key, empat karakter terakhirnya (qks_…abcd), kapan dibuat, dan kapan kedaluwarsa (atau Never). |
| Create key / Replace key | Membuka dialog berisi Name (maksimal 80 karakter) dan Expiry (7, 14, 30, 90, 180, atau 365 hari, atau Never expires; default 90 hari). Mengganti key yang aktif akan memperingatkan bahwa key lama langsung berhenti bekerja. |
| Copy your new key | Tampil sekali setelah key dibuat. Salin sebelum menutup: key tidak bisa ditampilkan lagi. Menutup dialog akan meminta konfirmasi dulu. |
| Revoke | Meminta konfirmasi, lalu langsung menghentikan key. Key yang sudah dicabut tidak bisa dinyalakan lagi. |
Used by other agents
Tampil jika agent lain mencari di agent ini melalui Knowledge → External. Satu baris untuk setiap key yang dibuat Qlar untuk mereka: Agent, Key (empat karakter terakhir), Made, Status (Active atau Revoked). Menu baris berisi Revoke, yang meminta konfirmasi lalu langsung menghentikan pencarian agent tersebut. Lihat Knowledge Eksternal.
Tab Permissions
| How permissions work in a search | Notice info: setiap pencarian membawa kode yang dipilih di sini, dan kode milik pemanggil ditambahkan di atasnya. |
| Permission codes | Pilih kode dari daftar permission agent. Kode ini ditambahkan ke setiap pencarian yang memakai key agent ini. Biarkan kosong untuk hanya memakai kode dari pemanggil. |
| No permission codes yet | Tampil jika agent belum punya kode permission. Open Permissions membuka Users → Permissions. |
| Kode yang sudah tidak ada di daftar | Peringatan jika kode yang tersimpan sudah dihapus dari daftar permission agent. |
Tab Log
Pengaturan log
| Keep entries for | Berapa lama entri disimpan. Jika Anda memperpendeknya, muncul peringatan bahwa entri lama akan dihapus, dan menyimpan akan meminta konfirmasi. Periode yang lebih panjang hanya berlaku untuk entri baru. |
| Store query text | Menyala secara default: log menyimpan teks query. Mati: log menyimpan semua informasi panggilan kecuali teks yang dicari, dan menampilkan Not stored. |
Panggilan pencarian
Filter: tanggal From dan To, serta Outcome (All, Success, Failed). Refresh memuat ulang daftar; Load more menampilkan entri yang lebih lama.
| Kolom | Isi |
|---|---|
| Time | Waktu panggilan, dalam zona waktu Anda. |
| Outcome | Chip Success atau Failed. |
| Status | Kode status HTTP yang dikembalikan. |
| Key | Nama key dan empat karakter terakhirnya. |
| Query | Query-nya, atau Not stored. |
| Results | Jumlah chunk yang dikembalikan. |
| Credits | Kredit yang terpakai (0 atau 1). |
| Model | Qlar atau Your model: embedding siapa yang melayani pencarian. |
| Duration | Lama pencarian. |
| Error | Kode error dan pesan dari panggilan yang gagal. |
Klik sebuah baris untuk membukanya: chunk yang dikembalikan (yang terdekat lebih dulu), distance terdekat, permission yang dikirim pemanggil, permission yang dipakai pencarian, limit, serta alamat IP dan user agent pemanggil.
Panduan terkait: API Pencarian Knowledge