EventHandler

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 prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
Pola
webhookHandler

string

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

object (StaticPrompt)

Wbudowany statyczny prompt. Może zawierać odwołania do zasobów w postaci ciągów znaków w pakietach.

staticPromptName

string

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

Reprezentacja YAML
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.

Reprezentacja YAML
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.

Reprezentacja YAML
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.

Reprezentacja YAML
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 prompcie zawierającym treść ma wartość true, tytuły zdefiniowane w tym polu zostaną dodane do tytułów zdefiniowanych we wszystkich wcześniej zdefiniowanych sugestiach, a powielone wartości zostaną usunięte.

override

boolean

Opcjonalnie. Tryb łączenia tych wiadomości z wcześniej zdefiniowanymi wiadomościami. true usunie wszystkie wcześniej zdefiniowane wiadomości (pierwszą i ostatnią prostą, treść, link do sugestii oraz obszar roboczy) oraz doda wiadomości zdefiniowane w tym promptie. false doda wiadomości zdefiniowane w tym promptie do wiadomości zdefiniowanych w poprzednich odpowiedziach. Ustawienie w tym polu wartości false umożliwi też dołączanie do niektórych pól w prostych promptach, promptach Sugestie 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.

canvas

object (StaticCanvasPrompt)

Odpowiedź używana w przypadku interaktywnego obszaru roboczego.

StaticSimplePrompt

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

Reprezentacja YAML
variants: 
  - object (Variant)
Pola
variants[]

object (Variant)

Lista możliwych wariantów.

Wariant

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

Reprezentacja YAML
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ę. Domyślnie zamiana tekstu na mowę jest dodawana do poprzedniego prostego promptu. Jeśli pole override w wierszu zawierającym prompt ma wartość true, mowa zdefiniowana w tym polu zastąpi treść poprzedniego prostego promptu.

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. Domyślnie tekst zostanie dołączony do tekstu poprzedniego prostego promptu. Jeśli pole override w wierszu zawierającym prompt ma wartość true, tekst zdefiniowany w tym polu zastąpi tekst poprzedniego prostego promptu.

StaticContentPrompt

Obiekt zastępczy stanowiący część treści elementu StaticPrompt.

Reprezentacja YAML
# 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)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# 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.

collectionBrowse

object (StaticCollectionBrowsePrompt)

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

Reprezentacja YAML
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.

Reprezentacja YAML
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.

Reprezentacja YAML
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.

Reprezentacja YAML
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 obsługujących funkcję WEB_BROWSER możesz przekierować użytkownika na stronę internetową z dodatkowymi danymi.

button

object (StaticLinkPrompt)

Opcjonalnie. Przycisk.

TableColumn

Opisuje kolumnę w tabeli.

Reprezentacja YAML
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.

Reprezentacja YAML
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.

Reprezentacja YAML
text: string
Pola
text

string

Zawartość komórki.

StaticMediaPrompt

Zawiera informacje o multimediach, takie jak nazwa, opis, adres URL itp. Następny identyfikator: 11

Reprezentacja YAML
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
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.

repeatMode

enum (RepeatMode)

Tryb powtarzania dla listy obiektów multimedialnych.

MediaObject

Reprezentuje jeden obiekt multimedialny.

Reprezentacja YAML
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.

Reprezentacja YAML
# 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.

Reprezentacja YAML
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.

Reprezentacja YAML
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.

Reprezentacja YAML
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.

Reprezentacja YAML
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.

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 (CollectionBrowseItem)
imageFill: enum (ImageFill)
Pola
items[]

object (CollectionBrowseItem)

Elementy w kolekcji Przeglądaj. Rozmiar listy powinien mieścić się w zakresie [2, 10].

imageFill

enum (ImageFill)

Opcja wyświetlania obrazów w kolekcji.

CollectionBrowseItem

Element w kolekcji.

Reprezentacja YAML
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
Pola
title

string

To pole jest wymagane. Tytuł elementu kolekcji.

description

string

Opis elementu kolekcji.

footer

string

Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty za pomocą wielokropka.

image

object (StaticImagePrompt)

Zdjęcie elementu kolekcji.

openUriAction

object (OpenUrl)

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

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

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 override w wierszu zawierającym prośbę zawiera wartość false, 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ł.

sendStateDataToCanvasApp

boolean

Opcjonalnie. Jeśli jest ustawiona wartość true, metadane związane z rozmowami są dołączane, a następnie są odsyłane do aplikacji Canvas.

enableFullScreen

boolean

Opcjonalnie. Jeśli true aplikacja Canvas zajmuje pełny ekran i nie będzie miała nagłówka na górze. Na ekranie wczytywania będzie również widoczny komunikat z podaną nazwą akcji, nazwą dewelopera i instrukcjami jej zamykania. Wartość domyślna: false

continueTtsDuringTouch

boolean

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