AgentNotification Classe
Gestore per le notifiche degli agenti dalle applicazioni di Microsoft 365.
Questa classe fornisce elementi decorator per la registrazione di gestori che rispondono alle notifiche provenienti da vari canali e canali secondari di Microsoft 365. Supporta il routing basato su ID canale, sottocanale ed eventi del ciclo di vita.
Costruttore
AgentNotification()
Parametri
| Nome | Descrizione |
|---|---|
|
app
Necessario
|
Istanza dell'applicazione che gestirà le notifiche indirizzate. |
|
known_subchannels
|
Iterabile facoltativo di sottocanali riconosciuti. Se Nessuno, per impostazione predefinita viene impostato su tutti i valori nell'enumerazione AgentSubChannel. Valore predefinito: None
|
|
known_lifecycle_events
|
Iterabile facoltativo degli eventi del ciclo di vita riconosciuti. Se Nessuno, per impostazione predefinita viene impostato su tutti i valori nell'enumerazione AgentLifecycleEvent. Valore predefinito: None
|
Esempio
''<<>>python<< da 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 e-mail:
await context.send_activity(f"Received email: {email.id}")
'''<<>><<
Metodi
| __init__ | |
| __new__ | |
| on_agent_lifecycle_notification |
Registrare un gestore per le notifiche degli eventi del ciclo di vita dell'agente. Questo elemento decorator registra una funzione del gestore da chiamare quando si verificano eventi del ciclo di vita, ad esempio la creazione, l'eliminazione o l'onboarding del carico di lavoro. |
| on_agent_notification |
Registrare un gestore per le notifiche da un canale specifico e da un canale secondario. Questo elemento decorator registra una funzione del gestore da chiamare quando una notifica viene ricevuta dal canale specificato e dal canale secondario facoltativo. Il gestore riceverà un wrapper AgentNotificationActivity tipizzato. |
| on_email |
Registrare un gestore per le notifiche di posta elettronica di Outlook. Si tratta di un elemento decorator pratico che registra un gestore per le notifiche dal canale secondario di posta elettronica. |
| on_excel |
Registrare un gestore per le notifiche dei commenti di Microsoft Excel. Si tratta di un elemento decorator pratico che registra un gestore per le notifiche dal canale secondario di Excel. |
| on_lifecycle |
Registrare un gestore per tutte le notifiche degli eventi del ciclo di vita dell'agente. Si tratta di un elemento decorator pratico che registra un gestore per tutti gli eventi del ciclo di vita usando il matcher jolly "*". |
| on_powerpoint |
Registrare un gestore per le notifiche dei commenti di Microsoft PowerPoint. Si tratta di un elemento decorator pratico che registra un gestore per le notifiche dal canale secondario di PowerPoint. |
| on_user_created |
Registrare un gestore per gli eventi del ciclo di vita di creazione utente. Si tratta di un elemento decorator pratico che registra un gestore in modo specifico per gli eventi di creazione di identità utente agentic. |
| on_user_deleted |
Registrare un gestore per gli eventi del ciclo di vita di eliminazione utente. Si tratta di un elemento decorator pratico che registra un gestore specificamente per gli eventi di eliminazione dell'identità utente agentica. |
| on_user_workload_onboarding |
Registrare un gestore per gli eventi di aggiornamento dell'onboarding del carico di lavoro utente. Si tratta di un elemento Decorator pratico che registra un gestore per gli eventi che si verificano quando viene aggiornato lo stato di onboarding del carico di lavoro di un utente. |
| on_word |
Registrare un gestore per le notifiche di commento di Microsoft Word. Si tratta di un elemento decorator pratico che registra un gestore per le notifiche dal canale secondario di Word. |
__init__
__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)
Parametri
| Nome | Descrizione |
|---|---|
|
app
Necessario
|
|
|
known_subchannels
|
Valore predefinito: None
|
|
known_lifecycle_events
|
Valore predefinito: None
|
__new__
__new__(**kwargs)
on_agent_lifecycle_notification
Registrare un gestore per le notifiche degli eventi del ciclo di vita dell'agente.
Questo elemento decorator registra una funzione del gestore da chiamare quando si verificano eventi del ciclo di vita, ad esempio la creazione, l'eliminazione o l'onboarding del carico di lavoro.
on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)
Parametri
| Nome | Descrizione |
|---|---|
|
lifecycle_event
Necessario
|
Evento del ciclo di vita da ascoltare. Usare "*" per trovare la corrispondenza con tutti gli eventi del ciclo di vita o specificare un evento specifico di AgentLifecycleEvent. |
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>'<<python @notifications.on_agent_lifecycle_notification("agenticuseridentitycreated") async def handle_user_created(context, state, notification):
print("New user created")
'''<<>><<
on_agent_notification
Registrare un gestore per le notifiche da un canale specifico e da un canale secondario.
Questo elemento decorator registra una funzione del gestore da chiamare quando una notifica viene ricevuta dal canale specificato e dal canale secondario facoltativo. Il gestore riceverà un wrapper AgentNotificationActivity tipizzato.
on_agent_notification(channel_id: ChannelId, **kwargs: Any)
Parametri
| Nome | Descrizione |
|---|---|
|
channel_id
Necessario
|
ID canale che specifica il canale e il canale secondario facoltativo da ascoltare. Usare "*" come canale secondario per trovare tutte le sottocanale. |
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>><<python da 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"Notifica ricevuta in {notification.channel}/{notification.sub_channel}")
'''<<>><<
on_email
Registrare un gestore per le notifiche di posta elettronica di Outlook.
Si tratta di un elemento decorator pratico che registra un gestore per le notifiche dal canale secondario di posta elettronica.
on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametri
| Nome | Descrizione |
|---|---|
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
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]]]
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>'<<python @notifications.on_email() async def handle_email(context, state, notification):
email = notification.email se e-mail:
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
Registrare un gestore per le notifiche dei commenti di Microsoft Excel.
Si tratta di un elemento decorator pratico che registra un gestore per le notifiche dal canale secondario di Excel.
on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametri
| Nome | Descrizione |
|---|---|
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
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]]]
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>python<<@notifications.on_excel() async def handle_excel_comment(context, state, notification):
comment = notification.wpx_comment se commento:
print(f"Received Excel comment: {comment.comment_id}")
'''<<>><<
on_lifecycle
Registrare un gestore per tutte le notifiche degli eventi del ciclo di vita dell'agente.
Si tratta di un elemento decorator pratico che registra un gestore per tutti gli eventi del ciclo di vita usando il matcher jolly "*".
on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametri
| Nome | Descrizione |
|---|---|
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
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]]]
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>python<<@notifications.on_lifecycle() async def handle_any_lifecycle_event(context, state, notification):
print(f"Lifecycle event type: {notification.notification_type}")
'''<<>><<
on_powerpoint
Registrare un gestore per le notifiche dei commenti di Microsoft PowerPoint.
Si tratta di un elemento decorator pratico che registra un gestore per le notifiche dal canale secondario di PowerPoint.
on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametri
| Nome | Descrizione |
|---|---|
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
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]]]
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>python<<@notifications.on_powerpoint() async def handle_powerpoint_comment(context, state, notification):
comment = notification.wpx_comment se commento:
print(f"Received PowerPoint comment: {comment.comment_id}")
'''<<>><<
on_user_created
Registrare un gestore per gli eventi del ciclo di vita di creazione utente.
Si tratta di un elemento decorator pratico che registra un gestore in modo specifico per gli eventi di creazione di identità utente agentic.
on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametri
| Nome | Descrizione |
|---|---|
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
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]]]
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>python<<@notifications.on_user_created() async def handle_user_created(context, state, notification):
print("New agentic user identity created")
'''<<>><<
on_user_deleted
Registrare un gestore per gli eventi del ciclo di vita di eliminazione utente.
Si tratta di un elemento decorator pratico che registra un gestore specificamente per gli eventi di eliminazione dell'identità utente agentica.
on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametri
| Nome | Descrizione |
|---|---|
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
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]]]
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>python<<@notifications.on_user_deleted() async def handle_user_deleted(context, state, notification):
print("Agentec user identity deleted")
'''<<>><<
on_user_workload_onboarding
Registrare un gestore per gli eventi di aggiornamento dell'onboarding del carico di lavoro utente.
Si tratta di un elemento Decorator pratico che registra un gestore per gli eventi che si verificano quando viene aggiornato lo stato di onboarding del carico di lavoro di un utente.
on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametri
| Nome | Descrizione |
|---|---|
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
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]]]
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>python<<@notifications.on_user_workload_onboarding() async def handle_onboarding_update(context, state, notification):
print("Stato di onboarding del carico di lavoro utente aggiornato")
'''<<>><<
on_word
Registrare un gestore per le notifiche di commento di Microsoft Word.
Si tratta di un elemento decorator pratico che registra un gestore per le notifiche dal canale secondario di Word.
on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametri
| Nome | Descrizione |
|---|---|
|
**kwargs
Necessario
|
Argomenti di parole chiave aggiuntivi passati al metodo di add_route dell'app. |
Valori restituiti
| Tipo | Descrizione |
|---|---|
|
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]]]
|
Funzione decorator che registra il gestore con l'applicazione. |
Esempio
''<<>>'<<python @notifications.on_word() async def handle_word_comment(context, state, notification):
comment = notification.wpx_comment se commento:
print(f"Received Word comment: {comment.comment_id}")
'''<<>><<