AgentNotification Klas
Handler voor agentmeldingen van Microsoft 365-toepassingen.
Deze klasse biedt decorators voor het registreren van handlers die reageren op meldingen van verschillende Microsoft 365-kanalen en subkanalen. Het biedt ondersteuning voor routering op basis van kanaal-id-, subkanaal- en levenscyclusgebeurtenissen.
Constructor
AgentNotification()
Parameters
| Name | Description |
|---|---|
|
app
Vereist
|
Het toepassingsexemplaren waarmee de gerouteerde meldingen worden verwerkt. |
|
known_subchannels
|
Optioneel itereerbaar van herkende subkanalen. Als geen, wordt standaard ingesteld op alle waarden in de enum AgentSubChannel. Default value: None
|
|
known_lifecycle_events
|
Optioneel itereerbaar van herkende levenscyclus-gebeurtenissen. Als geen, wordt standaard alle waarden in de AgentLifecycleEvent enum ingesteld. Default value: None
|
Voorbeelden
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}")
Methoden
| __init__ | |
| __new__ | |
| on_agent_lifecycle_notification |
Registreer een handler voor gebeurtenismeldingen voor de levenscyclus van agents. Deze decorator registreert een handler-functie die moet worden aangeroepen wanneer er levenscyclus-gebeurtenissen plaatsvinden, zoals het maken, verwijderen of onboarden van workloads. |
| on_agent_notification |
Registreer een handler voor meldingen van een specifiek kanaal en subkanaal. Deze decorator registreert een handler-functie die moet worden aangeroepen wanneer een melding wordt ontvangen van het opgegeven kanaal en optionele subkanaal. De handler ontvangt een getypte AgentNotificationActivity-wrapper. |
| on_email |
Registreer een handler voor e-mailmeldingen van Outlook. Dit is een handige decorator die een handler registreert voor meldingen van het e-mailsubkanaal. |
| on_excel |
Registreer een handler voor opmerkingenmeldingen van Microsoft Excel. Dit is een handige decorator die een handler registreert voor meldingen van het Excel-subkanaal. |
| on_lifecycle |
Registreer een handler voor alle meldingen over de levenscyclus van agents. Dit is een handige decorator die een handler registreert voor alle levenscyclus-gebeurtenissen met behulp van de jokerteken '*'-matcher. |
| on_powerpoint |
Registreer een handler voor opmerkingenmeldingen van Microsoft PowerPoint. Dit is een handige decorator die een handler registreert voor meldingen van het PowerPoint-subkanaal. |
| on_user_created |
Registreer een handler voor levenscyclus-gebeurtenissen voor het maken van gebruikers. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het maken van agentische gebruikersidentiteiten. |
| on_user_deleted |
Registreer een handler voor levenscyclus-gebeurtenissen voor het verwijderen van gebruikers. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het verwijderen van agentische gebruikersidentiteiten. |
| on_user_workload_onboarding |
Registreer een handler voor onboarding van update-gebeurtenissen voor gebruikersworkloads. Dit is een handige decorator die een handler registreert voor gebeurtenissen die optreden wanneer de onboardingstatus van een gebruiker wordt bijgewerkt. |
| on_word |
Registreer een handler voor opmerkingenmeldingen van Microsoft Word. Dit is een handige decorator die een handler registreert voor meldingen van het Word-subkanaal. |
__init__
__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)
Parameters
| Name | Description |
|---|---|
|
app
Vereist
|
|
|
known_subchannels
|
Default value: None
|
|
known_lifecycle_events
|
Default value: None
|
__new__
__new__(**kwargs)
on_agent_lifecycle_notification
Registreer een handler voor gebeurtenismeldingen voor de levenscyclus van agents.
Deze decorator registreert een handler-functie die moet worden aangeroepen wanneer er levenscyclus-gebeurtenissen plaatsvinden, zoals het maken, verwijderen of onboarden van workloads.
on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)
Parameters
| Name | Description |
|---|---|
|
lifecycle_event
Vereist
|
De levenscyclus-gebeurtenis om naar te luisteren. Gebruik *om alle levenscyclus-gebeurtenissen te vinden of geef een specifieke gebeurtenis op van AgentLifecycleEvent. |
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| Type | Description |
|---|---|
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@notifications.on_agent_lifecycle_notification("agenticuseridentitycreated")
async def handle_user_created(context, state, notification):
print("New user created")
on_agent_notification
Registreer een handler voor meldingen van een specifiek kanaal en subkanaal.
Deze decorator registreert een handler-functie die moet worden aangeroepen wanneer een melding wordt ontvangen van het opgegeven kanaal en optionele subkanaal. De handler ontvangt een getypte AgentNotificationActivity-wrapper.
on_agent_notification(channel_id: ChannelId, **kwargs: Any)
Parameters
| Name | Description |
|---|---|
|
channel_id
Vereist
|
De kanaal-id waarmee het kanaal en optionele subkanaal worden opgegeven om naar te luisteren. Gebruik *als subkanaal om alle subkanalen te vinden. |
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| Type | Description |
|---|---|
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
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
Registreer een handler voor e-mailmeldingen van Outlook.
Dit is een handige decorator die een handler registreert voor meldingen van het e-mailsubkanaal.
on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parameters
| Name | Description |
|---|---|
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| 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]]]
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@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
Registreer een handler voor opmerkingenmeldingen van Microsoft Excel.
Dit is een handige decorator die een handler registreert voor meldingen van het Excel-subkanaal.
on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parameters
| Name | Description |
|---|---|
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| 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]]]
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@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
Registreer een handler voor alle meldingen over de levenscyclus van agents.
Dit is een handige decorator die een handler registreert voor alle levenscyclus-gebeurtenissen met behulp van de jokerteken '*'-matcher.
on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parameters
| Name | Description |
|---|---|
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| 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]]]
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@notifications.on_lifecycle()
async def handle_any_lifecycle_event(context, state, notification):
print(f"Lifecycle event type: {notification.notification_type}")
on_powerpoint
Registreer een handler voor opmerkingenmeldingen van Microsoft PowerPoint.
Dit is een handige decorator die een handler registreert voor meldingen van het PowerPoint-subkanaal.
on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parameters
| Name | Description |
|---|---|
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| 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]]]
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@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
Registreer een handler voor levenscyclus-gebeurtenissen voor het maken van gebruikers.
Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het maken van agentische gebruikersidentiteiten.
on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parameters
| Name | Description |
|---|---|
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| 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]]]
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@notifications.on_user_created()
async def handle_user_created(context, state, notification):
print("New agentic user identity created")
on_user_deleted
Registreer een handler voor levenscyclus-gebeurtenissen voor het verwijderen van gebruikers.
Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het verwijderen van agentische gebruikersidentiteiten.
on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parameters
| Name | Description |
|---|---|
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| 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]]]
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@notifications.on_user_deleted()
async def handle_user_deleted(context, state, notification):
print("Agentic user identity deleted")
on_user_workload_onboarding
Registreer een handler voor onboarding van update-gebeurtenissen voor gebruikersworkloads.
Dit is een handige decorator die een handler registreert voor gebeurtenissen die optreden wanneer de onboardingstatus van een gebruiker wordt bijgewerkt.
on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parameters
| Name | Description |
|---|---|
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| 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]]]
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@notifications.on_user_workload_onboarding()
async def handle_onboarding_update(context, state, notification):
print("User workload onboarding status updated")
on_word
Registreer een handler voor opmerkingenmeldingen van Microsoft Word.
Dit is een handige decorator die een handler registreert voor meldingen van het Word-subkanaal.
on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parameters
| Name | Description |
|---|---|
|
**kwargs
Vereist
|
Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app. |
Retouren
| 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]]]
|
Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing. |
Voorbeelden
@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}")