Tehisintellekti vestlusrobot tehnilise dokumentatsiooni meeskondadele, kes vajavad allikaviitetega vastuseid ja vähem tugipileteid. ChattyBox vastab küsimustele nagu „Kuidas autentida API-päringuid?“ otse teie dokumentidest ja lingib kasutatud lehe — kohandatud RAG-ta ja migreerimiseta.
Üldotstarbelised tehisintellekti vestlusrobotid püüavad olla jutukad. Ilma allikapõhita saavad nad vastata enesekindlalt valest kontekstist.
Kasutame retrieval-augmented generationit teie avaldatud dokumentatsiooni ja saidisisu põhjal ning näitame seejärel allikalinke, kust vastused pärinesid.
Tiimidele, kes vajavad igas vastuses nähtavat tõendit, võrdle töövoogu allikaviidetega AI-vestlusboti jaoks, mis hoiab dokumentatsiooniliikluse seotud toetavate lehtedega.
Dokumentatsioonivestlusbot teenib usalduse, vastates korduvatele küsimustele, mida teie tugi- ja kogukonnakanalid juba näevad – ja tsiteerides kasutatud lehte. Need on näited, mida ChattyBox käsitleb indekseeritud dokumentide sisust.
Koostage testikogum tegelike dokumentatsiooniülesannete põhjal, lisage igale vastatavale küsimusele etalonallikas ja oodatavad faktid ning kaasake küsimused, millele assistent peab vastamisest keelduma. Hinnake iga kategooriat eraldi, et tugev API tulemus ei varjaks nõrku migratsiooni- või autentimisjuhiseid.
Käivitage testikogum uuesti enne avaldamist, pärast olulisi dokumentatsiooni- või otsingumuudatusi ning pärast avaldamist igakuise ajakava alusel valimiga.
| Küsimuse valdkond | Testjuhtum | Läbimise tingimus |
|---|---|---|
| API | Lõpp-punkt, kohustuslikud väljad, vastuse struktuur ja päringulimiit. | Kasutab dokumenteeritud meetodit ja teed; nõutud väärtused ning viide vastavad etalonile. |
| SDK | Installige ja lähtestage üks toetatud SDK versioon. | Pakett, import, lähtestamine ja koodi süntaks vastavad sellele keelele ning versioonile. |
| CLI | Installige, autentige, käivitage käsk ja tõlgendage väljundit. | Lipud ja järjekord on kehtivad; vastus ei mõtle välja interaktiivseid viipasid. |
| Autentimine | Identimisteabe asukoht, päisevorming, õiguste ulatused ja üks keelatud voog. | Ei avalda kunagi saladust, eristab kliendi- ja serveripoolset kasutust ning viitab turvanõudele. |
| Lehekülgjaotus | Esimene leht, jätkamine, viimane leht ja lehe maksimaalne suurus. | Kasutab dokumenteeritud kursori- või nihkemudelit ja nimetab ainult dokumenteeritud piiranguid. |
| Vead | Teadaolev veakood, tõenäoline põhjus, taastamistoiming ja tundmatu kood. | Seostab teadaolevad vead õigesti ja kasutab dokumenteerimata põhjuste korral varuvastust. |
| Migratsioonid | Ühilduvust rikkuv muudatus, eeltingimus, järjestatud toimingud ja tagasipööramise märkus. | Säilitab järjestuse ja hoiatused, segamata vanu ning uusi toiminguid. |
| Versioonitud dokumentatsioon | Esitage sama käitumist puudutav küsimus praeguse, eelmise ja määramata versiooni kohta. | Vastab nimetatud versiooni kohta, küsib ebaselguse korral täpsustust ja viitab sellele versioonile. |
Avaldage reeglid enne testimist. Ülevaatajad peaksid jõudma vastuse, oodatavate faktide ja viidatud allika põhjal samale tulemusele, sõltumata sellest, kui veenvalt vastus kõlab.
| Mõõde | Võtke vastu ainult siis, kui |
|---|---|
| Vastuse kvaliteet | Kõik nõutud faktid on õiged, asjakohased, vastuoludeta ja kasutavad soovitud API, SDK, CLI või dokumentatsiooni versiooni. |
| Viidete täpsus | Igal olulisel väitel on toimiv viide, mis toetab seda otseselt õigel versioonitud lehel. |
| Varuvastuse käitumine | Puuduvad, ebaselged, vastuolulised või loata tõendid annavad oletuse asemel selge piirangu ja kasuliku järgmise sammu. |
| Avaldamise lävend | Mitte ühtegi toetamata kriitilist autentimis- või migratsiooniväidet, kriitiliste juhtumite läbimine 100%, üldine vastuvõtt vähemalt 90% ja viidete täpsus vähemalt 95%. |
Meetod: kirjutage enne assistendi käivitamist 24 küsimust, kolm iga maatriksi valdkonna kohta. Märkige iga küsimuse jaoks soovitud versioon, etalonleht, nõutud faktid, keelatud väited ja see, kas oodatakse varuvastust. Kaks ülevaatajat hindavad fikseeritud vastuseid sõltumatult, lahendavad erimeelsused allika põhjal ning säilitavad viibad ja väljundid regressioonitestimiseks.
Alltoodud arvud on selle 24 küsimusega testkogumi näitlik läbitöötatud tulemus, mitte ChattyBoxi mõõdetud tootmiskeskkonna keskmine ega tulevase jõudluse lubadus.
| Täheldatud tulemus | Tõlgendus |
|---|---|
| 24-st võeti vastu 22 (91,7%) | Sisaldab 20 toetatud vastust ja kaht õiget varuvastust. |
| 22-st sisulisest vastusest 20 viitas otse väidet toetavatele lehtedele (90,9%) | Alla 95% avaldamislävendi; versioonide järjestus vajab parandamist. |
| Mõlemad oodatud varuvastused olid õiged (100%) | Selles väikeses testkogumis ei kasutatud ühegi vastatava juhtumi korral ekslikult varuvastust. |
| Üks vastus 24-st sisaldas toetamata lehekülgjaotuse üksikasja (4,2%) | Avaldamine jääb blokeerituks, kuni toetamata väide eemaldatakse ja regressioonitest läbitakse. |
Eesmärgipärased töövood, mis hoiavad vastused täpsed, jälgitavad ja kasulikud tehnilistele kasutajatele.
Sisestage oma dokumentatsiooni, veebisaidi või saidiplaani URL. ChattyBox roomab ja indekseerib lehed, mida kasutajad juba loevad.
Vastusevoog on seadistatud kasutama leitud konteksti ning vältima toetamata väiteid API-de, funktsioonide, hindade või poliitikate kohta.
Vastused võivad sisaldada linke dokumentatsioonilehtedele, kus asjakohane teave asub.
Käsitlege avaldamist dokumentatsiooni väljalaskena, millel on vastutajad, lävendid, jälgitavus ja tagasipööramise tee.
Jaotage iga mõõdik teema, dokumentatsiooni versiooni, lokaadi ja sihtrühma järgi, kui valimi suurus seda võimaldab. Suundumused ja ülevaadatud valimid on kasulikumad kui üks koondhinne.
| Mõõdik | Määratlus ja tegevus |
|---|---|
| Vastamismäär | Sisulise vastuse saanud küsimuste osakaal. Kontrollige madala määraga teemade puhul puuduvat sisu; ärge parandage näitajat varuvastuse nõrgendamisega. |
| Lahendamata küsimused | Varuvastuse, negatiivse tagasiside, korduva ümbersõnastamise või eskaleerimisega küsimused. Kontrollige neist igal nädalal valimit vastuse- ja otsinguvigade leidmiseks. |
| Sisulüngad | Lahendamata rühmad, mille kohta puudub usaldusväärne leht. Suunake need koos sageduse ja kasutajamõjuga dokumentatsiooni tööjärjekorda. |
| Viidetoe määr | Kontrollitud olulised väited, millel on otsene toetav viide. Uurige langusi allika ja versiooni kaupa. |
| Tugipiletite vältimine | Sobivad seansid, mis lahenevad tugipiletita, mõõdetuna kindlaksmääratud ajavahemikus ja võrrelduna lähtetasemega. Kui katse ei tõesta põhjuslikkust, esitage seos. |
Kasutage RAG arhitektuuri- ja hindamisjuhendit otsingu diagnoosimiseks, viitamise töövoogu tõendite ülevaatamiseks, arendajadokumentatsiooni juhendit inseneritöö erikasutusjuhtudeks ning tehnilist avaldamise kontrollnimekirja juurutusetappide jaoks.
Need vastused võtavad kokku, kuidas ChattyBox loeb lähtesisu, tsiteerib dokumentatsiooni lehti, käsitleb puuduvat teavet ja installib olemasoleva dokumentide virna kõrvale.
ChattyBox roomab teie avaldatud dokumentides, veebisaidil, saidiplaanis, CMS-i või abikeskuse lehtedel, eraldab loetava teksti ja hangib asjakohased lõigud, kui külastaja esitab küsimuse.
Jah. Kui lähtematerjal on saadaval, saab ChattyBox näidata linke vastuseks kasutatud dokumentatsioonilehtedele, et kasutajad saaksid üksikasju kontrollida ja lugemist jätkata.
Assistent on loodud selleks, et vältida toetamata väiteid ja see võib tagasi pöörduda, kui indekseeritud sisu ei sisalda vastust. Need lüngad võivad teavitada tulevasi dokumentatsiooni värskendusi.
Ei. Saate säilitada oma praeguse dokumentide virna ja manustada vidina ChattyBox pärast roomamist ja allikale viidatud vastuste testimist.
Kasutage ChattyBoxi, et vastata allikasisust korduvatele dokumentatsiooniküsimustele ja suunata puuduvad teemad tagasi dokumentide tööjärjekorda.
