AgentNotificationActivity Classe

Envolve um objeto de Atividade com entidades de notificação digitadas.

Esta classe proporciona acesso conveniente a entidades de notificação digitadas extraídas da coleção de entidades de uma Atividade. Analisa e valida automaticamente notificações por email, comentários em Word/PowerPoint/Excel e eventos do ciclo de vida durante a construção.

Construtor

AgentNotificationActivity()

Parâmetros

Name Description
activity
Necessário

O objeto de Atividade para envolver. Não pode ser nenhum.

Exemplos


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

Métodos

__init__
__new__
as_model

Analise o valor da atividade como um tipo de modelo personalizado.

Este método fornece uma forma genérica de validar e analisar a carga útil de valor da atividade em qualquer tipo de modelo Pydantic. Útil para tipos de notificação personalizados que não são diretamente suportados pelas propriedades digitadas.

__init__

__init__(activity: Activity)

Parâmetros

Name Description
activity
Necessário

__new__

__new__(**kwargs)

as_model

Analise o valor da atividade como um tipo de modelo personalizado.

Este método fornece uma forma genérica de validar e analisar a carga útil de valor da atividade em qualquer tipo de modelo Pydantic. Útil para tipos de notificação personalizados que não são diretamente suportados pelas propriedades digitadas.

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

Parâmetros

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

Uma classe de modelo Pydantic para validar e analisar o valor da atividade.

Devoluções

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

Uma instância do tipo de modelo especificado se a validação for bem-sucedida, caso contrário Nenhuma.

Exemplos


   from pydantic import BaseModel

   class CustomNotification(BaseModel):
       custom_field: str

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

Atributos

channel

O identificador do canal da channel_id da atividade.

Devoluções

Tipo Description

O nome do canal (por exemplo, 'agentes', 'msteams') ou Nenhum, se não estiver disponível.

email

A entidade de referência do email analisado, se estiver presente.

Devoluções

Tipo Description

Um objeto EmailReference se uma entidade de notificação de email foi encontrada e analisada com sucesso, caso contrário Nenhum.

notification_type

O tipo de notificação detetado.

Devoluções

Tipo Description

O valor enum NotificationTypes indica o tipo de notificação (EMAIL_NOTIFICATION, WPX_COMMENT ou AGENT_LIFECYCLE), ou Nenhum, caso o tipo de notificação não tenha sido determinado.

sub_channel

O identificador do subcanal da channel_id da atividade.

Devoluções

Tipo Description

O nome do subcanal (por exemplo, 'email', 'palavra') ou Nenhum, se não estiver disponível.

type

O tipo de atividade.

Devoluções

Tipo Description

O tipo da atividade (por exemplo, 'mensagem', 'evento') ou Nenhum, se não estiver definido.

value

O valor da carga útil da atividade.

Devoluções

Tipo Description

O valor da atividade, que pode conter dados adicionais de notificação.

wpx_comment

A entidade de comentário Word/PowerPoint/Excel analisada, se existir.

Devoluções

Tipo Description

Um objeto WpxComment se uma entidade de comentário foi encontrada e analisada com sucesso, caso contrário Nenhum.

activity

O objeto Atividade subjacente.