Neidio i'r prif gynnwys

CLI a gosod ffurfweddiad

Mae'r pecynnau CLI a config cyhoeddedig @openstaticfish/chattybox-cli@0.3.1 a @openstaticfish/chattybox-config@0.3.1 yn gweithredu contract ffurfweddiad/backend 0.3.0. Mae'r dilysiad lleol a'r dilysiad backend yn defnyddio'r un rheolau ac yn gwrthod allweddi anhysbys.

Mae'r CLI yn creu, yn dilysu, yn gosod, yn hyrwyddo ac yn dychwelyd fersiynau digyfnewid o ffurfweddiad ChattyBox. Mae pob tocyn gosod wedi'i gyfyngu i un prosiect sy'n bodoli eisoes ac amgylcheddau dethol. Triniwch un ffeil ffurfweddu ac un tocyn wedi'i gyfyngu i brosiect fel un prosiect ChattyBox a reolir.

Statws rhyddhau a runtime​

Mae'r SDK JavaScript ar wahân @openstaticfish/chattybox@0.1.4 hefyd ar gael yn y gofrestrfa gyhoeddus; mae'n becyn ar wahân ac nid yw'n rhan o'r contract config. Mae fersiynau pecyn a schemaVersion: "1" yn systemau fersiynu ar wahân.

Mae'r gorchmynion sylfaenol isod yn bodoli yn y CLI cyhoeddedig. Mae'r CLI/config 0.3.1 yn rhannu'r rheolau dilysu â'r backend 0.3.0 ac yn cefnogi'r contract estynedig. Mae status yn dangos fersiwn yr amgylchedd, tra mai runtimeConfigVersionId yw'r ffurfweddiad olaf a gymhwyswyd i'r runtime a rennir a gall fod yn wahanol. Mae hepgor mode yn dewis crawl heb newid maxDepth: 0 penodol.

Mae'r CLI yn rhaglen ESM ar gyfer y llinell orchymyn sy'n gofyn am Node.js 20 neu'n ddiweddarach. Yn ddiofyn, mae bunx yn dilyn shebang Node y CLI, felly gosodwch Node neu dewiswch Bun yn benodol gyda bunx --bun @openstaticfish/chattybox-cli ....

Nid offer porwr yw hwn. Mae CI defnyddwyr y pecynnau cyhoeddedig yn profi Node 20, 22 a 24 ar Linux, nid pob system weithredu na phorwr. Piniwch fersiwn pecyn sydd wedi'i brofi ar gyfer awtomeiddio cynhyrchu; mae'r enghreifftiau heb fersiwn yn defnyddio'r pecyn sydd wedi'i osod, yn y storfa dros dro neu yn y gofrestrfa, nid ffynhonnell yr ystorfa hon.

Beth mae ffurfweddu fel cod yn ei reoli​

Mae'r ffurfweddiad yn rheoli enw a disgrifiad y prosiect, persona ac ymateb wrth gefn y cynorthwyydd, darganfod ac adnewyddu'r wefan, iaith a golwg y widget a gynhelir. Mae deployment rhagolwg neu gynhyrchu yn cymhwyso'r gwerthoedd ac yn ciwio adnewyddiad o'r cynnwys presennol. Gyda'r clo ffurfweddiad wedi'i alluogi, newidir gosodiadau sy'n eiddo i'r ffurfweddiad drwy deployments fersiwnedig, ac eithrio'r dewis brandio sy'n dibynnu ar hawl y cynllun.

Crëir y prosiect unwaith yn y dangosfwrdd. Nid yw allweddi widget cyhoeddus a'u cyfyngiadau tarddiad dewisol, cylch oes tocynnau deployment, dadansoddeg, sgyrsiau, bylchau cynnwys, gweithredoedd dinistriol na ffeiliau eicon wedi'u huwchlwytho yn feysydd ffurfweddu. Defnyddiwch URL neu emoji ar gyfer eicon datganiadol. Nid oes ID prosiect yn y ffurfweddiad: mae'r tocyn deployment cyfrinachol yn dewis y prosiect.

Mae allwedd widget gyhoeddus ar gyfer sgwrsio a ffurfweddiad widget a gellir ei defnyddio yng nghod y porwr. Gall allwedd a baratowyd ar gyfer gwefan fod wedi'i chyfyngu eisoes; mae cyfyngiadau tarddiad union yn ddewisol ac nid ydynt yn dilysu ymwelwyr. Mae tocyn deployment ar gyfer un prosiect a labeli amgylchedd dethol yn gyfrinach: cadwch ef mewn cyfrinachau lleol neu CI, nid cod porwr.

Creu ffurfweddiad​

bunx @openstaticfish/chattybox-cli init

Mae hyn yn creu chattybox.config.json:

{
"schemaVersion": "1",
"assistant": {
"name": "Support"
},
"knowledge": {
"sources": [
{
"type": "website",
"url": "https://example.com"
}
]
},
"widget": {
"enabled": true
}
}

Defnyddiwch lwybr personol pan fo'r ffurfweddiad yn perthyn mewn isgyfeiriadur:

bunx @openstaticfish/chattybox-cli init config/chattybox.config.json

Dilysu'n lleol neu mewn CI​

bunx @openstaticfish/chattybox-cli validate
bunx @openstaticfish/chattybox-cli validate config/chattybox.config.json

Mae dilysiad lleol a dilysiad backend yn defnyddio'r un rheolau ffurfweddu ac yn gwrthod allweddi anhysbys ar bob lefel wrthrych. Mae'r dilysydd yn darllen JSON yn unig, nid yw'n gwneud ceisiadau rhwydwaith, yn gwirio tocyn na hawl cynllun, nac yn cymhwyso rhagosodiadau. Gellir hepgor knowledge wrth ddilysu'n lleol neu yn development, ond os caiff ei gynnwys rhaid iddo gynnwys union un ffynhonnell gwefan; mae angen y ffynhonnell honno ar preview a production. Os darperir widget, mae widget.enabled yn ofynnol. Nid yw llwyddiant lleol yn warant gosod.

Rhaid i gofnodion include/exclude fod yn llinynnau nad ydynt yn wag. Mae runtime.locale yn llaw-fer ar gyfer iaith sefydlog gyda diystyriadau wedi'u hanalluogi; ni ellir ei gyfuno â localeMode, defaultLocale na allowLocaleOverride: true. Mae'r gweinydd yn gwirio hawliau cynllun a chwmpas y tocyn wrth osod.

Creu tocyn gosod​

Agorwch Gosodiadau'r sgwrsfot → Ffurfweddiad datblygwr a chrëwch docyn ar gyfer yr amgylcheddau y gall eich llif gwaith eu newid. Copïwch werth testun plaen llawn y docyn ar unwaith; mae ChattyBox yn storio hash a metadata adnabod a chylch oes cyfyngedig yn unig, ac ni all ddangos y gwerth llawn eto.

Yn ddiofyn, dim ond development sydd wedi'i ddewis yn y ffurflen ac nid oes dyddiad dod i ben. Dewiswch preview neu production yn benodol pan fo angen.

Mae'r dangosfwrdd yn cynnig dewis o beidio â chael dyddiad dod i ben, neu gyfnod o 7, 30, 90 neu 365 diwrnod. Mae'r API creu sy'n gofyn am ddilysiad yn derbyn cyfanrif rhwng 1 a 365 diwrnod; os hepgorir nifer y diwrnodau, nid yw'r tocyn yn dod i ben. Gall prosiect gael hyd at 20 o docynnau gweithredol sydd heb ddod i ben. I gylchdroi tocyn, crëwch docyn newydd, diweddarwch CI, ac yna dirymwch yr hen docyn. Nid oes gorchmynion CLI ar gyfer mewngofnodi, creu tocyn, rhestru tocynnau na dirymu tocyn.

Gosodwch y tocyn ac URL API y widget. O dan Gosod → Gosod ar wefan, defnyddiwch werth data-api-url y darn cod os yw ar gael; fel arall, defnyddiwch URL deployment HTTP actions o ffurfweddiad eich deployment. Efallai y bydd angen cwblhau'r camau gosod yn gyntaf:

export CHATTYBOX_DEPLOY_TOKEN='cb_cfg_v1_...'
export CHATTYBOX_API_URL='https://your-deployment.convex.site/chat'

Peidiwch byth â chyflwyno'r tocyn na'i gynnwys mewn cod porwr. Storiwch ef yn storfa gyfrinachau wedi'i hamgryptio gan eich darparwr CI. Mae tocynnau deployment yn dilysu drwy Authorization: Bearer ...; ni all allweddi cyhoeddus y widget eu disodli. Nid yw'r llwybrau rheoli'n defnyddio cyfyngiadau origin y widget, nid oes angen pennyn Origin, ac nid ydynt yn darparu CORS i borwyr. Nid yw'r tocyn wedi'i rwymo i origin: gall unrhyw un sydd ganddo alw'r API o weinydd.

Defnyddiwch wraidd URL deployment HTTP actions neu URL y widget sy'n gorffen yn /chat, nid URL cleient .convex.cloud na phwynt terfyn llawn /v1/config/deployments. Mae'r CLI yn tynnu slaesau terfynol ac unrhyw /chat olaf cyn ychwanegu'r llwybr rheoli. Mae HTTPS yn ofynnol ac eithrio localhost, 127.0.0.1 neu [::1]; gwrthodir manylion adnabod, llinynnau ymholiad a darnau yn yr URL API. Gwiriwch y gyrchfan cyn darparu cyfrinach.

Ar ôl gwirio'r llif gwaith gosod, gallwch alluogi Config-as-code lock yn yr un adran gosodiadau. Mae'r clo'n anwrthdroadwy drwy'r dangosfwrdd, y CLI a'r API cyhoeddus presennol; nid oes gweithrediad datgloi â chymorth. Nid yw ei alluogi'n creu tocyn nac yn gosod fersiwn. Profwch lif y tocyn cyn cloi.

Mae'r clo'n rhwystro ysgrifennu o'r dangosfwrdd i osodiadau prosiect/widget sy'n eiddo i config, uwchlwytho eiconau a gweithrediadau corffws â llaw, megis sgrapio, dileu tudalennau, clirio cynnwys ac ail-greu embeddings. Mae gwaith wedi'i amserlennu a dileu prosiectau yn parhau. Mae creu/dirymu tocynnau, rheoli allweddi cyhoeddus a darllen gwybodaeth weithredol yn parhau ar gael. Brandio yw'r eithriad: gellir dal i olygu'r gosodiad brandio yn y dangosfwrdd ar brosiect sydd wedi'i gloi, yn unol â hawliau'r cynllun. Mae cuddio'r priodoliad yn gofyn am Starter neu uwch; mae hepgor widget.showBranding yn cadw'r dewis presennol (neu'n defnyddio true os nad oes un), ac mae runtime y cynllun Free bob amser yn dangos brandio.

Gosod ffurfweddiad​

Mae gosod yn creu fersiwn ddigynewid ac yn ei hyrwyddo i'r amgylchedd dethol:

bunx @openstaticfish/chattybox-cli deploy --environment preview
bunx @openstaticfish/chattybox-cli deploy --environment production

Mae development yn cofnodi pwyntydd fersiwn yn unig (applied: false, indexingStatus: "not_required"). Mae preview a production yn trosysgrifo'r un gosodiadau runtime ac yn defnyddio'r un corpus ac allweddi widget cyhoeddus; y dyrchafiad runtime diweddaraf sy'n ennill, hyd yn oed os yw pwyntydd label arall yn dal i ddangos fersiwn hŷn. Felly gall tocyn sydd â chwmpas preview newid prosiect sy'n gwasanaethu traffig cynhyrchu. Defnyddiwch brosiectau, tocynnau ac allweddi ar wahân ar gyfer ynysu go iawn. Mae'r ddau amgylchedd yn cymhwyso ffurfweddiad yn atomig ac yn ciwio scrape (applied: true, indexingStatus: "pending"), ond nid ydynt yn aros am sgrapio nac embeddings. Mae adnewyddiadau'n diweddaru tudalennau yn eu lle ac nid ydynt yn dileu URLau hŷn dim ond am fod ffynhonnell neu hidlydd newydd yn eu hepgor; nid snapshot fersiwnedig yw'r corpus. Gall diweddariadau rhannol aros os bydd gwaith yn methu, ac nid yw methiant yn dadwneud y ffurfweddiad a gymhwyswyd. Mae swyddi hefyd yn darllen gosodiadau sgrapio newidiol; os yw cysondeb mynegeio'n bwysig, peidiwch â gorgyffwrdd deployments.

Gosodwch y ffurfweddiad dymunol cyflawn, nid patch. Gall gwerthoedd config-owned a hepgorir glirio neu ailosod gosodiadau blaenorol y dangosfwrdd. Os hepgorir widget, caiff y widget ei alluogi. Os darperir gwrthrych widget, dilynir ei werth enabled gofynnol; caiff gosodiadau testun, thema a safle'r widget a hepgorir eu clirio ar wahân fel bod rhagosodiadau runtime yn gymwys. Wrth hyrwyddo i'r runtime, caiff ffeil eicon a uwchlwythwyd yn flaenorol ei dileu p'un a ddarperir eicon datganiadol newydd ai peidio. Dim ond pan hepgorir widget.icon y dewisir yr eicon diofyn; ni chaiff ei ddewis ar bob dyrchafiad.

Os sitemap yw'r mode ac na ddarperir sitemapUrl, defnyddir unrhyw fap gwefan a ganfuwyd yn gyntaf. Yna ceisir /sitemap.xml a /sitemap_index.xml; os na fydd y rhain yn dychwelyd URLau, defnyddir URL y wefan sydd wedi'i gadw.

Mae'r fersiwn ffurfweddu ddigyfnewid yn cadw'r gwerth maxPages y gofynnwyd amdano, ond mae hyrwyddo runtime yn capio'r gosodiad gweithredol ar gyfer sgrapio ar 100,000. Os hepgorir maxPages, gwerth diofyn y cais yw lwfans tudalennau'r cyfrif sydd wedi'i gynnwys yn y cynllun: Free 10, Starter 150, Pro 5,000 a Business 25,000. Terfyn y dewis yw'r lleiaf rhwng y gwerth maxPages y gofynnwyd amdano a'r mwyaf o gapasiti'r darparwr neu nifer tudalennau presennol y prosiect. Mae hyn yn caniatáu adnewyddu tudalennau sydd eisoes wedi'u storio hyd yn oed os yw capasiti'r darparwr yn is. Gwneir gwiriad ar wahân bod tudalennau newydd yn ffitio o fewn lwfans tudalennau cyfrif cyfan y perchennog. Gall darganfod map gwefan nôl dogfennau map a rhestru URLau cyn eu dewis; felly nid yw'r cap capasiti yn ffin preifatrwydd nac yn ffin ar geisiadau allan. Nid yw'r gwerth yn gwarantu y caiff pob tudalen y gofynnwyd amdani ei mynegeio.

Defnyddiwch --json mewn awtomeiddio i gael canlyniad yr API, gan gynnwys version._id, pwyntydd yr amgylchedd, applied, indexingStatus ac ID y job sgrapio. Cadwch version._id o allbwn deploy/promote/rollback neu activeVersion._id o allbwn status; ni ellir defnyddio'r rhif fersiwn gweladwy fel gwerth --version.

Statws, hyrwyddo a dychwelyd​

bunx @openstaticfish/chattybox-cli status --environment production

bunx @openstaticfish/chattybox-cli promote \
--version '<config-version-id>' \
--environment production

bunx @openstaticfish/chattybox-cli rollback \
--version '<known-good-config-version-id>' \
--environment production

Mae --version yn cymryd ID fersiwn config afloyw o allbwn deploy/promote/rollback (version._id) neu allbwn status (activeVersion._id), nid y rhif gweladwy, SHA na hash. Mae rollback yn defnyddio'r un hyrwyddo, nid oes rhaid iddi dargedu fersiwn hŷn ac mae'n ciwio adnewyddiad newydd; nid yw'n adfer corpus hanesyddol na gwarantu hanes hyrwyddo append-only.

Nid yw rollback yn dewis y fersiwn flaenorol yn awtomatig. Mae'n cadw cofnodion fersiwn digyfnewid ond yn trosysgrifo pwyntydd yr amgylchedd a'i metadata hyrwyddo. Gall deployments ailadroddus greu fersiynau newydd hyd yn oed os yw'r ffurfweddiad yn union yr un fath, a gall hyrwyddiadau ailadroddus giwio swyddi newydd.

Mae status yn dangos fersiwn a chrynodeb pwyntydd y label a ddewiswyd, nid y ffurfweddiad runtime gweithredol na chynnydd sgrapio neu embeddings. Ar gyfer label heb deployment, mae'n dychwelyd environment: null ac activeVersion: null. Gall runtimeConfigVersionId fod yn wahanol ar ôl hyrwyddo label arall; gall golygiadau dashboard diweddarach newid gosodiadau runtime heb newid yr ID os nad yw'r ffurfweddiad wedi'i gloi. Gwiriwch gynnydd mynegeio ar wahân yn y dangosfwrdd.

Disodli a therfynau cynllun​

Mae refresh awtomatig dyddiol a showBranding: false yn gofyn am Starter neu uwch; gwirir hawliau ar hyrwyddo preview/production, gan gynnwys rollback, nid wrth ddilysu'n lleol na chofnodi development. Nid yw cwmpas amgylchedd tocyn yn ynysu production oddi wrth preview.

Mae Free yn caniatáu adnewyddu awtomatig wythnosol neu fisol. Gall fersiwn a oedd yn ddilys fethu hyrwyddo ar ôl newid cynllun. Mae hyrwyddo'n defnyddio data cynllun prosiect/gweithle sydd wedi'i storio ar y gweinydd, nid cais byw i'r darparwr bilio; gwiriwch gydamseriad bilio a'r lwfans sgrapio ar wahân ar ôl newid cynllun neu PAYG.

Gorchmynion, opsiynau a gwallau​

Mae init [path] yn creu ffeil a chyfeiriaduron rhiant ond nid yw'n trosysgrifo ffeil bresennol; mae validate [path] yn darllen JSON yn lleol. Mae deploy yn gofyn am --environment ac yn derbyn --config <path> yn ddewisol. Mae promote a rollback yn gofyn am --environment a --version <opaque-id>; mae status yn gofyn am --environment. Nid yw'r tri olaf yn darllen ffurfweddiad lleol. Defnyddiwch chattybox --help ar gyfer cymorth lefel uchaf; mae --version ar y lefel honno yn dangos fersiwn y CLI, nid ID hyrwyddo.

Mae pob un o'r pedwar gorchymyn rheoli yn derbyn --token, --api-url a --json; mae opsiynau penodol yn drech na'r newidynnau amgylchedd. Defnyddiwch newidynnau cyfrinachol yn hytrach na rhoi tocynnau yn hanes y gragen neu ddadleuon proses. Nid oes amgylchedd diofyn; gwrthodir opsiynau anhysbys, dyblyg, gwag neu amhriodol. Nid oes opsiynau --dry-run, --wait, --force na --project, ac nid yw'r CLI yn anfon meysydd fersiwn ddisgwyliedig yr API. Rhedwch deployments CI i'r un prosiect yn olynol.

Mae gorchmynion llwyddiannus yn gadael â chod 0; mae gwallau dilysu, dadleuon, trafnidiaeth neu HTTP yn gadael â chod 1. Mae --json yn fformatio llwyddiant yn unig, nid gwallau. Nid yw'r CLI yn ailgeisio nac yn aros yn awtomatig, ac nid yw'n gosod terfyn amser cais. Ar ôl methiant trafnidiaeth, gwiriwch y statws cyn ailgeisio: efallai fod y gweinydd eisoes wedi cofnodi'r deployment. Mae llwybrau rheoli'n rhannu terfyn o 20 cais y funud fesul tocyn; ar gyfer 429, dilynwch Retry-After.

Llifau gwaith CI/CD​

Ychwanegwch CHATTYBOX_DEPLOY_TOKEN fel cyfrinach wedi'i hamgryptio wedi'i chwmpasu i gynhyrchu yn eich darparwr CI. Ychwanegwch CHATTYBOX_API_URL fel cyfrinach neu newidyn gan ddefnyddio URL deployment HTTP actions neu URL API y widget o Gosod → Gosod ar wefan, os yw ar gael. Rhedwch ddilysiad ar pull requests, ond cyfyngwch osod cynhyrchu i'ch cangen ddiofyn warchodedig neu amgylchedd gosod a gymeradwywyd.

GitHub Actions​

name: Deploy ChattyBox configuration

on:
pull_request:
push:
branches: [main]

jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- uses: actions/setup-node@v6
with:
node-version: 24
- run: bunx @openstaticfish/chattybox-cli validate

deploy:
if: github.event_name == 'push'
needs: validate
runs-on: ubuntu-latest
environment: production
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- uses: actions/setup-node@v6
with:
node-version: 24
- name: Validate and deploy
env:
CHATTYBOX_DEPLOY_TOKEN: ${{ secrets.CHATTYBOX_DEPLOY_TOKEN }}
CHATTYBOX_API_URL: ${{ vars.CHATTYBOX_API_URL }}
run: |
bunx @openstaticfish/chattybox-cli validate
bunx @openstaticfish/chattybox-cli deploy --environment production --json

Defnyddiwch gyfrinach gynhyrchu wedi'i chwmpasu gan amgylchedd a gofynnwch am gymeradwyaeth i'r gosodiad pan fo'ch ystorfa'n ei gefnogi. Mae'r CLI yn cofnodi newidynnau cyffredin commit a changen CI gyda'r fersiwn ddigynewid.

GitLab CI/CD​

Storiwch y ddau werth o dan Settings → CI/CD → Variables. Gwarchodwch gyfrinach y gosodiad, ei chuddio, a'i chwmpasu i'r amgylchedd production.

.gitlab-ci.yml
image: oven/bun:1

validate_chattybox:
stage: test
rules:
- if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
script:
- bunx --bun @openstaticfish/chattybox-cli validate

deploy_chattybox:
stage: deploy
environment: production
rules:
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
script:
- bunx --bun @openstaticfish/chattybox-cli validate
- bunx --bun @openstaticfish/chattybox-cli deploy --environment production --json

Mae GitLab yn datgelu CHATTYBOX_DEPLOY_TOKEN a CHATTYBOX_API_URL yn awtomatig i'r swydd gan ddefnyddio eu henwau newidynnau. Defnyddiwch gangen ddiofyn warchodedig fel nad yw newidynnau gwarchodedig ar gael i ganghennau annibynadwy.

Bitbucket Pipelines​

Ychwanegwch y ddau werth fel newidynnau gosod o dan Repository settings → Pipelines → Deployments → Production. Marciwch gyfrinach y gosodiad fel un ddiogel.

bitbucket-pipelines.yml
image: oven/bun:1

pipelines:
pull-requests:
'**':
- step:
name: Validate ChattyBox configuration
script:
- bunx --bun @openstaticfish/chattybox-cli validate
branches:
main:
- step:
name: Deploy ChattyBox configuration
deployment: Production
script:
- bunx --bun @openstaticfish/chattybox-cli validate
- bunx --bun @openstaticfish/chattybox-cli deploy --environment production --json

Amnewidiwch main os oes gan eich cangen ddiofyn enw arall. Mae Bitbucket yn mewnosod newidynnau gosod i gamau sy'n gysylltiedig â'r amgylchedd gosod hwnnw yn unig.

Adrannau ffurfweddu​

AdranDiben
schemaVersionYn dewis y contract ffurfweddu cyhoeddus. Cefnogir fersiwn 1 ar hyn o bryd.
projectMetadata prosiect dewisol, megis ei ddisgrifiad yn y dangosfwrdd.
assistantYn enwi'r cynorthwyydd ac yn diffinio persona neu anogwr system personol a thestun wrth gefn.
knowledge.sourcesYn dewis darganfod drwy hafan, map safle, URLau â llaw neu gropian, ynghyd â therfynau, hidlwyr ac amserlen.
runtimeYn rheoli locale awtomatig/sefydlog, y rhagosodiad a diystyriadau ar lefel tudalen.
widgetYn rheoli galluogi, safle, testun, lliwiau ac eicon diofyn, emoji neu URL.

Personae​

Gosodwch promptProfile i default, support, sales neu sarcastic i ddefnyddio cyfarwyddiadau persona a gynhelir. Ar gyfer persona personol, defnyddiwch custom a darparwch systemPrompt. Os darperir proffil adeiledig a systemPrompt, yr anogwr penodol sy'n ennill.

Darganfod gwybodaeth​

Mae’r enghraifft hon yn un cofnod yn knowledge.sources, nid yn ffurfweddiad cyflawn. Mae angen pecynnau CLI/config cyhoeddedig 0.3.1 a’r contract backend 0.3.0 cyfatebol. Mae adnewyddu dyddiol yn gofyn am Starter neu uwch; cais sy’n ddarostyngedig i’r capasiti sydd ar gael yw maxPages: 500, nid gwarant o fynegeio.

{
"type": "website",
"url": "https://docs.example.com",
"mode": "sitemap",
"sitemapUrl": "https://docs.example.com/docs-sitemap.xml",
"include": ["/docs/"],
"exclude": ["/private/"],
"maxPages": 500,
"autoRescrape": true,
"rescrapeInterval": "daily"
}

Mae homepage yn dewis url yn unig ar gyfer yr adnewyddiad, heb ddileu tudalennau presennol. Mae sitemap yn defnyddio sitemapUrl; os yw map safle penodol yn dychwelyd dim URLau, mae'r swydd yn methu. Os hepgorir ef, ceisir map safle a ganfuwyd, yna /sitemap.xml a /sitemap_index.xml, ac yn olaf URL y wefan sydd wedi'i gadw os nad oes URLau. Mae manual yn mynegeio rhestr manualUrls nad yw'n wag. Mae crawl yn ceisio mapiau safle confensiynol cyn dilyn dolenni o url hyd at maxDepth (diofyn 3).

Mae include ac exclude yn cyfateb i is-linynnau URL sy'n sensitif i lythrennau mawr a bach, nid glob nac regex. Mae cyfatebiad exclude yn drech; nid yw rhestrau gwag yn hidlo. Mae'r hidlwyr hefyd yn berthnasol i ddetholiad hafan a llaw. Rhaid i maxPages fod yn gyfanrif positif; mae'r terfyn gweithredol a gwiriadau capasiti uchod yn dal yn berthnasol. Rhaid i maxDepth fod rhwng 0 ac 20 ac mae'n rheoli cropian dolenni wrth gefn, nid rhestru map safle. Mae autoRescrape: true yn gofyn am rescrapeInterval: "daily", "weekly" neu "monthly"; nid yw cyfwng ar ei ben ei hun yn galluogi amserlen. Mae misol yn golygu 30 diwrnod, a gall yr amserlennydd redeg ar ôl yr amser dyledus.

Dilysu locale a widget​

Y codau locale a gefnogir yw en, de, fr, es, it, nl, pl, pt, sv, fi, et, cs, cy ac id. Mae localeMode yn auto neu fixed; mae fixed yn gofyn am defaultLocale. Gellir ffurfweddu allowLocaleOverride ar wahân, yn amodol ar y cyfyngiadau runtime.locale uchod.

Mae safleoedd y widget yn bottom-right, bottom-left, top-right a top-left. Rhaid i'r tri lliw thema ddefnyddio #RRGGBB. Mae eiconau yn defnyddio default, emoji gyda llinyn emoji nad yw'n wag, neu url HTTP(S), gyda maint dewisol small, medium neu large. Mae dilysu URL yn gwirio cystrawen a phrotocol, nid hygyrchedd na chaniatâd cropian; nid yw'n nôl eiconau nac yn gwirio eu math MIME. Rhaid i ddisgrifiad dewisol, anogwr neu ymateb wrth gefn y cynorthwyydd, teitl y widget a'r neges groeso fod yn llinynnau nad ydynt yn wag pan ddarperir hwy; hepgorwch hwy i glirio diystyriadau.

Cynorthwyydd ffurfweddu wedi'i deipio​

Gosodwch y pecyn ffurfweddu wrth adeiladu offer TypeScript ar wahân o amgylch y sgema:

bun add -d @openstaticfish/chattybox-config
import { defineConfig } from '@openstaticfish/chattybox-config';

const config = defineConfig({
schemaVersion: '1',
assistant: { name: 'Support' },
knowledge: {
sources: [{ type: 'website', url: 'https://docs.example.com' }],
},
widget: { enabled: true },
});

Mae'r CLI ei hun yn darllen ffeiliau JSON. Mae defineConfig() ar gyfer offer rhaglen neu adeiladu wedi'u teipio; nid yw'n gwneud ffeiliau TypeScript yn rhai y gall y CLI eu llwytho'n uniongyrchol. Mae defineConfig(config) a validateConfig(config) yn dilysu'n gydamserol, yn taflu Error ar y methiant cyntaf ac yn dychwelyd yr un gwrthrych heb ei glonio, ei rewi, ei orfodi i fath arall na mewnosod rhagosodiadau. Nid yw'r pecyn yn allforio dogfen JSON Schema nac URL $schema.

Ar gyfer integreiddiad cynhyrchu sy'n gweithio heddiw, defnyddiwch y widget lletyol neu adeiladwch ryngwyneb personol gyda'r SDK JavaScript.