Neidio i'r prif gynnwys
ChattyBox Logo

SDK JavaScript

Yr SDK JavaScript yw'r llwybr a argymhellir ar gyfer integreiddiadau newydd a arweinir gan ddatblygwyr. Adeiladwch eich profiad sgwrsio eich hun tra bo ChattyBox yn gweithredu adalw, dyfyniadau, sgyrsiau a graddio. Os ydych am gael rhyngwyneb parod heb god rhaglen, defnyddiwch y widget lletyol a gefnogir yn llawn yn lle hynny.

Cyn dechrau​

  1. Crëwch brosiect a mynegeiwch eich cynnwys.
  2. Profwch gwestiynau nodweddiadol yn y dangosfwrdd.
  3. Agorwch dab Mewnosod y prosiect.
  4. Crëwch neu dewiswch allwedd API gyhoeddus y widget a ffurfweddwch ei tharddleoedd a ganiateir.
  5. Copïwch URL API y widget a ddangosir gyda'r darn mewnosod.

Mae allweddi API cyhoeddus y widget wedi'u cynllunio i ymddangos yng nghod y porwr. Maent yn adnabod prosiect ond nid ydynt yn fanylion mewngofnodi rheoli. Cyfyngwch allweddi porwr i'r parthau y dylid caniatáu iddynt alw eich chatbot.

Gosod​

bun add @openstaticfish/chattybox

Mae'r pecyn yn gleient ESM ar gyfer rhaglenni Node.js a phorwr cyfredol sy'n darparu fetch.

Anfon neges​

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);

Gosodwch PUBLIC_CHATTYBOX_API_URL i union URL API y widget o'r tab Mewnosod. Mae'r SDK yn derbyn naill ai gwraidd y gosodiad neu URL sy'n gorffen â /chat.

Mae'r ymateb yn cynnwys:

MaesMathDisgrifiad
messagestringYr ateb a gynhyrchwyd.
conversationIdstringDynodwr a ddefnyddir i barhau'r sgwrs hon.
sourcesstring[]URLau'r ffynonellau a adalwyd ar gyfer yr ateb.

Parhau sgwrs​

Cadwch ID y sgwrs a ddychwelwyd yng nghyflwr eich rhyngwyneb a'i anfon gyda'r neges nesaf:

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

Peidiwch ag ailddefnyddio un ID sgwrs ar gyfer ymwelwyr nad ydynt yn gysylltiedig. Crëwch sgwrs newydd drwy hepgor conversationId o'u neges gyntaf.

Trin gwallau​

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);
  }
}

Mae ChattyboxError.status yn cynnwys statws HTTP. Mae code yn bresennol pan fydd yr API yn dychwelyd cod gwall strwythuredig.

Cydnawsedd widget uwch​

Mae'r SDK hefyd yn darparu getWidgetConfig() a getWidgetTranslations(locale). Mae'r dulliau hyn yn cefnogi cleientiaid sydd am ail-greu gosodiadau prosiect a labeli lleol y widget lletyol. Gall rhyngwyneb cwbl bersonol eu hanwybyddu.

Camau nesaf​