Tilføj et REST API som et værktøj (Customer Conversation) (forhåndsvisning)

[Denne artikel er dokumentation til en foreløbig version og er med forbehold for ændringer.]

Hvis det værktøj, du har brug for, ikke er tilgængeligt som et færdigbygget, connector- eller workflow-værktøj, kan du tilføje et specialværktøj ved at importere et REST API fra en OpenAPI-specifikation.

At tilføje et REST API som et værktøj til en agent drevet af Customer Conversation-harnesset svarer til at tilføje et til en agent drevet af standardharnesset. For at lære mere, se Udvid din agent med værktøjer fra et REST API (forhåndsvisning).

Forudsætninger

  • En kopi af OpenAPI-specifikationen for det REST API, du vil forbinde til.
  • Kendskab til den type autentificering, der er nødvendig for at forbinde til API'en, samt autentificeringsdetaljerne.

Tilføj et REST API-værktøj

  1. Vælg den primære agents kort under fanen Build for at åbne konfigurationspanelet. Hvis du har tilføjet nogle underagenter, skal du i stedet vælge en underagents kort for at konfigurere den underagent.

  2. I afsnittet Værktøjer skal du vælge Tilføj værktøj.

  3. I dialogen Tilføj et værktøj skal du vælge fanen REST API (eller vælg Tilføj>REST API).

  4. I den nye REST API-dialog skal du fuldføre følgende wizard-trin:

    1. Upload af specifikation: Importer din OpenAPI (Swagger 2.0) eller OpenAPI 3.0-specifikation. Træk og slip en JSON- eller YAML-fil (op til 5 MB), eller vælg Gennemse for at vælge én.

    2. Oplysninger om API-plugin: Giv dit værktøj et navn og en beskrivelse, som agenten kan bruge til at afgøre, hvornår det skal kaldes. Gennemgå og rediger om nødvendigt følgende felter, før du fortsætter:

      • Værktøjsnavn: Udfyldes i første omgang ud fra titlen i den API-specifikation, som du uploadede.
      • Beskrivelse: Udfyldes på forhånd fra beskrivelsen i den API-specifikation, du har uploadet. Angiv en detaljeret beskrivelse, da din agentens orkestrering bruger beskrivelsen til at bestemme, hvornår det pågældende værktøj skal bruges.
      • Løsning: Vælg Power Platform-løsningen til at gemme dette værktøj i, eller lad den stå tom, så systemet automatisk kan oprette en for dig.

    3. Autentificering: Vælg, hvordan agenten autentificerer med denne API:

      • Ingen: Ingen autentificering er nødvendig for at få adgang til API'et.
      • API-nøgle: Din agent beder brugeren om at give en API-nøgle under kørsel og forbinder derefter til API'et med den nøgle. Du angiver en Etiket (navnet, der vises ved oprettelse af forbindelse), et Parameternavn (for eksempel X-API-Key) og en Placering (Sidehoved eller Forespørgsel).
      • OAuth 2.0: Brugere autentificerer sig til API'et gennem en identitetsudbyder uden at dele deres legitimationsoplysninger med agenten. Du skal angive værdier som Klient-id, Klienthemmelighed, URD-adresse til godkendelse, URL-adresse til Token og URL-adresse til opdatering.

    4. Vælg værktøjer: Under Tilgængelige værktøjer skal du vælge plus-ikonet ved siden af hvert API-understøttet værktøj (endpoint og HTTP-metodekombination, såsom get, put, post eller delete), som du vil eksponere for din agent. Brug søgefeltet til at finde en specifik operation.

    5. Konfigurér værktøj: For hvert værktøj, du vælger, konfigurer et værktøjsnavn og en beskrivelse. Beskrivelser udfyldes indledningsvis fra API-specifikationen. Angiv en detaljeret beskrivelse, da din agentens orkestrering bruger beskrivelsen til at bestemme, hvornår det pågældende værktøj skal bruges.

    6. Vælg værktøjsparametre: Gennemgå dine input- og outputværdier og opdater beskrivelser efter behov. Du kan opdatere parameterbeskrivelser, men ikke selve parameterværdierne. Hvis en beskrivelse er tom, skal du udfylde den, før du fortsætter. Gentag trinnene Vælg værktøjer til Vælg værktøjsparametre for hvert værktøj, du vil føje til fra API'et.

    7. Gennemse: Gennemse værktøjets navn, beskrivelse, godkendelsestype og antallet af valgte værktøjer før publicering.

    8. Udgiv: Vælg Udgiv for at oprette værktøjet og gøre det tilgængeligt for din agent.

Forbind værktøjet efter udgivelse

Før din agent kan bruge det publicerede værktøj, skal du oprette eller vælge en forbindelse til det, uanset hvilken autentificeringstype du har valgt, inklusive Ingen.

  1. Vælg det publicerede værktøj for at tilføje det til din agent.
  2. I dialogen Forbind tilværktøjsnavn skal du vælge Vælg en forbindelse og derefter vælge en eksisterende forbindelse eller oprette en ny:
    1. Vælg + Ny forbindelse.
    2. I dialogen Forbind tilværktøjsnavn kan du valgfrit indtaste et visningsnavn for forbindelsen. Dette navn vises i listen over forbindelser.
    3. Vælg Opret.
  3. Vælg Tilføj og konfigurer for at fuldføre tilføjelsen af værktøjet til din agent.
  • Sidst opdateret den