API-ühendused

API-ühendused on kohandatud HTTP-funktsioonid, mida sinu häälagendid saavad vestluse ajal kutsuda — otsida tellimust, luua pöördumise või tuua sinu taustsüsteemist konto oleku. Määratled lõpp-punkti üks kord jaotises Connections → APIs (/dashboard/api-connections); häälagendid, millele ühendus on lisatud, saavad seda seejärel kasutada alati, kui vestlus seda nõuab.

Selle loomiseks on kaks võimalust: kleebi midagi, mida viisard saab analüüsida, või seadista ühendus käsitsi.

Kiire viis: kleebi ja analüüsi

1. Klõpsa valikut „Uus API-ühendus“

   Dialoog avaneb viisardis. Kleebi väljale näidis-cURL-käsk, OpenAPI/Swaggeri spetsifikatsioon, Postmani eksport, TypeScripti liides või Zodi skeem.

2. Klõpsa valikut „Analüüsi“

   ThunderPhone tuletab sinu kleebitud sisust kogu ühenduse — URL-i, meetodi, päised ja parameetrite skeemi, mis põhineb leitud päringuparameetritel ja päringu kehal. Kleebitud päised (sh autentimispäised) kantakse üle lõpp-punkti konfiguratsiooni.

3. Kinnita esiletõstetud väljad

   Tuletatud konfiguratsioon avaneb koos ülevaatuseks esiletõstetud oletatavate väljadega. Kohanda nimesid, kirjeldusi ja parameetrite tüüpe, et häälagent mõistaks, millal ja kuidas funktsiooni kutsuda — kirjeldus on see, mida mudel loeb.

4. Valideeri ja salvesta

   Salvestamisel tehakse esmalt sinu lõpp-punkti vastu reaalajas testpäring. Kui päring ebaõnnestub, ühendust ei salvestata — paranda URL, autentimispäised või päringu keha ja proovi uuesti. Õnnestumise korral salvestatakse ühendus märgisega Valideeritud.

Kui viisard ei leia sinu kleebitud sisust päringu URL-i, annab see sellest teada — lisa täielik http(s)-lõpp-punkt ja proovi uuesti.

Käsitsi seadistamine

Klõpsa viisardis Seadista käsitsi → (või tagasiminemiseks Kas soovid, et AI selle tuletaks? Proovi viisardit →). Käsitsi koostajal on kaks redaktorit:

• Visuaalne — vormiväljad kuvatava nime, funktsiooni nime, päringu URL-i, meetodi (POST, GET, PUT, PATCH, DELETE), kohandatud päiste ja parameetrite skeemi jaoks (Lisa omadus iga argumendi jaoks, mida häälagent saab kasutada).
• JSON — sama määratlus töötlemata JSON-ina, et tööriista spetsifikatsiooni otse kleepida või täpsustada.

Paneel Testpäring (valikuline) võimaldab sul enne salvestamist konfigureeritud päringu käivitada ning kuvab oleku, latentsuse ja vastuse eelvaate. Valideeri ja salvesta käivitab selle testi alati ja salvestab ainult õnnestumise korral.

Halda oma ühendusi

Igal ühenduse real kuvatakse selle valideerimise olek — Valideeritud, Testimata või Viga — funktsiooni nimi ja seda kasutavad häälagendid. Rea toimingute menüüst saad teha järgmist:

• Muuda — ava konfiguratsioon uuesti.
• Klooni — dubleeri see lähtepunktina (koopia algab testimata olekus).
• Muudatuste ajalugu — vaata varasemaid versioone ja taasta üks neist redaktorisse.
• Teisalda — kopeeri või teisalda ühendus teise organisatsiooni, kuhu kuulud. Teisaldamine eemaldab selle siit; seda kasutanud häälagendid võivad vajada ümberseadistamist.
• Kustuta — püsiv toiming; ühendust kasutavad häälagendid tuleb ümber seadistada.

Lisa see häälagendile

Lisa ühendus häälagendile koostaja API-ühenduste jaotises (Loo häälagent). Loend näitab, millised häälagendid iga ühendust kasutavad, et näeksid ühe pilguga, mida muudatus mõjutab.

Järgmised sammud