- StaticPromptCandidate
- Selektor
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Wersja
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- Sugestia
- StaticCanvasPrompt
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ć.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "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 element „Append” pole w nowym promptie ma wartość „true” tytuły zdefiniowane w tym polu zostaną dodane do tytułów zdefiniowanych we wszystkich wcześniej zdefiniowanych promptach, a zduplikowane wartości zostaną usunięte. |
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. „true” spowoduje usunięcie wszystkich wcześniej zdefiniowanych wiadomości (pierwsza i ostatnia prosta, treść, link z sugestiami oraz obszar roboczy) i dodanie wiadomości zdefiniowanych w tym promptie. „false” dodaje wiadomości zdefiniowane w tym promptie do wiadomości zdefiniowanych w poprzednich odpowiedziach. Ustawienie w tym polu wartości „false” . Wiadomości z treścią i linkami zawsze zostaną zastąpione, jeśli zostaną zdefiniowane w prompcie. Wartość domyślna to „false”. |
canvas |
Odpowiedź używana w przypadku interaktywnego obszaru roboczego. |
StaticSimplePrompt
Reprezentuje prosty prompt, który należy wysłać użytkownikowi.
Zapis JSON | |
---|---|
{
"variants": [
{
object ( |
Pola | |
---|---|
variants[] |
Lista możliwych wariantów. |
Wariant
Reprezentuje wariant, który jest częścią prostego promptu.
Zapis JSON | |
---|---|
{ "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ę. Jeśli element „Append” pole w nowym promptie ma wartość „true” mowa zdefiniowana w tym polu zostanie dodana do mowy poprzedniego prostego promptu. |
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. Jeśli element „Append” pole w nowym promptie ma wartość „true” tekst zdefiniowany w tym polu zostanie dołączony do tekstu poprzedniego prostego promptu. |
StaticContentPrompt
Obiekt zastępczy części „treść” prompta statycznego.
Zapis JSON | |
---|---|
{ // 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. |
StaticCardPrompt
Podstawowa karta do wyświetlania pewnych informacji, np. obrazu i/lub tekstu.
Zapis JSON | |
---|---|
{ "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.
Zapis JSON | |
---|---|
{ "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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "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 WEB_BROWSER możesz wskazać użytkownikowi stronę internetową z większą ilością danych. |
button |
Opcjonalnie: Przycisk. |
TableColumn
Opisuje kolumnę w tabeli.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "text": string } |
Pola | |
---|---|
text |
Zawartość tekstowa komórki. |
StaticMediaPrompt
Zawiera informacje o multimediach, takie jak nazwa, opis, URL itp. Następny identyfikator: 9
Zapis JSON | |
---|---|
{ "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. |
MediaObject
Reprezentuje jeden obiekt multimedialny.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ // 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.
Zapis JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Pola | |
---|---|
title |
Opcjonalnie: Tytuł listy. |
subtitle |
Opcjonalnie: Podtytuł listy. |
items[] |
Wymagane. Pozycje listy. |
ListItem
element na liście.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "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.
Zapis JSON | |
---|---|
{
"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. |
Sugestia
Reprezentuje element z sugestią, czyli element interfejsu wyświetlany dla wygody użytkownika.
Zapis JSON | |
---|---|
{ "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. Można go używać w połączeniu z właściwością „firstSimple” w oknie z prośbą o rozmowę z użytkownikiem, a jednocześnie wyświetli się interaktywna odpowiedź kanwy.
Zapis JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
Pola | |
---|---|
url |
Wymagane. Adres URL widoku internetowego do wczytania. |
data[] |
Opcjonalnie: Dane JSON przekazywane na stronę internetową środowiska immersyjnego jako zdarzenie. Jeśli opcja „zastąp” pole w nowym promptie ma wartość „false” (fałsz) wartości danych zdefiniowane w tym prompcie Canvas zostaną dodane po tym, jak wartości danych zdefiniowane w poprzednich promptach Canvas. |
suppressMic |
Opcjonalnie: Wartość prawda oznacza, że mikrofon nie włączy się do rejestrowania danych wejściowych po przedstawieniu użytkownikowi tej szczegółowej odpowiedzi. |