- 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ę sugerowanych promptów, z których jeden zostanie wybrany jako prompt wyświetlany w odpowiedzi użytkownikowi. Tę wiadomość można zlokalizować.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "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.
Zapis JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Pola | |
---|---|
surfaceCapabilities |
Zestaw wymaganych funkcji platformy. |
SurfaceCapabilities
Reprezentuje platformę, za pomocą której użytkownik wysyła żądanie do akcji.
Zapis JSON | |
---|---|
{
"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.
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 pojawiają się na końcu odpowiedzi. Jeśli pole „append” w prośbie z treścią ma wartość „true” (prawda), tytuły zdefiniowane w tym polu zostaną dodane do tytułów zdefiniowanych we wszystkich wcześniej zdefiniowanych promptach, a powielone wartości zostaną usunięte. |
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. Wartość „true” spowoduje usunięcie wszystkich wcześniej zdefiniowanych wiadomości (pierwsza i ostatnia prosta, treść, link do sugestii oraz obszar roboczy) oraz dodanie wiadomości zdefiniowanych w tym promptie. Wartość „false” (fałsz) spowoduje dodanie wiadomości zdefiniowanych w tym promptie do wiadomości zdefiniowanych w poprzednich odpowiedziach. Ustawienie wartości tego pola na „false” (fałsz) umożliwi też dołączanie do niektórych pól w prostych promptach, promptach sugestii i wierszu Canvas (część promptu Treść). Wiadomości Treść i linki są zawsze zastępowane, jeśli zostaną zdefiniowane w prompcie. Wartość domyślna to „false” (fałsz). |
canvas |
Odpowiedź używana w przypadku interaktywnego obszaru roboczego. |
StaticSimplePrompt
Reprezentuje prosty komunikat do wysłania do użytkownika.
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ć odczytana użytkownikowi. Może to być SSML lub zamiana tekstu na mowę. Jeśli pole „append” w wierszu zawierającym prompt ma wartość „true” (prawda), mowa zdefiniowana w tym polu zostanie dodana do wypowiedzi w poprzednim prostym promptie. |
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. Jeśli pole „append” w prompcie zawierającym treść ma wartość „true”, tekst zdefiniowany w tym polu zostanie dołączony do tekstu poprzedniego prostego promptu. |
StaticContentPrompt
Obiekt zastępczy stanowiący część treści elementu StaticPrompt.
Zapis JSON | |
---|---|
{ // 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. |
StaticCardPrompt
Podstawowa karta, na której można wyświetlać określone informacje, np. obraz lub tekst.
Zapis JSON | |
---|---|
{ "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.
Zapis JSON | |
---|---|
{ "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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "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, które obsługują funkcję 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 wartość nie zostanie określona, treść zostanie wyrównana do krawędzi wiodącej. |
TableRow
Opisuje wiersz w tabeli.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "text": string } |
Pola | |
---|---|
text |
Zawartość komórki. |
StaticMediaPrompt
Zawiera informacje o multimediach, np. nazwę, opis, adres URL itp. Następny identyfikator: 9
Zapis JSON | |
---|---|
{ "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. |
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 na karcie multimediów. |
MediaImage
Obraz do wyświetlenia w elemencie MediaPrompt.
Zapis JSON | |
---|---|
{ // 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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{
"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.
Zapis JSON | |
---|---|
{ "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.
Zapis JSON | |
---|---|
{
"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. |
Sugestia
Reprezentuje element z sugestią, czyli element interfejsu wyświetlany dla wygody użytkownika.
Zapis JSON | |
---|---|
{ "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 „first Simple” w wierszu zawierającym prompt, aby móc komunikować się z użytkownikiem, a także wyświetlać interaktywną odpowiedź obiektu canvas.
Zapis JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": 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 „zastąp” w prośbie zawierającym treść ma wartość „fałsz”, wartości danych zdefiniowane w tym promptie Canvas zostaną dodane po wartościach danych zdefiniowanych w poprzednich promptach Canvas. |
suppressMic |
Opcjonalnie. Wartość prawda oznacza, że po pokazaniu użytkownikowi tej immersyjnej odpowiedzi mikrofon się nie uruchamia, aby rejestrować sygnał. |