API-ühendused

Muuda mis tahes HTTP API funktsiooniks, mida sinu häälagent saab vestluse ajal kutsuda: kleebi cURL-käsk ning viisard loob tööriista definitsiooni, parameetrid ja autentimise.

API-ühendused on kohandatud HTTP-funktsioonid, mida sinu agendid saavad vestluse ajal kasutada — tellimuse otsimiseks, pileti loomiseks või konto oleku toomiseks sinu enda taustsüsteemist. Määratled lõpp-punkti üks kord jaotises Ühendused → API-d (/dashboard/api-connections); agendid, millele ühendus on lisatud, saavad seda 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 „Uus API-ühendus“

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

2. Klõpsa „Analüüsi“

   ThunderPhone tuletab sinu kleebitud sisust kogu ühenduse — URL-i, meetodi, päised ja leitud päringuparameetritest ning päringu sisust tuletatud parameetriskeemi. Kleebitud päised, sealhulgas autentimispäised, lisatakse lõpp-punkti konfiguratsiooni.

3. Kinnita esiletõstetud väljad

   Tuletatud konfiguratsioon avaneb ülevaatamiseks, kus oletatud väljad on esiletõstetud. Kohanda nimesid, kirjeldusi ja parameetrite tüüpe, et agent mõistaks, millal ja kuidas funktsiooni kasutada — kirjeldus on see, mida mudel loeb.

4. Valideeri ja salvesta

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

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

Käsitsi seadistamine#

Klõpsa viisardis Seadista käsitsi → (või tagasi minemiseks 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 parameetriskeemi jaoks (Lisa atribuut iga argumendi jaoks, mille agent saab esitada).
• JSON — sama määratlus töötlemata JSON-ina tööriista spetsifikatsiooni otse kleepimiseks või täpseks kohandamiseks.

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

Halda oma ühendusi#

Iga ühenduse rida näitab selle valideerimisolekut — Valideeritud, Testimata või Tõrge — funktsiooni nime ja seda kasutavaid agente. Rea toimingute menüüst saad:

• Muuda — ava konfiguratsioon uuesti.
• Klooni — tee sellest lähtepunktina koopia (koopia algab olekuga Testimata).
• Muudatuste ajalugu — vaata varasemaid versioone ja taasta üks neist redaktorisse.
• Teisalda — kopeeri või liiguta ühendus teise organisatsiooni, kuhu kuulud. Liigutamine eemaldab selle siit; seda kasutanud agendid võivad vajada ümberseadistamist.
• Kustuta — püsiv toiming; ühendust kasutavad agendid tuleb ümber seadistada.

Lisa see agendile#

Lisa ühendus agendile koostaja jaotises API-ühendused (Loo agent). Loend näitab, millised agendid iga ühendust kasutavad, nii et näed kohe, mida muudatus mõjutab.

Järgmised sammud#