AgentNotification Klass
Hanterare för agentmeddelanden från Microsoft 365-program.
Den här klassen tillhandahåller dekoratörer för att registrera hanterare som svarar på meddelanden från olika Microsoft 365-kanaler och underkanaler. Den stöder routning baserat på kanal-ID, underkanal och livscykelhändelser.
Konstruktor
AgentNotification()
Parametrar
| Name | Description |
|---|---|
|
app
Obligatorisk
|
Programinstansen som hanterar de dirigerade meddelandena. |
|
known_subchannels
|
Valfritt iterbart för identifierade underkanaler. Om ingen, är standard alla värden i AgentSubChannel-uppräkningen. Standardvärde: None
|
|
known_lifecycle_events
|
Valfritt iterbart för identifierade livscykelhändelser. Om ingen, är standard alla värden i AgentLifecycleEvent-uppräkningen. Standardvärde: None
|
Exempel
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}")
Metoder
| __init__ | |
| __new__ | |
| on_agent_lifecycle_notification |
Registrera en hanterare för meddelanden om agentens livscykelhändelser. Den här dekoratören registrerar en hanteringsfunktion som ska anropas när livscykelhändelser inträffar, till exempel uppdateringar av registrering av användare, borttagning eller arbetsbelastning. |
| on_agent_notification |
Registrera en hanterare för meddelanden från en specifik kanal och underkanal. Den här dekoratören registrerar en hanteringsfunktion som ska anropas när ett meddelande tas emot från den angivna kanalen och valfri underkanal. Hanteraren får en typinskriven AgentNotificationActivity-omslutning. |
| on_email |
Registrera en hanterare för e-postaviseringar i Outlook. Det här är en bekvämlighetsdekoratör som registrerar en hanterare för meddelanden från e-postunderkanalen. |
| on_excel |
Registrera en hanterare för Microsoft Excel-kommentarsaviseringar. Det här är en bekvämlighetsdekoratör som registrerar en hanterare för meddelanden från Excel-underkanalen. |
| on_lifecycle |
Registrera en hanterare för alla meddelanden om agentens livscykelhändelser. Det här är en bekvämlighetsdekoratör som registrerar en hanterare för alla livscykelhändelser med jokertecknet "*" matchare. |
| on_powerpoint |
Registrera en hanterare för Microsoft PowerPoint-kommentarsaviseringar. Det här är en bekvämlighetsdekoratör som registrerar en hanterare för meddelanden från PowerPoint-underkanalen. |
| on_user_created |
Registrera en hanterare för livscykelhändelser för användarskapande. Det här är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för händelser för att skapa agentiska användaridentiteter. |
| on_user_deleted |
Registrera en hanterare för livscykelhändelser för borttagning av användare. Det här är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för borttagningshändelser för agentiska användaridentiteter. |
| on_user_disabled |
Registrera en hanterare för användaraktivering av livscykelhändelser. Detta är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för agentiska användaraktiveringshändelser. |
| on_user_enabled |
Registrera en hanterare för användaraktiverade livscykelhändelser. Detta är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för agentiska användaraktiverade händelser. |
| on_user_manager_updated |
Registrera en hanterare för användarhanteraren uppdaterade livscykelhändelser. Det här är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för uppdaterade händelser för agentisk användarhanterare. |
| on_user_undeleted |
Registrera en hanterare för användarens livscykelhändelser som inte tas bort. Detta är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för agentiska användaridentiteter som inte tas bort. |
| on_user_updated |
Registrera en hanterare för användarupp uppdaterade livscykelhändelser. Detta är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för uppdaterade händelser för agentisk användaridentitet. |
| on_user_workload_onboarding |
Registrera en hanterare för användararbetsbelastningsregistrering av uppdateringshändelser. Det här är en bekvämlighetsdekoratör som registrerar en hanterare för händelser som inträffar när en användares registreringsstatus för arbetsbelastning uppdateras. |
| on_word |
Registrera en hanterare för Microsoft Word-kommentarsaviseringar. Det här är en bekvämlighetsdekoratör som registrerar en hanterare för meddelanden från Word-underkanalen. |
__init__
__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)
Parametrar
| Name | Description |
|---|---|
|
app
Obligatorisk
|
|
|
known_subchannels
|
Standardvärde: None
|
|
known_lifecycle_events
|
Standardvärde: None
|
__new__
__new__(**kwargs)
on_agent_lifecycle_notification
Registrera en hanterare för meddelanden om agentens livscykelhändelser.
Den här dekoratören registrerar en hanteringsfunktion som ska anropas när livscykelhändelser inträffar, till exempel uppdateringar av registrering av användare, borttagning eller arbetsbelastning.
on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)
Parametrar
| Name | Description |
|---|---|
|
lifecycle_event
Obligatorisk
|
Livscykelhändelsen att lyssna efter. Använd "*" för att matcha alla livscykelhändelser eller ange en specifik händelse från AgentLifecycleEvent. |
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | Description |
|---|---|
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@notifications.on_agent_lifecycle_notification("agenticuseridentitycreated")
async def handle_user_created(context, state, notification):
print("New user created")
on_agent_notification
Registrera en hanterare för meddelanden från en specifik kanal och underkanal.
Den här dekoratören registrerar en hanteringsfunktion som ska anropas när ett meddelande tas emot från den angivna kanalen och valfri underkanal. Hanteraren får en typinskriven AgentNotificationActivity-omslutning.
on_agent_notification(channel_id: ChannelId, **kwargs: Any)
Parametrar
| Name | Description |
|---|---|
|
channel_id
Obligatorisk
|
Kanal-ID:t som anger kanalen och valfri underkanal att lyssna efter. Använd "*" som underkanal för att matcha alla underkanaler. |
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | Description |
|---|---|
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
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
Registrera en hanterare för e-postaviseringar i Outlook.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare för meddelanden från e-postunderkanalen.
on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@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
Registrera en hanterare för Microsoft Excel-kommentarsaviseringar.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare för meddelanden från Excel-underkanalen.
on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@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
Registrera en hanterare för alla meddelanden om agentens livscykelhändelser.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare för alla livscykelhändelser med jokertecknet "*" matchare.
on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@notifications.on_lifecycle()
async def handle_any_lifecycle_event(context, state, notification):
print(f"Lifecycle event type: {notification.notification_type}")
on_powerpoint
Registrera en hanterare för Microsoft PowerPoint-kommentarsaviseringar.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare för meddelanden från PowerPoint-underkanalen.
on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@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
Registrera en hanterare för livscykelhändelser för användarskapande.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för händelser för att skapa agentiska användaridentiteter.
on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@notifications.on_user_created()
async def handle_user_created(context, state, notification):
print("New agentic user identity created")
on_user_deleted
Registrera en hanterare för livscykelhändelser för borttagning av användare.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för borttagningshändelser för agentiska användaridentiteter.
on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@notifications.on_user_deleted()
async def handle_user_deleted(context, state, notification):
print("Agentic user identity deleted")
on_user_disabled
Registrera en hanterare för användaraktivering av livscykelhändelser.
Detta är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för agentiska användaraktiveringshändelser.
on_user_disabled(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
'''<<>>Python @notifications.on_user_disabled()<<async def handle_user_disabled(context, state, notification):
print("Agentic user disabled")
''<<>>'<<
on_user_enabled
Registrera en hanterare för användaraktiverade livscykelhändelser.
Detta är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för agentiska användaraktiverade händelser.
on_user_enabled(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
'''<<>>Python @notifications.on_user_enabled()<<async def handle_user_enabled(context, state, notification):
print("Agentic user enabled")
''<<>>'<<
on_user_manager_updated
Registrera en hanterare för användarhanteraren uppdaterade livscykelhändelser.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för uppdaterade händelser för agentisk användarhanterare.
on_user_manager_updated(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
'''<<>>Python @notifications.on_user_manager_updated()<<async def handle_user_manager_updated(context, state, notification):
print("Agentic user manager updated")
''<<>>'<<
on_user_undeleted
Registrera en hanterare för användarens livscykelhändelser som inte tas bort.
Detta är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för agentiska användaridentiteter som inte tas bort.
on_user_undeleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
'''<<>>Python @notifications.on_user_undeleted()<<async def handle_user_undeleted(context, state, notification):
print("Agentic user identity un-deleted")
''<<>>'<<
on_user_updated
Registrera en hanterare för användarupp uppdaterade livscykelhändelser.
Detta är en bekvämlighetsdekoratör som registrerar en hanterare specifikt för uppdaterade händelser för agentisk användaridentitet.
on_user_updated(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
'''<<>><<Python @notifications.on_user_updated() async def handle_user_updated(context, state, notification):
print("Agentic user identity updated")
''<<>>'<<
on_user_workload_onboarding
Registrera en hanterare för användararbetsbelastningsregistrering av uppdateringshändelser.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare för händelser som inträffar när en användares registreringsstatus för arbetsbelastning uppdateras.
on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@notifications.on_user_workload_onboarding()
async def handle_onboarding_update(context, state, notification):
print("User workload onboarding status updated")
on_word
Registrera en hanterare för Microsoft Word-kommentarsaviseringar.
Det här är en bekvämlighetsdekoratör som registrerar en hanterare för meddelanden från Word-underkanalen.
on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametrar
| Name | Description |
|---|---|
|
**kwargs
Obligatorisk
|
Ytterligare nyckelordsargument skickas till appens add_route-metod. |
Returer
| Typ | 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]]]
|
En dekoratörsfunktion som registrerar hanteraren med programmet. |
Exempel
@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}")