AgentNotification Klasse

Behandler for agentvarsler fra Microsoft 365-programmer.

Denne klassen inneholder dekoratører for registreringsbehandlinger som svarer på varsler fra ulike Microsoft 365-kanaler og underkanaler. Den støtter ruting basert på kanal-ID, underkanal og livssyklushendelser.

Konstruktør

AgentNotification()

Parametere

Navn	Beskrivelse
app Obligatorisk	Programforekomsten som skal håndtere de rutede varslene.
known_subchannels	Valgfritt iterbart for gjenkjente underkanaler. Hvis ingen, brukes alle verdiene i AgentSubChannel-nummeret som standard. Default value: None
known_lifecycle_events	Valgfritt iterbart for gjenkjente livssyklushendelser. Hvis Ingen, brukes alle verdiene i AgentLifecycleEvent-opplistingen 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 behandler for hendelsesvarsler for agentlivssyklus. Denne dekoratøren registrerer en behandlingsfunksjon som skal kalles når livssyklushendelser oppstår, for eksempel oppdateringer for brukeroppretting, sletting eller arbeidsbelastning pålasting.
on_agent_notification	Registrer en behandler for varsler fra en bestemt kanal og underkanal. Denne dekoratøren registrerer en behandlingsfunksjon som skal kalles når et varsel mottas fra den angitte kanalen og valgfri underkanal. Behandleren vil motta en skrevet AgentNotificationActivity wrapper.
on_email	Registrer et behandlingsprogram for Outlook-e-postvarsler. Dette er en praktisk dekoratør som registrerer en behandler for varsler fra e-postunderkanalen.
on_excel	Registrer en behandler for kommentarvarsler i Microsoft Excel. Dette er en praktisk dekoratør som registrerer en behandler for varsler fra Excel-underkanalen.
on_lifecycle	Registrer en behandler for alle hendelsesvarsler for agentlivssyklus. Dette er en praktisk dekoratør som registrerer en behandling for alle livssyklushendelser ved hjelp av jokertegnet *.
on_powerpoint	Registrer en behandler for kommentarvarsler for Microsoft PowerPoint. Dette er en praktisk dekoratør som registrerer en behandler for varsler fra PowerPoint-underkanalen.
on_user_created	Registrer en behandlingsprogram for livssyklushendelser for brukeropprettelse. Dette er en praktisk dekoratør som registrerer en behandling spesielt for agentiske brukeridentitetsopprettingshendelser.
on_user_deleted	Registrer en behandling for livssyklushendelser for brukersletting. Dette er en bekvemmelighetsdekoratør som registrerer en behandling spesielt for agentiske brukeridentitetsslettingshendelser.
on_user_workload_onboarding	Registrer en behandler for oppdateringshendelser for brukerarbeidsbelastning pålasting. Dette er en praktisk dekoratør som registrerer en behandler for hendelser som oppstår når brukerens status for arbeidsbelastning pålasting oppdateres.
on_word	Registrer en behandler for kommentarvarsler i Microsoft Word. Dette er en praktisk dekoratør som registrerer en behandler for varsler fra Word-underkanalen.

__init__

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

Parametere

Navn	Beskrivelse
app Obligatorisk	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 behandler for hendelsesvarsler for agentlivssyklus.

Denne dekoratøren registrerer en behandlingsfunksjon som skal kalles når livssyklushendelser oppstår, for eksempel oppdateringer for brukeroppretting, sletting eller arbeidsbelastning pålasting.

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

Parametere

Navn	Beskrivelse
lifecycle_event Obligatorisk	str Livssyklushendelsen å lytte etter. Bruk *for å samsvare med alle livssyklushendelser, eller angi en bestemt hendelse fra AgentLifecycleEvent.
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt til appens add_route metode.

Returnerer

Type	Beskrivelse
	En dekoratørfunksjon som registrerer behandleren 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 behandler for varsler fra en bestemt kanal og underkanal.

Denne dekoratøren registrerer en behandlingsfunksjon som skal kalles når et varsel mottas fra den angitte kanalen og valgfri underkanal. Behandleren vil motta en skrevet AgentNotificationActivity wrapper.

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

Parametere

Navn	Beskrivelse
channel_id Obligatorisk	ChannelId Kanal-ID-en som angir kanalen og valgfri underkanal å lytte etter. Bruk *som underkanal for å samsvare med alle underkanalene.
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt til appens add_route metode.

Returnerer

Type	Beskrivelse
	En dekoratørfunksjon som registrerer behandleren 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 et behandlingsprogram for Outlook-e-postvarsler.

Dette er en praktisk dekoratør som registrerer en behandler for varsler fra e-postunderkanalen.

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

Parametere

Navn	Beskrivelse
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt 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ørfunksjon som registrerer behandleren 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 behandler for kommentarvarsler i Microsoft Excel.

Dette er en praktisk dekoratør som registrerer en behandler for varsler fra Excel-underkanalen.

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

Parametere

Navn	Beskrivelse
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt 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ørfunksjon som registrerer behandleren 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 behandler for alle hendelsesvarsler for agentlivssyklus.

Dette er en praktisk dekoratør som registrerer en behandling for alle livssyklushendelser ved hjelp av jokertegnet *.

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

Parametere

Navn	Beskrivelse
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt 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ørfunksjon som registrerer behandleren 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 behandler for kommentarvarsler for Microsoft PowerPoint.

Dette er en praktisk dekoratør som registrerer en behandler for varsler fra PowerPoint-underkanalen.

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

Parametere

Navn	Beskrivelse
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt 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ørfunksjon som registrerer behandleren 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 behandlingsprogram for livssyklushendelser for brukeropprettelse.

Dette er en praktisk dekoratør som registrerer en behandling spesielt for agentiske brukeridentitetsopprettingshendelser.

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

Parametere

Navn	Beskrivelse
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt 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ørfunksjon som registrerer behandleren 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 behandling for livssyklushendelser for brukersletting.

Dette er en bekvemmelighetsdekoratør som registrerer en behandling spesielt for agentiske brukeridentitetsslettingshendelser.

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

Parametere

Navn	Beskrivelse
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt 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ørfunksjon som registrerer behandleren 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 behandler for oppdateringshendelser for brukerarbeidsbelastning pålasting.

Dette er en praktisk dekoratør som registrerer en behandler for hendelser som oppstår når brukerens status for arbeidsbelastning pålasting oppdateres.

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

Parametere

Navn	Beskrivelse
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt 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ørfunksjon som registrerer behandleren 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 behandler for kommentarvarsler i Microsoft Word.

Dette er en praktisk dekoratør som registrerer en behandler for varsler fra Word-underkanalen.

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

Parametere

Navn	Beskrivelse
**kwargs Obligatorisk	Any Flere nøkkelordargumenter sendt 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ørfunksjon som registrerer behandleren 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}")