Agent-SDK (förhandsversion)
Vidarebefordrar Bot Framework/Microsoft Agents SDK-aktivitetsnyttolaster till en agentslutpunkt som tillhandahålls av användaren. Agentens slutpunkts-URL anges per anrop som en indataparameter. Autentisering väljs när anslutningen skapas: ingen autentisering, en statisk API-nyckel eller Microsoft Entra ID OAuth (client_credentials). När OAuth har valts måste målgruppen för ägartoken (resurs-URL som konfigurerats för anslutningen) matcha målgruppen som förväntas av målagenten.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Standard | Alla Logic Apps-regioner utom följande: – Azure Government-regioner - Azure kinaregioner - US Department of Defense (DoD) |
| Power Apps | Standard | Alla Power Apps regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Standard | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Microsoft |
| URL | https://support.microsoft.com |
| Metadata för anslutningsprogram | |
|---|---|
| Publisher | Microsoft |
| Webbplats | https://www.microsoft.com |
| Sekretesspolicy | https://privacy.microsoft.com/ |
| Kategorier | Produktivitet |
Agent-SDK-anslutningsappen vidarebefordrar Bot Framework/Microsoft Agents SDK-aktivitetsnyttolaster till en agentslutpunkt som tillhandahålls av användaren. Agentens slutpunkts-URL anges per anrop som en indataparameter. OAuth-token präglas av plattformen från de användartilldelade Microsoft Entra ID programautentiseringsuppgifter som konfigurerats på anslutningen och matas in som en ägartoken för varje utgående begäran. Målgruppen för ägartoken (resurs-URL som konfigurerats för anslutningen) måste matcha målgruppen som förväntas av målagenten.
Förutsättningar
- En distribuerad Microsoft Agents SDK/Bot Framework-agent som kan nås via HTTPS.
- Ett Microsoft Entra ID program som är registrerat i klientorganisationen som är värd för agenten, konfigurerat med beviljandet och behörigheten
client_credentialsatt anropa målagenten. - Agentens förväntade tokenmålgrupp (vanligtvis agentens Microsoft app-ID, till exempel
api://<appId>).
Hämta dina autentiseringsuppgifter
Om du vill autentisera dina API-begäranden behöver du:
- Klientorganisations-ID för Microsoft Entra ID-programmet.
- Klient-ID (program-ID) för Microsoft Entra ID-programmet.
- Klienthemligheten för det programmet.
- Resurs-URL:en som matchar målgruppen som förväntas av målagenten (autentiseringsmönstret för Bot Framework-kunskap).
Ange dessa värden när du skapar en anslutning. Skapa en anslutning per agent om målgrupperna skiljer sig åt.
Kända problem och begränsningar
- Indata
agentEndpointmåste vara en fullständig HTTPS-URL (till exempelhttps://my-agent.azurewebsites.net). Anslutningsappen lägger till/api/messagesoch vidarebefordrar aktivitetsnyttolasten. - Anslutningsappen vidarebefordrar aktivitetsnyttolasten as-is och anger
deliveryModeinte . Agenten svarar asynkront (normal leverans) genom att posting svarsaktiviteter tillbaka till denserviceUrlangivna på den inkommande aktiviteten (anroparen, t.ex. Microsoft Copilot Studio, tillhandahåller en SAS-nyckelad motringningserviceUrl). - Den här anslutningsappen är i förhandsversion. Tillgänglighet och funktioner kan komma att ändras.
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| API-nyckel | Autentisera med en statisk API-nyckel som målagenten förväntar sig i ett anpassat HTTP-huvud. Ange både rubriknamnet (till exempel x-api-key) och dess värde. | Alla regioner | Går inte att dela |
| Microsoft Entra ID (klientautentiseringsuppgifter) | Mint OAuth-ägartoken från ett Microsoft Entra ID program med hjälp av client_credentials flödet. Målgruppen för ägartoken (resurs-URL) måste matcha målgruppen som förväntas av målagenten. | Alla regioner | Går inte att dela |
| Ingen autentisering | Anropa målagentens slutpunkt utan något autentiseringshuvud. Använd endast detta med agenter som uttryckligen accepterar anonyma samtal. | Alla regioner | Shareable |
| Standard [INAKTUELL] | Det här alternativet är endast för äldre anslutningar utan en explicit autentiseringstyp och tillhandahålls endast för bakåtkompatibilitet. | Alla regioner | Går inte att dela |
API-nyckel
Autentiserings-ID: apiKey
Tillämpligt: Alla regioner
Autentisera med en statisk API-nyckel som målagenten förväntar sig i ett anpassat HTTP-huvud. Ange både rubriknamnet (till exempel x-api-key) och dess värde.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Name | Type | Description | Obligatoriskt |
|---|---|---|---|
| Namn på API-nyckelhuvud | string | Namnet på HTTP-huvudet där målagenten förväntar sig API-nyckeln (till exempel x-api-key eller Ocp-Apim-Subscription-Key). | True |
| API-nyckelvärde | securestring | Statiskt API-nyckelvärde som skickas på varje begäran till målagentens slutpunkt. | True |
Microsoft Entra ID (klientautentiseringsuppgifter)
Autentiserings-ID: oauthClientCredentials
Tillämpligt: Alla regioner
Mint OAuth-ägartoken från ett Microsoft Entra ID program med hjälp av client_credentials flödet. Målgruppen för ägartoken (resurs-URL) måste matcha målgruppen som förväntas av målagenten.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Name | Type | Description | Obligatoriskt |
|---|---|---|---|
| Hyresgäst | string | Klientorganisations-ID:t för Microsoft Entra ID-programmet | True |
| Kund-ID | string | Klient-ID (eller program) för Microsoft Entra ID-programmet. | True |
| Klienthemlighet | securestring | Klienthemlighet för Microsoft Entra ID-programmet. | True |
| Resurs-URL | string | Målgrupp för OAuth-token. Vanligtvis målagentens Microsoft app-ID (till exempel api://< appId> eller app-ID-GUID). | True |
Ingen autentisering
Autentiserings-ID: anonymt
Tillämpligt: Alla regioner
Anropa målagentens slutpunkt utan något autentiseringshuvud. Använd endast detta med agenter som uttryckligen accepterar anonyma samtal.
Det här är en delningsbar anslutning. Om power-appen delas med en annan användare delas även anslutningen. Mer information finns i Översikt över anslutningsappar för arbetsyteappar – Power Apps | Microsoft Docs
Standard [INAKTUELL]
Tillämpligt: Alla regioner
Det här alternativet är endast för äldre anslutningar utan en explicit autentiseringstyp och tillhandahålls endast för bakåtkompatibilitet.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
Åtgärder
| Skicka aktivitet till agent |
Vidarebefordrar en aktivitetsprotokollnyttolast till agentslutpunkten på {agentEndpoint}/api/messages. När anslutningen använder Microsoft Entra ID OAuth måste token-målgruppen (resurs-URL:en på anslutningen) vara lika med målgruppen som förväntas av målagenten (autentiseringsmönstret för Bot Framework-kompetens); skapa en anslutning per agent om målgrupperna skiljer sig åt. Anslutningsappen vidarebefordrar aktivitetsnyttolasten as-is och anger inte "deliveryMode". agenten svarar asynkront (normal leverans) genom att POSTing-svarsaktiviteter till "serviceUrl" som tillhandahålls på den inkommande aktiviteten. |
Skicka aktivitet till agent
Vidarebefordrar en aktivitetsprotokollnyttolast till agentslutpunkten på {agentEndpoint}/api/messages. När anslutningen använder Microsoft Entra ID OAuth måste token-målgruppen (resurs-URL:en på anslutningen) vara lika med målgruppen som förväntas av målagenten (autentiseringsmönstret för Bot Framework-kompetens); skapa en anslutning per agent om målgrupperna skiljer sig åt. Anslutningsappen vidarebefordrar aktivitetsnyttolasten as-is och anger inte "deliveryMode". agenten svarar asynkront (normal leverans) genom att POSTing-svarsaktiviteter till "serviceUrl" som tillhandahålls på den inkommande aktiviteten.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Url för agentslutpunkt
|
agentEndpoint | True | string |
Bas-URL för mål-Microsoft Agents SDK/Bot Framework-slutpunkten (till exempel https://my-agent.azurewebsites.net). Anslutningsappen lägger till /api/messages. |
|
|
object |
Returer
- response
- object
Definitioner
object
Detta är typen 'objekt'.