MCP Tools Reference: ces.googleapis.com

Tool: update_app

Aktualisiert die angegebene App. Achten Sie darauf, immer eine Aktualisierungsmaske in der Eingabe zu übergeben.

Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool update_app aufrufen.

cURL-Anfrage
curl --location 'https://ces.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "update_app", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }'

Eingabeschema

Anfragenachricht für AgentService.UpdateApp.

UpdateAppRequest

JSON-Darstellung
{ "app": { object (App) }, "updateMask": string }

Felder
app	object (App) Erforderlich. Die zu aktualisierende App.
updateMask	string (FieldMask format) Optional. Mit der Feldmaske wird gesteuert, welche Felder aktualisiert werden. Wenn die Maske nicht vorhanden ist, werden alle Felder aktualisiert. Dies ist eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

App

JSON-Darstellung

{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object (LanguageSettings) }, "timeZoneSettings": { object (TimeZoneSettings) }, "audioProcessingConfig": { object (AudioProcessingConfig) }, "loggingSettings": { object (LoggingSettings) }, "errorHandlingSettings": { object (ErrorHandlingSettings) }, "modelSettings": { object (ModelSettings) }, "toolExecutionMode": enum (ToolExecutionMode), "evaluationMetricsThresholds": { object (EvaluationMetricsThresholds) }, "variableDeclarations": [ { object (VariableDeclaration) } ], "predefinedVariableDeclarations": [ { object (VariableDeclaration) } ], "globalInstruction": string, "guardrails": [ string ], "dataStoreSettings": { object (DataStoreSettings) }, "defaultChannelProfile": { object (ChannelProfile) }, "metadata": { string: string, ... }, "createTime": string, "updateTime": string, "etag": string, "deploymentCount": integer, "clientCertificateSettings": { object (ClientCertificateSettings) }, "vpcScSettings": { object (VpcScSettings) }, "locked": boolean, "validationErrors": [ string ], "dashboardSettings": { object (DashboardSettings) } }

Felder
name	string ID. Die eindeutige Kennung der App. Format: projects/{project}/locations/{location}/apps/{app}
displayName	string Erforderlich. Anzeigename der App.
description	string Optional. Eine menschenlesbare Beschreibung der App.
pinned	boolean Optional. Gibt an, ob die App in der Liste der Apps angepinnt ist.
rootAgent	string Optional. Der Root-Agent ist der Einstiegspunkt der Anwendung. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings	object (LanguageSettings) Optional. Spracheinstellungen der App.
timeZoneSettings	object (TimeZoneSettings) Optional. Zeitzoneneinstellungen der App.
audioProcessingConfig	object (AudioProcessingConfig) Optional. Konfiguration der Audioverarbeitung der App.
loggingSettings	object (LoggingSettings) Optional. Logging-Einstellungen der App.
errorHandlingSettings	object (ErrorHandlingSettings) Optional. Fehlerbehandlungseinstellungen der App.
modelSettings	object (ModelSettings) Optional. Die Standardeinstellungen für das LLM-Modell der Anwendung. Einzelne Ressourcen (z.B. Agenten, Guardrails) können diese Konfigurationen bei Bedarf überschreiben.
toolExecutionMode	enum (ToolExecutionMode) Optional. Der Tool-Ausführungsmodus für die Anwendung. Wenn nicht angegeben, wird standardmäßig PARALLEL verwendet.
evaluationMetricsThresholds	object (EvaluationMetricsThresholds) Optional. Die Bewertungsschwellenwerte für die App.
variableDeclarations[]	object (VariableDeclaration) Optional. Die Deklarationen der Variablen.
predefinedVariableDeclarations[]	object (VariableDeclaration) Nur Ausgabe. Die Deklarationen vordefinierter Variablen für die App.
globalInstruction	string Optional. Anweisungen für alle Agenten in der Anwendung. Mit dieser Anweisung können Sie eine stabile Identität oder Persönlichkeit für alle Agenten einrichten.
guardrails[]	string Optional. Liste der Schutzmaßnahmen für die App. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings	object (DataStoreSettings) Optional. Die Datenspeichereinstellungen für die Anwendung.
defaultChannelProfile	object (ChannelProfile) Optional. Das von der App verwendete Standardkanalprofil.
metadata	map (key: string, value: string) Optional. Metadaten zur App. In diesem Feld können zusätzliche Informationen zu den Details oder Verwendungszwecken der App gespeichert werden. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime	string (Timestamp format) Nur Ausgabe. Zeitstempel für die Erstellung der App. 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime	string (Timestamp format) Nur Ausgabe. Zeitstempel der letzten Aktualisierung der App. 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
etag	string Nur Ausgabe. Etag, mit dem sichergestellt wird, dass sich das Objekt während eines Lesevorgangs mit anschließender Änderung und Schreibvorgang nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
deploymentCount	integer Nur Ausgabe. Anzahl der Deployments in der Anwendung.
clientCertificateSettings	object (ClientCertificateSettings) Optional. Die Standardeinstellungen für Clientzertifikate für die App.
vpcScSettings	object (VpcScSettings) Optional. VPC-SC-Einstellungen für die Anwendung.
locked	boolean Optional. Gibt an, ob die App für Änderungen gesperrt ist. Wenn die App gesperrt ist, werden Änderungen an den App-Ressourcen abgelehnt.
validationErrors[]	string Nur Ausgabe. Fehlkonfigurationen oder Warnungen in der App.
dashboardSettings	object (DashboardSettings) Optional. Anwendungsspezifische Dashboard-Einstellungen zum Verknüpfen und Konfigurieren von Contact Center Insights-Dashboards.

LanguageSettings

JSON-Darstellung
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string }

Felder
defaultLanguageCode	string Optional. Der Standardsprachcode der App.
supportedLanguageCodes[]	string Optional. Liste der von der App unterstützten Sprachcodes, zusätzlich zu default_language_code.
enableMultilingualSupport	boolean Optional. Aktiviert die Unterstützung mehrerer Sprachen. Wenn true, verwenden Agenten in der App vordefinierte Anweisungen, um die Verarbeitung mehrsprachiger Eingaben zu verbessern.
fallbackAction (deprecated)	string Dieses Element wird nicht mehr unterstützt. Optional. Eingestellt: Diese Funktion wird nicht mehr unterstützt. Verwenden Sie stattdessen enable_multilingual_support, um die Verarbeitung mehrsprachiger Eingaben zu verbessern. Die Aktion, die ausgeführt werden soll, wenn ein Agent Eingaben in einer nicht unterstützten Sprache empfängt. Das kann eine vordefinierte Aktion oder ein benutzerdefinierter Toolaufruf sein. Gültige Werte sind: – Der vollständige Ressourcenname eines Tools, der die Ausführung eines bestimmten Tools auslöst. – Eine vordefinierte Systemaktion wie „Eskalieren“ oder „Beenden“, die ein EndSession-Signal mit dem entsprechenden metadata auslöst, um die Unterhaltung zu beenden.

TimeZoneSettings

JSON-Darstellung
{ "timeZone": string }

Felder
timeZone	string Optional. Die Zeitzone der Anwendung aus der Zeitzonendatenbank, z.B. „America/Los_Angeles“ oder „Europe/Paris“.

AudioProcessingConfig

JSON-Darstellung
{ "synthesizeSpeechConfigs": { string: { object (SynthesizeSpeechConfig) }, ... }, "bargeInConfig": { object (BargeInConfig) }, "inactivityTimeout": string, "ambientSoundConfig": { object (AmbientSoundConfig) }, "customVoiceSamples": [ { object (CustomVoiceSample) } ] }

Felder
synthesizeSpeechConfigs	map (key: string, value: object (SynthesizeSpeechConfig)) Optional. Konfiguration der Synthese der KI-Agentenantwort, Zuordnung vom Sprachcode zu SynthesizeSpeechConfig. Wenn die Konfiguration für den angegebenen Sprachcode nicht gefunden wird, wird die Konfiguration für den Stamm-Sprachcode verwendet. Wenn die Zuordnung beispielsweise „en-us“ und „en“ enthält und der angegebene Sprachcode „en-gb“ ist, wird die Konfiguration „en“ verwendet. Hinweis: Beim Sprachcode wird die Groß-/Kleinschreibung nicht berücksichtigt. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig	object (BargeInConfig) Optional. Konfiguriert das Verhalten des KI-Agenten für die Unterbrechungsaktivitäten des Nutzers.
inactivityTimeout	string (Duration format) Optional. Die Dauer der Nutzerinaktivität (keine Sprache oder Interaktion), bevor der Agent den Nutzer auffordert, wieder aktiv zu werden. Wenn nicht festgelegt, fordert der KI-Agent den Nutzer nicht zur erneuten Interaktion auf. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
ambientSoundConfig	object (AmbientSoundConfig) Optional. Konfiguration für den Umgebungsgeräusch, der mit der synthetisierten Antwort des KI-Agenten abgespielt werden soll, um die Natürlichkeit der Unterhaltung zu verbessern.
customVoiceSamples[]	object (CustomVoiceSample) Optional. Konfiguriert benutzerdefinierte Sprachproben für das Klonen von Stimmen.

SynthesizeSpeechConfigsEntry

JSON-Darstellung
{ "key": string, "value": { object (SynthesizeSpeechConfig) } }

Felder
key	string
value	object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

JSON-Darstellung
{ "voice": string, "speakingRate": number, "model": string, "instruction": string }

Felder
voice	string Optional. Die Bezeichnung der Stimme. Wenn kein Wert festgelegt ist, wählt der Dienst eine Stimme anhand der anderen Parameter wie „language_code“ aus. Eine Liste der verfügbaren Stimmen finden Sie unter Unterstützte Stimmen und Sprachen von Cloud Text-to-Speech.
speakingRate	number Optional. Die Sprechgeschwindigkeit im Bereich [0,25, 2,0]. 1,0 ist die natürliche Geschwindigkeit, mit der der betreffende Sprecher normalerweise spricht. 2,0 bedeutet doppelt so schnell, 0,5 halb so schnell. Werte außerhalb des Bereichs [0,25, 2,0] führen zu einem Fehler.
model	string Optional. Das Modell, das zum Synthetisieren von Audio verwendet wird. Derzeit unterstützte Werte: - „gemini-3.1-flash-tts-preview“. Wenn leer, wird Chirp3-HD verwendet.
instruction	string Optional. Die Anweisung, die zum Synthetisieren von Sprache verwendet wird, wenn ein generatives Modell verwendet wird.

BargeInConfig

JSON-Darstellung
{ "disableBargeIn": boolean, "bargeInAwareness": boolean }

Felder
disableBargeIn (deprecated)	boolean Dieses Element wird nicht mehr unterstützt. Optional. Verworfen: disable_barge_in wird zugunsten von disable_barge_in_control in ChannelProfile verworfen. Deaktiviert das Unterbrechen durch den Nutzer, während der Agent spricht. Wenn „true“ festgelegt ist, werden Nutzereingaben während der Wiedergabe der Antwort des KI-Agenten ignoriert.
bargeInAwareness	boolean Optional. Wenn diese Option aktiviert ist, passt der KI-Agent seine nächste Antwort an, wobei er davon ausgeht, dass der Nutzer die vorherige Nachricht des KI-Agenten nicht vollständig gehört hat. Diese Option sollte nicht in Szenarien verwendet werden, in denen die Antworten des Kundenservicemitarbeiters visuell dargestellt werden.

Dauer

JSON-Darstellung
{ "seconds": string, "nanos": integer }

Felder
seconds	string (int64 format) Vorzeichenbehaftete Sekunden der Zeitspanne. Muss zwischen -315.576.000.000 und +315.576.000.000 (einschließlich) liegen. Hinweis: Diese Grenzen werden so berechnet: 60 Sek./Min. * 60 Min./Std. * 24 Std./Tag * 365,25 Tage/Jahr * 10.000 Jahre
nanos	integer Vorzeichenbehaftete Sekundenbruchteile mit Nanosekundenauflösung der Zeitspanne. Dauern von weniger als einer Sekunde werden mit einem seconds-Feld mit dem Wert 0 und einem positiven oder negativen nanos-Feld dargestellt. Bei einer Dauer von einer Sekunde oder mehr muss ein Wert ungleich null für das Feld nanos dasselbe Vorzeichen wie das Feld seconds haben. Muss zwischen -999.999.999 und +999.999.999 liegen.

AmbientSoundConfig

JSON-Darstellung
{ "volumeGainDb": number, // Union field source can be only one of the following: "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise), "gcsUri": string, "prebuiltAmbientSound": string // End of list of possible types for union field source. }

Felder
volumeGainDb	number Optional. Lautstärkeverstärkung (in dB) der normalen nativen Lautstärke, die durch Umgebungsgeräusche unterstützt wird, im Bereich [-96,0, 16,0]. Wenn dieser Wert nicht festgelegt oder ein Wert von 0,0 (dB) eingestellt ist, erfolgt die Wiedergabe mit der natürlichen Signalamplitude. Bei einem Wert von –6,0 (dB) erfolgt die Wiedergabe mit einer Signalamplitude, die etwa halb so hoch wie die natürliche ist. Bei einem Wert von +6.0 (dB) erfolgt die Wiedergabe mit einer Signalamplitude, die etwa doppelt so hoch wie die natürliche ist. Es wird dringend empfohlen, +10 (dB) nicht zu überschreiten, da es bei einem höheren Wert in der Regel zu keiner effektiven Erhöhung der Lautstärke kommt.
Union-Feld source. Umgebungsgeräusche, die mit der synthetisierten Agent-Antwort abgespielt werden sollen, um die Natürlichkeit der Unterhaltung zu verbessern. Für source ist nur einer der folgenden Werte zulässig:
prebuiltAmbientNoise (deprecated)	enum (PrebuiltAmbientNoise) Dieses Element wird nicht mehr unterstützt. Optional. Eingestellt: prebuilt_ambient_noise wurde zugunsten von prebuilt_ambient_sound eingestellt.
gcsUri	string Optional. Umgebungsgeräusche als einkanalige WAV-Datei mit 16 kHz, die in Cloud Storage gespeichert ist. Hinweis: Der CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com muss die Berechtigung storage.objects.get für das Cloud Storage-Objekt haben.
prebuiltAmbientSound	string Optional. Name des vordefinierten Umgebungsgeräuschs. Gültige Werte sind: - „coffee_shop“ - „keyboard“ - „keypad“ - „hum“ - „office_1“ - „office_2“ - „office_3“ - „room_1“ - „room_2“ - „room_3“ - „room_4“ - „room_5“ - „air_conditioner“

CustomVoiceSample

JSON-Darstellung
{ "name": string, "voiceSampleGcsUri": string, "consentAudioGcsUri": string, "voiceInstruction": string, "previewAudioContent": string, "previewText": string, "warnings": [ { object (Warning) } ], "voiceInstructionMode": enum (VoiceInstructionMode) }

Felder
name	string Optional. Der benutzerdefinierte Name für das Custom Voice-Beispiel.
voiceSampleGcsUri	string Optional. Der Cloud Storage-URI des Audiobeispiels für das Klonen von Stimmen. Das Audiobeispiel sollte eine einkanalige WAV-Datei mit 24 kHz sein.
consentAudioGcsUri	string Optional. Audio zur Einwilligung in das Klonen der Stimme.
voiceInstruction	string Optional. Anweisungen in natürlicher Sprache für den Sprachstil, den Ton, das Tempo oder die Aussprache.
previewAudioContent	string (bytes format) Nur Ausgabe. Synthetisiertes Vorschau-Audio für Custom Voice, formatiert als kanonisches WAV (LINEAR16, 24 kHz, 16 Bit, Mono). Ein base64-codierter String.
previewText	string Optional. Text zum Synthetisieren von Vorschauaudio für die benutzerdefinierte Stimme.
warnings[]	object (Warning) Nur Ausgabe. Warnmeldungen, die während der Verarbeitung des geklonten Sprachmodells aufgetreten sind (z.B. niedriger Audiopegel).
voiceInstructionMode	enum (VoiceInstructionMode) Optional. Anweisungsmodus für die Sprachprobe. Wenn nicht angegeben, wird standardmäßig NO_INSTRUCTION verwendet.

Warnung

JSON-Darstellung
{ "message": string, "type": enum (WarningType) }

Felder
message	string Nur Ausgabe. Eine menschenlesbare Beschreibung der Warnung.
type	enum (WarningType) Nur Ausgabe. Der Typ der Warnung.

LoggingSettings

JSON-Darstellung

{ "redactionConfig": { object (RedactionConfig) }, "audioRecordingConfig": { object (AudioRecordingConfig) }, "unredactedAudioRecordingConfig": { object (AudioRecordingConfig) }, "bigqueryExportSettings": { object (BigQueryExportSettings) }, "unredactedBigqueryExportSettings": { object (BigQueryExportSettings) }, "cloudLoggingSettings": { object (CloudLoggingSettings) }, "conversationLoggingSettings": { object (ConversationLoggingSettings) }, "evaluationAudioRecordingConfig": { object (AudioRecordingConfig) }, "metricAnalysisSettings": { object (MetricAnalysisSettings) }, "requiredRecordingConsent": boolean }

Felder
redactionConfig	object (RedactionConfig) Optional. Konfiguration für die Unkenntlichmachung sensibler Daten.
audioRecordingConfig	object (AudioRecordingConfig) Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen. Die Audiodaten werden gemäß der Konfiguration in RedactionConfig entfernt.
unredactedAudioRecordingConfig	object (AudioRecordingConfig) Optional. Konfiguriert eine zusätzliche Aufzeichnung von nicht bearbeiteten Audiodaten. Damit kann eine Kopie der Rohaudiodaten beibehalten werden, wenn die Audioredaktion enabled ist, in der Regel zu Prüf- oder Monitoringzwecken.
bigqueryExportSettings	object (BigQueryExportSettings) Optional. Konfiguriert das BigQuery-Exportverhalten für die Anwendung. Die Unterhaltungsdaten werden gemäß der Konfiguration in RedactionConfig entfernt.
unredactedBigqueryExportSettings	object (BigQueryExportSettings) Optional. Konfiguriert das BigQuery-Exportverhalten für die Anwendung. Wenn diese Option aktiviert ist, werden die nicht bearbeiteten Unterhaltungsdaten in BigQuery-Tabellen exportiert.
cloudLoggingSettings	object (CloudLoggingSettings) Optional. Einstellungen, die das Cloud Logging-Verhalten für die Anwendung beschreiben.
conversationLoggingSettings	object (ConversationLoggingSettings) Optional. Einstellungen, die das Logging-Verhalten für Unterhaltungen der Anwendung beschreiben.
evaluationAudioRecordingConfig	object (AudioRecordingConfig) Optional. Konfiguration, wie Audiointeraktionen für die Bewertung aufgezeichnet werden sollen. Standardmäßig ist die Audioaufzeichnung für Bewertungssitzungen nicht aktiviert.
metricAnalysisSettings	object (MetricAnalysisSettings) Optional. Einstellungen, die das Verhalten bei der Erhebung von Unterhaltungsdaten für die LLM-Analysepipeline der App beschreiben.
requiredRecordingConsent	boolean Optional. Ob die App angeben muss, was aufgezeichnet werden darf, bevor etwas gespeichert wird. Wenn „true“, beginnt eine Sitzung mit deaktivierter Aufzeichnung und bleibt deaktiviert, bis der Client SessionInput.recording_control sendet. Ab diesem Zeitpunkt wird die Aufzeichnung für jede Runde entschieden. Dies umfasst Audioaufnahmen sowie den Unterhaltungsverlauf, den BigQuery-Export und Cloud Logging. Wenn false (Standardeinstellung) festgelegt ist, entscheiden die oben genannten Einstellungen selbst und der Client muss nichts senden.

RedactionConfig

JSON-Darstellung
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string }

Felder
enableRedaction	boolean Optional. Wenn true, wird die Entfernung in verschiedenen Logging-Szenarien angewendet, einschließlich Unterhaltungsverlauf, Cloud Logging und Audioaufzeichnung.
inspectTemplate	string Optional. Name der DLP-Prüfvorlage, um die Erkennung sensibler Datentypen zu konfigurieren. Format: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate	string Optional. Name der DLP-De-Identifikationsvorlage, die angibt, wie Inhalte de-identifiziert werden sollen. Format: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

JSON-Darstellung
{ "gcsBucket": string, "gcsPathPrefix": string }

Felder
gcsBucket	string Optional. Der Cloud Storage-Bucket zum Speichern der Audioaufnahmen der Sitzung. Der URI muss mit „gs://“ beginnen. Wählen Sie einen Bucket-Standort aus, der Ihren Anforderungen an den Datenstandort entspricht. Hinweis: Wenn sich der Cloud Storage-Bucket in einem anderen Projekt als die App befindet, müssen Sie dem CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Berechtigung storage.objects.create erteilen.
gcsPathPrefix	string Optional. Das Cloud Storage-Pfadpräfix für Audioaufnahmen. Dieses Präfix kann die folgenden Platzhalter enthalten, die bei der Bereitstellung dynamisch ersetzt werden: - $project: Projekt-ID - $location: App-Standort - $app: App-ID - $date: Sitzungsdatum im Format JJJJ-MM-TT - $session: Sitzungs-ID Wenn das Pfadpräfix nicht angegeben ist, wird das Standardpräfix $project/$location/$app/$date/$session/ verwendet.

BigQueryExportSettings

JSON-Darstellung
{ "enabled": boolean, "project": string, "dataset": string }

Felder
enabled	boolean Optional. Gibt an, ob der BigQuery-Export aktiviert ist.
project	string Optional. Die Projekt-ID des BigQuery-Datasets, in das die Daten exportiert werden sollen. Hinweis: Wenn sich das BigQuery-Dataset in einem anderen Projekt als die App befindet, sollten Sie dem CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/bigquery.admin zuweisen.
dataset	string Optional. Die BigQuery-Dataset-ID, in die die Daten exportiert werden sollen.

CloudLoggingSettings

JSON-Darstellung
{ "enableCloudLogging": boolean }

Felder
enableCloudLogging	boolean Optional. Gibt an, ob Cloud Logging für die Sitzungen aktiviert werden soll.

ConversationLoggingSettings

JSON-Darstellung
{ "disableConversationLogging": boolean, "retentionWindow": string }

Felder
disableConversationLogging	boolean Optional. Gibt an, ob das Logging von Unterhaltungen für die Sitzungen deaktiviert werden soll.
retentionWindow	string (Duration format) Optional. Steuert die Aufbewahrungsdauer für die Unterhaltung. Wenn nicht festgelegt, wird die Unterhaltung 365 Tage lang aufbewahrt. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

MetricAnalysisSettings

JSON-Darstellung
{ "llmMetricsOptedOut": boolean }

Felder
llmMetricsOptedOut	boolean Optional. Gibt an, ob Unterhaltungsdaten für LLM-Analyse-Messwerte erfasst werden sollen. Wenn „true“, werden keine Unterhaltungsdaten für LLM-Analysemesswerte erhoben. Andernfalls werden Unterhaltungsdaten erhoben.

ErrorHandlingSettings

JSON-Darstellung
{ "errorHandlingStrategy": enum (ErrorHandlingStrategy), "fallbackResponseConfig": { object (FallbackResponseConfig) }, "endSessionConfig": { object (EndSessionConfig) } }

Felder
errorHandlingStrategy	enum (ErrorHandlingStrategy) Optional. Die Strategie, die für die Fehlerbehandlung verwendet werden soll.
fallbackResponseConfig	object (FallbackResponseConfig) Optional. Konfiguration für die Verarbeitung von Fallback-Antworten.
endSessionConfig	object (EndSessionConfig) Optional. Konfiguration zum Beenden der Sitzung bei Systemfehlern (z.B. LLM-Fehlern).

FallbackResponseConfig

JSON-Darstellung
{ "customFallbackMessages": { string: string, ... }, "maxFallbackAttempts": integer }

Felder
customFallbackMessages	map (key: string, value: string) Optional. Die Fallback-Nachrichten bei Systemfehlern (z.B. LLM-Fehlern), zugeordnet nach unterstütztem Sprachcode. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts	integer Optional. Die maximale Anzahl von Fallback-Versuchen, bevor der Agent das Signal EndSession ausgibt.

CustomFallbackMessagesEntry

JSON-Darstellung
{ "key": string, "value": string }

Felder
key	string
value	string

EndSessionConfig

JSON-Darstellung
{ // Union field _escalate_session can be only one of the following: "escalateSession": boolean // End of list of possible types for union field _escalate_session. }

Felder
Union-Feld _escalate_session. Für _escalate_session ist nur einer der folgenden Werte zulässig:
escalateSession	boolean Optional. Gibt an, ob die Sitzung in EndSession eskaliert werden soll. Wenn die Sitzung eskaliert wird, enthält metadata in EndSession den Wert session_escalated = true. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ModelSettings

JSON-Darstellung
{ "model": string, "thinkingLevel": enum (ThinkingLevel), // Union field _temperature can be only one of the following: "temperature": number // End of list of possible types for union field _temperature. }

Felder
model	string Optional. Das LLM-Modell, das der Agent verwenden soll. Wenn nicht festgelegt, übernimmt der Agent das Modell von seinem übergeordneten Agenten.
thinkingLevel	enum (ThinkingLevel) Optional. Der Denkaufwand des Modells.
Union-Feld _temperature. Für _temperature ist nur einer der folgenden Werte zulässig:
temperature	number Optional. Wenn festgelegt, wird diese Temperatur für das LLM-Modell verwendet. Die Temperatur steuert den Grad der Zufälligkeit bei den Antworten des Modells. Niedrigere Temperaturen führen zu vorhersehbareren Antworten. Höhere Temperaturen führen zu kreativeren Antworten.

EvaluationMetricsThresholds

JSON-Darstellung
{ "goldenEvaluationMetricsThresholds": { object (GoldenEvaluationMetricsThresholds) }, "hallucinationMetricBehavior": enum (HallucinationMetricBehavior), "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior), "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior) }

Felder
goldenEvaluationMetricsThresholds	object (GoldenEvaluationMetricsThresholds) Optional. Die Schwellenwerte für die Golden-Bewertungsmesswerte.
hallucinationMetricBehavior (deprecated)	enum (HallucinationMetricBehavior) Dieses Element wird nicht mehr unterstützt. Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen golden_hallucination_metric_behavior. Das Verhalten des Halluzinationsmesswerts wird derzeit für Golden-Evaluierungen verwendet.
goldenHallucinationMetricBehavior	enum (HallucinationMetricBehavior) Optional. Das Verhalten des Halluzinationsmesswerts für Golden-Evaluierungen.
scenarioHallucinationMetricBehavior	enum (HallucinationMetricBehavior) Optional. Das Verhalten des Halluzinationsmesswerts für Szenariobewertungen.

GoldenEvaluationMetricsThresholds

JSON-Darstellung
{ "turnLevelMetricsThresholds": { object (TurnLevelMetricsThresholds) }, "expectationLevelMetricsThresholds": { object (ExpectationLevelMetricsThresholds) }, "toolMatchingSettings": { object (ToolMatchingSettings) } }

Felder
turnLevelMetricsThresholds	object (TurnLevelMetricsThresholds) Optional. Die Schwellenwerte für die Messwerte auf Turn-Ebene.
expectationLevelMetricsThresholds	object (ExpectationLevelMetricsThresholds) Optional. Die Messwertgrenzwerte auf Erwartungsebene.
toolMatchingSettings	object (ToolMatchingSettings) Optional. Die Einstellungen für den Toolabgleich. Ein zusätzlicher Toolaufruf ist ein Toolaufruf, der in der Ausführung vorhanden ist, aber mit keinem Toolaufruf in der Golden Expectation übereinstimmt.

TurnLevelMetricsThresholds

JSON-Darstellung

{ "semanticSimilarityChannel": enum (SemanticSimilarityChannel), // Union field _semantic_similarity_success_threshold can be only one of the // following: "semanticSimilaritySuccessThreshold": integer // End of list of possible types for union field // _semantic_similarity_success_threshold. // Union field _overall_tool_invocation_correctness_threshold can be only one // of the following: "overallToolInvocationCorrectnessThreshold": number // End of list of possible types for union field // _overall_tool_invocation_correctness_threshold. }

Felder
semanticSimilarityChannel	enum (SemanticSimilarityChannel) Optional. Der Kanal für semantische Ähnlichkeit, der für die Bewertung verwendet werden soll.
Union-Feld _semantic_similarity_success_threshold. Für _semantic_similarity_success_threshold ist nur einer der folgenden Werte zulässig:
semanticSimilaritySuccessThreshold	integer Optional. Der Erfolgsschwellenwert für die semantische Ähnlichkeit. Muss eine Ganzzahl zwischen 0 und 4 sein. Der Standardwert ist >= 3.
Union-Feld _overall_tool_invocation_correctness_threshold. Für _overall_tool_invocation_correctness_threshold ist nur einer der folgenden Werte zulässig:
overallToolInvocationCorrectnessThreshold	number Optional. Der Erfolgsschwellenwert für die Gesamtkorrektheit des Toolaufrufs. Muss eine Gleitkommazahl zwischen 0 und 1 sein. Der Standardwert ist 1,0.

ExpectationLevelMetricsThresholds

JSON-Darstellung
{ // Union field _tool_invocation_parameter_correctness_threshold can be only one // of the following: "toolInvocationParameterCorrectnessThreshold": number // End of list of possible types for union field // _tool_invocation_parameter_correctness_threshold. }

Felder
Union-Feld _tool_invocation_parameter_correctness_threshold. Für _tool_invocation_parameter_correctness_threshold ist nur einer der folgenden Werte zulässig:
toolInvocationParameterCorrectnessThreshold	number Optional. Der Erfolgsschwellenwert für die Korrektheit einzelner Parameter für den Toolaufruf. Muss eine Gleitkommazahl zwischen 0 und 1 sein. Der Standardwert ist 1,0.

ToolMatchingSettings

JSON-Darstellung
{ "extraToolCallBehavior": enum (ExtraToolCallBehavior) }

Felder
extraToolCallBehavior	enum (ExtraToolCallBehavior) Optional. Verhalten bei zusätzlichen Toolaufrufen. Die Standardeinstellung ist FAIL.

VariableDeclaration

JSON-Darstellung
{ "name": string, "description": string, "schema": { object (Schema) } }

Felder
name	string Erforderlich. Der Name der Variablen. Der Name muss mit einem Buchstaben oder Unterstrich beginnen und darf nur Buchstaben, Ziffern oder Unterstriche enthalten.
description	string Erforderlich. Die Beschreibung der Variable.
schema	object (Schema) Erforderlich. Das Schema der Variable.

Schema

JSON-Darstellung

{ "type": enum (Type), "properties": { string: { object (Schema) }, ... }, "required": [ string ], "description": string, "items": { object (Schema) }, "nullable": boolean, "uniqueItems": boolean, "prefixItems": [ { object (Schema) } ], "additionalProperties": { object (Schema) }, "anyOf": [ { object (Schema) } ], "enum": [ string ], "default": value, "ref": string, "defs": { string: { object (Schema) }, ... }, "title": string, "minItems": string, "maxItems": string, // Union field _minimum can be only one of the following: "minimum": number // End of list of possible types for union field _minimum. // Union field _maximum can be only one of the following: "maximum": number // End of list of possible types for union field _maximum. }

Felder
type	enum (Type) Erforderlich. Der Typ der Daten.
properties	map (key: string, value: object (Schema)) Optional. Attribute von Type.OBJECT. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]	string Optional. Erforderliche Attribute von Type.OBJECT.
description	string Optional. Die Beschreibung der Daten.
items	object (Schema) Optional. Schema der Elemente von Type.ARRAY.
nullable	boolean Optional. Gibt an, ob der Wert null sein darf.
uniqueItems	boolean Optional. Geben Sie an, dass die Elemente im Array eindeutig sein müssen. Gilt nur für TYPE.ARRAY.
prefixItems[]	object (Schema) Optional. Schemas der ersten Elemente von Type.ARRAY.
additionalProperties	object (Schema) Optional. Kann entweder ein boolescher Wert oder ein Objekt sein und steuert das Vorhandensein zusätzlicher Attribute.
anyOf[]	object (Schema) Optional. Der Wert muss anhand eines oder mehrerer Unterschemas in der Liste validiert werden.
enum[]	string Optional. Mögliche Werte des Elements des primitiven Typs im enum-Format. Beispiele: 1. Wir können die Richtung so definieren : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Wir können die Wohnungsnummer so definieren : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	value (Value format) Optional. Standardwert der Daten.
ref	string Optional. Ermöglicht indirekte Verweise zwischen Schemaknoten. Der Wert sollte ein gültiger Verweis auf ein untergeordnetes Element des Stammverzeichnisses defs sein. Im folgenden Schema wird beispielsweise ein Verweis auf einen Schemaknoten namens „Pet“ definiert: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string Der Wert des Attributs „pet“ ist ein Verweis auf den Schemaknoten mit dem Namen „Pet“. Weitere Informationen finden Sie unter https://json-schema.org/understanding-json-schema/structuring.
defs	map (key: string, value: object (Schema)) Optional. Eine Zuordnung von Definitionen zur Verwendung durch ref. Nur im Stammverzeichnis des Schemas zulässig. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title	string Optional. Der Titel des Schemas.
minItems	string (int64 format) Optional. Mindestanzahl der Elemente für Type.ARRAY.
maxItems	string (int64 format) Optional. Maximale Anzahl der Elemente für Type.ARRAY.
Union-Feld _minimum. Für _minimum ist nur einer der folgenden Werte zulässig:
minimum	number Optional. Mindestwert für Type.INTEGER und Type.NUMBER.
Union-Feld _maximum. Für _maximum ist nur einer der folgenden Werte zulässig:
maximum	number Optional. Höchstwert für Type.INTEGER und Type.NUMBER.

PropertiesEntry

JSON-Darstellung
{ "key": string, "value": { object (Schema) } }

Felder
key	string
value	object (Schema)

Wert

JSON-Darstellung
{ // Union field kind can be only one of the following: "nullValue": null, "numberValue": number, "stringValue": string, "boolValue": boolean, "structValue": { object }, "listValue": array // End of list of possible types for union field kind. }

Felder
Union-Feld kind. Die Art des Werts. Für kind ist nur einer der folgenden Werte zulässig:
nullValue	null Stellt ein JSON-null dar.
numberValue	number Stellt eine JSON-Zahl dar. Darf nicht NaN, Infinity oder -Infinity sein, da diese in JSON nicht unterstützt werden. Außerdem können damit keine großen Int64-Werte dargestellt werden, da das JSON-Format diese im Zahlentyp im Allgemeinen nicht unterstützt.
stringValue	string Stellt einen JSON-String dar.
boolValue	boolean Stellt einen booleschen JSON-Wert dar (true- oder false-Literal in JSON).
structValue	object (Struct format) Stellt ein JSON-Objekt dar.
listValue	array (ListValue format) Stellt ein JSON-Array dar.

Struct

JSON-Darstellung
{ "fields": { string: value, ... } }

Felder
fields	map (key: string, value: value (Value format)) Ungeordnete Zuordnung von dynamisch typisierten Werten. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

JSON-Darstellung
{ "key": string, "value": value }

Felder
key	string
value	value (Value format)

ListValue

JSON-Darstellung
{ "values": [ value ] }

Felder
values[]	value (Value format) Wiederkehrendes Feld mit dynamisch typisierten Werten.

DefsEntry

JSON-Darstellung
{ "key": string, "value": { object (Schema) } }

Felder
key	string
value	object (Schema)

DataStoreSettings

JSON-Darstellung
{ "engines": [ { object (Engine) } ] }

Felder
engines[]	object (Engine) Nur Ausgabe. Die Engines für die Anwendung.

Engine

JSON-Darstellung
{ "name": string, "type": enum (Type) }

Felder
name	string Nur Ausgabe. Der Ressourcenname der Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	enum (Type) Nur Ausgabe. Der Typ der Engine.

ChannelProfile

JSON-Darstellung

{ "profileId": string, "channelType": enum (ChannelType), "personaProperty": { object (PersonaProperty) }, "webWidgetConfig": { object (WebWidgetConfig) }, "whatsappConfig": { object (WhatsAppConfig) }, "instagramConfig": { object (InstagramConfig) }, // Union field _disable_dtmf can be only one of the following: "disableDtmf": boolean // End of list of possible types for union field _disable_dtmf. // Union field _disable_barge_in_control can be only one of the following: "disableBargeInControl": boolean // End of list of possible types for union field _disable_barge_in_control. // Union field _noise_suppression_level can be only one of the following: "noiseSuppressionLevel": string // End of list of possible types for union field _noise_suppression_level. }

Felder
profileId	string Optional. Die eindeutige Kennung des Kanalprofils.
channelType	enum (ChannelType) Optional. Der Typ des Kanalprofils.
personaProperty	object (PersonaProperty) Optional. Das Persona-Attribut des Kanalprofils.
webWidgetConfig	object (WebWidgetConfig) Optional. Die Konfiguration für das Web-Widget.
whatsappConfig	object (WhatsAppConfig) Optional. Spezifische Konfiguration für WhatsApp-Bereitstellungen.
instagramConfig	object (InstagramConfig) Optional. Konfiguration speziell für Instagram-Bereitstellungen.
Union-Feld _disable_dtmf. Für _disable_dtmf ist nur einer der folgenden Werte zulässig:
disableDtmf	boolean Optional. Gibt an, ob DTMF (Dual-Tone Multi-Frequency) deaktiviert werden soll.
Union-Feld _disable_barge_in_control. Für _disable_barge_in_control ist nur einer der folgenden Werte zulässig:
disableBargeInControl	boolean Optional. Gibt an, ob die Unterbrechungssteuerung für Nutzer in der Unterhaltung deaktiviert werden soll. - true: Nutzerunterbrechungen sind deaktiviert, während der KI-Agent spricht. – false: Der KI-Agent behält die automatische Kontrolle darüber, wann der Nutzer unterbrechen kann.
Union-Feld _noise_suppression_level. Für _noise_suppression_level ist nur einer der folgenden Werte zulässig:
noiseSuppressionLevel	string Optional. Die Stufe der Geräuschunterdrückung des Kanalprofils. Mögliche Werte sind „low“, „moderate“, „high“ und „very_high“.

PersonaProperty

JSON-Darstellung
{ "persona": enum (Persona) }

Felder
persona	enum (Persona) Optional. Die Persona des Kanals.

WebWidgetConfig

JSON-Darstellung
{ "modality": enum (Modality), "theme": enum (Theme), "webWidgetTitle": string, "securitySettings": { object (SecuritySettings) } }

Felder
modality	enum (Modality) Optional. Die Modalität des Web-Widgets.
theme	enum (Theme) Optional. Das Design des Web-Widgets.
webWidgetTitle	string Optional. Der Titel des Web-Widgets.
securitySettings	object (SecuritySettings) Optional. Die Sicherheitseinstellungen des Web-Widgets.

SecuritySettings

JSON-Darstellung
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean }

Felder
enablePublicAccess	boolean Optional. Gibt an, ob der öffentliche Zugriff auf das Web-Widget aktiviert ist. Wenn true, ist das Web-Widget öffentlich zugänglich. Wenn false, muss das Web-Widget in Ihr eigenes Authentifizierungs- und Autorisierungssystem integriert werden, um gültige Anmeldedaten für den Zugriff auf den CES-Agenten zurückzugeben.
enableOriginCheck	boolean Optional. Gibt an, ob die Ursprungsprüfung für das Web-Widget aktiviert ist. Wenn true, prüft das Web-Widget den Ursprung der Website, die das Web-Widget lädt, und lässt nur das Laden im selben Ursprung oder in einem der zulässigen Ursprünge zu.
allowedOrigins[]	string Optional. Die Ursprünge, die das Web-Widget hosten dürfen. Ein Ursprung wird durch RFC 6454 definiert. Wenn dieses Feld leer ist, sind alle Ursprünge zulässig. Es sind maximal 100 Ursprünge zulässig. Beispiel: „https://beispiel.de“
enableRecaptcha	boolean Optional. Gibt an, ob die reCAPTCHA-Überprüfung für das Web-Widget aktiviert ist.

WhatsAppConfig

JSON-Darstellung
{ "wabaId": string, "phoneNumberId": string, "phoneNumber": string, "displayName": string, "thumbnailUrl": string, "description": string }

Felder
wabaId	string Erforderlich. Die WhatsApp Business-Konto-ID.
phoneNumberId	string Erforderlich. Die Meta-Telefonnummer-ID.
phoneNumber	string Optional. Die Telefonnummer im E.164-Format.
displayName	string Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite.
thumbnailUrl	string Nur Ausgabe. Die abgerufene URL der Miniaturansicht des Meta-Unternehmensprofils.
description	string Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Unternehmensprofils.

InstagramConfig

JSON-Darstellung
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string }

Felder
instagramAccountId	string Erforderlich. Die Instagram-Konto-ID.
displayName	string Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite.
thumbnailUrl	string Nur Ausgabe. Die abgerufene URL der Miniaturansicht des Meta-Unternehmensprofils.
description	string Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Unternehmensprofils.

MetadataEntry

JSON-Darstellung
{ "key": string, "value": string }

Felder
key	string
value	string

Zeitstempel

JSON-Darstellung
{ "seconds": string, "nanos": integer }

Felder
seconds	string (int64 format) Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss zwischen -62135596800 und 253402300799 (einschließlich) liegen, was 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z entspricht.
nanos	integer Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld ist der Nanosekundenanteil der Dauer, keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 (einschließlich) liegen.

ClientCertificateSettings

JSON-Darstellung
{ "tlsCertificate": string, "privateKey": string, "passphrase": string }

Felder
tlsCertificate	string Erforderlich. Das TLS-Zertifikat im PEM-Format. Dieser String muss die Zeilen für den Anfangs-Header und den End-Footer enthalten.
privateKey	string Erforderlich. Der Name der Secret-Versionsressource des Secret Manager, in der der private Schlüssel im PEM-Format gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Optional. Der Name der Secret-Versionsressource des Secret Manager, in der die Passphrase zum Entschlüsseln des privaten Schlüssels gespeichert ist. Sollte nicht festgelegt werden, wenn der private Schlüssel nicht verschlüsselt ist. Format: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

JSON-Darstellung
{ "allowedOrigins": [ string ] }

Felder

allowedOrigins[]

string Optional. Die zulässigen HTTP(S)-Ursprünge, die OpenAPI-Tools in der Anwendung direkt aufrufen können, wenn VPC Service Controls aktiviert ist. Diese Strings müssen genau mit dem Ursprung übereinstimmen, einschließlich des Ports, falls angegeben. Beispiel: „https://example.com“ oder „https://example.com:443“. Diese Liste gilt noch nicht für Python-Tools, die möglicherweise direkte HTTP-Aufrufe ausführen.

DashboardSettings

JSON-Darstellung
{ "defaultDashboard": string }

Felder
defaultDashboard	string Optional. Der Ressourcenname des Standard-Contact Center Insights-Dashboards, das mit der Anwendung verknüpft ist. Dieses Dashboard wird angezeigt, wenn Nutzer die Monitoring-Ansicht für die Anwendung aufrufen. Format: projects/{project}/locations/{location}/dashboards/{dashboard}

FieldMask

JSON-Darstellung
{ "paths": [ string ] }

Felder
paths[]	string Die Gruppe der Feldmaskenpfade.

PrebuiltAmbientNoise

Vordefinierte Umgebungsgeräusche.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	Nicht angegeben.
RETAIL_STORE	Umgebungsgeräusche eines Einzelhandelsgeschäfts.
CONVENTION_HALL	Umgebungsgeräusche in einer Messehalle.
OUTDOOR	Umgebungsgeräusche einer Straße.

WarningType

Art der Warnung, die während der Verarbeitung der Sprachprobe aufgetreten ist.

Enums
WARNING_TYPE_UNSPECIFIED	Nicht angegebener Warnungstyp.
LOW_AUDIO_LEVEL	Der Audiopegel des Sprachbeispiels ist zu niedrig (z.B. niedrige RMS-Amplitude).

VoiceInstructionMode

Anweisungsmodus für die Sprachprobe.

Enums
VOICE_INSTRUCTION_MODE_UNSPECIFIED	Nicht angegebener Anweisungsmodus. Die Standardeinstellung ist NO_INSTRUCTION.
NO_INSTRUCTION	Es werden keine Sprachanweisungen verwendet.
GENERATE_INSTRUCTION	Die Sprachanweisung wird von der KI automatisch aus dem Audiobeispiel generiert.
CUSTOM_INSTRUCTION	Benutzerdefinierte Sprachanweisung, die vom Nutzer bereitgestellt wird.

ErrorHandlingStrategy

Definiert die Strategie für die Fehlerbehandlung.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED	Nicht angegebene Fehlerbehandlungsstrategie.
NONE	Es ist keine spezielle Verarbeitung aktiviert.
FALLBACK_RESPONSE	Bei Systemfehlern (z.B. LLM-Fehlern) wird dem Nutzer eine Fallback-Nachricht zurückgegeben.
END_SESSION	Bei Systemfehlern (z.B. LLM-Fehlern) wird ein EndSession-Signal ausgegeben.

ThinkingLevel

Konfiguration des Denkaufwands für das Modell.

Enums
THINKING_LEVEL_UNSPECIFIED	Der Denkaufwand ist nicht angegeben.
DEFAULT	Standard-Denkaufwand.
LOW	Niedriger Denkaufwand.
MEDIUM	Mittlerer Denkaufwand.
HIGH	Hoher Denkaufwand.

ToolExecutionMode

Definiert das Verhalten bei der Ausführung von Tools, wenn der KI-Agent mehrere Tools gleichzeitig auswählt.

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED	Nicht angegebener Tool-Ausführungsmodus. Standardeinstellung ist PARALLEL.
PARALLEL	Wenn mehrere Tools ausgewählt werden, werden sie parallel mit demselben ToolContext ausgeführt.
SEQUENTIAL	Wenn mehrere Tools ausgewählt werden, werden sie nacheinander ausgeführt. Das nächste Tool wird erst ausgeführt, wenn das vorherige Tool abgeschlossen ist und den aktualisierten ToolContext des vorherigen Tools sehen kann.

SemanticSimilarityChannel

Kanal für semantische Ähnlichkeit, der verwendet werden soll.

Enums
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	Messwert nicht angegeben. Die Standardeinstellung ist TEXT.
TEXT	Semantische Textähnlichkeit verwenden.
AUDIO	Semantische Ähnlichkeit von Audioinhalten verwenden.

ExtraToolCallBehavior

Definiert das Verhalten, wenn ein zusätzlicher Toolaufruf erkannt wird. Ein zusätzlicher Toolaufruf ist ein Toolaufruf, der in der Ausführung vorhanden ist, aber mit keinem Toolaufruf in der Golden Expectation übereinstimmt.

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Nicht angegebenes Verhalten. Die Standardeinstellung ist FAIL.
FAIL	Die Bewertung schlägt fehl, wenn ein zusätzlicher Toolaufruf erkannt wird.
ALLOW	Lassen Sie den zusätzlichen Toolaufruf zu.

HallucinationMetricBehavior

Das Verhalten des Halluzinationsmesswerts. Unabhängig vom Verhalten wird der Messwert immer berechnet. Der Unterschied besteht darin, dass der Messwert bei Deaktivierung nicht zur Berechnung des Gesamtbewertungsergebnisses verwendet wird.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	Nicht angegebenes Verhalten des Halluzinationsmesswerts.
DISABLED	Halluzinationsmesswert deaktivieren.
ENABLED	Halluzinationsmesswert aktivieren.

Typ

OpenAPI-Datentypen.

Enums
TYPE_UNSPECIFIED	Der Typ ist nicht angegeben.
STRING	String-Typ.
INTEGER	Ganzzahltyp.
NUMBER	Zahlentyp.
BOOLEAN	Boolescher Typ.
OBJECT	Objekttyp.
ARRAY	Array-Typ.

NullValue

Stellt ein JSON-null dar.

NullValue ist ein Sentinel, der ein Enum mit nur einem Wert verwendet, um den Nullwert für die Typunion Value darzustellen.

Ein Feld vom Typ NullValue mit einem anderen Wert als 0 wird als ungültig betrachtet. Die meisten ProtoJSON-Serialisierer geben unabhängig vom Ganzzahlwert einen Value mit einem null_value aus, der als JSON-null festgelegt ist, und runden ihn auf einen 0-Wert.

Enums
NULL_VALUE	Nullwert.

Typ

Der Typ der Engine. Weitere Informationen finden Sie in der Dokumentation unter https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType und https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enums
TYPE_UNSPECIFIED	Nicht angegebener Engine-Typ.
ENGINE_TYPE_SEARCH	Die SOLUTION_TYPE_SEARCH-Engine für die Anwendung. Alle Connector-Datenspeicher, die der Anwendung hinzugefügt werden, werden dieser Engine hinzugefügt.
ENGINE_TYPE_CHAT	Chat-Engine-Typ. Die SOLUTION_TYPE_CHAT-Engine für die Anwendung. Alle der Anwendung hinzugefügten Connector-Datenspeicher werden dieser Engine hinzugefügt.

ChannelType

Der Typ des Kanalprofils.

Enums
UNKNOWN	Unbekannter Kanaltyp.
WEB_UI	Web-UI-Kanal.
API	API-Kanal.
TWILIO	Twilio-Kanal.
GOOGLE_TELEPHONY_PLATFORM	Google Telephony Platform-Kanal.
CONTACT_CENTER_AS_A_SERVICE	Contact Center as a Service (CCaaS)-Kanal.
CONTACT_CENTER_AS_A_SERVICE_CHAT	Contact Center as a Service (CCaaS Chat)-Kanal.
FIVE9	Five9-Kanal.
CONTACT_CENTER_INTEGRATION	Integrationskanal für Contact Center von Drittanbietern.
WHATSAPP	WhatsApp-Kanal.
INSTAGRAM	Instagram-Kanal

Persona

Die Persona des Kanals.

Enums
UNKNOWN	UNKNOWN-Persona.
CONCISE	Der KI-Agent hält die Antworten kurz und prägnant.
CHATTY	Der KI-Agent liefert zusätzlichen Kontext, Erklärungen und Details.

Modalität

Modalität des Web-Widgets.

Enums
MODALITY_UNSPECIFIED	Unbekannte Modalität.
CHAT_AND_VOICE	Das Widget unterstützt sowohl Chat- als auch Spracheingabe.
VOICE_ONLY	Das Widget unterstützt nur die Spracheingabe.
CHAT_ONLY	Das Widget unterstützt nur Chateingaben.
CHAT_VOICE_AND_VIDEO	Das Widget unterstützt Chat-, Sprach- und Videoeingaben.

Design

Design des Web-Widgets.

Enums
THEME_UNSPECIFIED	Unbekanntes Design.
LIGHT	Helles Design
DARK	Dunkles Design

Ausgabeschema

Eine Anwendung dient als übergeordneter Container für eine Gruppe von Agenten, einschließlich des Root-Agenten und seiner Sub-Agenten, sowie der zugehörigen Konfigurationen. Diese Agenten arbeiten zusammen, um bestimmte Ziele im Kontext der App zu erreichen.

App

JSON-Darstellung

{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object (LanguageSettings) }, "timeZoneSettings": { object (TimeZoneSettings) }, "audioProcessingConfig": { object (AudioProcessingConfig) }, "loggingSettings": { object (LoggingSettings) }, "errorHandlingSettings": { object (ErrorHandlingSettings) }, "modelSettings": { object (ModelSettings) }, "toolExecutionMode": enum (ToolExecutionMode), "evaluationMetricsThresholds": { object (EvaluationMetricsThresholds) }, "variableDeclarations": [ { object (VariableDeclaration) } ], "predefinedVariableDeclarations": [ { object (VariableDeclaration) } ], "globalInstruction": string, "guardrails": [ string ], "dataStoreSettings": { object (DataStoreSettings) }, "defaultChannelProfile": { object (ChannelProfile) }, "metadata": { string: string, ... }, "createTime": string, "updateTime": string, "etag": string, "deploymentCount": integer, "clientCertificateSettings": { object (ClientCertificateSettings) }, "vpcScSettings": { object (VpcScSettings) }, "locked": boolean, "validationErrors": [ string ], "dashboardSettings": { object (DashboardSettings) } }

Felder
name	string ID. Die eindeutige Kennung der App. Format: projects/{project}/locations/{location}/apps/{app}
displayName	string Erforderlich. Anzeigename der App.
description	string Optional. Eine menschenlesbare Beschreibung der App.
pinned	boolean Optional. Gibt an, ob die App in der Liste der Apps angepinnt ist.
rootAgent	string Optional. Der Root-Agent ist der Einstiegspunkt der Anwendung. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings	object (LanguageSettings) Optional. Spracheinstellungen der App.
timeZoneSettings	object (TimeZoneSettings) Optional. Zeitzoneneinstellungen der App.
audioProcessingConfig	object (AudioProcessingConfig) Optional. Konfiguration der Audioverarbeitung der App.
loggingSettings	object (LoggingSettings) Optional. Logging-Einstellungen der App.
errorHandlingSettings	object (ErrorHandlingSettings) Optional. Fehlerbehandlungseinstellungen der App.
modelSettings	object (ModelSettings) Optional. Die Standardeinstellungen für das LLM-Modell der Anwendung. Einzelne Ressourcen (z.B. Agenten, Guardrails) können diese Konfigurationen bei Bedarf überschreiben.
toolExecutionMode	enum (ToolExecutionMode) Optional. Der Tool-Ausführungsmodus für die Anwendung. Wenn nicht angegeben, wird standardmäßig PARALLEL verwendet.
evaluationMetricsThresholds	object (EvaluationMetricsThresholds) Optional. Die Bewertungsschwellenwerte für die App.
variableDeclarations[]	object (VariableDeclaration) Optional. Die Deklarationen der Variablen.
predefinedVariableDeclarations[]	object (VariableDeclaration) Nur Ausgabe. Die Deklarationen vordefinierter Variablen für die App.
globalInstruction	string Optional. Anweisungen für alle Agenten in der Anwendung. Mit dieser Anweisung können Sie eine stabile Identität oder Persönlichkeit für alle Agenten einrichten.
guardrails[]	string Optional. Liste der Schutzmaßnahmen für die App. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings	object (DataStoreSettings) Optional. Die Datenspeichereinstellungen für die Anwendung.
defaultChannelProfile	object (ChannelProfile) Optional. Das von der App verwendete Standardkanalprofil.
metadata	map (key: string, value: string) Optional. Metadaten zur App. In diesem Feld können zusätzliche Informationen zu den Details oder Verwendungszwecken der App gespeichert werden. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime	string (Timestamp format) Nur Ausgabe. Zeitstempel für die Erstellung der App. 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime	string (Timestamp format) Nur Ausgabe. Zeitstempel der letzten Aktualisierung der App. 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
etag	string Nur Ausgabe. Etag, mit dem sichergestellt wird, dass sich das Objekt während eines Lesevorgangs mit anschließender Änderung und Schreibvorgang nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
deploymentCount	integer Nur Ausgabe. Anzahl der Deployments in der Anwendung.
clientCertificateSettings	object (ClientCertificateSettings) Optional. Die Standardeinstellungen für Clientzertifikate für die App.
vpcScSettings	object (VpcScSettings) Optional. VPC-SC-Einstellungen für die Anwendung.
locked	boolean Optional. Gibt an, ob die App für Änderungen gesperrt ist. Wenn die App gesperrt ist, werden Änderungen an den App-Ressourcen abgelehnt.
validationErrors[]	string Nur Ausgabe. Fehlkonfigurationen oder Warnungen in der App.
dashboardSettings	object (DashboardSettings) Optional. Anwendungsspezifische Dashboard-Einstellungen zum Verknüpfen und Konfigurieren von Contact Center Insights-Dashboards.

LanguageSettings

JSON-Darstellung
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string }

Felder
defaultLanguageCode	string Optional. Der Standardsprachcode der App.
supportedLanguageCodes[]	string Optional. Liste der von der App unterstützten Sprachcodes, zusätzlich zu default_language_code.
enableMultilingualSupport	boolean Optional. Aktiviert die Unterstützung mehrerer Sprachen. Wenn true, verwenden Agenten in der App vordefinierte Anweisungen, um die Verarbeitung mehrsprachiger Eingaben zu verbessern.
fallbackAction (deprecated)	string Dieses Element wird nicht mehr unterstützt. Optional. Eingestellt: Diese Funktion wird nicht mehr unterstützt. Verwenden Sie stattdessen enable_multilingual_support, um die Verarbeitung mehrsprachiger Eingaben zu verbessern. Die Aktion, die ausgeführt werden soll, wenn ein Agent Eingaben in einer nicht unterstützten Sprache empfängt. Das kann eine vordefinierte Aktion oder ein benutzerdefinierter Toolaufruf sein. Gültige Werte sind: – Der vollständige Ressourcenname eines Tools, der die Ausführung eines bestimmten Tools auslöst. – Eine vordefinierte Systemaktion wie „Eskalieren“ oder „Beenden“, die ein EndSession-Signal mit dem entsprechenden metadata auslöst, um die Unterhaltung zu beenden.

TimeZoneSettings

JSON-Darstellung
{ "timeZone": string }

Felder
timeZone	string Optional. Die Zeitzone der Anwendung aus der Zeitzonendatenbank, z.B. „America/Los_Angeles“ oder „Europe/Paris“.

AudioProcessingConfig

JSON-Darstellung
{ "synthesizeSpeechConfigs": { string: { object (SynthesizeSpeechConfig) }, ... }, "bargeInConfig": { object (BargeInConfig) }, "inactivityTimeout": string, "ambientSoundConfig": { object (AmbientSoundConfig) }, "customVoiceSamples": [ { object (CustomVoiceSample) } ] }

Felder
synthesizeSpeechConfigs	map (key: string, value: object (SynthesizeSpeechConfig)) Optional. Konfiguration der Synthese der KI-Agentenantwort, Zuordnung vom Sprachcode zu SynthesizeSpeechConfig. Wenn die Konfiguration für den angegebenen Sprachcode nicht gefunden wird, wird die Konfiguration für den Stamm-Sprachcode verwendet. Wenn die Zuordnung beispielsweise „en-us“ und „en“ enthält und der angegebene Sprachcode „en-gb“ ist, wird die Konfiguration „en“ verwendet. Hinweis: Beim Sprachcode wird die Groß-/Kleinschreibung nicht berücksichtigt. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig	object (BargeInConfig) Optional. Konfiguriert das Verhalten des KI-Agenten für die Unterbrechungsaktivitäten des Nutzers.
inactivityTimeout	string (Duration format) Optional. Die Dauer der Nutzerinaktivität (keine Sprache oder Interaktion), bevor der Agent den Nutzer auffordert, wieder aktiv zu werden. Wenn nicht festgelegt, fordert der KI-Agent den Nutzer nicht zur erneuten Interaktion auf. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
ambientSoundConfig	object (AmbientSoundConfig) Optional. Konfiguration für den Umgebungsgeräusch, der mit der synthetisierten Antwort des KI-Agenten abgespielt werden soll, um die Natürlichkeit der Unterhaltung zu verbessern.
customVoiceSamples[]	object (CustomVoiceSample) Optional. Konfiguriert benutzerdefinierte Sprachproben für das Klonen von Stimmen.

SynthesizeSpeechConfigsEntry

JSON-Darstellung
{ "key": string, "value": { object (SynthesizeSpeechConfig) } }

Felder
key	string
value	object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

JSON-Darstellung
{ "voice": string, "speakingRate": number, "model": string, "instruction": string }

Felder
voice	string Optional. Die Bezeichnung der Stimme. Wenn kein Wert festgelegt ist, wählt der Dienst eine Stimme anhand der anderen Parameter wie „language_code“ aus. Eine Liste der verfügbaren Stimmen finden Sie unter Unterstützte Stimmen und Sprachen von Cloud Text-to-Speech.
speakingRate	number Optional. Die Sprechgeschwindigkeit im Bereich [0,25, 2,0]. 1,0 ist die natürliche Geschwindigkeit, mit der der betreffende Sprecher normalerweise spricht. 2,0 bedeutet doppelt so schnell, 0,5 halb so schnell. Werte außerhalb des Bereichs [0,25, 2,0] führen zu einem Fehler.
model	string Optional. Das Modell, das zum Synthetisieren von Audio verwendet wird. Derzeit unterstützte Werte: - „gemini-3.1-flash-tts-preview“. Wenn leer, wird Chirp3-HD verwendet.
instruction	string Optional. Die Anweisung, die zum Synthetisieren von Sprache verwendet wird, wenn ein generatives Modell verwendet wird.

BargeInConfig

JSON-Darstellung
{ "disableBargeIn": boolean, "bargeInAwareness": boolean }

Felder
disableBargeIn (deprecated)	boolean Dieses Element wird nicht mehr unterstützt. Optional. Verworfen: disable_barge_in wird zugunsten von disable_barge_in_control in ChannelProfile verworfen. Deaktiviert das Unterbrechen durch den Nutzer, während der Agent spricht. Wenn „true“ festgelegt ist, werden Nutzereingaben während der Wiedergabe der Antwort des KI-Agenten ignoriert.
bargeInAwareness	boolean Optional. Wenn diese Option aktiviert ist, passt der KI-Agent seine nächste Antwort an, wobei er davon ausgeht, dass der Nutzer die vorherige Nachricht des KI-Agenten nicht vollständig gehört hat. Diese Option sollte nicht in Szenarien verwendet werden, in denen die Antworten des Kundenservicemitarbeiters visuell dargestellt werden.

Dauer

JSON-Darstellung
{ "seconds": string, "nanos": integer }

Felder
seconds	string (int64 format) Vorzeichenbehaftete Sekunden der Zeitspanne. Muss zwischen -315.576.000.000 und +315.576.000.000 (einschließlich) liegen. Hinweis: Diese Grenzen werden so berechnet: 60 Sek./Min. * 60 Min./Std. * 24 Std./Tag * 365,25 Tage/Jahr * 10.000 Jahre
nanos	integer Vorzeichenbehaftete Sekundenbruchteile mit Nanosekundenauflösung der Zeitspanne. Dauern von weniger als einer Sekunde werden mit einem seconds-Feld mit dem Wert 0 und einem positiven oder negativen nanos-Feld dargestellt. Bei einer Dauer von einer Sekunde oder mehr muss ein Wert ungleich null für das Feld nanos dasselbe Vorzeichen wie das Feld seconds haben. Muss zwischen -999.999.999 und +999.999.999 liegen.

AmbientSoundConfig

JSON-Darstellung
{ "volumeGainDb": number, // Union field source can be only one of the following: "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise), "gcsUri": string, "prebuiltAmbientSound": string // End of list of possible types for union field source. }

Felder
volumeGainDb	number Optional. Lautstärkeverstärkung (in dB) der normalen nativen Lautstärke, die durch Umgebungsgeräusche unterstützt wird, im Bereich [-96,0, 16,0]. Wenn dieser Wert nicht festgelegt oder ein Wert von 0,0 (dB) eingestellt ist, erfolgt die Wiedergabe mit der natürlichen Signalamplitude. Bei einem Wert von –6,0 (dB) erfolgt die Wiedergabe mit einer Signalamplitude, die etwa halb so hoch wie die natürliche ist. Bei einem Wert von +6.0 (dB) erfolgt die Wiedergabe mit einer Signalamplitude, die etwa doppelt so hoch wie die natürliche ist. Es wird dringend empfohlen, +10 (dB) nicht zu überschreiten, da es bei einem höheren Wert in der Regel zu keiner effektiven Erhöhung der Lautstärke kommt.
Union-Feld source. Umgebungsgeräusche, die mit der synthetisierten Agent-Antwort abgespielt werden sollen, um die Natürlichkeit der Unterhaltung zu verbessern. Für source ist nur einer der folgenden Werte zulässig:
prebuiltAmbientNoise (deprecated)	enum (PrebuiltAmbientNoise) Dieses Element wird nicht mehr unterstützt. Optional. Eingestellt: prebuilt_ambient_noise wurde zugunsten von prebuilt_ambient_sound eingestellt.
gcsUri	string Optional. Umgebungsgeräusche als einkanalige WAV-Datei mit 16 kHz, die in Cloud Storage gespeichert ist. Hinweis: Der CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com muss die Berechtigung storage.objects.get für das Cloud Storage-Objekt haben.
prebuiltAmbientSound	string Optional. Name des vordefinierten Umgebungsgeräuschs. Gültige Werte sind: - „coffee_shop“ - „keyboard“ - „keypad“ - „hum“ - „office_1“ - „office_2“ - „office_3“ - „room_1“ - „room_2“ - „room_3“ - „room_4“ - „room_5“ - „air_conditioner“

CustomVoiceSample

JSON-Darstellung
{ "name": string, "voiceSampleGcsUri": string, "consentAudioGcsUri": string, "voiceInstruction": string, "previewAudioContent": string, "previewText": string, "warnings": [ { object (Warning) } ], "voiceInstructionMode": enum (VoiceInstructionMode) }

Felder
name	string Optional. Der benutzerdefinierte Name für das Custom Voice-Beispiel.
voiceSampleGcsUri	string Optional. Der Cloud Storage-URI des Audiobeispiels für das Klonen von Stimmen. Das Audiobeispiel sollte eine einkanalige WAV-Datei mit 24 kHz sein.
consentAudioGcsUri	string Optional. Audio zur Einwilligung in das Klonen der Stimme.
voiceInstruction	string Optional. Anweisungen in natürlicher Sprache für den Sprachstil, den Ton, das Tempo oder die Aussprache.
previewAudioContent	string (bytes format) Nur Ausgabe. Synthetisiertes Vorschau-Audio für Custom Voice, formatiert als kanonisches WAV (LINEAR16, 24 kHz, 16 Bit, Mono). Ein base64-codierter String.
previewText	string Optional. Text zum Synthetisieren von Vorschauaudio für die benutzerdefinierte Stimme.
warnings[]	object (Warning) Nur Ausgabe. Warnmeldungen, die während der Verarbeitung des geklonten Sprachmodells aufgetreten sind (z.B. niedriger Audiopegel).
voiceInstructionMode	enum (VoiceInstructionMode) Optional. Anweisungsmodus für die Sprachprobe. Wenn nicht angegeben, wird standardmäßig NO_INSTRUCTION verwendet.

Warnung

JSON-Darstellung
{ "message": string, "type": enum (WarningType) }

Felder
message	string Nur Ausgabe. Eine menschenlesbare Beschreibung der Warnung.
type	enum (WarningType) Nur Ausgabe. Der Typ der Warnung.

LoggingSettings

JSON-Darstellung

{ "redactionConfig": { object (RedactionConfig) }, "audioRecordingConfig": { object (AudioRecordingConfig) }, "unredactedAudioRecordingConfig": { object (AudioRecordingConfig) }, "bigqueryExportSettings": { object (BigQueryExportSettings) }, "unredactedBigqueryExportSettings": { object (BigQueryExportSettings) }, "cloudLoggingSettings": { object (CloudLoggingSettings) }, "conversationLoggingSettings": { object (ConversationLoggingSettings) }, "evaluationAudioRecordingConfig": { object (AudioRecordingConfig) }, "metricAnalysisSettings": { object (MetricAnalysisSettings) }, "requiredRecordingConsent": boolean }

Felder
redactionConfig	object (RedactionConfig) Optional. Konfiguration für die Unkenntlichmachung sensibler Daten.
audioRecordingConfig	object (AudioRecordingConfig) Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen. Die Audiodaten werden gemäß der Konfiguration in RedactionConfig entfernt.
unredactedAudioRecordingConfig	object (AudioRecordingConfig) Optional. Konfiguriert eine zusätzliche Aufzeichnung von nicht bearbeiteten Audiodaten. Damit kann eine Kopie der Rohaudiodaten beibehalten werden, wenn die Audioredaktion enabled ist, in der Regel zu Prüf- oder Monitoringzwecken.
bigqueryExportSettings	object (BigQueryExportSettings) Optional. Konfiguriert das BigQuery-Exportverhalten für die Anwendung. Die Unterhaltungsdaten werden gemäß der Konfiguration in RedactionConfig entfernt.
unredactedBigqueryExportSettings	object (BigQueryExportSettings) Optional. Konfiguriert das BigQuery-Exportverhalten für die Anwendung. Wenn diese Option aktiviert ist, werden die nicht bearbeiteten Unterhaltungsdaten in BigQuery-Tabellen exportiert.
cloudLoggingSettings	object (CloudLoggingSettings) Optional. Einstellungen, die das Cloud Logging-Verhalten für die Anwendung beschreiben.
conversationLoggingSettings	object (ConversationLoggingSettings) Optional. Einstellungen, die das Logging-Verhalten für Unterhaltungen der Anwendung beschreiben.
evaluationAudioRecordingConfig	object (AudioRecordingConfig) Optional. Konfiguration, wie Audiointeraktionen für die Bewertung aufgezeichnet werden sollen. Standardmäßig ist die Audioaufzeichnung für Bewertungssitzungen nicht aktiviert.
metricAnalysisSettings	object (MetricAnalysisSettings) Optional. Einstellungen, die das Verhalten bei der Erhebung von Unterhaltungsdaten für die LLM-Analysepipeline der App beschreiben.
requiredRecordingConsent	boolean Optional. Ob die App angeben muss, was aufgezeichnet werden darf, bevor etwas gespeichert wird. Wenn „true“, beginnt eine Sitzung mit deaktivierter Aufzeichnung und bleibt deaktiviert, bis der Client SessionInput.recording_control sendet. Ab diesem Zeitpunkt wird die Aufzeichnung für jede Runde entschieden. Dies umfasst Audioaufnahmen sowie den Unterhaltungsverlauf, den BigQuery-Export und Cloud Logging. Wenn false (Standardeinstellung) festgelegt ist, entscheiden die oben genannten Einstellungen selbst und der Client muss nichts senden.

RedactionConfig

JSON-Darstellung
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string }

Felder
enableRedaction	boolean Optional. Wenn true, wird die Entfernung in verschiedenen Logging-Szenarien angewendet, einschließlich Unterhaltungsverlauf, Cloud Logging und Audioaufzeichnung.
inspectTemplate	string Optional. Name der DLP-Prüfvorlage, um die Erkennung sensibler Datentypen zu konfigurieren. Format: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate	string Optional. Name der DLP-De-Identifikationsvorlage, die angibt, wie Inhalte de-identifiziert werden sollen. Format: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

JSON-Darstellung
{ "gcsBucket": string, "gcsPathPrefix": string }

Felder
gcsBucket	string Optional. Der Cloud Storage-Bucket zum Speichern der Audioaufnahmen der Sitzung. Der URI muss mit „gs://“ beginnen. Wählen Sie einen Bucket-Standort aus, der Ihren Anforderungen an den Datenstandort entspricht. Hinweis: Wenn sich der Cloud Storage-Bucket in einem anderen Projekt als die App befindet, müssen Sie dem CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Berechtigung storage.objects.create erteilen.
gcsPathPrefix	string Optional. Das Cloud Storage-Pfadpräfix für Audioaufnahmen. Dieses Präfix kann die folgenden Platzhalter enthalten, die bei der Bereitstellung dynamisch ersetzt werden: - $project: Projekt-ID - $location: App-Standort - $app: App-ID - $date: Sitzungsdatum im Format JJJJ-MM-TT - $session: Sitzungs-ID Wenn das Pfadpräfix nicht angegeben ist, wird das Standardpräfix $project/$location/$app/$date/$session/ verwendet.

BigQueryExportSettings

JSON-Darstellung
{ "enabled": boolean, "project": string, "dataset": string }

Felder
enabled	boolean Optional. Gibt an, ob der BigQuery-Export aktiviert ist.
project	string Optional. Die Projekt-ID des BigQuery-Datasets, in das die Daten exportiert werden sollen. Hinweis: Wenn sich das BigQuery-Dataset in einem anderen Projekt als die App befindet, sollten Sie dem CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/bigquery.admin zuweisen.
dataset	string Optional. Die BigQuery-Dataset-ID, in die die Daten exportiert werden sollen.

CloudLoggingSettings

JSON-Darstellung
{ "enableCloudLogging": boolean }

Felder
enableCloudLogging	boolean Optional. Gibt an, ob Cloud Logging für die Sitzungen aktiviert werden soll.

ConversationLoggingSettings

JSON-Darstellung
{ "disableConversationLogging": boolean, "retentionWindow": string }

Felder
disableConversationLogging	boolean Optional. Gibt an, ob das Logging von Unterhaltungen für die Sitzungen deaktiviert werden soll.
retentionWindow	string (Duration format) Optional. Steuert die Aufbewahrungsdauer für die Unterhaltung. Wenn nicht festgelegt, wird die Unterhaltung 365 Tage lang aufbewahrt. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

MetricAnalysisSettings

JSON-Darstellung
{ "llmMetricsOptedOut": boolean }

Felder
llmMetricsOptedOut	boolean Optional. Gibt an, ob Unterhaltungsdaten für LLM-Analyse-Messwerte erfasst werden sollen. Wenn „true“, werden keine Unterhaltungsdaten für LLM-Analysemesswerte erhoben. Andernfalls werden Unterhaltungsdaten erhoben.

ErrorHandlingSettings

JSON-Darstellung
{ "errorHandlingStrategy": enum (ErrorHandlingStrategy), "fallbackResponseConfig": { object (FallbackResponseConfig) }, "endSessionConfig": { object (EndSessionConfig) } }

Felder
errorHandlingStrategy	enum (ErrorHandlingStrategy) Optional. Die Strategie, die für die Fehlerbehandlung verwendet werden soll.
fallbackResponseConfig	object (FallbackResponseConfig) Optional. Konfiguration für die Verarbeitung von Fallback-Antworten.
endSessionConfig	object (EndSessionConfig) Optional. Konfiguration zum Beenden der Sitzung bei Systemfehlern (z.B. LLM-Fehlern).

FallbackResponseConfig

JSON-Darstellung
{ "customFallbackMessages": { string: string, ... }, "maxFallbackAttempts": integer }

Felder
customFallbackMessages	map (key: string, value: string) Optional. Die Fallback-Nachrichten bei Systemfehlern (z.B. LLM-Fehlern), zugeordnet nach unterstütztem Sprachcode. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts	integer Optional. Die maximale Anzahl von Fallback-Versuchen, bevor der Agent das Signal EndSession ausgibt.

CustomFallbackMessagesEntry

JSON-Darstellung
{ "key": string, "value": string }

Felder
key	string
value	string

EndSessionConfig

JSON-Darstellung
{ // Union field _escalate_session can be only one of the following: "escalateSession": boolean // End of list of possible types for union field _escalate_session. }

Felder
Union-Feld _escalate_session. Für _escalate_session ist nur einer der folgenden Werte zulässig:
escalateSession	boolean Optional. Gibt an, ob die Sitzung in EndSession eskaliert werden soll. Wenn die Sitzung eskaliert wird, enthält metadata in EndSession den Wert session_escalated = true. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ModelSettings

JSON-Darstellung
{ "model": string, "thinkingLevel": enum (ThinkingLevel), // Union field _temperature can be only one of the following: "temperature": number // End of list of possible types for union field _temperature. }

Felder
model	string Optional. Das LLM-Modell, das der Agent verwenden soll. Wenn nicht festgelegt, übernimmt der Agent das Modell von seinem übergeordneten Agenten.
thinkingLevel	enum (ThinkingLevel) Optional. Der Denkaufwand des Modells.
Union-Feld _temperature. Für _temperature ist nur einer der folgenden Werte zulässig:
temperature	number Optional. Wenn festgelegt, wird diese Temperatur für das LLM-Modell verwendet. Die Temperatur steuert den Grad der Zufälligkeit bei den Antworten des Modells. Niedrigere Temperaturen führen zu vorhersehbareren Antworten. Höhere Temperaturen führen zu kreativeren Antworten.

EvaluationMetricsThresholds

JSON-Darstellung
{ "goldenEvaluationMetricsThresholds": { object (GoldenEvaluationMetricsThresholds) }, "hallucinationMetricBehavior": enum (HallucinationMetricBehavior), "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior), "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior) }

Felder
goldenEvaluationMetricsThresholds	object (GoldenEvaluationMetricsThresholds) Optional. Die Schwellenwerte für die Golden-Bewertungsmesswerte.
hallucinationMetricBehavior (deprecated)	enum (HallucinationMetricBehavior) Dieses Element wird nicht mehr unterstützt. Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen golden_hallucination_metric_behavior. Das Verhalten des Halluzinationsmesswerts wird derzeit für Golden-Evaluierungen verwendet.
goldenHallucinationMetricBehavior	enum (HallucinationMetricBehavior) Optional. Das Verhalten des Halluzinationsmesswerts für Golden-Evaluierungen.
scenarioHallucinationMetricBehavior	enum (HallucinationMetricBehavior) Optional. Das Verhalten des Halluzinationsmesswerts für Szenariobewertungen.

GoldenEvaluationMetricsThresholds

JSON-Darstellung
{ "turnLevelMetricsThresholds": { object (TurnLevelMetricsThresholds) }, "expectationLevelMetricsThresholds": { object (ExpectationLevelMetricsThresholds) }, "toolMatchingSettings": { object (ToolMatchingSettings) } }

Felder
turnLevelMetricsThresholds	object (TurnLevelMetricsThresholds) Optional. Die Schwellenwerte für die Messwerte auf Turn-Ebene.
expectationLevelMetricsThresholds	object (ExpectationLevelMetricsThresholds) Optional. Die Messwertgrenzwerte auf Erwartungsebene.
toolMatchingSettings	object (ToolMatchingSettings) Optional. Die Einstellungen für den Toolabgleich. Ein zusätzlicher Toolaufruf ist ein Toolaufruf, der in der Ausführung vorhanden ist, aber mit keinem Toolaufruf in der Golden Expectation übereinstimmt.

TurnLevelMetricsThresholds

JSON-Darstellung

{ "semanticSimilarityChannel": enum (SemanticSimilarityChannel), // Union field _semantic_similarity_success_threshold can be only one of the // following: "semanticSimilaritySuccessThreshold": integer // End of list of possible types for union field // _semantic_similarity_success_threshold. // Union field _overall_tool_invocation_correctness_threshold can be only one // of the following: "overallToolInvocationCorrectnessThreshold": number // End of list of possible types for union field // _overall_tool_invocation_correctness_threshold. }

Felder
semanticSimilarityChannel	enum (SemanticSimilarityChannel) Optional. Der Kanal für semantische Ähnlichkeit, der für die Bewertung verwendet werden soll.
Union-Feld _semantic_similarity_success_threshold. Für _semantic_similarity_success_threshold ist nur einer der folgenden Werte zulässig:
semanticSimilaritySuccessThreshold	integer Optional. Der Erfolgsschwellenwert für die semantische Ähnlichkeit. Muss eine Ganzzahl zwischen 0 und 4 sein. Der Standardwert ist >= 3.
Union-Feld _overall_tool_invocation_correctness_threshold. Für _overall_tool_invocation_correctness_threshold ist nur einer der folgenden Werte zulässig:
overallToolInvocationCorrectnessThreshold	number Optional. Der Erfolgsschwellenwert für die Gesamtkorrektheit des Toolaufrufs. Muss eine Gleitkommazahl zwischen 0 und 1 sein. Der Standardwert ist 1,0.

ExpectationLevelMetricsThresholds

JSON-Darstellung
{ // Union field _tool_invocation_parameter_correctness_threshold can be only one // of the following: "toolInvocationParameterCorrectnessThreshold": number // End of list of possible types for union field // _tool_invocation_parameter_correctness_threshold. }

Felder
Union-Feld _tool_invocation_parameter_correctness_threshold. Für _tool_invocation_parameter_correctness_threshold ist nur einer der folgenden Werte zulässig:
toolInvocationParameterCorrectnessThreshold	number Optional. Der Erfolgsschwellenwert für die Korrektheit einzelner Parameter für den Toolaufruf. Muss eine Gleitkommazahl zwischen 0 und 1 sein. Der Standardwert ist 1,0.

ToolMatchingSettings

JSON-Darstellung
{ "extraToolCallBehavior": enum (ExtraToolCallBehavior) }

Felder
extraToolCallBehavior	enum (ExtraToolCallBehavior) Optional. Verhalten bei zusätzlichen Toolaufrufen. Die Standardeinstellung ist FAIL.

VariableDeclaration

JSON-Darstellung
{ "name": string, "description": string, "schema": { object (Schema) } }

Felder
name	string Erforderlich. Der Name der Variablen. Der Name muss mit einem Buchstaben oder Unterstrich beginnen und darf nur Buchstaben, Ziffern oder Unterstriche enthalten.
description	string Erforderlich. Die Beschreibung der Variable.
schema	object (Schema) Erforderlich. Das Schema der Variable.

Schema

JSON-Darstellung

{ "type": enum (Type), "properties": { string: { object (Schema) }, ... }, "required": [ string ], "description": string, "items": { object (Schema) }, "nullable": boolean, "uniqueItems": boolean, "prefixItems": [ { object (Schema) } ], "additionalProperties": { object (Schema) }, "anyOf": [ { object (Schema) } ], "enum": [ string ], "default": value, "ref": string, "defs": { string: { object (Schema) }, ... }, "title": string, "minItems": string, "maxItems": string, // Union field _minimum can be only one of the following: "minimum": number // End of list of possible types for union field _minimum. // Union field _maximum can be only one of the following: "maximum": number // End of list of possible types for union field _maximum. }

Felder
type	enum (Type) Erforderlich. Der Typ der Daten.
properties	map (key: string, value: object (Schema)) Optional. Attribute von Type.OBJECT. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]	string Optional. Erforderliche Attribute von Type.OBJECT.
description	string Optional. Die Beschreibung der Daten.
items	object (Schema) Optional. Schema der Elemente von Type.ARRAY.
nullable	boolean Optional. Gibt an, ob der Wert null sein darf.
uniqueItems	boolean Optional. Geben Sie an, dass die Elemente im Array eindeutig sein müssen. Gilt nur für TYPE.ARRAY.
prefixItems[]	object (Schema) Optional. Schemas der ersten Elemente von Type.ARRAY.
additionalProperties	object (Schema) Optional. Kann entweder ein boolescher Wert oder ein Objekt sein und steuert das Vorhandensein zusätzlicher Attribute.
anyOf[]	object (Schema) Optional. Der Wert muss anhand eines oder mehrerer Unterschemas in der Liste validiert werden.
enum[]	string Optional. Mögliche Werte des Elements des primitiven Typs im enum-Format. Beispiele: 1. Wir können die Richtung so definieren : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Wir können die Wohnungsnummer so definieren : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	value (Value format) Optional. Standardwert der Daten.
ref	string Optional. Ermöglicht indirekte Verweise zwischen Schemaknoten. Der Wert sollte ein gültiger Verweis auf ein untergeordnetes Element des Stammverzeichnisses defs sein. Im folgenden Schema wird beispielsweise ein Verweis auf einen Schemaknoten namens „Pet“ definiert: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string Der Wert des Attributs „pet“ ist ein Verweis auf den Schemaknoten mit dem Namen „Pet“. Weitere Informationen finden Sie unter https://json-schema.org/understanding-json-schema/structuring.
defs	map (key: string, value: object (Schema)) Optional. Eine Zuordnung von Definitionen zur Verwendung durch ref. Nur im Stammverzeichnis des Schemas zulässig. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title	string Optional. Der Titel des Schemas.
minItems	string (int64 format) Optional. Mindestanzahl der Elemente für Type.ARRAY.
maxItems	string (int64 format) Optional. Maximale Anzahl der Elemente für Type.ARRAY.
Union-Feld _minimum. Für _minimum ist nur einer der folgenden Werte zulässig:
minimum	number Optional. Mindestwert für Type.INTEGER und Type.NUMBER.
Union-Feld _maximum. Für _maximum ist nur einer der folgenden Werte zulässig:
maximum	number Optional. Höchstwert für Type.INTEGER und Type.NUMBER.

PropertiesEntry

JSON-Darstellung
{ "key": string, "value": { object (Schema) } }

Felder
key	string
value	object (Schema)

Wert

JSON-Darstellung
{ // Union field kind can be only one of the following: "nullValue": null, "numberValue": number, "stringValue": string, "boolValue": boolean, "structValue": { object }, "listValue": array // End of list of possible types for union field kind. }

Felder
Union-Feld kind. Die Art des Werts. Für kind ist nur einer der folgenden Werte zulässig:
nullValue	null Stellt ein JSON-null dar.
numberValue	number Stellt eine JSON-Zahl dar. Darf nicht NaN, Infinity oder -Infinity sein, da diese in JSON nicht unterstützt werden. Außerdem können damit keine großen Int64-Werte dargestellt werden, da das JSON-Format diese im Zahlentyp im Allgemeinen nicht unterstützt.
stringValue	string Stellt einen JSON-String dar.
boolValue	boolean Stellt einen booleschen JSON-Wert dar (true- oder false-Literal in JSON).
structValue	object (Struct format) Stellt ein JSON-Objekt dar.
listValue	array (ListValue format) Stellt ein JSON-Array dar.

Struct

JSON-Darstellung
{ "fields": { string: value, ... } }

Felder
fields	map (key: string, value: value (Value format)) Ungeordnete Zuordnung von dynamisch typisierten Werten. Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

JSON-Darstellung
{ "key": string, "value": value }

Felder
key	string
value	value (Value format)

ListValue

JSON-Darstellung
{ "values": [ value ] }

Felder
values[]	value (Value format) Wiederkehrendes Feld mit dynamisch typisierten Werten.

DefsEntry

JSON-Darstellung
{ "key": string, "value": { object (Schema) } }

Felder
key	string
value	object (Schema)

DataStoreSettings

JSON-Darstellung
{ "engines": [ { object (Engine) } ] }

Felder
engines[]	object (Engine) Nur Ausgabe. Die Engines für die Anwendung.

Engine

JSON-Darstellung
{ "name": string, "type": enum (Type) }

Felder
name	string Nur Ausgabe. Der Ressourcenname der Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	enum (Type) Nur Ausgabe. Der Typ der Engine.

ChannelProfile

JSON-Darstellung

{ "profileId": string, "channelType": enum (ChannelType), "personaProperty": { object (PersonaProperty) }, "webWidgetConfig": { object (WebWidgetConfig) }, "whatsappConfig": { object (WhatsAppConfig) }, "instagramConfig": { object (InstagramConfig) }, // Union field _disable_dtmf can be only one of the following: "disableDtmf": boolean // End of list of possible types for union field _disable_dtmf. // Union field _disable_barge_in_control can be only one of the following: "disableBargeInControl": boolean // End of list of possible types for union field _disable_barge_in_control. // Union field _noise_suppression_level can be only one of the following: "noiseSuppressionLevel": string // End of list of possible types for union field _noise_suppression_level. }

Felder
profileId	string Optional. Die eindeutige Kennung des Kanalprofils.
channelType	enum (ChannelType) Optional. Der Typ des Kanalprofils.
personaProperty	object (PersonaProperty) Optional. Das Persona-Attribut des Kanalprofils.
webWidgetConfig	object (WebWidgetConfig) Optional. Die Konfiguration für das Web-Widget.
whatsappConfig	object (WhatsAppConfig) Optional. Spezifische Konfiguration für WhatsApp-Bereitstellungen.
instagramConfig	object (InstagramConfig) Optional. Konfiguration speziell für Instagram-Bereitstellungen.
Union-Feld _disable_dtmf. Für _disable_dtmf ist nur einer der folgenden Werte zulässig:
disableDtmf	boolean Optional. Gibt an, ob DTMF (Dual-Tone Multi-Frequency) deaktiviert werden soll.
Union-Feld _disable_barge_in_control. Für _disable_barge_in_control ist nur einer der folgenden Werte zulässig:
disableBargeInControl	boolean Optional. Gibt an, ob die Unterbrechungssteuerung für Nutzer in der Unterhaltung deaktiviert werden soll. - true: Nutzerunterbrechungen sind deaktiviert, während der KI-Agent spricht. – false: Der KI-Agent behält die automatische Kontrolle darüber, wann der Nutzer unterbrechen kann.
Union-Feld _noise_suppression_level. Für _noise_suppression_level ist nur einer der folgenden Werte zulässig:
noiseSuppressionLevel	string Optional. Die Stufe der Geräuschunterdrückung des Kanalprofils. Mögliche Werte sind „low“, „moderate“, „high“ und „very_high“.

PersonaProperty

JSON-Darstellung
{ "persona": enum (Persona) }

Felder
persona	enum (Persona) Optional. Die Persona des Kanals.

WebWidgetConfig

JSON-Darstellung
{ "modality": enum (Modality), "theme": enum (Theme), "webWidgetTitle": string, "securitySettings": { object (SecuritySettings) } }

Felder
modality	enum (Modality) Optional. Die Modalität des Web-Widgets.
theme	enum (Theme) Optional. Das Design des Web-Widgets.
webWidgetTitle	string Optional. Der Titel des Web-Widgets.
securitySettings	object (SecuritySettings) Optional. Die Sicherheitseinstellungen des Web-Widgets.

SecuritySettings

JSON-Darstellung
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean }

Felder
enablePublicAccess	boolean Optional. Gibt an, ob der öffentliche Zugriff auf das Web-Widget aktiviert ist. Wenn true, ist das Web-Widget öffentlich zugänglich. Wenn false, muss das Web-Widget in Ihr eigenes Authentifizierungs- und Autorisierungssystem integriert werden, um gültige Anmeldedaten für den Zugriff auf den CES-Agenten zurückzugeben.
enableOriginCheck	boolean Optional. Gibt an, ob die Ursprungsprüfung für das Web-Widget aktiviert ist. Wenn true, prüft das Web-Widget den Ursprung der Website, die das Web-Widget lädt, und lässt nur das Laden im selben Ursprung oder in einem der zulässigen Ursprünge zu.
allowedOrigins[]	string Optional. Die Ursprünge, die das Web-Widget hosten dürfen. Ein Ursprung wird durch RFC 6454 definiert. Wenn dieses Feld leer ist, sind alle Ursprünge zulässig. Es sind maximal 100 Ursprünge zulässig. Beispiel: „https://beispiel.de“
enableRecaptcha	boolean Optional. Gibt an, ob die reCAPTCHA-Überprüfung für das Web-Widget aktiviert ist.

WhatsAppConfig

JSON-Darstellung
{ "wabaId": string, "phoneNumberId": string, "phoneNumber": string, "displayName": string, "thumbnailUrl": string, "description": string }

Felder
wabaId	string Erforderlich. Die WhatsApp Business-Konto-ID.
phoneNumberId	string Erforderlich. Die Meta-Telefonnummer-ID.
phoneNumber	string Optional. Die Telefonnummer im E.164-Format.
displayName	string Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite.
thumbnailUrl	string Nur Ausgabe. Die abgerufene URL der Miniaturansicht des Meta-Unternehmensprofils.
description	string Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Unternehmensprofils.

InstagramConfig

JSON-Darstellung
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string }

Felder
instagramAccountId	string Erforderlich. Die Instagram-Konto-ID.
displayName	string Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite.
thumbnailUrl	string Nur Ausgabe. Die abgerufene URL der Miniaturansicht des Meta-Unternehmensprofils.
description	string Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Unternehmensprofils.

MetadataEntry

JSON-Darstellung
{ "key": string, "value": string }

Felder
key	string
value	string

Zeitstempel

JSON-Darstellung
{ "seconds": string, "nanos": integer }

Felder
seconds	string (int64 format) Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss zwischen -62135596800 und 253402300799 (einschließlich) liegen, was 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z entspricht.
nanos	integer Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld ist der Nanosekundenanteil der Dauer, keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 (einschließlich) liegen.

ClientCertificateSettings

JSON-Darstellung
{ "tlsCertificate": string, "privateKey": string, "passphrase": string }

Felder
tlsCertificate	string Erforderlich. Das TLS-Zertifikat im PEM-Format. Dieser String muss die Zeilen für den Anfangs-Header und den End-Footer enthalten.
privateKey	string Erforderlich. Der Name der Secret-Versionsressource des Secret Manager, in der der private Schlüssel im PEM-Format gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Optional. Der Name der Secret-Versionsressource des Secret Manager, in der die Passphrase zum Entschlüsseln des privaten Schlüssels gespeichert ist. Sollte nicht festgelegt werden, wenn der private Schlüssel nicht verschlüsselt ist. Format: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

JSON-Darstellung
{ "allowedOrigins": [ string ] }

Felder

allowedOrigins[]

string Optional. Die zulässigen HTTP(S)-Ursprünge, die OpenAPI-Tools in der Anwendung direkt aufrufen können, wenn VPC Service Controls aktiviert ist. Diese Strings müssen genau mit dem Ursprung übereinstimmen, einschließlich des Ports, falls angegeben. Beispiel: „https://example.com“ oder „https://example.com:443“. Diese Liste gilt noch nicht für Python-Tools, die möglicherweise direkte HTTP-Aufrufe ausführen.

DashboardSettings

JSON-Darstellung
{ "defaultDashboard": string }

Felder
defaultDashboard	string Optional. Der Ressourcenname des Standard-Contact Center Insights-Dashboards, das mit der Anwendung verknüpft ist. Dieses Dashboard wird angezeigt, wenn Nutzer die Monitoring-Ansicht für die Anwendung aufrufen. Format: projects/{project}/locations/{location}/dashboards/{dashboard}

PrebuiltAmbientNoise

Vordefinierte Umgebungsgeräusche.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	Nicht angegeben.
RETAIL_STORE	Umgebungsgeräusche eines Einzelhandelsgeschäfts.
CONVENTION_HALL	Umgebungsgeräusche in einer Messehalle.
OUTDOOR	Umgebungsgeräusche einer Straße.

WarningType

Art der Warnung, die während der Verarbeitung der Sprachprobe aufgetreten ist.

Enums
WARNING_TYPE_UNSPECIFIED	Nicht angegebener Warnungstyp.
LOW_AUDIO_LEVEL	Der Audiopegel des Sprachbeispiels ist zu niedrig (z.B. niedrige RMS-Amplitude).

VoiceInstructionMode

Anweisungsmodus für die Sprachprobe.

Enums
VOICE_INSTRUCTION_MODE_UNSPECIFIED	Nicht angegebener Anweisungsmodus. Die Standardeinstellung ist NO_INSTRUCTION.
NO_INSTRUCTION	Es werden keine Sprachanweisungen verwendet.
GENERATE_INSTRUCTION	Die Sprachanweisung wird von der KI automatisch aus dem Audiobeispiel generiert.
CUSTOM_INSTRUCTION	Benutzerdefinierte Sprachanweisung, die vom Nutzer bereitgestellt wird.

ErrorHandlingStrategy

Definiert die Strategie für die Fehlerbehandlung.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED	Nicht angegebene Fehlerbehandlungsstrategie.
NONE	Es ist keine spezielle Verarbeitung aktiviert.
FALLBACK_RESPONSE	Bei Systemfehlern (z.B. LLM-Fehlern) wird dem Nutzer eine Fallback-Nachricht zurückgegeben.
END_SESSION	Bei Systemfehlern (z.B. LLM-Fehlern) wird ein EndSession-Signal ausgegeben.

ThinkingLevel

Konfiguration des Denkaufwands für das Modell.

Enums
THINKING_LEVEL_UNSPECIFIED	Der Denkaufwand ist nicht angegeben.
DEFAULT	Standard-Denkaufwand.
LOW	Niedriger Denkaufwand.
MEDIUM	Mittlerer Denkaufwand.
HIGH	Hoher Denkaufwand.

ToolExecutionMode

Definiert das Verhalten bei der Ausführung von Tools, wenn der KI-Agent mehrere Tools gleichzeitig auswählt.

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED	Nicht angegebener Tool-Ausführungsmodus. Standardeinstellung ist PARALLEL.
PARALLEL	Wenn mehrere Tools ausgewählt werden, werden sie parallel mit demselben ToolContext ausgeführt.
SEQUENTIAL	Wenn mehrere Tools ausgewählt werden, werden sie nacheinander ausgeführt. Das nächste Tool wird erst ausgeführt, wenn das vorherige Tool abgeschlossen ist und den aktualisierten ToolContext des vorherigen Tools sehen kann.

SemanticSimilarityChannel

Kanal für semantische Ähnlichkeit, der verwendet werden soll.

Enums
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	Messwert nicht angegeben. Die Standardeinstellung ist TEXT.
TEXT	Semantische Textähnlichkeit verwenden.
AUDIO	Semantische Ähnlichkeit von Audioinhalten verwenden.

ExtraToolCallBehavior

Definiert das Verhalten, wenn ein zusätzlicher Toolaufruf erkannt wird. Ein zusätzlicher Toolaufruf ist ein Toolaufruf, der in der Ausführung vorhanden ist, aber mit keinem Toolaufruf in der Golden Expectation übereinstimmt.

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Nicht angegebenes Verhalten. Die Standardeinstellung ist FAIL.
FAIL	Die Bewertung schlägt fehl, wenn ein zusätzlicher Toolaufruf erkannt wird.
ALLOW	Lassen Sie den zusätzlichen Toolaufruf zu.

HallucinationMetricBehavior

Das Verhalten des Halluzinationsmesswerts. Unabhängig vom Verhalten wird der Messwert immer berechnet. Der Unterschied besteht darin, dass der Messwert bei Deaktivierung nicht zur Berechnung des Gesamtbewertungsergebnisses verwendet wird.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	Nicht angegebenes Verhalten des Halluzinationsmesswerts.
DISABLED	Halluzinationsmesswert deaktivieren.
ENABLED	Halluzinationsmesswert aktivieren.

Typ

OpenAPI-Datentypen.

Enums
TYPE_UNSPECIFIED	Der Typ ist nicht angegeben.
STRING	String-Typ.
INTEGER	Ganzzahltyp.
NUMBER	Zahlentyp.
BOOLEAN	Boolescher Typ.
OBJECT	Objekttyp.
ARRAY	Array-Typ.

NullValue

Stellt ein JSON-null dar.

NullValue ist ein Sentinel, der ein Enum mit nur einem Wert verwendet, um den Nullwert für die Typunion Value darzustellen.

Ein Feld vom Typ NullValue mit einem anderen Wert als 0 wird als ungültig betrachtet. Die meisten ProtoJSON-Serialisierer geben unabhängig vom Ganzzahlwert einen Value mit einem null_value aus, der als JSON-null festgelegt ist, und runden ihn auf einen 0-Wert.

Enums
NULL_VALUE	Nullwert.

Typ

Der Typ der Engine. Weitere Informationen finden Sie in der Dokumentation unter https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType und https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enums
TYPE_UNSPECIFIED	Nicht angegebener Engine-Typ.
ENGINE_TYPE_SEARCH	Die SOLUTION_TYPE_SEARCH-Engine für die Anwendung. Alle Connector-Datenspeicher, die der Anwendung hinzugefügt werden, werden dieser Engine hinzugefügt.
ENGINE_TYPE_CHAT	Chat-Engine-Typ. Die SOLUTION_TYPE_CHAT-Engine für die Anwendung. Alle der Anwendung hinzugefügten Connector-Datenspeicher werden dieser Engine hinzugefügt.

ChannelType

Der Typ des Kanalprofils.

Enums
UNKNOWN	Unbekannter Kanaltyp.
WEB_UI	Web-UI-Kanal.
API	API-Kanal.
TWILIO	Twilio-Kanal.
GOOGLE_TELEPHONY_PLATFORM	Google Telephony Platform-Kanal.
CONTACT_CENTER_AS_A_SERVICE	Contact Center as a Service (CCaaS)-Kanal.
CONTACT_CENTER_AS_A_SERVICE_CHAT	Contact Center as a Service (CCaaS Chat)-Kanal.
FIVE9	Five9-Kanal.
CONTACT_CENTER_INTEGRATION	Integrationskanal für Contact Center von Drittanbietern.
WHATSAPP	WhatsApp-Kanal.
INSTAGRAM	Instagram-Kanal

Persona

Die Persona des Kanals.

Enums
UNKNOWN	UNKNOWN-Persona.
CONCISE	Der KI-Agent hält die Antworten kurz und prägnant.
CHATTY	Der KI-Agent liefert zusätzlichen Kontext, Erklärungen und Details.

Modalität

Modalität des Web-Widgets.

Enums
MODALITY_UNSPECIFIED	Unbekannte Modalität.
CHAT_AND_VOICE	Das Widget unterstützt sowohl Chat- als auch Spracheingabe.
VOICE_ONLY	Das Widget unterstützt nur die Spracheingabe.
CHAT_ONLY	Das Widget unterstützt nur Chateingaben.
CHAT_VOICE_AND_VIDEO	Das Widget unterstützt Chat-, Sprach- und Videoeingaben.

Design

Design des Web-Widgets.

Enums
THEME_UNSPECIFIED	Unbekanntes Design.
LIGHT	Helles Design
DARK	Dunkles Design

Tool-Annotationen

Tool-Anmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können jedoch verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet werden soll.

Zusätzlich zum Titelstring werden die folgenden booleschen Hinweise definiert:

• readOnlyHint: Wenn „true“, ändert das Tool seine Umgebung nicht. Standardeinstellung: false.
• destructiveHint: Wenn „true“, kann das Tool destruktive Aktionen ausführen. Wenn „false“, kann das Tool nur additive Aktionen ausführen. Standardeinstellung: true.
• idempotentHint: Wenn „true“, hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf die Umgebung. Standardeinstellung: false.
• openWorldHint: Wenn „true“, kann das Tool mit einer „offenen Welt“ externer Entitäten interagieren. Wenn „false“, kann das Tool nur mit internen Entitäten interagieren. Ein Tool für die Websuche wäre beispielsweise frei verfügbar, ein Tool für gemerkte Informationen jedoch nicht.

Destruktiver Hinweis: ✅ | Idempotenter Hinweis: ❌ | Lesezugriff-Hinweis: ❌ | Open-World-Hinweis: ❌