AgentNotification Sınıf
Microsoft 365 uygulamalarından gelen aracı bildirimleri için işleyici.
Bu sınıf, çeşitli Microsoft 365 kanallarından ve alt kanallarından gelen bildirimlere yanıt veren işleyicileri kaydetmek için dekoratörler sağlar. Kanal kimliğine, alt kanala ve yaşam döngüsü olaylarına göre yönlendirmeyi destekler.
Oluşturucu
AgentNotification()
Parametreler
| Name | Description |
|---|---|
|
app
Gerekli
|
Yönlendirilen bildirimleri işleyecek uygulama örneği. |
|
known_subchannels
|
Tanınan alt kanallarda isteğe bağlı yinelenebilir. Hiçbiri ise, AgentSubChannel sabit listesi içindeki tüm değerleri varsayılan olarak kullanır. Default value: None
|
|
known_lifecycle_events
|
Tanınan yaşam döngüsü olaylarının isteğe bağlı yinelenebilir olması. Hiçbiri ise, AgentLifecycleEvent sabit listesi içindeki tüm değerleri varsayılan olarak kullanır. Default value: None
|
Örnekler
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}")
Yöntemler
| __init__ | |
| __new__ | |
| on_agent_lifecycle_notification |
Aracı yaşam döngüsü olay bildirimleri için bir işleyici kaydedin. Bu dekoratör kullanıcı oluşturma, silme veya iş yükü ekleme güncelleştirmeleri gibi yaşam döngüsü olayları gerçekleştiğinde çağrılmak üzere bir işleyici işlevi kaydeder. |
| on_agent_notification |
Belirli bir kanaldan ve alt kanaldan gelen bildirimler için bir işleyici kaydedin. Bu dekoratör, belirtilen kanaldan ve isteğe bağlı alt kanaldan bir bildirim alındığında çağrılmak üzere bir işleyici işlevi kaydeder. İşleyici türü belirtilmiş bir AgentNotificationActivity sarmalayıcı alır. |
| on_email |
Outlook e-posta bildirimleri için bir işleyici kaydedin. Bu, e-posta alt kanaldan gelen bildirimler için bir işleyici kaydeden kullanışlı bir dekoratördür. |
| on_excel |
Microsoft Excel açıklama bildirimleri için bir işleyici kaydedin. Bu, Excel alt kanaldan gelen bildirimler için bir işleyici kaydeden kullanışlı bir dekoratördür. |
| on_lifecycle |
Tüm aracı yaşam döngüsü olay bildirimleri için bir işleyici kaydedin. Bu, joker karakter "*" eşleştiricisini kullanarak tüm yaşam döngüsü olayları için bir işleyici kaydeden bir kolaylık dekoratörüdür. |
| on_powerpoint |
Microsoft PowerPoint açıklama bildirimleri için bir işleyici kaydedin. Bu, PowerPoint alt kanaldan gelen bildirimler için bir işleyici kaydeden bir kolaylık dekoratörüdür. |
| on_user_created |
Kullanıcı oluşturma yaşam döngüsü olayları için bir işleyici kaydedin. Bu, özellikle aracı kullanıcı kimliği oluşturma olayları için bir işleyici kaydeden bir kolaylık dekoratörüdür. |
| on_user_deleted |
Kullanıcı silme yaşam döngüsü olayları için bir işleyici kaydedin. Bu, özellikle aracı kullanıcı kimliği silme olayları için bir işleyici kaydeden bir kolaylık dekoratörüdür. |
| on_user_workload_onboarding |
Kullanıcı iş yükü ekleme güncelleştirme olayları için bir işleyici kaydedin. Bu, kullanıcının iş yükü ekleme durumu güncelleştirildiğinde gerçekleşen olaylar için işleyici kaydeden bir kolaylık dekoratörüdür. |
| on_word |
Microsoft Word açıklama bildirimleri için bir işleyici kaydedin. Bu, Word alt kanaldan gelen bildirimler için bir işleyici kaydeden bir kolaylık dekoratörüdür. |
__init__
__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)
Parametreler
| Name | Description |
|---|---|
|
app
Gerekli
|
|
|
known_subchannels
|
Default value: None
|
|
known_lifecycle_events
|
Default value: None
|
__new__
__new__(**kwargs)
on_agent_lifecycle_notification
Aracı yaşam döngüsü olay bildirimleri için bir işleyici kaydedin.
Bu dekoratör kullanıcı oluşturma, silme veya iş yükü ekleme güncelleştirmeleri gibi yaşam döngüsü olayları gerçekleştiğinde çağrılmak üzere bir işleyici işlevi kaydeder.
on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)
Parametreler
| Name | Description |
|---|---|
|
lifecycle_event
Gerekli
|
Dinlenecek yaşam döngüsü olayı. Tüm yaşam döngüsü olaylarını eşleştirmek için "*" kullanın veya AgentLifecycleEvent'ten belirli bir olay belirtin. |
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@notifications.on_agent_lifecycle_notification("agenticuseridentitycreated")
async def handle_user_created(context, state, notification):
print("New user created")
on_agent_notification
Belirli bir kanaldan ve alt kanaldan gelen bildirimler için bir işleyici kaydedin.
Bu dekoratör, belirtilen kanaldan ve isteğe bağlı alt kanaldan bir bildirim alındığında çağrılmak üzere bir işleyici işlevi kaydeder. İşleyici türü belirtilmiş bir AgentNotificationActivity sarmalayıcı alır.
on_agent_notification(channel_id: ChannelId, **kwargs: Any)
Parametreler
| Name | Description |
|---|---|
|
channel_id
Gerekli
|
Kanalı belirten kanal kimliği ve dinlenecek isteğe bağlı alt kanal. Tüm alt kanallarla eşleştirmek için alt kanal olarak "*" kullanın. |
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
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 e-posta bildirimleri için bir işleyici kaydedin.
Bu, e-posta alt kanaldan gelen bildirimler için bir işleyici kaydeden kullanışlı bir dekoratördür.
on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametreler
| Name | Description |
|---|---|
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
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]]]
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@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 açıklama bildirimleri için bir işleyici kaydedin.
Bu, Excel alt kanaldan gelen bildirimler için bir işleyici kaydeden kullanışlı bir dekoratördür.
on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametreler
| Name | Description |
|---|---|
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
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]]]
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@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
Tüm aracı yaşam döngüsü olay bildirimleri için bir işleyici kaydedin.
Bu, joker karakter "*" eşleştiricisini kullanarak tüm yaşam döngüsü olayları için bir işleyici kaydeden bir kolaylık dekoratörüdür.
on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametreler
| Name | Description |
|---|---|
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
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]]]
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@notifications.on_lifecycle()
async def handle_any_lifecycle_event(context, state, notification):
print(f"Lifecycle event type: {notification.notification_type}")
on_powerpoint
Microsoft PowerPoint açıklama bildirimleri için bir işleyici kaydedin.
Bu, PowerPoint alt kanaldan gelen bildirimler için bir işleyici kaydeden bir kolaylık dekoratörüdür.
on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametreler
| Name | Description |
|---|---|
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
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]]]
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@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
Kullanıcı oluşturma yaşam döngüsü olayları için bir işleyici kaydedin.
Bu, özellikle aracı kullanıcı kimliği oluşturma olayları için bir işleyici kaydeden bir kolaylık dekoratörüdür.
on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametreler
| Name | Description |
|---|---|
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
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]]]
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@notifications.on_user_created()
async def handle_user_created(context, state, notification):
print("New agentic user identity created")
on_user_deleted
Kullanıcı silme yaşam döngüsü olayları için bir işleyici kaydedin.
Bu, özellikle aracı kullanıcı kimliği silme olayları için bir işleyici kaydeden bir kolaylık dekoratörüdür.
on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametreler
| Name | Description |
|---|---|
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
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]]]
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@notifications.on_user_deleted()
async def handle_user_deleted(context, state, notification):
print("Agentic user identity deleted")
on_user_workload_onboarding
Kullanıcı iş yükü ekleme güncelleştirme olayları için bir işleyici kaydedin.
Bu, kullanıcının iş yükü ekleme durumu güncelleştirildiğinde gerçekleşen olaylar için işleyici kaydeden bir kolaylık dekoratörüdür.
on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametreler
| Name | Description |
|---|---|
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
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]]]
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@notifications.on_user_workload_onboarding()
async def handle_onboarding_update(context, state, notification):
print("User workload onboarding status updated")
on_word
Microsoft Word açıklama bildirimleri için bir işleyici kaydedin.
Bu, Word alt kanaldan gelen bildirimler için bir işleyici kaydeden bir kolaylık dekoratörüdür.
on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]
Parametreler
| Name | Description |
|---|---|
|
**kwargs
Gerekli
|
Uygulamanın add_route yöntemine geçirilen ek anahtar sözcük bağımsız değişkenleri. |
Döndürülenler
| Tür | Description |
|---|---|
|
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]]]
|
İşleyiciyi uygulamaya kaydeden bir dekoratör işlevi. |
Örnekler
@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}")