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ć.

Zapis JSON
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Pola
candidates[]

object (StaticPromptCandidate)

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 (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Pola
selector

object (Selector)

Opcjonalnie. Kryteria zgodności tego promptu z żądaniem. Jeśli selektor jest pusty, ten komunikat będzie zawsze wywoływany.

promptResponse

object (StaticPromptResponse)

Odpowiedź przesłana z selektorem.

Selektor

Określa kryteria dopasowania promptu do żądania.

Zapis JSON
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Pola
surfaceCapabilities

object (SurfaceCapabilities)

Zestaw wymaganych funkcji platformy.

SurfaceCapabilities

Reprezentuje platformę, za pomocą której użytkownik wysyła żądanie do akcji.

Zapis JSON
{
  "capabilities": [
    enum (Capability)
  ]
}
Pola
capabilities[]

enum (Capability)

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 (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
Pola
firstSimple

object (StaticSimplePrompt)

Opcjonalnie. Pierwsza odpowiedź głosowa i tekstowa.

content

object (StaticContentPrompt)

Opcjonalnie. Treści takie jak karta, lista lub multimedia do wyświetlenia użytkownikowi.

lastSimple

object (StaticSimplePrompt)

Opcjonalnie. Ostatnia odpowiedź głosowa i tekstowa.

suggestions[]

object (Suggestion)

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.

override

boolean

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

object (StaticCanvasPrompt)

Odpowiedź używana w przypadku interaktywnego obszaru roboczego.

StaticSimplePrompt

Reprezentuje prosty komunikat do wysłania do użytkownika.

Zapis JSON
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Pola
variants[]

object (Variant)

Lista możliwych wariantów.

Wariant

Reprezentuje wariant, który jest częścią prostego promptu.

Zapis JSON
{
  "speech": string,
  "text": string
}
Pola
speech

string

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

string

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 content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  }
  // End of list of possible types for union field content.
}
Pola
Pole sumy content. Prompt może zawierać tylko jeden rodzaj treści. content może mieć tylko jedną z tych wartości:
card

object (StaticCardPrompt)

Kartę podstawową.

image

object (StaticImagePrompt)

Obraz.

table

object (StaticTablePrompt)

Karta z tabelą.

media

object (StaticMediaPrompt)

Odpowiedź wskazująca zestaw multimediów do odtworzenia.

list

object (StaticListPrompt)

Karta zawierająca listę opcji do wyboru.

collection

object (StaticCollectionPrompt)

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 (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}
Pola
title

string

Opcjonalnie. Ogólny tytuł karty.

subtitle

string

Opcjonalnie. Podtytuł karty.

text

string

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

object (StaticImagePrompt)

Opcjonalnie. Baner powitalny karty. Wysokość jest stała i wynosi 192 dp.

imageFill

enum (ImageFill)

Opcjonalnie. Sposób wypełnienia tła obrazu.

button

object (StaticLinkPrompt)

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

string

To pole jest wymagane. Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). np. https://www.agentx.com/logo.png.

alt

string

To pole jest wymagane. Opis tekstowy obrazu, który ma być używany na potrzeby ułatwień dostępu, np. przez czytniki ekranu.

height

integer

Opcjonalnie. Wysokość obrazu w pikselach.

width

integer

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 (OpenUrl)
  }
}
Pola
name

string

Nazwa linku

open

object (OpenUrl)

Określa zachowanie, gdy użytkownik otwiera link.

OpenUrl

Określa zachowanie, gdy użytkownik otwiera link.

Zapis JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
Pola
url

string

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

enum (UrlHint)

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 (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}
Pola
title

string

Opcjonalnie. Ogólny tytuł tabeli. Musi być ustawiony, jeśli podtytuł jest ustawiony.

subtitle

string

Opcjonalnie. Podtytuł tabeli.

image

object (StaticImagePrompt)

Opcjonalnie. Obraz powiązany z tabelą.

columns[]

object (TableColumn)

Opcjonalnie. Nagłówki i wyrównanie kolumn.

rows[]

object (TableRow)

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

object (StaticLinkPrompt)

Opcjonalnie. Przycisk.

TableColumn

Opisuje kolumnę w tabeli.

Zapis JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Pola
header

string

Tekst nagłówka kolumny.

align

enum (HorizontalAlignment)

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 (TableCell)
    }
  ],
  "divider": boolean
}
Pola
cells[]

object (TableCell)

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

boolean

Wskazuje, czy po każdym wierszu powinien znajdować się separator.

TableCell

Opisuje komórkę w wierszu.

Zapis JSON
{
  "text": string
}
Pola
text

string

Zawartość komórki.

StaticMediaPrompt

Zawiera informacje o multimediach, np. nazwę, opis, adres URL itp. Następny identyfikator: 9

Zapis JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
Pola
mediaType

enum (MediaType)

Typ multimediów tej odpowiedzi.

startOffset

string (Duration format)

Opóźnienie rozpoczęcia pierwszego obiektu multimedialnego.

Czas trwania w sekundach zawierający maksymalnie 9 cyfr po przecinku zakończony znakiem „s”. Przykład: "3.5s".

optionalMediaControls[]

enum (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[]

object (MediaObject)

Lista obiektów multimedialnych.

MediaObject

Reprezentuje jeden obiekt multimedialny.

Zapis JSON
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Pola
name

string

Nazwa tego obiektu multimedialnego.

description

string

Opis tego obiektu multimedialnego.

url

string

Adres URL wskazujący treści multimedialne.

image

object (MediaImage)

Obraz wyświetlany na karcie multimediów.

MediaImage

Obraz do wyświetlenia w elemencie MediaPrompt.

Zapis JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}
Pola
Pole sumy image. Dozwolony jest tylko jeden typ elementu MediaImage. image może mieć tylko jedną z tych wartości:
large

object (StaticImagePrompt)

Duży obraz, np. okładka albumu itp.

icon

object (StaticImagePrompt)

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 (ListItem)
    }
  ]
}
Pola
title

string

Opcjonalnie. Tytuł listy.

subtitle

string

Opcjonalnie. Podtytuł listy.

items[]

object (ListItem)

To pole jest wymagane. Elementy listy.

ListItem

Element na liście.

Zapis JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Pola
key

string

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

string

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

string

Opcjonalnie. Tekst główny elementu.

image

object (StaticImagePrompt)

Opcjonalnie. Obraz elementu.

StaticCollectionPrompt

Karta prezentująca zbiór opcji do wyboru.

Zapis JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Pola
title

string

Opcjonalnie. Tytuł kolekcji.

subtitle

string

Opcjonalnie. Podtytuł kolekcji.

items[]

object (CollectionItem)

To pole jest wymagane. Elementy z kolekcji.

imageFill

enum (ImageFill)

Opcjonalnie. Typ opcji wyświetlania obrazu.

CollectionItem

Element w kolekcji.

Zapis JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Pola
key

string

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

string

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

string

Opcjonalnie. Tekst główny elementu.

image

object (StaticImagePrompt)

Opcjonalnie. Obraz elementu.

Sugestia

Reprezentuje element z sugestią, czyli element interfejsu wyświetlany dla wygody użytkownika.

Zapis JSON
{
  "title": string
}
Pola
title

string

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

string

To pole jest wymagane. Adres URL widoku internetowego do wczytania.

data[]

value (Value format)

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

boolean

Opcjonalnie. Wartość prawda oznacza, że po pokazaniu użytkownikowi tej immersyjnej odpowiedzi mikrofon się nie uruchamia, aby rejestrować sygnał.