MessageActivityInput Klasse

Eingabemodell zum Erstellen von Nachrichtenaktivitäten mit Generatormethoden.

Erstellen Sie ein neues Modell, indem Sie Eingabedaten aus Schlüsselwortargumenten analysieren und validieren.

Löst [ValidationError][pydantic_core. ValidationError] wenn die Eingabedaten nicht überprüft werden können, um ein gültiges Modell zu bilden.

self ist explizit positional, um selbst als Feldnamen zuzulassen.

Konstruktor

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)

Nur Schlüsselwortparameter

Name Beschreibung
serviceUrl
Standardwert: None
timestamp
Standardwert: None
locale
Standardwert: None
localTimestamp
Standardwert: None
channelId
Standardwert: None
from_
Standardwert: None
conversation
Standardwert: None
replyToId
Standardwert: None
entities
Standardwert: None
channelData
Standardwert: None
type
Standardwert: message
id
Standardwert: None
recipient
Standardwert: None
text
Standardwert: None
summary
Standardwert: None
textFormat
Standardwert: None
attachmentLayout
Standardwert: None
attachments
Standardwert: None
suggestedActions
Standardwert: None
deliveryMode
Standardwert: None
value
Standardwert: None

Methoden

add_ai_generated

Fügen Sie die Bezeichnung "Generiert von KI" hinzu.
add_attachments

Fügen Sie der Nachricht Anlagen hinzu.
add_card

Fügen Sie der Nachricht eine Kartenanlage hinzu.
add_citation

Fügen Sie Zitate hinzu.
add_feedback

Nachrichtenfeedback aktivieren.
add_mention

Fügen Sie der Nachricht eine Erwähnung (@mention) hinzu.
add_quote

Fügen Sie einen Verweis auf zitierte Nachrichten hinzu, und fügen Sie einen Platzhalter an Text an. Teams rendert die zitierte Nachricht als Vorschaublase oberhalb des Antworttexts. Wenn Text bereitgestellt wird, wird er an den Platzhalter für zitierte Nachrichten angefügt.

Warning

Bald verfügbar

Diese API wird in Kürze verfügbar sein und kann sich in Zukunft ändern.

Diagnose: ExperimentalTeamsQuotedReplies
add_stream_final

Fügen Sie Datenstrominformationen hinzu, wodurch dies zu einer endgültigen Streamnachricht wird.
add_targeted_message_info

Fügen Sie eine targetedMessageInfo-Entität für die Eingabeaufforderungsvorschau hinzu.

Wenn eine Entität mit Typ "targetedMessageInfo" bereits vorhanden ist, wird sie nicht erneut hinzugefügt (eine Eingabeaufforderungsvorschau pro Nachricht).

Beim Hinzufügen der Entität werden alle quotedReply Entitäten und übereinstimmenden <quoted messageId="..."/> Platzhaltertext entfernt, um Kollisionen mit der Eingabeaufforderungsvorschau zu vermeiden.
add_text

An die Nachricht Text anfügen.
get_account_mention

Rufen Sie eine Erwähnungsentität nach Konto-ID ab.
is_recipient_mentioned

Überprüfen Sie, ob das Empfängerkonto in der Nachricht erwähnt wird.
prepend_quote

Stellen Sie vor dem vorhandenen Text eine an zitierte Entität und einen Platzhalter vor. Wird von reply()/quote() für Anführungszeichen oberhalb der Antwort verwendet.

Warning

Bald verfügbar

Diese API wird in Kürze verfügbar sein und kann sich in Zukunft ändern.

Diagnose: ExperimentalTeamsQuotedReplies
with_attachment_layout

Legen Sie den Layouthinweis für mehrere Anlagen fest.
with_delivery_mode

Legen Sie den Übermittlungsmodus für die Aktivität fest.
with_recipient

Legen Sie den Empfänger fest.
with_suggested_actions

Legen Sie die vorgeschlagenen Aktionen für die Aktivität fest.
with_summary

Legen Sie den anzuzeigenden Text fest, wenn der Kanal keine Karten rendern kann.
with_text

Legen Sie den Textinhalt der Nachricht fest.
with_text_format

Legen Sie das Format von Textfeldern fest.

add_ai_generated

Fügen Sie die Bezeichnung "Generiert von KI" hinzu.

add_ai_generated() -> Self

add_attachments

Fügen Sie der Nachricht Anlagen hinzu.

add_attachments(*attachments: Attachment) -> Self

Parameter

Name Beschreibung
*attachments
Erforderlich

Hinzuzufügende Anlagen

Gibt zurück

Typ Beschreibung

Self for method chaining

add_card

Fügen Sie der Nachricht eine Kartenanlage hinzu.

add_card(card: AdaptiveCard) -> Self

Parameter

Name Beschreibung
card
Erforderlich

Die hinzuzufügende Kartenanlage
content
Erforderlich

Der Karteninhalt

Gibt zurück

Typ Beschreibung

Self for method chaining

add_citation

Fügen Sie Zitate hinzu.

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

Parameter

Name Beschreibung
position
Erforderlich
appearance
Erforderlich

add_feedback

Nachrichtenfeedback aktivieren.

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

Parameter

Name Beschreibung
mode

"Standard" zeigt die integrierte Benutzeroberfläche von Teams an. "custom" löst eine Nachricht/fetchTask-Aufruf aus, damit der Bot sein eigenes Aufgabenmoduldialogfeld zurückgeben kann.

Standardwert: default

add_mention

Fügen Sie der Nachricht eine Erwähnung (@mention) hinzu.

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

Parameter

Name Beschreibung
account
Erforderlich

Das zu erwähnende Konto
text

Benutzerdefinierter Text für die Erwähnung (Standardeinstellung für account.name)

Standardwert: None
add_text

Gibt an, ob der Erwähnungstext an die Nachricht angefügt werden soll.

Standardwert: True

Gibt zurück

Typ Beschreibung

Self for method chaining

add_quote

Fügen Sie einen Verweis auf zitierte Nachrichten hinzu, und fügen Sie einen Platzhalter an Text an. Teams rendert die zitierte Nachricht als Vorschaublase oberhalb des Antworttexts. Wenn Text bereitgestellt wird, wird er an den Platzhalter für zitierte Nachrichten angefügt.

Warning

Bald verfügbar

Diese API wird in Kürze verfügbar sein und kann sich in Zukunft ändern.

Diagnose: ExperimentalTeamsQuotedReplies

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

Parameter

Name Beschreibung
message_id
Erforderlich

Die ID der zu zitierenden Nachricht
text

Optionaler Text, der an den Platzhalter für zitierte Nachrichten angefügt wird

Standardwert: None

Gibt zurück

Typ Beschreibung

Self for method chaining

add_stream_final

Fügen Sie Datenstrominformationen hinzu, wodurch dies zu einer endgültigen Streamnachricht wird.

add_stream_final() -> Self

Gibt zurück

Typ Beschreibung

Self for method chaining

add_targeted_message_info

Fügen Sie eine targetedMessageInfo-Entität für die Eingabeaufforderungsvorschau hinzu.

Wenn eine Entität mit Typ "targetedMessageInfo" bereits vorhanden ist, wird sie nicht erneut hinzugefügt (eine Eingabeaufforderungsvorschau pro Nachricht).

Beim Hinzufügen der Entität werden alle quotedReply Entitäten und übereinstimmenden <quoted messageId="..."/> Platzhaltertext entfernt, um Kollisionen mit der Eingabeaufforderungsvorschau zu vermeiden.

add_targeted_message_info(message_id: str) -> Self

Parameter

Name Beschreibung
message_id
Erforderlich

Die Nachrichten-ID der Zielnachricht.

Gibt zurück

Typ Beschreibung

Self for method chaining

add_text

An die Nachricht Text anfügen.

add_text(text: str) -> Self

Parameter

Name Beschreibung
text
Erforderlich

Anzufügenden Text

Gibt zurück

Typ Beschreibung

Self for method chaining

get_account_mention

Rufen Sie eine Erwähnungsentität nach Konto-ID ab.

get_account_mention(account_id: str) -> MentionEntity | None

Parameter

Name Beschreibung
account_id
Erforderlich

Die konto-ID, nach der gesucht werden soll

Gibt zurück

Typ Beschreibung

Die Erwähnungsentität, falls gefunden, andernfalls Keine

is_recipient_mentioned

Überprüfen Sie, ob das Empfängerkonto in der Nachricht erwähnt wird.

is_recipient_mentioned() -> bool

Gibt zurück

Typ Beschreibung

True, wenn der Empfänger erwähnt wird

prepend_quote

Stellen Sie vor dem vorhandenen Text eine an zitierte Entität und einen Platzhalter vor. Wird von reply()/quote() für Anführungszeichen oberhalb der Antwort verwendet.

Warning

Bald verfügbar

Diese API wird in Kürze verfügbar sein und kann sich in Zukunft ändern.

Diagnose: ExperimentalTeamsQuotedReplies

prepend_quote(message_id: str) -> Self

Parameter

Name Beschreibung
message_id
Erforderlich

Die IC3-Nachrichten-ID der Nachricht, an die Sie anführungszeichen möchten

Gibt zurück

Typ Beschreibung

Self for method chaining

with_attachment_layout

Legen Sie den Layouthinweis für mehrere Anlagen fest.

with_attachment_layout(attachment_layout: AttachmentLayout) -> Self

Parameter

Name Beschreibung
attachment_layout
Erforderlich

Anlagenlayout (Liste, Karussell)

Gibt zurück

Typ Beschreibung

Self for method chaining

with_delivery_mode

Legen Sie den Übermittlungsmodus für die Aktivität fest.

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

Parameter

Name Beschreibung
delivery_mode
Erforderlich

Übermittlungsmodus (normal, Benachrichtigung)

Gibt zurück

Typ Beschreibung

Self for method chaining

with_recipient

Legen Sie den Empfänger fest.

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

Parameter

Name Beschreibung
value
Erforderlich

Das Empfängerkonto
is_targeted

Bei "True" wird dies nur für diesen Empfänger als zielorientierte Nachricht markiert. Wenn False, wird die Zielbestimmung explizit gelöscht. If None (the default), the existing is_targeted value is left unchanged.

Standardwert: None

Gibt zurück

Typ Beschreibung

Self for method chaining

with_suggested_actions

Legen Sie die vorgeschlagenen Aktionen für die Aktivität fest.

with_suggested_actions(suggested_actions: SuggestedActions) -> Self

Parameter

Name Beschreibung
suggested_actions
Erforderlich

Empfohlene Maßnahmen

Gibt zurück

Typ Beschreibung

Self for method chaining

with_summary

Legen Sie den anzuzeigenden Text fest, wenn der Kanal keine Karten rendern kann.

with_summary(summary: str) -> Self

Parameter

Name Beschreibung
summary
Erforderlich

Zusammenfassungstext

Gibt zurück

Typ Beschreibung

Self for method chaining

with_text

Legen Sie den Textinhalt der Nachricht fest.

with_text(text: str) -> Self

Parameter

Name Beschreibung
text
Erforderlich

Festzulegenden Text

Gibt zurück

Typ Beschreibung

Self for method chaining

with_text_format

Legen Sie das Format von Textfeldern fest.

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

Parameter

Name Beschreibung
text_format
Erforderlich

Textformat (Markdown, Plain, XML)

Gibt zurück

Typ Beschreibung

Self for method chaining

Attribute

model_config

Die Konfiguration für das Modell sollte ein Wörterbuch sein, das [ConfigDict][pydantic.configentspricht. 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}