AgentNotification Classe
Gestionnaire de notifications d’agent à partir d’applications Microsoft 365.
Cette classe fournit des décorateurs pour l’inscription de gestionnaires qui répondent aux notifications provenant de différents canaux et sous-canaux Microsoft 365. Il prend en charge le routage en fonction de l’ID de canal, du sous-canal et des événements de cycle de vie.
Constructeur
AgentNotification()
Paramètres
| Nom | Description |
|---|---|
|
app
Obligatoire
|
Instance d’application qui gère les notifications routées. |
|
known_subchannels
|
Itérable facultatif des sous-canaux reconnus. Si aucun, la valeur par défaut est de toutes les valeurs de l’énumération AgentSubChannel. Valeur par défaut: None
|
|
known_lifecycle_events
|
Itérable facultatif des événements de cycle de vie reconnus. Si aucun, la valeur par défaut est toutes les valeurs de l’énumération AgentLifecycleEvent. Valeur par défaut: None
|
Exemples
from microsoft_agents.hosting import Application
from microsoft_agents_a365.notifications import AgentNotification
app = Application()
notifications = AgentNotification(app)
@notifications.on_email()
async def handle_email(context, state, notification):
email = notification.email
if email:
await context.send_activity(f"Received email: {email.id}")
Méthodes
| __init__ | |
| __new__ | |
| on_agent_lifecycle_notification |
Inscrivez un gestionnaire pour les notifications d’événements de cycle de vie de l’agent. Ce décorateur inscrit une fonction de gestionnaire à appeler lorsque des événements de cycle de vie se produisent, tels que la création d’utilisateurs, la suppression ou les mises à jour d’intégration de charge de travail. |
| on_agent_notification |
Inscrivez un gestionnaire pour les notifications à partir d’un canal et d’un sous-canal spécifique. Ce décorateur inscrit une fonction de gestionnaire à appeler lorsqu’une notification est reçue du canal spécifié et du sous-canal facultatif. Le gestionnaire reçoit un wrapper AgentNotificationActivity typé. |
| on_email |
Inscrivez un gestionnaire pour les notifications par e-mail Outlook. Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les notifications à partir du sous-canal de messagerie. |
| on_excel |
Inscrivez un gestionnaire pour les notifications de commentaires Microsoft Excel. Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les notifications à partir du sous-canal Excel. |
| on_lifecycle |
Inscrivez un gestionnaire pour toutes les notifications d’événements de cycle de vie de l’agent. Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour tous les événements de cycle de vie à l’aide du matcher générique « * ». |
| on_powerpoint |
Inscrivez un gestionnaire pour les notifications de commentaires Microsoft PowerPoint. Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les notifications à partir du sous-canal PowerPoint. |
| on_user_created |
Inscrivez un gestionnaire pour les événements de cycle de vie de création d’utilisateurs. Il s’agit d’un décorateur pratique qui inscrit un gestionnaire spécifiquement pour les événements de création d’identité utilisateur agentique. |
| on_user_deleted |
Inscrivez un gestionnaire pour les événements de cycle de vie de suppression des utilisateurs. Il s’agit d’un décorateur pratique qui inscrit un gestionnaire spécifiquement pour les événements de suppression d’identité utilisateur agentique. |
| on_user_workload_onboarding |
Inscrivez un gestionnaire pour les événements de mise à jour d’intégration de charge de travail utilisateur. Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les événements qui se produisent lorsque l’état d’intégration de la charge de travail d’un utilisateur est mis à jour. |
| on_word |
Inscrivez un gestionnaire pour les notifications de commentaires Microsoft Word. Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les notifications à partir du sous-canal Word. |
__init__
__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)
Paramètres
| Nom | Description |
|---|---|
|
app
Obligatoire
|
|
|
known_subchannels
|
Valeur par défaut: None
|
|
known_lifecycle_events
|
Valeur par défaut: None
|
__new__
__new__(**kwargs)
on_agent_lifecycle_notification
Inscrivez un gestionnaire pour les notifications d’événements de cycle de vie de l’agent.
Ce décorateur inscrit une fonction de gestionnaire à appeler lorsque des événements de cycle de vie se produisent, tels que la création d’utilisateurs, la suppression ou les mises à jour d’intégration de charge de travail.
on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)
Paramètres
| Nom | Description |
|---|---|
|
lifecycle_event
Obligatoire
|
Événement de cycle de vie à écouter. Utilisez « * » pour faire correspondre tous les événements de cycle de vie ou spécifiez un événement spécifique de AgentLifecycleEvent. |
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_agent_lifecycle_notification("agenticuseridentitycreated")
async def handle_user_created(context, state, notification):
print("New user created")
on_agent_notification
Inscrivez un gestionnaire pour les notifications à partir d’un canal et d’un sous-canal spécifique.
Ce décorateur inscrit une fonction de gestionnaire à appeler lorsqu’une notification est reçue du canal spécifié et du sous-canal facultatif. Le gestionnaire reçoit un wrapper AgentNotificationActivity typé.
on_agent_notification(channel_id: ChannelId, **kwargs: Any)
Paramètres
| Nom | Description |
|---|---|
|
channel_id
Obligatoire
|
ID de canal spécifiant le canal et le sous-canal facultatif à écouter. Utilisez « * » comme sous-canal pour faire correspondre tous les sous-canaux. |
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
from microsoft_agents.activity import ChannelId
@notifications.on_agent_notification(
ChannelId(channel="agents", sub_channel="email")
)
async def handle_custom_channel(context, state, notification):
print(f"Received notification on {notification.channel}/{notification.sub_channel}")
on_email
Inscrivez un gestionnaire pour les notifications par e-mail Outlook.
Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les notifications à partir du sous-canal de messagerie.
on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Paramètres
| Nom | Description |
|---|---|
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_email()
async def handle_email(context, state, notification):
email = notification.email
if email:
print(f"Received email: {email.id}")
response = EmailResponse.create_email_response_activity(
"<p>Thank you for your email.</p>"
)
await context.send_activity(response)
on_excel
Inscrivez un gestionnaire pour les notifications de commentaires Microsoft Excel.
Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les notifications à partir du sous-canal Excel.
on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Paramètres
| Nom | Description |
|---|---|
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_excel()
async def handle_excel_comment(context, state, notification):
comment = notification.wpx_comment
if comment:
print(f"Received Excel comment: {comment.comment_id}")
on_lifecycle
Inscrivez un gestionnaire pour toutes les notifications d’événements de cycle de vie de l’agent.
Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour tous les événements de cycle de vie à l’aide du matcher générique « * ».
on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Paramètres
| Nom | Description |
|---|---|
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_lifecycle()
async def handle_any_lifecycle_event(context, state, notification):
print(f"Lifecycle event type: {notification.notification_type}")
on_powerpoint
Inscrivez un gestionnaire pour les notifications de commentaires Microsoft PowerPoint.
Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les notifications à partir du sous-canal PowerPoint.
on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Paramètres
| Nom | Description |
|---|---|
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_powerpoint()
async def handle_powerpoint_comment(context, state, notification):
comment = notification.wpx_comment
if comment:
print(f"Received PowerPoint comment: {comment.comment_id}")
on_user_created
Inscrivez un gestionnaire pour les événements de cycle de vie de création d’utilisateurs.
Il s’agit d’un décorateur pratique qui inscrit un gestionnaire spécifiquement pour les événements de création d’identité utilisateur agentique.
on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Paramètres
| Nom | Description |
|---|---|
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_user_created()
async def handle_user_created(context, state, notification):
print("New agentic user identity created")
on_user_deleted
Inscrivez un gestionnaire pour les événements de cycle de vie de suppression des utilisateurs.
Il s’agit d’un décorateur pratique qui inscrit un gestionnaire spécifiquement pour les événements de suppression d’identité utilisateur agentique.
on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Paramètres
| Nom | Description |
|---|---|
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_user_deleted()
async def handle_user_deleted(context, state, notification):
print("Agentic user identity deleted")
on_user_workload_onboarding
Inscrivez un gestionnaire pour les événements de mise à jour d’intégration de charge de travail utilisateur.
Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les événements qui se produisent lorsque l’état d’intégration de la charge de travail d’un utilisateur est mis à jour.
on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Paramètres
| Nom | Description |
|---|---|
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_user_workload_onboarding()
async def handle_onboarding_update(context, state, notification):
print("User workload onboarding status updated")
on_word
Inscrivez un gestionnaire pour les notifications de commentaires Microsoft Word.
Il s’agit d’un décorateur pratique qui inscrit un gestionnaire pour les notifications à partir du sous-canal Word.
on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Paramètres
| Nom | Description |
|---|---|
|
**kwargs
Obligatoire
|
Arguments de mot clé supplémentaires passés à la méthode add_route de l’application. |
Retours
| Type | Description |
|---|---|
|
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
|
Fonction de décorateur qui inscrit le gestionnaire auprès de l’application. |
Exemples
@notifications.on_word()
async def handle_word_comment(context, state, notification):
comment = notification.wpx_comment
if comment:
print(f"Received Word comment: {comment.comment_id}")