EventHandler

candidates: 
  - object (StaticPromptCandidate)

object (StaticPromptCandidate)

Die Liste der möglichen Prompts, die an den Client gesendet werden sollen. Jeder Prompt hat einen Selector, um festzulegen, wann er verwendet werden kann. Der erste Selector, der einer Anfrage entspricht, wird gesendet und der Rest ignoriert.

selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)

object (Selector)

Optional. Die Kriterien dafür, ob dieser Prompt mit einer Anfrage übereinstimmt. Wenn die Auswahl leer ist, wird diese Aufforderung immer ausgelöst.

object (StaticPromptResponse)

Die mit der Auswahl verknüpfte Prompt-Antwort.

surfaceCapabilities: 
  object (SurfaceCapabilities)

object (SurfaceCapabilities)

Die erforderlichen Oberflächenfunktionen.

capabilities: 
  - enum (Capability)

enum (Capability)

Erforderlich. Die Fähigkeiten der Oberfläche, die eine Anfrage an die Aktion sendet.

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

object (StaticSimplePrompt)

Optional. Die erste reine Sprach- und Textantwort.

object (StaticContentPrompt)

Optional. Ein Inhalt wie eine Karte, eine Liste oder ein Medium, das bzw. der dem Nutzer angezeigt werden soll.

object (StaticSimplePrompt)

Optional. Die letzte reine Sprach- und Textantwort.

object (Suggestion)

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

object (StaticLinkPrompt)

Optional. Ein zusätzlicher Vorschlags-Chip, der auf die verknüpfte App oder Website verweisen kann. Der Chip wird mit dem Titel „Öffnen “ gerendert. Maximal 20 Zeichen.

boolean

Optional. Modus zum Zusammenführen 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 in diesem Prompt definierte Nachrichten hinzu. false fügt die in diesem Prompt definierten Nachrichten den in früheren Antworten definierten Nachrichten hinzu. Wenn du dieses Feld auf false setzt, wird auch das Anfügen an einige Felder in einfachen Prompts, der Aufforderung „Vorschläge“ und der Canvas-Aufforderung (Teil der Inhaltsaufforderung) aktiviert. Die Inhalts- und Linkmeldungen werden immer überschrieben, wenn sie im Prompt definiert werden. Der Standardwert ist false.

object (StaticCanvasPrompt)

Eine Antwort, die für das interaktive Canvas-Erlebnis verwendet werden soll.

variants: 
  - object (Variant)

object (Variant)

Liste der möglichen Varianten.

speech: string
text: string

string

Optional. Stellt die Sprache dar, die dem Nutzer vorgelesen werden soll. Kann SSML oder Sprachausgabe sein. Standardmäßig wird die Sprachausgabe an die vorherige einfache Aufforderung angehängt. Wenn das Feld override im zugehörigen Prompt true lautet, überschreibt die in diesem Feld definierte Sprache die vorherige Sprache des einfachen Prompts.

string

Optional. Text, der im Chat-Infofeld angezeigt wird. Wenn nicht angegeben, wird eine Anzeigedarstellung des obigen Sprachfelds verwendet. Auf 640 Zeichen begrenzt. Standardmäßig wird der Text an den vorherigen einfachen Prompt-Text angehängt. Wenn das Feld override im enthaltenen Prompt true lautet, überschreibt der in diesem Feld definierte Text den vorherigen einfachen Prompt-Text.

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

object (StaticCardPrompt)

Eine einfache Karte.

object (StaticImagePrompt)

Ein Bild.

object (StaticTablePrompt)

Tabellenkarte.

object (StaticMediaPrompt)

Antwort, die eine Gruppe von Medien angibt, die abgespielt werden sollen.

object (StaticListPrompt)

Eine Karte, auf der eine Liste mit Optionen präsentiert wird.

object (StaticCollectionPrompt)

Eine Karte mit einer Liste von Optionen zur Auswahl.

object (StaticCollectionBrowsePrompt)

Eine Karte mit einer Sammlung von Webseiten, die geöffnet werden können.

title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)

string

Optional. Gesamttitel der Karte

string

Optional. Untertitel der Karte

string

Erforderlich. Text der Karte, der erforderlich ist, sofern kein Bild vorhanden ist Unterstützt einen begrenzten Satz von Markdown-Syntax für die Formatierung.

object (StaticImagePrompt)

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

enum (ImageFill)

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

object (StaticLinkPrompt)

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

url: string
alt: string
height: integer
width: integer

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.

string

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

integer

Optional. Die Höhe des Bilds in Pixeln

integer

Optional. Die Breite des Bilds in Pixeln

name: string
open: 
  object (OpenUrl)

string

Name des Links

object (OpenUrl)

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

url: string
hint: enum (UrlHint)

string

Das URL-Feld, entweder http- oder https-URLs zum Öffnen einer mit Apps verknüpften App oder einer Webseite

enum (UrlHint)

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

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

string

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

string

Optional. Untertitel für die Tabelle.

object (StaticImagePrompt)

Optional. Mit der Tabelle verknüpftes Bild.

object (TableColumn)

Optional. Überschriften und Ausrichtung von Spalten.

object (TableRow)

Optional. Zeilendaten der Tabelle. Die ersten 3 Zeilen werden garantiert angezeigt, aber die anderen werden möglicherweise an bestimmten Oberflächen abgeschnitten. Führen Sie einen Test mit dem Simulator durch, um zu sehen, welche Zeilen für eine bestimmte Oberfläche angezeigt werden. Auf Oberflächen, die die Funktion WEB_BROWSER unterstützen, kannst du den Nutzer auf eine Webseite mit weiteren Daten verweisen.

object (StaticLinkPrompt)

Optional. Schaltfläche.

header: string
align: enum (HorizontalAlignment)

string

Überschrift für die Spalte.

enum (HorizontalAlignment)

Horizontale Ausrichtung des Inhalts mit der Spalte. Wenn kein Wert angegeben ist, wird der Inhalt an der Spitze ausgerichtet.

cells: 
  - object (TableCell)
divider: boolean

object (TableCell)

Zellen in dieser Zeile. Die ersten 3 Zellen werden garantiert angezeigt, aber andere werden möglicherweise an bestimmten Oberflächen ausgeschnitten. Führen Sie einen Test mit dem Simulator durch, um zu sehen, welche Zellen für eine bestimmte Oberfläche angezeigt werden.

boolean

Gibt an, ob nach jeder Zeile eine Trennlinie vorhanden sein soll.

text: string

string

Textinhalt der Zelle.

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

enum (MediaType)

Medientyp dieser Antwort.

string (Duration format)

Startversatz des ersten Medienobjekts.

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

enum (OptionalMediaControls)

Optionale Mediensteuerungstypen, die diese Medienantwortsitzung unterstützen kann. Wenn festgelegt, wird die Anfrage an 3p gesendet, wenn ein bestimmtes Medienereignis eintritt. Wenn die Richtlinie nicht konfiguriert ist, muss 3p dennoch die beiden Standardsteuerungstypen FINISHED und FAILED verarbeiten.

object (MediaObject)

Liste der Medienobjekte.

enum (RepeatMode)

Wiederholungsmodus für die Liste der Medienobjekte.

name: string
description: string
url: string
image: 
  object (MediaImage)

string

Name dieses Medienobjekts.

string

Beschreibung dieses Medienobjekts.

string

Die URL, die auf den Medieninhalt verweist

object (MediaImage)

Bild, das mit der Medienkarte angezeigt werden soll.

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

object (StaticImagePrompt)

Ein großes Bild, z. B. das Cover des Albums

object (StaticImagePrompt)

Ein kleines Bildsymbol rechts neben dem Titel. Die Größe wird auf 36 x 36 dp reduziert.

title: string
subtitle: string
items: 
  - object (ListItem)

string

Optional. Titel der Liste.

string

Optional. Untertitel der Liste.

object (ListItem)

Erforderlich. Listenelemente.

key: string
title: string
description: string
image: 
  object (StaticImagePrompt)

string

Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Eingabeschlüssels im verknüpften Typ übereinstimmt. Wenn ein Element angetippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben.

string

Erforderlich. Titel des Artikels. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Gruppe von Elementen eindeutig sein.

string

Optional. Text des Elements.

object (StaticImagePrompt)

Optional. Bild des Artikels.

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

string

Optional. Titel der Sammlung.

string

Optional. Untertitel der Sammlung.

object (CollectionItem)

Erforderlich. Sammlungselemente.

enum (ImageFill)

Optional. Art der Bildanzeigeoption.

key: string
title: string
description: string
image: 
  object (StaticImagePrompt)

string

Erforderlich. Der NLU-Schlüssel, der mit dem Namen des Eingabeschlüssels im verknüpften Typ übereinstimmt. Wenn ein Element angetippt wird, wird diese Taste als Parameter für die Auswahloption zurückgegeben.

string

Erforderlich. Titel des Artikels. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss innerhalb der Gruppe von Elementen eindeutig sein.

string

Optional. Text des Elements.

object (StaticImagePrompt)

Optional. Bild des Artikels.

items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)

object (CollectionBrowseItem)

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

enum (ImageFill)

Anzeigeoption für Bilder in der Sammlung.

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

string

Erforderlich. Titel des Sammlungselements.

string

Beschreibung des Sammlungselements.

string

Fußzeilentext für das Sammlungselement, der unter der Beschreibung angezeigt wird. Einzelne, mit Auslassungspunkten abgeschnittene Textzeile.

object (StaticImagePrompt)

Bild für das Sammlungselement.

object (OpenUrl)

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

title: string

string

Erforderlich. Der Text, der im Vorschlags-Chip angezeigt wird. Wenn dieser Text angetippt wird, wird er wörtlich in der Unterhaltung gepostet, als ob der Nutzer ihn eingegeben hätte. Jeder Titel muss unter den Vorschlags-Chips eindeutig sein. Maximal 25 Zeichen

url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean

string

Erforderlich. URL der zu ladenden Webansicht.

value (Value format)

Optional. JSON-Daten, die als Ereignis an die Webseite des immersiven Erlebnisses übergeben werden. Wenn das Feld override im enthaltenen Prompt false enthält, werden die in diesem Canvas-Prompt definierten Datenwerte nach den in vorherigen Canvas-Prompts definierten Datenwerten hinzugefügt.

boolean

Optional. Ein wahrer Wert bedeutet, dass das Mikrofon nicht für die Erfassung von Eingaben geöffnet wird, nachdem die immersive Antwort dem Nutzer präsentiert wurde.

boolean

Optional. Bei true sind unterhaltungsbezogene Metadaten enthalten und werden an die Canvas-Anwendung zurückgesendet.

boolean

Optional. Wenn true aktiviert ist, füllt die Canvas-Anwendung den gesamten Bildschirm aus und hat oben keine Kopfzeile. Außerdem wird auf dem Ladebildschirm eine Toast-Nachricht mit dem Anzeigenamen der Aktion, dem Namen des Entwicklers und einer Anleitung zum Beenden der Aktion angezeigt. Standardwert: false.

boolean

Optional. Bei „true“ wird die Sprachausgabe durch Tippen auf den Bildschirm nicht während der gesamten Canvas-Sitzung beendet. Standardwert: false.