AgentNotification Klasa

Procedura obsługi powiadomień agenta z aplikacji platformy Microsoft 365.

Ta klasa udostępnia dekoratory do rejestrowania programów obsługi, które odpowiadają na powiadomienia z różnych kanałów i podkanałów platformy Microsoft 365. Obsługuje routing na podstawie identyfikatora kanału, podkanałów i zdarzeń cyklu życia.

Konstruktor

AgentNotification()

Parametry

Nazwa	Opis
app Wymagane	Wystąpienie aplikacji, które będzie obsługiwać kierowane powiadomienia.
known_subchannels	Opcjonalne iteracje rozpoznanych podkanałów. Jeśli brak, wartość domyślna to wszystkie wartości w wyliczenie AgentSubChannel. Domyślna wartość: None
known_lifecycle_events	Opcjonalne iterable rozpoznanych zdarzeń cyklu życia. Jeśli brak, wartość domyślna to wszystkie wartości w wyliczenie AgentLifecycleEvent. Domyślna wartość: None

Przykłady

   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	Rejestrowanie programu obsługi powiadomień o zdarzeniach cyklu życia agenta. Ten dekorator rejestruje funkcję obsługi, która ma być wywoływana w przypadku wystąpienia zdarzeń cyklu życia, takich jak tworzenie, usuwanie lub dołączanie obciążeń.
on_agent_notification	Zarejestruj procedurę obsługi powiadomień z określonego kanału i podkanału. Ten dekorator rejestruje funkcję obsługi, która ma być wywoływana po odebraniu powiadomienia z określonego kanału i opcjonalnego podkanału. Procedura obsługi otrzyma wpisaną otokę AgentNotificationActivity.
on_email	Zarejestruj procedurę obsługi powiadomień e-mail programu Outlook. Jest to dekorator wygody, który rejestruje program obsługi powiadomień z podkanałów poczty e-mail.
on_excel	Zarejestruj procedurę obsługi powiadomień o komentarzach programu Microsoft Excel. Jest to dekorator wygody, który rejestruje program obsługi powiadomień z podkanału programu Excel.
on_lifecycle	Zarejestruj procedurę obsługi dla wszystkich powiadomień o zdarzeniach cyklu życia agenta. Jest to dekorator wygody, który rejestruje procedurę obsługi dla wszystkich zdarzeń cyklu życia przy użyciu symbolu wieloznakowego "*" matcher.
on_powerpoint	Zarejestruj procedurę obsługi powiadomień o komentarzach programu Microsoft PowerPoint. Jest to wygodny dekorator, który rejestruje program obsługi powiadomień z podkanału programu PowerPoint.
on_user_created	Zarejestruj procedurę obsługi zdarzeń cyklu życia tworzenia użytkownika. Jest to dekorator wygody, który rejestruje program obsługi specjalnie dla zdarzeń tworzenia tożsamości użytkownika agenta.
on_user_deleted	Zarejestruj procedurę obsługi zdarzeń cyklu życia usuwania użytkownika. Jest to dekorator wygody, który rejestruje program obsługi specjalnie dla zdarzeń usuwania tożsamości użytkownika agenta.
on_user_workload_onboarding	Zarejestruj procedurę obsługi zdarzeń aktualizacji dołączania obciążenia użytkownika. Jest to wygodny dekorator, który rejestruje program obsługi zdarzeń występujących po zaktualizowaniu stanu dołączania obciążenia użytkownika.
on_word	Zarejestruj procedurę obsługi powiadomień o komentarzach programu Microsoft Word. Jest to dekorator wygody, który rejestruje program obsługi powiadomień z podkanałów programu Word.

__init__

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

Parametry

Nazwa	Opis
app Wymagane	Any
known_subchannels	Iterable[str | AgentSubChannel] | None Domyślna wartość: None
known_lifecycle_events	Iterable[str | AgentLifecycleEvent] | None Domyślna wartość: None

__new__

__new__(**kwargs)

on_agent_lifecycle_notification

Rejestrowanie programu obsługi powiadomień o zdarzeniach cyklu życia agenta.

Ten dekorator rejestruje funkcję obsługi, która ma być wywoływana w przypadku wystąpienia zdarzeń cyklu życia, takich jak tworzenie, usuwanie lub dołączanie obciążeń.

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

Parametry

Nazwa	Opis
lifecycle_event Wymagane	str Zdarzenie cyklu życia do nasłuchiwania. Użyj wartości "*", aby dopasować wszystkie zdarzenia cyklu życia lub określić określone zdarzenie z elementu AgentLifecycleEvent.
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

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

on_agent_notification

Zarejestruj procedurę obsługi powiadomień z określonego kanału i podkanału.

Ten dekorator rejestruje funkcję obsługi, która ma być wywoływana po odebraniu powiadomienia z określonego kanału i opcjonalnego podkanału. Procedura obsługi otrzyma wpisaną otokę AgentNotificationActivity.

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

Parametry

Nazwa	Opis
channel_id Wymagane	ChannelId Identyfikator kanału określający kanał i opcjonalny podkanał do nasłuchiwania. Użyj ciągu "*" jako podkanałka, aby dopasować wszystkie podkanały.
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

   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

Zarejestruj procedurę obsługi powiadomień e-mail programu Outlook.

Jest to dekorator wygody, który rejestruje program obsługi powiadomień z podkanałów poczty e-mail.

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

Parametry

Nazwa	Opis
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
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]]]	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

   @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

Zarejestruj procedurę obsługi powiadomień o komentarzach programu Microsoft Excel.

Jest to dekorator wygody, który rejestruje program obsługi powiadomień z podkanału programu Excel.

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

Parametry

Nazwa	Opis
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
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]]]	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

   @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

Zarejestruj procedurę obsługi dla wszystkich powiadomień o zdarzeniach cyklu życia agenta.

Jest to dekorator wygody, który rejestruje procedurę obsługi dla wszystkich zdarzeń cyklu życia przy użyciu symbolu wieloznakowego "*" matcher.

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

Parametry

Nazwa	Opis
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
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]]]	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

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

on_powerpoint

Zarejestruj procedurę obsługi powiadomień o komentarzach programu Microsoft PowerPoint.

Jest to wygodny dekorator, który rejestruje program obsługi powiadomień z podkanału programu PowerPoint.

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

Parametry

Nazwa	Opis
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
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]]]	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

   @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

Zarejestruj procedurę obsługi zdarzeń cyklu życia tworzenia użytkownika.

Jest to dekorator wygody, który rejestruje program obsługi specjalnie dla zdarzeń tworzenia tożsamości użytkownika agenta.

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

Parametry

Nazwa	Opis
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
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]]]	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

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

on_user_deleted

Zarejestruj procedurę obsługi zdarzeń cyklu życia usuwania użytkownika.

Jest to dekorator wygody, który rejestruje program obsługi specjalnie dla zdarzeń usuwania tożsamości użytkownika agenta.

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

Parametry

Nazwa	Opis
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
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]]]	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

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

on_user_workload_onboarding

Zarejestruj procedurę obsługi zdarzeń aktualizacji dołączania obciążenia użytkownika.

Jest to wygodny dekorator, który rejestruje program obsługi zdarzeń występujących po zaktualizowaniu stanu dołączania obciążenia użytkownika.

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

Parametry

Nazwa	Opis
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
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]]]	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

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

on_word

Zarejestruj procedurę obsługi powiadomień o komentarzach programu Microsoft Word.

Jest to dekorator wygody, który rejestruje program obsługi powiadomień z podkanałów programu Word.

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

Parametry

Nazwa	Opis
**kwargs Wymagane	Any Dodatkowe argumenty słów kluczowych przekazane do metody add_route aplikacji.

Zwraca

Typ	Opis
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]]]	Funkcja dekoratora, która rejestruje program obsługi w aplikacji.

Przykłady

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