EventHandler

Definiuje moduł obsługi do wykonania po zdarzeniu. Przykładami zdarzeń w scenie są zdarzenia związane z intencjami i warunkami.

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 do wywołania.

Pole sumy prompt. Prompty mogą być wstawiane w treści lub mogą się przywoływać w treści. prompt może mieć tylko jedną z tych wartości:
staticPrompt

object (StaticPrompt)

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

staticPromptName

string

Nazwa statycznego promptu, który ma zostać wywołany.

StaticPrompt

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

Reprezentacja YAML
candidates: 
  - object (StaticPromptCandidate)
Pola
candidates[]

object (StaticPromptCandidate)

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.

Reprezentacja YAML
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
Pola
selector

object (Selector)

Opcjonalnie: Kryteria, czy ten prompt pasuje do żądania. Jeśli selektor jest pusty, prośba zawsze będzie wywoływana.

promptResponse

object (StaticPromptResponse)

Odpowiedź na prompt powiązana z selektorem.

Selektor

Określa kryteria dopasowania promptu do żądania.

Reprezentacja YAML
surfaceCapabilities: 
  object (SurfaceCapabilities)
Pola
surfaceCapabilities

object (SurfaceCapabilities)

Zbiór wymaganych możliwości powierzchni.

SurfaceCapabilities

Reprezentuje platformę, na której użytkownik wysyła żądanie do działania.

Reprezentacja YAML
capabilities: 
  - enum (Capability)
Pola
capabilities[]

enum (Capability)

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.

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 będą pojawiać się na końcu odpowiedzi. Jeśli pole append w powiązanym promptie ma wartość true, tytuły zdefiniowane w tym polu zostaną dodane do tytułów zdefiniowanych we wszystkich wcześniej zdefiniowanych promptach sugestii, a zduplikowane wartości zostaną usunięte.

override

boolean

Opcjonalnie: Tryb sposobu łączenia tych wiadomości z wiadomościami zdefiniowanymi wcześniej. Aplikacja true usunie wszystkie wcześniej zdefiniowane wiadomości (pierwsza i ostatnia prosta, treść, link z sugestiami oraz obszar roboczy) i doda wiadomości zdefiniowane w tym promptie. false doda wiadomości zdefiniowane w tym promptie do wiadomości zdefiniowanych w poprzednich odpowiedziach. Ustawienie tego pola na false umożliwia też dołączanie do niektórych pól w prostych promptach, w prompcie Sugestie i Canvas (część promptu Treść). Wiadomości z treścią i linkami zawsze zostaną zastąpione, 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 prompt, który należy wysłać użytkownikowi.

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ć wypowiedziana użytkownikowi. Może to być SSML lub zamiana tekstu na mowę. Domyślnie mowa jest dołączana do mowy poprzedniego promptu prostego. Jeśli pole override w nowym promptie to true mowa zdefiniowana w tym polu zastąpi mowę poprzedniego prostego promptu.

text

string

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. Domyślnie tekst jest dołączany do tekstu poprzedniego prostego promptu. Jeśli pole override w nowym promptie ma wartość true, tekst zdefiniowany w tym polu zastąpi tekst poprzedniego prostego promptu.

StaticContentPrompt

Obiekt zastępczy części „treść” prompta statycznego.

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 typ treści. content może mieć tylko jedną z tych wartości:
card

object (StaticCardPrompt)

karta podstawowa.

image

object (StaticImagePrompt)

Obraz.

table

object (StaticTablePrompt)

Karta tabeli.

media

object (StaticMediaPrompt)

Odpowiedź wskazująca zbiór multimediów do odtworzenia.

list

object (StaticListPrompt)

Karta zawierająca listę opcji do wyboru.

collection

object (StaticCollectionPrompt)

Karta z listą opcji do wyboru.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Karta przedstawiająca zbiór stron internetowych do otwarcia.

StaticCardPrompt

Podstawowa karta do wyświetlania pewnych informacji, np. obrazu i/lub tekstu.

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

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

object (StaticImagePrompt)

Opcjonalnie: Baner powitalny karty. Wysokość jest stała na 192 dp.

imageFill

enum (ImageFill)

Opcjonalnie: Sposób wypełniania 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

Wymagane. Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). Na przykład: https://www.agentx.com/logo.png.

alt

string

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 z sugestią i może być otwierany przez użytkownika.

Reprezentacja YAML
name: string
open: 
  object (OpenUrl)
Pola
name

string

Nazwa linku

open

object (OpenUrl)

Określa, co się stanie, gdy użytkownik otworzy link.

OpenUrl

Określa, co się stanie, gdy użytkownik otworzy link.

Reprezentacja YAML
url: string
hint: enum (UrlHint)
Pola
url

string

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

enum (UrlHint)

Wskazuje wskazówkę dotyczącą typu adresu URL.

StaticTablePrompt

Karta tabeli zawierająca tabelę z tekstem.

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. Ta opcja jest wymagana, jeśli ustawiono podtytuł.

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 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 funkcję WEB_BROWSER możesz kierować użytkowników 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 nie określono inaczej, treść zostanie wyrównana do krawędzi początkowej.

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

boolean

Wskazuje, czy po każdym wierszu powinien być separator.

TableCell

Opisuje komórkę w wierszu.

Reprezentacja YAML
text: string
Pola
text

string

Zawartość tekstowa komórki.

StaticMediaPrompt

Zawiera informacje o multimediach, takie jak nazwa, opis, 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 w tej odpowiedzi.

startOffset

string (Duration format)

Odsunięcie pierwszego obiektu multimedialnego.

Czas trwania w sekundach z maksymalnie dziewięcioma cyframi po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

optionalMediaControls[]

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

object (MediaObject)

Lista obiektów multimedialnych.

repeatMode

enum (RepeatMode)

Tryb powtarzania w przypadku listy obiektów multimediów.

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 z kartą multimediów.

MediaImage

Obraz do wyświetlenia w 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 obiektu MediaImage. image może mieć tylko jedną z tych wartości:
large

object (StaticImagePrompt)

Duże zdjęcie, np. okładka albumu itp.

icon

object (StaticImagePrompt)

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.

Reprezentacja YAML
title: string
subtitle: string
items: 
  - object (ListItem)
Pola
title

string

Opcjonalnie: Tytuł listy.

subtitle

string

Opcjonalnie: Podtytuł listy.

items[]

object (ListItem)

Wymagane. Pozycje listy.

ListItem

element na liście.

Reprezentacja YAML
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Pola
key

string

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

string

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

string

Opcjonalnie: Tekst główny elementu.

image

object (StaticImagePrompt)

Opcjonalnie: Obraz elementu.

StaticCollectionPrompt

Karta, która przedstawia kolekcję 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)

Wymagane. Elementy 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

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

string

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

string

Opcjonalnie: Tekst główny elementu.

image

object (StaticImagePrompt)

Opcjonalnie: Obraz elementu.

StaticCollectionBrowsePrompt

Przedstawia zestaw dokumentów internetowych jako zbiór dużych elementów. Można je wybrać do uruchomienia powiązanego dokumentu internetowego 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

Wymagane. Tytuł elementu kolekcji.

description

string

Opis elementu kolekcji.

footer

string

Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty wielokropkiem.

image

object (StaticImagePrompt)

Obraz elementu kolekcji.

openUriAction

object (OpenUrl)

Wymagane. Identyfikator URI do otworzenia po wybraniu elementu.

Sugestia

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

Reprezentacja YAML
title: string
Pola
title

string

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. Tej opcji można używać w połączeniu z polem firstSimple w prośbie o rozmowę z użytkownikiem w uzupełnieniu do wyświetlenia interaktywnej odpowiedzi kanwy.

Reprezentacja YAML
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
Pola
url

string

Wymagane. Adres URL widoku internetowego do wczytania.

data[]

value (Value format)

Opcjonalnie: Dane JSON przekazywane na stronę internetową środowiska immersyjnego jako zdarzenie. Jeśli pole override w promptie zawiera wartości false zdefiniowane w tym promptie Canvas, zostaną dodane po wartościach danych zdefiniowanych w poprzednich promptach Canvas.

suppressMic

boolean

Opcjonalnie: Wartość prawda oznacza, że mikrofon nie włączy się do rejestrowania danych wejściowych po przedstawieniu użytkownikowi tej szczegółowej odpowiedzi.

sendStateDataToCanvasApp

boolean

Opcjonalnie: Jeśli true, metadane dotyczące rozmowy są dołączane i odsyłane z powrotem do aplikacji Canvas.

enableFullScreen

boolean

Opcjonalnie: Jeśli true, aplikacja Canvas zajmuje pełny ekran i nie ma nagłówka na górze. Na ekranie wczytywania pojawi się też komunikat z wyświetlaną nazwą akcji, nazwą dewelopera i instrukcjami zamknięcia akcji. Wartość domyślna: false.

continueTtsDuringTouch

boolean

Opcjonalnie: Jeśli wybrano opcję prawda, dotknięcia ekranu nie zatrzymują zamiany tekstu na mowę przez całą sesję Canvas. Wartość domyślna: false.