API jungtys

Paverskite bet kurią HTTP API funkcija, kurią jūsų agentas gali iškviesti pokalbio metu: įklijuokite cURL komandą, o vedlys sukurs įrankio apibrėžimą, parametrus ir autentifikavimą.

API jungtys yra pasirinktinės HTTP funkcijos, kurias jūsų agentai gali iškviesti pokalbio metu — rasti užsakymą, sukurti bilietą, gauti paskyros būseną iš jūsų vidinės sistemos. Galinį tašką vieną kartą nustatote skiltyje Jungtys → API (/dashboard/api-connections); agentai, kuriems priskirta jungtis, gali ją iškviesti, kai to reikia pokalbio metu.

Yra du būdai ją sukurti: įklijuoti ką nors, ką vedlys gali išanalizuoti, arba nustatyti jungtį rankiniu būdu.

Greitas būdas: įklijuokite ir analizuokite#

1. Spustelėkite Nauja API jungtis

   Dialogo langas atidaromas vedlyje. Į laukelį įklijuokite pavyzdinę cURL komandą, OpenAPI/Swagger specifikaciją, Postman eksportą, TypeScript sąsają arba Zod schemą.

2. Spustelėkite Analizuoti

   ThunderPhone pagal jūsų įklijuotą turinį nustato visą jungtį — URL, metodą, antraštes ir parametrų schemą, sudarytą pagal rastus užklausos parametrus ir užklausos turinį. Įklijuotos antraštės (įskaitant autentifikavimo antraštes) perkeliamos į galinio taško konfigūraciją.

3. Patvirtinkite paryškintus laukus

   Nustatyta konfigūracija atidaroma su peržiūrai paryškintais spėjamais laukais. Pakoreguokite pavadinimus, aprašymus ir parametrų tipus, kad agentas suprastų, kada ir kaip iškviesti funkciją — aprašymą skaito modelis.

4. Patvirtinti ir išsaugoti

   Išsaugant pirmiausia vykdoma tikra bandomoji užklausa į jūsų galinį tašką. Jei užklausa nepavyksta, jungtis neišsaugoma — pataisykite URL, autentifikavimo antraštes arba turinį ir bandykite dar kartą. Sėkmės atveju jungtis išsaugoma su žyma Patvirtinta.

Jei vedlys jūsų įklijuotame turinyje negali rasti užklausos URL, jis tai nurodys — įtraukite visą http(s) galinį tašką ir bandykite dar kartą.

Rankinis nustatymas#

Vedlyje spustelėkite Nustatyti rankiniu būdu → (arba Norite, kad tai nustatytų DI? Išbandykite vedlį →, jei norite grįžti). Rankiniame kūrimo įrankyje yra du redaktoriai:

• Vaizdinis — formos laukai rodomam pavadinimui, funkcijos pavadinimui, užklausos URL, metodui (POST, GET, PUT, PATCH, DELETE), pasirinktinėms antraštėms ir parametrų schemai (Pridėti ypatybę kiekvienam argumentui, kurį gali pateikti agentas).
• JSON — tas pats apibrėžimas neapdorotu JSON formatu, skirtas įklijuoti arba tiesiogiai tikslinti įrankio specifikaciją.

Skydelyje Bandomoji užklausa (pasirenkama) galite vykdyti sukonfigūruotą užklausą prieš išsaugodami ir peržiūrėti būseną, delsą bei atsakymo peržiūrą. Patvirtinti ir išsaugoti visada vykdo šį testą ir išsaugo tik sėkmės atveju.

Tvarkykite savo jungtis#

Kiekvienoje jungties eilutėje rodoma jos patvirtinimo būsena — Patvirtinta, Netikrinta arba Klaida — funkcijos pavadinimas ir ją naudojantys agentai. Eilutės veiksmų meniu galite:

• Redaguoti — iš naujo atidaryti konfigūraciją.
• Klonuoti — dubliuoti ją kaip pradinį tašką (kopija pradžioje būna netikrinta).
• Pakeitimų istorija — peržiūrėti ankstesnes versijas ir vieną jų atkurti redaktoriuje.
• Perkelti — nukopijuoti arba perkelti jungtį į kitą organizaciją, kuriai priklausote. Perkėlus ji čia pašalinama; ją naudojantiems agentams gali reikėti iš naujo nustatyti konfigūraciją.
• Ištrinti — negrįžtamas veiksmas; jungtį naudojančius agentus reikės iš naujo sukonfigūruoti.

Priskirkite ją agentui#

Pridėkite jungtį agentui kūrimo įrankio API jungčių skiltyje (Sukurkite agentą). Sąraše rodoma, kurie agentai naudoja kiekvieną jungtį, todėl iš karto matysite, ką paveiks pakeitimas.

Tolesni veiksmai#