MessageActivityInput Classe

Modelo de entrada para criar atividades de mensagens com métodos de construção.

Crie um novo modelo analisando e validando dados de entrada a partir de argumentos de palavras-chave.

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

self é explicitamente apenas posicional para permitir self como 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 Só de Palavra-Chave

Name	Descrição
serviceUrl	Valor predefinido: None
timestamp	Valor predefinido: None
locale	Valor predefinido: None
localTimestamp	Valor predefinido: None
channelId	Valor predefinido: None
from_	Valor predefinido: None
conversation	Valor predefinido: None
replyToId	Valor predefinido: None
entities	Valor predefinido: None
channelData	Valor predefinido: None
type	Valor predefinido: message
id	Valor predefinido: None
recipient	Valor predefinido: None
text	Valor predefinido: None
summary	Valor predefinido: None
textFormat	Valor predefinido: None
attachmentLayout	Valor predefinido: None
attachments	Valor predefinido: None
suggestedActions	Valor predefinido: None
deliveryMode	Valor predefinido: None
value	Valor predefinido: None

Métodos

add_ai_generated	Adicione a etiqueta 'Gerado por IA'.
add_attachments	Adicione anexos à mensagem.
add_card	Adicione um anexo de cartão à mensagem.
add_citation	Adicione citações.
add_feedback	Ativar o feedback das mensagens.
add_mention	Adicione uma menção (@mention) à mensagem.
add_quote	Adicione uma referência de mensagem entre aspas e acrescente um marcador de posição ao texto. O Teams apresenta a mensagem citada como uma bolha de pré-visualização acima do texto da resposta. Se for fornecido texto, este é anexado ao marcador de página da mensagem citada. Warning Brevemente Esta API está a chegar em breve e pode mudar no futuro. Diagnóstico: ExperimentalTeamsQuotedRespondies
add_stream_final	Adicione informações do stream, tornando esta uma mensagem final do stream.
add_targeted_message_info	Adicione uma entidade TargetedMessageInfo para pré-visualização de prompts. Se uma entidade com tipo `"targetedMessageInfo"` já existir, não é adicionada novamente (uma pré-visualização de prompt por mensagem). Ao adicionar a entidade, quaisquer `quotedReply` entidades e o texto provisório correspondente `<quoted messageId="..."/>` são removidos para evitar colisão com a pré-visualização de prompt.
add_text	Adicione texto à mensagem.
get_account_mention	Obtenha uma entidade mencionada pelo ID da conta.
is_recipient_mentioned	Verifica se a conta destinatária é mencionada na mensagem.
prepend_quote	Anteponha uma entidade de Resposta entre aspas e um marcador de posição antes do texto existente. Usado por reple()/quote() para citação acima. Warning Brevemente Esta API está a chegar em breve e pode mudar no futuro. Diagnóstico: ExperimentalTeamsQuotedRespondies
with_attachment_layout	Defina a dica de layout para múltiplos anexos.
with_delivery_mode	Defina o modo de entrega da atividade.
with_recipient	Defina o destinatário.
with_suggested_actions	Defina as ações sugeridas para a atividade.
with_summary	Defina o texto para mostrar se o canal não conseguir renderizar cartões.
with_text	Defina o conteúdo de texto da mensagem.
with_text_format	Defina o formato dos campos de texto.

add_ai_generated

Adicione a etiqueta 'Gerado por IA'.

add_ai_generated() -> Self

add_attachments

Adicione anexos à mensagem.

add_attachments(*attachments: Attachment) -> Self

Parâmetros

Name	Descrição
*attachments Obrigatório	Anexos para acrescentar

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

add_card

Adicione um anexo de cartão à mensagem.

add_card(card: AdaptiveCard) -> Self

Parâmetros

Name	Descrição
card Obrigatório	O anexo do cartão para adicionar
content Obrigatório	O conteúdo do cartão

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

add_citation

Adicione citações.

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

Parâmetros

Name	Descrição
position Obrigatório
appearance Obrigatório

add_feedback

Ativar o feedback das mensagens.

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

Parâmetros

Name	Descrição
mode	"padrão" mostra a interface integrada do Teams com os polegares para cima/baixo. "custom" desencadeia uma invocação de mensagem/fetchTask para que o bot possa devolver o seu próprio diálogo de módulo de tarefa. Valor predefinido: default

add_mention

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

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

Parâmetros

Name	Descrição
account Obrigatório	O relato a mencionar
text	Texto personalizado para a menção (por defeito é account.name) Valor predefinido: None
add_text	Se deve acrescentar o texto da menção à mensagem Valor predefinido: True

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

add_quote

Adicione uma referência de mensagem entre aspas e acrescente um marcador de posição ao texto. O Teams apresenta a mensagem citada como uma bolha de pré-visualização acima do texto da resposta. Se for fornecido texto, este é anexado ao marcador de página da mensagem citada.

Warning

Brevemente

Esta API está a chegar em breve e pode mudar no futuro.

Diagnóstico: ExperimentalTeamsQuotedRespondies

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

Parâmetros

Name	Descrição
message_id Obrigatório	O ID da mensagem a citar
text	Texto opcional, anexado ao marcador da mensagem citada Valor predefinido: None

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

add_stream_final

Adicione informações do stream, tornando esta uma mensagem final do stream.

add_stream_final() -> Self

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

add_targeted_message_info

Adicione uma entidade TargetedMessageInfo para pré-visualização de prompts.

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

Ao adicionar a entidade, quaisquer quotedReply entidades e o texto provisório correspondente <quoted messageId="..."/> são removidos para evitar colisão com a pré-visualização de prompt.

add_targeted_message_info(message_id: str) -> Self

Parâmetros

Name	Descrição
message_id Obrigatório	O ID da mensagem alvo.

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

add_text

Adicione texto à mensagem.

add_text(text: str) -> Self

Parâmetros

Name	Descrição
text Obrigatório	Texto para anexar

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

get_account_mention

Obtenha uma entidade mencionada pelo ID da conta.

get_account_mention(account_id: str) -> MentionEntity | None

Parâmetros

Name	Descrição
account_id Obrigatório	O ID da conta a procurar

Devoluções

Tipo	Descrição
	A entidade mencionada se encontrada, Nenhuma, de outra forma

is_recipient_mentioned

Verifica se a conta destinatária é mencionada na mensagem.

is_recipient_mentioned() -> bool

Devoluções

Tipo	Descrição
	É verdade se o destinatário for mencionado

prepend_quote

Anteponha uma entidade de Resposta entre aspas e um marcador de posição antes do texto existente. Usado por reple()/quote() para citação acima.

Warning

Brevemente

Esta API está a chegar em breve e pode mudar no futuro.

Diagnóstico: ExperimentalTeamsQuotedRespondies

prepend_quote(message_id: str) -> Self

Parâmetros

Name	Descrição
message_id Obrigatório	O ID da mensagem IC3 da mensagem a citar

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

with_attachment_layout

Defina a dica de layout para múltiplos anexos.

with_attachment_layout(attachment_layout: AttachmentLayout) -> Self

Parâmetros

Name	Descrição
attachment_layout Obrigatório	Disposição dos anexos (lista, carrossel)

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

with_delivery_mode

Defina o modo de entrega da atividade.

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

Parâmetros

Name	Descrição
delivery_mode Obrigatório	Modo de entrega (normal, notificação)

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

with_recipient

Defina o destinatário.

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

Parâmetros

Name	Descrição
value Obrigatório	A conta destinatária
is_targeted	Se for Verdadeiro, marca esta mensagem como direcionada visível apenas para este destinatário. Se for Falso, limpa explicitamente o direcionamento. Se Nenhum (o padrão), o valor de is_targeted existente permanece inalterado. Valor predefinido: None

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

with_suggested_actions

Defina as ações sugeridas para a atividade.

with_suggested_actions(suggested_actions: SuggestedActions) -> Self

Parâmetros

Name	Descrição
suggested_actions Obrigatório	Ações sugeridas

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

with_summary

Defina o texto para mostrar se o canal não conseguir renderizar cartões.

with_summary(summary: str) -> Self

Parâmetros

Name	Descrição
summary Obrigatório	Texto resumo

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

with_text

Defina o conteúdo de texto da mensagem.

with_text(text: str) -> Self

Parâmetros

Name	Descrição
text Obrigatório	Texto para conjunto

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

with_text_format

Defina o formato dos campos de texto.

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

Parâmetros

Name	Descrição
text_format Obrigatório	Formato de texto (markdown, simples, xml)

Devoluções

Tipo	Descrição
	Auto para encadeamento de método

Atributos

model_config

A configuração do modelo deve ser um dicionário conforme a [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?