API klien bertipe
Gunakan klien yang ringkas dan ramah TypeScript untuk pesan, percakapan lanjutan, konfigurasi widget, dan label yang dilokalkan.
Gunakan @openstaticfish/chattybox untuk mengendalikan antarmuka, sementara ChattyBox menangani retrieval, sitasi sumber, percakapan, dan penskalaan. Kunci API yang aman untuk browser mengidentifikasi proyek Anda dan dapat dibatasi ke origin yang disetujui.
Percakapan ilustratif — bukan chat langsung.
ChattyBox merayapi situs web, dokumentasi, pusat bantuan, CMS, atau basis pengetahuan yang sudah ada, lalu menyematkan chatbot yang menjawab berdasarkan konten terbitan Anda sendiri, bukan memori model generik.
Buat proyek ChattyBox, indeks konten Anda, dan uji pertanyaan yang representatif.
Buat kunci API widget publik; batasi ke origin aplikasi Anda jika diinginkan.
Instal @openstaticfish/chattybox dan inisialisasi klien dengan URL API dari dasbor.
Tampilkan jawaban dan URL sumber yang disitasi dalam antarmuka yang dibutuhkan produk Anda.
Peluncuran tiga langkah
SDK adalah jalur yang direkomendasikan untuk integrasi yang dipimpin developer dan memerlukan UI kustom, state aplikasi, atau alur kerja khusus produk.
Gunakan pos pemeriksaan ini untuk memutuskan apakah ChattyBox harus ditempatkan di samping platform dokumen Anda, menggantikan asisten terpisah, atau tetap terisolasi untuk pengujian.
Gunakan klien yang ringkas dan ramah TypeScript untuk pesan, percakapan lanjutan, konfigurasi widget, dan label yang dilokalkan.
Terima URL sumber bersama setiap jawaban berbasis sumber dan tentukan sendiri cara menampilkannya di antarmuka.
Gunakan kembali conversationId yang sama untuk pertanyaan lanjutan agar model menerima hingga 12 pesan terbaru yang tersimpan sebagai konteks, masing-masing dipotong hingga 2.000 karakter. Ini konteks terbatas, bukan seluruh transkrip; pisahkan ID di antara pengunjung yang tidak berkaitan.
Aplikasi Anda mengendalikan rendering dan desain interaksi; ChattyBox mengoperasikan crawling, retrieval, generation, dan penskalaan.
Paket ini berfungsi di aplikasi browser dan Node.js modern yang menyediakan fetch. Gunakan URL widget API dan kunci browser publik yang persis seperti pada tab Embed proyek Anda.
import { Chattybox } from '@openstaticfish/chattybox';
// Replace these placeholders with the public key and widget API URL from Embed.
const chattybox = new Chattybox({
apiKey: 'YOUR_PUBLIC_WIDGET_KEY',
baseUrl: 'YOUR_WIDGET_API_URL',
});
const answer = await chattybox.sendMessage({
message: 'How do I get started?',
});
console.log(answer.message, answer.sources);SDK ini adalah pustaka klien yang menyediakan transport chat dan data respons tanpa menentukan antarmukanya. Aplikasi Anda menampilkan pesan, sumber, state pemuatan, dan kontrol.
Ya. Instal @openstaticfish/chattybox dari npm dan gunakan API publik yang didokumentasikan pada halaman referensi SDK.
SDK memanggil infrastruktur terkelola ChattyBox, yang mengambil informasi dari konten terindeks dan mengembalikan pesan yang dibuat beserta URL sumber yang disitasi.
Gunakan SDK jika tim Anda mengendalikan antarmuka atau alur kerja kustom. Gunakan widget.js jika Anda ingin ChattyBox mengelola UI chat siap pakai tanpa proses build.
Tidak perlu kartu kredit
Paket gratis. Tanpa kartu.