Zestaw SDK agenta (wersja zapoznawcza)

Przekazuje ładunki działania bot framework/Microsoft Agentów SDK do punktu końcowego agenta dostarczonego przez użytkownika. Adres URL punktu końcowego agenta jest dostarczany na wywołanie jako parametr wejściowy. Uwierzytelnianie jest wybierane podczas tworzenia połączenia: brak uwierzytelniania, statyczny klucz interfejsu API lub Microsoft Entra ID OAuth (client_credentials). Po wybraniu protokołu OAuth odbiorcy tokenu elementu nośnego (adres URL zasobu skonfigurowany w połączeniu) muszą być zgodni z odbiorcami oczekiwaną przez agenta docelowego.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Standard Wszystkie regiony Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Standard Wszystkie regiony Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów Standard Wszystkie regiony Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt biznesowy
Name Microsoft
adres URL https://support.microsoft.com
Metadane łącznika
Publisher Microsoft
Witryna internetowa https://www.microsoft.com
Zasady ochrony prywatności https://privacy.microsoft.com/
Kategorie Produktywność

Łącznik zestawu SDK agenta przekazuje ładunek działania bot framework/Microsoft agentów do punktu końcowego agenta dostarczonego przez użytkownika. Adres URL punktu końcowego agenta jest dostarczany na wywołanie jako parametr wejściowy; Tokeny OAuth są wybite przez platformę z dostarczonych przez użytkownika poświadczeń aplikacji Microsoft Entra ID skonfigurowanych na połączeniu i wstrzykiwane jako token elementu nośnego na każdym żądaniu wychodzącym. Odbiorcy tokenu elementu nośnego (adres URL zasobu skonfigurowany w połączeniu) muszą być zgodni z odbiorcami oczekiwaną przez agenta docelowego.

Wymagania wstępne

  • Wdrożony zestaw SDK agentów Microsoft/agent platformy Bot Framework osiągalny za pośrednictwem protokołu HTTPS.
  • Aplikacja Microsoft Entra ID zarejestrowana w dzierżawie hostująca agenta, skonfigurowana przy użyciu client_credentials udzielenia i uprawnienia do wywoływania agenta docelowego.
  • Oczekiwana grupa odbiorców tokenu agenta (zazwyczaj Microsoft identyfikator aplikacji agenta, na przykład api://<appId>).

Pobieranie poświadczeń

Do uwierzytelniania żądań interfejsu API potrzebne są następujące elementy:

  1. Identyfikator dzierżawy aplikacji Microsoft Entra ID.
  2. Identyfikator klienta (identyfikator aplikacji) aplikacji Microsoft Entra ID.
  3. Klucz tajny klienta dla tej aplikacji.
  4. Adres URL zasobu zgodny z odbiorcami oczekiwany przez agenta docelowego (wzorzec uwierzytelniania umiejętności bot framework).

Podaj te wartości podczas tworzenia połączenia. Utwórz jedno połączenie na agenta, jeśli odbiorcy różnią się.

Znane problemy i ograniczenia

  • Dane agentEndpoint wejściowe muszą być pełnym adresem URL HTTPS (na przykład https://my-agent.azurewebsites.net). Łącznik dołącza /api/messages i przekazuje ładunek działania.
  • Łącznik przekazuje ładunek działania as-is i nie ustawia wartości deliveryMode. Agent odpowiada asynchronicznie (normalne dostarczanie) przez działania odpowiedzi POSTing z powrotem do podanego serviceUrl w działaniu przychodzącym (obiekt wywołujący, np. Microsoft Copilot Studio, zapewnia wywołanie zwrotne serviceUrlz kluczem SAS).
  • Ten łącznik jest w wersji zapoznawczej. Dostępność i możliwości mogą ulec zmianie.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Klucz interfejsu API Uwierzytelnianie przy użyciu klucza statycznego interfejsu API oczekiwanego przez agenta docelowego w niestandardowym nagłówku HTTP. Określ zarówno nazwę nagłówka (na przykład x-api-key) jak i jego wartość. Wszystkie regiony Nie można udostępniać
Microsoft Entra ID (poświadczenia klienta) Mint OAuth tokeny elementu nośnego z aplikacji Microsoft Entra ID przy użyciu przepływu client_credentials. Odbiorcy tokenu elementu nośnego (adres URL zasobu) muszą być zgodni z odbiorcami oczekiwaną przez agenta docelowego. Wszystkie regiony Nie można udostępniać
Bez uwierzytelniania Wywołaj docelowy punkt końcowy agenta bez żadnego nagłówka uwierzytelniania. Tej funkcji należy używać tylko z agentami, którzy jawnie akceptują połączenia anonimowe. Wszystkie regiony Udostępnialne
Domyślne [PRZESTARZAŁE] Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami. Wszystkie regiony Nie można udostępniać

klucz interfejsu API

Identyfikator uwierzytelniania: apiKey

Dotyczy: wszystkie regiony

Uwierzytelnianie przy użyciu klucza statycznego interfejsu API oczekiwanego przez agenta docelowego w niestandardowym nagłówku HTTP. Określ zarówno nazwę nagłówka (na przykład x-api-key) jak i jego wartość.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Opis Wymagane
Nazwa nagłówka klucza interfejsu API ciąg Nazwa nagłówka HTTP, na którym agent docelowy oczekuje klucza interfejsu API (na przykład x-api-key lub Ocp-Apim-Subscription-Key). True
Wartość klucza interfejsu API Securestring Wartość klucza interfejsu API statycznego wysyłana na każde żądanie do punktu końcowego agenta docelowego. True

Microsoft Entra ID (poświadczenia klienta)

Identyfikator uwierzytelniania: oauthClientCredentials

Dotyczy: wszystkie regiony

Mint OAuth tokeny elementu nośnego z aplikacji Microsoft Entra ID przy użyciu przepływu client_credentials. Odbiorcy tokenu elementu nośnego (adres URL zasobu) muszą być zgodni z odbiorcami oczekiwaną przez agenta docelowego.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Opis Wymagane
Tenant ciąg Identyfikator dzierżawy aplikacji Microsoft Entra ID True
identyfikator klienta ciąg Identyfikator klienta (lub aplikacji) aplikacji Microsoft Entra ID. True
Tajemnica klienta Securestring Wpis tajny klienta aplikacji Microsoft Entra ID. True
URL zasobu ciąg Odbiorcy tokenu OAuth. Zazwyczaj identyfikator aplikacji Microsoft agenta docelowego (na przykład api://< appId> lub identyfikator GUID identyfikatora aplikacji). True

Bez uwierzytelniania

Identyfikator uwierzytelniania: anonimowy

Dotyczy: wszystkie regiony

Wywołaj docelowy punkt końcowy agenta bez żadnego nagłówka uwierzytelniania. Tej funkcji należy używać tylko z agentami, którzy jawnie akceptują połączenia anonimowe.

Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz omówienie Connectors dla aplikacji kanwy — Power Apps | Microsoft Docs

Domyślne [PRZESTARZAŁE]

Dotyczy: wszystkie regiony

Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Akcje

Wysyłanie działania do agenta

Przekazuje ładunek protokołu działania do punktu końcowego agenta w lokalizacji {agentEndpoint}/api/messages. Gdy połączenie używa Microsoft Entra ID OAuth, odbiorcy tokenu (adres URL zasobu w połączeniu) muszą być równe grupie odbiorców oczekiwanych przez agenta docelowego (wzorzec uwierzytelniania umiejętności platformy Bot Framework); utwórz jedno połączenie na agenta, jeśli odbiorcy różnią się. Łącznik przekazuje ładunek działania as-is i nie ustawia wartości "deliveryMode"; agent odpowiada asynchronicznie (normalne dostarczanie) przez działania odpowiedzi POSTing do "serviceUrl" dostarczonego w działaniu przychodzącym.

Wysyłanie działania do agenta

Identyfikator operacji:
SendActivity

Przekazuje ładunek protokołu działania do punktu końcowego agenta w lokalizacji {agentEndpoint}/api/messages. Gdy połączenie używa Microsoft Entra ID OAuth, odbiorcy tokenu (adres URL zasobu w połączeniu) muszą być równe grupie odbiorców oczekiwanych przez agenta docelowego (wzorzec uwierzytelniania umiejętności platformy Bot Framework); utwórz jedno połączenie na agenta, jeśli odbiorcy różnią się. Łącznik przekazuje ładunek działania as-is i nie ustawia wartości "deliveryMode"; agent odpowiada asynchronicznie (normalne dostarczanie) przez działania odpowiedzi POSTing do "serviceUrl" dostarczonego w działaniu przychodzącym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Adres URL punktu końcowego agenta
 agentEndpoint True string

Podstawowy adres URL docelowego zestawu SDK agentów Microsoft / punktu końcowego platformy Bot Framework (na przykład https://my-agent.azurewebsites.net). Łącznik dołącza /api/messages.
object

Zwraca

response
object

Definicje

obiekt

Jest to typ 'obiekt'.