:::note Versiooni olek
Avaldatud npm-SDK 0.1.4 koos hostitud widget.js v15-ga toetab teardowni remove() või window.ChattyBox.destroy() kaudu: see eemaldab UI/styled ja katkestab ootel käivituse, korduskatsed ning vestlused. Headless sendMessage() ei korda päringuid automaatselt.
:::
Hostitud vidina kohandamine
Kohandage valmis kasutajaliidest, mida laaditakse aadressilt https://chattybox.ai/widget.js. Raamistike ja platvormide ametlikud paigaldusnäited leiate paigaldusjuhenditest.
Enne kohandamist
Looge projekt, indekseerige selle sisu ja kontrollige tüüpilisi vastuseid Test Chat-is, enne kui hakkate esitlusele aega kulutama. Täielikku järjekorda kirjeldab Alustamise leht.
Hostitud vidina seadistamine
- Avage juhtpaneel ja valige oma projekt.
- Avage vahekaart Embed.
- Vaadake vidina välimus ja keelekäitumine eelvaates üle ning salvestage need.
Vahekaart Embed juhib esitlust ja loob paigalduskoodi, kuid avalikke võtmeid hallatakse eraldi. Kui olete valmis paigaldama:
- Avage Public Keys ja looge brauserivõti.
- Naaske jaotisse Embed, valige võti ja kopeerige loodud koodilõik. Võti töötab tootmises, eelvaadetes, testkeskkonnas ja localhostis vaikimisi.
- Soovi korral avage Public Keys > Edit origins ning lubage täpne origin’i piirang lisakaitseks.
- Järgige oma platvormi paigaldusjuhendeid.
<script
src="https://chattybox.ai/widget.js"
data-api-key="YOUR_API_KEY"
data-api-url="https://adorable-woodpecker-629.convex.site/chat"
async
></script>
Juhtpaneelil salvestatud vidina esitlusmuudatused rakenduvad järgmisel vidina algkäivitusel ilma teie saidil olevat koodilõiku asendamata. Juba avatud leht ei uuene reaalajas; laadige see uuesti.
Visuaalne kohandamine
ChattyBox sisaldab täielikult integreeritud visuaalset redaktorit. Saate vidina välimuse ja tunnetuse oma brändiga täpselt sobitada ilma koodi muutmata.
Juhtpaneeli juhtelemendid
-
Accent Color - Valige oma brändi põhivärv. See mõjutab avajat, olulisi esiletõsteid ja kasutaja sõnumeid.
-
Position - Valige, kus vidin ekraanil kuvatakse.
-
Header Title - Määrake vestlusakna ülaosas kuvatav pealkiri.
-
Welcome Message - Kohandage esimest sõnumit, mida külastajad vestluse avamisel näevad.
Salvestage muudatused, seejärel laadige paigaldatud leht uuesti ja kontrollige tulemust. Juhtpaneeli eelvaade ei ole hostitud vidinaga identne.
Täpsemad valikud
Juhtpaneeli seaded ja skriptiatribuudid
Enamikku vidina käitumisest tuleks hallata juhtpaneelilt, et lihtsate muudatuste jaoks ei peaks veebisaiti uuesti juurutama.
Kasutage juhtpaneeli värvide, asukoha, ikooni, pealkirja, tervitussõnumi, vaikekeele, avalike võtmete haldamise, kraapimise ja Analyticsi jaoks. Starter ja kõrgem pakett saavad peita jaluse „Powered by ChattyBox”; Free-paketil jääb branding nähtavaks.
Kui teie projekt kasutab avaliku võtme origin’ide piiranguid, hoidke piirangud sünkroonis domeenidega, kuhu vidin on paigaldatud.
Kasutage skriptiatribuute ainult väärtuste jaoks, mida vidin vajab lehe laadimise ajal:
data-api-keytuvastab avaliku vidinavõtme.data-api-urlütleb vidinale, kuhu päringud saata. Tootmises on see juhtpaneelilt pärit stabiilnehttps://...convex.site/chatURL.data-localetaotleb kasutajaliidese kindlat keelt algkäivitamisel ainult siis, kui projekt lubab skripti ülekirjutust.data-colorjadata-positionalistavad pärast edukat seadistuse päringut salvestatud värvi või asukoha; eelistage juhtpaneeli väärtusi.data-debug="true"lülitab sisse konsoolidiagnostika.
Hostitud vidin saadab iga chat-päringuga valideeritud avaliku HTTP(S)-lehe origin’i ja tee Popular Triggers analüütika jaoks; query-string, fragment ja mandaadid eemaldatakse. Lehekontekst ei mõjuta indekseeritud allikate otsingut. Ärge laadige vidinat tundlikel teedel ainult seetõttu, et query-string eemaldatakse.
Chat kasutab terviklikku JSON-vastust, mitte token-streaming’ut. Hostitud v15 loader loob iga sõnumi jaoks idempotentsusvõtme ja teeb võrguvea, HTTP 429, HTTP 5xx ning loetava Retry-After päisega 409 korral kokku kuni 10 transpordikatset. Automaatsete retry’de planeerimise eelarve on kuni 30 sekundit, mitte iga fetchi range timeout; loetav Retry-After arvestatakse sellesse eelarvesse. Peata SDK seda retry-käitumist ei paku. Vestluse olek on ainult selle vidinainstantsi mälus ja kaob reload’i või uuestialgkäivituse järel. Allikad deduplikeeritakse ja kuvatakse kuni kolme kirjena; varuvastusel võivad allikad puududa.
Kui vidin pärast paigaldamist ei ilmu, vaadake tõrkeotsingut.
Platvormipõhiste näidete jaoks alustage Docusauruse, MkDocsi, VitePressi, WordPressi või GitBooki juhendist.
Vidina peitmine kindlatel lehtedel
Kui peate vidina valitud lehtedel visuaalselt peitma, saate kasutada ainult neil lehtedel CSS-i:
.chattybox-widget {
display: none;
}
CSS-iga peitmine ei peata algkäivitust, API-päringuid ega veateavitust ning ei ole nõusoleku- ega privaatsuskontroll. Laadimise vältimiseks jätke skript neil lehevastustel välja. Kliendipoolsete marsruudimuutuste või nõusoleku tühistamise jaoks pakub hostitud widget.js v15 window.ChattyBox.destroy()-i ning avaldatud SDK 0.1.4 kasutab sama teardowni jaoks remove()-i.
Kohandatud integratsioonid
Kas vajate hostitud vidinast kohandatumat lahendust? Looge oma kasutajaliides JavaScripti SDK abil või kirjutage arhitektuurialase abi saamiseks aadressil support@chattybox.ai.
Mitmekeelne tugi
ChattyBoxi vidin määrab kasutajaliidese lokaadi algkäivitamisel projekti Fixed- või Auto-režiimi järgi; hilisemaid atribuudi-, juhtpaneeli- ega kliendipoolse marsruutimise muutusi ei jälgita.
Ametlikult toetatud keeled
Vidinal on 14 keele tõlkekataloogid. Kataloogi olemasolu ei tähenda, et kõik nähtavad või abistavad stringid on tõlgitud, ega taga vastuse kvaliteeti.
| Keel | Kood |
|---|---|
| Inglise | en |
| Prantsuse | fr |
| Saksa | de |
| Hispaania | es |
| Itaalia | it |
| Hollandi | nl |
| Portugali | pt |
| Poola | pl |
| Rootsi | sv |
| Indoneesia | id |
| Eesti | et |
| Soome | fi |
| Kõmri | cy |
| Tšehhi | cs |
:::note Kasutajaliidese keel ja vastused Kasutajaliidese lokaal ei ole vestluse keeleparameeter. Taustsüsteem tuvastab küsimuse keele ning püüab teha keeleteadlikku otsingut ja genereerimist; vastuste keel ja kvaliteet sõltuvad indekseeritud sisust ja mudelist. :::
Kuidas keele tuvastamine töötab
Vidin kasutab ahelas toimivat tuvastussüsteemi:
- Lubatud skripti ülekirjutus - Mittetühi
data-localevõidab ainult siis, kuiallowLocaleOverrideei ole false, ka Fixed-režiimis. - Fixed-režiim - Ilma lubatud ülekirjutuseta kasutatakse
defaultLocale-i. - Auto-režiim - Kasutatakse esimest mittetühja väärtust: lehe
<html lang>, brauserinavigator.language(või vanauserLanguage) ja seejäreldefaultLocale. - Normaliseerimine - Toetatud piirkondlikud väärtused, näiteks
fr-CA, vähendatakse põhikoodiks; toetamata väärtus muutub kohe ingliskeelseks, ilma järgmist kandidaati proovimata.
Keele käsitsi ülekirjutamine
Konkreetse keele taotlemiseks sõltumata brauseri seadetest lubage Allow Script Override ja lisage enne loaderi käivitamist atribuut data-locale:
<script
src="https://chattybox.ai/widget.js"
data-api-key="YOUR_API_KEY"
data-locale="de"
data-api-url="https://adorable-woodpecker-629.convex.site/chat"
async
></script>
:::tip Kasutusjuht
See on eriti kasulik mitmekeelse veebisaidi puhul, kus igal keeleversioonil on oma URL (nt /de/, /fr/). Seadke data-locale enne loaderi käivitamist vastama iga lehe keelele ja kontrollige renderdatud kasutajaliidest.
:::
Juhtpaneeli keeleseaded
Rakenduse juhtpaneel võimaldab projekti kaupa vidina keele-eelistusi seadistada:
- Auto-detect - Kasutab lehe keelt enne külastaja brauseri keelt
- Fixed Language - Kasutab seadistatud vaikekeelt, kui lubatud
data-localeseda ei kirjuta üle - Allow Script Override - Lubab või keelab atribuudi
data-localeülekirjutuse
Need seaded leiate juhtpaneelist → Projekt → vahekaart Embed → jaotis Widget Language.
Sisu keele sobitamine
Kasuliku mitmekeelse kogemuse jaoks indekseerige avalikku sisu külastajate keeltes ja kontrollige viiteid; tuvastus ega otsing ei ole garanteeritud. Selleks tehke järgmist:
- Kraapige dokumentatsiooni kõik keeleversioonid faili
sitemap.xmlabil. - Kraapija püüab lehe keelt tuvastada; kontrollige sisu ja viiteid.
- Otsing püüab eelistada küsimuse keelt, kuid võib kasutada muud indekseeritud sisu.
Seadistamine rakenduse juhtpaneelil: kasutage kraapimise seadistamisel oma sitemap.xml URL-i (nt https://yourdocs.com/sitemap.xml) keeleversioonide leidmiseks ning kontrollige seejärel indekseeritud lehti. Saidikaardid ei möödu roomamispiirangutest ega välistustest.
Tõrkeotsing
Vidin näitab endiselt inglise keelt
- Sundvärskendus diagnostikana - Laadige leht uuesti klahvidega Ctrl+F5 või Cmd+Shift+R ja kontrollige brauseri võrgupaneelil vidina- ja tõlkepäringuid
- Kontrollige
data-locale-i - Veenduge, et atribuut on õigesti määratud toetatud keelekoodile - Kontrollige brauseri keelt - Veenduge, et brauseri eelistatud keel on õigesti seadistatud
- Kontrollige lehe HTML-i lang-atribuuti - Veenduge, et lehel on
<html lang="de">(või sobiv kood)
Allikad on vales keeles
- Kraapige sisu uuesti - Veenduge, et kõik keeleversioonid on indekseeritud
- Kasutage sitemap.xml-i - Kontrollige, et soovitud URL-id oleksid tõesti indekseeritud; roomamispiirangud ja välistused võivad need välja jätta
- Kontrollige päringu keelt - AI proovib vastuse keelt päringu keelega sobitada
Tõlked puuduvad
- Kontrollige toetatud keeli - Ainult ülal loetletud 14 koodil on kataloogid; puuduvad sildid võivad jääda ingliskeelseks
Head tavad
- Määrake lehtedel
<html lang>- See aitab nii juurdepääsetavuse kui ka vidina tuvastamisega - Testige arenduse ajal
data-locale-iga - Kontrollige, et iga keel renderdub õigesti - Kraapige kõik keeleversioonid - Kasutage
sitemap.xml-i leidmiseks ja kontrollige indekseeritud lehti - Vaadake üle päris küsimused - Kontrollige vestlusi ja keelepõhiseid sisulünki; juhtpaneel ei näita praegu vidina lokaadi jaotust
UI-kataloog ei tõlgi vastuseid ega tingimata kõiki kasutajaliidese tekste.