AgentNotification Clase
Controlador para las notificaciones del agente de aplicaciones de Microsoft 365.
Esta clase proporciona decoradores para registrar controladores que responden a las notificaciones de varios canales y subcanales de Microsoft 365. Admite el enrutamiento basado en el identificador de canal, el subcanal y los eventos de ciclo de vida.
Constructor
AgentNotification()
Parámetros
| Nombre | Description |
|---|---|
|
app
Requerido
|
Instancia de aplicación que controlará las notificaciones enrutadas. |
|
known_subchannels
|
Iterable opcional de subcanales reconocidos. Si No, el valor predeterminado es todos los valores de la enumeración AgentSubChannel. Valor predeterminado: None
|
|
known_lifecycle_events
|
Iteración opcional de eventos de ciclo de vida reconocidos. Si no es Ninguno, el valor predeterminado es todos los valores de la enumeración AgentLifecycleEvent. Valor predeterminado: None
|
Ejemplos
'''<<>><<python from microsoft_agents.hosting import Application from microsoft_agents_a365.notifications import AgentNotificationapp = Application() notifications = AgentNotification(app)@notifications.on_email() async def handle_email(context, state, notification):
email = notification.email si el correo electrónico:
await context.send_activity(f"Received email: {email.id}")
''<<>>'<<
Métodos
| __init__ | |
| __new__ | |
| on_agent_lifecycle_notification |
Registre un controlador para las notificaciones de eventos del ciclo de vida del agente. Este decorador registra una función de controlador a la que se llamará cuando se produzcan eventos de ciclo de vida, como la creación de usuarios, la eliminación o las actualizaciones de incorporación de cargas de trabajo. |
| on_agent_notification |
Registre un controlador para recibir notificaciones desde un canal específico y un subcanal. Este decorador registra una función de controlador a la que se llamará cuando se recibe una notificación desde el canal especificado y un subcanal opcional. El controlador recibirá un contenedor AgentNotificationActivity con tipo. |
| on_email |
Registre un controlador para las notificaciones por correo electrónico de Outlook. Este es un decorador de conveniencia que registra un controlador para las notificaciones desde el subcanal de correo electrónico. |
| on_excel |
Registre un controlador para las notificaciones de comentarios de Microsoft Excel. Este es un decorador de conveniencia que registra un controlador para las notificaciones desde el subcanal de Excel. |
| on_lifecycle |
Registre un controlador para todas las notificaciones de eventos del ciclo de vida del agente. Este es un decorador de conveniencia que registra un controlador para todos los eventos de ciclo de vida mediante el buscador de coincidencias "*". |
| on_powerpoint |
Registre un controlador para las notificaciones de comentarios de Microsoft PowerPoint. Este es un decorador de conveniencia que registra un controlador para las notificaciones desde el subcanal de PowerPoint. |
| on_user_created |
Registre un controlador para eventos de ciclo de vida de creación de usuarios. Este es un decorador de conveniencia que registra un controlador específicamente para eventos de creación de identidades de usuario agente. |
| on_user_deleted |
Registre un controlador para eventos de ciclo de vida de eliminación de usuarios. Este es un decorador de conveniencia que registra un controlador específicamente para eventos de eliminación de identidades de usuario agente. |
| on_user_workload_onboarding |
Registre un controlador para eventos de actualización de incorporación de cargas de trabajo de usuario. Este es un decorador de conveniencia que registra un controlador para eventos que se producen cuando se actualiza el estado de incorporación de carga de trabajo de un usuario. |
| on_word |
Registre un controlador para las notificaciones de comentarios de Microsoft Word. Este es un decorador de conveniencia que registra un controlador para las notificaciones desde el subcanal de Word. |
__init__
__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)
Parámetros
| Nombre | Description |
|---|---|
|
app
Requerido
|
|
|
known_subchannels
|
Valor predeterminado: None
|
|
known_lifecycle_events
|
Valor predeterminado: None
|
__new__
__new__(**kwargs)
on_agent_lifecycle_notification
Registre un controlador para las notificaciones de eventos del ciclo de vida del agente.
Este decorador registra una función de controlador a la que se llamará cuando se produzcan eventos de ciclo de vida, como la creación de usuarios, la eliminación o las actualizaciones de incorporación de cargas de trabajo.
on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)
Parámetros
| Nombre | Description |
|---|---|
|
lifecycle_event
Requerido
|
Evento de ciclo de vida que se va a escuchar. Use "*" para que coincida con todos los eventos del ciclo de vida o especifique un evento específico de AgentLifecycleEvent. |
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | Description |
|---|---|
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_agent_lifecycle_notification("agenticuseridentitycreated") async def handle_user_created(context, state, notification):
print("Nuevo usuario creado")
''<<>>'<<
on_agent_notification
Registre un controlador para recibir notificaciones desde un canal específico y un subcanal.
Este decorador registra una función de controlador a la que se llamará cuando se recibe una notificación desde el canal especificado y un subcanal opcional. El controlador recibirá un contenedor AgentNotificationActivity con tipo.
on_agent_notification(channel_id: ChannelId, **kwargs: Any)
Parámetros
| Nombre | Description |
|---|---|
|
channel_id
Requerido
|
Identificador de canal que especifica el canal y el subcanal opcional que se va a escuchar. Use "*" como subcanal para que coincida con todos los subcanales. |
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | Description |
|---|---|
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
''python<<>><< de 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
Registre un controlador para las notificaciones por correo electrónico de Outlook.
Este es un decorador de conveniencia que registra un controlador para las notificaciones desde el subcanal de correo electrónico.
on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parámetros
| Nombre | Description |
|---|---|
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | 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]]]
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_email() async def handle_email(context, state, notification):
email = notification.email si el correo electrónico:
print(f"Received email: {email.id}")
# Send a response
response = EmailResponse.create_email_response_activity(
"<p>Thank you for your email.</p>"
)
await context.send_activity(response)
''<<>>'<<
on_excel
Registre un controlador para las notificaciones de comentarios de Microsoft Excel.
Este es un decorador de conveniencia que registra un controlador para las notificaciones desde el subcanal de Excel.
on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parámetros
| Nombre | Description |
|---|---|
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | 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]]]
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_excel() async def handle_excel_comment(context, state, notification):
comment = notification.wpx_comment si comentario:
print(f"Received Excel comment: {comment.comment_id}")
''<<>>'<<
on_lifecycle
Registre un controlador para todas las notificaciones de eventos del ciclo de vida del agente.
Este es un decorador de conveniencia que registra un controlador para todos los eventos de ciclo de vida mediante el buscador de coincidencias "*".
on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parámetros
| Nombre | Description |
|---|---|
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | 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]]]
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_lifecycle() async def handle_any_lifecycle_event(context, state, notification):
print(f"Lifecycle event type: {notification.notification_type}")
''<<>>'<<
on_powerpoint
Registre un controlador para las notificaciones de comentarios de Microsoft PowerPoint.
Este es un decorador de conveniencia que registra un controlador para las notificaciones desde el subcanal de PowerPoint.
on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parámetros
| Nombre | Description |
|---|---|
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | 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]]]
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_powerpoint() async def handle_powerpoint_comment(context, state, notification):
comment = notification.wpx_comment si comentario:
print(f"Received PowerPoint comment: {comment.comment_id}")
''<<>>'<<
on_user_created
Registre un controlador para eventos de ciclo de vida de creación de usuarios.
Este es un decorador de conveniencia que registra un controlador específicamente para eventos de creación de identidades de usuario agente.
on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parámetros
| Nombre | Description |
|---|---|
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | 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]]]
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_user_created() async def handle_user_created(context, state, notification):
print("Nueva identidad de usuario agente creada")
''<<>>'<<
on_user_deleted
Registre un controlador para eventos de ciclo de vida de eliminación de usuarios.
Este es un decorador de conveniencia que registra un controlador específicamente para eventos de eliminación de identidades de usuario agente.
on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parámetros
| Nombre | Description |
|---|---|
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | 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]]]
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_user_deleted() async def handle_user_deleted(context, state, notification):
print("Agentic user identity deleted")
''<<>>'<<
on_user_workload_onboarding
Registre un controlador para eventos de actualización de incorporación de cargas de trabajo de usuario.
Este es un decorador de conveniencia que registra un controlador para eventos que se producen cuando se actualiza el estado de incorporación de carga de trabajo de un usuario.
on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parámetros
| Nombre | Description |
|---|---|
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | 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]]]
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_user_workload_onboarding() async def handle_onboarding_update(context, state, notification):
print("Estado de incorporación de carga de trabajo de usuario actualizado")
''<<>>'<<
on_word
Registre un controlador para las notificaciones de comentarios de Microsoft Word.
Este es un decorador de conveniencia que registra un controlador para las notificaciones desde el subcanal de Word.
on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parámetros
| Nombre | Description |
|---|---|
|
**kwargs
Requerido
|
Argumentos de palabra clave adicionales pasados al método add_route de la aplicación. |
Devoluciones
| Tipo | 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]]]
|
Función de decorador que registra el controlador con la aplicación. |
Ejemplos
'''<<>><<python @notifications.on_word() async def handle_word_comment(context, state, notification):
comment = notification.wpx_comment si comentario:
print(f"Received Word comment: {comment.comment_id}")
''<<>>'<<