Liigu põhisisu juurde
ChattyBox Logo

JavaScripti SDK

JavaScripti SDK on soovitatud valik uutele arendajate juhitud integratsioonidele. Looge oma vestluskogemus, samal ajal kui ChattyBox hoolitseb teabeotsingu, viidete, vestluste ja skaleerimise eest. Kui soovite valmis kasutajaliidest ilma rakendusekoodita, kasutage selle asemel täielikult toetatud majutatud vidinat.

Enne alustamist​

  1. Looge projekt ja indekseerige oma sisu.
  2. Katsetage juhtpaneelil tüüpilisi küsimusi.
  3. Avage projekti vahekaart Manusta.
  4. Looge või valige avalik vidina API-võti ja seadistage selle lubatud päritolud.
  5. Kopeerige manustamiskoodiga kuvatav vidina API URL.

Avalikud vidina API-võtmed on mõeldud brauserikoodis kasutamiseks. Need tuvastavad projekti, kuid ei ole halduse pääsuandmed. Piirake brauserivõtmed domeenidega, millel peaks olema lubatud teie chatbotile päringuid saata.

Installimine​

bun add @openstaticfish/chattybox

Pakett on ESM-klient tänapäevastele Node.js-i ja brauserirakendustele, mis pakuvad funktsiooni fetch.

Sõnumi saatmine​

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);
console.log(answer.sources);

Määrake PUBLIC_CHATTYBOX_API_URL väärtuseks täpne vidina API URL vahekaardilt Manusta. SDK aktsepteerib nii juurutuse juur-URL-i kui ka URL-i, mille lõpus on /chat.

Vastus sisaldab järgmist:

VäliTüüpKirjeldus
messagestringLoodud vastus.
conversationIdstringTunnus, mida kasutatakse selle vestluse jätkamiseks.
sourcesstring[]Vastuse jaoks leitud allikate URL-id.

Vestluse jätkamine​

Hoidke tagastatud vestluse ID-d oma kasutajaliidese olekus ja saatke see järgmise sõnumiga:

const followUp = await chattybox.sendMessage({
  message: 'Can you explain the second step?',
  conversationId: answer.conversationId,
});

Ärge kasutage sama vestluse ID-d omavahel mitteseotud külastajate jaoks. Uue vestluse loomiseks jätke nende esimeses sõnumis conversationId määramata.

Vigade käsitlemine​

import { Chattybox, ChattyboxError } from '@openstaticfish/chattybox';

try {
  await chattybox.sendMessage({ message: 'Where is the API reference?' });
} catch (error) {
  if (error instanceof ChattyboxError) {
    console.error(error.status, error.code, error.message);
  }
}

ChattyboxError.status sisaldab HTTP-olekut. code on olemas, kui API tagastab struktureeritud veakoodi.

Täiustatud vidinaühilduvus​

SDK pakub ka meetodeid getWidgetConfig() ja getWidgetTranslations(locale). Need meetodid toetavad kliente, kes soovivad jäljendada majutatud vidina projektisätteid ja lokaliseeritud silte. Täielikult kohandatud kasutajaliides võib neid eirata.

Järgmised sammud​