Compartilhar via

executeEvent (versão prévia)

Importante

  • Esse é um recurso de visualização.
  • Os recursos de versão preliminar não foram criados para uso em ambientes de produção e podem ter funcionalidade restrita. Esses recursos estão sujeitos a termos de uso suplementares e são disponibilizados antes de um lançamento oficial, de maneira que os clientes possam ter acesso antecipado e fazer comentários.

Executa um tópico do Microsoft Copilot Studio com base no Nome do Evento registrado. Retorna uma matriz do tipo MCSResponse.

Disponível para

Aplicativos baseados em modelo

Sintaxe

context.copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);

Parâmetros

Nome do parâmetro Tipo Obrigatório Description
eventName cadeia Yes Nome do evento registrado no tópico do Copilot Studio
eventParameters Unknown Yes Parâmetros necessários para a execução do evento. Elas dependem do que o tópico faz.
successCallback Função Yes Uma função a ser chamada quando a operação for bem-sucedida.
errorCallback Função Yes Uma função a ser chamada quando a operação falhar.

Valor de retorno

Tipo: Promise<MCSResponse>

Consulte Promise e MCSResponse

Acessando o contexto do aplicativo

Quando uma API do Agente é chamada, o contexto do aplicativo é passado para o tópico do Copilot Studio por meio de um conjunto de variáveis. Veja a seguir variáveis de contexto disponíveis como variáveis globais do Copilot Studio.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID do registro da tabela no formulário principal
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Nome lógico da tabela na página principal
Global.PA__Copilot_Model_PageContext.pageContext.pageName Nome da página principal
Global.PA__Copilot_Model_PageContext.pageContext.pageType Tipo da página principal
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Nome exclusivo do aplicativo controlado por modelos

Por exemplo, usando Global.PA__Copilot_Model_PageContext.pageContext.id.guid e Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, o registro do formulário pode ser recuperado do Dataverse.

Acessando eventParameters

No tópico do Copilot Studio, a eventParameters chamada da API pode ser acessada usando a variável Activity.Value. Use o nó de valor parse para converter o JSON em um registro com um ou mais campos. Selecionar de dados de exemplo para o tipo de dados permite fornecer um exemplo JSON para criar o registro.

Example

No Microsoft Copilot Studio, onde um tópico é registrado que aceita uma ID (ID do registro de entidade) como um parâmetro de entrada. Com base na entrada, ele recupera as atividades relacionadas desse registro de entidade e retorna os resultados como uma atividade de evento do Copilot Studio. A API de contexto do PCF permite a execução desses métodos no contexto dos controles pcf.

const response = await context.copilot.executeEvent( 
    "Microsoft.PowerApps.Copilot.RelatedActivities", 
    { id:"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"});

Resposta

[
    {
        "type": "event",
        "timestamp": "2025-02-05T16:05:53.4074714+00:00",
        "replyToId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "attachments": [],
        "value": {
            "@odata.context": "https://*.dynamics.com/api/data/v9.2/$metadata#activitypointers(subject,prioritycode)",
            "value": [
                {
                    "@odata.etag": "W/\"6825587\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "cccccccc-2222-3333-4444-dddddddddddd",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Discuss new opportunity (sample)"
                },
                {
                    "@odata.etag": "W/\"6826236\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Likes our new products (sample)"
                }
            ]
        },
        "name": "MS.CopilotApiDemo.RelatedActivities"
    }
]

Copiloto
executePrompt
Referência da API da estrutura de componentes do Power Apps
Visão geral da estrutura de componentes do Power Apps

  • Last updated on