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 crawlar din befintliga dokumentation, indexerar innehållet för hämtning och bäddar in en chattbot som svarar med dina docs i stället för generiskt modellminne.
Skapa ett ChattyBox-projekt, indexera ditt innehåll och testa representativa frågor.
Skapa en offentlig widget-API-nyckel och begränsa den till applikationens ursprung.
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.
Behåll det returnerade konversations-ID:t i besökarstatus för att stödja kontextuella uppföljningsfrågor.
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';
const chattybox = new Chattybox({
apiKey: import.meta.env.PUBLIC_CHATTYBOX_API_KEY,
baseUrl: import.meta.env.PUBLIC_CHATTYBOX_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.
We use optional analytics and tag-management tools to understand site use. Choose whether to allow PostHog and Google Tag Manager. Turning analytics off reloads this page so the change takes effect cleanly. Essential site functionality and error monitoring are not controlled by this choice. Read our privacy policy.