Compartir a través de

executeEvent (versión preliminar)

Importante

  • Esta es una característica en versión preliminar.
  • Las características en vista previa no se han diseñado para un uso de producción y pueden tener una funcionalidad restringida. Estas características están sujetas a condiciones de uso adicionales y están disponibles antes del lanzamiento oficial para que los clientes puedan tener un acceso anticipado y proporcionar comentarios.

Ejecuta un tema Microsoft Copilot Studio basado en el nombre del evento registrado. Devuelve un array de tipo MCSResponse.

Disponible para

Aplicaciones basadas en modelo

Sintaxis

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

Parámetros

Nombre de parámetro Type Obligatorio Description
eventName string Sí Nombre del evento registrado en el tema Copilot Studio (MCS)
eventParameters Unknown Sí Parámetros necesarios para la ejecución del evento. Estos dependen de lo que haga el tema.
successCallback Function Sí Una función para llamar a la operación es correcta.
errorCallback Function Sí Una función a la que se llama cuando la operación tiene error.

Valor devuelto

Tipo: Promise<MCSResponse>

Consulte Promesa y MCSResponse

Acceso al contexto de la aplicación

Cuando se llama a una API de agente, el contexto de la aplicación se pasa al Copilot Studio tema a través de un conjunto de variables. A continuación, se muestran variables de contexto disponibles como Copilot Studio variables globales.

Variables Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID del registro de la tabla en el formulario principal
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Nombre lógico de la tabla en la página principal
Global.PA__Copilot_Model_PageContext.pageContext.pageName Nombre de la página principal
Global.PA__Copilot_Model_PageContext.pageContext.pageType Tipo de página principal
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Nombre único de la aplicación basada en modelos

Por ejemplo, usando Global.PA__Copilot_Model_PageContext.pageContext.id.guid y Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, se puede recuperar el registro del formulario Dataverse.

Acceso a eventParameters

Dentro del Copilot Studio tema, se eventParameters puede acceder desde la llamada API mediante la variable Activity.Value. Utilice Analizar valor nodo para convertir el JSON en un registro con uno o varios campos. Al seleccionar A partir de datos de ejemplo para Tipo de datos, se puede proporcionar un ejemplo de JSON para crear el registro.

Ejemplo

En Microsoft Copilot Studio, donde se registra un tema personalizado que acepta ID (ID de registro de entidad) como parámetro de entrada. En función de la entrada, recupera las actividades relacionadas de ese registro de entidad y devuelve los resultados como una Copilot Studio actividad de evento. La API de contexto PCF permite la ejecución de estos métodos en el contexto de controles PCF.

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

Response

[
    {
        "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"
    }
]

Copilot
executePrompt
Referencia de la API de Power Apps component framework
Información general sobre Power Apps component framework

  • Last updated on