EventHandler

Definiert einen Handler, der nach einem Ereignis ausgeführt werden soll. Beispiele für Ereignisse sind Intent- und bedingungsbasierte Ereignisse in einer Szene.

YAML-Darstellung
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.
Felder
webhookHandler

string

Name des aufzurufenden Webhook-Handlers.

Union-Feld prompt. Aufforderungen können entweder inline eingefügt oder durch den Namen referenziert werden. Für prompt ist nur einer der folgenden Werte zulässig:
staticPrompt

object (StaticPrompt)

Inline-Anzeige mit statischer Aufforderung Kann Verweise auf Stringressourcen in Bundles enthalten.

staticPromptName

string

Name der statischen Aufforderung, die aufgerufen werden soll.

StaticPrompt

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.

YAML-Darstellung
candidates: 
  - object (StaticPromptCandidate)
Felder
candidates[]

object (StaticPromptCandidate)

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.

YAML-Darstellung
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
Felder
selector

object (Selector)

Optional. Die Kriterien dafür, ob diese Aufforderung einer Anfrage entspricht. Wenn die Auswahl leer ist, wird diese Eingabeaufforderung immer ausgelöst.

promptResponse

object (StaticPromptResponse)

Die mit der Auswahl verknüpfte Eingabeaufforderung.

Selector

Definiert die Kriterien dafür, ob eine Aufforderung mit einer Anfrage übereinstimmt.

YAML-Darstellung
surfaceCapabilities: 
  object (SurfaceCapabilities)
Felder
surfaceCapabilities

object (SurfaceCapabilities)

Die erforderlichen Oberflächenfunktionen.

SurfaceCapabilities

Stellt die Oberfläche dar, die der Nutzer für eine Anfrage an die Aktion verwendet.

YAML-Darstellung
capabilities: 
  - enum (Capability)
Felder
capabilities[]

enum (Capability)

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.

YAML-Darstellung
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
Felder
firstSimple

object (StaticSimplePrompt)

Optional. Die erste Sprach- und Textantwort.

content

object (StaticContentPrompt)

Optional. Dem Nutzer angezeigte Inhalte wie Karten, Listen oder Medien.

lastSimple

object (StaticSimplePrompt)

Optional. Die letzte Antwort per Sprach- oder Texteingabe.

suggestions[]

object (Suggestion)

Optional. Vorschläge, die dem Nutzer immer am Ende der Antwort angezeigt werden. Wenn das Feld append in der zugehörigen Aufforderung true ist, werden die in diesem Feld definierten Titel den Titeln hinzugefügt, die in den zuvor definierten Vorschlägen für Vorschläge definiert wurden. Doppelte Werte werden entfernt.

override

boolean

Optional. Modus für die Zusammenführung dieser Nachrichten mit zuvor definierten Nachrichten. true löscht alle zuvor definierten Nachrichten (erste und letzte einfache Nachricht, Inhalt, Link für Vorschläge und Canvas) und fügt Nachrichten hinzu, die in diesem Prompt definiert wurden. false fügt die in diesem Prompt definierten Nachrichten den Nachrichten hinzu, 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

object (StaticCanvasPrompt)

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.

YAML-Darstellung
variants: 
  - object (Variant)
Felder
variants[]

object (Variant)

Liste der möglichen Varianten.

Variante

Stellt eine Variante dar, die Teil der einfachen Aufforderung ist.

YAML-Darstellung
speech: string
text: string
Felder
speech

string

Optional. Stellt die Sprache dar, die für den Nutzer gesprochen wird. Kann SSML oder Text-to-Speech sein. Standardmäßig wird Sprache an die Sprachausgabe des vorherigen einfachen Prompts angehängt. Wenn das Feld override in der zugehörigen Aufforderung true ist, überschreibt die in diesem Feld definierte Sprache die Sprachausgabe des vorherigen einfachen Prompts.

text

string

Optional. Text, der im Infofeld des Chats angezeigt wird. Wenn nicht angegeben, wird das obige Sprachfeld angezeigt. Auf 640 Zeichen begrenzt. Standardmäßig wird Text an den Text der vorherigen einfachen Aufforderung angehängt. Wenn das Feld override in der zugehörigen Aufforderung true ist, überschreibt der in diesem Feld definierte Text den Text des vorherigen einfachen Prompts.

StaticContentPrompt

Ein Platzhalter für den Content-Teil eines StaticPrompt.

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

object (StaticCardPrompt)

Eine einfache Karte.

image

object (StaticImagePrompt)

Ein Bild.

table

object (StaticTablePrompt)

Tabellenkarte.

media

object (StaticMediaPrompt)

Antwort, die eine Reihe von Medien angibt, die wiedergegeben werden sollen.

list

object (StaticListPrompt)

Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann.

collection

object (StaticCollectionPrompt)

Eine Karte mit einer Liste von Optionen, aus denen ausgewählt werden kann.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Eine Karte mit mehreren Webseiten, die geöffnet werden sollen.

StaticCardPrompt

Eine einfache Karte zur Anzeige einiger Informationen, z.B. ein Bild und/oder Text.

YAML-Darstellung
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
Felder
title

string

Optional. Gesamttitel der Karte.

subtitle

string

Optional. Untertitel der Karte.

text

string

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

object (StaticImagePrompt)

Optional. Ein Hero-Image für die Karte. Die Höhe ist auf 192 dp festgelegt.

imageFill

enum (ImageFill)

Optional. Legt fest, wie der Bildhintergrund ausgefüllt wird.

button

object (StaticLinkPrompt)

Optional. Eine anklickbare Schaltfläche, die auf der Karte angezeigt wird.

StaticImagePrompt

Ein Bild, das auf der Karte angezeigt wird.

YAML-Darstellung
url: string
alt: string
height: integer
width: integer
Felder
url

string

Erforderlich. Die Quell-URL des Bildes. Bilder können das Format JPG, PNG und GIF haben (animiert und nicht animiert). Beispiel: https://www.agentx.com/logo.png.

alt

string

Erforderlich. Eine Textbeschreibung des Bildes, die für Barrierefreiheit verwendet werden soll, z.B. Screenreader.

height

integer

Optional. Die Höhe des Bilds in Pixeln

width

integer

Optional. Die Breite des Bilds in Pixeln

StaticLinkPrompt

Definiert einen Link, der als Vorschlags-Chip angezeigt wird und vom Nutzer geöffnet werden kann.

YAML-Darstellung
name: string
open: 
  object (OpenUrl)
Felder
name

string

Name des Links

open

object (OpenUrl)

Definiert das Verhalten, wenn der Nutzer den Link öffnet.

OpenUrl

Definiert das Verhalten, wenn der Nutzer den Link öffnet.

YAML-Darstellung
url: string
hint: enum (UrlHint)
Felder
url

string

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

enum (UrlHint)

Gibt einen Hinweis für den URL-Typ an.

StaticTablePrompt

Eine Tabellenkarte zum Anzeigen einer Tabelle mit Text.

YAML-Darstellung
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
Felder
title

string

Optional. Gesamttitel der Tabelle. Muss festgelegt werden, wenn Untertitel festgelegt sind.

subtitle

string

Optional. Untertitel für die Tabelle.

image

object (StaticImagePrompt)

Optional. Mit der Tabelle verknüpftes Bild.

columns[]

object (TableColumn)

Optional. Überschriften und Spaltenausrichtung.

rows[]

object (TableRow)

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

object (StaticLinkPrompt)

Optional. Schaltfläche.

TableColumn

Beschreibt eine Spalte in der Tabelle.

YAML-Darstellung
header: string
align: enum (HorizontalAlignment)
Felder
header

string

Überschrift der Spalte.

align

enum (HorizontalAlignment)

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.

YAML-Darstellung
cells: 
  - object (TableCell)
divider: boolean
Felder
cells[]

object (TableCell)

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

boolean

Gibt an, ob nach jeder Zeile eine Trennlinie eingefügt werden soll.

TableCell

Beschreibt eine Zelle in einer Zeile.

YAML-Darstellung
text: string
Felder
text

string

Textinhalt der Zelle

StaticMediaPrompt

Enthält Informationen zum Medium, z. B. Name, Beschreibung und URL. Nächste ID: 11

YAML-Darstellung
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
Felder
mediaType

enum (MediaType)

Medientyp dieser Antwort.

startOffset

string (Duration format)

Startversatz des ersten Medienobjekts.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".

optionalMediaControls[]

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

object (MediaObject)

Liste der Medienobjekte.

repeatMode

enum (RepeatMode)

Wiederholungsmodus für die Liste der Medienobjekte.

MediaObject

Stellt ein einzelnes Medienobjekt dar.

YAML-Darstellung
name: string
description: string
url: string
image: 
  object (MediaImage)
Felder
name

string

Name dieses Medienobjekts.

description

string

Beschreibung dieses Medienobjekts.

url

string

Die URL, die auf den Medieninhalt verweist

image

object (MediaImage)

Bild, das mit der Medienkarte angezeigt wird.

MediaImage

Bild, das in einem MediaPrompt angezeigt wird

YAML-Darstellung
# 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.
Felder
Union-Feld image. Es ist nur ein MediaImage-Typ zulässig. Für image ist nur einer der folgenden Werte zulässig:
large

object (StaticImagePrompt)

Ein großes Bild wie das Cover des Albums usw.

icon

object (StaticImagePrompt)

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.

YAML-Darstellung
title: string
subtitle: string
items: 
  - object (ListItem)
Felder
title

string

Optional. Titel der Liste.

subtitle

string

Optional. Untertitel der Liste.

items[]

object (ListItem)

Erforderlich. Listenelemente.

ListItem

Ein Element in der Liste.

YAML-Darstellung
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Felder
key

string

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

string

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

string

Optional. Text des Elements.

image

object (StaticImagePrompt)

Optional. Bild des Artikels.

StaticCollectionPrompt

Eine Karte mit einer Reihe von Optionen, aus denen ausgewählt werden kann.

YAML-Darstellung
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
Felder
title

string

Optional. Titel der Sammlung

subtitle

string

Optional. Untertitel der Sammlung

items[]

object (CollectionItem)

Erforderlich. Sammlungselemente.

imageFill

enum (ImageFill)

Optional. Art der Bildanzeigeoption.

CollectionItem

Ein Element in der Sammlung.

YAML-Darstellung
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Felder
key

string

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

string

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

string

Optional. Text des Elements.

image

object (StaticImagePrompt)

Optional. Bild des Artikels.

StaticCollectionBrowsePrompt

Stellt eine Reihe von Webdokumenten als eine Sammlung großer Kacheln dar. Sie können Elemente auswählen, um das zugehörige Webdokument in einem Web Viewer zu öffnen.

YAML-Darstellung
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
Felder
items[]

object (CollectionBrowseItem)

Elemente in der Sammlung „Stöbern“. Die Listengröße sollte im Bereich [2, 10] liegen.

imageFill

enum (ImageFill)

Anzeigeoption für Bilder in der Sammlung

CollectionBrowseItem

Element in der Sammlung.

YAML-Darstellung
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
Felder
title

string

Erforderlich. Titel des Sammlungselements

description

string

Beschreibung des Sammlungselements

footer

string

Fußzeilentext für das Sammlungselement, angezeigt unter der Beschreibung. Einzelne Textzeile, durch Auslassungspunkte abgeschnitten.

image

object (StaticImagePrompt)

Bild für das Sammlungselement.

openUriAction

object (OpenUrl)

Erforderlich. URI, der geöffnet werden soll, wenn das Element ausgewählt wurde.

Vorschlag

Stellt einen Vorschlags-Chip dar. Dies ist ein UI-Element, das dem Nutzer der Einfachheit halber angezeigt wird.

YAML-Darstellung
title: string
Felder
title

string

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

YAML-Darstellung
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
Felder
url

string

Erforderlich. URL der zu ladenden Webansicht.

data[]

value (Value format)

Optional. JSON-Daten, die als Ereignis an die Webseite mit dem immersiven Erlebnis übergeben werden. Wenn das Feld override im zugehörigen Prompt false ist, werden die in diesem Canvas-Prompt definierten Datenwerte hinzugefügt, nachdem die in vorherigen Canvas-Prompts definierten Datenwerte hinzugefügt wurden.

suppressMic

boolean

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.

sendStateDataToCanvasApp

boolean

Optional. Wenn true, werden konversationsbezogene Metadaten eingeschlossen und an die Canvas-Anwendung zurückgesendet.

enableFullScreen

boolean

Optional. Bei true füllt die Canvas-Anwendung den gesamten Bildschirm aus und hat oben keine Kopfzeile. Außerdem wird auf dem Ladebildschirm eine Meldung angezeigt, die den Anzeigenamen der Aktion, den Namen des Entwicklers und eine Anleitung zum Beenden der Aktion enthält. Standardwert: false.

continueTtsDuringTouch

boolean

Optional. Bei „true“ wird die Sprachausgabe durch Tippen auf den Bildschirm nicht für die gesamte Canvas-Sitzung gestoppt. Standardwert: false.