AgentNotification Klasse

Handler für Agentbenachrichtigungen von Microsoft 365-Anwendungen.

Diese Klasse stellt Dekoratoren zum Registrieren von Handlern bereit, die auf Benachrichtigungen aus verschiedenen Microsoft 365-Kanälen und -Unterkanälen reagieren. Es unterstützt das Routing basierend auf Kanal-ID, Subchannel- und Lebenszyklusereignissen.

Konstruktor

AgentNotification()

Parameter

Name Beschreibung
app
Erforderlich

Die Anwendungsinstanz, die die routingierten Benachrichtigungen behandelt.

known_subchannels

Optionaler Iterable von erkannten Unterkanälen. If None, default to all values in the AgentSubChannel enum.

Standardwert: None
known_lifecycle_events

Optionaler Iterable of recognized lifecycle events. If None, default to all values in the AgentLifecycleEvent enum.

Standardwert: None

Beispiele

''<<>><<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 wenn E-Mail:

  await context.send_activity(f"Received email: {email.id}")

'''<<>><<

Methoden

__init__
__new__
on_agent_lifecycle_notification

Registrieren Sie einen Handler für Agent-Lebenszyklusereignisbenachrichtigungen.

Dieser Dekorateur registriert eine Handlerfunktion, die aufgerufen wird, wenn Lebenszyklusereignisse auftreten, z. B. Benutzererstellungs-, Lösch- oder Workload-Onboarding-Updates.

on_agent_notification

Registrieren Sie einen Handler für Benachrichtigungen aus einem bestimmten Kanal und Unterkanal.

Dieser Dekorateur registriert eine Handlerfunktion, die aufgerufen werden soll, wenn eine Benachrichtigung vom angegebenen Kanal und optionalen Unterkanal empfangen wird. Der Handler erhält einen typierten AgentNotificationActivity-Wrapper.

on_email

Registrieren Sie einen Handler für Outlook-E-Mail-Benachrichtigungen.

Dies ist ein Komfortdekoror, der einen Handler für Benachrichtigungen aus dem E-Mail-Unterkanal registriert.

on_excel

Registrieren Sie einen Handler für Microsoft Excel-Kommentarbenachrichtigungen.

Dies ist ein Komfortdekoror, der einen Handler für Benachrichtigungen aus dem Excel-Unterkanal registriert.

on_lifecycle

Registrieren Sie einen Handler für alle Agent-Lebenszyklusereignisbenachrichtigungen.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler für alle Lebenszyklusereignisse mithilfe des Wildcard-Matchers "*" registriert.

on_powerpoint

Registrieren Sie einen Handler für Microsoft PowerPoint-Kommentarbenachrichtigungen.

Dies ist ein Komfortdekoror, der einen Handler für Benachrichtigungen aus dem PowerPoint-Unterkanal registriert.

on_user_created

Registrieren Sie einen Handler für Benutzererstellungslebenszyklusereignisse.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler speziell für agentische Benutzeridentitätserstellungsereignisse registriert.

on_user_deleted

Registrieren Sie einen Handler für Benutzerlöschlebenszyklusereignisse.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler speziell für agentische Benutzeridentitätslöschereignisse registriert.

on_user_workload_onboarding

Registrieren Sie einen Handler für Onboarding-Updateereignisse für die Benutzerarbeitsauslastung.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler für Ereignisse registriert, die auftreten, wenn der Workload-Onboarding-Status eines Benutzers aktualisiert wird.

on_word

Registrieren sie einen Handler für Microsoft Word-Kommentarbenachrichtigungen.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler für Benachrichtigungen aus dem Word-Unterkanal registriert.

__init__

__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)

Parameter

Name Beschreibung
app
Erforderlich
Any
known_subchannels
Standardwert: None
known_lifecycle_events
Standardwert: None

__new__

__new__(**kwargs)

on_agent_lifecycle_notification

Registrieren Sie einen Handler für Agent-Lebenszyklusereignisbenachrichtigungen.

Dieser Dekorateur registriert eine Handlerfunktion, die aufgerufen wird, wenn Lebenszyklusereignisse auftreten, z. B. Benutzererstellungs-, Lösch- oder Workload-Onboarding-Updates.

on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)

Parameter

Name Beschreibung
lifecycle_event
Erforderlich
str

Das Lebenszyklusereignis, auf das gewartet werden soll. Verwenden Sie "*", um alle Lebenszyklusereignisse abzugleichen, oder geben Sie ein bestimmtes Ereignis aus AgentLifecycleEvent an.

**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>><<python @notifications.on_agent_lifecycle_notification("agenticuseridentitycreated") async def handle_user_created(context, state, notification):

print("Neuer Benutzer erstellt")

'''<<>><<

on_agent_notification

Registrieren Sie einen Handler für Benachrichtigungen aus einem bestimmten Kanal und Unterkanal.

Dieser Dekorateur registriert eine Handlerfunktion, die aufgerufen werden soll, wenn eine Benachrichtigung vom angegebenen Kanal und optionalen Unterkanal empfangen wird. Der Handler erhält einen typierten AgentNotificationActivity-Wrapper.

on_agent_notification(channel_id: ChannelId, **kwargs: Any)

Parameter

Name Beschreibung
channel_id
Erforderlich

Die Kanal-ID, die den Kanal und optionalen Unterkanal angibt, auf den lauschen soll. Verwenden Sie "*" als Unterkanal, um alle Unterkanäle abzugleichen.

**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>><<python aus 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

Registrieren Sie einen Handler für Outlook-E-Mail-Benachrichtigungen.

Dies ist ein Komfortdekoror, der einen Handler für Benachrichtigungen aus dem E-Mail-Unterkanal registriert.

on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

Parameter

Name Beschreibung
**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung
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]]]

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>>'<<python @notifications.on_email() async def handle_email(context, state, notification):

email = notification.email wenn 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

Registrieren Sie einen Handler für Microsoft Excel-Kommentarbenachrichtigungen.

Dies ist ein Komfortdekoror, der einen Handler für Benachrichtigungen aus dem Excel-Unterkanal registriert.

on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

Parameter

Name Beschreibung
**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung
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]]]

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>><<python @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

Registrieren Sie einen Handler für alle Agent-Lebenszyklusereignisbenachrichtigungen.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler für alle Lebenszyklusereignisse mithilfe des Wildcard-Matchers "*" registriert.

on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

Parameter

Name Beschreibung
**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung
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]]]

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

'''<<>><<python @notifications.on_lifecycle() async def handle_any_lifecycle_event(context, state, notification):

print(f"Lifecycle-Ereignistyp: {notification.notification_type}")

'''<<>><<

on_powerpoint

Registrieren Sie einen Handler für Microsoft PowerPoint-Kommentarbenachrichtigungen.

Dies ist ein Komfortdekoror, der einen Handler für Benachrichtigungen aus dem PowerPoint-Unterkanal registriert.

on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

Parameter

Name Beschreibung
**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung
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]]]

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>>python<<@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

Registrieren Sie einen Handler für Benutzererstellungslebenszyklusereignisse.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler speziell für agentische Benutzeridentitätserstellungsereignisse registriert.

on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

Parameter

Name Beschreibung
**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung
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]]]

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>><<python @notifications.on_user_created() async def handle_user_created(context, state, notification):

print("Neue agentische Benutzeridentität erstellt")

'''<<>><<

on_user_deleted

Registrieren Sie einen Handler für Benutzerlöschlebenszyklusereignisse.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler speziell für agentische Benutzeridentitätslöschereignisse registriert.

on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

Parameter

Name Beschreibung
**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung
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]]]

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>>'<<python @notifications.on_user_deleted() async def handle_user_deleted(context, state, notification):

print("Agentic user identity deleted")

'''<<>><<

on_user_workload_onboarding

Registrieren Sie einen Handler für Onboarding-Updateereignisse für die Benutzerarbeitsauslastung.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler für Ereignisse registriert, die auftreten, wenn der Workload-Onboarding-Status eines Benutzers aktualisiert wird.

on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

Parameter

Name Beschreibung
**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung
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]]]

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>>'<<python @notifications.on_user_workload_onboarding() async def handle_onboarding_update(context, state, notification):

print("Onboardingstatus der Benutzerarbeitsauslastung aktualisiert")

'''<<>><<

on_word

Registrieren sie einen Handler für Microsoft Word-Kommentarbenachrichtigungen.

Dies ist ein Benutzerfreundlichkeitsdekoror, der einen Handler für Benachrichtigungen aus dem Word-Unterkanal registriert.

on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

Parameter

Name Beschreibung
**kwargs
Erforderlich
Any

Zusätzliche Schlüsselwortargumente, die an die add_route-Methode der App übergeben werden.

Gibt zurück

Typ Beschreibung
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]]]

Eine Dekorateurfunktion, die den Handler bei der Anwendung registriert.

Beispiele

''<<>>'<<python @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}")

'''<<>><<