AgentNotification Třída

Obslužná rutina pro oznámení agenta z aplikací Microsoftu 365

Tato třída poskytuje dekorátory pro registraci obslužných rutin, které reagují na oznámení z různých kanálů Microsoftu 365 a podkanály. Podporuje směrování na základě ID kanálu, dílčího kanálu a událostí životního cyklu.

Konstruktor

AgentNotification()

Parametry

Name	Description
app Vyžadováno	Instance aplikace, která bude zpracovávat směrovaná oznámení.
known_subchannels	Volitelné iterovatelné rozpoznané podkanály. Pokud none, výchozí hodnoty ve výčtu AgentSubChannel. Default value: None
known_lifecycle_events	Volitelné iterace rozpoznaných událostí životního cyklu. Pokud None, výchozí hodnoty ve výčtu AgentLifecycleEvent. Default value: None

Příklady

   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}")

Metody

__init__
__new__
on_agent_lifecycle_notification	Zaregistrujte obslužnou rutinu pro oznámení událostí životního cyklu agenta. Tento dekorátor zaregistruje funkci obslužné rutiny, která se má volat, když dojde k událostem životního cyklu, jako je vytvoření uživatele, odstranění nebo aktualizace onboardingu úloh.
on_agent_notification	Zaregistrujte obslužnou rutinu pro oznámení z konkrétního kanálu a dílčího kanálu. Tento dekorátor zaregistruje funkci obslužné rutiny, která se má volat při přijetí oznámení ze zadaného kanálu a volitelného podkanálu. Obslužná rutina obdrží typový obálku AgentNotificationActivity.
on_email	Zaregistrujte obslužnou rutinu pro e-mailová oznámení Outlooku. Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu pro oznámení z podkanálu e-mailu.
on_excel	Zaregistrujte obslužnou rutinu pro oznámení komentářů aplikace Microsoft Excel. Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu pro oznámení z podkanálové aplikace Excel.
on_lifecycle	Zaregistrujte obslužnou rutinu pro všechna oznámení o událostech životního cyklu agenta. Toto je dekorátor pohodlí, který zaregistruje obslužnou rutinu pro všechny události životního cyklu pomocí zástupné znamény "*".
on_powerpoint	Zaregistrujte obslužnou rutinu pro oznámení komentářů Microsoft PowerPointu. Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu pro oznámení z podkanálu PowerPointu.
on_user_created	Zaregistrujte obslužnou rutinu pro události životního cyklu vytváření uživatelů. Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu speciálně pro události vytváření identit uživatele agentů.
on_user_deleted	Zaregistrujte obslužnou rutinu pro události životního cyklu odstranění uživatele. Toto je popisovač pohodlí, který zaregistruje obslužnou rutinu speciálně pro události odstranění identity agenta uživatele.
on_user_workload_onboarding	Zaregistrujte obslužnou rutinu pro události aktualizace připojování úloh uživatele. Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu událostí, ke kterým dochází při aktualizaci stavu onboardingu úloh uživatele.
on_word	Zaregistrujte obslužnou rutinu pro oznámení komentářů aplikace Microsoft Word. Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu pro oznámení z podkanálové aplikace Word.

__init__

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

Parametry

Name	Description
app Vyžadováno	Any
known_subchannels	Iterable[str | AgentSubChannel] | None Default value: None
known_lifecycle_events	Iterable[str | AgentLifecycleEvent] | None Default value: None

__new__

__new__(**kwargs)

on_agent_lifecycle_notification

Zaregistrujte obslužnou rutinu pro oznámení událostí životního cyklu agenta.

Tento dekorátor zaregistruje funkci obslužné rutiny, která se má volat, když dojde k událostem životního cyklu, jako je vytvoření uživatele, odstranění nebo aktualizace onboardingu úloh.

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

Parametry

Name	Description
lifecycle_event Vyžadováno	str Událost životního cyklu, která se má naslouchat. Ke shodě všech událostí životního cyklu použijte *nebo zadejte konkrétní událost z agentaLifecycleEvent.
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

Typ	Description
	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   @notifications.on_agent_lifecycle_notification("agenticuseridentitycreated")
   async def handle_user_created(context, state, notification):
       print("New user created")

on_agent_notification

Zaregistrujte obslužnou rutinu pro oznámení z konkrétního kanálu a dílčího kanálu.

Tento dekorátor zaregistruje funkci obslužné rutiny, která se má volat při přijetí oznámení ze zadaného kanálu a volitelného podkanálu. Obslužná rutina obdrží typový obálku AgentNotificationActivity.

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

Parametry

Name	Description
channel_id Vyžadováno	ChannelId ID kanálu určující kanál a volitelný dílčí kanál, který se má naslouchat. Jako podkanál použijte "*", aby se shodovaly se všemi podkanály.
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

Typ	Description
	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   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

Zaregistrujte obslužnou rutinu pro e-mailová oznámení Outlooku.

Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu pro oznámení z podkanálu e-mailu.

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

Parametry

Name	Description
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

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]]]	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   @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

Zaregistrujte obslužnou rutinu pro oznámení komentářů aplikace Microsoft Excel.

Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu pro oznámení z podkanálové aplikace Excel.

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

Parametry

Name	Description
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

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]]]	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   @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

Zaregistrujte obslužnou rutinu pro všechna oznámení o událostech životního cyklu agenta.

Toto je dekorátor pohodlí, který zaregistruje obslužnou rutinu pro všechny události životního cyklu pomocí zástupné znamény "*".

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

Parametry

Name	Description
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

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]]]	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   @notifications.on_lifecycle()
   async def handle_any_lifecycle_event(context, state, notification):
       print(f"Lifecycle event type: {notification.notification_type}")

on_powerpoint

Zaregistrujte obslužnou rutinu pro oznámení komentářů Microsoft PowerPointu.

Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu pro oznámení z podkanálu PowerPointu.

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

Parametry

Name	Description
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

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]]]	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   @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

Zaregistrujte obslužnou rutinu pro události životního cyklu vytváření uživatelů.

Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu speciálně pro události vytváření identit uživatele agentů.

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

Parametry

Name	Description
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

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]]]	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   @notifications.on_user_created()
   async def handle_user_created(context, state, notification):
       print("New agentic user identity created")

on_user_deleted

Zaregistrujte obslužnou rutinu pro události životního cyklu odstranění uživatele.

Toto je popisovač pohodlí, který zaregistruje obslužnou rutinu speciálně pro události odstranění identity agenta uživatele.

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

Parametry

Name	Description
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

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]]]	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   @notifications.on_user_deleted()
   async def handle_user_deleted(context, state, notification):
       print("Agentic user identity deleted")

on_user_workload_onboarding

Zaregistrujte obslužnou rutinu pro události aktualizace připojování úloh uživatele.

Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu událostí, ke kterým dochází při aktualizaci stavu onboardingu úloh uživatele.

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

Parametry

Name	Description
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

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]]]	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

   @notifications.on_user_workload_onboarding()
   async def handle_onboarding_update(context, state, notification):
       print("User workload onboarding status updated")

on_word

Zaregistrujte obslužnou rutinu pro oznámení komentářů aplikace Microsoft Word.

Jedná se o popisovač pohodlí, který zaregistruje obslužnou rutinu pro oznámení z podkanálové aplikace Word.

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

Parametry

Name	Description
**kwargs Vyžadováno	Any Další argumenty klíčových slov předané metodě add_route aplikace.

Návraty

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]]]	Funkce dekorátoru, která zaregistruje obslužnou rutinu v aplikaci.

Příklady

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