Activity Klasa

Działanie to podstawowy typ komunikacji dla protokołu Bot Framework 3.0.

Konstruktor

Activity(*, type=None, id: str = None, timestamp=None, local_timestamp=None, local_timezone: str = None, service_url: str = None, channel_id: str = None, from_property=None, conversation=None, recipient=None, text_format=None, attachment_layout=None, members_added=None, members_removed=None, reactions_added=None, reactions_removed=None, topic_name: str = None, history_disclosed: bool = None, locale: str = None, text: str = None, speak: str = None, input_hint=None, summary: str = None, suggested_actions=None, attachments=None, entities=None, channel_data=None, action: str = None, reply_to_id: str = None, label: str = None, value_type: str = None, value=None, name: str = None, relates_to=None, code=None, expiration=None, importance=None, delivery_mode=None, listen_for=None, text_highlights=None, semantic_action=None, caller_id: str = None, **kwargs)

Parametry

Nazwa Opis
type
Wymagane
str lub <xref:botframework.connector.models.ActivityTypes>

Zawiera typ działania. Możliwe wartości obejmują: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff"

id
Wymagane
str

Zawiera identyfikator, który jednoznacznie identyfikuje działanie w kanale.

timestamp
Wymagane

Zawiera datę i godzinę wysłania komunikatu w formacie UTC wyrażonym w formacie ISO-8601.

local_timestamp
Wymagane

Zawiera lokalną datę i godzinę komunikatu wyrażonego w formacie ISO-8601. Na przykład 2016-09-23T13:07:49.4714686-07:00.

local_timezone
Wymagane
str

Zawiera nazwę lokalnej strefy czasowej komunikatu wyrażonej w formacie bazy danych strefy czasowej IANA. Na przykład Ameryka/Los_Angeles.

service_url
Wymagane
str

Zawiera adres URL określający punkt końcowy usługi kanału. Ustaw według kanału.

channel_id
Wymagane
str

Zawiera identyfikator, który jednoznacznie identyfikuje kanał. Ustaw według kanału.

from_property
Wymagane
<xref:botframework.connector.models.ChannelAccount>

Identyfikuje nadawcę wiadomości.

conversation
Wymagane
<xref:botframework.connector.models.ConversationAccount>

Określa konwersację, do której należy działanie.

recipient
Wymagane
<xref:botframework.connector.models.ChannelAccount>

Identyfikuje adresata wiadomości.

text_format
Wymagane
str lub <xref:botframework.connector.models.TextFormatTypes>

Format pól tekstowych Default:markdown. Możliwe wartości to: "markdown", "plain", "xml"

attachment_layout
Wymagane
str lub <xref:botframework.connector.models.AttachmentLayoutTypes>

Wskazówka układu dla wielu załączników. Ustawienie domyślne: lista. Możliwe wartości to: "list", "karuzela"

members_added
Wymagane
list[<xref:botframework.connector.models.ChannelAccount>]

Kolekcja członków dodanych do konwersacji.

members_removed
Wymagane
list[<xref:botframework.connector.models.ChannelAccount>]

Kolekcja członków usunięta z konwersacji.

reactions_added
Wymagane
list[<xref:botframework.connector.models.MessageReaction>]

Kolekcja reakcji dodanych do konwersacji.

reactions_removed
Wymagane
list[<xref:botframework.connector.models.MessageReaction>]

Kolekcja reakcji usuniętych z konwersacji.

topic_name
Wymagane
str

Zaktualizowana nazwa tematu konwersacji.

history_disclosed
Wymagane

Wskazuje, czy wcześniejsza historia kanału została ujawniona.

locale
Wymagane
str

Nazwa ustawień regionalnych dla zawartości pola tekstowego. Nazwa ustawień regionalnych jest kombinacją dwuliterowego lub trzyliterowego kodu kultury ISO 639 skojarzonego z językiem i dwuliterowego kodu subkultury ISO 3166 skojarzonego z krajem lub regionem. Nazwa ustawień regionalnych może również odpowiadać prawidłowemu tagowi języka BCP-47.

text
Wymagane
str

Zawartość tekstowa wiadomości.

speak
Wymagane
str

Tekst do mówienia.

input_hint
Wymagane
str lub <xref:botframework.connector.models.InputHints>

Wskazuje, czy bot akceptuje, oczekuje lub ignoruje dane wejściowe użytkownika po dostarczeniu komunikatu do klienta. Możliwe wartości to: "acceptingInput", "ignoringInput", "expectingInput"

summary
Wymagane
str

Tekst do wyświetlenia, jeśli kanał nie może renderować kart.

suggested_actions
Wymagane
<xref:botframework.connector.models.SuggestedActions>

Sugerowane akcje dla działania.

attachments
Wymagane
list[<xref:botframework.connector.models.Attachment>]

Załączniki

entities
Wymagane
list[<xref:botframework.connector.models.Entity>]

Reprezentuje jednostki wymienione w komunikacie.

channel_data
Wymagane

Zawiera zawartość specyficzną dla kanału.

action
Wymagane
str

Wskazuje, czy odbiorca contactRelationUpdate został dodany, czy usunięty z listy kontaktów nadawcy.

reply_to_id
Wymagane
str

Zawiera identyfikator wiadomości, do której ta wiadomość jest odpowiedzią.

label
Wymagane
str

Etykieta opisowa działania.

value_type
Wymagane
str

Typ obiektu wartości działania.

value
Wymagane

Wartość skojarzona z działaniem.

name
Wymagane
str

Nazwa operacji skojarzonej z działaniem wywołania lub zdarzenia.

relates_to
Wymagane
<xref:botframework.connector.models.ConversationReference>

Odwołanie do innej konwersacji lub aktywności.

code
Wymagane
str lub <xref:botframework.connector.models.EndOfConversationCodes>

Kod działań endOfConversation wskazujący, dlaczego konwersacja zakończyła się. Możliwe wartości obejmują: "unknown", "completedSuccessfully", "userCancelled", "botTimedOut", "botIssuedInvalidMessage", "channelFailed"

expiration
Wymagane

Czas, w którym działanie powinno być uznawane za "wygasłe" i nie powinno być prezentowane adresatowi.

importance
Wymagane
str lub <xref:botframework.connector.models.ActivityImportance>

Znaczenie działania. Możliwe wartości to: "niski", "normalny", "wysoki"

delivery_mode
Wymagane
str lub <xref:botframework.connector.models.DeliveryModes>

Wskazówka dostarczania sygnalizowana alternatywnym ścieżkom dostarczania odbiorcy dla działania. Domyślny tryb dostarczania to "default". Możliwe wartości obejmują: "normal", "notification", "expectReplies", "efemeryczny"

listen_for
Wymagane

Lista fraz i odwołań, które systemy zamiany mowy i języka powinny nasłuchiwać

text_highlights
Wymagane
list[<xref:botframework.connector.models.TextHighlight>]

Kolekcja fragmentów tekstu do wyróżnienia, gdy działanie zawiera wartość ReplyToId.

semantic_action
Wymagane
<xref:botframework.connector.models.SemanticAction>

Opcjonalna akcja programowa towarzysząca temu żądaniu

caller_id
Wymagane
str

Ciąg zawierający IRI identyfikujący obiekt wywołujący bota. To pole nie jest przeznaczone do przesyłania za pośrednictwem przewodu, ale zamiast tego jest wypełniane przez boty i klientów na podstawie kryptograficznie weryfikowalnych danych, które potwierdzają tożsamość osób wywołujących (np. tokeny).

Parametry Tylko słowo kluczowe

Nazwa Opis
type
Wymagane
id
Wymagane
timestamp
Wymagane
local_timestamp
Wymagane
local_timezone
Wymagane
service_url
Wymagane
channel_id
Wymagane
from_property
Wymagane
conversation
Wymagane
recipient
Wymagane
text_format
Wymagane
attachment_layout
Wymagane
members_added
Wymagane
members_removed
Wymagane
reactions_added
Wymagane
reactions_removed
Wymagane
topic_name
Wymagane
history_disclosed
Wymagane
locale
Wymagane
text
Wymagane
speak
Wymagane
input_hint
Wymagane
summary
Wymagane
suggested_actions
Wymagane
attachments
Wymagane
entities
Wymagane
channel_data
Wymagane
action
Wymagane
reply_to_id
Wymagane
label
Wymagane
value_type
Wymagane
value
Wymagane
name
Wymagane
relates_to
Wymagane
code
Wymagane
expiration
Wymagane
importance
Wymagane
delivery_mode
Wymagane
listen_for
Wymagane
text_highlights
Wymagane
semantic_action
Wymagane
caller_id
Wymagane

Metody

apply_conversation_reference

Aktualizuje to działanie przy użyciu informacji o dostarczaniu z istniejącej usługi ConversationReference

aktywność przychodząca, gdzie bot jest adresatem; w przeciwnym razie, Fałsz. Wartość domyślna to Fałsz, a działanie spowoduje wyświetlenie bota jako nadawcy.

as_contact_relation_update_activity

Zwraca to działanie jako obiekt ContactRelationUpdateActivity; lub Brak, jeśli nie jest to typ działania.

as_conversation_update_activity

Zwraca to działanie jako obiekt ConversationUpdateActivity; lub Brak, jeśli nie jest to typ działania.

as_end_of_conversation_activity

Zwraca to działanie jako obiekt EndOfConversationActivity; lub Brak, jeśli nie jest to typ działania.

as_event_activity

Zwraca to działanie jako obiekt EventActivity; lub Brak, jeśli nie jest to typ działania.

as_handoff_activity

Zwraca to działanie jako obiekt HandoffActivity; lub Brak, jeśli nie jest to typ działania.

as_installation_update_activity

Zwraca to działanie jako obiekt InstallationUpdateActivity; lub Brak, jeśli nie jest to typ działania.

as_invoke_activity

Zwraca to działanie jako obiekt InvokeActivity; lub Brak, jeśli nie jest to typ działania.

as_message_activity

Zwraca to działanie jako obiekt MessageActivity; lub Brak, jeśli nie jest to typ działania.

as_message_delete_activity

Zwraca to działanie jako obiekt MessageDeleteActivity; lub Brak, jeśli nie jest to typ działania.

as_message_reaction_activity

Zwraca to działanie jako obiekt MessageReactionActivity; lub Brak, jeśli nie jest to typ działania.

as_message_update_activity

Zwraca to działanie jako obiekt MessageUpdateActivity; lub Brak, jeśli nie jest to typ działania.

as_suggestion_activity

Zwraca to działanie jako obiekt SuggestionActivity; lub Brak, jeśli nie jest to typ działania.

as_trace_activity

Zwraca to działanie jako obiekt TraceActivity; lub Brak, jeśli nie jest to typ działania.

as_typing_activity

Zwraca to działanie jako obiekt TypingActivity; lub null, jeśli nie jest to typ działania.

create_contact_relation_update_activity

Tworzy wystąpienie klasy Activity jako obiekt aContactRelationUpdateActivity.

create_conversation_update_activity

Tworzy wystąpienie klasy Activity jako obiekt ConversationUpdateActivity.

create_end_of_conversation_activity

Tworzy wystąpienie klasy Activity jako obiekt EndOfConversationActivity.

create_event_activity

Tworzy wystąpienie klasy Activity jako obiekt EventActivity.

create_handoff_activity

Tworzy wystąpienie klasy Activity jako obiekt HandoffActivity.

create_invoke_activity

Tworzy wystąpienie klasy Activity jako obiekt InvokeActivity.

create_message_activity

Tworzy wystąpienie klasy Activity jako obiekt MessageActivity.

create_reply

Tworzy nowe działanie komunikatu jako odpowiedź na to działanie.

create_trace

Tworzy nowe działanie śledzenia na podstawie tego działania.

Wartość domyślna to nazwa typu wartości. etykieta :p aram: opcjonalna etykieta opisowa dla tej operacji śledzenia.

create_trace_activity

Tworzy wystąpienie klasy Activity jako obiekt TraceActivity.

Wartość domyślna to nazwa typu wartości. etykieta :p aram: opcjonalna etykieta opisowa dla tej operacji śledzenia.

create_typing_activity

Tworzy wystąpienie klasy Activity jako obiekt TypingActivity.

get_conversation_reference

Tworzy element ConversationReference na podstawie tego działania.

get_mentions

Usuwa wzmianki z jednostek tego działania.

get_reply_conversation_reference

Utwórz element ConversationReference na podstawie informacji o konwersacji tego działania i zasobuResponse z wysyłania działania.

has_content

Wskazuje, czy to działanie ma zawartość.

is_from_streaming_connection

Ustal, czy działanie zostało wysłane za pośrednictwem połączenia HTTP/HTTPS lub przesyłania strumieniowego. Można to określić, patrząc na właściwość service_url: (1) Wszystkie kanały wysyłające komunikaty za pośrednictwem protokołu http/https nie są kanałami przesyłania strumieniowego (2) wysyłającymi komunikaty za pośrednictwem przesyłania strumieniowego, mają właściwość ServiceUrl, która nie zaczyna się od http/https.

apply_conversation_reference

Aktualizuje to działanie przy użyciu informacji o dostarczaniu z istniejącej usługi ConversationReference

aktywność przychodząca, gdzie bot jest adresatem; w przeciwnym razie, Fałsz. Wartość domyślna to Fałsz, a działanie spowoduje wyświetlenie bota jako nadawcy.

apply_conversation_reference(reference: ConversationReference, is_incoming: bool = False)

Parametry

Nazwa Opis
reference
Wymagane
is_incoming
Domyślna wartość: False

Zwraca

Typ Opis

jego działalność, zaktualizowana o informacje o dostawie.

Uwagi

Wywołaj metodę GetConversationReference dla działania przychodzącego, aby uzyskać odwołanie do konwersacji, których można następnie użyć do zaktualizowania działania wychodzącego przy użyciu prawidłowych informacji o dostarczaniu.

as_contact_relation_update_activity

Zwraca to działanie jako obiekt ContactRelationUpdateActivity; lub Brak, jeśli nie jest to typ działania.

as_contact_relation_update_activity()

Zwraca

Typ Opis

To działanie jako działanie komunikatu; lub Brak.

as_conversation_update_activity

Zwraca to działanie jako obiekt ConversationUpdateActivity; lub Brak, jeśli nie jest to typ działania.

as_conversation_update_activity()

Zwraca

Typ Opis

To działanie jako działanie aktualizacji konwersacji; lub Brak.

as_end_of_conversation_activity

Zwraca to działanie jako obiekt EndOfConversationActivity; lub Brak, jeśli nie jest to typ działania.

as_end_of_conversation_activity()

Zwraca

Typ Opis

To działanie jako koniec działania konwersacji; lub Brak.

as_event_activity

Zwraca to działanie jako obiekt EventActivity; lub Brak, jeśli nie jest to typ działania.

as_event_activity()

Zwraca

Typ Opis

To działanie jako działanie zdarzenia; lub Brak.

as_handoff_activity

Zwraca to działanie jako obiekt HandoffActivity; lub Brak, jeśli nie jest to typ działania.

as_handoff_activity()

Zwraca

Typ Opis

To działanie jako działanie przekazywania; lub Brak.

as_installation_update_activity

Zwraca to działanie jako obiekt InstallationUpdateActivity; lub Brak, jeśli nie jest to typ działania.

as_installation_update_activity()

Zwraca

Typ Opis

To działanie jako działanie aktualizacji instalacji; lub Brak.

as_invoke_activity

Zwraca to działanie jako obiekt InvokeActivity; lub Brak, jeśli nie jest to typ działania.

as_invoke_activity()

Zwraca

Typ Opis

To działanie jako działanie wywołania; lub Brak.

as_message_activity

Zwraca to działanie jako obiekt MessageActivity; lub Brak, jeśli nie jest to typ działania.

as_message_activity()

Zwraca

Typ Opis

To działanie jako działanie komunikatu; lub Brak.

as_message_delete_activity

Zwraca to działanie jako obiekt MessageDeleteActivity; lub Brak, jeśli nie jest to typ działania.

as_message_delete_activity()

Zwraca

Typ Opis

To działanie jako żądanie usunięcia komunikatu; lub Brak.

as_message_reaction_activity

Zwraca to działanie jako obiekt MessageReactionActivity; lub Brak, jeśli nie jest to typ działania.

as_message_reaction_activity()

Zwraca

Typ Opis

To działanie jako działanie reakcji komunikatu; lub Brak.

as_message_update_activity

Zwraca to działanie jako obiekt MessageUpdateActivity; lub Brak, jeśli nie jest to typ działania.

as_message_update_activity()

Zwraca

Typ Opis

To działanie jako żądanie aktualizacji komunikatu; lub Brak.

as_suggestion_activity

Zwraca to działanie jako obiekt SuggestionActivity; lub Brak, jeśli nie jest to typ działania.

as_suggestion_activity()

Zwraca

Typ Opis

To działanie jako działanie sugestii; lub Brak.

as_trace_activity

Zwraca to działanie jako obiekt TraceActivity; lub Brak, jeśli nie jest to typ działania.

as_trace_activity()

Zwraca

Typ Opis

To działanie jako działanie śledzenia; lub Brak.

as_typing_activity

Zwraca to działanie jako obiekt TypingActivity; lub null, jeśli nie jest to typ działania.

as_typing_activity()

Zwraca

Typ Opis

To działanie jako działanie wpisywania; lub null.

create_contact_relation_update_activity

Tworzy wystąpienie klasy Activity jako obiekt aContactRelationUpdateActivity.

static create_contact_relation_update_activity()

Zwraca

Typ Opis

Nowe działanie aktualizacji relacji kontaktów.

create_conversation_update_activity

Tworzy wystąpienie klasy Activity jako obiekt ConversationUpdateActivity.

static create_conversation_update_activity()

Zwraca

Typ Opis

Nowe działanie aktualizacji konwersacji.

create_end_of_conversation_activity

Tworzy wystąpienie klasy Activity jako obiekt EndOfConversationActivity.

static create_end_of_conversation_activity()

Zwraca

Typ Opis

Nowy koniec aktywności konwersacji.

create_event_activity

Tworzy wystąpienie klasy Activity jako obiekt EventActivity.

static create_event_activity()

Zwraca

Typ Opis

Nowe działanie zdarzenia.

create_handoff_activity

Tworzy wystąpienie klasy Activity jako obiekt HandoffActivity.

static create_handoff_activity()

Zwraca

Typ Opis

Nowe działanie przekazywania.

create_invoke_activity

Tworzy wystąpienie klasy Activity jako obiekt InvokeActivity.

static create_invoke_activity()

Zwraca

Typ Opis

Nowe działanie wywołania.

create_message_activity

Tworzy wystąpienie klasy Activity jako obiekt MessageActivity.

static create_message_activity()

Zwraca

Typ Opis

Nowe działanie komunikatu.

create_reply

Tworzy nowe działanie komunikatu jako odpowiedź na to działanie.

create_reply(text: str = None, locale: str = None)

Parametry

Nazwa Opis
text

Tekst odpowiedzi.

Domyślna wartość: None
locale

Kod języka tekstu.

Domyślna wartość: None

Zwraca

Typ Opis

Nowe działanie komunikatu.

Uwagi

Nowe działanie konfiguruje informacje o routingu na podstawie tego działania.

create_trace

Tworzy nowe działanie śledzenia na podstawie tego działania.

Wartość domyślna to nazwa typu wartości. etykieta :p aram: opcjonalna etykieta opisowa dla tej operacji śledzenia.

create_trace(name: str, value: object = None, value_type: str = None, label: str = None)

Parametry

Nazwa Opis
name
Wymagane
value
Domyślna wartość: None
value_type
Domyślna wartość: None
label
Domyślna wartość: None

Zwraca

Typ Opis

Nowe działanie śledzenia.

create_trace_activity

Tworzy wystąpienie klasy Activity jako obiekt TraceActivity.

Wartość domyślna to nazwa typu wartości. etykieta :p aram: opcjonalna etykieta opisowa dla tej operacji śledzenia.

static create_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None)

Parametry

Nazwa Opis
name
Wymagane
value
Domyślna wartość: None
value_type
Domyślna wartość: None
label
Domyślna wartość: None

Zwraca

Typ Opis

Nowe działanie śledzenia.

create_typing_activity

Tworzy wystąpienie klasy Activity jako obiekt TypingActivity.

static create_typing_activity()

Zwraca

Typ Opis

Nowe działanie wpisywania.

get_conversation_reference

Tworzy element ConversationReference na podstawie tego działania.

get_conversation_reference()

Zwraca

Typ Opis

Odwołanie do konwersacji zawierającej to działanie.

get_mentions

Usuwa wzmianki z jednostek tego działania.

get_mentions() -> List[Mention]

Zwraca

Typ Opis

Tablica wzmianek; lub pusta tablica, jeśli nie zostanie znaleziona żadna.

Uwagi

Ta metoda jest zdefiniowana w klasie Activity, ale jest przeznaczona tylko do użycia z działaniem komunikatu, gdzie właściwość activity.Type jest ustawiona na ActivityTypes.Message.

get_reply_conversation_reference

Utwórz element ConversationReference na podstawie informacji o konwersacji tego działania i zasobuResponse z wysyłania działania.

get_reply_conversation_reference(reply: ResourceResponse) -> ConversationReference

Parametry

Nazwa Opis
reply
Wymagane

ZasóbResponse zwrócony z send_activity.

Zwraca

Typ Opis

KonwersacjaReferencja, która może być przechowywana i używana później do usunięcia lub zaktualizowania działania.

has_content

Wskazuje, czy to działanie ma zawartość.

has_content() -> bool

Zwraca

Typ Opis

Prawda, jeśli to działanie ma dowolną zawartość do wysłania; w przeciwnym razie, fałsz.

Uwagi

Ta metoda jest zdefiniowana w klasie Activity, ale jest przeznaczona tylko do użycia z działaniem komunikatu, gdzie właściwość activity.Type jest ustawiona na ActivityTypes.Message.

is_from_streaming_connection

Ustal, czy działanie zostało wysłane za pośrednictwem połączenia HTTP/HTTPS lub przesyłania strumieniowego. Można to określić, patrząc na właściwość service_url: (1) Wszystkie kanały wysyłające komunikaty za pośrednictwem protokołu http/https nie są kanałami przesyłania strumieniowego (2) wysyłającymi komunikaty za pośrednictwem przesyłania strumieniowego, mają właściwość ServiceUrl, która nie zaczyna się od http/https.

is_from_streaming_connection() -> bool

Zwraca

Typ Opis

Wartość True, jeśli działanie pochodzi z połączenia przesyłania strumieniowego.