AgentNotification クラス

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

パラメーター

__new__(**kwargs)

エージェント ライフサイクル イベント通知のハンドラーを登録します。

このデコレーターは、ユーザーの作成、削除、ワークロードオンボードの更新など、ライフサイクル イベントが発生したときに呼び出されるハンドラー関数を登録します。

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

パラメーター

返品

例

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

特定のチャネルとサブチャネルからの通知のハンドラーを登録します。

このデコレーターは、指定されたチャネルとオプションのサブチャネルから通知を受信したときに呼び出されるハンドラー関数を登録します。 ハンドラーは、型指定された AgentNotificationActivity ラッパーを受け取ります。

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

パラメーター

返品

例

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

Outlook メール通知のハンドラーを登録します。

これは、電子メール サブチャネルからの通知のハンドラーを登録する便利なデコレーターです。

on_email(**kwargs: Any) -> Callable[[Callable[[TContext, 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)

Microsoft Excel コメント通知のハンドラーを登録します。

これは、Excel サブチャネルからの通知のハンドラーを登録する便利なデコレーターです。

on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, 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(**kwargs: Any) -> Callable[[Callable[[TContext, 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}")

Microsoft PowerPoint コメント通知のハンドラーを登録します。

これは、PowerPoint サブチャネルからの通知のハンドラーを登録する便利なデコレーターです。

on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, 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}")

ユーザー作成ライフサイクル イベントのハンドラーを登録します。

これは、エージェント ユーザー ID 作成イベント専用のハンドラーを登録する便利なデコレーターです。

on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, 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")

ユーザー削除ライフサイクル イベントのハンドラーを登録します。

これは、エージェント ユーザー ID 削除イベント専用のハンドラーを登録する便利なデコレーターです。

on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, 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(**kwargs: Any) -> Callable[[Callable[[TContext, 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")

Microsoft Word コメント通知のハンドラーを登録します。

これは、Word サブチャネルからの通知のハンドラーを登録する便利なデコレーターです。

on_word(**kwargs: Any) -> Callable[[Callable[[TContext, 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}")