Dokumentacja kanałów
DOTYCZY: ZESTAW SDK w wersji 4
W tym artykule opisano obsługę kanałów dla różnych funkcji platformy Bot Framework:
- Typy działań mogą wysyłać lub odbierać poszczególne kanały.
- Karty typy poszczególnych kanałów mogą być wyświetlane, w tym karty adaptacyjne.
- Akcja karty i sugerowana obsługa akcji w każdym kanale.
- Ogólna klasyfikacja różnych typów działań.
Aby uzyskać szczegółowe informacje na temat struktury działań i kart na poziomie protokołu, zobacz Schematy działań i kart platformy Bot Framework.
Karty adaptacyjne to osobna technologia. Aby uzyskać więcej informacji, zobacz adaptivecards.io.
Obsługa działań według kanału
Poniższa tabela wskazuje, czy dany kanał może wysłać dany typ działania do bota. W tabeli następujące terminy mają następujące znaczenie.
Termin | Znaczenie |
---|---|
Tak | Bot może odbierać to działanie z kanału. |
Nie. | Bot nie może odebrać tego działania z kanału. |
Nieokreślone | Obecnie nieokreślone. |
Kanał | Aktualizacja relacji kontaktu | Aktualizacja konwersacji | Koniec konwersacji | Wydarzenie | Aktualizacja instalacji | Wywołanie | Wiadomość | Reakcja komunikatu | Aktualizacja komunikatów | Usuwanie wiadomości | Wpisywanie |
---|---|---|---|---|---|---|---|---|---|---|---|
Alexa | Nie. | VAT | Tak | Tak | VAT | VAT | Tak | VAT | VAT | VAT | Nie. |
Azure Communication Services Chat | Nie. | Tak | VAT | Tak | VAT | VAT | Tak | VAT | Tak | Tak | Tak |
Direct Line | Nie. | Tak | Tak | Tak | Tak | VAT | Tak | VAT | VAT | VAT | Tak |
Mowa Direct Line | Tak | ||||||||||
Poczta e-mail | Nie. | VAT | Nie. | Nieokreślone | Nie. | VAT | Tak | VAT | VAT | VAT | Nie. |
Nie. | Tak | VAT | Tak | VAT | VAT | Tak | Tak | VAT | VAT | Nie. | |
GroupMe | Nie. | Tak | Nie. | Nieokreślone | Nie. | VAT | Tak | VAT | VAT | VAT | Nie. |
LINE | Nie. | Tak | VAT | Tak | VAT | VAT | Tak | VAT | VAT | VAT | Nie. |
Microsoft Teams | Nie. | Tak | Nie. | Nieokreślone | Nie. | Tak | Tak | Tak | Tak | Tak | Nie. |
Obsługa wielokanałowa | Tak | ||||||||||
Outlook (wersja zapoznawcza) | Tak | ||||||||||
Wyszukiwanie (wersja zapoznawcza) | Tak | ||||||||||
Slack | Nie. | Tak | Nie. | Nieokreślone | Nie. | VAT | Tak | VAT | Tak | Tak | Nie. |
Telegram | Nie. | Tak | Nie. | Nieokreślone | Nie. | VAT | Tak | VAT | Tak | Nieokreślone | Nie. |
Twilio (SMS) | Nie. | VAT | Nie. | Nieokreślone | Nie. | VAT | Tak | VAT | VAT | VAT | Nie. |
Czat internetowy | Nie. | Tak | Tak | Tak | Tak | VAT | Tak | VAT | VAT | VAT | Tak |
Obsługa działań event
i invoke
różni się w zależności od nazwy działania i różni się w zależności od kanału.
Obsługa karty przez kanał
Poniższa tabela wskazuje, czy dany kanał może renderować dany typ karty. Nawet jeśli kanał może renderować typ karty, kanał może nie obsługiwać wszystkich funkcji na karcie. Przed zwolnieniem bota przetestuj zachowanie każdej karty, która może wysłać bot.
W tabeli następujące terminy mają następujące znaczenie.
Termin | Znaczenie |
---|---|
Tak | Karta jest obsługiwana w tym kanale; jednak każdy dany kanał może obsługiwać tylko podzestaw akcji karty lub może ograniczyć liczbę akcji dozwolonych na każdej karcie. |
Nie. | Karta nie jest obsługiwana w tym kanale. |
Częściowe | Częściowa obsługa. Ten kanał może nie wyświetlać karty, jeśli karta zawiera dane wejściowe lub przyciski. Poziom obsługi różni się w zależności od kanału. |
Obraz | Karta jest konwertowana na obraz. |
Text | Karta jest konwertowana na niesformatowany tekst. Linki mogą nie być klikalne, obrazy mogą nie być wyświetlane, a nośniki mogą nie być odtwarzalne. Poziom obsługi różni się w zależności od kanału. |
Kanał | Karta adaptacyjna | Karta animacji | Karta Audio | Karta Hero | Karta paragonu | Karta logowania | Karta Thumbnail | Karta wideo |
---|---|---|---|---|---|---|---|---|
Alexa | Nie. | VAT | VAT | Tak | VAT | Tak | VAT | Nie. |
Azure Communication Services Chat | Tak* | Tak | Tak | Tak | Tak | Tak | Tak | Tak |
Poczta e-mail | Obraz | Text | Tekst | Tak | Tak | Tak | Tak | Text |
Obraz, częściowy | Tak | Tak | Tak | Tak | Tak | Tak | Tak | |
GroupMe | Obraz | Text | Text | Text | Text | Text | Text | Text |
LINE | Obraz, częściowy | Tak | Tekst | Tak | Tak | Tak | Tak | Text |
Microsoft Teams | Tak | VAT | VAT | Tak | Tak | Tak | Tak | Nie. |
Obsługa wielokanałowa | ||||||||
Outlook (wersja zapoznawcza) | ||||||||
Wyszukiwanie (wersja zapoznawcza) | ||||||||
Slack | Obraz | Tak | Text | Tekst | Tak | Tak | Text | Text |
Telegram | Obraz, częściowy | Tak | Tekst | Tak | Tak | Tak | Tak | Tak |
Twilio (SMS) | Obraz | Tekst | Nie. | Text | Text | Text | Tekst | Nie. |
Czat internetowy | Tak | Tak | Tak | Tak | Tak | Tak | Tak | Tak |
Uwaga
- Kanał Direct Line technicznie obsługuje wszystkie karty, ale do klienta należy ich zaimplementowanie.
- *W przypadku czatu usług Azure Communication Services karty adaptacyjne są obsługiwane tylko w przypadku przypadków użycia usług Azure Communication Services, a nie dla usług Azure Communication Services w przypadku przypadków użycia usługi Teams.
Obsługa akcji karty według kanału
W poniższej tabeli przedstawiono maksymalną liczbę sugerowanych akcji i akcji kart, które obsługuje dany kanał. Wartość "Brak" wskazuje, że typ akcji nie jest obsługiwany w kanale.
Kanał | Sugerowane akcje | Akcje karty |
---|---|---|
Alexa | Brak | Brak |
Azure Communication Services Chat | ||
Direct Line | 100 | 100 |
Mowa Direct Line | 100 | 100 |
Brak | Brak | |
11 | 3 | |
GroupMe | Brak | Brak |
LINE | 13 | 99 |
Microsoft Teams | Brak | 3 |
Obsługa wielokanałowa | ||
Outlook (wersja zapoznawcza) | ||
Wyszukiwanie (wersja zapoznawcza) | ||
Slack | Brak | 100 |
Telegram | 100 | 100 |
Twilio (SMS) | Brak | Brak |
Czat internetowy | 100 | 100 |
- Aby uzyskać więcej informacji na temat akcji kart, zobacz Przetwarzanie zdarzeń na kartach bogatych w artykule Dodawanie multimediów do komunikatów .
- Aby uzyskać więcej informacji na temat sugerowanych akcji, zobacz używanie przycisków do wprowadzania danych wejściowych.
Kategorie działań
Działania można podzielić na oddzielne kategorie. Aby uzyskać szczegółowy opis każdego typu działania oraz informacje zawarte w poszczególnych typach działań, zobacz schemat działania platformy Bot Framework.
Witamy
Ta kategoria obejmuje conversationUpdate
działania i contactRelationUpdate
.
- Wiele kanałów wysyła działania aktualizacji konwersacji.
- Często zachowanie powitalne bota jest wyzwalane przez działanie aktualizacji konwersacji. Jednak tworzenie niezawodnego zachowania powitalnego może wymagać użycia konwersacji lub stanu użytkownika.
- Niektóre kanały wysyłają działania aktualizacji relacji kontaktów.
- Jeśli bot korzysta z tych kanałów, może być konieczne uwzględnienie logiki dla tego działania w zachowaniu powitalnym bota.
Konwersacyjne
Ta kategoria obejmuje message
działania , messageReaction
i endOfConversation
.
- Wszystkie kanały mogą wysyłać i odbierać działania wiadomości.
- W przypadku botów korzystających z okien dialogowych działania komunikatów powinny być zwykle przekazywane do okna dialogowego.
- Niektóre kanały mogą wysyłać i odbierać działania reakcji na komunikaty.
- W zależności od projektu bota możesz przekazać działania reakcji komunikatów do okna dialogowego.
- Działania reakcji komunikatów odwołują się do poprzednich komunikatów według identyfikatora.
- Koniec działań konwersacji sygnalizuje koniec konwersacji z perspektywy nadawcy.
- Zakończenie działań konwersacji jest używane w komunikacji bot-to-bot na potrzeby umiejętności.
Napiwek
Reakcja wiadomości zawiera takie rzeczy jak kciuki w górę w poprzednim komentarzu. Mogą się one zdarzyć poza kolejnością, więc można je traktować jako podobne do przycisków. Ten typ działania może być wysyłany przez kanał usługi Teams.
Aktualizacja i usuwanie komunikatów
Ta kategoria obejmuje messageUpdate
działania i messageDelete
.
- Usługa Teams obsługuje działania aktualizacji i usuwania komunikatów.
Rozszerzalność aplikacji
Ta kategoria obejmuje event
działania i invoke
.
Znaczenie działania jest definiowane przez jego name
pole, które ma znaczenie w zakresie kanału.
- Aplikacja, która jest właścicielem zarówno klienta, jak i serwera, może używać działań zdarzeń do komunikowania informacji programowych między klientem a serwerem.
- Działania zdarzeń, takie jak większość typów działań, są asynchroniczne.
- Linia bezpośrednia i czat internetowy używają działań zdarzeń jako mechanizmu rozszerzalności.
- Wywołanie działań jest specyficzne dla aplikacji, a nie coś, co definiuje klient.
- Wywołaj działania, w przeciwieństwie do innych typów działań, są synchroniczne. (Wywołaj jest obecnie jedynym typem działania, który wyzwala zachowanie żądania-odpowiedź na bota).
- Usługa Microsoft Teams używa działań wywoływania i definiuje kilka działań wywoływanych specyficznych dla usługi Teams.
Uwierzytelnianie
Aby monit OAuth działał z oknami dialogowymi, TeamsVerification
należy przekazać działanie wywołania do okna dialogowego.
Bez kategorii
Działania installationUpdate
, typing
i handoff
nie pasują znacząco do innych kategorii.
- Działania aktualizacji instalacji reprezentują instalację lub odinstalowywanie bota w jednostce organizacyjnej kanału.
- Wpisywanie działań reprezentuje bieżące dane wejściowe od użytkownika lub bota.
- Żądania działań przekazywania lub sygnalizuj zmianę fokusu między elementami wewnątrz bota. Działanie przekazywania różni się od działania zdarzenia o nazwie "przekazywanie".
Brak użycia (obejmuje wywołanie specyficzne dla płatności)
Te typy działań nie są już używane:
deleteUserData
handoff
ping
Address
WywołaćPaymentRequest
Wywołać
Dodatkowe informacje
Wszystkie kanały mogą wysyłać i odbierać message
działania.
Napiwek
Podczas dodawania obsługi kanału do bota zapoznaj się z dokumentami dewelopera kanału. Każdy kanał ma różne ograniczenia dotyczące różnych aspektów konwersacji. Oto niektóre różnice:
- Ile czasu bot musi obsłużyć każde żądanie HTTP.
- Czy bot może wysłać działanie, które nie jest odpowiedzią na określone działanie użytkownika.
- Ile komunikatów bot może wysyłać w danym przedziale czasu.
- Sposób renderowania karty i obsługiwanych kart.