Jaa

HTTP-pyyntöjen tekeminen

  • Artikkeli

Copilot Studiossa voidaan laajentaa agentin ominaisuuksia kutsumalla ulkoisia REST API -ohjelmointirajapintoja HTTP-pyyntö-solmun avulla. Tämä kutsu voi olla kätevä, kun tietoja on noudettava ulkoisesta järjestelmästä tai tietoja on käsiteltävä kyseisessä järjestelmässä.

edellytykset

HTTP-pyynnön solmun käyttäminen

  1. Valitse Lisää solmu (+), avaa Lisäasetukset-alivalikko ja valitse sitten Lähetä HTTP-pyyntö.

    Kuva Lähetä HTTP-pyyntö -asetuksesta lisäasetusvalikossa.

  2. Syötä URL-osoite-kenttään kutsuttavan ohjelmointirajapintapäätepisteen URL-osoite.

  3. Valitse soveltuva pyynnön Metodi avattavasta luettelosta. GET-, POST-, PATCH-, PUT- ja DELETE-menetelmiä tuetaan.

    Näyttökuva valmiista ohjelmointirajapinnan URL-osoitteesta ja metodin avattavasta valikosta

  4. Valitse solmun Otsikot ja teksti -kohdassa Muokkaa-painike, joka avaa HTTP-pyynnön ominaisuudet -ruutu.

  5. Voit halutessasi lisätä HTTP-pyyntöön yhden tai useamman otsikon. Lisää kunkin otsikon avain ja arvo valitsemalla Lisää-painike.

    Näyttökuva HTTP-solmun otsikoiden avain-arvo-parien luettelosta.

  6. HTTP-pyynnön tekstiosassa ei oletusarvoisesti lähetetä sisältöä, mutta voit määrittää sisällön tekstiosaan.

  7. Valitse solmussa käytettävissä olevista asetuksistaVastauksen tietotyyppi.

    JSON-esimerkkivastaus voidaan antaa, ja se on löytyy yleensä kutsuttavan ohjelmointirajapinnan ohjeista. Se luo Power Fx -muuttujan, mikä mahdollistaa sen käyttämisen muualla sisällön tuotantoalustassa, Power Fx -editorin Intellisense-tuen avulla. Valitse ensin Näytetiedoista ja sitten Hae rakenne JSON-näytteestä. Liite näytevastaus editoriin ja valitse Vahvista.

  8. Valitse Tallenna käyttäjän vastaus nimellä -kohdassa, minne haluat tallentaa HTTP-pyyntövastauksen joko luoden uuden muuttujan tai valiten olemassa olevan muuttujan.

Sisällön lähettäminen HTTP-pyynnön tekstiosaan

  1. Valitse solmun Otsikot ja teksti -kohdassa Muokkaa-painike, joka avaa HTTP-pyynnön ominaisuudet -ruutu.

  2. Valitse Teksti-kohdassa haluamasi sisältötyyppi. Teksti-määrityksenä on oletusarvoisesti Ei sisältöä, joten pyynnön tekstissä ei pitäisi olla sisältöä, ja sitä käytetään yleisimmin GET-pyynnön kanssa: Jos haluat lisätä sisältöä tekstiosaan, valitse jokin käytettävissä olevista vaihtoehdoista.

    Näyttökuva tekstisisällön asetuksien avattavasta luettelosta

    • JSON-sisältö: JSON-sisällön avulla voit lisätä JSON-objektin pyynnön tekstiosaan. Tätä objektia käytetään POST- tai PUT-pyyntöä tehtäessä. Jos tämä vaihtoehto on valittu, editori sallii oman JSON-sisällön syöttämisen.

      Lisäksi JSON-sisältöä voidaan määrittää Power Fx:n avulla, mikä mahdollistaa dynaamisten arvojen ja viitemuuttujien sisällyttämisen. Valitse ensin Muokkaa JSON-koodia -painike ja sitten Kaava. Syötä seuraavaksi Power Fx -objekti (mikä tahansa aiemmin luotu JSON, joka syötetään, muunnetaan Power Fx -objektiksi), joka muunnetaan JSON-muotoon, kun HTTP-pyyntö tehdään.

      Näyttökuva JSON-sisällöstä, joka on valittu tekstiosan sisältötyypiksi.

    • Raakasisältö: Raakasisällön avulla voit lisätä datamerkkijonon pyynnön tekstiosaan, ja tämä merkkijono voi olla mitä tahansa sisältötyyppiä. Raakasisältö syötetään Power Fx -kaavan avulla. Sisältö voi olla vaikkapa merkkijono, kuten seuraavassa esimerkissä.

      Näyttökuva RAW-sisällöstä, joka on valittu tekstiosan sisältötyypiksi.

Virheiden käsittely ja aikakatkaisu

HTTP-pyyntö-solmussa on useita vaihtoehtoja sellaisten tilanteiden käsittelemiseen, joissa HTTP-pyyntö saattaa epäonnistua tai palauttaa virheen.

Oletusarvoisesti ominaisuus aiheuttaa virheen. Tämä tarkoittaa, että kun HTTP-pyyntö palauttaa virheen tai sen suorittaminen epäonnistuu, agentti lopettaa toimintansa ja käynnistää Virheestä -järjestelmäaiheen, jolloin näkyviin tulee virhesanoma.

Voit kuitenkin määrittää virheenkäsittelyn siten, että Virheestä-järjestelmäaihetta ei käynnistetä. Se täyttää sen sijaan HTTP-tilakoodin ja virheen mahdollisen vastaustekstin määritettäviin muuttujiin, mikä mahdollistaa näiden muuttujien tutkimisen tarvittaessa ja aiheen suorittamisen jatkamisen. Tämä määritys on hyödyllinen tilanteissa, joissa haluat agentin jatkavan toimintaansa, vaikka tietty HTTP-pyyntö epäonnistuisi.

Voit määrittää virheenkäsittelyn toiminnallisuuden.

  1. Valitse solmun Otsikot ja teksti -kohdassa Muokkaa-painike, joka avaa HTTP-pyynnön ominaisuudet -ruutu.

  2. Valitse haluamasi toiminta avattavasta Virheen käsittely -valikosta.

  3. Jos valitset Jatka virheen ilmetessä, määritä Tilakoodi- ja Virhevastauksen tekstiosa -muuttujat joko luomalla uusia muuttujia tai valitsemalla aiemmin luodut muuttujat valitsimesta.

    Näyttökuva virheiden käsittelystä, jonka on määritetty jatkamaan virheen ilmetessä, ja tilakoodille ja virhevastauksen tekstille on määritetty muuttujat.

Jos HTTP-pyyntö epäonnistuu tässä koodiesimerkissä, agentti tallentaa HTTP-tilakoodin muuttujaan Topic.StatusCode ja vastauksen tekstin muuttujaan Topic.ErrorResponse. Asiakaspalvelija jatkaa aiheen seuraaviin vaiheisiin.

Virhevastauksen muuttujatyyppi on Mikä tahansa. Jäsennä arvo -solmua voidaan käyttää muuntamaan tämä muuttuja Power Fx -tietueeksi.

Ominaisuusruudussa on myös Pyynnön aikakatkaisu -ominaisuus, joka hyväksyy arvon millisekunteina. Oletusarvo on 30 sekuntia, mutta voit muuttaa arvoa tarvittaessa.