StaticPrompt

Stellt eine Liste mit Prompt-Kandidaten dar, von denen eine als Prompt ausgewählt wird, der dem Nutzer in der Antwort angezeigt wird. Diese Nachricht kann lokalisiert werden.

JSON-Darstellung
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Felder
candidates[]

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.

StaticPromptCandidate

Stellt einen Kandidaten für statische Aufforderungen dar.

JSON-Darstellung
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Felder
selector

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.

promptResponse

object (StaticPromptResponse)

Die mit der Auswahl verknüpfte Prompt-Antwort.

Selector

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

JSON-Darstellung
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Felder
surfaceCapabilities

object (SurfaceCapabilities)

Die erforderlichen Oberflächenfunktionen.

SurfaceCapabilities

Stellt die Oberfläche dar, über die der Nutzer eine Anfrage an die Aktion sendet.

JSON-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, Chips mit Vorschlägen usw.

JSON-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 reine Sprach- und Textantwort.

content

object (StaticContentPrompt)

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

lastSimple

object (StaticSimplePrompt)

Optional. Die letzte reine Sprach- und Textantwort.

suggestions[]

object (Suggestion)

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

override

boolean

Optional. Modus zum Zusammenführen dieser Nachrichten mit zuvor definierten Nachrichten. „wahr“ löscht alle zuvor definierten Nachrichten (erste und letzte einfache, 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. Dieses Feld auf „false“ setzen ermöglicht auch das Anfügen an einige Felder in einfachen Prompts, der Aufforderung „Vorschläge“ und der Canvas-Aufforderung (Teil der Inhaltsaufforderung). Die Inhalts- und Linkmeldungen werden immer überschrieben, wenn sie im Prompt definiert werden. Der Standardwert ist „false“.

canvas

object (StaticCanvasPrompt)

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

StaticSimplePrompt

Stellt eine einfache Aufforderung dar, die an einen Nutzer gesendet werden soll.

JSON-Darstellung
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Felder
variants[]

object (Variant)

Liste der möglichen Varianten.

Variante

Stellt eine Variante dar, die Teil des einfachen Prompts ist.

JSON-Darstellung
{
  "speech": string,
  "text": string
}
Felder
speech

string

Optional. Stellt die Sprache dar, die dem Nutzer vorgelesen werden soll. Kann SSML oder Sprachausgabe sein. Wenn das Feld „append“ in der enthaltenden Aufforderung ist „true“. Die in diesem Feld definierte Sprache wird an die vorherige einfache Prompt-Sprache angehängt.

text

string

Optional. Text, der im Chat-Infofeld angezeigt wird. Wenn nicht angegeben, wird eine Anzeigedarstellung des obigen Sprachfelds verwendet. Auf 640 Zeichen begrenzt. Wenn das Feld „append“ in der enthaltenden Aufforderung ist „true“. Der in diesem Feld definierte Text wird an den Text des vorherigen einfachen Prompts angehängt.

StaticContentPrompt

Ein Platzhalter für den Inhaltsteil einer StaticPrompt.

JSON-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)
  }
  // End of list of possible types for union field content.
}
Felder
Union-Feld content. In einem Prompt kann 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 Gruppe von Medien angibt, die abgespielt werden sollen.

list

object (StaticListPrompt)

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

collection

object (StaticCollectionPrompt)

Eine Karte mit einer Liste von Optionen zur Auswahl.

StaticCardPrompt

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

JSON-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 erforderlich ist, sofern kein Bild vorhanden ist Unterstützt einen begrenzten Satz 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.

JSON-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, das für Barrierefreiheit verwendet werden soll, z.B. Screenreadern.

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.

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

JSON-Darstellung
{
  "url": string,
  "hint": enum (UrlHint)
}
Felder
url

string

Das URL-Feld, entweder http- oder https-URLs zum Öffnen einer mit Apps 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.

JSON-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 Ausrichtung von Spalten.

rows[]

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 WEB_BROWSER-Funktion unterstützen, kannst du den Nutzer auf eine Webseite mit weiteren Daten verweisen.

button

object (StaticLinkPrompt)

Optional. Schaltfläche.

TableColumn

Beschreibt eine Spalte in der Tabelle.

JSON-Darstellung
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Felder
header

string

Überschrift für die Spalte.

align

enum (HorizontalAlignment)

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

TableRow

Beschreibt eine Zeile in der Tabelle.

JSON-Darstellung
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Felder
cells[]

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.

divider

boolean

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

TableCell

Beschreibt eine Zelle in einer Zeile.

JSON-Darstellung
{
  "text": string
}
Felder
text

string

Textinhalt der Zelle.

StaticMediaPrompt

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

JSON-Darstellung
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
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 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.

mediaObjects[]

object (MediaObject)

Liste der Medienobjekte.

MediaObject

Stellt ein einzelnes Medienobjekt dar.

JSON-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 werden soll.

MediaImage

Bild, das in einem MediaPrompt angezeigt wird.

JSON-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, z. B. das Cover des Albums

icon

object (StaticImagePrompt)

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

StaticListPrompt

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

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

JSON-Darstellung
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Felder
key

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.

title

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.

description

string

Optional. Text des Elements.

image

object (StaticImagePrompt)

Optional. Bild des Artikels.

StaticCollectionPrompt

Eine Karte, auf der eine Sammlung von Optionen präsentiert wird.

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

JSON-Darstellung
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Felder
key

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.

title

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.

description

string

Optional. Text des Elements.

image

object (StaticImagePrompt)

Optional. Bild des Artikels.

Vorschlag

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

JSON-Darstellung
{
  "title": string
}
Felder
title

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

StaticCanvasPrompt

Stellt eine Interactive Canvas-Antwort dar, die an den Nutzer gesendet werden soll. Dies kann in Verbindung mit dem Tag "firstSimple" in der enthaltenden Aufforderung, mit dem Nutzer zu sprechen und zusätzlich eine interaktive Canvas-Antwort anzuzeigen.

JSON-Darstellung
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean
}
Felder
url

string

Erforderlich. URL der zu ladenden Webansicht.

data[]

value (Value format)

Optional. JSON-Daten, die als Ereignis an die Webseite des immersiven Erlebnisses übergeben werden. Wenn die „Überschreibung“ in der enthaltenen Aufforderung auf „false“ gesetzt ist Datenwerte, die in diesem Canvas-Prompt definiert wurden, werden nach den in vorherigen Canvas-Prompts definierten Datenwerten hinzugefügt.

suppressMic

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.