Tool: list_apps
Listet Apps im angegebenen Projekt und am angegebenen Standort auf.
Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool list_apps 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": "list_apps", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Eingabeschema
Anfragenachricht für AgentService.ListApps.
ListAppsRequest
| JSON-Darstellung |
|---|
{ "parent": string, "pageSize": integer, "pageToken": string, "filter": string, "orderBy": string } |
| Felder | |
|---|---|
parent |
Erforderlich. Der Ressourcenname des Standorts, für den Apps aufgelistet werden sollen. |
pageSize |
Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus. |
pageToken |
Optional. Der Wert |
filter |
Optional. Filter, der beim Auflisten der Apps angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160. |
orderBy |
Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering. |
Ausgabeschema
Antwortnachricht für AgentService.ListApps.
ListAppsResponse
| JSON-Darstellung |
|---|
{
"apps": [
{
object ( |
| Felder | |
|---|---|
apps[] |
Die Liste der Apps. |
nextPageToken |
Ein Token, das als |
unreachable[] |
Unsortierte Liste. Standorte, die nicht erreicht werden konnten. |
App
| JSON-Darstellung |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| Felder | |
|---|---|
name |
ID. Die eindeutige Kennung der App. Format: |
displayName |
Erforderlich. Anzeigename der App. |
description |
Optional. Eine menschenlesbare Beschreibung der App. |
pinned |
Optional. Gibt an, ob die App in der App-Liste angepinnt ist. |
rootAgent |
Optional. Der Stamm-Agent ist der Einstiegspunkt der App. Format: |
languageSettings |
Optional. Spracheinstellungen der App. |
timeZoneSettings |
Optional. Zeitzoneneinstellungen der App. |
audioProcessingConfig |
Optional. Konfiguration der Audioverarbeitung der App. |
loggingSettings |
Optional. Protokollierungseinstellungen der App. |
errorHandlingSettings |
Optional. Einstellungen für die Fehlerbehandlung der App. |
modelSettings |
Optional. Die Standardeinstellungen für das LLM-Modell für die App. Einzelne Ressourcen (z.B. Agents, Guardrails) können diese Konfigurationen bei Bedarf überschreiben. |
toolExecutionMode |
Optional. Der Ausführungsmodus des Tools für die App. Wenn nicht angegeben, wird standardmäßig PARALLEL verwendet. |
evaluationMetricsThresholds |
Optional. Die Bewertungs-Schwellenwerte für die App. |
variableDeclarations[] |
Optional. Die Deklarationen der Variablen. |
predefinedVariableDeclarations[] |
Nur Ausgabe. Die Deklarationen vordefinierter Variablen für die App. |
globalInstruction |
Optional. Anleitung für alle Agents in der App. Mit dieser Anleitung können Sie eine stabile Identität oder Persönlichkeit für alle Agents festlegen. |
guardrails[] |
Optional. Liste der Richtlinien für die App. Format: |
dataStoreSettings |
Optional. Die Datenspeichereinstellungen für die App. |
defaultChannelProfile |
Optional. Das Standardkanalprofil, das von der App verwendet wird. |
metadata |
Optional. Metadaten zur App. In diesem Feld können zusätzliche Informationen gespeichert werden, die für die Details oder die beabsichtigte Nutzung der App relevant sind. Ein Objekt, das eine Liste von |
createTime |
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: |
updateTime |
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: |
etag |
Nur Ausgabe. Etag, das verwendet wird, um sicherzustellen, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden alle gleichzeitigen Änderungen durch das Update überschrieben. |
deploymentCount |
Nur Ausgabe. Anzahl der Bereitstellungen in der App. |
clientCertificateSettings |
Optional. Die Standardeinstellungen für das Clientzertifikat für die App. |
vpcScSettings |
Optional. VPC-SC-Einstellungen für die App. |
locked |
Optional. Gibt an, ob die App für Änderungen gesperrt ist. Wenn die App gesperrt ist, werden Änderungen an den App-Ressourcen abgelehnt. |
validationErrors[] |
Nur Ausgabe. Fehlkonfigurationen oder Warnungen in der App |
dashboardSettings |
Optional. App-spezifische 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 |
Optional. Der Standardsprachcode der App. |
supportedLanguageCodes[] |
Optional. Liste der von der App unterstützten Sprachcodes zusätzlich zu |
enableMultilingualSupport |
Optional. Ermöglicht die Unterstützung mehrerer Sprachen. Wenn „true“ festgelegt ist, verwenden Agents in der App vordefinierte Anweisungen, um die Verarbeitung mehrsprachiger Eingaben zu verbessern. |
fallbackAction |
Optional. Eingestellt: Diese Funktion wird nicht mehr unterstützt. Verwenden Sie stattdessen Das kann eine vordefinierte Aktion oder ein benutzerdefinierter Tool-Aufruf sein. Gültige Werte sind: - Der vollständige Ressourcenname eines Tools, der die Ausführung eines bestimmten Tools auslöst. – Eine vordefinierte Systemaktion wie „escalate“ (eskalieren) oder „exit“ (beenden), die ein |
TimeZoneSettings
| JSON-Darstellung |
|---|
{ "timeZone": string } |
| Felder | |
|---|---|
timeZone |
Optional. Die Zeitzone der App aus der Zeitzonendatenbank, z.B. America/Los_Angeles, Europe/Paris. |
AudioProcessingConfig
| JSON-Darstellung |
|---|
{ "synthesizeSpeechConfigs": { string: { object ( |
| Felder | |
|---|---|
synthesizeSpeechConfigs |
Optional. Konfiguration, wie die Antwort des Agenten synthetisiert werden soll. Die Zuordnung erfolgt vom Sprachcode zu Wenn die Konfiguration für den angegebenen Sprachcode nicht gefunden wird, wird die Konfiguration für den Stamm-Sprachcode verwendet. Wenn die Karte 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 beachtet. Ein Objekt, das eine Liste von |
bargeInConfig |
Optional. Konfiguriert das Verhalten des Agents für die Unterbrechungsaktivitäten des Nutzers. |
inactivityTimeout |
Optional. Die Dauer der Nutzerinaktivität (keine Sprache oder Interaktion), bevor der Agent den Nutzer auffordert, die Interaktion fortzusetzen. Wenn diese Einstellung nicht festgelegt ist, wird der Nutzer vom Kundenservicemitarbeiter nicht aufgefordert, die Interaktion fortzusetzen. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „ |
ambientSoundConfig |
Optional. Konfiguration für den Umgebungsgeräusch, der mit der synthetisierten Antwort des KI-Agenten wiedergegeben werden soll, um die Natürlichkeit des Gesprächs zu verbessern. |
SynthesizeSpeechConfigsEntry
| JSON-Darstellung |
|---|
{
"key": string,
"value": {
object ( |
| Felder | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| JSON-Darstellung |
|---|
{ "voice": string, "voiceSampleGcsUri": string, "speakingRate": number, "model": string, "instruction": string, "consentAudioGcsUri": string } |
| Felder | |
|---|---|
voice |
Optional. Die Bezeichnung der Stimme. Wenn nicht festgelegt, 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 in der Cloud Text-to-Speech-Dokumentation. |
voiceSampleGcsUri |
Optional. Verworfen: Verwenden Sie stattdessen Der Cloud Storage-URI des Audio-Samples für das Klonen der Stimme. Das Audiobeispiel sollte eine Mono-WAV-Datei mit 24 kHz sein. Hinweis: Der CES-Dienst-Agent |
speakingRate |
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. Bei Werten außerhalb des Bereichs [0,25, 2,0] wird ein Fehler zurückgegeben. |
model |
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 |
Optional. Die Anweisung, die zum Synthetisieren von Sprache verwendet wird, wenn ein generatives Modell verwendet wird. |
consentAudioGcsUri |
Optional. Verworfen: Verwenden Sie stattdessen Der Cloud Storage-URI der Audiodatei mit Einwilligung für das Klonen von Stimmen. |
BargeInConfig
| JSON-Darstellung |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| Felder | |
|---|---|
disableBargeIn |
Optional. Eingestellt: Deaktiviert das Unterbrechen des Nutzers, während der Agent spricht. Wenn „true“ festgelegt ist, wird die Nutzereingabe während der Wiedergabe der Agent-Antwort ignoriert. |
bargeInAwareness |
Optional. Wenn diese Option aktiviert ist, passt der Agent seine nächste Antwort an die Annahme an, dass der Nutzer die vorherige Nachricht des Agents nicht vollständig gehört hat. Diese Funktion sollte nicht in Szenarien verwendet werden, in denen Agent-Antworten visuell dargestellt werden. |
Dauer
| JSON-Darstellung |
|---|
{ "seconds": string, "nanos": integer } |
| Felder | |
|---|---|
seconds |
Vorzeichenbehaftete Sekunden des Zeitraums. Muss zwischen -315.576.000.000 und +315.576.000.000 (einschließlich) liegen. Hinweis: Diese Grenzwerte werden so berechnet: 60 Sek./Min. × 60 Min./Std. × 24 Std./Tag × 365,25 Tage/Jahr × 10.000 Jahre |
nanos |
Signierte Sekundenbruchteile mit Nanosekunden-Auflösung des Zeitraums. Dauern von weniger als einer Sekunde werden mit dem Feld |
AmbientSoundConfig
| JSON-Darstellung |
|---|
{ "volumeGainDb": number, // Union field |
| Felder | |
|---|---|
volumeGainDb |
Optional. Lautstärkeänderung (in dB) der normalen nativen Lautstärke, die von Umgebungsgeräuschen unterstützt wird, im Bereich [–96,0 bis 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 wiedergegeben werden sollen, um die Natürlichkeit der Unterhaltung zu verbessern. Für source ist nur einer der folgenden Werte zulässig: |
|
prebuiltAmbientNoise |
Optional. Eingestellt: |
gcsUri |
Optional. Umgebungsgeräusche als Mono-WAV-Datei mit 16 kHz, die in Cloud Storage gespeichert ist. Hinweis: Der CES-Dienst-Agent |
prebuiltAmbientSound |
Optional. Name des integrierten Ambient-Sounds. 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" |
LoggingSettings
| JSON-Darstellung |
|---|
{ "redactionConfig": { object ( |
| Felder | |
|---|---|
redactionConfig |
Optional. Konfiguration, wie sensible Daten unkenntlich gemacht werden sollen. |
audioRecordingConfig |
Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen. Das Audio unterliegt der Entfernung gemäß der Konfiguration in |
unredactedAudioRecordingConfig |
Optional. Konfiguriert eine zusätzliche Aufzeichnung von Audio ohne Schwärzungen. Dies kann verwendet werden, um eine Rohkopie des Audiosignals zu behalten, wenn die Audio-Schwärzung |
bigqueryExportSettings |
Optional. Konfiguriert das Verhalten des BigQuery-Exports für die App. Die Konversationsdaten werden gemäß der Konfiguration in |
unredactedBigqueryExportSettings |
Optional. Konfiguriert das Verhalten beim BigQuery-Export für die App. Die nicht anonymisierten Unterhaltungsdaten werden in BigQuery-Tabellen exportiert, wenn der Export aktiviert ist. |
cloudLoggingSettings |
Optional. Einstellungen zur Beschreibung des Cloud Logging-Verhaltens für die App. |
conversationLoggingSettings |
Optional. Einstellungen, die das Verhalten der App beim Aufzeichnen von Unterhaltungen beschreiben. |
evaluationAudioRecordingConfig |
Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen für die Auswertung. Standardmäßig ist die Audioaufnahme für Evaluationssitzungen nicht aktiviert. |
metricAnalysisSettings |
Optional. Einstellungen zur Beschreibung des Verhaltens bei der Datenerhebung von Unterhaltungen für die LLM-Analysepipeline für die App. |
RedactionConfig
| JSON-Darstellung |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| Felder | |
|---|---|
enableRedaction |
Optional. Bei „true“ wird die Entfernung in verschiedenen Logging-Szenarien angewendet, darunter Gesprächsablauf, Cloud Logging und Audioaufzeichnung. |
inspectTemplate |
Optional. Name der DLP-Prüfungsvorlage zum Konfigurieren der Erkennung sensibler Datentypen. Format: |
deidentifyTemplate |
Optional. Name der DLP-De-Identifikationsvorlage, um anzugeben, wie Inhalte de-identifiziert werden sollen. Format: |
AudioRecordingConfig
| JSON-Darstellung |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| Felder | |
|---|---|
gcsBucket |
Optional. Der Cloud Storage-Bucket, in dem die Audioaufzeichnungen der Sitzung gespeichert werden. 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 der App befindet, sollten Sie dem CES-Dienst-Agent |
gcsPathPrefix |
Optional. Das Präfix des Cloud Storage-Pfads für Audioaufzeichnungen. Dieses Präfix kann die folgenden Platzhalter enthalten, die zur Laufzeit dynamisch ersetzt werden: – $project: Projekt-ID – $location: App-Standort – $app: App-ID – $date: Sitzungsdatum im Format YYYY-MM-DD – $session: Sitzungs-ID Wenn das Pfadpräfix nicht angegeben ist, wird das Standardpräfix |
BigQueryExportSettings
| JSON-Darstellung |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| Felder | |
|---|---|
enabled |
Optional. Gibt an, ob der BigQuery-Export aktiviert ist. |
project |
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 |
dataset |
Optional. Die BigQuery-Dataset-ID, in die die Daten exportiert werden sollen. |
CloudLoggingSettings
| JSON-Darstellung |
|---|
{ "enableCloudLogging": boolean } |
| Felder | |
|---|---|
enableCloudLogging |
Optional. Gibt an, ob Cloud Logging für die Sitzungen aktiviert werden soll. |
ConversationLoggingSettings
| JSON-Darstellung |
|---|
{ "disableConversationLogging": boolean, "retentionWindow": string } |
| Felder | |
|---|---|
disableConversationLogging |
Optional. Gibt an, ob das Logging von Unterhaltungen für die Sitzungen deaktiviert werden soll. |
retentionWindow |
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 „ |
MetricAnalysisSettings
| JSON-Darstellung |
|---|
{ "llmMetricsOptedOut": boolean } |
| Felder | |
|---|---|
llmMetricsOptedOut |
Optional. Gibt an, ob Konversationsdaten für LLM-Analyse-Messwerte erfasst werden sollen. Wenn „true“ festgelegt ist, werden keine Konversationsdaten für LLM-Analyse-Messwerte erhoben. Andernfalls werden Konversationsdaten erhoben. |
ErrorHandlingSettings
| JSON-Darstellung |
|---|
{ "errorHandlingStrategy": enum ( |
| Felder | |
|---|---|
errorHandlingStrategy |
Optional. Die Strategie, die für die Fehlerbehandlung verwendet werden soll. |
fallbackResponseConfig |
Optional. Konfiguration für die Verarbeitung von Fallback-Antworten. |
endSessionConfig |
Optional. Konfiguration zum Beenden der Sitzung bei Systemfehlern (z.B. LLM-Fehlern). |
FallbackResponseConfig
| JSON-Darstellung |
|---|
{ "customFallbackMessages": { string: string, ... }, "maxFallbackAttempts": integer } |
| Felder | |
|---|---|
customFallbackMessages |
Optional. Die Fallback-Meldungen bei Systemfehlern (z.B. LLM-Fehler), die nach unterstütztem Sprachcode zugeordnet sind. Ein Objekt, das eine Liste von |
maxFallbackAttempts |
Optional. Die maximale Anzahl von Fallback-Versuchen, die unternommen werden sollen, bevor der Agent das |
CustomFallbackMessagesEntry
| JSON-Darstellung |
|---|
{ "key": string, "value": string } |
| Felder | |
|---|---|
key |
|
value |
|
EndSessionConfig
| JSON-Darstellung |
|---|
{ // Union field |
| Felder | |
|---|---|
Union-Feld Für |
|
escalateSession |
Optional. Gibt an, ob die Sitzung in |
ModelSettings
| JSON-Darstellung |
|---|
{ "model": string, // Union field |
| Felder | |
|---|---|
model |
Optional. Das LLM-Modell, das der Agent verwenden soll. Wenn nicht festgelegt, übernimmt der Agent das Modell vom übergeordneten Agent. |
Union-Feld Für |
|
temperature |
Optional. Wenn festgelegt, wird diese Temperatur für das LLM-Modell verwendet. Die Temperatur steuert die Zufälligkeit der Antworten des Modells. Niedrigere Temperaturen führen zu vorhersagbareren Antworten. Höhere Temperaturen führen zu kreativeren Antworten. |
EvaluationMetricsThresholds
| JSON-Darstellung |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| Felder | |
|---|---|
goldenEvaluationMetricsThresholds |
Optional. Die Grenzwerte für die Golden-Bewertungsmesswerte. |
hallucinationMetricBehavior |
Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen |
goldenHallucinationMetricBehavior |
Optional. Das Verhalten des Messwerts für Halluzinationen bei Golden Evaluations. |
scenarioHallucinationMetricBehavior |
Optional. Das Verhalten des Halluzinationsmesswerts für Szenariobewertungen. |
GoldenEvaluationMetricsThresholds
| JSON-Darstellung |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| Felder | |
|---|---|
turnLevelMetricsThresholds |
Optional. Die Schwellenwerte für Messwerte auf Turn-Ebene. |
expectationLevelMetricsThresholds |
Optional. Die Grenzwerte für die Messwerte für das Erwartungsniveau. |
toolMatchingSettings |
Optional. Die Einstellungen für den Tool-Abgleich. Ein zusätzlicher Tool-Aufruf ist ein Tool-Aufruf, der in der Ausführung vorhanden ist, aber keinem Tool-Aufruf in der Goldenen Erwartung entspricht. |
TurnLevelMetricsThresholds
| JSON-Darstellung |
|---|
{ "semanticSimilarityChannel": enum ( |
| Felder | |
|---|---|
semanticSimilarityChannel |
Optional. Der semantische Ähnlichkeitschannel, der für die Bewertung verwendet werden soll. |
Union-Feld Für |
|
semanticSimilaritySuccessThreshold |
Optional. Der Erfolgsschwellenwert für die semantische Ähnlichkeit. Muss eine Ganzzahl zwischen 0 und 4 sein. Der Standardwert ist >= 3. |
Union-Feld Für |
|
overallToolInvocationCorrectnessThreshold |
Optional. Der Schwellenwert für die Richtigkeit des Toolaufrufs insgesamt. Muss eine Gleitkommazahl zwischen 0 und 1 sein. Der Standardwert ist 1,0. |
ExpectationLevelMetricsThresholds
| JSON-Darstellung |
|---|
{ // Union field |
| Felder | |
|---|---|
Union-Feld Für |
|
toolInvocationParameterCorrectnessThreshold |
Optional. Der Erfolgsschwellenwert für die Richtigkeit einzelner Parameter für den Toolaufruf. Muss eine Gleitkommazahl zwischen 0 und 1 sein. Der Standardwert ist 1,0. |
ToolMatchingSettings
| JSON-Darstellung |
|---|
{
"extraToolCallBehavior": enum ( |
| Felder | |
|---|---|
extraToolCallBehavior |
Optional. Verhalten bei zusätzlichen Tool-Aufrufen. Die Standardeinstellung ist FAIL. |
VariableDeclaration
| JSON-Darstellung |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| Felder | |
|---|---|
name |
Erforderlich. Der Name der Variablen. Der Name muss mit einem Buchstaben oder Unterstrich beginnen und darf nur Buchstaben, Ziffern oder Unterstriche enthalten. |
description |
Erforderlich. Die Beschreibung der Variablen. |
schema |
Erforderlich. Das Schema der Variablen. |
Schema
| JSON-Darstellung |
|---|
{ "type": enum ( |
| Felder | |
|---|---|
type |
Erforderlich. Der Typ der Daten. |
properties |
Optional. Attribute von Type.OBJECT. Ein Objekt, das eine Liste von |
required[] |
Optional. Erforderliche Eigenschaften von Type.OBJECT. |
description |
Optional. Die Beschreibung der Daten. |
items |
Optional. Schema der Elemente von Type.ARRAY. |
nullable |
Optional. Gibt an, ob der Wert null sein darf. |
uniqueItems |
Optional. Geben Sie an, dass die Elemente im Array eindeutig sein müssen. Gilt nur für TYPE.ARRAY. |
prefixItems[] |
Optional. Schemas der ersten Elemente von Type.ARRAY. |
additionalProperties |
Optional. Kann entweder ein boolescher Wert oder ein Objekt sein. Steuert das Vorhandensein zusätzlicher Attribute. |
anyOf[] |
Optional. Der Wert sollte anhand eines oder mehrerer der Unterschemas in der Liste validiert werden. |
enum[] |
Optional. Mögliche Werte des Elements des einfachen 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 |
Optional. Standardwert der Daten. |
ref |
Optional. Ermöglicht indirekte Verweise zwischen Schemaknoten. Der Wert sollte ein gültiger Verweis auf ein untergeordnetes Element des Stamm- Das folgende Schema definiert beispielsweise eine Referenz auf einen Schemaknoten mit dem Namen „Pet“: Der Wert der Property „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 |
Optional. Eine Karte mit Definitionen zur Verwendung durch Ein Objekt, das eine Liste von |
title |
Optional. Der Titel des Schemas. |
minItems |
Optional. Mindestanzahl der Elemente für Type.ARRAY. |
maxItems |
Optional. Maximale Anzahl der Elemente für Type.ARRAY. |
Union-Feld Für |
|
minimum |
Optional. Mindestwert für Type.INTEGER und Type.NUMBER. |
Union-Feld Für |
|
maximum |
Optional. Maximaler Wert für Type.INTEGER und Type.NUMBER. |
PropertiesEntry
| JSON-Darstellung |
|---|
{
"key": string,
"value": {
object ( |
| Felder | |
|---|---|
key |
|
value |
|
Wert
| JSON-Darstellung |
|---|
{ // Union field |
| Felder | |
|---|---|
Union-Feld kind. Die Art des Werts. Für kind ist nur einer der folgenden Werte zulässig: |
|
nullValue |
Stellt ein JSON- |
numberValue |
Stellt eine JSON-Zahl dar. Darf nicht |
stringValue |
Stellt einen JSON-String dar. |
boolValue |
Stellt einen booleschen JSON-Wert dar ( |
structValue |
Stellt ein JSON-Objekt dar. |
listValue |
Stellt ein JSON-Array dar. |
Struct
| JSON-Darstellung |
|---|
{ "fields": { string: value, ... } } |
| Felder | |
|---|---|
fields |
Ungeordnete Zuordnung von dynamisch typisierten Werten. Ein Objekt, das eine Liste von |
FieldsEntry
| JSON-Darstellung |
|---|
{ "key": string, "value": value } |
| Felder | |
|---|---|
key |
|
value |
|
ListValue
| JSON-Darstellung |
|---|
{ "values": [ value ] } |
| Felder | |
|---|---|
values[] |
Wiederkehrendes Feld mit dynamisch typisierten Werten. |
DefsEntry
| JSON-Darstellung |
|---|
{
"key": string,
"value": {
object ( |
| Felder | |
|---|---|
key |
|
value |
|
DataStoreSettings
| JSON-Darstellung |
|---|
{
"engines": [
{
object ( |
| Felder | |
|---|---|
engines[] |
Nur Ausgabe. Die Engines für die App. |
Engine
| JSON-Darstellung |
|---|
{
"name": string,
"type": enum ( |
| Felder | |
|---|---|
name |
Nur Ausgabe. Der Ressourcenname der Engine. Format: |
type |
Nur Ausgabe. Der Typ der Engine. |
ChannelProfile
| JSON-Darstellung |
|---|
{ "profileId": string, "channelType": enum ( |
| Felder | |
|---|---|
profileId |
Optional. Die eindeutige ID des Channelprofils. |
channelType |
Optional. Der Typ des Channel-Profils. |
personaProperty |
Optional. Die Persona-Eigenschaft des Kanalprofils. |
webWidgetConfig |
Optional. Die Konfiguration für das Web-Widget. |
whatsappConfig |
Optional. Konfiguration für WhatsApp-Bereitstellungen. |
instagramConfig |
Optional. Konfiguration für Instagram-Bereitstellungen. |
Union-Feld Für |
|
disableDtmf |
Optional. Gibt an, ob DTMF (Dual-Tone-Multifrequenz) deaktiviert werden soll. |
Union-Feld Für |
|
disableBargeInControl |
Optional. Gibt an, ob die Funktion zum Unterbrechen von Nutzeranfragen in der Unterhaltung deaktiviert werden soll. – true: Nutzerunterbrechungen sind deaktiviert, während der Agent spricht. – false: Der Agent behält die automatische Kontrolle darüber, wann der Nutzer unterbrechen kann. |
Union-Feld Für |
|
noiseSuppressionLevel |
Optional. Der Grad der Geräuschunterdrückung des Kanalprofils. Verfügbare Werte sind „low“, „moderate“, „high“ und „very_high“. |
PersonaProperty
| JSON-Darstellung |
|---|
{
"persona": enum ( |
| Felder | |
|---|---|
persona |
Optional. Die Persona des Kanals. |
WebWidgetConfig
| JSON-Darstellung |
|---|
{ "modality": enum ( |
| Felder | |
|---|---|
modality |
Optional. Die Modalität des Web-Widgets. |
theme |
Optional. Das Design des Web-Widgets. |
webWidgetTitle |
Optional. Der Titel des Web-Widgets. |
securitySettings |
Optional. Die Sicherheitseinstellungen des Web-Widgets. |
SecuritySettings
| JSON-Darstellung |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| Felder | |
|---|---|
enablePublicAccess |
Optional. Gibt an, ob der öffentliche Zugriff auf das Web-Widget aktiviert ist. Wenn |
enableOriginCheck |
Optional. Gibt an, ob die Ursprungsprüfung für das Web-Widget aktiviert ist. Wenn |
allowedOrigins[] |
Optional. Die Ursprünge, die das Web-Widget hosten dürfen. Ein Ursprung wird durch RFC 6454 definiert. Wenn das Feld leer ist, sind alle Ursprünge zulässig. Es sind maximal 100 Ursprünge zulässig. Beispiel: „https://beispiel.de“ |
enableRecaptcha |
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 |
Erforderlich. Die WhatsApp Business-Konto-ID. |
phoneNumberId |
Erforderlich. Die Meta-Telefonnummer-ID. |
phoneNumber |
Optional. Die Telefonnummer im E.164-Format. |
displayName |
Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite. |
thumbnailUrl |
Nur Ausgabe. Die abgerufene Miniaturansicht-URL des Meta-Unternehmensprofils. |
description |
Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils. |
InstagramConfig
| JSON-Darstellung |
|---|
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| Felder | |
|---|---|
instagramAccountId |
Erforderlich. Die Instagram-Konto-ID. |
displayName |
Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite. |
thumbnailUrl |
Nur Ausgabe. Die abgerufene Miniaturansicht-URL des Meta-Unternehmensprofils. |
description |
Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils. |
MetadataEntry
| JSON-Darstellung |
|---|
{ "key": string, "value": string } |
| Felder | |
|---|---|
key |
|
value |
|
Zeitstempel
| JSON-Darstellung |
|---|
{ "seconds": string, "nanos": integer } |
| Felder | |
|---|---|
seconds |
Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss einschließlich zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z). |
nanos |
Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld enthält den Nanosekundenanteil der Dauer und ist 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 liegen (einschließlich). |
ClientCertificateSettings
| JSON-Darstellung |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| Felder | |
|---|---|
tlsCertificate |
Erforderlich. Das TLS-Zertifikat im PEM-Format. Dieser String muss die Zeilen für den Beginn des Headers und das Ende der Fußzeile enthalten. |
privateKey |
Erforderlich. Der Name der SecretManager-Secret-Versionsressource, in der der private Schlüssel im PEM-Format gespeichert ist. Format: |
passphrase |
Optional. Der Name der SecretManager-Secret-Versionsressource, 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: |
VpcScSettings
| JSON-Darstellung |
|---|
{ "allowedOrigins": [ string ] } |
| Felder | |
|---|---|
allowedOrigins[] |
Optional. Die zulässigen HTTP(S)-Ursprünge, die von OpenAPI-Tools in der App direkt aufgerufen werden 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://beispiel.de“ oder „https://beispiel.de: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 |
Optional. Der Ressourcenname des Standard-Contact Center Insights-Dashboards, das mit der App verknüpft ist. Dieses Dashboard wird angezeigt, wenn Nutzer zur Monitoring-Ansicht für die App wechseln. Format: |
PrebuiltAmbientNoise
Vorgefertigte Umgebungsgeräusche.
| Enums | |
|---|---|
PREBUILT_AMBIENT_NOISE_UNSPECIFIED |
Nicht angegeben. |
RETAIL_STORE |
Umgebungsgeräusche in einem Einzelhandelsgeschäft |
CONVENTION_HALL |
Umgebungsgeräusche einer Kongresshalle. |
OUTDOOR |
Umgebungsgeräusche einer Straße. |
ErrorHandlingStrategy
Definiert die Strategie für die Fehlerbehandlung.
| Enums | |
|---|---|
ERROR_HANDLING_STRATEGY_UNSPECIFIED |
Nicht angegebene Strategie zur Fehlerbehandlung. |
NONE |
Es ist keine spezielle Verarbeitung aktiviert. |
FALLBACK_RESPONSE |
Im Falle von 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. |
ToolExecutionMode
Definiert das Verhalten bei der Ausführung von Tools, wenn mehrere Tools vom Agent gleichzeitig ausgewählt werden.
| Enums | |
|---|---|
TOOL_EXECUTION_MODE_UNSPECIFIED |
Nicht angegebener Tool-Ausführungsmodus. Die Standardeinstellung ist PARALLEL. |
PARALLEL |
Wenn mehrere Tools ausgewählt sind, werden sie parallel mit demselben ToolContext ausgeführt. |
SEQUENTIAL |
Wenn mehrere Tools ausgewählt sind, werden sie nacheinander ausgeführt. Das nächste Tool wird erst ausgeführt, wenn das vorherige Tool abgeschlossen ist. Es kann dann den aktualisierten ToolContext des vorherigen Tools sehen. |
SemanticSimilarityChannel
Der zu verwendende Channel für die semantische Ähnlichkeit.
| Enums | |
|---|---|
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED |
Messwert nicht angegeben. Die Standardeinstellung ist TEXT. |
TEXT |
Semantische Ähnlichkeit von Text verwenden. |
AUDIO |
Semantische Ähnlichkeit von Audioinhalten verwenden. |
ExtraToolCallBehavior
Definiert das Verhalten, wenn ein zusätzlicher Tool-Aufruf erfolgt. Ein zusätzlicher Tool-Aufruf ist ein Tool-Aufruf, der in der Ausführung vorhanden ist, aber keinem Tool-Aufruf in der Goldenen Erwartung entspricht.
| Enums | |
|---|---|
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
Nicht angegebenes Verhalten. Die Standardeinstellung ist FAIL. |
FAIL |
Die Auswertung schlägt fehl, wenn ein zusätzlicher Toolaufruf erfolgt. |
ALLOW |
Zusätzlichen Toolaufruf zulassen |
HallucinationMetricBehavior
Das Verhalten des Messwerts für Halluzinationen. Der Messwert wird immer berechnet, unabhängig vom Verhalten. Der Unterschied besteht darin, dass der Messwert bei Deaktivierung nicht zur Berechnung der Gesamtbewertung verwendet wird.
| Enums | |
|---|---|
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED |
Nicht angegebenes Verhalten des Halluzinationsmesswerts. |
DISABLED |
Messwert für Halluzinationen deaktivieren. |
ENABLED |
Halluzinationsmesswert aktivieren |
Typ
OpenAPI-Datentypen.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Der Typ ist nicht angegeben. |
STRING |
String-Typ. |
INTEGER |
Ganzzahltyp. |
NUMBER |
Numerischer Typ. |
BOOLEAN |
Boolescher Typ. |
OBJECT |
Objekttyp. |
ARRAY |
Array-Typ. |
NullValue
Stellt ein JSON-null dar.
NullValue ist ein Sentinel, der einen 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 gilt als ungültig. Die meisten ProtoJSON-Serialisierungsprogramme geben ein Value mit einem als JSON-null festgelegten null_value aus, unabhängig vom Ganzzahlwert. Daher wird ein Roundtrip zu einem 0-Wert durchgeführt.
| 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 Motortyp. |
ENGINE_TYPE_SEARCH |
Die SOLUTION_TYPE_SEARCH-Engine für die App. Alle Connector-Datenspeicher, die der App hinzugefügt werden, werden dieser Engine hinzugefügt. |
ENGINE_TYPE_CHAT |
Typ der Chat-Engine. Die SOLUTION_TYPE_CHAT-Engine für die App. Alle Connector-Datenspeicher, die der App hinzugefügt werden, werden dieser Engine hinzugefügt. |
ChannelType
Der Typ des Channel-Profils.
| Enums | |
|---|---|
UNKNOWN |
Unbekannter Kanaltyp. |
WEB_UI |
Webbenutzeroberflächen-Channel |
API |
API-Channel. |
TWILIO |
Twilio-Channel. |
GOOGLE_TELEPHONY_PLATFORM |
Google Telephony Platform-Kanal. |
CONTACT_CENTER_AS_A_SERVICE |
Contact Center as a Service (CCaaS) |
CONTACT_CENTER_AS_A_SERVICE_CHAT |
Contact Center as a Service (CCaaS Chat) |
FIVE9 |
Five9-Kanal. |
CONTACT_CENTER_INTEGRATION |
Drittanbieter-Channel für die Contact-Center-Integration. |
WHATSAPP |
WhatsApp-Kanal. |
INSTAGRAM |
Instagram-Kanal |
Persona
Die Persona des Kanals.
| Enums | |
|---|---|
UNKNOWN |
UNKNOWN-Persona. |
CONCISE |
Der 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 Spracheingabe. |
CHAT_ONLY |
Das Widget unterstützt nur Chateingaben. |
CHAT_VOICE_AND_VIDEO |
Das Widget unterstützt Chat-, Sprach- und Videoeingabe. |
Design
Design des Web-Widgets.
| Enums | |
|---|---|
THEME_UNSPECIFIED |
Unbekanntes Thema. |
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 aber verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet wird.
Zusammen mit dem Titelstring sind 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 Einheiten interagieren. Wenn „false“, kann das Tool nur mit internen Einheiten interagieren. Ein Web-Suchtool wäre beispielsweise frei verfügbar, ein Memory-Tool jedoch nicht.
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌