API jungtys

API jungtys – tai tinkintos HTTP funkcijos, kurias jūsų agentai gali iškviesti pokalbio metu: rasti užsakymą, sukurti užklausą, gauti paskyros būseną iš jūsų vidinės sistemos. Galinį tašką vieną kartą apibrėžiate skiltyje Jungtys → API (/dashboard/api-connections); agentai, prie kurių pridėta jungtis, gali ją iškviesti, kai to reikia pokalbio metu.

Jungtį galima sukurti dviem būdais: įklijuoti turinį, kurį vedlys gali išanalizuoti, arba nustatyti jungtį rankiniu būdu.

Greitas būdas: įklijuokite ir analizuokite

1. Spustelėkite Nauja API jungtis

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

2. Spustelėkite Analizuoti

   ThunderPhone pagal įklijuotą turinį nustato visą jungtį – URL, metodą, antraštes ir parametrų schemą, sudarytą iš rastų užklausos parametrų bei užklausos turinio. Į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 numatytais 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 atliekama tiesioginė 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 neranda užklausos URL, jis apie tai praneš – įtraukite visą http(s) galinį tašką ir bandykite dar kartą.

Nustatymas rankiniu būdu

Vedlyje spustelėkite Nustatyti rankiniu būdu → (arba Norite, kad tai nustatytų DI? Išbandykite vedlį →, kad grįžtumėte). Rankinio nustatymo įrankyje yra du redaktoriai:

• Vaizdinis – formos laukai rodomam pavadinimui, funkcijos pavadinimui, užklausos URL, metodui (POST, GET, PUT, PATCH, DELETE), tinkintoms 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 išsiųsti 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 atlieka šį testą ir išsaugo tik sėkmės atveju.

Tvarkykite jungtis

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

• Redaguoti – iš naujo atidaryti konfigūraciją.
• Klonuoti – sukurti jos kopiją kaip pradinį tašką (kopija pradedama kaip Neišbandyta).
• Pakeitimų istorija – peržiūrėti ankstesnes versijas ir atkurti vieną iš jų redaktoriuje.
• Perkelti – kopijuoti arba perkelti jungtį į kitą organizaciją, kuriai priklausote. Perkėlus ji pašalinama čia; ją naudojantiems agentams gali reikėti iš naujo nustatyti konfigūraciją.
• Ištrinti – veiksmas negrįžtamas; jungtį naudojantiems agentams reikės iš naujo nustatyti konfigūraciją.

Pridėkite ją prie agento

Pridėkite jungtį prie agento konstruktoriaus 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