SDK do agente (versão prévia)

Encaminha cargas de atividade do SDK do Bot Framework/Microsoft Agents para um ponto de extremidade de agente fornecido pelo usuário. A URL do ponto de extremidade do agente é fornecida por chamada como um parâmetro de entrada. A autenticação é selecionada ao criar a conexão: nenhuma autenticação, uma chave de API estática ou Microsoft Entra ID OAuth (client_credentials). Quando o OAuth é selecionado, o público-alvo do token de portador (URL de recurso configurada na conexão) deve corresponder ao público-alvo esperado pelo agente de destino.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Standard Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Standard Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Standard Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Microsoft
URL https://support.microsoft.com
Metadados do conector
Publicador Microsoft
Site https://www.microsoft.com
Política de privacidade https://privacy.microsoft.com/
Categories Produtividade

O conector do SDK do Agente encaminha cargas de atividade do SDK do Bot Framework/Microsoft Agents para um ponto de extremidade de agente fornecido pelo usuário. A URL do ponto de extremidade do agente é fornecida por chamada como um parâmetro de entrada; Os tokens OAuth são criados pela plataforma a partir das credenciais de aplicativo Microsoft Entra ID fornecidas pelo usuário configuradas na conexão e injetadas como um token de portador em cada solicitação de saída. O público-alvo do token de portador (URL de recurso configurada na conexão) deve corresponder ao público-alvo esperado pelo agente de destino.

Pré-requisitos

  • Um agente do SDK do Microsoft Agents/Bot Framework implantado pode ser acessado por HTTPS.
  • Um aplicativo Microsoft Entra ID registrado no locatário que hospeda o agente, configurado com a client_credentials concessão e a permissão para chamar o agente de destino.
  • O público-alvo de token esperado do agente (normalmente a ID do aplicativo Microsoft do agente, por exemploapi://<appId>).

Obter suas credenciais

Para autenticar suas solicitações de API, você precisará de:

  1. A ID do locatário do aplicativo Microsoft Entra ID.
  2. A ID do cliente (ID do aplicativo) do aplicativo Microsoft Entra ID.
  3. O Segredo do Cliente para esse aplicativo.
  4. A URL de Recurso que corresponde ao público-alvo esperado pelo agente de destino (padrão de autenticação de habilidade do Bot Framework).

Forneça esses valores ao criar uma conexão. Crie uma conexão por agente se o público-alvo for diferente.

Limitações e problemas conhecidos

  • A agentEndpoint entrada deve ser uma URL HTTPS completa (por exemplo, https://my-agent.azurewebsites.net). O conector acrescenta /api/messages e encaminha o conteúdo da Atividade.
  • O conector encaminha o conteúdo da atividade as-is e não define deliveryMode. O agente responde de forma assíncrona (entrega normal) ao enviar atividades de resposta de volta ao serviceUrl fornecido na atividade de entrada (o chamador, por exemplo, Microsoft Copilot Studio, fornece um retorno serviceUrlde chamada com chave SAS).
  • Esse conector está em versão prévia. A disponibilidade e os recursos estão sujeitos a alterações.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Chave de API Autentique com uma chave de API estática que o agente de destino espera em um cabeçalho HTTP personalizado. Especifique o nome do cabeçalho (por exemplo, x-api-key) e seu valor. Todas as regiões Não compartilhável
Microsoft Entra ID (credenciais do cliente) Tokens de portador do Mint OAuth de um aplicativo Microsoft Entra ID usando o fluxo de client_credentials. O público-alvo do token de portador (URL do recurso) deve corresponder ao público-alvo esperado pelo agente de destino. Todas as regiões Não compartilhável
Sem autenticação Chame o ponto de extremidade do agente de destino sem nenhum cabeçalho de autenticação. Use isso apenas com agentes que aceitam explicitamente chamadas anônimas. Todas as regiões Compartilhável
Padrão [PRETERIDO] Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. Todas as regiões Não compartilhável

chave de API

ID de autenticação: apiKey

Aplicável: todas as regiões

Autentique com uma chave de API estática que o agente de destino espera em um cabeçalho HTTP personalizado. Especifique o nome do cabeçalho (por exemplo, x-api-key) e seu valor.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Nome do cabeçalho da chave de API cadeia Nome do cabeçalho HTTP no qual o agente de destino espera a chave de API (por exemplo, x-api-key ou Ocp-Apim-Subscription-Key). Verdade
Valor da chave de API Securestring Valor de chave de API estático enviado em cada solicitação para o ponto de extremidade do agente de destino. Verdade

Microsoft Entra ID (credenciais do cliente)

ID de autenticação: oauthClientCredentials

Aplicável: todas as regiões

Tokens de portador do Mint OAuth de um aplicativo Microsoft Entra ID usando o fluxo de client_credentials. O público-alvo do token de portador (URL do recurso) deve corresponder ao público-alvo esperado pelo agente de destino.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Inquilino cadeia A ID do locatário do aplicativo Microsoft Entra ID Verdade
ID do cliente cadeia ID do cliente (ou aplicativo) do aplicativo Microsoft Entra ID. Verdade
Segredo do Cliente Securestring Segredo do cliente do aplicativo Microsoft Entra ID. Verdade
URL do recurso cadeia Audiência para o token OAuth. Normalmente, a ID do aplicativo Microsoft do agente de destino (por exemplo, api://< appId> ou o GUID da ID do aplicativo). Verdade

Sem autenticação

ID de autenticação: anônimo

Aplicável: todas as regiões

Chame o ponto de extremidade do agente de destino sem nenhum cabeçalho de autenticação. Use isso apenas com agentes que aceitam explicitamente chamadas anônimas.

Essa é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a visão geral do Connectors para aplicativos de tela – Power Apps | Microsoft Docs

Padrão [PRETERIDO]

Aplicável: todas as regiões

Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Ações

Enviar atividade para o agente

Encaminha um conteúdo do Protocolo de Atividade para o ponto de extremidade do agente em {agentEndpoint}/api/messages. Quando a conexão usa Microsoft Entra ID OAuth, o público-alvo do token (URL do recurso na conexão) deve ser igual ao público-alvo esperado pelo agente de destino (padrão de autenticação de habilidade do Bot Framework); crie uma conexão por agente se o público-alvo for diferente. O conector encaminha o conteúdo da atividade as-is e não define 'deliveryMode'; o agente responde de forma assíncrona (entrega normal) por meio da posting atividades de resposta ao 'serviceUrl' fornecido na atividade de entrada.

Enviar atividade para o agente

Encaminha um conteúdo do Protocolo de Atividade para o ponto de extremidade do agente em {agentEndpoint}/api/messages. Quando a conexão usa Microsoft Entra ID OAuth, o público-alvo do token (URL do recurso na conexão) deve ser igual ao público-alvo esperado pelo agente de destino (padrão de autenticação de habilidade do Bot Framework); crie uma conexão por agente se o público-alvo for diferente. O conector encaminha o conteúdo da atividade as-is e não define 'deliveryMode'; o agente responde de forma assíncrona (entrega normal) por meio da posting atividades de resposta ao 'serviceUrl' fornecido na atividade de entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
URL do ponto de extremidade do agente
agentEndpoint True string

URL base do SDK de agentes de Microsoft de destino/ponto de extremidade do Bot Framework (por exemplo, https://my-agent.azurewebsites.net). O conector acrescenta /api/mensagens.

object

Retornos

response
object

Definições

objeto

Esse é o tipo 'object'.