Typat 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, ditt hjälpcenter, CMS eller din kunskapsbas. Hämtat innehåll kan vägleda chatbotens svar; kontrollera att svaren och källhänvisningarna är korrekta.
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 avgöra om ChattyBox ska användas vid sidan av din dokumentationsplattform, ersätta en separat assistent eller användas separat 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 källbaserat svar och bestäm exakt hur de visas i ditt gränssnitt.
Återanvänd samma conversationId för följdfrågor så att modellen får upp till 12 nyligen sparade meddelanden som kontext, vart och ett begränsat till 2 000 tecken. Det är begränsad kontext, inte hela transkriptet; håll ID:n åtskilda mellan obesläktade besökare.
Din applikation äger rendering och interaktionsdesign; ChattyBox driver genomsökning, hämtning, generering och skalning.
Paketet fungerar i moderna webbläsar- och Node.js-applikationer som tillhandahåller fetch. 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 när ditt team ansvarar för ett anpassat gränssnitt eller arbetsflöde. Använd widget.js när du vill att ChattyBox ska underhålla ett färdigt chattgränssnitt utan byggsteg.
Inget kreditkort krävs
Free-nivå. Inget kort behövs.