Skrivet klient-API
Använd en fokuserad TypeScript-vänlig klient för meddelanden, uppföljningskonversationer, widgetkonfiguration och lokaliserade etiketter.
Använd @openstaticfish/chattybox för att äga gränssnittet medan ChattyBox kör hämtning, källhänvisningar, konversationer och skalning. Den webbläsarsäkra API-nyckeln identifierar ditt projekt och kan begränsas till godkända ursprung.
ChattyBox genomsöker din befintliga webbplats, dokumentation, hjälpcenter, CMS eller kunskapsbas och bäddar sedan in en chatbot som svarar utifrån ditt eget publicerade innehåll i stället för modellens generiska minne.
Skapa ett ChattyBox-projekt, indexera ditt innehåll och testa representativa frågor.
Skapa en offentlig widget-API-nyckel; begränsa den valfritt till applikationens origins.
Installera @openstaticfish/chattybox och initiera klienten med API-URL från instrumentpanelen.
Återge svar och citerade källadresser i det gränssnitt som din produkt behöver.
Lansering i tre steg
SDK:n är den rekommenderade sökvägen för utvecklarledda integrationer som behöver anpassat användargränssnitt, applikationstillstånd eller produktspecifika arbetsflöden.
Använd dessa kontrollpunkter för att bestämma om ChattyBox ska sitta bredvid din dokumentplattform, ersätta en separat assistent eller hålla sig isolerad för testning.
Använd en fokuserad TypeScript-vänlig klient för meddelanden, uppföljningskonversationer, widgetkonfiguration och lokaliserade etiketter.
Ta emot källadresser med varje jordat svar och bestäm exakt hur de visas i ditt gränssnitt.
Spara returnerat konversations-ID för att gruppera meddelanden i en konversation. Den aktuella svarsförfrågan inkluderar inte tidigare meddelanden som modellkontext.
Din applikation äger rendering och interaktionsdesign; ChattyBox driver genomsökning, hämtning, generering och skalning.
Paketet fungerar i nuvarande webbläsare och Node.js-applikationer som tillhandahåller hämtning. Använd den exakta widget-API-URL och offentliga webbläsarnyckel som visas på fliken Bädda in i ditt projekt.
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);Det är ett klientbibliotek som tillhandahåller chatttransport och svarsdata utan att föreskriva gränssnittet. Din applikation återger meddelanden, källor, laddningstillstånd och kontroller.
Ja. Installera @openstaticfish/chattybox från npm och använd det offentliga API:t som finns dokumenterat på SDK-referenssidan.
SDK:n anropar ChattyBox-hanterad infrastruktur, som hämtar från ditt indexerade innehåll och returnerar det genererade meddelandet med citerade källadresser.
Använd SDK när ditt team äger ett anpassat gränssnitt eller arbetsflöde. Använd widget.js när du vill att ChattyBox ska upprätthålla ett färdigt chatt-gränssnitt som inte är byggt.
Inget kreditkort krävs. Ditt innehåll används inte för modellträning.
Free-nivå. Inget kort behövs.
Vi använder valfria analys- och tagghanteringsverktyg för att förstå hur webbplatsen används. Välj om du vill tillåta Ahrefs Web Analytics, PostHog och Google Tag Manager. Om du stänger av analysen laddas sidan om så att ändringen genomförs korrekt. Grundläggande webbplatsfunktioner och felövervakning styrs inte av detta val. Läs vår integritetspolicy.