:::note Statws fersiwn
Mae'r SDK npm 0.1.4 cyhoeddedig gyda widget.js v15 yn cefnogi teardown drwy remove() neu window.ChattyBox.destroy(): mae'n tynnu UI/arddulliau ac yn canslo cychwyn, retries a chatiau sydd ar y gweill. Mae chat v15 yn gwneud hyd at 10 ymgais o fewn cyllideb amserlennu 30 eiliad, nid timeout galed fesul cais. Nid yw headless sendMessage() yn ailgeisio’n awtomatig.
:::
Addasu’r Widget Lletyol
Addaswch y rhyngwyneb parod a lwythir gan https://chattybox.ai/widget.js. Am enghreifftiau gosod fframweithiau a llwyfannau canonaidd, gweler Canllawiau Gosod.
Cyn Addasu
Crëwch y prosiect, mynegeiwch ei gynnwys, a gwiriwch atebion cynrychioliadol yn Test Chat cyn treulio amser ar gyflwyniad. Gweler Dechrau Arni am y dilyniant cyflawn.
Ffurfweddu’r Widget Lletyol
- Ewch i’ch Dangosfwrdd a dewiswch eich prosiect.
- Ewch i’r tab Embed.
- Rhagolygwch a chadwch olwg ac ymddygiad iaith y widget.
Mae’r tab Embed yn rheoli’r cyflwyniad ac yn cynhyrchu cod gosod, ond caiff allweddi cyhoeddus eu rheoli ar wahân. Pan fyddwch yn barod i osod:
- Agorwch Public Keys a chrëwch allwedd porwr.
- Dychwelwch i Embed, dewiswch yr allwedd, a chopïwch y pyt a gynhyrchwyd. Mae'r allwedd yn gweithio ar draws cynhyrchu, rhagolygon, llwyfannu a localhost yn ddiofyn.
- Agorwch Public Keys > Edit origins yn ddewisol i alluogi cyfyngiad tarddiad union fel amddiffyniad mewn dyfnder.
- Dilynwch Ganllawiau Gosod ar gyfer eich platfform.
<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>
Caiff newidiadau a gedwir yn y dangosfwrdd eu nôl ar gychwyn nesaf y widget heb ddisodli’r pyt. Nid yw tudalennau sydd eisoes ar agor yn diweddaru'n fyw: ail-lwythwch i gael y gosodiadau a gadwyd.
Addasu Gweledol
Mae golygydd y dangosfwrdd yn addasu lliwiau, lleoliad, eicon a thestun a gefnogir heb olygu cod. Gwiriwch y canlyniad yn y widget lletyol, oherwydd nid yw'r rhagolwg a'r loader yn union yr un peth.
Rheolyddion y Dangosfwrdd
-
Accent Color - Dewiswch brif liw eich brand. Mae hyn yn effeithio ar y lansiwr, prif uchafbwyntiau a negeseuon defnyddwyr.
-
Position - Dewiswch ble mae’r widget yn ymddangos ar y sgrin.
-
Header Title - Gosodwch y teitl sy’n ymddangos ar frig y ffenestr sgwrsio.
-
Welcome Message - Addaswch y neges gyntaf y mae ymwelwyr yn ei gweld pan fyddant yn agor y sgwrs.
-
ChattyBox Branding - Gall cynlluniau Starter ac uwch ddiffodd y troedyn “Powered by ChattyBox”; mae branding yn aros ymlaen ar Free.
Cadwch y newidiadau, yna ail-lwythwch y dudalen sydd wedi'i gosod i'w gwirio. Mock yw rhagolwg y dangosfwrdd, nid y widget lletyol ei hun.
Dewisiadau Uwch
Gosodiadau’r Dangosfwrdd yn erbyn Priodoleddau Sgript
Dylid rheoli’r rhan fwyaf o ymddygiad y widget o’r dangosfwrdd fel nad oes angen ail-ddefnyddio eich gwefan ar gyfer newidiadau syml.
Defnyddiwch y dangosfwrdd ar gyfer lliwiau, safle, eicon, teitl pennyn, neges groeso, ieithoedd diofyn, rheoli allweddi cyhoeddus, sgrapio a dadansoddeg.
Mae cyfyngiadau tarddiad allwedd gyhoeddus yn ddewisol, yn amddiffyniad mewn dyfnder ac nid yn ddilysiad. Os cânt eu galluogi, cadwch yr union darddiadau yn gyson â'r parthau lle mae'r widget wedi'i osod.
Defnyddiwch briodoleddau sgript dim ond ar gyfer gwerthoedd sydd eu hangen ar y widget wrth lwytho’r dudalen:
- Mae
data-api-keyyn nodi allwedd widget gyhoeddus. - Mae
data-api-urlyn dweud wrth y widget ble i anfon ceisiadau. Wrth gynhyrchu, URL sefydloghttps://...convex.site/chato’ch dangosfwrdd yw hwn. - Mae
data-localeyn gofyn am iaith UI wrth gychwyn dim ond os caniateir diystyru'r sgript gan y prosiect.
Os nad yw’r widget yn ymddangos ar ôl ei osod, gweler Datrys Problemau.
Mae'r widget yn anfon cyd-destun y dudalen HTTP(S) gyfredol heb query/fragment ar gyfer Popular Triggers. Nid yw CSS display:none yn atal cychwyn na cheisiadau; i beidio â'i lwytho, eithriwch y sgript. Mae window.ChattyBox.destroy() yn darparu teardown llawn y widget lletyol, ac mae SDK cyhoeddedig 0.1.4 yn darparu remove() ar gyfer yr un teardown.
Am enghreifftiau penodol i blatfform, dechreuwch gyda Docusaurus, MkDocs, VitePress, WordPress, neu GitBook.
Cuddio’r Widget ar Dudalenau Penodol
I guddio'r widget yn weledol ar dudalennau dethol, defnyddiwch CSS ar y tudalennau hynny'n unig:
.chattybox-widget {
display: none;
}
Nid yw CSS yn atal cychwyn, ceisiadau API na reportio gwallau ac nid yw'n reolaeth caniatâd na phreifatrwydd. I atal llwytho, eithriwch y sgript ar y ceisiadau tudalen hynny. Ar gyfer teardown llawn ar draws llwybrau ochr-cleient, defnyddiwch UI personol.
Integreiddiadau Personol
Angen gosodiad mwy pwrpasol na’r widget lletyol? Adeiladwch eich rhyngwyneb eich hun gyda’r SDK JavaScript, neu cysylltwch â support@chattybox.ai am help pensaernïol.
Cymorth Amlieithog
Mae widget ChattyBox yn datrys locale UI wrth gychwyn yn ôl modd Fixed neu Auto y prosiect. Nid yw'n gwylio priodoleddau locale na llywio ochr-cleient am newidiadau.
Ieithoedd a Gefnogir yn Swyddogol
Mae gan y widget gatalogau cyfieithu ar gyfer 14 iaith. Nid yw catalog yn golygu bod pob llinyn gweladwy neu hygyrch wedi’i gyfieithu, ac nid yw’n gwarantu ansawdd atebion.
| Iaith | Cod |
|---|---|
| Saesneg | en |
| Ffrangeg | fr |
| Almaeneg | de |
| Sbaeneg | es |
| Eidaleg | it |
| Iseldireg | nl |
| Portiwgaleg | pt |
| Pwyleg | pl |
| Swedeg | sv |
| Indoneseg | id |
| Estoneg | et |
| Ffinneg | fi |
| Cymraeg | cy |
| Tsieceg | cs |
:::note Iaith UI ac atebion Nid paramedr iaith sgwrs na gwarant ansawdd atebion yw locale UI. Mae ansawdd yn dibynnu ar y cwestiwn, y model a'r cynnwys sydd wedi'i fynegeio. :::
Sut Mae Canfod Iaith yn Gweithio
Mae’r widget yn defnyddio system ganfod rhaeadrol:
- Mae
data-localenad yw'n wag yn ennill dim ond pan fo Allow Script Override wedi'i alluogi. - Yn modd Fixed defnyddir
defaultLocale. - Yn Auto:
<html lang>, yna iaith y porwr, yna'r iaith ddiofyn. - Mae gwerth heb ei gefnogi'n mynd yn syth i Saesneg; caiff gwerthoedd rhanbarthol a gefnogir eu gostwng i'r cod sylfaenol.
Diystyru Iaith â Llaw
I ofyn i’r widget ddangos mewn iaith benodol waeth beth fo gosodiadau’r porwr, galluogwch Allow Script Override ac ychwanegwch y briodoledd data-locale cyn i'r loader redeg:
<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 Achos Defnydd
Mae hyn yn arbennig o ddefnyddiol os oes gan wefan amlieithog URL ei hun ar gyfer pob fersiwn iaith (e.e. /de/, /fr/). Gosodwch data-locale i gyd-fynd ag iaith pob tudalen a gwiriwch y rhyngwyneb a rendrwyd.
:::
Gosodiadau Iaith y Dangosfwrdd
Mae dangosfwrdd yr ap yn gadael i chi ffurfweddu dewisiadau iaith y widget fesul prosiect:
- Auto-detect - Yn defnyddio iaith y dudalen cyn iaith porwr yr ymwelydd
- Fixed Language - Yn defnyddio iaith ddiofyn y prosiect oni bai fod
data-localea ganiateir yn ei disodli - Allow Script Override - Yn galluogi/analluogi diystyru’r briodoledd
data-locale
Gwelwch y gosodiadau hyn yn eich Dangosfwrdd → Prosiect → tab Embed → adran Widget Language.
Cyfateb Iaith y Cynnwys
I gael profiad amlieithog defnyddiol, mynegeiwch gynnwys cyhoeddus yn ieithoedd eich ymwelwyr a phrofwch y dyfyniadau; nid yw canfod nac adalw yn warantedig.
- Sgrapiwch bob fersiwn iaith o’ch dogfennaeth gan ddefnyddio’r ffeil
sitemap.xml - Mae’r scraper yn ceisio canfod iaith y dudalen; archwiliwch y cynnwys a'r dyfyniadau
- Mae adalw'n ceisio ffafrio iaith y cwestiwn ond gall ddisgyn yn ôl i gynnwys arall wedi'i fynegeio
Gosod yn Nangosfwrdd yr Ap: Wrth ffurfweddu sgrapio, defnyddiwch URL eich sitemap.xml (e.e. https://yourdocs.com/sitemap.xml) i ddarganfod fersiynau iaith, yna gwiriwch y tudalennau a fynegeiwyd. Nid yw mapiau safle yn osgoi terfynau cropian nac eithriadau.
Datrys Problemau
Mae’r Widget yn Dal i Ddangos Saesneg
- Adnewyddiad caled fel diagnosis - Ail-lwythwch gyda Ctrl+F5 neu Cmd+Shift+R, yna gwiriwch banel rhwydwaith y porwr am geisiadau widget a chyfieithiadau
- Gwiriwch
data-locale- Gwiriwch fod y briodoledd wedi’i gosod yn gywir gyda chod iaith a gefnogir - Gwiriwch fodd y prosiect a chaniatâd diystyru - Gall Fixed neu ddiystyru anabl anwybyddu iaith porwr neu
data-localeyn fwriadol - Gwiriwch iaith y porwr - Gwiriwch fod dewis iaith eich porwr wedi’i osod yn gywir
- Gwiriwch HTML lang y dudalen - Sicrhewch fod gan eich tudalen
<html lang="de">(neu’r cod priodol)
Mae Ffynonellau yn yr Iaith Anghywir
- Ail-sgrapiwch eich cynnwys - Gwiriwch fod y fersiynau iaith a ddymunir wedi’u mynegeio
- Defnyddiwch sitemap.xml - Gwiriwch fod URLau dymunol wedi’u mynegeio mewn gwirionedd; gall terfynau cropian ac eithriadau eu hepgor
- Gwiriwch iaith yr ymholiad - Mae’r AI yn ceisio paru iaith yr ateb ag iaith yr ymholiad
Cyfieithiadau ar Goll
- Gwiriwch ieithoedd a gefnogir - Dim ond y 14 cod a restrir uchod sydd â chatalogau; gall labeli coll ddefnyddio fallback Saesneg
Arferion Gorau
- Gosodwch
<html lang>ar eich tudalennau - Mae hyn yn helpu hygyrchedd a chanfod iaith y widget - Profwch gyda
data-localewrth ddatblygu - Galluogwch ddiystyru sgript a gwiriwch fod pob iaith yn rendro’n gywir - Sgrapiwch bob fersiwn iaith - Defnyddiwch
sitemap.xmli ddarganfod fersiynau a gwiriwch y tudalennau a fynegeiwyd - Adolygwch gwestiynau go iawn - Archwiliwch sgyrsiau am fylchau cynnwys sy'n benodol i iaith; nid yw'r dangosfwrdd yn adrodd dosbarthiad locale widget ar hyn o bryd