Liigu põhisisu juurde

CLI ja seadistuse juurutamine

Avaldatud @openstaticfish/chattybox-cli@0.3.1 ja @openstaticfish/chattybox-config@0.3.1 artefaktid rakendavad seadistuse/backendi lepingut 0.3.0 ning lükkavad tundmatud võtmed tagasi nii lokaalselt kui ka backendis. Avalikus registris on ka JavaScripti SDK @openstaticfish/chattybox@0.1.4. status näitab keskkonna versiooni, samal ajal kui runtimeConfigVersionId on jagatud runtime’i viimati rakendatud seadistus ja võib erineda. Kui mode jäetakse välja, valitakse crawl ning selgesõnaline maxDepth: 0 säilib.

CLI on ESM-käsureaprogramm ja nõuab Node.js 20 või uuemat. bunx järgib vaikimisi Node’i shebang’i, seega paigalda Node või vali Bun selgesõnaliselt käsuga bunx --bun @openstaticfish/chattybox-cli .... See ei ole brauseritööriist. Avaldatud pakettide kasutaja CI kontrollib Node'i versioone 20, 22 ja 24 Linuxis, mitte kõiki operatsioonisüsteeme või brausereid. Paketiversioonid ja schemaVersion: "1" on eraldi versioonisüsteemid.

Tootmise automatiseerimises fikseerige testitud paketiversioon. Versioonita näited kasutavad juba installitud või vahemällu salvestatud paketti või registrist hangitavat paketti, mitte selle hoidla lähtekoodi.

CLI loob, valideerib, juurutab, promoveerib ja ennistab muutumatuid ChattyBoxi seadistuse versioone. Iga juurutustoken on seotud täpselt ühe olemasoleva projekti ja valitud keskkonnasiltidega; käsitlege üht seadistusfaili ning üht projektipõhist tokenit ühe hallatava ChattyBoxi projektina.

Mida seadistus haldab​

Seadistus juhib projekti nime ja kirjeldust, assistendi personat ja varuvastust, veebisaidi avastamist ja värskendamist, keelevalikut ning hostitud vidina välimust. Eelvaate või tootmise juurutamine rakendab need väärtused ja lisab olemasoleva korpuse värskendamise järjekorda. Valikulise konfiguratsiooniluku korral muudetakse neid seadeid versioonitud juurutustega, välja arvatud paketist sõltuv brändingueelistus.

Projekt tuleb esialgu üks kord juhtpaneelis luua. Avalikud vidinavõtmed ja nende valikulised päritolupiirangud, juurutustokenite elutsükkel, analüütika, vestlused, sisulüngad, kustutavad toimingud ja üles laaditud ikoonifailid ei ole seadistusväljad. Deklaratiivse kohandatud ikooni jaoks kasutage URL-i või emotikoni. Seadistus ei sisalda projekti ID-d: sihtprojekti valib salajane juurutustoken.

Avalik vidina API-võti on mõeldud vestluseks ja vidina seadistuse pärimiseks ning sobib brauserikoodi; piiranguteta loodud võti töötab eri päritoludelt, veebisaidi jaoks ettevalmistatud võti võib olla juba piiratud. Täpse päritolu piirang on valikuline lisakaitse, mitte külastaja autentimine. Ühe projekti ja valitud keskkondade seadistuse juurutamiseks, promoveerimiseks, ennistamiseks ja oleku pärimiseks mõeldud juurutustokenit tuleb hoida kohaliku keskkonna või CI saladusena, mitte brauseris.

Seadistuse loomine​

bunx @openstaticfish/chattybox-cli init

See loob faili chattybox.config.json:

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

Kasutage kohandatud teed, kui seadistus peab asuma alamkataloogis:

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

Kohalik või CI-s valideerimine​

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

Valideerimine kontrollib objektide kuju, nõutavat assistendi nime, enum’e, HTTP(S)-URL-e, täisarvulisi piire, lokaadikombinatsioone ja kuuekohalisi hex-värve. knowledge võib lokaalseks valideerimiseks või developmenti jaoks puududa, kuid olemasolul peab sellel olema täpselt üks website-allikas; preview ja production nõuavad seda. Edukas kohalik valideerimine ei juuruta, ei kontrolli tokenit, paketti ega õigusi ega taga kaugjuurutuse õnnestumist.

Kui widget on olemas, on widget.enabled kohustuslik. Valideerimine loeb ainult JSON-i, mitte TypeScripti, JSONC-d, YAML-i ega kaugskeemi; see ei tee võrgupäringuid ega lisa vaikeväärtusi. Skeem v1 lükkab tundmatud väljad tagasi kõigil objektitasemetel. include- ja exclude-kirjed peavad olema mittetühjad stringid. runtime.locale on fikseeritud keele lühikuju, mis keelab ülekirjutused; seda ei saa ühendada väljadega localeMode, defaultLocale või allowLocaleOverride: true. Kohalik ja serveripoolne valideerimine kasutavad samu reegleid, kuid paketiõigusi ja tokeni ulatust kontrollib server.

Juurutustokeni loomine​

Avage Vestlusroboti seaded → Arendaja konfiguratsioon ja leidke Konfiguratsiooni juurutustokenid. Looge token keskkondade jaoks, mida teie töövoog võib muuta. Kopeerige kohe kogu token — ChattyBox säilitab selle räsi ning piiratud identifitseerimis- ja elutsükli metaandmed, kuid ei saa kogu tokenit uuesti näidata.

Vaikimisi valib vorm ainult development-keskkonna (juhtpaneeli silt „Arendus”) ja „Ei aegu”. Kui töövoog peab muutma ka preview- või production-keskkonda, vali need selgesõnaliselt.

Juhtpaneelis saab valida aegumatusaja või 7, 30, 90 või 365 päeva; autentitud loomise API aktsepteerib täisarvu 1–365 päeva või aegumisaja väljajätmist. Projektil võib olla kuni 20 aktiivset aegumata tokenit. Vahetamiseks loo uus token, uuenda CI-d ja tühista vana token. CLI-s puuduvad sisselogimise ning tokeni loomise, loetlemise ja tühistamise käsud.

Määra token ja vidina API URL. Jaotises Paigalda → Veebisaidi paigaldamine kasuta installilõigu data-api-url väärtust, kui see on saadaval; muul juhul leia juurutuse konfiguratsioonist HTTP actionsi juurutus-URL. Installi ettevalmistamine võib nõuda, et seadistus oleks esmalt valmis:

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

Ära kunagi lisa tokenit brauserikoodi ega commiti seda hoidlasse. Hoia seda CI-teenusepakkuja krüptitud saladuste hoidlas. Juurutustoken on serveripoolne saladus, mida kasutatakse kujul Authorization: Bearer ...; vidina päritolu (origin) piirangud seda ei kaitse. Haldusmarsruudid ei kasuta vidina origin-piiranguid, ei nõua Origin-päist ega paku brauseri CORS-juurdepääsu. Token pole origin’iga seotud — igaüks, kellel see on, saab serverist API-d kutsuda. Avalikud vidinavõtmed ei asenda seda tokenit.

Puuduv, vigane, aegunud, tühistatud, vale keskkonnaga või muul põhjusel kehtetu token annab HTTP 401 INVALID_TOKEN. Token lakkab töötamast ka siis, kui projekt või omanik puudub või seda kustutatakse. Kasuta HTTP actionsi juurutuse juuraadressi või vidina URL-i lõpuga /chat, mitte .convex.cloud kliendi URL-i ega täielikku /v1/config/deployments lõpp-punkti. CLI eemaldab lõpu kaldkriipsud ja viimase /chat-i ning lisab haldusmarsruudi. HTTPS on nõutav, välja arvatud localhost, 127.0.0.1 ja [::1]; URL-is ei lubata kasutajatunnuseid, päringustringi ega fragmenti. Kontrolli sihtkohta enne saladuse kasutamist.

Enne luku sisselülitamist testi kogu tokeniga juurutamise töövoog läbi. Klõpsa jaotises Vestlusroboti seaded → Arendaja konfiguratsioon nuppu Luba konfiguratsiooni lukustus. Lukk on praeguse juhtpaneeli, CLI ja avaliku API kaudu pöördumatu — selle avamiseks pole toetatud toimingut. Luku sisselülitamine ei loo tokenit ega juuruta versiooni.

Lukk blokeerib juhtpaneeli kaudu konfiguratsiooniga hallatavate projekti- ja vidinaseadete muutmise, ikoonide üleslaadimise ning käsitsi korpuse toimingud, näiteks kraapimise, lehtede kustutamise, sisu tühjendamise ja embedding’ute taasloomise. See ei peata ajastatud töid ega takista projekti kustutamist. Tokenite loomine ja tühistamine, avalike võtmete haldamine ning tööoleku lugemine jäävad kättesaadavaks.

Bränding on erand: lukustatud projekti juhtpaneelis saab muuta ainult brändingueelistust, kui pakett seda lubab. ChattyBoxi brändingu peitmiseks on vaja vähemalt Starter-paketti, ka seadistuse juurutamisel. widget.showBranding väljajätmine säilitab salvestatud eelistuse (või vaikimisi väärtuse true); selgesõnaline väärtus kirjutab selle üle järgmisel runtime’i promotsioonil. Free-paketi runtime sunnib brändingu endiselt peale.

Seadistuse juurutamine​

Juurutamine loob muutumatu versiooni ja promoveerib selle valitud keskkonda:

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

development salvestab ainult versiooni/osuti (applied: false, indexingStatus: "not_required"). preview ja production kirjutavad üle sama projekti runtime’i seaded ning kasutavad sama korpust ja avalikke vidinavõtmeid; viimati toimunud runtime’i promotsioon võidab ka siis, kui teise sildi olek osutab vanemale versioonile. Eelvaateõigusega token võib seega muuta tootmisliiklust teenindavat projekti. Tegelikuks isoleerimiseks kasutage eraldi projekte ning nende vastavaid tokeneid ja võtmeid. Mõlemad rakendavad seadistuse aatomiliselt ja panevad kraapimistöö järjekorda (applied: true, indexingStatus: "pending"), kuid ei oota kraapimise ega embeddingute lõppu. Värskendus uuendab lehti kohapeal, lisab muutunud sisu embedding-töö järjekorda ega eemalda vanu URL-e pelgalt sellepärast, et uus allikas või filter neid välja jätab. Korpus ei ole versioonitud hetkepilt: töö nurjumisel võivad osalised muudatused alles jääda ja ebaõnnestunud värskendus ei ennista rakendatud seadistust. Töö salvestab seadistusversiooni ID, kuid loeb ka muudetavaid kraapimisseadeid; indekseerimise järjepidevuse huvides vältige kattuvaid juurutusi.

Kasutage automaatikas suvandit --json, et saada version._id, keskkonna osuti, applied, indexingStatus ja järjekorda lisatud kraapimistöö ID. Hoidke version._id hilisemaks promotsiooniks või ennistamiseks alles; kuvatav järjekorranumber ei sobi argumendiks --version.

Olek, promotsioon ja ennistamine​

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

--version kasutab JSON-väljundis olevat läbipaistmatut versiooni ID-d: deploy/promote/rollback vastuse version._id või status-vastuse activeVersion._id — mitte kuvatavat numbrit, SHA-d ega räsi. Rollback kasutab sama taustatoimingut nagu promote, ei pea valima vanemat versiooni ja kirjutab üle valitud keskkonna osuti ning promotsiooni metaandmed; append-only promotsiooniajalugu puudub. Preview või production rollback rakendab seadistuse kehtivate entitlementidega ja paneb uue värskenduse järjekorda, mitte ei taasta ajaloolist korpust.

Asendage näidetes jutumärkides kohatäited tokeni projektile kuuluvate tegelike ID-dega. Rollback ei vali eelmist versiooni automaatselt. Korduv juurutamine loob uue versiooni ka sama seadistuse korral; korduvad promotsioonid võivad lisada uusi töid.

status näitab valitud keskkonnasildi versiooni ja osutit, mitte tegelikku runtime’i seadistust, juhtpaneeli muudatuste võrdlust ega kraapimise või embeddingute edenemist. Juurutamata sildi puhul kuvatakse Environment version: none ning tagastatakse environment: null ja activeVersion: null. runtimeConfigVersionId näitab jagatud runtime’is viimati rakendatud versiooni ja võib teisest sildist erineda; development-promotsioon seda ei muuda. Lukustamata projektis võivad hilisemad juhtpaneeli muudatused runtime’i muuta ilma seda ID-d muutmata. Edukas olekupäring uuendab ka tokeni lastUsedAt väärtust ja kasutab halduspäringute limiiti. Indekseerimist kontrollige eraldi juhtpaneelis.

Täielik seadistus ja piirangud​

Juuruta täielik soovitud seadistus, mitte patch: väljajäetud konfiguratsiooniga hallatavad väljad lähtestatakse, sealhulgas varasemad juhtpaneeli seadistused. Kui kogu widget-objekt jäetakse välja, lülitatakse vidin sisse; kui objekt on olemas, järgitakse selle kohustuslikku enabled väärtust. Muud väljajäetud välimusseaded eemaldatakse, et rakenduksid runtime’i vaikeväärtused. widget.icon väljajätmine taastab vaikimisi keskmise ikooni ning runtime’i promotsioon kustutab varem üles laaditud ikoonifaili — ka siis, kui asendad selle deklaratiivse ikooniga. widget.showBranding on erand: väljajätmine säilitab praeguse eelistuse (või vaikimisi true); selgesõnaline väärtus kirjutab selle runtime’i promotsioonil üle.

Kui maxPages on määratud, säilitab muutumatu seadistusversioon soovitud väärtuse, kuid runtime’i promotsioon piirab kraapimise tööseadistuse väärtusele 100 000. Kui maxPages jäetakse välja, kasutatakse vaikimisi konto paketis sisalduvat lehtede arvu: Free 10, Starter 150, Pro 5 000, Business 25 000.

Iga käivituse efektiivne valikupiir on väiksem järgmistest: soovitud maxPages või praeguse teenusepakkuja lehemahu ja projekti olemasolevate lehtede arvu suurem väärtus. Uute lehtede lisamist piirab eraldi omaniku kontoülene lehtede limiit. Kõigi soovitud lehtede indekseerimine pole garanteeritud. Saidikaardi avastamine võib enne valimist saidikaardi dokumente alla laadida ja URL-e loetleda, seega ei ole maxPages ega saadaolev maht privaatsuse ega väljaminevate päringute piir.

Kui sitemap-režiimis pole sitemapUrl määratud, proovitakse esmalt tuvastatud sitemap’i, seejärel /sitemap.xml ja /sitemap_index.xml ning kui ükski neist URL-e ei tagasta, salvestatud veebisaidi aadressi. preview ja production kasutavad sama runtime’i; tokeni keskkonnaulatus neid ei isoleeri. Daily auto-refresh ja showBranding:false nõuavad Starter+.

Väljajäetud project.description ja assistendi viiba-, profiili- või varuvastuse seaded kustutavad salvestatud ülekirjutused. Väljajäetud runtime taastab automaatse keelevaliku, vaikekeele en ja lubatud keeleülekirjutuse. Allika režiim vaikimisi on crawl, väljajäetud filtrid kustutatakse ja automaatne värskendamine on vaikimisi välja lülitatud; režiimipõhiseid sätteid rakendatakse ainult sobivas režiimis.

Free lubab iganädalast või igakuist automaatset värskendamist. Paketiõigusi kontrollitakse preview/production-promotsioonil, sealhulgas rollback’i korral, mitte kohalikul valideerimisel ega development-versiooni salvestamisel. Varem sobinud versiooni promotsioon võib pärast paketivahetust nurjuda. Server kasutab paketi määramiseks vahemällu salvestatud projekti/tööruumi andmeid, mitte reaalajas arvelduspäringut; hiljutise paketi- või PAYG-muudatuse tõrkeotsingul kontrollige eraldi arvelduse sünkroonimist ja tegelikku kraapimismahtu.

Käsud, suvandid ja vead​

init [path] loob vajadusel ülemkataloogid ega kirjuta olemasolevat faili üle; validate [path] kontrollib JSON-i ilma kaugühenduseta. Mõlema vaikimisi tee on chattybox.config.json; kohalikud käsud lubavad ainult üht positsioonilist teed, mitte lippe ega lisaargumente. deploy nõuab --environment ja lubab --config <path>; promote ja rollback nõuavad --environment ning --version <opaque-id>; status nõuab --environment. Viimased kolm ei loe kohalikku seadistusfaili. Üldabi saab käsuga chattybox --help, mitte chattybox deploy --help; üldine --version või -v näitab CLI versiooni, mitte promotsiooni versiooni ID-d.

Kõik neli halduskäsku toetavad --token, --api-url ja --json. Selgesõnalised suvandid on keskkonnamuutujatest ülimuslikud; eelista saladusega keskkonnamuutujat tokenile käsuargumentides või shelli ajaloos. Väärtust saab anda kujul --flag value või --flag=value; --json on väärtuseta lipp. Vaikekeskkonda pole ning tundmatud, korduvad, tühjad või käsule sobimatud haldussuvandid lükatakse tagasi. CLI-l pole --dry-run, --wait, --force, --project, sõnumi ega optimistliku konkurentsikontrolli lippu. HTTP API toetab oodatava versiooni välju, kuid CLI neid ei saada; käivita sama projekti CI juurutused järjestikku.

Edukas käsk väljub koodiga 0; faili-, JSON-i, valideerimis-, argumendi-, transpordi-, vastuse lugemise ja HTTP-vead koodiga 1 ning kirjutavad stderr-i ChattyBox: ... teate. --json vormindab ainult eduka tulemuse, mitte vead. API vead sisaldavad võimaluse korral HTTP olekut ja veakoodi; edukas mitte-JSON-vastus lükatakse tagasi. CLI ei korda päringuid, ei jälgi edenemist ega määra päringu ajalõppu. Transpordivea järel kontrolli enne kordamist olekut, sest server võis juurutuse juba kinnitada.

Haldusmarsruudid on POST /v1/config/deployments (201), POST /v1/config/deployments/promote ja /rollback (200) ning GET /v1/config/deployments/status?environment=... (200). HTTP edukas vastus on kujul { "data": ... }, CLI JSON eemaldab selle ümbrise. Tavalised vead on kujul { "error": { "code": ..., "message": ... } }: 401 INVALID_TOKEN, 404 NOT_FOUND puuduva või teise projekti versiooni korral, 409 CONFIG_CONFLICT, 413 BODY_TOO_LARGE, 422 INVALID_CONFIG või 500 INTERNAL_ERROR. Vigase vormiga tüübistatud ID annab 422, mitte tingimata 404. Päringukeha piir on 262 144 baiti ja kõigi haldusmarsruutide ühine tokenipõhine piir 20 päringut minutis; 429 kasutab ühist piiranguvormingut ja päist Retry-After. Täiesti puuduva POST-keha korral tagastatakse praegu 500, vigase JSON-i korral 422.

CI/CD töövood​

Lisa CHATTYBOX_DEPLOY_TOKEN CI-pakkujas krüptitud tootmisepõhise saladusena. Lisa CHATTYBOX_API_URL saladuse või muutujana: kasuta jaotise Paigalda → Veebisaidi paigaldamine data-api-url väärtust, kui see on saadaval, või juurutuse konfiguratsioonis olevat HTTP actionsi juurutus-URL-i. Käivita valideerimine pull request'ide korral, kuid piira tootmise juurutamine kaitstud vaikeharu või heakskiidetud juurutuskeskkonnaga.

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

Kasutage keskkonnaga seotud tootmissaladust ja nõudke juurutamise kinnitamist, kui teie repositoorium seda toetab. CLI talletab tavalised CI commiti- ja harumuutujad koos muutumatu versiooniga.

GitLab CI/CD​

Salvestage mõlemad väärtused jaotises Settings → CI/CD → Variables. Kaitske juurutustokenit, maskeerige see ja siduge see keskkonnaga 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

GitLab avaldab CHATTYBOX_DEPLOY_TOKEN ja CHATTYBOX_API_URL tööle automaatselt nende muutujanimede kaudu. Kasutage kaitstud vaikeharu, et kaitstud muutujad poleks usaldamata harudele saadaval. Buni konteineri näide kasutab selgesõnaliselt --bun, et vältida sõltuvust eraldi Node'i paigaldusest; kontrollige CI-s fikseeritud Buni- ja pildiversiooni.

Bitbucket Pipelines​

Lisage mõlemad väärtused juurutusmuutujatena jaotises Repository settings → Pipelines → Deployments → Production. Märkige juurutustoken turvatuks.

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

Asendage main, kui teie vaikeharul on teine nimi. Bitbucket süstib juurutusmuutujad ainult sammudesse, mis on selle juurutuskeskkonnaga seotud. CLI-l puudub eraldi BITBUCKET_* metaandmete vastendus; see kasutab commiti ja haru jaoks kohalikku Giti, kus eraldatud checkout'is ei pruugi haru nime olla.

Seadistuse jaotised​

JaotisOtstarve
schemaVersionValib avaliku seadistuslepingu. Praegu toetatakse versiooni 1.
projectValikulised projekti metaandmed, näiteks juhtpaneeli kirjeldus.
assistantMäärab assistendi nime, sisseehitatud persona või kohandatud süsteemiviiba ning varuvastuse.
knowledge.sourcesValib avalehe, saidikaardi, käsitsi URL-id või crawl’i ning nende filtrid, piiri ja värskendusgraafiku.
runtimeJuhib automaatset või fikseeritud lokaati, vaikimisi lokaati ja lehepõhiseid lokaadi override’e.
widgetJuhib lubamist, asukohta, tekste, värve ja ikooni esitlust.

Personad​

Hallatava persona kasutamiseks määra promptProfile väärtuseks default, support, sales või sarcastic. Kohandatud persona jaoks kasuta custom ja lisa systemPrompt. Kui antakse nii sisseehitatud profiil kui ka systemPrompt, on selgesõnaline viip ülimuslik.

Teadmiste avastamine​

See näide on üks kirje loendis knowledge.sources, mitte täielik konfiguratsioon. See nõuab avaldatud CLI/config-pakette 0.3.1 ja vastavat backendi lepingut 0.3.0. Igapäevane värskendus nõuab Starter-paketti või kõrgemat; maxPages: 500 on saadaolevast mahust sõltuv taotlus, mitte indekseerimise garantii.

{
"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"
}

Laiendatud avastusseaded nõuavad avaldatud 0.3.1 konfiguratsioonitüüpe ja vastavat 0.3.0 backend-lepingut. Igapäevane ajakava nõuab vähemalt Starter-paketti; näiteks maxPages: 500 salvestab soovitud piiri, millele rakendub käivituse tegelik maht.

  • homepage: vali selleks värskenduseks ainult url; olemasolevaid lehti ei kustutata.
  • sitemap: kasuta sitemapUrl-i; selgesõnaline saidikaart, mis URL-e ei anna, lõpetab töö veaga. Väljajätmisel proovitakse tuvastatud saidikaarti, seejärel /sitemap.xml ja /sitemap_index.xml ning lõpuks salvestatud veebisaidi URL-i.
  • manual: indekseeri mittetühi manualUrls loend.
  • crawl: proovi tavapäraseid saidikaarte, seejärel järgi url-ist linke kuni maxDepth sügavuseni (vaikimisi 3).

include ja exclude võrdlevad URL-i tõstutundlikke alamstringe, mitte glob- või regex-mustreid. Iga kaasamisvaste lubab URL-i ja iga välistusvaste lükkab selle tagasi ka kaasamisvaste korral. Tühjad loendid ei filtreeri; filtrid kehtivad ka avalehe ja käsitsi valiku puhul. maxPages peab olema positiivne täisarv; salvestatud soovitud väärtust piiravad runtime’i ülempiir ja eespool kirjeldatud mahukontrollid. Saidikaardi avastamine võib URL-e loetleda enne valiku tegemist. maxDepth peab olema täisarv 0–20 ning juhib linkide järgimise varurežiimi, mitte saidikaardi loetlemist. Väljajäetud mode valib crawl’i ja säilitab selgesõnalise maxDepth väärtuse, ka nulli. autoRescrape: true nõuab väärtust rescrapeInterval: "daily", "weekly" või "monthly"; intervall üksi ajastamist ei luba. Kuu tähendab 30 päeva ja ajastatud töö võib käivituda pärast tähtaega.

Keele ja vidina valideerimine​

Toetatud lokaadid on en, de, fr, es, it, nl, pl, pt, sv, fi, et, cs, cy ja id. localeMode on auto või fixed; fikseeritud režiim nõuab defaultLocale-i. allowLocaleOverride on eraldi seadistatav. Lühikuju runtime.locale valib fikseeritud režiimi ja keelab ülekirjutused; seda ei saa kombineerida väljadega localeMode, defaultLocale või allowLocaleOverride: true.

Vidina asukohad on bottom-right, bottom-left, top-right ja top-left. Kõik kolm teemavärvi kasutavad vormingut #RRGGBB, mitte lühikest hex-värvi, värvinime ega läbipaistvust. Ikoonitüübid on default, emoji (mittetühi emoji string) ja url (HTTP(S) url); suurus võib olla small, medium või large. Valideerimine ei hangi ikooni URL-i, ei kontrolli pildi MIME-tüüpi ega nõua, et emotikonistring sisaldaks täpselt üht emotikoni. Allika ja ikooni URL-i puhul kontrollitakse süntaksit ja protokolli, mitte kättesaadavust ega kraapimise õigust. Valikuline kirjeldus, assistendi viip või varuvastus, vidina pealkiri ja tervitustekst peavad esitamisel olema mittetühjad; ülekirjutuse kustutamiseks jäta väli välja.

Tüübistatud seadistuse abifunktsioon​

Installige seadistuspakett, kui loote skeemi ümber eraldi TypeScripti tööriistu:

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

CLI ise loeb JSON-faile. defineConfig() on mõeldud tüübistatud rakendus- või koostetööriistadele; see ei muuda TypeScripti faile CLI jaoks otse laaditavaks. Nii defineConfig(config) kui ka validateConfig(config) valideerivad sünkroonselt, annavad esimese vea korral tavalise Error-i ning tagastavad sama objekti seda kloonimata, külmutamata, teisendamata või vaikeväärtusi lisamata. Pakett ekspordib TypeScripti tüübid ja need funktsioonid, mitte JSON Schema dokumenti ega $schema URL-i. Avaldatud 0.3.1 pakett toetab ka eespool kirjeldatud laiendatud väljade TypeScripti tüüpe.

Praegu toimiva tootmisintegratsiooni jaoks kasutage majutatud vidinat või looge JavaScripti SDK abil kohandatud liides.