- Reprezentacja języka YAML
- StaticPrompt
- StaticPromptCandidate
- Selektor
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Wersja
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Sugestia
- StaticCanvasPrompt
Definiuje moduł obsługi do wykonania po zdarzeniu. Przykładami zdarzeń w scenie są zdarzenia związane z intencjami i warunkami.
Reprezentacja YAML | |
---|---|
webhookHandler: string # Union field |
Pola | ||
---|---|---|
webhookHandler |
Nazwa modułu obsługi webhooka do wywołania. |
|
Pole sumy prompt . Prompty mogą być wstawiane w treści lub mogą się przywoływać w treści. prompt może mieć tylko jedną z tych wartości: |
||
staticPrompt |
Wbudowany prompt statyczny. Może zawierać odwołania do zasobów w postaci ciągów znaków w pakietach. |
|
staticPromptName |
Nazwa statycznego promptu, który ma zostać wywołany. |
StaticPrompt
Reprezentuje listę kandydatów do promptów. Jeden z nich zostanie wybrany jako prompt, który będzie wyświetlany w odpowiedzi użytkownikowi. Tę wiadomość można zlokalizować.
Reprezentacja YAML | |
---|---|
candidates:
- object ( |
Pola | |
---|---|
candidates[] |
Lista promptów kandydujących, które mają zostać wysłane do klienta. Każdy prompt ma selektor, który określa, kiedy można go użyć. Zostanie wysłany pierwszy selektor pasujący do żądania, a pozostałe zostaną zignorowane. |
StaticPromptCandidate
Reprezentuje kandydata statycznego promptu.
Reprezentacja YAML | |
---|---|
selector: object ( |
Pola | |
---|---|
selector |
Opcjonalnie: Kryteria, czy ten prompt pasuje do żądania. Jeśli selektor jest pusty, prośba zawsze będzie wywoływana. |
promptResponse |
Odpowiedź na prompt powiązana z selektorem. |
Selektor
Określa kryteria dopasowania promptu do żądania.
Reprezentacja YAML | |
---|---|
surfaceCapabilities:
object ( |
Pola | |
---|---|
surfaceCapabilities |
Zbiór wymaganych możliwości powierzchni. |
SurfaceCapabilities
Reprezentuje platformę, na której użytkownik wysyła żądanie do działania.
Reprezentacja YAML | |
---|---|
capabilities:
- enum ( |
Pola | |
---|---|
capabilities[] |
Wymagane. Możliwości platformy wysyłającej żądanie do akcji. |
StaticPromptResponse
Reprezentuje uporządkowane odpowiedzi, które mają być wysyłane do użytkownika, na przykład tekst, mowę, karty, dane w obszarze roboczym, elementy z sugestią itp.
Reprezentacja YAML | |
---|---|
firstSimple: object ( |
Pola | |
---|---|
firstSimple |
Opcjonalnie: Pierwsza odpowiedź głosowa i tekstowa. |
content |
Opcjonalnie: Treści takie jak karta, lista lub multimedia do wyświetlenia użytkownikowi. |
lastSimple |
Opcjonalnie: Ostatnia odpowiedź głosowa i tekstowa. |
suggestions[] |
Opcjonalnie: Sugestie do wyświetlenia użytkownikowi, które zawsze będą pojawiać się na końcu odpowiedzi. Jeśli pole |
link |
Opcjonalnie: Dodatkowy element z sugestią, który może prowadzić do powiązanej aplikacji lub witryny. Element zostanie wyrenderowany z tytułem „Otwórz |
override |
Opcjonalnie: Tryb sposobu łączenia tych wiadomości z wiadomościami zdefiniowanymi wcześniej. Aplikacja |
canvas |
Odpowiedź używana w przypadku interaktywnego obszaru roboczego. |
StaticSimplePrompt
Reprezentuje prosty prompt, który należy wysłać użytkownikowi.
Reprezentacja YAML | |
---|---|
variants:
- object ( |
Pola | |
---|---|
variants[] |
Lista możliwych wariantów. |
Wariant
Reprezentuje wariant, który jest częścią prostego promptu.
Reprezentacja YAML | |
---|---|
speech: string text: string |
Pola | |
---|---|
speech |
Opcjonalnie: Reprezentuje mowę, która ma zostać wypowiedziana użytkownikowi. Może to być SSML lub zamiana tekstu na mowę. Domyślnie mowa jest dołączana do mowy poprzedniego promptu prostego. Jeśli pole |
text |
Opcjonalnie: Tekst do wyświetlenia w dymku czatu. Jeśli wartość nie zostanie podana, będzie używane renderowanie powyższego pola mowy. Limit wynosi 640 znaków. Domyślnie tekst jest dołączany do tekstu poprzedniego prostego promptu. Jeśli pole |
StaticContentPrompt
Obiekt zastępczy części „treść” prompta statycznego.
Reprezentacja YAML | |
---|---|
# Union field |
Pola | ||
---|---|---|
Pole sumy content . Prompt może zawierać tylko jeden typ treści. content może mieć tylko jedną z tych wartości: |
||
card |
karta podstawowa. |
|
image |
Obraz. |
|
table |
Karta tabeli. |
|
media |
Odpowiedź wskazująca zbiór multimediów do odtworzenia. |
|
list |
Karta zawierająca listę opcji do wyboru. |
|
collection |
Karta z listą opcji do wyboru. |
|
collectionBrowse |
Karta przedstawiająca zbiór stron internetowych do otwarcia. |
StaticCardPrompt
Podstawowa karta do wyświetlania pewnych informacji, np. obrazu i/lub tekstu.
Reprezentacja YAML | |
---|---|
title: string subtitle: string text: string image: object ( |
Pola | |
---|---|
title |
Opcjonalnie: Ogólny tytuł karty. |
subtitle |
Opcjonalnie: Podtytuł karty. |
text |
Wymagane. Tekst karty. Potrzebny jest ten tekst, o ile nie ma zdjęcia. Obsługuje ograniczony zestaw składni formatowania Markdown na potrzeby formatowania. |
image |
Opcjonalnie: Baner powitalny karty. Wysokość jest stała na 192 dp. |
imageFill |
Opcjonalnie: Sposób wypełniania tła obrazu. |
button |
Opcjonalnie: Klikalny przycisk wyświetlany na karcie. |
StaticImagePrompt
Obraz wyświetlany na karcie.
Reprezentacja YAML | |
---|---|
url: string alt: string height: integer width: integer |
Pola | |
---|---|
url |
Wymagane. Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). Na przykład: |
alt |
Wymagane. Opis tekstowy obrazu, który ma być używany na potrzeby ułatwień dostępu, np. przez czytniki ekranu. |
height |
Opcjonalnie: Wysokość obrazu w pikselach. |
width |
Opcjonalnie: Szerokość obrazu w pikselach. |
StaticLinkPrompt
Definiuje link, który będzie wyświetlany jako element z sugestią i może być otwierany przez użytkownika.
Reprezentacja YAML | |
---|---|
name: string
open:
object ( |
Pola | |
---|---|
name |
Nazwa linku |
open |
Określa, co się stanie, gdy użytkownik otworzy link. |
OpenUrl
Określa, co się stanie, gdy użytkownik otworzy link.
Reprezentacja YAML | |
---|---|
url: string
hint: enum ( |
Pola | |
---|---|
url |
Pole adresu URL, którym może być dowolny z tych elementów: – adresy URL http/https służące do otwierania aplikacji powiązanej z aplikacją lub strony internetowej |
hint |
Wskazuje wskazówkę dotyczącą typu adresu URL. |
StaticTablePrompt
Karta tabeli zawierająca tabelę z tekstem.
Reprezentacja YAML | |
---|---|
title: string subtitle: string image: object ( |
Pola | |
---|---|
title |
Opcjonalnie: Ogólny tytuł tabeli. Ta opcja jest wymagana, jeśli ustawiono podtytuł. |
subtitle |
Opcjonalnie: Podtytuł tabeli. |
image |
Opcjonalnie: Obraz powiązany z tabelą. |
columns[] |
Opcjonalnie: Nagłówki i wyrównanie kolumn. |
rows[] |
Opcjonalnie: Dane wiersza tabeli. Pierwsze 3 wiersze na pewno się wyświetlą, ale inne mogą zostać wycięte na niektórych platformach. Przetestuj za pomocą symulatora, które wiersze będą wyświetlane dla danej platformy. Na platformach obsługujących funkcję |
button |
Opcjonalnie: Przycisk. |
TableColumn
Opisuje kolumnę w tabeli.
Reprezentacja YAML | |
---|---|
header: string
align: enum ( |
Pola | |
---|---|
header |
Tekst nagłówka kolumny. |
align |
Wyrównanie w poziomie kolumny z treściami. Jeśli nie określono inaczej, treść zostanie wyrównana do krawędzi początkowej. |
TableRow
Opisuje wiersz w tabeli.
Reprezentacja YAML | |
---|---|
cells:
- object ( |
Pola | |
---|---|
cells[] |
Komórki w tym wierszu. Pierwsze 3 komórki są wyświetlane, ale inne mogą zostać wycięte na niektórych platformach. Przetestuj za pomocą symulatora, które komórki zostaną wyświetlone na danej powierzchni. |
divider |
Wskazuje, czy po każdym wierszu powinien być separator. |
TableCell
Opisuje komórkę w wierszu.
Reprezentacja YAML | |
---|---|
text: string |
Pola | |
---|---|
text |
Zawartość tekstowa komórki. |
StaticMediaPrompt
Zawiera informacje o multimediach, takie jak nazwa, opis, URL itp. Następny identyfikator: 11
Reprezentacja YAML | |
---|---|
mediaType: enum ( |
Pola | |
---|---|
mediaType |
Typ multimediów w tej odpowiedzi. |
startOffset |
Odsunięcie pierwszego obiektu multimedialnego. Czas trwania w sekundach z maksymalnie dziewięcioma cyframi po przecinku, zakończony znakiem „ |
optionalMediaControls[] |
Opcjonalne typy elementów sterujących multimediami, które obsługuje ta sesja odpowiedzi na multimedia. Jeśli jest ustawione, żądanie jest przekazywane do firm zewnętrznych, gdy wystąpi określone zdarzenie multimedialne. Jeśli nie jest ustawiona, firma zewnętrzna musi nadal obsługiwać 2 domyślne typy ustawień: ZAKOŃCZONO i NIEPOWODZENIE. |
mediaObjects[] |
Lista obiektów multimedialnych. |
repeatMode |
Tryb powtarzania w przypadku listy obiektów multimediów. |
MediaObject
Reprezentuje jeden obiekt multimedialny.
Reprezentacja YAML | |
---|---|
name: string
description: string
url: string
image:
object ( |
Pola | |
---|---|
name |
Nazwa tego obiektu multimedialnego. |
description |
Opis tego obiektu multimedialnego. |
url |
Adres URL wskazujący treści multimedialne. |
image |
Obraz wyświetlany z kartą multimediów. |
MediaImage
Obraz do wyświetlenia w MediaPrompt.
Reprezentacja YAML | |
---|---|
# Union field |
Pola | ||
---|---|---|
Pole sumy image . Dozwolony jest tylko jeden typ obiektu MediaImage. image może mieć tylko jedną z tych wartości: |
||
large |
Duże zdjęcie, np. okładka albumu itp. |
|
icon |
Mała ikona obrazu wyświetlana po prawej stronie tytułu. Został zmniejszony do rozmiaru 36 x 36 dp. |
StaticListPrompt
Karta zawierająca listę opcji do wyboru.
Reprezentacja YAML | |
---|---|
title: string
subtitle: string
items:
- object ( |
Pola | |
---|---|
title |
Opcjonalnie: Tytuł listy. |
subtitle |
Opcjonalnie: Podtytuł listy. |
items[] |
Wymagane. Pozycje listy. |
ListItem
element na liście.
Reprezentacja YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Pola | |
---|---|
key |
Wymagane. Klucz NLU zgodny z nazwą klucza wpisu w powiązanym typie. Po kliknięciu elementu ten klucz zostanie wysłany z powrotem jako parametr wyboru opcji. |
title |
Wymagane. Tytuł produktu. Po kliknięciu tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w obrębie zestawu elementów. |
description |
Opcjonalnie: Tekst główny elementu. |
image |
Opcjonalnie: Obraz elementu. |
StaticCollectionPrompt
Karta, która przedstawia kolekcję opcji do wyboru.
Reprezentacja YAML | |
---|---|
title: string subtitle: string items: - object ( |
Pola | |
---|---|
title |
Opcjonalnie: Tytuł kolekcji. |
subtitle |
Opcjonalnie: Podtytuł kolekcji. |
items[] |
Wymagane. Elementy kolekcji. |
imageFill |
Opcjonalnie: Typ opcji wyświetlania obrazu. |
CollectionItem
Element w kolekcji.
Reprezentacja YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Pola | |
---|---|
key |
Wymagane. Klucz NLU zgodny z nazwą klucza wpisu w powiązanym typie Type. Po kliknięciu elementu ten klucz zostanie wysłany z powrotem jako parametr wyboru opcji. |
title |
Wymagane. Tytuł produktu. Po kliknięciu tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w obrębie zestawu elementów. |
description |
Opcjonalnie: Tekst główny elementu. |
image |
Opcjonalnie: Obraz elementu. |
StaticCollectionBrowsePrompt
Przedstawia zestaw dokumentów internetowych jako zbiór dużych elementów. Można je wybrać do uruchomienia powiązanego dokumentu internetowego w przeglądarce.
Reprezentacja YAML | |
---|---|
items: - object ( |
Pola | |
---|---|
items[] |
Elementy w kolekcji Przeglądaj. Rozmiar listy powinien mieścić się w zakresie [2, 10]. |
imageFill |
Opcja wyświetlania obrazów w kolekcji. |
CollectionBrowseItem
Element w kolekcji.
Reprezentacja YAML | |
---|---|
title: string description: string footer: string image: object ( |
Pola | |
---|---|
title |
Wymagane. Tytuł elementu kolekcji. |
description |
Opis elementu kolekcji. |
footer |
Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty wielokropkiem. |
image |
Obraz elementu kolekcji. |
openUriAction |
Wymagane. Identyfikator URI do otworzenia po wybraniu elementu. |
Sugestia
Reprezentuje element z sugestią, czyli element interfejsu wyświetlany dla wygody użytkownika.
Reprezentacja YAML | |
---|---|
title: string |
Pola | |
---|---|
title |
Wymagane. Tekst widoczny w elemencie z sugestią. Po kliknięciu tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w zestawie elementów z sugestią. Maks. 25 znaków |
StaticCanvasPrompt
Reprezentuje odpowiedź interaktywnego obszaru roboczego do wysłania użytkownikowi. Tej opcji można używać w połączeniu z polem firstSimple
w prośbie o rozmowę z użytkownikiem w uzupełnieniu do wyświetlenia interaktywnej odpowiedzi kanwy.
Reprezentacja YAML | |
---|---|
url: string data: - value suppressMic: boolean sendStateDataToCanvasApp: boolean enableFullScreen: boolean continueTtsDuringTouch: boolean |
Pola | |
---|---|
url |
Wymagane. Adres URL widoku internetowego do wczytania. |
data[] |
Opcjonalnie: Dane JSON przekazywane na stronę internetową środowiska immersyjnego jako zdarzenie. Jeśli pole |
suppressMic |
Opcjonalnie: Wartość prawda oznacza, że mikrofon nie włączy się do rejestrowania danych wejściowych po przedstawieniu użytkownikowi tej szczegółowej odpowiedzi. |
sendStateDataToCanvasApp |
Opcjonalnie: Jeśli |
enableFullScreen |
Opcjonalnie: Jeśli |
continueTtsDuringTouch |
Opcjonalnie: Jeśli wybrano opcję prawda, dotknięcia ekranu nie zatrzymują zamiany tekstu na mowę przez całą sesję Canvas. Wartość domyślna: false. |