AgentNotification Classe
Manipulador para notificações de agente de aplicativos do Microsoft 365.
Essa classe fornece decoradores para registrar manipuladores que respondem a notificações de vários canais e subcanais do Microsoft 365. Ele dá suporte ao roteamento com base na ID do canal, subcanal e eventos de ciclo de vida.
Construtor
AgentNotification()
Parâmetros
| Nome | Description |
|---|---|
|
app
Obrigatório
|
A instância do aplicativo que manipulará as notificações roteada. |
|
known_subchannels
|
Iterável opcional de subcanais reconhecidos. Se None, o padrão é todos os valores na enumeração AgentSubChannel. Valor padrão: None
|
|
known_lifecycle_events
|
Iterável opcional de eventos de ciclo de vida reconhecidos. Se None, o padrão é todos os valores na enumeração AgentLifecycleEvent. Valor padrão: None
|
Exemplos
'''<<>><<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 se email:
await context.send_activity(f"Received email: {email.id}")
''<<>>'<<
Métodos
| __init__ | |
| __new__ | |
| on_agent_lifecycle_notification |
Registre um manipulador para notificações de evento do ciclo de vida do agente. Esse decorador registra uma função de manipulador a ser chamada quando ocorrem eventos de ciclo de vida, como a criação, a exclusão ou as atualizações de integração de carga de trabalho. |
| on_agent_notification |
Registre um manipulador para notificações de um canal e subcanal específicos. Esse decorador registra uma função de manipulador a ser chamada quando uma notificação é recebida do canal especificado e do subcanal opcional. O manipulador receberá um wrapper AgentNotificationActivity tipado. |
| on_email |
Registre um manipulador para notificações por email do Outlook. Esse é um decorador de conveniência que registra um manipulador para notificações do subcanal de email. |
| on_excel |
Registre um manipulador para notificações de comentário do Microsoft Excel. Esse é um decorador de conveniência que registra um manipulador para notificações do subcanal do Excel. |
| on_lifecycle |
Registre um manipulador para todas as notificações de evento do ciclo de vida do agente. Este é um decorador de conveniência que registra um manipulador para todos os eventos de ciclo de vida usando o caractere curinga "*". |
| on_powerpoint |
Registre um manipulador para notificações de comentário do Microsoft PowerPoint. Esse é um decorador de conveniência que registra um manipulador para notificações do subcanal do PowerPoint. |
| on_user_created |
Registre um manipulador para eventos de ciclo de vida de criação do usuário. Esse é um decorador de conveniência que registra um manipulador especificamente para eventos de criação de identidade de usuário agente. |
| on_user_deleted |
Registre um manipulador para eventos de ciclo de vida de exclusão de usuário. Esse é um decorador de conveniência que registra um manipulador especificamente para eventos de exclusão de identidade do usuário agente. |
| on_user_workload_onboarding |
Registre um manipulador para eventos de atualização de integração de carga de trabalho do usuário. Esse é um decorador de conveniência que registra um manipulador para eventos que ocorrem quando o status de integração de carga de trabalho de um usuário é atualizado. |
| on_word |
Registre um manipulador para notificações de comentário do Microsoft Word. Esse é um decorador de conveniência que registra um manipulador para notificações do subcanal do Word. |
__init__
__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)
Parâmetros
| Nome | Description |
|---|---|
|
app
Obrigatório
|
|
|
known_subchannels
|
Valor padrão: None
|
|
known_lifecycle_events
|
Valor padrão: None
|
__new__
__new__(**kwargs)
on_agent_lifecycle_notification
Registre um manipulador para notificações de evento do ciclo de vida do agente.
Esse decorador registra uma função de manipulador a ser chamada quando ocorrem eventos de ciclo de vida, como a criação, a exclusão ou as atualizações de integração de carga de trabalho.
on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)
Parâmetros
| Nome | Description |
|---|---|
|
lifecycle_event
Obrigatório
|
O evento de ciclo de vida a ser escutado. Use "*" para corresponder a todos os eventos do ciclo de vida ou especifique um evento específico do AgentLifecycleEvent. |
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| Tipo | Description |
|---|---|
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_agent_lifecycle_notification("agenticuseridentitycreated") async def handle_user_created(context, state, notification):
print("Novo usuário criado")
''<<>>'<<
on_agent_notification
Registre um manipulador para notificações de um canal e subcanal específicos.
Esse decorador registra uma função de manipulador a ser chamada quando uma notificação é recebida do canal especificado e do subcanal opcional. O manipulador receberá um wrapper AgentNotificationActivity tipado.
on_agent_notification(channel_id: ChannelId, **kwargs: Any)
Parâmetros
| Nome | Description |
|---|---|
|
channel_id
Obrigatório
|
A ID do canal que especifica o canal e o subcanal opcional a serem escutados. Use "*" como o subcanal para corresponder a todos os subcanais. |
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| Tipo | Description |
|---|---|
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python de microsoft_agents.activity import ChannelId
@notifications.on_agent_notification( ChannelId(channel="agents", sub_channel="email")
) async def handle_custom_channel(contexto, estado, notificação):
print(f"Notificação recebida em {notification.channel}/{notification.sub_channel}")
''<<>>'<<
on_email
Registre um manipulador para notificações por email do Outlook.
Esse é um decorador de conveniência que registra um manipulador para notificações do subcanal de email.
on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parâmetros
| Nome | Description |
|---|---|
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| 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]]]
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_email() async def handle_email(contexto, estado, notificação):
email = notification.email se email:
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 um manipulador para notificações de comentário do Microsoft Excel.
Esse é um decorador de conveniência que registra um manipulador para notificações do subcanal do Excel.
on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parâmetros
| Nome | Description |
|---|---|
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| 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]]]
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_excel() async def handle_excel_comment(contexto, estado, notificação):
comment = notification.wpx_comment se comentar:
print(f"Received Excel comment: {comment.comment_id}")
''<<>>'<<
on_lifecycle
Registre um manipulador para todas as notificações de evento do ciclo de vida do agente.
Este é um decorador de conveniência que registra um manipulador para todos os eventos de ciclo de vida usando o caractere curinga "*".
on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parâmetros
| Nome | Description |
|---|---|
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| 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]]]
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_lifecycle() async def handle_any_lifecycle_event(contexto, estado, notificação):
print(f"Tipo de evento de ciclo de vida: {notification.notification_type}")
''<<>>'<<
on_powerpoint
Registre um manipulador para notificações de comentário do Microsoft PowerPoint.
Esse é um decorador de conveniência que registra um manipulador para notificações do subcanal do PowerPoint.
on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parâmetros
| Nome | Description |
|---|---|
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| 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]]]
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_powerpoint() async def handle_powerpoint_comment(contexto, estado, notificação):
comment = notification.wpx_comment se comentar:
print(f"Received PowerPoint comment: {comment.comment_id}")
''<<>>'<<
on_user_created
Registre um manipulador para eventos de ciclo de vida de criação do usuário.
Esse é um decorador de conveniência que registra um manipulador especificamente para eventos de criação de identidade de usuário agente.
on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parâmetros
| Nome | Description |
|---|---|
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| 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]]]
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_user_created() async def handle_user_created(contexto, estado, notificação):
print("Nova identidade de usuário agentic criada")
''<<>>'<<
on_user_deleted
Registre um manipulador para eventos de ciclo de vida de exclusão de usuário.
Esse é um decorador de conveniência que registra um manipulador especificamente para eventos de exclusão de identidade do usuário agente.
on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parâmetros
| Nome | Description |
|---|---|
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| 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]]]
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_user_deleted() async def handle_user_deleted(contexto, estado, notificação):
print("Identidade do usuário agente excluída")
''<<>>'<<
on_user_workload_onboarding
Registre um manipulador para eventos de atualização de integração de carga de trabalho do usuário.
Esse é um decorador de conveniência que registra um manipulador para eventos que ocorrem quando o status de integração de carga de trabalho de um usuário é atualizado.
on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parâmetros
| Nome | Description |
|---|---|
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| 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]]]
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_user_workload_onboarding() async def handle_onboarding_update(contexto, estado, notificação):
print("Status de integração da carga de trabalho do usuário atualizado")
''<<>>'<<
on_word
Registre um manipulador para notificações de comentário do Microsoft Word.
Esse é um decorador de conveniência que registra um manipulador para notificações do subcanal do Word.
on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parâmetros
| Nome | Description |
|---|---|
|
**kwargs
Obrigatório
|
Argumentos de palavra-chave adicionais passados para o método add_route do aplicativo. |
Retornos
| 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]]]
|
Uma função decoradora que registra o manipulador com o aplicativo. |
Exemplos
'''<<>><<python @notifications.on_word() async def handle_word_comment(contexto, estado, notificação):
comment = notification.wpx_comment se comentar:
print(f"Received Word comment: {comment.comment_id}")
''<<>>'<<