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 przeszukuje istniejącą dokumentację, indeksuje treść w celu pobrania i osadza chatbota, który odpowiada, korzystając z dokumentów zamiast ogólnej pamięci modelu.
Utwórz projekt ChattyBox, zindeksuj treści i przetestuj reprezentatywne pytania.
Utwórz publiczny klucz API widżetu i ogranicz go do źródeł 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.
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 konwersacji w stanie odwiedzającego, aby obsługiwać kontekstowe pytania uzupełniające.
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';
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);Zarządzaj stanem czatu i cytowanymi odpowiedziami we własnym interfejsie React.
Bezpiecznie używaj SDK na granicach serwera i klienta App Router.
Poznaj metody klienta, pola odpowiedzi, konwersacje i błędy.
Wybierz utrzymywany interfejs niewymagający kompilacji, jeśli nie potrzebujesz własnego renderowania.
Sprawdź opublikowane wersje, metadane pakietu i polecenie instalacji w npm.
Przejrzyj repozytorium kodu źródłowego, wydania, zgłoszenia i historię projektu na GitHub.
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.