AgentNotificationActivity Klass

Omslutning runt ett aktivitetsobjekt med skrivna meddelandeentiteter.

Den här klassen ger bekväm åtkomst till inskrivna meddelandeentiteter som extraherats från en aktivitets entitetssamling. Den parsar och validerar automatiskt e-postaviseringar, Word/PowerPoint/Excel-kommentarer och livscykelhändelser vid byggtid.

Konstruktor

AgentNotificationActivity()

Parametrar

Name Description
activity
Obligatorisk

Aktivitetsobjektet som ska omslutas. Får inte vara Ingen.

Exempel


   async def email_handler(
       context: TurnContext,
       state: TurnState,
       notification: AgentNotificationActivity,
   ) -> None:
       email = notification.email
       if email:
           print(f"Received email: {email.id}")
           print(f"Body: {email.html_body}")

Metoder

__init__
__new__
as_model

Parsa aktivitetsvärdet som en anpassad modelltyp.

Den här metoden ger ett allmänt sätt att verifiera och parsa aktivitetens värdenyttolast i valfri Pydantisk modelltyp. Användbart för anpassade meddelandetyper som inte stöds direkt av de inskrivna egenskaperna.

__init__

__init__(activity: Activity)

Parametrar

Name Description
activity
Obligatorisk

__new__

__new__(**kwargs)

as_model

Parsa aktivitetsvärdet som en anpassad modelltyp.

Den här metoden ger ett allmänt sätt att verifiera och parsa aktivitetens värdenyttolast i valfri Pydantisk modelltyp. Användbart för anpassade meddelandetyper som inte stöds direkt av de inskrivna egenskaperna.

as_model(model: Type[TModel]) -> TModel | None

Parametrar

Name Description
model
Obligatorisk
Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]

En Pydantisk modellklass som du vill verifiera och parsa aktivitetsvärdet i.

Returer

Typ Description
<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel> | None

En instans av den angivna modelltypen om valideringen lyckas, annars Ingen.

Exempel


   from pydantic import BaseModel

   class CustomNotification(BaseModel):
       custom_field: str

   notification = AgentNotificationActivity(activity)
   custom = notification.as_model(CustomNotification)
   if custom:
       print(custom.custom_field)

Attribut

channel

Kanalidentifieraren från aktivitetens channel_id.

Returer

Typ Description

Kanalnamnet (t.ex. "agenter", "msteams") eller Ingen om det inte är tillgängligt.

email

Den parsade e-postreferensen, om den finns.

Returer

Typ Description

Ett EmailReference-objekt om en e-postaviseringsentitet hittades och parsades, annars Ingen.

notification_type

Den identifierade meddelandetypen.

Returer

Typ Description

Uppräkningsvärdet NotificationTypes som anger typen av meddelande (EMAIL_NOTIFICATION, WPX_COMMENT eller AGENT_LIFECYCLE) eller Ingen om det inte gick att fastställa meddelandetypen.

sub_channel

Underkanalsidentifieraren från aktivitetens channel_id.

Returer

Typ Description

Underkanalsnamnet (t.ex. "e-post", "ord") eller Ingen om det inte är tillgängligt.

type

Aktivitetstypen.

Returer

Typ Description

Typen av aktivitet (t.ex. "meddelande", "händelse") eller Ingen om den inte har angetts.

value

Värdets nyttolast från aktiviteten.

Returer

Typ Description

Aktivitetens värde, som kan innehålla ytterligare meddelandedata.

wpx_comment

Den parsade entiteten Word/PowerPoint/Excel-kommentar, om den finns.

Returer

Typ Description

Ett WpxComment-objekt om en kommentarentitet hittades och parsades, annars Ingen.

activity

Det underliggande aktivitetsobjektet.