AgentNotification Klasse

Handler for agentmeddelelser fra Microsoft 365-programmer.

Denne klasse indeholder dekoratører til registrering af handlere, der reagerer på meddelelser fra forskellige Microsoft 365-kanaler og -underkanaler. Den understøtter routing baseret på kanal-id,underkanal- og livscyklushændelser.

Konstruktør

AgentNotification()

Parametre

Name	Beskrivelse
app Påkrævet	Den programforekomst, der håndterer de distribuerede meddelelser.
known_subchannels	Valgfri gentagelse af genkendte underkanaler. Hvis Ingen, angives alle værdier i AgentSubChannel-optællingen som standard. Default value: None
known_lifecycle_events	Valgfri gentagelse af genkendte livscyklushændelser. Hvis Ingen, er alle værdier i AgentLifecycleEvent-optællingen som standard. Default value: None

Eksempler

   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	Registrer en handler for meddelelser om agentlivscyklushændelser. Denne dekoratør registrerer en handlerfunktion, der skal kaldes, når der opstår livscyklushændelser, f.eks. opdatering af brugeroprettelse, sletning eller onboarding af arbejdsbelastninger.
on_agent_notification	Registrer en handler for meddelelser fra en bestemt kanal og underkanal. Denne dekoratør registrerer en handlerfunktion, der skal kaldes, når der modtages en meddelelse fra den angivne kanal og valgfri underkanal. Handleren modtager en typed AgentNotificationActivity-ombrydning.
on_email	Registrer en handler til Outlook-mailmeddelelser. Dette er en praktisk dekoratør, der registrerer en handler for meddelelser fra mailunderkanalen.
on_excel	Registrer en handler til Kommentarer i Microsoft Excel. Dette er en praktisk dekoratør, der registrerer en handler til meddelelser fra Excel-underkanalen.
on_lifecycle	Registrer en handler for alle meddelelser om agentlivscyklushændelser. Dette er en praktisk dekoratør, der registrerer en handler for alle livscyklushændelser ved hjælp af jokertegnet "*" matcher.
on_powerpoint	Registrer en handler til Microsoft PowerPoint-kommentarmeddelelser. Dette er en praktisk dekoratør, der registrerer en handler til meddelelser fra PowerPoint-underkanalen.
on_user_created	Registrer en handler for hændelser for brugeroprettelseslivscyklus. Dette er en praktisk dekoratør, der registrerer en handler specifikt til agentiske hændelser for oprettelse af brugeridentitet.
on_user_deleted	Registrer en handler for livscyklushændelser for brugersletning. Dette er en praktisk dekoratør, der registrerer en handler specifikt for agentiske hændelser for sletning af brugeridentitet.
on_user_workload_onboarding	Registrer en handler for onboarding af opdateringshændelser for brugerarbejdsbelastning. Dette er en praktisk dekoratør, der registrerer en handler for hændelser, der opstår, når en brugers onboardingstatus for arbejdsbelastning opdateres.
on_word	Registrer en handler til kommentarer fra Microsoft Word. Dette er en praktisk dekoratør, der registrerer en handler for meddelelser fra Word-underkanalen.

__init__

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

Parametre

Name	Beskrivelse
app Påkrævet	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

Registrer en handler for meddelelser om agentlivscyklushændelser.

Denne dekoratør registrerer en handlerfunktion, der skal kaldes, når der opstår livscyklushændelser, f.eks. opdatering af brugeroprettelse, sletning eller onboarding af arbejdsbelastninger.

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

Parametre

Name	Beskrivelse
lifecycle_event Påkrævet	str Livscyklushændelsen, der skal lyttes efter. Brug "*" til at matche alle livscyklushændelser, eller angiv en bestemt hændelse fra AgentLifecycleEvent.
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
	En dekoratørfunktion, der registrerer handleren med programmet.

Eksempler

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

on_agent_notification

Registrer en handler for meddelelser fra en bestemt kanal og underkanal.

Denne dekoratør registrerer en handlerfunktion, der skal kaldes, når der modtages en meddelelse fra den angivne kanal og valgfri underkanal. Handleren modtager en typed AgentNotificationActivity-ombrydning.

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

Parametre

Name	Beskrivelse
channel_id Påkrævet	ChannelId Kanal-id'et, der angiver kanalen og den valgfri underkanal, der skal lyttes efter. Brug "*" som underkanal for at matche alle underkanaler.
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
	En dekoratørfunktion, der registrerer handleren med programmet.

Eksempler

   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

Registrer en handler til Outlook-mailmeddelelser.

Dette er en praktisk dekoratør, der registrerer en handler for meddelelser fra mailunderkanalen.

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

Parametre

Name	Beskrivelse
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
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ørfunktion, der registrerer handleren med programmet.

Eksempler

   @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

Registrer en handler til Kommentarer i Microsoft Excel.

Dette er en praktisk dekoratør, der registrerer en handler til meddelelser fra Excel-underkanalen.

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

Parametre

Name	Beskrivelse
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
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ørfunktion, der registrerer handleren med programmet.

Eksempler

   @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

Registrer en handler for alle meddelelser om agentlivscyklushændelser.

Dette er en praktisk dekoratør, der registrerer en handler for alle livscyklushændelser ved hjælp af jokertegnet "*" matcher.

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

Parametre

Name	Beskrivelse
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
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ørfunktion, der registrerer handleren med programmet.

Eksempler

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

on_powerpoint

Registrer en handler til Microsoft PowerPoint-kommentarmeddelelser.

Dette er en praktisk dekoratør, der registrerer en handler til meddelelser fra PowerPoint-underkanalen.

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

Parametre

Name	Beskrivelse
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
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ørfunktion, der registrerer handleren med programmet.

Eksempler

   @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

Registrer en handler for hændelser for brugeroprettelseslivscyklus.

Dette er en praktisk dekoratør, der registrerer en handler specifikt til agentiske hændelser for oprettelse af brugeridentitet.

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

Parametre

Name	Beskrivelse
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
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ørfunktion, der registrerer handleren med programmet.

Eksempler

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

on_user_deleted

Registrer en handler for livscyklushændelser for brugersletning.

Dette er en praktisk dekoratør, der registrerer en handler specifikt for agentiske hændelser for sletning af brugeridentitet.

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

Parametre

Name	Beskrivelse
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
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ørfunktion, der registrerer handleren med programmet.

Eksempler

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

on_user_workload_onboarding

Registrer en handler for onboarding af opdateringshændelser for brugerarbejdsbelastning.

Dette er en praktisk dekoratør, der registrerer en handler for hændelser, der opstår, når en brugers onboardingstatus for arbejdsbelastning opdateres.

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

Parametre

Name	Beskrivelse
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
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ørfunktion, der registrerer handleren med programmet.

Eksempler

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

on_word

Registrer en handler til kommentarer fra Microsoft Word.

Dette er en praktisk dekoratør, der registrerer en handler for meddelelser fra Word-underkanalen.

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

Parametre

Name	Beskrivelse
**kwargs Påkrævet	Any Yderligere nøgleordsargumenter, der overføres til appens add_route-metode.

Returnerer

Type	Beskrivelse
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ørfunktion, der registrerer handleren med programmet.

Eksempler

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