- StaticPromptCandidate
- Auswahl
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- Vorschlag
- StaticCanvasPrompt
Stellt eine Liste mit Vorschlagskandidaten dar. Eine davon wird als Aufforderung ausgewählt, die dem Nutzer in der Antwort angezeigt wird. Diese Nachricht kann lokalisiert werden.
JSON-Darstellung | |
---|---|
{
"candidates": [
{
object ( |
Felder | |
---|---|
candidates[] |
Die Liste der möglichen Eingabeaufforderungen, die an den Client gesendet werden sollen. Für jeden Prompt gibt es eine Auswahl, mit der festgelegt wird, wann er verwendet werden kann. Der erste Selector, der einer Anfrage entspricht, wird gesendet. Der Rest wird ignoriert. |
StaticPromptCandidate
Stellt einen statischen Prompt-Kandidaten dar.
JSON-Darstellung | |
---|---|
{ "selector": { object ( |
Felder | |
---|---|
selector |
Optional. Die Kriterien dafür, ob diese Aufforderung einer Anfrage entspricht. Wenn die Auswahl leer ist, wird diese Eingabeaufforderung immer ausgelöst. |
promptResponse |
Die mit der Auswahl verknüpfte Eingabeaufforderung. |
Selector
Definiert die Kriterien dafür, ob eine Aufforderung mit einer Anfrage übereinstimmt.
JSON-Darstellung | |
---|---|
{
"surfaceCapabilities": {
object ( |
Felder | |
---|---|
surfaceCapabilities |
Die erforderlichen Oberflächenfunktionen. |
SurfaceCapabilities
Stellt die Oberfläche dar, die der Nutzer für eine Anfrage an die Aktion verwendet.
JSON-Darstellung | |
---|---|
{
"capabilities": [
enum ( |
Felder | |
---|---|
capabilities[] |
Erforderlich. Die Fähigkeiten der Oberfläche, die eine Anfrage an die Aktion sendet. |
StaticPromptResponse
Stellt strukturierte Antworten dar, die an den Nutzer gesendet werden, z. B. Text, Sprache, Karten, Canvas-Daten oder Vorschlags-Chips.
JSON-Darstellung | |
---|---|
{ "firstSimple": { object ( |
Felder | |
---|---|
firstSimple |
Optional. Die erste Sprach- und Textantwort. |
content |
Optional. Dem Nutzer angezeigte Inhalte wie Karten, Listen oder Medien. |
lastSimple |
Optional. Die letzte Antwort per Sprach- oder Texteingabe. |
suggestions[] |
Optional. Vorschläge, die dem Nutzer immer am Ende der Antwort angezeigt werden. Wenn das Feld „append“ in der zugehörigen Aufforderung auf „true“ gesetzt ist, werden die in diesem Feld definierten Titel zu Titeln hinzugefügt, die in den zuvor definierten Vorschlägen für Vorschläge definiert wurden. Außerdem werden doppelte Werte entfernt. |
link |
Optional. Ein zusätzlicher Vorschlags-Chip, der auf die verknüpfte App oder Website verweist. Der Chip wird mit dem Titel „Öffnen |
override |
Optional. Modus für die Zusammenführung dieser Nachrichten mit zuvor definierten Nachrichten. „true“ löscht alle zuvor definierten Nachrichten (erste und letzte einfache, Inhalt, Link und Canvas mit Vorschlägen) und fügt Nachrichten hinzu, die in diesem Prompt definiert wurden. Bei „false“ werden die in diesem Prompt definierten Nachrichten den Nachrichten hinzugefügt, die in den vorherigen Antworten definiert wurden. Wenn Sie dieses Feld auf „false“ setzen, können auch an einige Felder innerhalb der einfachen Aufforderungen, der Vorschläge für Vorschläge und der Canvas-Aufforderung (Teil der Inhaltsaufforderung) Daten angehängt werden. Die Inhalts- und Linknachrichten werden immer überschrieben, wenn sie in der Eingabeaufforderung definiert wurden. Der Standardwert ist „false“. |
canvas |
Eine Antwort, die für die interaktive Canvas-Nutzung verwendet werden soll. |
StaticSimplePrompt
Stellt eine einfache Aufforderung dar, die an einen Nutzer gesendet werden soll.
JSON-Darstellung | |
---|---|
{
"variants": [
{
object ( |
Felder | |
---|---|
variants[] |
Liste der möglichen Varianten. |
Variante
Stellt eine Variante dar, die Teil der einfachen Aufforderung ist.
JSON-Darstellung | |
---|---|
{ "speech": string, "text": string } |
Felder | |
---|---|
speech |
Optional. Stellt die Sprache dar, die für den Nutzer gesprochen wird. Kann SSML oder Text-to-Speech sein. Wenn das Feld „append“ in der zugehörigen Aufforderung „true“ ist, wird die in diesem Feld definierte Sprache an die Sprachausgabe der vorherigen einfachen Aufforderung angehängt. |
text |
Optional. Text, der im Infofeld des Chats angezeigt wird. Wenn nicht angegeben, wird das obige Sprachfeld angezeigt. Auf 640 Zeichen begrenzt. Wenn das Feld „append“ in der zugehörigen Aufforderung „true“ ist, wird der in diesem Feld definierte Text an den Text der vorherigen einfachen Aufforderung angehängt. |
StaticContentPrompt
Ein Platzhalter für den Content-Teil eines StaticPrompt.
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld content . In einer Aufforderung darf nur ein Inhaltstyp enthalten sein. Für content ist nur einer der folgenden Werte zulässig: |
||
card |
Eine einfache Karte. |
|
image |
Ein Bild. |
|
table |
Tabellenkarte. |
|
media |
Antwort, die eine Reihe von Medien angibt, die wiedergegeben werden sollen. |
|
list |
Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann. |
|
collection |
Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann. |
StaticCardPrompt
Eine einfache Karte zur Anzeige einiger Informationen, z.B. ein Bild und/oder Text.
JSON-Darstellung | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Felder | |
---|---|
title |
Optional. Gesamttitel der Karte. |
subtitle |
Optional. Untertitel der Karte. |
text |
Erforderlich. Text der Karte, der benötigt wird, sofern kein Bild vorhanden ist Unterstützt eine begrenzte Anzahl von Markdown-Syntax für die Formatierung. |
image |
Optional. Ein Hero-Image für die Karte. Die Höhe ist auf 192 dp festgelegt. |
imageFill |
Optional. Legt fest, wie der Bildhintergrund ausgefüllt wird. |
button |
Optional. Eine anklickbare Schaltfläche, die auf der Karte angezeigt wird. |
StaticImagePrompt
Ein Bild, das auf der Karte angezeigt wird.
JSON-Darstellung | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Felder | |
---|---|
url |
Erforderlich. Die Quell-URL des Bildes. Bilder können das Format JPG, PNG und GIF haben (animiert und nicht animiert). Beispiel: |
alt |
Erforderlich. Eine Textbeschreibung des Bildes, die für Barrierefreiheit verwendet werden soll, z.B. Screenreader. |
height |
Optional. Die Höhe des Bilds in Pixeln |
width |
Optional. Die Breite des Bilds in Pixeln |
StaticLinkPrompt
Definiert einen Link, der als Vorschlags-Chip angezeigt wird und vom Nutzer geöffnet werden kann.
JSON-Darstellung | |
---|---|
{
"name": string,
"open": {
object ( |
Felder | |
---|---|
name |
Name des Links |
open |
Definiert das Verhalten, wenn der Nutzer den Link öffnet. |
OpenUrl
Definiert das Verhalten, wenn der Nutzer den Link öffnet.
JSON-Darstellung | |
---|---|
{
"url": string,
"hint": enum ( |
Felder | |
---|---|
url |
Das URL-Feld, das einen der folgenden Werte annehmen kann: – HTTP- oder HTTPS-URLs zum Öffnen einer mit der App verknüpften App oder einer Webseite |
hint |
Gibt einen Hinweis für den URL-Typ an. |
StaticTablePrompt
Eine Tabellenkarte zum Anzeigen einer Tabelle mit Text.
JSON-Darstellung | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Felder | |
---|---|
title |
Optional. Gesamttitel der Tabelle. Muss festgelegt werden, wenn Untertitel festgelegt sind. |
subtitle |
Optional. Untertitel für die Tabelle. |
image |
Optional. Mit der Tabelle verknüpftes Bild. |
columns[] |
Optional. Überschriften und Spaltenausrichtung. |
rows[] |
Optional. Zeilendaten der Tabelle Die ersten 3 Zeilen werden garantiert angezeigt, aber andere werden auf bestimmten Oberflächen möglicherweise ausgeschnitten. Testen Sie mit dem Simulator, welche Zeilen für eine bestimmte Oberfläche angezeigt werden. Auf Oberflächen, die die WEB_BROWSER-Funktion unterstützen, können Sie den Nutzer auf eine Webseite mit mehr Daten verweisen. |
button |
Optional. Schaltfläche. |
TableColumn
Beschreibt eine Spalte in der Tabelle.
JSON-Darstellung | |
---|---|
{
"header": string,
"align": enum ( |
Felder | |
---|---|
header |
Überschrift der Spalte. |
align |
Horizontale Ausrichtung des Inhalts in der Spalte „Richtig“. Wenn kein Wert angegeben ist, wird der Inhalt an der obersten Kante ausgerichtet. |
TableRow
Beschreibt eine Zeile in der Tabelle.
JSON-Darstellung | |
---|---|
{
"cells": [
{
object ( |
Felder | |
---|---|
cells[] |
Zellen in dieser Zeile. Die ersten 3 Zellen werden garantiert angezeigt, andere werden jedoch möglicherweise auf bestimmten Oberflächen ausgeschnitten. Testen Sie mit dem Simulator, welche Zellen für eine bestimmte Oberfläche angezeigt werden. |
divider |
Gibt an, ob nach jeder Zeile eine Trennlinie eingefügt werden soll. |
TableCell
Beschreibt eine Zelle in einer Zeile.
JSON-Darstellung | |
---|---|
{ "text": string } |
Felder | |
---|---|
text |
Textinhalt der Zelle |
StaticMediaPrompt
Enthält Informationen zum Medium, z. B. Name, Beschreibung und URL. Nächste ID: 9
JSON-Darstellung | |
---|---|
{ "mediaType": enum ( |
Felder | |
---|---|
mediaType |
Medientyp dieser Antwort. |
startOffset |
Startversatz des ersten Medienobjekts. Dauer in Sekunden mit bis zu neun Nachkommastellen und einem ' |
optionalMediaControls[] |
Optionale Arten der Mediensteuerung, die diese Medienantwortsitzung unterstützen kann. Wenn festgelegt, erfolgt bei einem bestimmten Medienereignis die Anfrage an 15:00 Uhr. Wenn die Richtlinie nicht konfiguriert ist, muss Drittanbieter immer noch zwei Standardsteuerungstypen verarbeiten: FINISHED und FAILED. |
mediaObjects[] |
Liste der Medienobjekte. |
MediaObject
Stellt ein einzelnes Medienobjekt dar.
JSON-Darstellung | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Felder | |
---|---|
name |
Name dieses Medienobjekts. |
description |
Beschreibung dieses Medienobjekts. |
url |
Die URL, die auf den Medieninhalt verweist |
image |
Bild, das mit der Medienkarte angezeigt wird. |
MediaImage
Bild, das in einem MediaPrompt angezeigt wird
JSON-Darstellung | |
---|---|
{ // Union field |
Felder | ||
---|---|---|
Union-Feld image . Es ist nur ein MediaImage-Typ zulässig. Für image ist nur einer der folgenden Werte zulässig: |
||
large |
Ein großes Bild wie das Cover des Albums usw. |
|
icon |
Ein kleines Bildsymbol, das rechts neben dem Titel angezeigt wird. Die Größe wird auf 36 × 36 dp angepasst. |
StaticListPrompt
Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann.
JSON-Darstellung | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Felder | |
---|---|
title |
Optional. Titel der Liste. |
subtitle |
Optional. Untertitel der Liste. |
items[] |
Erforderlich. Listenelemente. |
ListItem
Ein Element in der Liste.
JSON-Darstellung | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Felder | |
---|---|
key |
Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Zugangscodes im zugehörigen Typ übereinstimmt. Wenn auf das Element getippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben. |
title |
Erforderlich. Titel des Artikels Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Elementgruppe eindeutig sein. |
description |
Optional. Text des Elements. |
image |
Optional. Bild des Artikels. |
StaticCollectionPrompt
Eine Karte mit einer Reihe von Optionen, aus denen ausgewählt werden kann.
JSON-Darstellung | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Felder | |
---|---|
title |
Optional. Titel der Sammlung |
subtitle |
Optional. Untertitel der Sammlung |
items[] |
Erforderlich. Sammlungselemente. |
imageFill |
Optional. Art der Bildanzeigeoption. |
CollectionItem
Ein Element in der Sammlung.
JSON-Darstellung | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Felder | |
---|---|
key |
Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Zugangscodes im verknüpften Typ übereinstimmt. Wenn auf das Element getippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben. |
title |
Erforderlich. Titel des Artikels Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Elementgruppe eindeutig sein. |
description |
Optional. Text des Elements. |
image |
Optional. Bild des Artikels. |
Vorschlag
Stellt einen Vorschlags-Chip dar. Dies ist ein UI-Element, das dem Nutzer der Einfachheit halber angezeigt wird.
JSON-Darstellung | |
---|---|
{ "title": string } |
Felder | |
---|---|
title |
Erforderlich. Der Text im Vorschlags-Chip. Wenn dieser Text angetippt wird, wird er wortwörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel darf unter den Vorschlags-Chips nur einmal vorkommen. Maximal 25 Zeichen |
StaticCanvasPrompt
Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll. Dies kann zusammen mit dem Feld „firstSimple“ in der zugehörigen Aufforderung verwendet werden, um mit dem Nutzer zu sprechen und zusätzlich eine interaktive Canvas-Antwort anzuzeigen.
JSON-Darstellung | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
Felder | |
---|---|
url |
Erforderlich. URL der zu ladenden Webansicht. |
data[] |
Optional. JSON-Daten, die als Ereignis an die Webseite mit dem immersiven Erlebnis übergeben werden. Wenn das Feld „Überschreiben“ im zugehörigen Prompt „false“ ist, werden die in diesem Canvas-Prompt definierten Datenwerte hinzugefügt, nachdem die Datenwerte aus den vorherigen Canvas-Prompts hinzugefügt wurden. |
suppressMic |
Optional. Der Wert „true“ bedeutet, dass das Mikrofon nicht mehr geöffnet wird, um Eingaben zu erfassen, nachdem dem Nutzer diese umfassende Antwort präsentiert wurde. |