Xrm.Copilot (Referência à API do cliente)

Fornece métodos para interagir com o Microsoft Copilot em Power Apps orientados por modelos, incluindo APIs de pré-visualização para executar tópicos registados no Microsoft Copilot Studio.

Métodos geralmente disponíveis

Método Description
addActionHandler Regista uma função de handler personalizada para uma ação do Microsoft Copilot.
addDefaultActionHandlers Restaura os handlers padrão da plataforma para uma ação do Microsoft Copilot.
getCurrentAgent Devolve o Microsoft agente do Copilot atualmente ativo, ou indefinido se o estado do agente ainda não for conhecido.
isM365CopilotEnabled Indica se o Microsoft Copilot está ativado no ambiente atual.
openM365CopilotPanel Abre o painel lateral do Microsoft Copilot.
removeActionHandler Remove um handler personalizado previamente registado para uma ação do Microsoft Copilot.
removeDefaultActionHandlers Remove os handlers padrão da plataforma para uma ação do Microsoft Copilot.
enviarPromptParaM365Copilot Envia um prompt para o painel lateral do Microsoft Copilot, fazendo com que o Copilot processe e responda em nome do utilizador.
updateContext Envia contexto atualizado da aplicação para o painel lateral do Microsoft Copilot.

Métodos de pré-visualização

Método Description
executeEvent (pré-visualização) Executa um tópico do Microsoft Copilot Studio com base no Nome do Evento registado. Retorna uma matriz do tipo MCSResponse.
executePrompt (pré-visualização) Executa um tópico do Microsoft Copilot Studio com base nas consultas de gatilho registadas no tópico. Retorna a matriz do tipo MCSResponse.

Interfaces

Interface Description
M365CopilotAgent Descreve o Microsoft agente do Copilot atualmente ativo — devolvido por getCurrentAgent.
M365CopilotAgentMode Descreve como um Microsoft agente do Copilot está a ser referenciado.
MCSResponse Descreve os dados devolvidos pelos métodos executeEvent e executePrompt .
PowerAppsContent Descreve os dados de contexto passados para o método updateContext . Todas as propriedades são opcionais.
SendPromptToM365CopilotOptions Descreve os parâmetros opcionais passados ao método sendPromptToM365Copilot .

Objeto Xrm da API do cliente