AgentNotificationActivity Classe

Wrapper autour d’un objet Activity avec des entités de notification typées.

Cette classe fournit un accès pratique aux entités de notification typées extraites de la collection d’entités d’une activité. Il analyse et valide automatiquement les notifications par e-mail, les commentaires Word/PowerPoint/Excel et les événements de cycle de vie au moment de la construction.

Constructeur

AgentNotificationActivity()

Paramètres

Nom Description
activity
Obligatoire

Objet Activité à encapsuler. Ne doit pas être None.

Exemples


   async def email_handler(
       context: TurnContext,
       state: TurnState,
       notification: AgentNotificationActivity,
   ) -> None:
       email = notification.email
       if email:
           print(f"Received email: {email.id}")
           print(f"Body: {email.html_body}")

Méthodes

__init__
__new__
as_model

Analysez la valeur d’activité en tant que type de modèle personnalisé.

Cette méthode fournit un moyen générique de valider et d’analyser la charge utile de valeur de l’activité dans n’importe quel type de modèle Pydantic. Utile pour les types de notification personnalisés non directement pris en charge par les propriétés typées.

__init__

__init__(activity: Activity)

Paramètres

Nom Description
activity
Obligatoire

__new__

__new__(**kwargs)

as_model

Analysez la valeur d’activité en tant que type de modèle personnalisé.

Cette méthode fournit un moyen générique de valider et d’analyser la charge utile de valeur de l’activité dans n’importe quel type de modèle Pydantic. Utile pour les types de notification personnalisés non directement pris en charge par les propriétés typées.

as_model(model: Type[TModel]) -> TModel | None

Paramètres

Nom Description
model
Obligatoire
Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]

Classe de modèle Pydantic dans laquelle valider et analyser la valeur d’activité.

Retours

Type Description
<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel> | None

Instance du type de modèle spécifié si la validation réussit, sinon Aucun.

Exemples


   from pydantic import BaseModel

   class CustomNotification(BaseModel):
       custom_field: str

   notification = AgentNotificationActivity(activity)
   custom = notification.as_model(CustomNotification)
   if custom:
       print(custom.custom_field)

Attributs

channel

Identificateur de canal du channel_id de l’activité.

Retours

Type Description

Nom du canal (par exemple, « agents », « msteams ») ou Aucun s’il n’est pas disponible.

email

Entité de référence de messagerie analysée, le cas échéant.

Retours

Type Description

Objet EmailReference si une entité de notification par e-mail a été trouvée et analysée correctement, sinon Aucun.

notification_type

Type de notification détecté.

Retours

Type Description

Valeur d’énumération NotificationTypes indiquant le type de notification (EMAIL_NOTIFICATION, WPX_COMMENT ou AGENT_LIFECYCLE) ou Aucun si le type de notification n’a pas pu être déterminé.

sub_channel

Identificateur de sous-canal du channel_id de l’activité.

Retours

Type Description

Nom du sous-canal (par exemple, « e-mail », « word ») ou Aucun s’il n’est pas disponible.

type

Type d’activité.

Retours

Type Description

Type de l’activité (par exemple, « message », « événement ») ou Aucun s’il n’est pas défini.

value

Charge utile de valeur de l’activité.

Retours

Type Description

Valeur de l’activité, qui peut contenir des données de notification supplémentaires.

wpx_comment

Entité de commentaire Word/PowerPoint/Excel analysée, le cas échéant.

Retours

Type Description

Objet WpxComment si une entité de commentaire a été trouvée et analysée correctement, sinon Aucun.

activity

Objet Activité sous-jacent.