AgentNotification מחלקה

מטפל עבור הודעות סוכן מיישומי Microsoft 365.

כיתה זו מספקת מעצבי צורה לרישום מטפלים המגיבים להודעות מערוצים ומתנים שונים של Microsoft 365. הוא תומך בניתוב בהתבסס על מזהה ערוץ, תת-ערוצי ואירועי מחזור חיים.

בנאי

AgentNotification()

פרמטרים

שם	תיאור
app נדרש	מופע היישום שמטפל בהודעות מנותב.
known_subchannels	אופציונלי, ניתן לאטראציונלי לתת-ערוצי משנה מזוהים. אם האפשרות ללא, ברירת המחדל היא כל הערכים בספירה AgentSubChannel. ערך ברירת מחדל: None
known_lifecycle_events	אופציונלי ניתן להפעלה של אירועי מחזור חיים מזוהים. אם האפשרות ללא, ברירת המחדל היא כל הערכים ב- AgentLifecycleEvent enum. ערך ברירת מחדל: None

דוגמאות

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

שיטות

__init__
__new__
on_agent_lifecycle_notification	רשום מטפל לקבלת הודעות לאירועי מחזור חיים של סוכן. מעצב זה נרשם פונקציית מטפל שיש לבצע אליה קריאה כאשר מתרחשים אירועי מחזור חיים, כגון יצירת משתמשים, מחיקה או עדכוני צירוף עומס עבודה.
on_agent_notification	רשום מטפל עבור הודעות מערוץ ומשפך משנה ספציפיים. מעצב זה נרשם פונקציית מטפל כדי לקבל קריאה כאשר מתקבלת הודעה מהערוץ שצוין ומשפך משנה אופציונלי. המטפל יקבל עטיפת AgentNotificationActivity שהוקלדה.
on_email	רשום מטפל עבור הודעות דואר אלקטרוני של Outlook. זהו מעצב נוחות שרשם מטפל עבור הודעות ממשפך המשנה של הדואר האלקטרוני.
on_excel	רשום מטפל עבור הודעות תגובה של Microsoft Excel. זהו מעצב נוחות שרשם מטפל עבור הודעות ממשפך המשנה של Excel.
on_lifecycle	רשום מטפל עבור כל הודעות האירוע של מחזור החיים של הסוכן. זהו מעצב נוחות שרשם מטפל עבור כל אירועי מחזור החיים באמצעות התו הכללי "*" matcher.
on_powerpoint	רשום מטפל עבור הודעות הערה של Microsoft PowerPoint. זהו מעצב נוחות שרשם מטפל עבור הודעות ממשפך המשנה של PowerPoint.
on_user_created	רשום מטפל עבור אירועי מחזור חיים של יצירת משתמשים. זהו מעצב נוחות שרשם מטפל באופן ספציפי לאירועים של יצירת זהות סוכן של משתמשים.
on_user_deleted	רשום מטפל עבור אירועי מחזור חיים למחיקת משתמשים. זהו מעצב נוחות שרשם מטפל במיוחד עבור אירועים סוכן של מחיקת זהות משתמש.
on_user_workload_onboarding	רשום מטפל עבור אירועי עדכון צירוף עומס עבודה של משתמשים. זהו מעצב נוחות שרשם מטפל עבור אירועים המתרחשים כאשר מצב הצירוף של עומס העבודה של משתמש מתעדכן.
on_word	רשום מטפל עבור הודעות תגובה של Microsoft Word. זהו מעצב נוחות שרשם מטפל עבור הודעות ממשפך המשנה של Word.

__init__

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

פרמטרים

שם	תיאור
app נדרש	Any
known_subchannels	Iterable[str | AgentSubChannel] | None ערך ברירת מחדל: None
known_lifecycle_events	Iterable[str | AgentLifecycleEvent] | None ערך ברירת מחדל: None

__new__

__new__(**kwargs)

on_agent_lifecycle_notification

רשום מטפל לקבלת הודעות לאירועי מחזור חיים של סוכן.

מעצב זה נרשם פונקציית מטפל שיש לבצע אליה קריאה כאשר מתרחשים אירועי מחזור חיים, כגון יצירת משתמשים, מחיקה או עדכוני צירוף עומס עבודה.

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

פרמטרים

שם	תיאור
lifecycle_event נדרש	str אירוע מחזור החיים שברצונך להאזין לו. השתמש ב- "*" כדי להתאים את כל אירועי מחזור החיים, או ציין אירוע ספציפי מ- AgentLifecycleEvent.
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

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

on_agent_notification

רשום מטפל עבור הודעות מערוץ ומשפך משנה ספציפיים.

מעצב זה נרשם פונקציית מטפל כדי לקבל קריאה כאשר מתקבלת הודעה מהערוץ שצוין ומשפך משנה אופציונלי. המטפל יקבל עטיפת AgentNotificationActivity שהוקלדה.

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

פרמטרים

שם	תיאור
channel_id נדרש	ChannelId מזהה הערוץ המציין את הערוץ ואת משפך המשנה האופציונלי שעבורו יש להאזין. השתמש ב- "*" כמשפך המשנה כדי להתאים את כל משפני המשנה.
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

   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

רשום מטפל עבור הודעות דואר אלקטרוני של Outlook.

זהו מעצב נוחות שרשם מטפל עבור הודעות ממשפך המשנה של הדואר האלקטרוני.

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

פרמטרים

שם	תיאור
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
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]]]	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

   @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

רשום מטפל עבור הודעות תגובה של Microsoft Excel.

זהו מעצב נוחות שרשם מטפל עבור הודעות ממשפך המשנה של Excel.

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

פרמטרים

שם	תיאור
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
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]]]	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

   @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

רשום מטפל עבור כל הודעות האירוע של מחזור החיים של הסוכן.

זהו מעצב נוחות שרשם מטפל עבור כל אירועי מחזור החיים באמצעות התו הכללי "*" matcher.

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

פרמטרים

שם	תיאור
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
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]]]	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

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

on_powerpoint

רשום מטפל עבור הודעות הערה של Microsoft PowerPoint.

זהו מעצב נוחות שרשם מטפל עבור הודעות ממשפך המשנה של PowerPoint.

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

פרמטרים

שם	תיאור
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
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]]]	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

   @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

רשום מטפל עבור אירועי מחזור חיים של יצירת משתמשים.

זהו מעצב נוחות שרשם מטפל באופן ספציפי לאירועים של יצירת זהות סוכן של משתמשים.

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

פרמטרים

שם	תיאור
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
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]]]	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

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

on_user_deleted

רשום מטפל עבור אירועי מחזור חיים למחיקת משתמשים.

זהו מעצב נוחות שרשם מטפל במיוחד עבור אירועים סוכן של מחיקת זהות משתמש.

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

פרמטרים

שם	תיאור
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
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]]]	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

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

on_user_workload_onboarding

רשום מטפל עבור אירועי עדכון צירוף עומס עבודה של משתמשים.

זהו מעצב נוחות שרשם מטפל עבור אירועים המתרחשים כאשר מצב הצירוף של עומס העבודה של משתמש מתעדכן.

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

פרמטרים

שם	תיאור
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
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]]]	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

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

on_word

רשום מטפל עבור הודעות תגובה של Microsoft Word.

זהו מעצב נוחות שרשם מטפל עבור הודעות ממשפך המשנה של Word.

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

פרמטרים

שם	תיאור
**kwargs נדרש	Any ארגומנטים נוספים של מילות מפתח שהועברו לפעולת השירות add_route היישום.

החזרות

סוג נתונים	תיאור
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]]]	פונקציית מעצב ש רושמת את המטפל ביישום.

דוגמאות

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