- Reprezentowanie kanału 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
Określa moduł obsługi, który ma zostać wykonany po zdarzeniu. Przykładami zdarzeń są zdarzenia w scenie oparte na zamiarach i warunkach.
Reprezentacja YAML | |
---|---|
webhookHandler: string # Union field |
Pola | ||
---|---|---|
webhookHandler |
Nazwa modułu obsługi webhooka, który ma zostać wywołany. |
|
Pole sumy prompt . Prompty mogą być wbudowane lub zawierać odwołania do nazw. prompt może mieć tylko jedną z tych wartości: |
||
staticPrompt |
Wbudowany statyczny prompt. Może zawierać odwołania do zasobów w postaci ciągów znaków w pakietach. |
|
staticPromptName |
Nazwa statycznego promptu do wywołania. |
StaticPrompt
Reprezentuje listę sugerowanych promptów, z których jeden zostanie wybrany jako prompt wyświetlany w odpowiedzi użytkownikowi. Tę wiadomość można zlokalizować.
Reprezentacja YAML | |
---|---|
candidates:
- object ( |
Pola | |
---|---|
candidates[] |
Lista sugerowanych próśb, które mają zostać wysłane do klienta. Każdy prompt ma selektor, który określa, kiedy można go użyć. Pierwszy selektor, który pasuje do żądania, zostanie wysłany, a pozostałe będą ignorowane. |
StaticPromptCandidate
Reprezentuje statyczną propozycję promptu.
Reprezentacja YAML | |
---|---|
selector: object ( |
Pola | |
---|---|
selector |
Opcjonalnie. Kryteria zgodności tego promptu z żądaniem. Jeśli selektor jest pusty, ten komunikat będzie zawsze wywoływany. |
promptResponse |
Odpowiedź przesłana z selektorem. |
Selektor
Określa kryteria dopasowania promptu do żądania.
Reprezentacja YAML | |
---|---|
surfaceCapabilities:
object ( |
Pola | |
---|---|
surfaceCapabilities |
Zestaw wymaganych funkcji platformy. |
SurfaceCapabilities
Reprezentuje platformę, za pomocą której użytkownik wysyła żądanie do akcji.
Reprezentacja YAML | |
---|---|
capabilities:
- enum ( |
Pola | |
---|---|
capabilities[] |
To pole jest wymagane. Możliwości platformy wysyłającej żądanie do akcji. |
StaticPromptResponse
Reprezentuje ustrukturyzowane odpowiedzi wysyłane do użytkownika, na przykład tekst, mowę, karty, dane obiektu canvas, 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 pojawiają się na końcu odpowiedzi. Jeśli pole |
link |
Opcjonalnie. Dodatkowy element sugestii, który może prowadzić do powiązanej aplikacji lub strony. Element zostanie wyrenderowany z tytułem „Otwórz |
override |
Opcjonalnie. Tryb łączenia tych wiadomości z wcześniej zdefiniowanymi wiadomościami. |
canvas |
Odpowiedź używana w przypadku interaktywnego obszaru roboczego. |
StaticSimplePrompt
Reprezentuje prosty komunikat do wysłania do użytkownika.
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ć odczytana użytkownikowi. Może to być SSML lub zamiana tekstu na mowę. Domyślnie zamiana tekstu na mowę jest dodawana do poprzedniego prostego promptu. Jeśli pole |
text |
Opcjonalnie. Tekst do wyświetlenia w dymku czatu. Jeśli pole nie zostanie podane, wyświetlane będzie renderowanie powyższego pola mowy w trybie displayowym. Limit wynosi 640 znaków. Domyślnie tekst zostanie dołączony do tekstu poprzedniego prostego promptu. Jeśli pole |
StaticContentPrompt
Obiekt zastępczy stanowiący część treści elementu StaticPrompt.
Reprezentacja YAML | |
---|---|
# Union field |
Pola | ||
---|---|---|
Pole sumy content . Prompt może zawierać tylko jeden rodzaj treści. content może mieć tylko jedną z tych wartości: |
||
card |
Kartę podstawową. |
|
image |
Obraz. |
|
table |
Karta z tabelą. |
|
media |
Odpowiedź wskazująca zestaw multimediów do odtworzenia. |
|
list |
Karta zawierająca listę opcji do wyboru. |
|
collection |
Karta zawierająca listę opcji do wyboru. |
|
collectionBrowse |
Karta prezentująca zbiór stron internetowych do otwarcia. |
StaticCardPrompt
Podstawowa karta, na której można wyświetlać określone informacje, np. obraz lub tekst.
Reprezentacja YAML | |
---|---|
title: string subtitle: string text: string image: object ( |
Pola | |
---|---|
title |
Opcjonalnie. Ogólny tytuł karty. |
subtitle |
Opcjonalnie. Podtytuł karty. |
text |
To pole jest wymagane. Tekst główny karty, który jest potrzebny, o ile nie ma obrazu. Obsługuje ograniczony zestaw składni znaków Markdown na potrzeby formatowania. |
image |
Opcjonalnie. Baner powitalny karty. Wysokość jest stała i wynosi 192 dp. |
imageFill |
Opcjonalnie. Sposób wypełnienia 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 |
To pole jest wymagane. Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). np. |
alt |
To pole jest 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 sugestii i może zostać otwarty przez użytkownika.
Reprezentacja YAML | |
---|---|
name: string
open:
object ( |
Pola | |
---|---|
name |
Nazwa linku |
open |
Określa zachowanie, gdy użytkownik otwiera link. |
OpenUrl
Określa zachowanie, gdy użytkownik otwiera link.
Reprezentacja YAML | |
---|---|
url: string
hint: enum ( |
Pola | |
---|---|
url |
Pole adresu URL, które może być dowolnym z tych elementów: – Adres URL http/https umożliwiający otwarcie aplikacji lub strony internetowej |
hint |
Wskazuje wskazówkę dotyczącą typu adresu URL. |
StaticTablePrompt
Karta, która służy do wyświetlania tabeli tekstowej.
Reprezentacja YAML | |
---|---|
title: string subtitle: string image: object ( |
Pola | |
---|---|
title |
Opcjonalnie. Ogólny tytuł tabeli. Musi być ustawiony, jeśli podtytuł jest ustawiony. |
subtitle |
Opcjonalnie. Podtytuł tabeli. |
image |
Opcjonalnie. Obraz powiązany z tabelą. |
columns[] |
Opcjonalnie. Nagłówki i wyrównanie kolumn. |
rows[] |
Opcjonalnie. Dane w wierszach tabeli. Pierwsze 3 wiersze na pewno zostaną wyświetlone, ale inne mogą zostać wycięte na niektórych platformach. Przeprowadź test za pomocą symulatora, aby zobaczyć, które wiersze będą wyświetlane na danej powierzchni. 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 wartość nie zostanie określona, treść zostanie wyrównana do krawędzi wiodącej. |
TableRow
Opisuje wiersz w tabeli.
Reprezentacja YAML | |
---|---|
cells:
- object ( |
Pola | |
---|---|
cells[] |
Komórki w tym wierszu. Pierwsze 3 komórki na pewno zostaną wyświetlone, ale inne mogą zostać wycięte na niektórych powierzchniach. Użyj symulatora, aby sprawdzić, które komórki są wyświetlane na danej powierzchni. |
divider |
Wskazuje, czy po każdym wierszu powinien znajdować się separator. |
TableCell
Opisuje komórkę w wierszu.
Reprezentacja YAML | |
---|---|
text: string |
Pola | |
---|---|
text |
Zawartość komórki. |
StaticMediaPrompt
Zawiera informacje o multimediach, takie jak nazwa, opis, adres URL itp. Następny identyfikator: 11
Reprezentacja YAML | |
---|---|
mediaType: enum ( |
Pola | |
---|---|
mediaType |
Typ multimediów tej odpowiedzi. |
startOffset |
Opóźnienie rozpoczęcia pierwszego obiektu multimedialnego. Czas trwania w sekundach zawierający maksymalnie 9 cyfr po przecinku zakończony znakiem „ |
optionalMediaControls[] |
Opcjonalne typy sterowania multimediami, które może obsługiwać ta sesja odpowiedzi na multimedia. Jeśli zasada jest skonfigurowana, po wystąpieniu określonego zdarzenia multimedialnego żądania będą wysyłane do 3p. Jeśli zasada nie jest skonfigurowana, 3p nadal musi obsługiwać 2 domyślne typy elementów sterujących: FINISHED i FAILED. |
mediaObjects[] |
Lista obiektów multimedialnych. |
repeatMode |
Tryb powtarzania dla listy obiektów multimedialnych. |
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 na karcie multimediów. |
MediaImage
Obraz do wyświetlenia w elemencie MediaPrompt.
Reprezentacja YAML | |
---|---|
# Union field |
Pola | ||
---|---|---|
Pole sumy image . Dozwolony jest tylko jeden typ elementu MediaImage. image może mieć tylko jedną z tych wartości: |
||
large |
Duży obraz, np. okładka albumu itp. |
|
icon |
Mała ikona obrazu wyświetlana po prawej stronie tytułu. Rozmiar zostanie zmieniony na 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[] |
To pole jest wymagane. Elementy listy. |
ListItem
Element na liście.
Reprezentacja YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Pola | |
---|---|
key |
To pole jest wymagane. Klucz NLU pasujący do nazwy klucza dostępu w powiązanym typie. Po kliknięciu elementu ten klucz zostanie z powrotem opublikowany jako parametr opcji wyboru. |
title |
To pole jest wymagane. Tytuł produktu. Po kliknięciu ten tekst jest dosłowny w rozmowie, tak jakby użytkownik wpisał go w zapytaniu. Każdy tytuł musi być unikalny w obrębie zestawu elementów. |
description |
Opcjonalnie. Tekst główny elementu. |
image |
Opcjonalnie. Obraz elementu. |
StaticCollectionPrompt
Karta prezentująca zbiór opcji do wyboru.
Reprezentacja YAML | |
---|---|
title: string subtitle: string items: - object ( |
Pola | |
---|---|
title |
Opcjonalnie. Tytuł kolekcji. |
subtitle |
Opcjonalnie. Podtytuł kolekcji. |
items[] |
To pole jest wymagane. Elementy z kolekcji. |
imageFill |
Opcjonalnie. Typ opcji wyświetlania obrazu. |
CollectionItem
Element w kolekcji.
Reprezentacja YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Pola | |
---|---|
key |
To pole jest wymagane. Klucz NLU zgodny z nazwą klucza dostępu w powiązanym typie. Po kliknięciu elementu ten klucz zostanie z powrotem opublikowany jako parametr opcji wyboru. |
title |
To pole jest wymagane. Tytuł produktu. Po kliknięciu ten tekst jest dosłowny w rozmowie, tak jakby użytkownik wpisał go w zapytaniu. Każdy tytuł musi być unikalny w obrębie zestawu elementów. |
description |
Opcjonalnie. Tekst główny elementu. |
image |
Opcjonalnie. Obraz elementu. |
StaticCollectionBrowsePrompt
Prezentuje zestaw dokumentów internetowych jako zbiór dużych elementów. Elementy można wybrać, aby uruchomić powiązany dokument internetowy 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 |
To pole jest wymagane. Tytuł elementu kolekcji. |
description |
Opis elementu kolekcji. |
footer |
Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty za pomocą wielokropka. |
image |
Zdjęcie elementu kolekcji. |
openUriAction |
To pole jest wymagane. Identyfikator URI do otwarcia w przypadku wybrania elementu. |
Sugestia
Reprezentuje element z sugestią, czyli element interfejsu wyświetlany dla wygody użytkownika.
Reprezentacja YAML | |
---|---|
title: string |
Pola | |
---|---|
title |
To pole jest wymagane. Tekst wyświetlany w elemencie sugestii. Po kliknięciu ten tekst jest dosłowny w rozmowie, tak jakby użytkownik wpisał go w zapytaniu. Każdy tytuł musi być unikalny w zestawie elementów sugestii. Maks. 25 znaków |
StaticCanvasPrompt
Reprezentuje odpowiedź Interactive Canvas, która ma zostać wysłana do użytkownika. Tej opcji można użyć w połączeniu z polem firstSimple
w komunikacie zawierającym prośbę o rozpoczęcie rozmowy z użytkownikiem, a nie tylko do wyświetlenia interaktywnej odpowiedzi canvas.
Reprezentacja YAML | |
---|---|
url: string data: - value suppressMic: boolean sendStateDataToCanvasApp: boolean enableFullScreen: boolean continueTtsDuringTouch: boolean |
Pola | |
---|---|
url |
To pole jest wymagane. Adres URL widoku internetowego do wczytania. |
data[] |
Opcjonalnie. Dane JSON, które mają być przekazywane do strony internetowej trybu interaktywnego w formie zdarzenia. Jeśli pole |
suppressMic |
Opcjonalnie. Wartość prawda oznacza, że po pokazaniu użytkownikowi tej immersyjnej odpowiedzi mikrofon się nie uruchamia, aby rejestrować sygnał. |
sendStateDataToCanvasApp |
Opcjonalnie. Jeśli jest ustawiona wartość |
enableFullScreen |
Opcjonalnie. Jeśli |
continueTtsDuringTouch |
Opcjonalnie. Jeśli ma wartość prawda, kliknięcia ekranu nie zatrzymują zamiany tekstu na mowę przez całą sesję obszaru roboczego. Wartość domyślna: false (fałsz). |