Typowane API klienta
Korzystaj z klienta przyjaznego TypeScript do wiadomości, dalszych konwersacji, konfiguracji widżetu i zlokalizowanych etykiet.
Użyj @openstaticfish/chattybox, aby zachować kontrolę nad interfejsem, podczas gdy ChattyBox obsługuje wyszukiwanie, cytowania źródeł, konwersacje i skalowanie. Bezpieczny dla przeglądarki klucz API identyfikuje projekt i może być ograniczony do zatwierdzonych źródeł.
ChattyBox indeksuje istniejącą witrynę, dokumentację, centrum pomocy, CMS lub bazę wiedzy, a następnie osadza chatbota, który odpowiada na podstawie własnych opublikowanych treści zamiast ogólnej pamięci modelu.
Utwórz projekt ChattyBox, zindeksuj treści i przetestuj reprezentatywne pytania.
Utwórz publiczny klucz API widżetu; opcjonalnie ogranicz go do originów swojej aplikacji.
Zainstaluj @openstaticfish/chattybox i zainicjuj klienta adresem URL API z panelu.
Wyświetl odpowiedzi i adresy URL cytowanych źródeł w interfejsie dopasowanym do produktu.
Uruchomienie w trzech krokach
SDK jest zalecaną ścieżką dla integracji tworzonych przez programistów, które wymagają własnego interfejsu, stanu aplikacji lub przepływów specyficznych dla produktu.
Skorzystaj z tych punktów kontrolnych, aby zdecydować, czy ChattyBox powinien siedzieć obok Twojej platformy dokumentów, zastąpić osobnego asystenta, czy też pozostać odizolowany na czas testów.
Korzystaj z klienta przyjaznego TypeScript do wiadomości, dalszych konwersacji, konfiguracji widżetu i zlokalizowanych etykiet.
Otrzymuj adresy URL źródeł z każdą odpowiedzią i samodzielnie decyduj, jak wyświetlać je w interfejsie.
Zachowaj zwrócony identyfikator rozmowy, aby grupować wiadomości w jednej rozmowie. Bieżące żądanie odpowiedzi nie przekazuje wcześniejszych wiadomości jako kontekstu modelu.
Twoja aplikacja odpowiada za renderowanie i interakcje; ChattyBox obsługuje indeksowanie, wyszukiwanie, generowanie i skalowanie.
Pakiet działa we współczesnych aplikacjach przeglądarkowych i Node.js udostępniających fetch. Użyj dokładnego adresu URL API widżetu i publicznego klucza przeglądarkowego z karty Osadzanie projektu.
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);To biblioteka kliencka zapewniająca komunikację czatu i dane odpowiedzi bez narzucania interfejsu. Twoja aplikacja wyświetla wiadomości, źródła, stany ładowania i elementy sterujące.
Tak. Zainstaluj @openstaticfish/chattybox z npm i użyj publicznego API opisanego w dokumentacji SDK.
SDK wywołuje zarządzaną infrastrukturę ChattyBox, która wyszukuje w zindeksowanych treściach i zwraca wygenerowaną wiadomość z adresami URL cytowanych źródeł.
Użyj SDK, gdy zespół tworzy własny interfejs lub przepływ pracy. Wybierz widget.js, jeśli chcesz gotowego, utrzymywanego przez ChattyBox interfejsu czatu bez kompilacji.
Karta kredytowa nie jest wymagana. Twoje treści nie są używane do trenowania modeli.
Plan Free. Bez karty.
Używamy opcjonalnych narzędzi analitycznych oraz narzędzi do zarządzania tagami, aby rozumieć sposób korzystania z witryny. Wybierz, czy zezwalasz na Ahrefs Web Analytics, PostHog i Google Tag Manager. Wyłączenie analityki spowoduje ponowne załadowanie tej strony, aby zmiana została prawidłowo zastosowana. Podstawowe funkcje witryny i monitorowanie błędów nie zależą od tego wyboru. Przeczytaj naszą politykę prywatności.