Tyypitetty asiakas-API
Käytä selkeää TypeScript-ystävällistä asiakasta viesteihin, jatkokeskusteluihin, widgetin määrityksiin ja lokalisoituihin teksteihin.
@openstaticfish/chattybox antaa sinulle käyttöliittymän hallinnan, kun ChattyBox hoitaa tiedonhaun, lähdeviitteet, keskustelut ja skaalauksen. Selaimessa turvallinen API-avain tunnistaa projektisi, ja sen käyttö voidaan rajata hyväksyttyihin origineihin.
ChattyBox indeksoi olemassa olevan dokumentaatiosi, indeksoi sisällön haettavaksi ja upottaa chatbotin, joka vastaa käyttämällä asiakirjojasi yleisen mallimuistin sijaan.
Luo ChattyBox-projekti, indeksoi sisältösi ja testaa edustavia kysymyksiä.
Luo julkinen widgetin API-avain ja rajaa se sovelluksesi origineihin.
Asenna @openstaticfish/chattybox ja alusta asiakas koontinäytön API-URL-osoitteella.
Esitä vastaukset ja lähteinä käytetyt URL-osoitteet tuotteesi tarvitsemassa käyttöliittymässä.
Kolmivaiheinen käynnistys
SDK on suositeltu ratkaisu kehittäjävetoisiin integraatioihin, jotka tarvitsevat mukautetun käyttöliittymän, sovellustilan tai tuotekohtaisia työnkulkuja.
Käytä selkeää TypeScript-ystävällistä asiakasta viesteihin, jatkokeskusteluihin, widgetin määrityksiin ja lokalisoituihin teksteihin.
Saat lähde-URL-osoitteet jokaisen lähteisiin perustuvan vastauksen mukana ja päätät itse, miten ne näkyvät käyttöliittymässä.
Säilytä palautettu keskustelutunnus kävijän tilassa, jotta kontekstuaaliset jatkokysymykset toimivat.
Sovelluksesi hallitsee esitystä ja vuorovaikutusta; ChattyBox hoitaa haravoinnin, tiedonhaun, vastausten luonnin ja skaalauksen.
Paketti toimii nykyisissä selain- ja Node.js-sovelluksissa, joissa fetch on käytettävissä. Käytä projektisi Upota-välilehdellä näkyvää tarkkaa widgetin API-URL-osoitetta ja julkista selainavainta.
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);Hallitse chatin tilaa ja lähdeviitteellisiä vastauksia mukautetussa React-käyttöliittymässä.
Käytä SDK:ta turvallisesti App Routerin palvelin- ja asiakasrajojen yli.
Tutustu asiakkaan metodeihin, vastauskenttiin, keskusteluihin ja virheisiin.
Valitse ylläpidetty, käännösvaihetta tarvitsematon käyttöliittymä, kun et tarvitse mukautettua esitystä.
Tutustu julkaistuihin versioihin, paketin metatietoihin ja asennuskomentoon npm:ssä.
Tutustu lähdekoodivarastoon, julkaisuihin, ongelmiin ja projektin historiaan GitHubissa.
Se on asiakaskirjasto, joka tarjoaa chat-yhteyden ja vastausdatan määräämättä käyttöliittymää. Sovelluksesi esittää viestit, lähteet, lataustilat ja ohjaimet.
Kyllä. Asenna @openstaticfish/chattybox npm:stä ja käytä SDK-viitesivulla dokumentoitua julkista API:a.
SDK kutsuu ChattyBoxin hallittua infrastruktuuria, joka hakee indeksoidusta sisällöstäsi ja palauttaa luodun viestin sekä lähteinä käytetyt URL-osoitteet.
Käytä SDK:ta, kun tiimisi rakentaa mukautetun käyttöliittymän tai työnkulun. Käytä widget.js:ää, kun haluat ChattyBoxin ylläpitämän valmiin chat-käyttöliittymän ilman käännösvaihetta.
Luottokorttia ei vaadita. Sisältöäsi ei käytetä mallien kouluttamiseen.
Ilmainen taso. Ei korttia.