MessageActivityInput Classe

Modelo de entrada para criar atividades de mensagem com métodos de construtor.

Crie um novo modelo analisando e validando dados de entrada de argumentos de palavra-chave.

Raises [ValidationError][pydantic_core. ValidationError] se os dados de entrada não puderem ser validados para formar um modelo válido.

self é explicitamente posicional somente para permitir a si mesmo como um nome de campo.

Construtor

MessageActivityInput(*, serviceUrl: str | None = None, timestamp: datetime | None = None, locale: str | None = None, localTimestamp: datetime | None = None, channelId: Literal['webchat', 'msteams'] | str | None = None, from_: Account | None = None, conversation: ConversationAccount | None = None, replyToId: str | None = None, entities: List[ClientInfoEntity | MentionEntity | MessageEntity | AIMessageEntity | StreamInfoEntity | CitationEntity | SensitiveUsageEntity | ProductInfoEntity | QuotedReplyEntity | TargetedMessageInfoEntity | UnknownEntity] | None = None, channelData: ChannelData | None = None, type: Literal['message'] = 'message', id: str | None = None, recipient: Account | None = None, text: str | None = None, summary: str | None = None, textFormat: Literal['markdown', 'plain', 'xml'] | None = None, attachmentLayout: AttachmentLayout | None = None, attachments: List[Attachment] | None = None, suggestedActions: SuggestedActions | None = None, deliveryMode: Literal['normal', 'notification', 'expectReplies', 'ephemeral'] | None = None, value: Any | None = None, **extra_data: Any)

Parâmetros somente de palavra-chave

Nome	Description
serviceUrl	Valor padrão: None
timestamp	Valor padrão: None
locale	Valor padrão: None
localTimestamp	Valor padrão: None
channelId	Valor padrão: None
from_	Valor padrão: None
conversation	Valor padrão: None
replyToId	Valor padrão: None
entities	Valor padrão: None
channelData	Valor padrão: None
type	Valor padrão: message
id	Valor padrão: None
recipient	Valor padrão: None
text	Valor padrão: None
summary	Valor padrão: None
textFormat	Valor padrão: None
attachmentLayout	Valor padrão: None
attachments	Valor padrão: None
suggestedActions	Valor padrão: None
deliveryMode	Valor padrão: None
value	Valor padrão: None

Métodos

add_ai_generated	Adicione o rótulo "Gerado por IA".
add_attachments	Adicione anexos à mensagem.
add_card	Adicione um anexo de cartão à mensagem.
add_citation	Adicione citações.
add_feedback	Habilite os comentários da mensagem.
add_mention	Adicione uma menção (@mention) à mensagem.
add_quote	Adicione uma referência de mensagem entre aspas e acrescente um espaço reservado ao texto. O Teams renderiza a mensagem entre aspas como uma bolha de visualização acima do texto de resposta. Se o texto for fornecido, ele será acrescentado ao espaço reservado da mensagem entre aspas. Aviso Em breve Essa API está chegando e pode mudar no futuro. Diagnóstico: ExperimentalTeamsQuotedReplies
add_stream_final	Adicione informações de fluxo, tornando esta uma mensagem de fluxo final.
add_targeted_message_info	Adicione uma entidade targetedMessageInfo para visualização de prompt. Se já existir uma entidade com tipo `"targetedMessageInfo"` , ela não será adicionada novamente (uma visualização de prompt por mensagem). Ao adicionar a entidade, todas `quotedReply` as entidades e o texto de espaço reservado correspondente `<quoted messageId="..."/>` são removidos para evitar colisão com a visualização de prompt.
add_text	Acrescente o texto à mensagem.
get_account_mention	Obtenha uma entidade de menção por ID da conta.
is_recipient_mentioned	Verifique se a conta do destinatário é mencionada na mensagem.
prepend_quote	Prepare uma entidade quotedReply e um espaço reservado antes do texto existente. Usado por reply()/quote() para quote-above-response. Aviso Em breve Essa API está chegando e pode mudar no futuro. Diagnóstico: ExperimentalTeamsQuotedReplies
with_attachment_layout	Defina a dica de layout para vários anexos.
with_delivery_mode	Defina o modo de entrega para a atividade.
with_recipient	Defina o destinatário.
with_suggested_actions	Defina as ações sugeridas para a atividade.
with_summary	Defina o texto a ser exibido se o canal não puder renderizar cartões.
with_text	Defina o conteúdo do texto da mensagem.
with_text_format	Defina o formato dos campos de texto.

add_ai_generated

Adicione o rótulo "Gerado por IA".

add_ai_generated() -> Self

add_attachments

Adicione anexos à mensagem.

add_attachments(*attachments: Attachment) -> Self

Parâmetros

Nome	Description
*attachments Obrigatório	Anexos a serem adicionados

Retornos

Tipo	Description
	Auto para encadeamento de métodos

add_card

Adicione um anexo de cartão à mensagem.

add_card(card: AdaptiveCard) -> Self

Parâmetros

Nome	Description
card Obrigatório	O anexo do cartão a ser adicionado
content Obrigatório	O conteúdo do cartão

Retornos

Tipo	Description
	Auto para encadeamento de métodos

add_citation

Adicione citações.

add_citation(position: int, appearance: CitationAppearance) -> Self

Parâmetros

Nome	Description
position Obrigatório
appearance Obrigatório

add_feedback

Habilite os comentários da mensagem.

add_feedback(mode: Literal['default', 'custom'] = 'default') -> Self

Parâmetros

Nome	Description
mode	"padrão" mostra os polegares internos do Teams para cima/para baixo da interface do usuário. "personalizado" dispara uma mensagem/fetchTask invocando para que o bot possa retornar sua própria caixa de diálogo de módulo de tarefa. Valor padrão: default

add_mention

Adicione uma menção (@mention) à mensagem.

add_mention(account: Account, text: str | None = None, add_text: bool = True) -> Self

Parâmetros

Nome	Description
account Obrigatório	A conta a ser mencionada
text	Texto personalizado para a menção (o padrão é account.name) Valor padrão: None
add_text	Se deve acrescentar o texto de menção à mensagem Valor padrão: True

Retornos

Tipo	Description
	Auto para encadeamento de métodos

add_quote

Adicione uma referência de mensagem entre aspas e acrescente um espaço reservado ao texto. O Teams renderiza a mensagem entre aspas como uma bolha de visualização acima do texto de resposta. Se o texto for fornecido, ele será acrescentado ao espaço reservado da mensagem entre aspas.

Aviso

Em breve

Essa API está chegando e pode mudar no futuro.

Diagnóstico: ExperimentalTeamsQuotedReplies

add_quote(message_id: str, text: str | None = None) -> Self

Parâmetros

Nome	Description
message_id Obrigatório	A ID da mensagem a ser entre aspas
text	Texto opcional, acrescentado ao espaço reservado da mensagem entre aspas Valor padrão: None

Retornos

Tipo	Description
	Auto para encadeamento de métodos

add_stream_final

Adicione informações de fluxo, tornando esta uma mensagem de fluxo final.

add_stream_final() -> Self

Retornos

Tipo	Description
	Auto para encadeamento de métodos

add_targeted_message_info

Adicione uma entidade targetedMessageInfo para visualização de prompt.

Se já existir uma entidade com tipo "targetedMessageInfo" , ela não será adicionada novamente (uma visualização de prompt por mensagem).

Ao adicionar a entidade, todas quotedReply as entidades e o texto de espaço reservado correspondente <quoted messageId="..."/> são removidos para evitar colisão com a visualização de prompt.

add_targeted_message_info(message_id: str) -> Self

Parâmetros

Nome	Description
message_id Obrigatório	A ID da mensagem de destino.

Retornos

Tipo	Description
	Auto para encadeamento de métodos

add_text

Acrescente o texto à mensagem.

add_text(text: str) -> Self

Parâmetros

Nome	Description
text Obrigatório	Texto a acrescentar

Retornos

Tipo	Description
	Auto para encadeamento de métodos

get_account_mention

Obtenha uma entidade de menção por ID da conta.

get_account_mention(account_id: str) -> MentionEntity | None

Parâmetros

Nome	Description
account_id Obrigatório	A ID da conta a ser pesquisada

Retornos

Tipo	Description
	A entidade de menção, se encontrada, Nenhuma caso contrário

is_recipient_mentioned

Verifique se a conta do destinatário é mencionada na mensagem.

is_recipient_mentioned() -> bool

Retornos

Tipo	Description
	True se o destinatário for mencionado

prepend_quote

Prepare uma entidade quotedReply e um espaço reservado antes do texto existente. Usado por reply()/quote() para quote-above-response.

Aviso

Em breve

Essa API está chegando e pode mudar no futuro.

Diagnóstico: ExperimentalTeamsQuotedReplies

prepend_quote(message_id: str) -> Self

Parâmetros

Nome	Description
message_id Obrigatório	A ID da mensagem IC3 da mensagem entre aspas

Retornos

Tipo	Description
	Auto para encadeamento de métodos

with_attachment_layout

Defina a dica de layout para vários anexos.

with_attachment_layout(attachment_layout: AttachmentLayout) -> Self

Parâmetros

Nome	Description
attachment_layout Obrigatório	Layout do anexo (lista, carrossel)

Retornos

Tipo	Description
	Auto para encadeamento de métodos

with_delivery_mode

Defina o modo de entrega para a atividade.

with_delivery_mode(delivery_mode: Literal['normal', 'notification', 'expectReplies', 'ephemeral']) -> Self

Parâmetros

Nome	Description
delivery_mode Obrigatório	Modo de entrega (normal, notificação)

Retornos

Tipo	Description
	Auto para encadeamento de métodos

with_recipient

Defina o destinatário.

with_recipient(value: Account, is_targeted: bool | None = None) -> Self

Parâmetros

Nome	Description
value Obrigatório	A conta do destinatário
is_targeted	Se True, marcará isso como uma mensagem de destino visível apenas para esse destinatário. Se False, limpa explicitamente o direcionamento. Se None (o padrão), o valor de is_targeted existente será deixado inalterado. Valor padrão: None

Retornos

Tipo	Description
	Auto para encadeamento de métodos

with_suggested_actions

Defina as ações sugeridas para a atividade.

with_suggested_actions(suggested_actions: SuggestedActions) -> Self

Parâmetros

Nome	Description
suggested_actions Obrigatório	Ações sugeridas

Retornos

Tipo	Description
	Auto para encadeamento de métodos

with_summary

Defina o texto a ser exibido se o canal não puder renderizar cartões.

with_summary(summary: str) -> Self

Parâmetros

Nome	Description
summary Obrigatório	Texto resumido

Retornos

Tipo	Description
	Auto para encadeamento de métodos

with_text

Defina o conteúdo do texto da mensagem.

with_text(text: str) -> Self

Parâmetros

Nome	Description
text Obrigatório	Texto a ser definido

Retornos

Tipo	Description
	Auto para encadeamento de métodos

with_text_format

Defina o formato dos campos de texto.

with_text_format(text_format: Literal['markdown', 'plain', 'xml']) -> Self

Parâmetros

Nome	Description
text_format Obrigatório	Formato de texto (markdown, simples, xml)

Retornos

Tipo	Description
	Auto para encadeamento de métodos

Atributos

model_config

A configuração do modelo deve ser um dicionário em conformidade com [ConfigDict][pydantic.config. ConfigDict].

model_config: ClassVar[ConfigDict] = {'alias_generator': AliasGenerator(alias=None, validation_alias=<staticmethod(<function CustomBaseModel.validation_alias_generator>)>, serialization_alias=<staticmethod(<function CustomBaseModel.serialization_alias_generator>)>), 'arbitrary_types_allowed': True, 'extra': 'allow', 'populate_by_name': True, 'serialize_by_alias': True, 'validate_by_alias': True, 'validate_by_name': True}

Comentários

Esta página foi útil?