- Ressource: ChannelConfig
- JSON-Darstellung
- OperationsConfig
- UpsellStrategy
- UpsellConfig
- GreetingOffer
- OfferMessage
- MessageConfig
- ClosingOffer
- ClosingMessage
- CelUpsell
- SuggestedModifierGroup
- Viele Grüße
- FeaturesConfig
- OrderPickup
- OrderDineIn
- NameCollection
- GetOrderPrices
- EndSessionWithCheckoutRequest
- EnableAddressCollection
- SupportCashPayment
- InteractionMode
- DisambiguationStrategy
- DisambiguationMapping
- Typ
- TargetItem
- TargetModifier
- Bundesland
- Typ
- SupplementalInstructions
- Ton
- Methoden
Ressource: ChannelConfig
Eine Kanalkonfiguration stellt eine Konfiguration der Betriebsstrategie dar. Lebenszyklus der Kanalkonfiguration: * DRAFT: Eine Konfiguration befindet sich im Entwurfsstatus, wenn ihr keine Konfigurationsanwendungsregeln zugeordnet sind und sie nicht als Standardkonfiguration für die Marke festgelegt ist. * ACTIVE: Eine Konfiguration ist aktiv, wenn sie entweder mit einer Konfigurationsanwendungsregel verknüpft oder als Standard für die Marke festgelegt ist. * Wenn die Laufzeit aktiv ist, wird die Kanalkonfiguration auf übereinstimmende Stores angewendet. Um Flexibilität zu gewährleisten, besteht auf jeder Ressourcenebene eine 1:n-Beziehung zwischen der Kanalkonfiguration und der Regel für die Anwendung der Konfiguration: * Auf Markenebene besteht eine 1:n-Beziehung zwischen Kanalkonfigurationen und Regeln für die Anwendung der Konfiguration. * Auf Store-Ebene gibt es eine weitere 1:n-Beziehung zwischen Kanalkonfigurationen und Regeln für die Anwendung von Konfigurationen. Wenn mehrere Kanalkonfigurationen anwendbar sind, bestimmt die Laufzeit die anzuwendende Konfiguration anhand der folgenden Rangfolge (bei Konflikten überschreibt die letztere die erstere): 1. Standardeinstellung auf Markenebene 2. Markenbindung 3. Standardwert auf Store-Ebene: 4. Bindung auf Store-Ebene
| JSON-Darstellung |
|---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "operationsConfig": { object ( |
| Felder | |
|---|---|
name |
ID. Der Name der Kanalkonfiguration. Format: projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channelConfig} |
displayName |
Optional. Optionaler Anzeigename für diese Kanalkonfiguration für Benutzeroberflächen. Der Wert ist auf 63 Zeichen beschränkt. |
createTime |
Nur Ausgabe. Der Zeitpunkt, zu dem diese Kanalkonfiguration erstellt wurde. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
updateTime |
Nur Ausgabe. Der Zeitpunkt, zu dem diese Kanalkonfiguration zuletzt aktualisiert wurde. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
operationsConfig |
Optional. Die Betriebsstrategie für die Kanalkonfiguration. |
state |
Nur Ausgabe. Der Status der Kanalkonfiguration. |
type |
Erforderlich. Der Typ der Kanalkonfiguration. |
supplementalInstructions |
Optional. Zusätzliche Anweisungen für die Kanalkonfiguration. |
tone |
Optional. Der Tonfall des KI-Agenten. |
configApplicationRules[] |
Nur Ausgabe. Die Regeln für die Konfigurationsanwendung, die mit dieser Kanalkonfiguration verknüpft sind. |
OperationsConfig
Konfigurationen zum Definieren einer Betriebsstrategie.
| JSON-Darstellung |
|---|
{ "displayName": string, "description": string, "upsellStrategy": { object ( |
| Felder | |
|---|---|
displayName |
Optional. Der Name dieser Betriebsstrategie. |
description |
Optional. Eine Beschreibung dieser Betriebsstrategie. |
upsellStrategy |
Optional. Konfiguration für das Upselling-Verhalten. |
greetings[] |
Optional. Benutzerdefinierte Begrüßungsnachrichten (pro Sprache) |
defaultLanguageCode |
Optional. Standardsprache für die Kundenbetreuung. |
featuresConfig |
Optional. Konfiguration der KI-Agentenfunktionen. |
interactionMode |
Optional. Der Interaktionsmodus des KI-Agenten. |
disambiguationStrategy |
Optional. Strategiekonfiguration für die Disambiguierungssteuerung. |
UpsellStrategy
Definiert die Strategie für das Upselling.
| JSON-Darstellung |
|---|
{
"maxUpsellOffers": integer,
"maxUpsellDeclines": integer,
"maxItemsInCart": integer,
"upsells": [
{
object ( |
| Felder | |
|---|---|
maxUpsellOffers |
Optional. Die maximale Anzahl von Upselling-Angeboten, die pro Sitzung präsentiert werden sollen. |
maxUpsellDeclines |
Optional. Die maximale Anzahl, wie oft ein Kunde ein Upselling-Angebot ablehnen kann, bevor weitere Upselling-Angebote für die aktuelle Sitzung übersprungen werden. |
maxItemsInCart |
Optional. Die maximale Anzahl von Artikeln, die im Einkaufswagen zulässig sind, bevor weitere Upsells für die aktuelle Sitzung übersprungen werden. |
upsells[] |
Optional. Die konfigurierten Upsells. |
cateringGuidelines |
Optional. Stellt eine Reihe von Texten dar, die die offline generierten Berechnungen für die Bereitstellung und die Regeln für die Gruppenreihenfolge für dieses Menü darstellen. Vom Konversations-LLM gelesen. |
UpsellConfig
Definiert die Konfiguration für eine Upselling-Instanz.
| JSON-Darstellung |
|---|
{ "displayName": string, "priority": integer, "skipOnMultiQuantityUpsoldFromItem": boolean, "skipOnPreviousTurnUpsell": boolean, "disabled": boolean, // Union field |
| Felder | |
|---|---|
displayName |
Optional. Name für das Upselling. Wird für die UI-Anzeige sowie für die Aggregation und Analyse von Messwerten verwendet. |
priority |
Erforderlich. Zahl, die die Prioritätsreihenfolge der Upsell-Konfiguration im Verhältnis zu allen anderen UpsellConfigs innerhalb einer bestimmten UpsellStrategy darstellt. Bei UpsellConfigs mit höherer Priorität wird der Upsell vor denen mit niedrigerer Priorität versucht.
|
skipOnMultiQuantityUpsoldFromItem |
Optional. Gibt an, ob dieses Upselling übersprungen werden soll, wenn die Menge des Artikels, von dem aus das Upselling erfolgen soll, größer als 1 ist. Diese Konfiguration gilt nur für die relevanten Upsell-Typen: - Artikel zu Kombi - Kombi-Größe - Modifikator-Ergänzung - Kombi-Getränk - Artikel-Größe - Kombi-Variante - Artikel-Auslöser |
skipOnPreviousTurnUpsell |
Optional. Gibt an, ob dieses Upselling übersprungen werden soll, wenn der vorherige Gesprächsbeitrag ein Upselling war. |
disabled |
Optional. Gibt an, ob der Upsell-Typ deaktiviert ist. Wenn „true“, wird kein Upselling versucht. Diese Konfiguration ist nützlich, um einen Upselling-Typ im Rahmen einer Überschreibung der Konfigurationsanwendungsregel zu deaktivieren. |
Union-Feld upsell_type_config. Die typspezifische Konfiguration des Upsells. Für upsell_type_config ist nur einer der folgenden Werte zulässig: |
|
greetingOffer |
Bieten Sie bestimmte Artikel als Teil der Willkommensnachricht des KI-Agenten an. |
closingOffer |
Bieten Sie bestimmte Artikel an, nachdem ein Kunde seine Bestellung abgeschlossen hat. |
celUpsell |
Dynamisch ausgewertete Upselling-Regel basierend auf der Common Expression Language (CEL). |
GreetingOffer
Bieten Sie bestimmte Artikel als Teil der Willkommensnachricht des KI-Agenten an.
| JSON-Darstellung |
|---|
{
"messages": [
{
object ( |
| Felder | |
|---|---|
messages[] |
Erforderlich. Begrüßungs-Upsell-Nachrichten, die verwendet werden sollen. |
OfferMessage
Allgemeine Konfiguration für Begrüßungs- und Abschlussnachrichten.
| JSON-Darstellung |
|---|
{
"displayName": string,
"messageFrequency": number,
"upsoldItems": [
string
],
"messageConfigs": [
{
object ( |
| Felder | |
|---|---|
displayName |
Optional. Name, der für die Anzeige und Analyse verwendet werden soll. |
messageFrequency |
Optional. Anteil der Zeit, in der diese Nachricht verwendet werden soll. Beispiel: Ein „messageFrequency“-Wert von 0,2 bedeutet, dass diese Nachricht in 20 % der Sitzungen verwendet wird. Wenn alle „messageFrequency“-Werte nicht festgelegt sind (0,0), wird jede Nachricht für 1/n der Sitzungen verwendet, wobei n die Anzahl der für den Angebotstyp konfigurierten OfferMessages ist. Wenn nur einige „messageFrequency“-Werte festgelegt sind, werden „OfferMessages“ mit nicht festgelegten „messageFrequency“-Werten nicht verwendet. |
upsoldItems[] |
Optional. Namen der Artikel, die in dieser Nachricht als Upselling-Angebote beworben werden. Legen Sie entweder dieses Feld ODER „upsoldItemIds“ fest, aber nicht beide. |
messageConfigs[] |
Erforderlich. Upselling-Nachrichten für die einzelnen Sprachen. |
upsoldItemIds[] |
Optional. IDs der Artikel, die in dieser Nachricht per Upselling angeboten werden. Legen Sie entweder dieses Feld ODER „upsoldItems“ fest, aber nicht beide. |
MessageConfig
Sprachspezifische Nachricht, die für ein Upselling verwendet werden soll.
| JSON-Darstellung |
|---|
{ "languageCode": string, "messageText": string } |
| Felder | |
|---|---|
languageCode |
Erforderlich. Code der Sprache, die für diese Nachricht verwendet werden soll. BCP-47-Sprachcode, z. B. „en-US“ oder „fr-CA“. |
messageText |
Erforderlich. Sprachspezifischer Nachrichtentext. |
ClosingOffer
Bieten Sie bestimmte Artikel an, nachdem ein Kunde seine Bestellung abgeschlossen hat.
| JSON-Darstellung |
|---|
{
"closingMessages": [
{
object ( |
| Felder | |
|---|---|
closingMessages[] |
Erforderlich. Upselling-Angebote zum Abschluss. |
ClosingMessage
Konfiguration der Upselling-Nachricht wird geschlossen.
| JSON-Darstellung |
|---|
{
"offerMessage": {
object ( |
| Felder | |
|---|---|
offerMessage |
Erforderlich. Konfiguration der Angebotsnachricht. |
skipTerms[] |
Optional. Dieses Upselling-Angebot wird übersprungen, wenn einer dieser Begriffe im Namen eines Artikels enthalten ist, der sich bereits in der Bestellung des Kunden befindet. |
CelUpsell
Stellt eine vorab berechnete Regel dar, die definiert, unter welchen kontextbezogenen Bedingungen eine Reihe von Artikeln dem Nutzer proaktiv als Upselling angeboten werden soll.
| JSON-Darstellung |
|---|
{
"conditionExpression": string,
"suggestedMenuItems": [
string
],
"triggerReason": string,
"priority": integer,
"suggestedModifiers": [
string
],
"suggestedModifierGroups": [
{
object ( |
| Felder | |
|---|---|
conditionExpression |
Erforderlich. Ein CEL-String (Common Expression Language), der anhand des aktuellen Sitzungsstatus ( |
suggestedMenuItems[] |
Erforderlich. Die semantischen Namen der Elemente, die vorgeschlagen werden sollen, wenn diese Regel ausgelöst wird. |
triggerReason |
Optional. Eine Anweisung in natürlicher Sprache, die dem konversationellen LLM erklärt, warum dieses Upselling erfolgt, damit es ein natürliches Upselling formulieren kann. Beispiel: |
priority |
Optional. Der |
suggestedModifiers[] |
Optional. Die semantischen Namen der Modifikatoren, die vorgeschlagen werden sollen, wenn diese Regel ausgelöst wird. |
suggestedModifierGroups[] |
Optional. Die Modifikatorgruppen, die vorgeschlagen werden sollen, wenn diese Regel ausgelöst wird. |
maxModifierPerGroup |
Optional. Maximale Anzahl von Modifikatoren, die pro Gruppe vorgeschlagen werden sollen. |
suggestionOnly |
Optional. Kein echtes Upselling, sondern nur, um dem Nutzer die vorgeschlagenen Optionen anzuzeigen. |
SuggestedModifierGroup
Eine vorgeschlagene Modifikatorgruppe.
| JSON-Darstellung |
|---|
{ "name": string, "suggestedModifiers": [ string ] } |
| Felder | |
|---|---|
name |
Optional. Der semantische Name der Modifikatorgruppe. |
suggestedModifiers[] |
Optional. Die semantischen Namen der Modifikatoren, die innerhalb dieser Gruppe vorgeschlagen werden sollen. |
Greetings
Stellt Begrüßungsnachrichten für eine bestimmte Sprache dar.
| JSON-Darstellung |
|---|
{ "languageCode": string, "greetingPhrases": [ string ] } |
| Felder | |
|---|---|
languageCode |
Optional. Der Sprachcode der Begrüßungsformeln. BCP-47-Sprachcode, z. B. „en-US“ oder „fr-CA“. |
greetingPhrases[] |
Optional. Eine Liste von Begrüßungsformeln in der angegebenen Sprache. |
FeaturesConfig
Konfigurationen für Agentenfunktionen. Liste der Funktions-Flags, die zum Generieren der benutzerdefinierten Anweisungen und Tools des KI-Agenten verwendet werden.
| JSON-Darstellung |
|---|
{ "orderPickup": { object ( |
| Felder | |
|---|---|
orderPickup |
Optional. Konfiguration der Funktion „Abholung von Bestellungen“. |
orderDineIn |
Optional. Konfiguration der Funktion „Im Restaurant essen“. |
nameCollection |
Optional. Konfiguration der Funktion zur Namenserfassung. |
confirmOrderInfoAtStart |
Optional. Gibt an, ob die Bestellinformationen zu Beginn der Sitzung bestätigt werden sollen. Verworfen: Ersetzt durch „confirmOrderInfoOnFinalize“. |
confirmOrderInfoOnFinalize |
Optional. Gibt an, ob die Bestellinformationen beim Abschließen der Bestellung bestätigt werden sollen. |
getOrderPrices |
Optional. Konfiguration der Funktion zum Abrufen von Bestellpreisen. |
endSessionWithCheckoutRequest |
Optional. Sitzung mit der Konfiguration der Funktion für Checkout-Anfragen beenden. |
enableAddressCollection |
Optional. Konfiguration der Funktion zum Erfassen von Lieferadressen aktivieren. |
supportCashPayment |
Optional. Konfiguration der Barzahlungsfunktion unterstützen. |
budgetBasedOrdering |
Optional. Ob die budgetbasierte Sortierung aktiviert werden soll. |
OrderPickup
Dieser Typ hat keine Felder.
Ermöglicht es Kunden, Essen über den Agenten zur Abholung zu bestellen.
OrderDineIn
Dieser Typ hat keine Felder.
Ermöglicht es Kunden, über den Agenten Essen zum Verzehr vor Ort zu bestellen
NameCollection
Dieser Typ hat keine Felder.
Ermöglicht dem KI-Agenten, den Namen des Kunden während der Sitzung zu erfassen.
GetOrderPrices
Dieser Typ hat keine Felder.
Ermöglicht dem KI-Agenten, Bestellpreise vom POS abzurufen.
EndSessionWithCheckoutRequest
Dieser Typ hat keine Felder.
Ermöglicht dem Agenten, die Sitzung mit einer Checkout-Anfrage zu beenden.
EnableAddressCollection
Dieser Typ hat keine Felder.
Ermöglicht dem KI-Agenten, während der Sitzung die Lieferadresse des Kunden zu erfassen.
SupportCashPayment
Dieser Typ hat keine Felder.
Ermöglicht dem Agenten, Barzahlungen zu unterstützen.
InteractionMode
Der Interaktionsmodus des KI-Agenten.
| Enums | |
|---|---|
INTERACTION_MODE_UNSPECIFIED |
Der Interaktionsmodus ist nicht angegeben. |
ORDER_TAKING |
Der KI-Agent führt eine wechselseitige Unterhaltung, um Bestellungen entgegenzunehmen. |
LISTEN_ONLY |
Der KI-Agent hört nur zu und spricht nicht. |
DisambiguationStrategy
Strategiekonfiguration für die Disambiguierungssteuerung.
| JSON-Darstellung |
|---|
{
"mappings": [
{
object ( |
| Felder | |
|---|---|
mappings[] |
Optional. Die konfigurierten Zuordnungen für die Mehrdeutigkeitsauflösung. |
DisambiguationMapping
Eine Zuordnungsregel, um ungültige Begriffe zu korrigieren oder mehrdeutige Elemente zu klären.
| JSON-Darstellung |
|---|
{ "type": enum ( |
| Felder | |
|---|---|
type |
Erforderlich. Der operative Typ der Disambiguierungsregel. |
customerTerms[] |
Erforderlich. Kundenäußerungen oder Shortcut-Strings. Jeder Kundenbegriff ist auf 100 Zeichen beschränkt. |
targets[] |
Erforderlich. Vollständig strukturierte Zielmenüpunkte, die vorgeschlagen oder verdeutlicht werden sollen, einschließlich verschachtelter Modifikatoren. |
customInstruction |
Optional. Optionale benutzerdefinierte bedingte Makroanweisungen oder Formulierungshinweise. |
Typ
Der operative Typ der Disambiguierungsregel.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Nicht angegebener Regeltyp. |
SINGLE_TARGET |
Wird für Zuordnungen mit einem einzelnen Ziel verwendet (Tastenkombinationen, benutzerdefinierte Kombinationen oder gültige Synonyme). |
INVALID_ITEM |
Wird für ungültige Artikel, nicht vorrätige Artikel oder Produkte von Mitbewerbern verwendet. |
DISAMBIGUATION |
Wird für mehrdeutige Eingaben verwendet, die eine Klärung zwischen mehreren gültigen Zieloptionen erfordern. |
TargetItem
Ein alternatives Ziel für ein strukturiertes Element.
| JSON-Darstellung |
|---|
{
"itemName": string,
"modifiers": [
{
object ( |
| Felder | |
|---|---|
itemName |
Erforderlich. Der Name des Artikels im Speisekartenkatalog. |
modifiers[] |
Optional. Strukturierte Modifikatoren, die an dieses Ziel angehängt werden sollen. |
itemId |
Optional. Die eindeutige ID des Artikels im Speisekartenkatalog (direkte Verknüpfung mit menu.proto). |
TargetModifier
Ein strukturierter Modifikator, der auf das Zielelement angewendet werden soll.
| JSON-Darstellung |
|---|
{ "modifierName": string, "modifierGroupName": string, "modifierId": string, "modifierGroupId": string } |
| Felder | |
|---|---|
modifierName |
Erforderlich. Der Name des Modifikators, der direkt mit dem Katalogeintrag übereinstimmt. |
modifierGroupName |
Optional. Optionaler Name der Modifikatorgruppe, um den Modifikator zu binden. |
modifierId |
Optional. Die eindeutige ID des Modifikators im Menükatalog (direkte Verknüpfung mit menu.proto). |
modifierGroupId |
Optional. Die eindeutige ID der Modifikatorgruppe im Speisekartenkatalog. |
Bundesland
Status der Kanalkonfiguration.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Kein Status angegeben. |
DRAFT |
Die Kanalkonfiguration ist ein Entwurf und noch nicht einsatzbereit. |
ACTIVE |
Die Kanalkonfiguration ist aktiv und kann verwendet werden. |
PROMOTED |
Die Kanalkonfiguration wird hochgestuft. |
Typ
Der Typ der Kanalkonfiguration.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Typ ist nicht angegeben. |
UPSELL_STRATEGY |
Die Kanalkonfiguration ist für die Upselling-Strategie vorgesehen. |
AGENT_CUSTOMIZATION |
Die Kanalkonfiguration dient der Anpassung des KI-Agenten. |
SupplementalInstructions
Konfigurationen für zusätzliche Anweisungen.
| JSON-Darstellung |
|---|
{ "freeformInstructions": string } |
| Felder | |
|---|---|
freeformInstructions |
Optional. Anweisungen im freien Format, die im Prompt enthalten sind. |
Ton
Der Tonfall des KI-Agenten.
| Enums | |
|---|---|
TONE_UNSPECIFIED |
Der Ton ist nicht angegeben. |
CONCISE_AND_DIRECT |
Der Tonfall des KI-Agenten ist prägnant und direkt. |
PROFESSIONAL_AND_FORMAL |
Der Ton des KI-Agenten ist professionell und formell. |
FRIENDLY |
Der Ton des KI-Agenten ist freundlich. |
Methoden |
|
|---|---|
|
Erstellt eine ChannelConfig. |
|
Löscht die angegebene ChannelConfig. |
|
Ruft eine ChannelConfig ab. |
|
Listet ChannelConfigs auf. |
|
Aktualisiert die angegebene ChannelConfig. |
|
Stuft die angegebene Kanalkonfiguration hoch. |