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

Zapis JSON
{
  "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.

Zapis JSON
{
  "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.

Zapis JSON
{
  "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.

Zapis JSON
{
  "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.

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

override

boolean

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

object (StaticCanvasPrompt)

Odpowiedź używana w przypadku interaktywnego obszaru roboczego.

StaticSimplePrompt

Reprezentuje prosty prompt, który należy wysłać użytkownikowi.

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

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

StaticCardPrompt

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

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

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.

Zapis JSON
{
  "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.

Zapis JSON
{
  "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.

Zapis JSON
{
  "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.

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. 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 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 nie określono inaczej, treść zostanie wyrównana do krawędzi początkowej.

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

Zapis JSON
{
  "text": string
}
Pola
text

string

Zawartość tekstowa komórki.

StaticMediaPrompt

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

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

MediaImage

Obraz do wyświetlenia w 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 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.

Zapis JSON
{
  "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.

Zapis JSON
{
  "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.

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)

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

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.

Sugestia

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

Zapis JSON
{
  "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. 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

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

boolean

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