MCP Tools Reference: ces.googleapis.com

Tool: create_app_version

Erstellt eine neue App-Version in der angegebenen App.

Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool create_app_version 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": "create_app_version",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Eingabeschema

Anfragenachricht für AgentService.CreateAppVersion

CreateAppVersionRequest

JSON-Darstellung 
{
  "parent": string,
  "appVersionId": string,
  "appVersion": {
    object (AppVersion)
  }
}
Felder
parent

string

Erforderlich. Der Ressourcenname der App, in der eine App-Version erstellt werden soll.
appVersionId

string

Optional. Die für die App-Version zu verwendende ID, die als letzte Komponente des Ressourcennamens der App-Version verwendet wird. Wenn nicht angegeben, wird der App-Version automatisch eine eindeutige ID zugewiesen.
appVersion

object (AppVersion)

Erforderlich. Die zu erstellende App-Version.

AppVersion

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": string,
  "snapshot": {
    object (AppSnapshot)
  },
  "etag": string
}
Felder
name

string

ID. Die eindeutige ID der App-Version. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
displayName

string

Optional. Der Anzeigename der App-Version.
description

string

Optional. Die Beschreibung der App-Version.
creator

string

Nur Ausgabe. E-Mail-Adresse des Nutzers, der die App-Version erstellt hat.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung der App-Version.

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"
snapshot

object (AppSnapshot)

Nur Ausgabe. Der Snapshot der App, der beim Erstellen der Version aufgenommen wurde.
etag

string

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.

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 einschließlich zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).
nanos

integer

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

AppSnapshot

JSON-Darstellung 
{
  "app": {
    object (App)
  },
  "agents": [
    {
      object (Agent)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "examples": [
    {
      object (Example)
    }
  ],
  "guardrails": [
    {
      object (Guardrail)
    }
  ],
  "toolsets": [
    {
      object (Toolset)
    }
  ]
}
Felder
app

object (App)

Optional. Die Grundeinstellungen für die App.
agents[]

object (Agent)

Optional. Liste der Agents in der App.
tools[]

object (Tool)

Optional. Liste der Tools in der App.
examples[]

object (Example)

Optional. Liste mit Beispielen in der App.
guardrails[]

object (Guardrail)

Optional. Liste der Schutzmaßnahmen in der App.
toolsets[]

object (Toolset)

Optional. Liste der Toolsets in der App.

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 App-Liste angepinnt ist.
rootAgent

string

Optional. Der Stamm-Agent ist der Einstiegspunkt der App. 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. Protokollierungseinstellungen der App.
errorHandlingSettings

object (ErrorHandlingSettings)

Optional. Einstellungen für die Fehlerbehandlung der App.
modelSettings

object (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

enum (ToolExecutionMode)

Optional. Der Ausführungsmodus des Tools für die App. Wenn nicht angegeben, wird standardmäßig PARALLEL verwendet.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Optional. Die Bewertungs-Schwellenwerte 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. 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[]

string

Optional. Liste der Richtlinien für die App. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Optional. Die Datenspeichereinstellungen für die App.
defaultChannelProfile

object (ChannelProfile)

Optional. Das Standardkanalprofil, das von der App verwendet wird.
metadata

map (key: string, value: string)

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 "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, 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

integer

Nur Ausgabe. Anzahl der Bereitstellungen in der App.
clientCertificateSettings

object (ClientCertificateSettings)

Optional. Die Standardeinstellungen für das Clientzertifikat für die App.
vpcScSettings

object (VpcScSettings)

Optional. VPC-SC-Einstellungen für die App.
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. 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

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. 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
(deprecated)

string

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 erhält.

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 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 App aus der Zeitzonendatenbank, z.B. America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

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

map (key: string, value: object (SynthesizeSpeechConfig))

Optional. Konfiguration, wie die Antwort des Agenten synthetisiert werden soll. Die Zuordnung erfolgt 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 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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Optional. Konfiguriert das Verhalten des Agents 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, 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 „s“. Beispiel: "3.5s".
ambientSoundConfig

object (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 (SynthesizeSpeechConfig)
  }
}
Felder
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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
(deprecated)

string

Optional. Verworfen: Verwenden Sie stattdessen custom_voice_samples in AudioProcessingConfig.

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 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com muss die Berechtigung storage.objects.get für das Cloud Storage-Objekt haben.
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. Bei Werten außerhalb des Bereichs [0,25, 2,0] wird ein Fehler zurückgegeben.
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.
consentAudioGcsUri
(deprecated)

string

Optional. Verworfen: Verwenden Sie stattdessen custom_voice_samples in AudioProcessingConfig.

Der Cloud Storage-URI der Audiodatei mit Einwilligung für das Klonen von Stimmen.

BargeInConfig

JSON-Darstellung 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Felder
disableBargeIn
(deprecated)

boolean

Optional. Eingestellt: disable_barge_in wird in ChannelProfile zugunsten von disable_barge_in_control 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

boolean

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

string (int64 format)

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

integer

Signierte Sekundenbruchteile mit Nanosekunden-Auflösung des Zeitraums. Dauern von weniger als einer Sekunde werden mit dem Feld seconds = 0 und einem positiven oder negativen Feld nanos dargestellt. Bei Zeiträumen 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 (einschließlich).

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ä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
(deprecated)

enum (PrebuiltAmbientNoise)

Optional. Eingestellt: prebuilt_ambient_noise wurde zugunsten von prebuilt_ambient_sound eingestellt.
gcsUri

string

Optional. Umgebungsgeräusche als Mono-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 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 (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)
  }
}
Felder
redactionConfig

object (RedactionConfig)

Optional. Konfiguration, wie sensible Daten unkenntlich gemacht werden sollen.
audioRecordingConfig

object (AudioRecordingConfig)

Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen. Das Audio unterliegt der Entfernung gemäß der Konfiguration in RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

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 enabled ist, in der Regel zu Prüf- oder Überwachungszwecken.
bigqueryExportSettings

object (BigQueryExportSettings)

Optional. Konfiguriert das Verhalten des BigQuery-Exports für die App. Die Konversationsdaten werden gemäß der Konfiguration in RedactionConfig unkenntlich gemacht.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

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

object (CloudLoggingSettings)

Optional. Einstellungen zur Beschreibung des Cloud Logging-Verhaltens für die App.
conversationLoggingSettings

object (ConversationLoggingSettings)

Optional. Einstellungen, die das Verhalten der App beim Aufzeichnen von Unterhaltungen beschreiben.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen für die Auswertung. Standardmäßig ist die Audioaufnahme für Evaluationssitzungen nicht aktiviert.
metricAnalysisSettings

object (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

boolean

Optional. Bei „true“ wird die Entfernung in verschiedenen Logging-Szenarien angewendet, darunter Gesprächsablauf, Cloud Logging und Audioaufzeichnung.
inspectTemplate

string

Optional. Name der DLP-Prüfungsvorlage zum Konfigurieren der Erkennung sensibler Datentypen.

Format: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate

string

Optional. Name der DLP-De-Identifikationsvorlage, um anzugeben, 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, 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 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Berechtigung storage.objects.create erteilen.
gcsPathPrefix

string

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 $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 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 (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-Meldungen bei Systemfehlern (z.B. LLM-Fehler), die nach unterstütztem Sprachcode zugeordnet sind.

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, die unternommen werden sollen, bevor der Agent das EndSession-Signal 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,

  // 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 vom übergeordneten Agent.

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 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 (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
Felder
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

Optional. Die Grenzwerte für die Golden-Bewertungsmesswerte.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen golden_hallucination_metric_behavior. Das Verhalten des Halluzinationsmesswerts wird derzeit für Golden Evaluations verwendet.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Optional. Das Verhalten des Messwerts für Halluzinationen bei Golden Evaluations.
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 Messwerte auf Turn-Ebene.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Optional. Die Grenzwerte für die Messwerte für das Erwartungsniveau.
toolMatchingSettings

object (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 Golden-Erwartung entspricht.

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 semantische Ähnlichkeitschannel, 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 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 _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 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 (ExtraToolCallBehavior)
}
Felder
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Optional. Verhalten bei zusätzlichen Tool-Aufrufen. 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 Variablen.
schema

object (Schema)

Erforderlich. Das Schema der Variablen.

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 Eigenschaften 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. Steuert das Vorhandensein zusätzlicher Attribute.
anyOf[]

object (Schema)

Optional. Der Wert sollte anhand eines oder mehrerer der Unterschemas in der Liste validiert werden.
enum[]

string

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

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 Stamm-defs sein.

Das folgende Schema definiert beispielsweise eine Referenz auf einen Schemaknoten mit dem Namen „Pet“:

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

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

map (key: string, value: object (Schema))

Optional. Eine Karte mit 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. Maximaler Wert 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. Auch große Int64-Werte können nicht dargestellt werden, da das JSON-Format sie in seinem Zahlentyp generell 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 App.

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 ID des Channelprofils.
channelType

enum (ChannelType)

Optional. Der Typ des Channel-Profils.
personaProperty

object (PersonaProperty)

Optional. Die Persona-Eigenschaft des Kanalprofils.
webWidgetConfig

object (WebWidgetConfig)

Optional. Die Konfiguration für das Web-Widget.
whatsappConfig

object (WhatsAppConfig)

Optional. Konfiguration für WhatsApp-Bereitstellungen.
instagramConfig

object (InstagramConfig)

Optional. Konfiguration 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-Multifrequenz) 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 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 _noise_suppression_level.

Für _noise_suppression_level ist nur einer der folgenden Werte zulässig:
noiseSuppressionLevel

string

Optional. Der Grad der Geräuschunterdrückung des Kanalprofils. Verfügbare 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-Agent 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, auf der das Web-Widget geladen wird. Das Laden ist nur für denselben Ursprung oder einen der zulässigen Ursprünge zulässig.
allowedOrigins[]

string

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

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 Miniaturansicht-URL des Meta-Unternehmensprofils.
description

string

Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils.

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 Miniaturansicht-URL des Meta-Unternehmensprofils.
description

string

Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils.

MetadataEntry

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

string
value

string

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 Beginn des Headers und das Ende der Fußzeile enthalten.
privateKey

string

Erforderlich. Der Name der SecretManager-Secret-Versionsressource, in der der private Schlüssel im PEM-Format gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

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: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

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

string

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

string

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: projects/{project}/locations/{location}/dashboards/{dashboard}

Agent

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "modelSettings": {
    object (ModelSettings)
  },
  "instruction": string,
  "tools": [
    string
  ],
  "childAgents": [
    string
  ],
  "beforeAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "guardrails": [
    string
  ],
  "etag": string,
  "toolsets": [
    {
      object (AgentToolset)
    }
  ],
  "generatedSummary": string,
  "transferRules": [
    {
      object (TransferRule)
    }
  ],
  "validationErrors": [
    string
  ],

  // Union field agent_type can be only one of the following:
  "llmAgent": {
    object (LlmAgent)
  },
  "remoteDialogflowAgent": {
    object (RemoteDialogflowAgent)
  }
  // End of list of possible types for union field agent_type.
}
Felder
name

string

ID. Die eindeutige ID des Agents. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Erforderlich. Anzeigename des KI-Agenten.
description

string

Optional. Eine menschenlesbare Beschreibung des KI-Agenten.
modelSettings

object (ModelSettings)

Optional. Konfigurationen für das LLM-Modell.
instruction

string

Optional. Anweisungen für das LLM-Modell, um das Verhalten des KI-Agenten zu steuern.
tools[]

string

Optional. Liste der verfügbaren Tools für den Agenten. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
childAgents[]

string

Optional. Liste der untergeordneten Agents in der Agent-Baumstruktur. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
beforeAgentCallbacks[]

object (Callback)

Optional. Die Rückrufe, die vor dem Aufrufen des Agents ausgeführt werden sollen. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
afterAgentCallbacks[]

object (Callback)

Optional. Die Callbacks, die nach dem Aufrufen des Agenten ausgeführt werden sollen. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
beforeModelCallbacks[]

object (Callback)

Optional. Die Callbacks, die vor dem Aufrufen des Modells ausgeführt werden sollen. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
afterModelCallbacks[]

object (Callback)

Optional. Die Callbacks, die nach dem Aufrufen des Modells ausgeführt werden sollen. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
beforeToolCallbacks[]

object (Callback)

Optional. Die Callbacks, die vor dem Aufrufen des Tools ausgeführt werden sollen. Wenn mehrere Tool-Aufrufe vorhanden sind, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
afterToolCallbacks[]

object (Callback)

Optional. Die Callbacks, die nach dem Aufrufen des Tools ausgeführt werden sollen. Wenn mehrere Tool-Aufrufe vorhanden sind, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Agents.

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 des KI-Agents.

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".
guardrails[]

string

Optional. Liste der Richtlinien für den Agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag

string

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.
toolsets[]

object (AgentToolset)

Optional. Liste der Toolsets für den Agenten.
generatedSummary

string

Nur Ausgabe. Wenn der Agent vom LLM-Assistenten generiert wird, enthält dieses Feld eine beschreibende Zusammenfassung der Generierung.
transferRules[]

object (TransferRule)

Optional. Regeln für die Agent-Übertragung. Wenn mehrere Regeln übereinstimmen, wird die erste Regel in der Liste verwendet.
validationErrors[]

string

Nur Ausgabe. Fehlkonfigurationen oder Fehler im Agent, die sich auf die Qualität des Agents auswirken können.
Union-Feld agent_type. Der Typ des Agents. Für agent_type ist nur einer der folgenden Werte zulässig:
llmAgent

object (LlmAgent)

Optional. Der Standard-KI-Agententyp.
remoteDialogflowAgent

object (RemoteDialogflowAgent)

Optional. Der Remote-Dialogflow-Agent, der für die Ausführung des Agent verwendet werden soll. Wenn dieses Feld festgelegt ist, werden alle anderen Eigenschaften auf Agentenebene ignoriert.

Hinweis: Wenn sich der Dialogflow-Agent 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/dialogflow.client zuweisen.

RemoteDialogflowAgent

JSON-Darstellung 
{
  "agent": string,
  "flowId": string,
  "environmentId": string,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "respectResponseInterruptionSettings": boolean,
  "languageCodeVariable": string
}
Felder
agent

string

Erforderlich. Der Ressourcenname des Dialogflow-KI-Agenten. Format: projects/{project}/locations/{location}/agents/{agent}
flowId

string

Optional. Die Ablauf-ID des Ablaufs im Dialogflow-Agent.
environmentId

string

Optional. Die Umgebungs-ID des Dialogflow-Agents, der für die Ausführung des Agents verwendet werden soll. Wenn keine Angabe erfolgt, wird die Umgebung „Entwurf“ verwendet.
inputVariableMapping

map (key: string, value: string)

Optional. Die Zuordnung der Namen der App-Variablen zu den Namen der Dialogflow-Sitzungsparameter, die als Eingabe an den Dialogflow-Agent gesendet werden sollen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
outputVariableMapping

map (key: string, value: string)

Optional. Die Zuordnung der Namen der Dialogflow-Sitzungsparameter zu den Namen der App-Variablen, die nach Beendigung der Ausführung des Dialogflow-Agenten an den CES-Agenten zurückgesendet werden sollen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
respectResponseInterruptionSettings

boolean

Optional. Gibt an, ob die auf Nachrichtenebene konfigurierten Unterbrechungseinstellungen im Dialogflow-Agent berücksichtigt werden sollen.

  • Bei „false“: Alle Antwortnachrichten des Dialogflow-Agents folgen den Einstellungen für das Unterbrechen auf App-Ebene.
  • Wenn „true“: Nur Antwortnachrichten, bei denen allow_playback_interruption auf „true“ gesetzt ist, können unterbrochen werden. Für alle anderen Nachrichten gelten die Einstellungen für das Unterbrechen auf App-Ebene.
languageCodeVariable

string

Optional. Der Name der Variablen, die den Sprachcode für die Dialogflow-Sitzung enthält. Wenn nichts angegeben wird, wird der Standardsprachcode des Dialogflow-Agents verwendet.

InputVariableMappingEntry

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

string
value

string

OutputVariableMappingEntry

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

string
value

string

Rückruf

JSON-Darstellung 
{
  "description": string,
  "disabled": boolean,
  "proactiveExecutionEnabled": boolean,

  // Union field callback can be only one of the following:
  "pythonCode": string
  // End of list of possible types for union field callback.
}
Felder
description

string

Optional. Eine menschenlesbare Beschreibung des Rückrufs.
disabled

boolean

Optional. Gibt an, ob der Rückruf deaktiviert ist. Deaktivierte Rückrufe werden vom Kundenservicemitarbeiter ignoriert.
proactiveExecutionEnabled

boolean

Optional. Wenn aktiviert, wird der Callback auch für Zwischenausgaben des Modells ausgeführt. Diese Einstellung wirkt sich nur auf den „After Model“-Callback aus. MIT VORSICHT AKTIVIEREN. Normalerweise muss „after_model_callback“ erst nach dem Empfang aller Modellantworten ausgeführt werden. Die Aktivierung der proaktiven Ausführung kann sich negativ auf die Ausführungskosten und ‑latenz auswirken und sollte nur in seltenen Fällen aktiviert werden.
Union-Feld callback. Der auszuführende Callback. Für callback ist nur einer der folgenden Werte zulässig:
pythonCode

string

Erforderlich. Der Python-Code, der für den Callback ausgeführt werden soll.

AgentToolset

JSON-Darstellung 
{
  "toolset": string,
  "toolIds": [
    string
  ]
}
Felder
toolset

string

Erforderlich. Der Ressourcenname des Toolsets. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolIds[]

string

Optional. Die Tool-IDs zum Filtern des Toolsets.

TransferRule

JSON-Darstellung 
{
  "childAgent": string,
  "direction": enum (Direction),

  // Union field rule_type can be only one of the following:
  "deterministicTransfer": {
    object (DeterministicTransfer)
  },
  "disablePlannerTransfer": {
    object (DisablePlannerTransfer)
  }
  // End of list of possible types for union field rule_type.
}
Felder
childAgent

string

Erforderlich. Der Ressourcenname des untergeordneten Agenten, für den die Regel gilt. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

enum (Direction)

Erforderlich. Die Richtung der Übertragung.
Union-Feld rule_type. Der Regeltyp. Für rule_type ist nur einer der folgenden Werte zulässig:
deterministicTransfer

object (DeterministicTransfer)

Optional. Eine Regel, die sofort an den Ziel-Agent übertragen wird, wenn die Bedingung erfüllt ist.
disablePlannerTransfer

object (DisablePlannerTransfer)

Optional. Regel, die verhindert, dass der Planner an den Ziel-Agent übertragen wird.

DeterministicTransfer

JSON-Darstellung 
{

  // Union field condition_type can be only one of the following:
  "expressionCondition": {
    object (ExpressionCondition)
  },
  "pythonCodeCondition": {
    object (PythonCodeCondition)
  }
  // End of list of possible types for union field condition_type.
}
Felder
Union-Feld condition_type. Die auszuwertende Bedingung. Für condition_type ist nur einer der folgenden Werte zulässig:
expressionCondition

object (ExpressionCondition)

Optional. Eine Regel, die eine Bedingung für den Sitzungsstatus auswertet. Wenn die Bedingung als „true“ ausgewertet wird, erfolgt die Übertragung.
pythonCodeCondition

object (PythonCodeCondition)

Optional. Eine Regel, in der ein Python-Codeblock verwendet wird, um die Bedingungen auszuwerten. Wenn die Bedingung als „true“ ausgewertet wird, erfolgt die Übertragung.

ExpressionCondition

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

string

Erforderlich. Die String-Darstellung der Bedingung „cloud.api.Expression“.

PythonCodeCondition

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

string

Erforderlich. Der auszuführende Python-Code.

DisablePlannerTransfer

JSON-Darstellung 
{
  "expressionCondition": {
    object (ExpressionCondition)
  }
}
Felder
expressionCondition

object (ExpressionCondition)

Erforderlich. Wenn die Bedingung als „true“ ausgewertet wird, darf der Planer nicht zum Ziel-Kundenservicemitarbeiter weitergeleitet werden.

Tool

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field tool_type can be only one of the following:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of list of possible types for union field tool_type.
}
Felder
name

string

ID. Der Ressourcenname des Tools. Format:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} für eigenständige Tools.
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} für Tools, die aus einem Toolset abgerufen werden.

Diese Tools sind dynamisch und geben nur Ausgaben zurück. Sie können nicht direkt referenziert werden, wenn ein Tool erwartet wird.
displayName

string

Nur Ausgabe. Der Anzeigename des Tools, der auf dem Typ des Tools basiert. Der Anzeigename einer [ClientFunction][Tool.ClientFunction] wird beispielsweise aus der zugehörigen name-Eigenschaft abgeleitet.
executionType

enum (ExecutionType)

Optional. Der Ausführungstyp des Tools.
timeout

string (Duration format)

Optional. Das Zeitlimit für die Toolausführung. Wenn kein Wert festgelegt ist, beträgt das Standard-Zeitlimit 30 Sekunden für SYNCHRONOUS-Tools und 60 Sekunden für ASYNCHRONOUS-Tools.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Tools.

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 des Tools.

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

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

string

Nur Ausgabe. Wenn das Tool vom LLM-Assistenten generiert wird, enthält dieses Feld eine beschreibende Zusammenfassung der Generierung.
toolFakeConfig

object (ToolFakeConfig)

Optional. Konfiguration für das Verhalten von Tools im Fälschungsmodus.
Union-Feld tool_type. Der Typ des Tools. Für tool_type ist nur einer der folgenden Werte zulässig:
clientFunction

object (ClientFunction)

Optional. Die Clientfunktion.
openApiTool

object (OpenApiTool)

Optional. Das Open API-Tool.
googleSearchTool

object (GoogleSearchTool)

Optional. Das Tool für die Google Suche.
connectorTool

object (ConnectorTool)

Optional. Das Integration Connector-Tool
dataStoreTool

object (DataStoreTool)

Optional. Das Datenspeichertool.
pythonFunction

object (PythonFunction)

Optional. Das Python-Funktionstool.
mcpTool

object (McpTool)

Optional. Das MCP-Tool. Ein MCP-Tool kann nicht direkt erstellt oder aktualisiert werden, sondern wird vom MCP-Toolset verwaltet.
fileSearchTool

object (FileSearchTool)

Optional. Das Dateisuchtool.
systemTool

object (SystemTool)

Optional. Das Systemtool
agentTool

object (AgentTool)

Optional. Das Agent-Tool.
widgetTool

object (WidgetTool)

Optional. Das Widget-Tool
remoteAgentTool

object (RemoteAgentTool)

Optional. Das Remote-KI-Agenten-Tool.

ClientFunction

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  },
  "response": {
    object (Schema)
  }
}
Felder
name

string

Erforderlich. Der Name der Funktion.
description

string

Optional. Die Funktionsbeschreibung.
parameters

object (Schema)

Optional. Das Schema der Funktionsparameter.
response

object (Schema)

Optional. Das Schema der Funktionsantwort.

OpenApiTool

JSON-Darstellung 
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Felder
openApiSchema

string

Erforderlich. Das OpenAPI-Schema im JSON- oder YAML-Format.
name

string

Optional. Der Name des Tools. Wenn nicht angegeben, wird der Name des Tools aus dem OpenAPI-Schema abgeleitet, aus operation.operationId.
description

string

Optional. Die Beschreibung des Tools. Wenn sie nicht angegeben ist, wird die Beschreibung des Tools aus dem OpenAPI-Schema, aus operation.description oder aus operation.summary abgeleitet.
apiAuthentication

object (ApiAuthentication)

Optional. Von der API benötigte Authentifizierungsinformationen.
tlsConfig

object (TlsConfig)

Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration.
ignoreUnknownFields

boolean

Optional. Bei „true“ ignoriert der Agent unbekannte Felder in der API-Antwort.
url

string

Optional. Die Server-URL des Open API-Schemas. Dieses Feld wird in Tools in den Umgebungsabhängigkeiten während des Exportvorgangs nur festgelegt, wenn das Schema eine Server-URL enthält. Wenn diese URL während des Importvorgangs in den Umgebungsabhängigkeiten vorhanden ist und das Schema den Platzhalter $env_var enthält, wird der Platzhalter im Schema ersetzt.

ApiAuthentication

JSON-Darstellung 
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
Felder
Union-Feld auth_config. Die Authentifizierungskonfiguration. Für auth_config ist nur einer der folgenden Werte zulässig:
apiKeyConfig

object (ApiKeyConfig)

Optional. Konfiguration für die API-Schlüsselauthentifizierung.
oauthConfig

object (OAuthConfig)

Optional. Konfiguration für OAuth.
serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

Optional. Konfiguration für die ID-Token-Authentifizierung, die vom CES-Dienst-Agent generiert wurde.
serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

Optional. Konfiguration für die Dienstkontoauthentifizierung.
bearerTokenConfig

object (BearerTokenConfig)

Optional. Konfiguration für die Inhabertoken-Authentifizierung.

ApiKeyConfig

JSON-Darstellung 
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
Felder
keyName

string

Erforderlich. Der Parametername oder der Headername des API-Schlüssels. Beispiel: Wenn die API-Anfrage „https://example.com/act?X-Api-Key=“ lautet, ist „X-Api-Key“ der Parametername.
apiKeySecretVersion

string

Erforderlich. Der Name der Secret-Versionsressource des Secret Manager, in der der API-Schlüssel gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}

Hinweis: Sie sollten dem CES-Dienst-Agenten service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/secretmanager.secretAccessor zuweisen.
requestLocation

enum (RequestLocation)

Erforderlich. Schlüsselposition in der Anfrage.

OAuthConfig

JSON-Darstellung 
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
Felder
oauthGrantType

enum (OauthGrantType)

Erforderlich. OAuth-Berechtigungstypen.
clientId

string

Erforderlich. Die Client-ID des OAuth-Anbieters.
clientSecretVersion

string

Erforderlich. Der Name der SecretManager-Secret-Versionsressource, in der der Clientschlüssel gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}

Hinweis: Sie sollten dem CES-Dienst-Agenten service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/secretmanager.secretAccessor zuweisen.
tokenEndpoint

string

Erforderlich. Der Token-Endpunkt im OAuth-Anbieter, der gegen ein Zugriffstoken getauscht werden soll.
scopes[]

string

Optional. Die zu gewährenden OAuth-Bereiche.

ServiceAccountAuthConfig

JSON-Darstellung 
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
Felder
serviceAccount

string

Erforderlich. Die E‑Mail-Adresse des für die Authentifizierung verwendeten Dienstkontos. CES verwendet dieses Dienstkonto, um ein Zugriffstoken auszutauschen. Das Zugriffstoken wird dann im Authorization-Header der Anfrage gesendet.

Dem Dienstkonto muss die Rolle roles/iam.serviceAccountTokenCreator für den CES-Dienst-Agenten service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com zugewiesen sein.
scopes[]

string

Optional. Die zu gewährenden OAuth-Bereiche. Wenn nichts angegeben ist, wird der Standardbereich https://www.googleapis.com/auth/cloud-platform verwendet.

BearerTokenConfig

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

string

Erforderlich. Das Inhabertoken. Muss das Format $context.variables.<name_of_variable> aufweisen.

TlsConfig

JSON-Darstellung 
{
  "caCerts": [
    {
      object (CaCert)
    }
  ]
}
Felder
caCerts[]

object (CaCert)

Erforderlich. Gibt eine Liste der zulässigen benutzerdefinierten CA-Zertifikate für die HTTPS-Überprüfung an.

CaCert

JSON-Darstellung 
{
  "displayName": string,
  "cert": string
}
Felder
displayName

string

Erforderlich. Der Name der zulässigen benutzerdefinierten CA-Zertifikate. Damit können die benutzerdefinierten CA-Zertifikate eindeutig identifiziert werden.
cert

string (bytes format)

Erforderlich. Die zulässigen benutzerdefinierten CA-Zertifikate (im DER-Format) für die HTTPS-Überprüfung. Dadurch wird der Standard-SSL-Trust-Anchor überschrieben. Wenn dieses Feld leer oder nicht angegeben ist, verwendet CES den Standard-Trust Store von Google, um Zertifikate zu prüfen. Hinweis: Die HTTPS-Serverzertifikate müssen mit „subject alt name“ signiert sein. Ein Zertifikat kann beispielsweise mit dem folgenden Befehl selbst signiert werden:

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Ein base64-codierter String.

ServiceDirectoryConfig

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

string

Erforderlich. Der Name des Service Directory-Dienstes. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Der Speicherort des Dienstverzeichnisses muss mit dem Speicherort der App übereinstimmen.

GoogleSearchTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (PromptConfig)
  }
}
Felder
name

string

Erforderlich. Der Name des Tools.
description

string

Optional. Beschreibung des Zwecks des Tools.
contextUrls[]

string

Optional. Inhalte werden direkt von diesen URLs abgerufen, um Kontext und Fundierung zu erhalten. Beispiel: „https://beispiel.de/pfad.html“. Es sind maximal 20 URLs zulässig.
preferredDomains[]

string

Optional. Gibt Domains an, auf die Suchergebnisse beschränkt werden sollen. Beispiel: „beispiel.de“, „andere.website“. Es können maximal 20 Domains angegeben werden.
excludeDomains[]

string

Optional. Liste der Domains, die aus den Suchergebnissen ausgeschlossen werden sollen. Beispiel: „beispiel.de“ Es können maximal 2.000 Domains ausgeschlossen werden.
promptConfig

object (PromptConfig)

Optional. An den Planner übergebene Anweisungen für die Verarbeitung der Suchergebnisse für Text und Sprache.

PromptConfig

JSON-Darstellung 
{
  "textPrompt": string,
  "voicePrompt": string
}
Felder
textPrompt

string

Optional. Definiert den Prompt, der für die Systemanweisungen verwendet wird, wenn Sie in Chatunterhaltungen mit dem Agent interagieren. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
voicePrompt

string

Optional. Definiert den Prompt, der für die Systemanweisungen verwendet wird, wenn Sie in Sprachunterhaltungen mit dem Agent interagieren. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.

ConnectorTool

JSON-Darstellung 
{
  "connection": string,
  "action": {
    object (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
Felder
connection

string

Erforderlich. Der vollständige Ressourcenname der referenzierten Integration Connectors-Verbindung. Format: projects/{project}/locations/{location}/connections/{connection}
action

object (Action)

Erforderlich. Aktion für das zu verwendende Tool.
authConfig

object (EndUserAuthConfig)

Optional. Konfiguriert, wie die Authentifizierung in Integration Connectors gehandhabt wird. Standardmäßig wird eine Administratorauthentifizierung in den Integration Connectors API-Anfragen übergeben. Sie können sie mit einer anderen Konfiguration für die Endnutzerauthentifizierung überschreiben. Hinweis: Für die Verbindung muss die Authentifizierungsüberschreibung aktiviert sein, damit hier eine EUC-Konfiguration angegeben werden kann. Andernfalls schlägt die ConnectorTool-Erstellung fehl. Weitere Informationen finden Sie unter https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
name

string

Optional. Der Name des Tools, das vom Agent verwendet werden kann, um zu entscheiden, ob dieses ConnectorTool aufgerufen werden soll.
description

string

Optional. Die Beschreibung des Tools, anhand derer der Agent entscheiden kann, ob dieses ConnectorTool aufgerufen werden soll.

Aktion

JSON-Darstellung 
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
Felder
inputFields[]

string

Optional. Entitätsfelder, die als Eingaben für den Vorgang verwendet werden sollen. Wenn keine Felder angegeben sind, werden alle Felder der Entität verwendet.
outputFields[]

string

Optional. Entitätsfelder, die vom Vorgang zurückgegeben werden sollen. Wenn keine Felder angegeben sind, werden alle Felder der Entität zurückgegeben.
Union-Feld action_spec. Spezifikation für eine Aktion, die für das zu verwendende Tool konfiguriert werden soll. Für action_spec ist nur einer der folgenden Werte zulässig:
connectionActionId

string

ID einer Verbindungsaktion für das zu verwendende Tool.
entityOperation

object (EntityOperation)

Konfiguration für den Entitätsvorgang, die vom Tool verwendet werden soll.

EntityOperation

JSON-Darstellung 
{
  "entityId": string,
  "operation": enum (OperationType)
}
Felder
entityId

string

Erforderlich. ID der Entität.
operation

enum (OperationType)

Erforderlich. Vorgang, der für die Entität ausgeführt werden soll.

EndUserAuthConfig

JSON-Darstellung 
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
Felder
Union-Feld auth_config. Die Authentifizierungskonfiguration. Für auth_config ist nur einer der folgenden Werte zulässig:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

Oauth 2.0-Authentifizierung mit Autorisierungscode.
oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

Authentifizierung mit OAuth 2.0-Berechtigungstyp zur Autorisierung mit JWT-Profil.

Oauth2AuthCodeConfig

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

string

Erforderlich. Name des OAuth-Tokenparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.

Oauth2JwtBearerConfig

JSON-Darstellung 
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
Felder
issuer

string

Erforderlich. Name des Ausstellerparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.
subject

string

Erforderlich. Name des Inhaberparameters, der weitergegeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.
clientKey

string

Erforderlich. Name des Clientparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.

DataStoreTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (FilterParameterBehavior),

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
Felder
name

string

Erforderlich. Der Name des Datenspeicher-Tools.
description

string

Optional. Die Tool-Beschreibung.
boostSpecs[]

object (BoostSpecs)

Optional. Mit der Boost-Spezifikation können Sie bestimmte Dokumente hervorheben.
modalityConfigs[]

object (ModalityConfig)

Optional. Die Modalitätskonfigurationen für den Datenspeicher.
filterParameterBehavior

enum (FilterParameterBehavior)

Optional. Das Verhalten des Filterparameters.
Union-Feld search_source. Definiert die Suchquelle, entweder einen einzelnen DataStore oder eine Engine. Für search_source ist nur einer der folgenden Werte zulässig:
dataStoreSource

object (DataStoreSource)

Optional. In einem einzelnen bestimmten Datenspeicher suchen.
engineSource

object (EngineSource)

Optional. Suche innerhalb einer Engine (möglicherweise in mehreren Datenspeichern).

DataStoreSource

JSON-Darstellung 
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
Felder
filter

string

Optional. Filterspezifikation für den DataStore. Weitere Informationen finden Sie unter https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.
dataStore

object (DataStore)

Optional. Der Datenspeicher.

Datastore

JSON-Darstellung 
{
  "name": string,
  "type": enum (DataStoreType),
  "documentProcessingMode": enum (DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (ConnectorConfig)
  }
}
Felder
name

string

Erforderlich. Vollständiger Ressourcenname des DataStore. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

enum (DataStoreType)

Nur Ausgabe. Der Typ des Datenspeichers. Dieses Feld ist schreibgeschützt und wird vom Server ausgefüllt.
documentProcessingMode

enum (DocumentProcessingMode)

Nur Ausgabe. Der Dokumentverarbeitungsmodus für die Datenspeicherverbindung. Wird nur für PUBLIC_WEB- und UNSTRUCTURED-Datenspeicher festgelegt.
displayName

string

Nur Ausgabe. Der Anzeigename des Datenspeichers.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Datenspeichers.

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"
connectorConfig

object (ConnectorConfig)

Nur Ausgabe. Die Connector-Konfiguration für die Datenspeicherverbindung.

ConnectorConfig

JSON-Darstellung 
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
Felder
collection

string

Der Ressourcenname der Sammlung, zu der der Datenspeicher gehört.
collectionDisplayName

string

Der Anzeigename der Sammlung, zu der der Datenspeicher gehört.
dataSource

string

Der Name der Datenquelle. Beispiel: salesforce, jira, confluence, bigquery.

EngineSource

JSON-Darstellung 
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreSource)
    }
  ],
  "filter": string
}
Felder
engine

string

Erforderlich. Vollständiger Ressourcenname der Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
dataStoreSources[]

object (DataStoreSource)

Optional. Damit können Sie bestimmte DataStores innerhalb der Engine als Ziel auswählen. Wenn das Feld leer ist, wird die Suche auf alle DataStores angewendet, die mit der Engine verknüpft sind.
filter

string

Optional. Ein Filter, der auf die Suche in der Engine angewendet wird. Nicht relevant und wird nicht verwendet, wenn „data_store_sources“ angegeben ist. Weitere Informationen finden Sie unter https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.

BoostSpecs

JSON-Darstellung 
{
  "dataStores": [
    string
  ],
  "spec": [
    {
      object (BoostSpec)
    }
  ]
}
Felder
dataStores[]

string

Erforderlich. Der Datenspeicher, auf den die Konfiguration für die Steigerung angewendet wird. Vollständiger Ressourcenname des Datenspeichers, z. B. „projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}“.
spec[]

object (BoostSpec)

Erforderlich. Eine Liste mit Spezifikationen für das Boosting.

BoostSpec

JSON-Darstellung 
{
  "conditionBoostSpecs": [
    {
      object (ConditionBoostSpec)
    }
  ]
}
Felder
conditionBoostSpecs[]

object (ConditionBoostSpec)

Erforderlich. Eine Liste mit Spezifikationen für das Boosting.

ConditionBoostSpec

JSON-Darstellung 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
Felder
condition

string

Erforderlich. Der Ausdruck für eine Boost-Bedingung. Die Syntax ist dieselbe wie die Syntax für Filterausdrücke. Derzeit wird nur eine Liste von BCP-47-Sprachcodes als Bedingung unterstützt. Beispiel: So verbessern Sie Vorschläge in den Sprachen „en“ oder „fr“: (lang_code: ANY("en", "fr"))
boost

number

Optional. Stärke des Boostings, das im Bereich [-1, 1] liegen sollte. Negatives Boosting bedeutet Abwertung. Der Standardwert ist 0,0.

Wenn Sie den Wert auf 1,0 setzen, werden die Vorschläge deutlich hochgestuft. Das bedeutet jedoch nicht, dass das Top-Ergebnis immer ein geboosteter Vorschlag ist.

Wenn Sie den Wert auf -1,0 setzen, werden die Vorschläge stark herabgestuft. Es werden jedoch möglicherweise weiterhin andere relevante Vorschläge angezeigt.

Wenn Sie den Wert auf 0,0 festlegen, wird kein Boosting angewendet. Die Boost-Bedingung wird ignoriert.
boostControlSpec

object (BoostControlSpec)

Optional. Komplexe Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden definierten Attributwert.

BoostControlSpec

JSON-Darstellung 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Felder
fieldName

string

Optional. Der Name des Feldes, dessen Wert zur Bestimmung des Boost-Betrags verwendet wird.
attributeType

enum (AttributeType)

Optional. Der Attributtyp, der zum Ermitteln des Boost-Betrags verwendet werden soll. Der Attributwert kann aus dem Feldwert des angegebenen „field_name“ abgeleitet werden. Bei numerischen Werten ist das ganz einfach: attribute_value = numerical_field_value. Bei der Aktualität gilt jedoch: attribute_value = (time.now() – datetime_field_value).
interpolationType

enum (InterpolationType)

Optional. Der Interpolationstyp, der zum Verbinden der unten aufgeführten Kontrollpunkte verwendet wird.
controlPoints[]

object (ControlPoint)

Optional. Die Kontrollpunkte, mit denen die Kurve definiert wird. Die monotone Funktion (die oben über „interpolation_type“ definiert wurde) geht durch die hier aufgeführten Kontrollpunkte.

ControlPoint

JSON-Darstellung 
{
  "attributeValue": string,
  "boostAmount": number
}
Felder
attributeValue

string

Optional. Kann einer der folgenden Werte sein: 1. Der numerische Feldwert. 2. Die Dauerangabe für die Aktualität: Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]].
boostAmount

number

Optional. Der Wert zwischen -1 und 1, der angibt, um wieviel die Punktzahl erhöht werden soll, wenn „attribute_value“ dem oben angegebenen Wert entspricht.

ModalityConfig

JSON-Darstellung 
{
  "modalityType": enum (ModalityType),
  "rewriterConfig": {
    object (RewriterConfig)
  },
  "summarizationConfig": {
    object (SummarizationConfig)
  },
  "groundingConfig": {
    object (GroundingConfig)
  },
  "snippetsConfig": {
    object (SnippetsConfig)
  }
}
Felder
modalityType

enum (ModalityType)

Erforderlich. Der Modalitätstyp.
rewriterConfig

object (RewriterConfig)

Optional. Die Rewriter-Konfiguration.
summarizationConfig

object (SummarizationConfig)

Optional. Die Zusammenfassungskonfiguration.
groundingConfig

object (GroundingConfig)

Optional. Die Fundierungskonfiguration.
snippetsConfig

object (SnippetsConfig)

Optional. Die Snippets-Konfiguration.

RewriterConfig

JSON-Darstellung 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Felder
modelSettings

object (ModelSettings)

Erforderlich. Konfigurationen für das LLM-Modell.
prompt

string

Optional. Die Prompt-Definition. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
disabled

boolean

Optional. Gibt an, ob der Rewriter deaktiviert ist.

SummarizationConfig

JSON-Darstellung 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Felder
modelSettings

object (ModelSettings)

Optional. Konfigurationen für das LLM-Modell.
prompt

string

Optional. Die Prompt-Definition. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
disabled

boolean

Optional. Gibt an, ob die Zusammenfassung deaktiviert ist.

GroundingConfig

JSON-Darstellung 
{
  "groundingLevel": number,
  "disabled": boolean
}
Felder
groundingLevel

number

Optional. Der Fundierungsschwellenwert der Antwort basierend auf den abgerufenen Quellen. Der Wert hat einen konfigurierbaren Bereich von [1, 5]. Mit der Ebene wird die Fundierung der Antwort begrenzt. Das bedeutet, dass bei allen Antworten mit einem Fundierungswert unter dem Schwellenwert nur relevante Snippets zurückgegeben werden.

Wenn der Wert beispielsweise 3 ist, muss der Fundierungs-Score mindestens 3 betragen, damit die Antwort zurückgegeben wird.
disabled

boolean

Optional. Gibt an, ob die Fundierung deaktiviert ist.

SnippetsConfig

JSON-Darstellung 
{
  "enableSnippets": boolean,
  "maxSnippets": integer
}
Felder
enableSnippets

boolean

Optional. Gibt an, ob Snippets aktiviert sind.
maxSnippets

integer

Optional. Anzahl der Snippets, die pro Anfrage zurückgegeben werden sollen. Wenn nicht festgelegt, werden standardmäßig alle Snippets des Dienstes zurückgegeben.

PythonFunction

JSON-Darstellung 
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
Felder
name

string

Optional. Der Name der auszuführenden Python-Funktion. Muss mit einem im Python-Code definierten Python-Funktionsnamen übereinstimmen. Groß- und Kleinschreibung wird berücksichtigt. Wenn der Name nicht angegeben ist, wird die erste im Python-Code definierte Funktion verwendet.
pythonCode

string

Optional. Der Python-Code, der für das Tool ausgeführt werden soll.
description

string

Nur Ausgabe. Die Beschreibung der Python-Funktion, die aus dem Docstring des Python-Codes geparst wurde.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration für das Tool.

McpTool

JSON-Darstellung 
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (State)
}
Felder
name

string

Erforderlich. Der Name des MCP-Tools.
nameOverride

string

Optional. Die Namensüberschreibung des MCP-Tools. Dieses Feld wird ausgefüllt, wenn der Name durch eine Toolset-Überschreibung überschrieben wurde.
description

string

Optional. Die Beschreibung des MCP-Tools.
inputSchema

object (Schema)

Optional. Das Schema der Eingabeargumente des MCP-Tools.
outputSchema

object (Schema)

Optional. Das Schema der Ausgabeargumente des MCP-Tools.
serverAddress

string

Erforderlich. Die Serveradresse des MCP-Servers, z.B. „https://example.com/mcp/“. Wenn der Server mit dem MCP SDK erstellt wurde, sollte die URL mit „/mcp/“ enden. Es werden nur Streamable HTTP-Transport-basierte Server unterstützt. Dies entspricht der server_address im McpToolset. Weitere Informationen finden Sie unter https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

Optional. Authentifizierungsinformationen, die zum Ausführen des Tools auf dem MCP-Server erforderlich sind. Bei der Bearer-Token-Authentifizierung gilt das Token nur für die Ausführung von Tools, nicht für die Auflistung von Tools. Dazu müssen Tools ohne Authentifizierung aufgeführt werden können.
tlsConfig

object (TlsConfig)

Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration für VPC-SC, die zum Auflösen von Dienstnamen innerhalb eines Perimeters verwendet wird.
customHeaders

map (key: string, value: string)

Optional. Die benutzerdefinierten Header, die in der Anfrage an den MCP-Server gesendet werden sollen. Die Werte müssen das Format $context.variables.<name_of_variable> haben und können in den Sitzungsvariablen festgelegt werden. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Nur Ausgabe. Der dynamische Verfügbarkeitsstatus des Tools auf dem externen Server.

CustomHeadersEntry

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

string
value

string

FileSearchTool

JSON-Darstellung 
{
  "corpusType": enum (CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
Felder
corpusType

enum (CorpusType)

Optional. Der Typ des Korpus. Der Standardwert ist FULLY_MANAGED.
name

string

Erforderlich. Der Name des Tools.
description

string

Optional. Die Tool-Beschreibung.
fileCorpus

string

Optional. Das Corpus, in dem Dateien gespeichert werden. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

SystemTool

JSON-Darstellung 
{
  "name": string,
  "description": string
}
Felder
name

string

Erforderlich. Der Name des Systemtools.
description

string

Nur Ausgabe. Die Beschreibung des Systemtools.

AgentTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "agent": string
}
Felder
name

string

Erforderlich. Der Name des Agent-Tools.
description

string

Optional. Beschreibung des Zwecks des Tools.
agent

string

Optional. Der Ressourcenname des KI-Agenten, der der Einstiegspunkt des Tools ist. Format: projects/{project}/locations/{location}/agents/{agent}

WidgetTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
Felder
name

string

Erforderlich. Der Anzeigename des Widget-Tools.
description

string

Optional. Die Beschreibung des Widget-Tools.
widgetType

enum (WidgetType)

Optional. Der Typ des Widget-Tools. Wenn keine Angabe erfolgt, wird der Standardtyp CUSTOMIZED verwendet.
uiConfig

object (Struct format)

Optional. Konfiguration für das Rendern des Widgets.
dataMapping

object (DataMapping)

Optional. Die Zuordnung, die definiert, wie Daten aus einem Quelltool den Eingabeparametern des Widgets zugeordnet werden.
textResponseConfig

object (TextResponseConfig)

Optional. Konfiguration für Textantworten, die immer enthalten sind.
Union-Feld input. Die Eingabe des Widget-Tools. Für input ist nur einer der folgenden Werte zulässig:
parameters

object (Schema)

Optional. Die Eingabeparameter des Widget-Tools.

DataMapping

JSON-Darstellung 
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (Mode),
  "pythonScript": string
}
Felder
sourceToolName

string

Optional. Der Ressourcenname des Tools, das die Daten für das Widget bereitstellt, z.B. ein Suchtool oder eine benutzerdefinierte Funktion. Format: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
fieldMappings

map (key: string, value: string)

Optional. Eine Zuordnung von Widget-Eingabeparameterfeldern zu den entsprechenden Ausgabefeldern des Quelltools.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
pythonFunction

object (PythonFunction)

Optional. Konfiguration für eine Python-Funktion, mit der die Ausgabe des Quelltools in das Eingabeformat des Widgets transformiert wird.
mode

enum (Mode)

Optional. Der Modus des Datenabgleichs.
pythonScript
(deprecated)

string

Nicht mehr unterstützt: Verwenden Sie stattdessen python_function.

FieldMappingsEntry

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

string
value

string

TextResponseConfig

JSON-Darstellung 
{
  "type": enum (Type),
  "staticText": string,
  "textResponseInstruction": string
}
Felder
type

enum (Type)

Optional. Die Strategie für die Bereitstellung der Textantwort.
staticText

string

Optional. Die statische Textantwort, die zurückgegeben werden soll, wenn der Typ STATIC ist.
textResponseInstruction

string

Optional. Anweisung für das LLM, wie die Textantwort generiert werden soll. Wird als Beschreibung für den Textantwortparameter verwendet, wenn der Typ LLM_GENERATED ist.

RemoteAgentTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  },
  "apiAuthentication": {
    object (ApiAuthentication)
  }
}
Felder
name

string

Erforderlich. Der Name des Tools.
description

string

Erforderlich. Die Beschreibung des Tools.
agentCard

object (AgentCard)

Erforderlich. Die Agentenkarte des Remote-Agenten, der von diesem Tool aufgerufen wird.
apiAuthentication

object (ApiAuthentication)

Optional. Authentifizierungskonfiguration für den Aufruf des Remote-Agents.

AgentCard

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
Felder
name

string

Erforderlich. Ein menschenlesbarer Name für den KI-Agenten.
description

string

Erforderlich. Eine Beschreibung des Handlungs- bzw. Lösungsbereichs des KI-Agenten.
supportedInterfaces[]

object (AgentInterface)

Erforderlich. Geordnete Liste der unterstützten Schnittstellen. Der erste Eintrag wird bevorzugt.
version

string

Erforderlich. Die Version des Agents.
skills[]

object (AgentSkill)

Erforderlich. Skills stellen eine Einheit von Fähigkeiten dar, die ein Agent ausführen kann. Das ist zwar etwas abstrakt, stellt aber eine gezieltere Reihe von Aktionen dar, die der Agent mit hoher Wahrscheinlichkeit ausführen kann.

AgentInterface

JSON-Darstellung 
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
Felder
url

string

Erforderlich. Die URL, unter der diese Schnittstelle verfügbar ist. Muss in der Produktion eine gültige absolute HTTPS-URL sein. Beispiel: „https://api.beispiel.de/a2a/v1“, „https://grpc.beispiel.de/a2a“
protocolBinding

string

Erforderlich. Die an dieser URL unterstützte Protokollbindung. Dies ist ein offener Formularstring, der sich leicht für andere Protokollbindungen erweitern lässt. Die offiziell unterstützten Kern-Frameworks sind JSONRPC, GRPC und HTTP+JSON.
tenant

string

Die Mandanten-ID, die in der Anfrage verwendet werden soll, wenn der Agent aufgerufen wird.
protocolVersion

string

Erforderlich. Die Version des A2A Protocol, das von dieser Schnittstelle bereitgestellt wird. Verwenden Sie die neueste unterstützte Nebenversion pro Hauptversion. Beispiele: „0.3“, „1.0“

AgentSkill

JSON-Darstellung 
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
Felder
id

string

Erforderlich. Eine eindeutige Kennung für die Funktion des Agents.
name

string

Erforderlich. Ein für Menschen lesbarer Name für den Skill.
description

string

Erforderlich. Eine detaillierte Beschreibung des Skills.
tags[]

string

Erforderlich. Eine Reihe von Keywords, die die Fähigkeiten des Skills beschreiben.
examples[]

string

Beispiel-Prompts oder ‑Szenarien, die mit dieser Skill bearbeitet werden können.
inputModes[]

string

Die Menge der unterstützten Eingabemedientypen für diesen Skill, die die Standardeinstellungen des Agenten überschreiben.
outputModes[]

string

Die Menge der unterstützten Ausgabemedientypen für diesen Skill, die die Standardeinstellungen des Agenten überschreiben.

ToolFakeConfig

JSON-Darstellung 
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
Felder
enableFakeMode

boolean

Optional. Gibt an, ob das Tool den Fiktivmodus verwendet.
Union-Feld tool_response. Die Antwort ist entweder statisch oder wird von einer Python-Funktion bereitgestellt. Für tool_response ist nur einer der folgenden Werte zulässig:
codeBlock

object (CodeBlock)

Optional. Codeblock, der anstelle eines echten Tool-Aufrufs ausgeführt wird.

CodeBlock

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

string

Erforderlich. Python-Code, der im Tool-Fake-Modus aufgerufen wird. Erwartete Python-Funktionssignatur: Um alle Tool-Aufrufe abzufangen: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Um einen bestimmten Tool-Aufruf abzufangen: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Wenn die Funktion „None“ zurückgibt, wird stattdessen das echte Tool aufgerufen.

Beispiel

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "entryAgent": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "invalid": boolean,
  "etag": string
}
Felder
name

string

ID. Die eindeutige ID des Beispiels. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
displayName

string

Erforderlich. Anzeigename des Beispiels.
description

string

Optional. Eine menschenlesbare Beschreibung des Beispiels.
entryAgent

string

Optional. Der Agent, der die Unterhaltung ursprünglich bearbeitet. Wenn nichts angegeben ist, wird das Beispiel für eine Unterhaltung verwendet, die vom Stamm-Agent bearbeitet wird. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]

object (Message)

Optional. Die Sammlung von Nachrichten, aus denen die Unterhaltung besteht.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Beispiels.

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 des Beispiels.

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"
invalid

boolean

Nur Ausgabe. Das Beispiel kann ungültig werden, wenn referenzierte Ressourcen gelöscht werden. Ungültige Beispiele werden nicht als Few-Shot-Beispiele verwendet.
etag

string

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.

Nachricht

JSON-Darstellung 
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
Felder
role

string

Optional. Die Rolle in der Unterhaltung, z.B. „user“ (Nutzer) oder „agent“ (Agent).
chunks[]

object (Chunk)

Optional. Inhalt der Nachricht als Reihe von Chunks.
eventTime

string (Timestamp format)

Optional. Zeitstempel für das Senden oder Empfangen der Nachricht. Sollte nicht verwendet werden, wenn die Nachricht Teil einer example ist.

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

Chunk

JSON-Darstellung 
{

  // Union field data can be only one of the following:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of list of possible types for union field data.
}
Felder
Union-Feld data. Daten in Blöcke aufteilen. Für data ist nur einer der folgenden Werte zulässig:
text

string

Optional. Textdaten.
transcript

string

Optional. Transkript, das mit dem Audio verknüpft ist.
blob

object (Blob)

Optional. Blob-Daten.
payload

object (Struct format)

Optional. Benutzerdefinierte Nutzlastdaten.
image

object (Image)

Optional. Bilddaten.
toolCall

object (ToolCall)

Optional. Anfrage zur Toolausführung.
toolResponse

object (ToolResponse)

Optional. Antwort auf die Toolausführung.
agentTransfer

object (AgentTransfer)

Optional. Ereignis für die Übertragung von Agenten.
updatedVariables

object (Struct format)

Ein Struct stellt Variablen dar, die in der Unterhaltung aktualisiert wurden, wobei die Variablennamen als Schlüssel verwendet werden.
defaultVariables

object (Struct format)

Eine Struktur stellt Standardvariablen zu Beginn der Unterhaltung dar, die nach Variablennamen sortiert sind.

Blob

JSON-Darstellung 
{
  "mimeType": string,
  "data": string
}
Felder
mimeType

string

Erforderlich. Der IANA-Standard-MIME-Typ der Quelldaten.
data

string (bytes format)

Erforderlich. Rohbyte des Blobs.

Ein base64-codierter String.

Bild

JSON-Darstellung 
{
  "mimeType": string,
  "data": string
}
Felder
mimeType

string

Erforderlich. Der IANA-Standard-MIME-Typ der Quelldaten. Unterstützte Bildtypen: * image/png * image/jpeg * image/webp
data

string (bytes format)

Erforderlich. Rohbyte des Bildes.

Ein base64-codierter String.

ToolCall

JSON-Darstellung 
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Felder
id

string

Optional. Die eindeutige ID des Tool-Aufrufs. Wenn das Feld ausgefüllt ist, sollte der Client das Ausführungsergebnis mit der ID zum Abgleich in ToolResponse zurückgeben.
displayName

string

Nur Ausgabe. Anzeigename des Tools.
args

object (Struct format)

Optional. Die Eingabeparameter und ‑werte für das Tool im JSON-Objektformat.
parentToolCallId

string

Nur Ausgabe. Die ID des Tool-Aufrufs, der diesen Aufruf verursacht hat, wenn er von einem untergeordneten Agenten im Namen eines übergeordneten Aufrufs ausgegeben wurde. Leer für Aufrufe der obersten Ebene. Ermöglicht es einem Client, die Arbeit eines untergeordneten Agents unter dem Aufruf zu gruppieren, der ihn gestartet hat, anstatt jeden Schritt als gleichgeordnetes Element darzustellen.
agentName

string

Nur Ausgabe. Ein menschenlesbarer Name des KI-Agenten, der diesen Aufruf ausgegeben hat, z.B. „Contract Architect“. Leer, wenn der Root-Agent die Anfrage gestellt hat.
Union-Feld tool_identifier. Die Kennung des auszuführenden Tools. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool

string

Optional. Der Name des auszuführenden Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Optional. Das Toolset-Tool, das ausgeführt werden soll.

ToolsetTool

JSON-Darstellung 
{
  "toolset": string,
  "toolId": string
}
Felder
toolset

string

Erforderlich. Der Ressourcenname des Toolsets, aus dem dieses Tool abgeleitet wird. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolId

string

Optional. Die Tool-ID, nach der die Tools gefiltert werden sollen, um das Schema abzurufen.

ToolResponse

JSON-Darstellung 
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Felder
id

string

Optional. Die ID zum Abgleich des tool call, auf den sich die Antwort bezieht.
displayName

string

Nur Ausgabe. Anzeigename des Tools.
response

object (Struct format)

Erforderlich. Das Ergebnis der Tool-Ausführung im JSON-Objektformat. Verwenden Sie den Schlüssel „output“, um die Tool-Antwort anzugeben, und den Schlüssel „error“, um Fehlerdetails anzugeben (falls vorhanden). Wenn die Schlüssel „output“ und „error“ nicht angegeben sind, wird die gesamte „response“ als Ergebnis der Tool-Ausführung behandelt.
parentToolCallId

string

Nur Ausgabe. Die ID des Tool-Aufrufs, der diesen Aufruf verursacht hat, wenn er von einem untergeordneten Agenten im Namen eines übergeordneten Aufrufs ausgegeben wurde. Leer für Aufrufe der obersten Ebene. Ermöglicht es einem Client, die Arbeit eines untergeordneten Agents unter dem Aufruf zu gruppieren, der ihn gestartet hat, anstatt jeden Schritt als gleichgeordnetes Element darzustellen.
agentName

string

Nur Ausgabe. Ein menschenlesbarer Name des KI-Agenten, der diesen Aufruf ausgegeben hat, z.B. „Contract Architect“. Leer, wenn der Root-Agent die Anfrage gestellt hat.
Union-Feld tool_identifier. Die Kennung des Tools, das ausgeführt wurde. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool

string

Optional. Der Name des auszuführenden Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Optional. Das Toolset-Tool, das ausgeführt wurde.

AgentTransfer

JSON-Darstellung 
{
  "targetAgent": string,
  "displayName": string
}
Felder
targetAgent

string

Erforderlich. Der Agent, an den die Unterhaltung übertragen wird. Der Agent übernimmt die Unterhaltung ab diesem Punkt. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Nur Ausgabe. Anzeigename des KI-Agenten.

Schutzmaßnahme

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "enabled": boolean,
  "action": {
    object (TriggerAction)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field guardrail_type can be only one of the following:
  "contentFilter": {
    object (ContentFilter)
  },
  "llmPromptSecurity": {
    object (LlmPromptSecurity)
  },
  "llmPolicy": {
    object (LlmPolicy)
  },
  "modelSafety": {
    object (ModelSafety)
  },
  "codeCallback": {
    object (CodeCallback)
  }
  // End of list of possible types for union field guardrail_type.
}
Felder
name

string

ID. Die eindeutige ID der Richtlinie. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
displayName

string

Erforderlich. Anzeigename der Richtlinie.
description

string

Optional. Beschreibung der Richtlinie.
enabled

boolean

Optional. Gibt an, ob die Schutzvorrichtung aktiviert ist.
action

object (TriggerAction)

Optional. Aktion, die ausgeführt werden soll, wenn die Richtlinie ausgelöst wird.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung der Richtlinie.

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

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

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.
Union-Feld guardrail_type. Art der Schutzmaßnahme. Für guardrail_type ist nur einer der folgenden Werte zulässig:
contentFilter

object (ContentFilter)

Optional. Schutzmechanismus, der verhindert, dass bestimmte Inhalte in der Unterhaltung verwendet werden.
llmPromptSecurity

object (LlmPromptSecurity)

Optional. Schutzfunktion, die die Unterhaltung blockiert, wenn der Prompt basierend auf der LLM-Klassifizierung als unsicher eingestuft wird.
llmPolicy

object (LlmPolicy)

Optional. Guardrail, die die Unterhaltung blockiert, wenn die LLM-Antwort basierend auf der LLM-Klassifizierung als Richtlinienverstoß eingestuft wird.
modelSafety

object (ModelSafety)

Optional. Guardrail, die die Unterhaltung blockiert, wenn die LLM-Antwort basierend auf den Sicherheitseinstellungen des Modells als unsicher eingestuft wird.
codeCallback

object (CodeCallback)

Optional. Guardrail, die die Unterhaltung basierend auf dem Ergebnis der Callback-Ausführung möglicherweise blockiert.

ContentFilter

JSON-Darstellung 
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean
}
Felder
bannedContents[]

string

Optional. Liste verbotener Ausdrücke. Gilt sowohl für Nutzereingaben als auch für Antworten von KI-Agenten.
bannedContentsInUserInput[]

string

Optional. Liste verbotener Ausdrücke. Gilt nur für Nutzereingaben.
bannedContentsInAgentResponse[]

string

Optional. Liste verbotener Ausdrücke. Gilt nur für Antworten von Kundenservicemitarbeitern.
matchType

enum (MatchType)

Erforderlich. Keyword-Option für den Inhaltsfilter.
disregardDiacritics

boolean

Optional. Wenn der Wert „true“ ist, werden diakritische Zeichen beim Abgleich ignoriert.

LlmPromptSecurity

JSON-Darstellung 
{
  "failOpen": boolean,

  // Union field security_config can be only one of the following:
  "defaultSettings": {
    object (DefaultSecuritySettings)
  },
  "customPolicy": {
    object (LlmPolicy)
  }
  // End of list of possible types for union field security_config.
}
Felder
failOpen

boolean

Optional. Bestimmt das Verhalten, wenn bei der Schutzmaßnahme ein LLM-Fehler auftritt. – Bei „true“ wird die Schutzvorrichtung umgangen. – „false“ (Standard): Die Richtlinie wird ausgelöst bzw. blockiert.

Hinweis: Wenn eine benutzerdefinierte Richtlinie angegeben wird, wird dieses Feld zugunsten der „fail_open“-Konfiguration der Richtlinie ignoriert.
Union-Feld security_config. Definiert den Modus der Sicherheitskonfiguration. Der Nutzer muss eine der folgenden Konfigurationen auswählen. Für security_config ist nur einer der folgenden Werte zulässig:
defaultSettings

object (DefaultSecuritySettings)

Optional. Die vordefinierten Standardsicherheitseinstellungen des Systems verwenden. Wenn Sie diesen Modus auswählen möchten, fügen Sie eine leere „default_settings“-Nachricht in die Anfrage ein. Das Feld „default_prompt_template“ wird vom Server in der Antwort ausgefüllt.
customPolicy

object (LlmPolicy)

Optional. Verwenden Sie eine benutzerdefinierte LlmPolicy, um den Sicherheitsmechanismus zu konfigurieren.

DefaultSecuritySettings

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

string

Nur Ausgabe. Die vom System verwendete Standardvorlage für Prompts. Dieses Feld dient dazu, dem Nutzer anzuzeigen, welchen Prompt das System standardmäßig verwendet. Es ist OUTPUT_ONLY.

LlmPolicy

JSON-Darstellung 
{
  "maxConversationMessages": integer,
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "policyScope": enum (PolicyScope),
  "failOpen": boolean,
  "allowShortUtterance": boolean
}
Felder
maxConversationMessages

integer

Optional. Bei der Überprüfung dieser Richtlinie werden die letzten „n“ Nachrichten in der Unterhaltung berücksichtigt. Wenn kein Wert festgelegt ist, wird der Standardwert 10 verwendet.
modelSettings

object (ModelSettings)

Optional. Modelleinstellungen.
prompt

string

Erforderlich. Richtlinien-Prompt.
policyScope

enum (PolicyScope)

Erforderlich. Definiert, wann die Richtlinienprüfung während der Unterhaltung angewendet werden soll. Wenn sie auf „POLICY_SCOPE_UNSPECIFIED“ gesetzt ist, wird die Richtlinie auf die Nutzereingabe angewendet. Wenn die Richtlinie auf die Antwort des Agents angewendet wird, kommt es zu einer zusätzlichen Latenz, bevor der Agent antworten kann.
failOpen

boolean

Optional. Wenn während der Richtlinienprüfung ein Fehler auftritt, wird die Anfrage nicht blockiert und die Guardrail wird nicht ausgelöst.
allowShortUtterance

boolean

Optional. Standardmäßig wird die LLM-Richtlinienprüfung bei kurzen Äußerungen umgangen. Wenn Sie diese Einstellung aktivieren, wird die Richtlinienprüfung auf alle Äußerungen angewendet, auch auf solche, die normalerweise übersprungen würden.

ModelSafety

JSON-Darstellung 
{
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ]
}
Felder
safetySettings[]

object (SafetySetting)

Erforderlich. Liste der Sicherheitseinstellungen.

SafetySetting

JSON-Darstellung 
{
  "category": enum (HarmCategory),
  "threshold": enum (HarmBlockThreshold)
}
Felder
category

enum (HarmCategory)

Erforderlich. Die Schadenskategorie.
threshold

enum (HarmBlockThreshold)

Erforderlich. Der Schwellenwert für die Schadensblockierung

CodeCallback

JSON-Darstellung 
{
  "beforeAgentCallback": {
    object (Callback)
  },
  "afterAgentCallback": {
    object (Callback)
  },
  "beforeModelCallback": {
    object (Callback)
  },
  "afterModelCallback": {
    object (Callback)
  }
}
Felder
beforeAgentCallback

object (Callback)

Optional. Der Callback, der vor dem Aufrufen des Agents ausgeführt werden soll. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, in dem die Entscheidung erläutert wird. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
afterAgentCallback

object (Callback)

Optional. Der Callback, der nach dem Aufrufen des Agenten ausgeführt werden soll. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, in dem die Entscheidung erläutert wird. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
beforeModelCallback

object (Callback)

Optional. Der Callback, der vor dem Aufrufen des Modells ausgeführt werden soll. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, in dem die Entscheidung erläutert wird. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
afterModelCallback

object (Callback)

Optional. Der Callback, der nach dem Aufrufen des Modells ausgeführt werden soll. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, in dem die Entscheidung erläutert wird. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.

TriggerAction

JSON-Darstellung 
{

  // Union field action can be only one of the following:
  "respondImmediately": {
    object (RespondImmediately)
  },
  "transferAgent": {
    object (TransferAgent)
  },
  "generativeAnswer": {
    object (GenerativeAnswer)
  }
  // End of list of possible types for union field action.
}
Felder
Union-Feld action. Die erforderliche Aktion. Für action ist nur einer der folgenden Werte zulässig:
respondImmediately

object (RespondImmediately)

Optional. Sofort mit einer vorkonfigurierten Antwort reagieren.
transferAgent

object (TransferAgent)

Optional. Leiten Sie die Unterhaltung an einen anderen Kundenservicemitarbeiter weiter.
generativeAnswer

object (GenerativeAnswer)

Optional. Mit einer generativen Antwort antworten.

RespondImmediately

JSON-Darstellung 
{
  "responses": [
    {
      object (Response)
    }
  ]
}
Felder
responses[]

object (Response)

Erforderlich. Die Antwortvorlagen, aus denen der Agent auswählen kann. Die Antwort wird zufällig ausgewählt.

Antwort

JSON-Darstellung 
{
  "text": string,
  "disabled": boolean
}
Felder
text

string

Erforderlich. Text, mit dem der Agent antworten soll.
disabled

boolean

Optional. Gibt an, ob die Antwort deaktiviert ist. Deaktivierte Antworten werden vom KI-Agenten nicht verwendet.

TransferAgent

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

string

Erforderlich. Der Name des Agents, an den die Unterhaltung übertragen werden soll. Der Agent muss sich in derselben App wie der aktuelle Agent befinden. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

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

string

Erforderlich. Der Prompt, der für die generative Antwort verwendet werden soll.

Toolset

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
Felder
name

string

ID. Die eindeutige ID des Toolsets. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

Optional. Der Anzeigename des Toolsets. Muss innerhalb derselben App eindeutig sein.
description

string

Optional. Die Beschreibung des Toolsets.
timeout

string (Duration format)

Optional. Das Zeitlimit für die Toolset-Ausführung. Wenn nichts anderes festgelegt ist, beträgt das Standard-Zeitlimit 30 Sekunden für SYNCHRONOUS-Toolsets und 60 Sekunden für ASYNCHRONOUS-Toolsets.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Toolsets.

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 des Toolsets.

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

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

enum (ExecutionType)

Optional. Der Ausführungstyp der Tools im Toolset.
toolFakeConfig

object (ToolFakeConfig)

Optional. Konfiguration für das Verhalten von Tools im Fälschungsmodus.
Union-Feld toolset_type. Der Typ des Toolsets. Für toolset_type ist nur einer der folgenden Werte zulässig:
mcpToolset

object (McpToolset)

Optional. Ein Toolset, das eine Liste der Tools enthält, die vom MCP-Server angeboten werden.
openApiToolset

object (OpenApiToolset)

Optional. Ein Toolset, das eine Liste von Tools enthält, die durch ein OpenAPI-Schema definiert werden.
connectorToolset

object (ConnectorToolset)

Optional. Eine Sammlung von Tools, die aus einer Integration Connectors-Verbindung generiert werden.

McpToolset

JSON-Darstellung 
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Felder
serverAddress

string

Erforderlich. Die Adresse des MCP-Servers, z. B. „https://beispiel.de/mcp/“. Wenn der Server mit dem MCP SDK erstellt wurde, sollte die URL mit „/mcp/“ enden. Es werden nur Streamable HTTP-Transport-basierte Server unterstützt. Weitere Informationen finden Sie unter https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

Optional. Authentifizierungsinformationen, die für den Zugriff auf Tools und die Ausführung eines Tools auf dem MCP-Server erforderlich sind. Bei der Bearer-Token-Authentifizierung gilt das Token nur für die Ausführung von Tools, nicht für die Auflistung von Tools. Dazu müssen Tools ohne Authentifizierung aufgeführt werden können.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration für VPC-SC, die zum Auflösen von Dienstnamen innerhalb eines Perimeters verwendet wird.
tlsConfig

object (TlsConfig)

Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
customHeaders

map (key: string, value: string)

Optional. Die benutzerdefinierten Header, die in der Anfrage an den MCP-Server gesendet werden sollen. Die Werte müssen das Format $context.variables.<name_of_variable> haben und können in den Sitzungsvariablen festgelegt werden. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
toolOverrides[]

object (McpToolOverride)

Optional. Überschreibungen für einzelne Tools in diesem Toolset. So können Sie bestimmte Details wie Beschreibungen oder Namen überschreiben oder den Status der Tools fixieren, damit er nicht vollständig dynamisch ist.

CustomHeadersEntry

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

string
value

string

McpToolOverride

JSON-Darstellung 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Felder
tool

string

Erforderlich. Der ursprüngliche Name des Tools, wie er vom MCP-Server ausgegeben wird.
nameOverride

string

Optional. Wenn dieser Name vorhanden ist, wird er im Agent anstelle des ursprünglichen Namens verwendet. Dies wird hauptsächlich als Alias verwendet, wenn der MCP-Server schlecht benannte Tools anbietet.
descriptionOverride

string

Optional. Falls vorhanden, wird diese Beschreibung anstelle der ursprünglichen Beschreibung vom Server verwendet.
snapshot

object (McpToolDefinition)

Nur Ausgabe. Wenn das Tool vorhanden ist, wird es angepinnt und verwendet die Snapshot-Werte als Fallback, wenn der Server vorübergehend nicht verfügbar ist oder keine Überschreibung vorhanden ist.

McpToolDefinition

JSON-Darstellung 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Felder
description

string

Nur Ausgabe. Die Beschreibung des MCP-Tools. Dies kann durch description_override in McpToolOverride überschrieben werden.
inputSchema

object (Schema)

Nur Ausgabe. Das Schema der Eingabeargumente des MCP-Tools.
outputSchema

object (Schema)

Nur Ausgabe. Das Schema der Ausgabeargumente des MCP-Tools.

OpenApiToolset

JSON-Darstellung 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Felder
openApiSchema

string

Erforderlich. Das OpenAPI-Schema des Toolsets.
apiAuthentication

object (ApiAuthentication)

Optional. Von der API benötigte Authentifizierungsinformationen.
tlsConfig

object (TlsConfig)

Optional. Die TLS-Konfiguration. Benutzerdefinierte Serverzertifikate sind enthalten
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration.
ignoreUnknownFields

boolean

Optional. Bei „true“ ignoriert der Agent unbekannte Felder in der API-Antwort für alle im OpenAPI-Schema definierten Vorgänge.
url

string

Optional. Die Server-URL des Open API-Schemas. Dieses Feld wird nur in Toolsets in den Umgebungsabhängigkeiten während des Exportvorgangs festgelegt, wenn das Schema eine Server-URL enthält. Wenn diese URL während des Importvorgangs in den Umgebungsabhängigkeiten vorhanden ist und das Schema den Platzhalter $env_var enthält, wird der Platzhalter im Schema ersetzt.

ConnectorToolset

JSON-Darstellung 
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Felder
connection

string

Erforderlich. Der vollständige Ressourcenname der referenzierten Integration Connectors-Verbindung. Format: projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

Optional. Konfiguriert, wie die Authentifizierung in Integration Connectors gehandhabt wird. Standardmäßig wird eine Administratorauthentifizierung in den Integration Connectors API-Anfragen übergeben. Sie können sie mit einer anderen Konfiguration für die Endnutzerauthentifizierung überschreiben. Hinweis: Für die Verbindung muss die Authentifizierungsüberschreibung aktiviert sein, damit Sie hier eine EUC-Konfiguration angeben können. Andernfalls schlägt die Erstellung des Toolsets fehl. Weitere Informationen finden Sie unter https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
connectorActions[]

object (Action)

Erforderlich. Die Liste der Connector-Aktionen/Entitätsvorgänge, für die Tools generiert werden sollen.

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_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

Richtung

Die Richtung der Übertragung.

Enums
DIRECTION_UNSPECIFIED Nicht angegebene Richtung.
PARENT_TO_CHILD Übertragung vom übergeordneten Agent zum untergeordneten Agent.
CHILD_TO_PARENT Übertragung vom untergeordneten zum übergeordneten Agent.

RequestLocation

Der Speicherort des API-Schlüssels in der Anfrage.

Enums
REQUEST_LOCATION_UNSPECIFIED Nicht angegeben. Dieser Wert sollte nicht verwendet werden.
HEADER Stellt den Schlüssel im HTTP-Header dar.
QUERY_STRING Stellt den Schlüssel im Abfragestring dar.

OauthGrantType

OAuth-Berechtigungstypen. Es wird nur die Gewährung von Clientanmeldedaten unterstützt.

Enums
OAUTH_GRANT_TYPE_UNSPECIFIED Nicht angegeben. Die Standardeinstellung ist CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Stellt den Ablauf für Clientanmeldedaten dar.

OperationType

Der Vorgang, der für die Entität ausgeführt werden soll.

Enums
OPERATION_TYPE_UNSPECIFIED Vorgangstyp nicht angegeben. Ungültig. Das Erstellen/Aktualisieren von ConnectorTool schlägt fehl.
LIST Vorgang auflisten.
GET Vorgang abrufen
CREATE Vorgang erstellen
UPDATE Aktualisierungsvorgang.
DELETE Löschvorgang.

DataStoreType

Der Typ des Datenspeichers.

Enums
DATA_STORE_TYPE_UNSPECIFIED Nicht angegeben. Dieser Wert gibt an, dass der Datenspeichertyp nicht angegeben ist. Er wird daher bei der Suche nicht verwendet.
PUBLIC_WEB Ein Datenspeicher, der öffentliche Webinhalte enthält.
UNSTRUCTURED Ein Datenspeicher, der unstrukturierte private Daten enthält.
FAQ Ein Datenspeicher, der strukturierte Daten enthält, die als FAQs verwendet werden.
CONNECTOR Ein Datenspeicher, der ein Connector zu einem selbst erhobenen oder einem Drittanbieterdienst ist.

DocumentProcessingMode

Der Dokumentverarbeitungsmodus des Datenspeichers.

Enums
DOCUMENT_PROCESSING_MODE_UNSPECIFIED Nicht angegeben.
DOCUMENTS Dokumente werden als Dokumente verarbeitet.
CHUNKS Dokumente werden in Blöcke unterteilt.

AttributeType

Das Attribut (oder die Funktion), auf das bzw. die das benutzerdefinierte Ranking angewendet werden soll.

Enums
ATTRIBUTE_TYPE_UNSPECIFIED Nicht angegebener AttributeType.
NUMERICAL Der Wert des numerischen Felds wird verwendet, um den Boost-Betrag dynamisch zu aktualisieren. In diesem Fall ist der „attribute_value“ (der x-Wert) des Kontrollpunkts der tatsächliche Wert des numerischen Felds, für das „boost_amount“ definiert ist.
FRESHNESS Im Anwendungsfall „Aktualität“ ist der Attributwert die Zeitspanne zwischen der aktuellen Uhrzeit und dem Datum im angegebenen Datums-/Uhrzeitfeld. Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]]. Beispiele: 5D, 3DT12H30M, T24H.

InterpolationType

Anzuwendender Interpolationstyp. Der Standardwert ist „linear“ (Piecewise Linear).

Enums
INTERPOLATION_TYPE_UNSPECIFIED Der Interpolationstyp ist nicht angegeben. In diesem Fall wird standardmäßig der Typ „Linear“ verwendet.
LINEAR Die „PiecewiseLinear“-Interpolation wird angewendet.

ModalityType

Der Modalitätstyp.

Enums
MODALITY_TYPE_UNSPECIFIED Nicht angegebener Modalitätstyp.
TEXT Textmodalität.
AUDIO Audio-Modalität

FilterParameterBehavior

Verhalten von Filterparametern.

Enums
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED Standardverhalten von Filtern. Filterparameter für Connector-Datenspeicher einbeziehen Bei den restlichen Datenspeichertypen wird der Filter-Eingabeparameter weggelassen.
ALWAYS_INCLUDE Fügen Sie immer einen Filterparameter für alle Datenspeichertypen ein.
NEVER_INCLUDE Der Filterparameter ist unabhängig vom Datenspeichertyp nie in der Liste der Tool-Parameter enthalten.

Bundesland

Stellt den dynamischen Verfügbarkeitsstatus des Tools dar.

Enums
STATE_UNSPECIFIED Standardstatus.
ACTIVE Das Tool ist verfügbar und wird aktiv vom Server angeboten.
INACTIVE Das Tool ist konfiguriert oder angepinnt, wird aber derzeit nicht vom Server angeboten.
STALE Das Tool ist auf dem Server vorhanden, stimmt aber nicht mit der Version auf dem Server überein.

CorpusType

Der Typ des Vertex-RAG-Korpus.

Enums
CORPUS_TYPE_UNSPECIFIED Nicht angegebener Korpus-Typ.
USER_OWNED Das Corpus wird vom Nutzer erstellt und gehört ihm.
FULLY_MANAGED Der Korpus wird vom Agenten erstellt.

WidgetType

Alle verfügbaren Widgettypen. Dieser Enum können in Zukunft neue Werte hinzugefügt werden.

Enums
WIDGET_TYPE_UNSPECIFIED Nicht angegebener Widget-Typ.
CUSTOM Benutzerdefinierter Widget-Typ.
PRODUCT_DETAILS Widget mit Produktdetails.
QUICK_ACTIONS Schnellaktionen-Widget
PRODUCT_COMPARISON Widget für den Produktvergleich.
ADVANCED_PRODUCT_DETAILS Widget mit weitergehenden Produktdetails
SHORT_FORM Kurzform-Widget
OVERALL_SATISFACTION Widget zur Gesamtzufriedenheit
ORDER_SUMMARY Widget für die Bestellübersicht
APPOINTMENT_DETAILS Widget mit Termin-Details.
APPOINTMENT_SCHEDULER Widget für die Terminplanung
CONTACT_FORM Kontaktformular-Widget

Modus

Die Strategie, die zum Zuordnen von Daten aus dem Quelltool zum Widget verwendet wird.

Enums
MODE_UNSPECIFIED Nicht angegebener Modus.
FIELD_MAPPING Verwenden Sie die field_mappings-Karte für die Datentransformation.
PYTHON_SCRIPT Verwenden Sie python_script für die Datentransformation.

Typ

Definiert, wie die Textantwort erstellt wird.

Enums
TYPE_UNSPECIFIED Nicht definierter Typ.
NONE Das LLM entscheidet dynamisch, ob neben dem Widget eine Textantwort generiert werden soll, basierend auf dem Gesprächskontext.
LLM_GENERATED Das LLM muss explizit eine Textantwort generieren.
STATIC Es wird immer eine vordefinierte statische Textantwort verwendet.

ExecutionType

Der Ausführungstyp des Tools oder Toolsets.

Enums
EXECUTION_TYPE_UNSPECIFIED Der Ausführungstyp ist nicht angegeben. Wenn kein Wert angegeben wird, gilt der Standardwert SYNCHRONOUS.
SYNCHRONOUS Das Tool wird synchron ausgeführt. Die Sitzung wird blockiert, bis das Tool zurückgegeben wird.
ASYNCHRONOUS Das Tool wird asynchron ausgeführt. Die Sitzung wird fortgesetzt, während das Tool ausgeführt wird.

MatchType

Keyword-Option für den Inhaltsfilter.

Enums
MATCH_TYPE_UNSPECIFIED Die Keyword-Option ist nicht angegeben.
SIMPLE_STRING_MATCH Inhalte werden zeichenweise auf Teilstrings abgeglichen.
WORD_BOUNDARY_STRING_MATCH Inhalte werden nur dann als Übereinstimmung erkannt, wenn das im Text gefundene Muster von Worttrennzeichen umgeben ist. Verbotene Ausdrücke können auch Worttrennzeichen enthalten.
REGEXP_MATCH Inhalte werden mithilfe der Syntax für reguläre Ausdrücke abgeglichen.

PolicyScope

Definiert, wann die Richtlinienprüfung während der Unterhaltung angewendet werden soll.

Enums
POLICY_SCOPE_UNSPECIFIED Der Richtlinienbereich ist nicht angegeben.
USER_QUERY Die Richtlinienprüfung wird durch Nutzereingaben ausgelöst.
AGENT_RESPONSE Die Richtlinienprüfung wird bei der Antwort des KI-Agents ausgelöst. Wenn Sie diesen Richtlinienbereich anwenden, kommt es zu zusätzlichen Latenzzeiten, bevor der Agent antworten kann.
USER_QUERY_AND_AGENT_RESPONSE Die Richtlinienprüfung wird sowohl bei Nutzereingaben als auch bei Antworten des KI-Agenten ausgelöst. Wenn Sie diesen Richtlinienbereich anwenden, kommt es zu zusätzlichen Latenzzeiten, bevor der Agent antworten kann.

HarmCategory

Schadenskategorie

Enums
HARM_CATEGORY_UNSPECIFIED Die Schadenskategorie ist nicht angegeben.
HARM_CATEGORY_HATE_SPEECH Die Schadenskategorie ist Hassrede.
HARM_CATEGORY_DANGEROUS_CONTENT Die Schadenskategorie ist gefährlicher Inhalt.
HARM_CATEGORY_HARASSMENT Die Schadenskategorie ist Belästigung.
HARM_CATEGORY_SEXUALLY_EXPLICIT Die Schadenskategorie umfasst sexuell anstößige Inhalte.
HARM_CATEGORY_PROFANITY Die Schadenskategorie ist Obszönität.
HARM_CATEGORY_TOXIC Die Schadenskategorie ist „Schädlich“.

HarmBlockThreshold

Wahrscheinlichkeitsbasierte Schwellenwertebenen für die Blockierung

Enums
HARM_BLOCK_THRESHOLD_UNSPECIFIED Unbekannter Schwellenwert für die Schadensblockierung
BLOCK_LOW_AND_ABOVE Niedrigen Schwellenwert und höher blockieren (d. h. mehr blockieren)
BLOCK_MEDIUM_AND_ABOVE Mittleren Schwellenwert und höher blockieren
BLOCK_ONLY_HIGH Nur einen hohen Schwellenwert blockieren (d. h. weniger blockieren)
BLOCK_NONE Nichts blockieren
OFF Sicherheitsfilter deaktivieren

Ausgabeschema

In der Customer Engagement Suite (CES) ist eine App-Version eine Momentaufnahme der App zu einem bestimmten Zeitpunkt. Sie ist unveränderlich und kann nach der Erstellung nicht mehr geändert werden.

AppVersion

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": string,
  "snapshot": {
    object (AppSnapshot)
  },
  "etag": string
}
Felder
name

string

ID. Die eindeutige ID der App-Version. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
displayName

string

Optional. Der Anzeigename der App-Version.
description

string

Optional. Die Beschreibung der App-Version.
creator

string

Nur Ausgabe. E-Mail-Adresse des Nutzers, der die App-Version erstellt hat.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung der App-Version.

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"
snapshot

object (AppSnapshot)

Nur Ausgabe. Der Snapshot der App, der beim Erstellen der Version aufgenommen wurde.
etag

string

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.

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 einschließlich zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).
nanos

integer

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

AppSnapshot

JSON-Darstellung 
{
  "app": {
    object (App)
  },
  "agents": [
    {
      object (Agent)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "examples": [
    {
      object (Example)
    }
  ],
  "guardrails": [
    {
      object (Guardrail)
    }
  ],
  "toolsets": [
    {
      object (Toolset)
    }
  ]
}
Felder
app

object (App)

Optional. Die Grundeinstellungen für die App.
agents[]

object (Agent)

Optional. Liste der Agents in der App.
tools[]

object (Tool)

Optional. Liste der Tools in der App.
examples[]

object (Example)

Optional. Liste mit Beispielen in der App.
guardrails[]

object (Guardrail)

Optional. Liste der Schutzmaßnahmen in der App.
toolsets[]

object (Toolset)

Optional. Liste der Toolsets in der App.

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 App-Liste angepinnt ist.
rootAgent

string

Optional. Der Stamm-Agent ist der Einstiegspunkt der App. 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. Protokollierungseinstellungen der App.
errorHandlingSettings

object (ErrorHandlingSettings)

Optional. Einstellungen für die Fehlerbehandlung der App.
modelSettings

object (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

enum (ToolExecutionMode)

Optional. Der Ausführungsmodus des Tools für die App. Wenn nicht angegeben, wird standardmäßig PARALLEL verwendet.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Optional. Die Bewertungs-Schwellenwerte 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. 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[]

string

Optional. Liste der Richtlinien für die App. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Optional. Die Datenspeichereinstellungen für die App.
defaultChannelProfile

object (ChannelProfile)

Optional. Das Standardkanalprofil, das von der App verwendet wird.
metadata

map (key: string, value: string)

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 "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, 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

integer

Nur Ausgabe. Anzahl der Bereitstellungen in der App.
clientCertificateSettings

object (ClientCertificateSettings)

Optional. Die Standardeinstellungen für das Clientzertifikat für die App.
vpcScSettings

object (VpcScSettings)

Optional. VPC-SC-Einstellungen für die App.
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. 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

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. 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
(deprecated)

string

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 erhält.

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 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 App aus der Zeitzonendatenbank, z.B. America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

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

map (key: string, value: object (SynthesizeSpeechConfig))

Optional. Konfiguration, wie die Antwort des Agenten synthetisiert werden soll. Die Zuordnung erfolgt 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 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 "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Optional. Konfiguriert das Verhalten des Agents 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, 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 „s“. Beispiel: "3.5s".
ambientSoundConfig

object (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 (SynthesizeSpeechConfig)
  }
}
Felder
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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
(deprecated)

string

Optional. Verworfen: Verwenden Sie stattdessen custom_voice_samples in AudioProcessingConfig.

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 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com muss die Berechtigung storage.objects.get für das Cloud Storage-Objekt haben.
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. Bei Werten außerhalb des Bereichs [0,25, 2,0] wird ein Fehler zurückgegeben.
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.
consentAudioGcsUri
(deprecated)

string

Optional. Verworfen: Verwenden Sie stattdessen custom_voice_samples in AudioProcessingConfig.

Der Cloud Storage-URI der Audiodatei mit Einwilligung für das Klonen von Stimmen.

BargeInConfig

JSON-Darstellung 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Felder
disableBargeIn
(deprecated)

boolean

Optional. Eingestellt: disable_barge_in wird in ChannelProfile zugunsten von disable_barge_in_control 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

boolean

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

string (int64 format)

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

integer

Signierte Sekundenbruchteile mit Nanosekunden-Auflösung des Zeitraums. Dauern von weniger als einer Sekunde werden mit dem Feld seconds = 0 und einem positiven oder negativen Feld nanos dargestellt. Bei Zeiträumen 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 (einschließlich).

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ä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
(deprecated)

enum (PrebuiltAmbientNoise)

Optional. Eingestellt: prebuilt_ambient_noise wurde zugunsten von prebuilt_ambient_sound eingestellt.
gcsUri

string

Optional. Umgebungsgeräusche als Mono-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 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 (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)
  }
}
Felder
redactionConfig

object (RedactionConfig)

Optional. Konfiguration, wie sensible Daten unkenntlich gemacht werden sollen.
audioRecordingConfig

object (AudioRecordingConfig)

Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen. Das Audio unterliegt der Entfernung gemäß der Konfiguration in RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

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 enabled ist, in der Regel zu Prüf- oder Überwachungszwecken.
bigqueryExportSettings

object (BigQueryExportSettings)

Optional. Konfiguriert das Verhalten des BigQuery-Exports für die App. Die Konversationsdaten werden gemäß der Konfiguration in RedactionConfig unkenntlich gemacht.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

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

object (CloudLoggingSettings)

Optional. Einstellungen zur Beschreibung des Cloud Logging-Verhaltens für die App.
conversationLoggingSettings

object (ConversationLoggingSettings)

Optional. Einstellungen, die das Verhalten der App beim Aufzeichnen von Unterhaltungen beschreiben.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen für die Auswertung. Standardmäßig ist die Audioaufnahme für Evaluationssitzungen nicht aktiviert.
metricAnalysisSettings

object (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

boolean

Optional. Bei „true“ wird die Entfernung in verschiedenen Logging-Szenarien angewendet, darunter Gesprächsablauf, Cloud Logging und Audioaufzeichnung.
inspectTemplate

string

Optional. Name der DLP-Prüfungsvorlage zum Konfigurieren der Erkennung sensibler Datentypen.

Format: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate

string

Optional. Name der DLP-De-Identifikationsvorlage, um anzugeben, 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, 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 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Berechtigung storage.objects.create erteilen.
gcsPathPrefix

string

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 $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 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 (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-Meldungen bei Systemfehlern (z.B. LLM-Fehler), die nach unterstütztem Sprachcode zugeordnet sind.

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, die unternommen werden sollen, bevor der Agent das EndSession-Signal 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,

  // 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 vom übergeordneten Agent.

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 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 (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
Felder
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

Optional. Die Grenzwerte für die Golden-Bewertungsmesswerte.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen golden_hallucination_metric_behavior. Das Verhalten des Halluzinationsmesswerts wird derzeit für Golden Evaluations verwendet.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Optional. Das Verhalten des Messwerts für Halluzinationen bei Golden Evaluations.
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 Messwerte auf Turn-Ebene.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Optional. Die Grenzwerte für die Messwerte für das Erwartungsniveau.
toolMatchingSettings

object (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 Golden-Erwartung entspricht.

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 semantische Ähnlichkeitschannel, 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 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 _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 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 (ExtraToolCallBehavior)
}
Felder
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Optional. Verhalten bei zusätzlichen Tool-Aufrufen. 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 Variablen.
schema

object (Schema)

Erforderlich. Das Schema der Variablen.

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 Eigenschaften 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. Steuert das Vorhandensein zusätzlicher Attribute.
anyOf[]

object (Schema)

Optional. Der Wert sollte anhand eines oder mehrerer der Unterschemas in der Liste validiert werden.
enum[]

string

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

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 Stamm-defs sein.

Das folgende Schema definiert beispielsweise eine Referenz auf einen Schemaknoten mit dem Namen „Pet“:

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

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

map (key: string, value: object (Schema))

Optional. Eine Karte mit 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. Maximaler Wert 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. Auch große Int64-Werte können nicht dargestellt werden, da das JSON-Format sie in seinem Zahlentyp generell 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 App.

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 ID des Channelprofils.
channelType

enum (ChannelType)

Optional. Der Typ des Channel-Profils.
personaProperty

object (PersonaProperty)

Optional. Die Persona-Eigenschaft des Kanalprofils.
webWidgetConfig

object (WebWidgetConfig)

Optional. Die Konfiguration für das Web-Widget.
whatsappConfig

object (WhatsAppConfig)

Optional. Konfiguration für WhatsApp-Bereitstellungen.
instagramConfig

object (InstagramConfig)

Optional. Konfiguration 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-Multifrequenz) 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 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 _noise_suppression_level.

Für _noise_suppression_level ist nur einer der folgenden Werte zulässig:
noiseSuppressionLevel

string

Optional. Der Grad der Geräuschunterdrückung des Kanalprofils. Verfügbare 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-Agent 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, auf der das Web-Widget geladen wird. Das Laden ist nur für denselben Ursprung oder einen der zulässigen Ursprünge zulässig.
allowedOrigins[]

string

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

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 Miniaturansicht-URL des Meta-Unternehmensprofils.
description

string

Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils.

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 Miniaturansicht-URL des Meta-Unternehmensprofils.
description

string

Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Profils.

MetadataEntry

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

string
value

string

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 Beginn des Headers und das Ende der Fußzeile enthalten.
privateKey

string

Erforderlich. Der Name der SecretManager-Secret-Versionsressource, in der der private Schlüssel im PEM-Format gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

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: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

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

string

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

string

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: projects/{project}/locations/{location}/dashboards/{dashboard}

Agent

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "modelSettings": {
    object (ModelSettings)
  },
  "instruction": string,
  "tools": [
    string
  ],
  "childAgents": [
    string
  ],
  "beforeAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "guardrails": [
    string
  ],
  "etag": string,
  "toolsets": [
    {
      object (AgentToolset)
    }
  ],
  "generatedSummary": string,
  "transferRules": [
    {
      object (TransferRule)
    }
  ],
  "validationErrors": [
    string
  ],

  // Union field agent_type can be only one of the following:
  "llmAgent": {
    object (LlmAgent)
  },
  "remoteDialogflowAgent": {
    object (RemoteDialogflowAgent)
  }
  // End of list of possible types for union field agent_type.
}
Felder
name

string

ID. Die eindeutige ID des Agents. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Erforderlich. Anzeigename des KI-Agenten.
description

string

Optional. Eine menschenlesbare Beschreibung des KI-Agenten.
modelSettings

object (ModelSettings)

Optional. Konfigurationen für das LLM-Modell.
instruction

string

Optional. Anweisungen für das LLM-Modell, um das Verhalten des KI-Agenten zu steuern.
tools[]

string

Optional. Liste der verfügbaren Tools für den Agenten. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
childAgents[]

string

Optional. Liste der untergeordneten Agents in der Agent-Baumstruktur. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
beforeAgentCallbacks[]

object (Callback)

Optional. Die Rückrufe, die vor dem Aufrufen des Agents ausgeführt werden sollen. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
afterAgentCallbacks[]

object (Callback)

Optional. Die Callbacks, die nach dem Aufrufen des Agenten ausgeführt werden sollen. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
beforeModelCallbacks[]

object (Callback)

Optional. Die Callbacks, die vor dem Aufrufen des Modells ausgeführt werden sollen. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
afterModelCallbacks[]

object (Callback)

Optional. Die Callbacks, die nach dem Aufrufen des Modells ausgeführt werden sollen. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
beforeToolCallbacks[]

object (Callback)

Optional. Die Callbacks, die vor dem Aufrufen des Tools ausgeführt werden sollen. Wenn mehrere Tool-Aufrufe vorhanden sind, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
afterToolCallbacks[]

object (Callback)

Optional. Die Callbacks, die nach dem Aufrufen des Tools ausgeführt werden sollen. Wenn mehrere Tool-Aufrufe vorhanden sind, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden nacheinander in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Agents.

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 des KI-Agents.

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".
guardrails[]

string

Optional. Liste der Richtlinien für den Agent. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag

string

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.
toolsets[]

object (AgentToolset)

Optional. Liste der Toolsets für den Agenten.
generatedSummary

string

Nur Ausgabe. Wenn der Agent vom LLM-Assistenten generiert wird, enthält dieses Feld eine beschreibende Zusammenfassung der Generierung.
transferRules[]

object (TransferRule)

Optional. Regeln für die Agent-Übertragung. Wenn mehrere Regeln übereinstimmen, wird die erste Regel in der Liste verwendet.
validationErrors[]

string

Nur Ausgabe. Fehlkonfigurationen oder Fehler im Agent, die sich auf die Qualität des Agents auswirken können.
Union-Feld agent_type. Der Typ des Agents. Für agent_type ist nur einer der folgenden Werte zulässig:
llmAgent

object (LlmAgent)

Optional. Der Standard-KI-Agententyp.
remoteDialogflowAgent

object (RemoteDialogflowAgent)

Optional. Der Remote-Dialogflow-Agent, der für die Ausführung des Agent verwendet werden soll. Wenn dieses Feld festgelegt ist, werden alle anderen Eigenschaften auf Agentenebene ignoriert.

Hinweis: Wenn sich der Dialogflow-Agent 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/dialogflow.client zuweisen.

RemoteDialogflowAgent

JSON-Darstellung 
{
  "agent": string,
  "flowId": string,
  "environmentId": string,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "respectResponseInterruptionSettings": boolean,
  "languageCodeVariable": string
}
Felder
agent

string

Erforderlich. Der Ressourcenname des Dialogflow-KI-Agenten. Format: projects/{project}/locations/{location}/agents/{agent}
flowId

string

Optional. Die Ablauf-ID des Ablaufs im Dialogflow-Agent.
environmentId

string

Optional. Die Umgebungs-ID des Dialogflow-Agents, der für die Ausführung des Agents verwendet werden soll. Wenn keine Angabe erfolgt, wird die Umgebung „Entwurf“ verwendet.
inputVariableMapping

map (key: string, value: string)

Optional. Die Zuordnung der Namen der App-Variablen zu den Namen der Dialogflow-Sitzungsparameter, die als Eingabe an den Dialogflow-Agent gesendet werden sollen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
outputVariableMapping

map (key: string, value: string)

Optional. Die Zuordnung der Namen der Dialogflow-Sitzungsparameter zu den Namen der App-Variablen, die nach Beendigung der Ausführung des Dialogflow-Agenten an den CES-Agenten zurückgesendet werden sollen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
respectResponseInterruptionSettings

boolean

Optional. Gibt an, ob die auf Nachrichtenebene konfigurierten Unterbrechungseinstellungen im Dialogflow-Agent berücksichtigt werden sollen.

  • Bei „false“: Alle Antwortnachrichten des Dialogflow-Agents folgen den Einstellungen für das Unterbrechen auf App-Ebene.
  • Wenn „true“: Nur Antwortnachrichten, bei denen allow_playback_interruption auf „true“ gesetzt ist, können unterbrochen werden. Für alle anderen Nachrichten gelten die Einstellungen für das Unterbrechen auf App-Ebene.
languageCodeVariable

string

Optional. Der Name der Variablen, die den Sprachcode für die Dialogflow-Sitzung enthält. Wenn nichts angegeben wird, wird der Standardsprachcode des Dialogflow-Agents verwendet.

InputVariableMappingEntry

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

string
value

string

OutputVariableMappingEntry

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

string
value

string

Rückruf

JSON-Darstellung 
{
  "description": string,
  "disabled": boolean,
  "proactiveExecutionEnabled": boolean,

  // Union field callback can be only one of the following:
  "pythonCode": string
  // End of list of possible types for union field callback.
}
Felder
description

string

Optional. Eine menschenlesbare Beschreibung des Rückrufs.
disabled

boolean

Optional. Gibt an, ob der Rückruf deaktiviert ist. Deaktivierte Rückrufe werden vom Kundenservicemitarbeiter ignoriert.
proactiveExecutionEnabled

boolean

Optional. Wenn aktiviert, wird der Callback auch für Zwischenausgaben des Modells ausgeführt. Diese Einstellung wirkt sich nur auf den „After Model“-Callback aus. MIT VORSICHT AKTIVIEREN. Normalerweise muss „after_model_callback“ erst nach dem Empfang aller Modellantworten ausgeführt werden. Die Aktivierung der proaktiven Ausführung kann sich negativ auf die Ausführungskosten und ‑latenz auswirken und sollte nur in seltenen Fällen aktiviert werden.
Union-Feld callback. Der auszuführende Callback. Für callback ist nur einer der folgenden Werte zulässig:
pythonCode

string

Erforderlich. Der Python-Code, der für den Callback ausgeführt werden soll.

AgentToolset

JSON-Darstellung 
{
  "toolset": string,
  "toolIds": [
    string
  ]
}
Felder
toolset

string

Erforderlich. Der Ressourcenname des Toolsets. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolIds[]

string

Optional. Die Tool-IDs zum Filtern des Toolsets.

TransferRule

JSON-Darstellung 
{
  "childAgent": string,
  "direction": enum (Direction),

  // Union field rule_type can be only one of the following:
  "deterministicTransfer": {
    object (DeterministicTransfer)
  },
  "disablePlannerTransfer": {
    object (DisablePlannerTransfer)
  }
  // End of list of possible types for union field rule_type.
}
Felder
childAgent

string

Erforderlich. Der Ressourcenname des untergeordneten Agenten, für den die Regel gilt. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

enum (Direction)

Erforderlich. Die Richtung der Übertragung.
Union-Feld rule_type. Der Regeltyp. Für rule_type ist nur einer der folgenden Werte zulässig:
deterministicTransfer

object (DeterministicTransfer)

Optional. Eine Regel, die sofort an den Ziel-Agent übertragen wird, wenn die Bedingung erfüllt ist.
disablePlannerTransfer

object (DisablePlannerTransfer)

Optional. Regel, die verhindert, dass der Planner an den Ziel-Agent übertragen wird.

DeterministicTransfer

JSON-Darstellung 
{

  // Union field condition_type can be only one of the following:
  "expressionCondition": {
    object (ExpressionCondition)
  },
  "pythonCodeCondition": {
    object (PythonCodeCondition)
  }
  // End of list of possible types for union field condition_type.
}
Felder
Union-Feld condition_type. Die auszuwertende Bedingung. Für condition_type ist nur einer der folgenden Werte zulässig:
expressionCondition

object (ExpressionCondition)

Optional. Eine Regel, die eine Bedingung für den Sitzungsstatus auswertet. Wenn die Bedingung als „true“ ausgewertet wird, erfolgt die Übertragung.
pythonCodeCondition

object (PythonCodeCondition)

Optional. Eine Regel, in der ein Python-Codeblock verwendet wird, um die Bedingungen auszuwerten. Wenn die Bedingung als „true“ ausgewertet wird, erfolgt die Übertragung.

ExpressionCondition

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

string

Erforderlich. Die String-Darstellung der Bedingung „cloud.api.Expression“.

PythonCodeCondition

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

string

Erforderlich. Der auszuführende Python-Code.

DisablePlannerTransfer

JSON-Darstellung 
{
  "expressionCondition": {
    object (ExpressionCondition)
  }
}
Felder
expressionCondition

object (ExpressionCondition)

Erforderlich. Wenn die Bedingung als „true“ ausgewertet wird, darf der Planer nicht zum Ziel-Kundenservicemitarbeiter weitergeleitet werden.

Tool

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field tool_type can be only one of the following:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of list of possible types for union field tool_type.
}
Felder
name

string

ID. Der Ressourcenname des Tools. Format:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} für eigenständige Tools.
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} für Tools, die aus einem Toolset abgerufen werden.

Diese Tools sind dynamisch und geben nur Ausgaben zurück. Sie können nicht direkt referenziert werden, wenn ein Tool erwartet wird.
displayName

string

Nur Ausgabe. Der Anzeigename des Tools, der auf dem Typ des Tools basiert. Der Anzeigename einer [ClientFunction][Tool.ClientFunction] wird beispielsweise aus der zugehörigen name-Eigenschaft abgeleitet.
executionType

enum (ExecutionType)

Optional. Der Ausführungstyp des Tools.
timeout

string (Duration format)

Optional. Das Zeitlimit für die Toolausführung. Wenn kein Wert festgelegt ist, beträgt das Standard-Zeitlimit 30 Sekunden für SYNCHRONOUS-Tools und 60 Sekunden für ASYNCHRONOUS-Tools.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Tools.

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 des Tools.

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

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

string

Nur Ausgabe. Wenn das Tool vom LLM-Assistenten generiert wird, enthält dieses Feld eine beschreibende Zusammenfassung der Generierung.
toolFakeConfig

object (ToolFakeConfig)

Optional. Konfiguration für das Verhalten von Tools im Fälschungsmodus.
Union-Feld tool_type. Der Typ des Tools. Für tool_type ist nur einer der folgenden Werte zulässig:
clientFunction

object (ClientFunction)

Optional. Die Clientfunktion.
openApiTool

object (OpenApiTool)

Optional. Das Open API-Tool.
googleSearchTool

object (GoogleSearchTool)

Optional. Das Tool für die Google Suche.
connectorTool

object (ConnectorTool)

Optional. Das Integration Connector-Tool
dataStoreTool

object (DataStoreTool)

Optional. Das Datenspeichertool.
pythonFunction

object (PythonFunction)

Optional. Das Python-Funktionstool.
mcpTool

object (McpTool)

Optional. Das MCP-Tool. Ein MCP-Tool kann nicht direkt erstellt oder aktualisiert werden, sondern wird vom MCP-Toolset verwaltet.
fileSearchTool

object (FileSearchTool)

Optional. Das Dateisuchtool.
systemTool

object (SystemTool)

Optional. Das Systemtool
agentTool

object (AgentTool)

Optional. Das Agent-Tool.
widgetTool

object (WidgetTool)

Optional. Das Widget-Tool
remoteAgentTool

object (RemoteAgentTool)

Optional. Das Remote-KI-Agenten-Tool.

ClientFunction

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  },
  "response": {
    object (Schema)
  }
}
Felder
name

string

Erforderlich. Der Name der Funktion.
description

string

Optional. Die Funktionsbeschreibung.
parameters

object (Schema)

Optional. Das Schema der Funktionsparameter.
response

object (Schema)

Optional. Das Schema der Funktionsantwort.

OpenApiTool

JSON-Darstellung 
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Felder
openApiSchema

string

Erforderlich. Das OpenAPI-Schema im JSON- oder YAML-Format.
name

string

Optional. Der Name des Tools. Wenn nicht angegeben, wird der Name des Tools aus dem OpenAPI-Schema abgeleitet, aus operation.operationId.
description

string

Optional. Die Beschreibung des Tools. Wenn sie nicht angegeben ist, wird die Beschreibung des Tools aus dem OpenAPI-Schema, aus operation.description oder aus operation.summary abgeleitet.
apiAuthentication

object (ApiAuthentication)

Optional. Von der API benötigte Authentifizierungsinformationen.
tlsConfig

object (TlsConfig)

Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration.
ignoreUnknownFields

boolean

Optional. Bei „true“ ignoriert der Agent unbekannte Felder in der API-Antwort.
url

string

Optional. Die Server-URL des Open API-Schemas. Dieses Feld wird in Tools in den Umgebungsabhängigkeiten während des Exportvorgangs nur festgelegt, wenn das Schema eine Server-URL enthält. Wenn diese URL während des Importvorgangs in den Umgebungsabhängigkeiten vorhanden ist und das Schema den Platzhalter $env_var enthält, wird der Platzhalter im Schema ersetzt.

ApiAuthentication

JSON-Darstellung 
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
Felder
Union-Feld auth_config. Die Authentifizierungskonfiguration. Für auth_config ist nur einer der folgenden Werte zulässig:
apiKeyConfig

object (ApiKeyConfig)

Optional. Konfiguration für die API-Schlüsselauthentifizierung.
oauthConfig

object (OAuthConfig)

Optional. Konfiguration für OAuth.
serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

Optional. Konfiguration für die ID-Token-Authentifizierung, die vom CES-Dienst-Agent generiert wurde.
serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

Optional. Konfiguration für die Dienstkontoauthentifizierung.
bearerTokenConfig

object (BearerTokenConfig)

Optional. Konfiguration für die Inhabertoken-Authentifizierung.

ApiKeyConfig

JSON-Darstellung 
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
Felder
keyName

string

Erforderlich. Der Parametername oder der Headername des API-Schlüssels. Beispiel: Wenn die API-Anfrage „https://example.com/act?X-Api-Key=“ lautet, ist „X-Api-Key“ der Parametername.
apiKeySecretVersion

string

Erforderlich. Der Name der Secret-Versionsressource des Secret Manager, in der der API-Schlüssel gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}

Hinweis: Sie sollten dem CES-Dienst-Agenten service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/secretmanager.secretAccessor zuweisen.
requestLocation

enum (RequestLocation)

Erforderlich. Schlüsselposition in der Anfrage.

OAuthConfig

JSON-Darstellung 
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
Felder
oauthGrantType

enum (OauthGrantType)

Erforderlich. OAuth-Berechtigungstypen.
clientId

string

Erforderlich. Die Client-ID des OAuth-Anbieters.
clientSecretVersion

string

Erforderlich. Der Name der SecretManager-Secret-Versionsressource, in der der Clientschlüssel gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}

Hinweis: Sie sollten dem CES-Dienst-Agenten service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/secretmanager.secretAccessor zuweisen.
tokenEndpoint

string

Erforderlich. Der Token-Endpunkt im OAuth-Anbieter, der gegen ein Zugriffstoken getauscht werden soll.
scopes[]

string

Optional. Die zu gewährenden OAuth-Bereiche.

ServiceAccountAuthConfig

JSON-Darstellung 
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
Felder
serviceAccount

string

Erforderlich. Die E‑Mail-Adresse des für die Authentifizierung verwendeten Dienstkontos. CES verwendet dieses Dienstkonto, um ein Zugriffstoken auszutauschen. Das Zugriffstoken wird dann im Authorization-Header der Anfrage gesendet.

Dem Dienstkonto muss die Rolle roles/iam.serviceAccountTokenCreator für den CES-Dienst-Agenten service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com zugewiesen sein.
scopes[]

string

Optional. Die zu gewährenden OAuth-Bereiche. Wenn nichts angegeben ist, wird der Standardbereich https://www.googleapis.com/auth/cloud-platform verwendet.

BearerTokenConfig

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

string

Erforderlich. Das Inhabertoken. Muss das Format $context.variables.<name_of_variable> aufweisen.

TlsConfig

JSON-Darstellung 
{
  "caCerts": [
    {
      object (CaCert)
    }
  ]
}
Felder
caCerts[]

object (CaCert)

Erforderlich. Gibt eine Liste der zulässigen benutzerdefinierten CA-Zertifikate für die HTTPS-Überprüfung an.

CaCert

JSON-Darstellung 
{
  "displayName": string,
  "cert": string
}
Felder
displayName

string

Erforderlich. Der Name der zulässigen benutzerdefinierten CA-Zertifikate. Damit können die benutzerdefinierten CA-Zertifikate eindeutig identifiziert werden.
cert

string (bytes format)

Erforderlich. Die zulässigen benutzerdefinierten CA-Zertifikate (im DER-Format) für die HTTPS-Überprüfung. Dadurch wird der Standard-SSL-Trust-Anchor überschrieben. Wenn dieses Feld leer oder nicht angegeben ist, verwendet CES den Standard-Trust Store von Google, um Zertifikate zu prüfen. Hinweis: Die HTTPS-Serverzertifikate müssen mit „subject alt name“ signiert sein. Ein Zertifikat kann beispielsweise mit dem folgenden Befehl selbst signiert werden:

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Ein base64-codierter String.

ServiceDirectoryConfig

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

string

Erforderlich. Der Name des Service Directory-Dienstes. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Der Speicherort des Dienstverzeichnisses muss mit dem Speicherort der App übereinstimmen.

GoogleSearchTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (PromptConfig)
  }
}
Felder
name

string

Erforderlich. Der Name des Tools.
description

string

Optional. Beschreibung des Zwecks des Tools.
contextUrls[]

string

Optional. Inhalte werden direkt von diesen URLs abgerufen, um Kontext und Fundierung zu erhalten. Beispiel: „https://beispiel.de/pfad.html“. Es sind maximal 20 URLs zulässig.
preferredDomains[]

string

Optional. Gibt Domains an, auf die Suchergebnisse beschränkt werden sollen. Beispiel: „beispiel.de“, „andere.website“. Es können maximal 20 Domains angegeben werden.
excludeDomains[]

string

Optional. Liste der Domains, die aus den Suchergebnissen ausgeschlossen werden sollen. Beispiel: „beispiel.de“ Es können maximal 2.000 Domains ausgeschlossen werden.
promptConfig

object (PromptConfig)

Optional. An den Planner übergebene Anweisungen für die Verarbeitung der Suchergebnisse für Text und Sprache.

PromptConfig

JSON-Darstellung 
{
  "textPrompt": string,
  "voicePrompt": string
}
Felder
textPrompt

string

Optional. Definiert den Prompt, der für die Systemanweisungen verwendet wird, wenn Sie in Chatunterhaltungen mit dem Agent interagieren. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
voicePrompt

string

Optional. Definiert den Prompt, der für die Systemanweisungen verwendet wird, wenn Sie in Sprachunterhaltungen mit dem Agent interagieren. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.

ConnectorTool

JSON-Darstellung 
{
  "connection": string,
  "action": {
    object (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
Felder
connection

string

Erforderlich. Der vollständige Ressourcenname der referenzierten Integration Connectors-Verbindung. Format: projects/{project}/locations/{location}/connections/{connection}
action

object (Action)

Erforderlich. Aktion für das zu verwendende Tool.
authConfig

object (EndUserAuthConfig)

Optional. Konfiguriert, wie die Authentifizierung in Integration Connectors gehandhabt wird. Standardmäßig wird eine Administratorauthentifizierung in den Integration Connectors API-Anfragen übergeben. Sie können sie mit einer anderen Konfiguration für die Endnutzerauthentifizierung überschreiben. Hinweis: Für die Verbindung muss die Authentifizierungsüberschreibung aktiviert sein, damit hier eine EUC-Konfiguration angegeben werden kann. Andernfalls schlägt die ConnectorTool-Erstellung fehl. Weitere Informationen finden Sie unter https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
name

string

Optional. Der Name des Tools, das vom Agent verwendet werden kann, um zu entscheiden, ob dieses ConnectorTool aufgerufen werden soll.
description

string

Optional. Die Beschreibung des Tools, anhand derer der Agent entscheiden kann, ob dieses ConnectorTool aufgerufen werden soll.

Aktion

JSON-Darstellung 
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
Felder
inputFields[]

string

Optional. Entitätsfelder, die als Eingaben für den Vorgang verwendet werden sollen. Wenn keine Felder angegeben sind, werden alle Felder der Entität verwendet.
outputFields[]

string

Optional. Entitätsfelder, die vom Vorgang zurückgegeben werden sollen. Wenn keine Felder angegeben sind, werden alle Felder der Entität zurückgegeben.
Union-Feld action_spec. Spezifikation für eine Aktion, die für das zu verwendende Tool konfiguriert werden soll. Für action_spec ist nur einer der folgenden Werte zulässig:
connectionActionId

string

ID einer Verbindungsaktion für das zu verwendende Tool.
entityOperation

object (EntityOperation)

Konfiguration für den Entitätsvorgang, die vom Tool verwendet werden soll.

EntityOperation

JSON-Darstellung 
{
  "entityId": string,
  "operation": enum (OperationType)
}
Felder
entityId

string

Erforderlich. ID der Entität.
operation

enum (OperationType)

Erforderlich. Vorgang, der für die Entität ausgeführt werden soll.

EndUserAuthConfig

JSON-Darstellung 
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
Felder
Union-Feld auth_config. Die Authentifizierungskonfiguration. Für auth_config ist nur einer der folgenden Werte zulässig:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

Oauth 2.0-Authentifizierung mit Autorisierungscode.
oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

Authentifizierung mit OAuth 2.0-Berechtigungstyp zur Autorisierung mit JWT-Profil.

Oauth2AuthCodeConfig

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

string

Erforderlich. Name des OAuth-Tokenparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.

Oauth2JwtBearerConfig

JSON-Darstellung 
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
Felder
issuer

string

Erforderlich. Name des Ausstellerparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.
subject

string

Erforderlich. Name des Inhaberparameters, der weitergegeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.
clientKey

string

Erforderlich. Name des Clientparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.

DataStoreTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (FilterParameterBehavior),

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
Felder
name

string

Erforderlich. Der Name des Datenspeicher-Tools.
description

string

Optional. Die Tool-Beschreibung.
boostSpecs[]

object (BoostSpecs)

Optional. Mit der Boost-Spezifikation können Sie bestimmte Dokumente hervorheben.
modalityConfigs[]

object (ModalityConfig)

Optional. Die Modalitätskonfigurationen für den Datenspeicher.
filterParameterBehavior

enum (FilterParameterBehavior)

Optional. Das Verhalten des Filterparameters.
Union-Feld search_source. Definiert die Suchquelle, entweder einen einzelnen DataStore oder eine Engine. Für search_source ist nur einer der folgenden Werte zulässig:
dataStoreSource

object (DataStoreSource)

Optional. In einem einzelnen bestimmten Datenspeicher suchen.
engineSource

object (EngineSource)

Optional. Suche innerhalb einer Engine (möglicherweise in mehreren Datenspeichern).

DataStoreSource

JSON-Darstellung 
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
Felder
filter

string

Optional. Filterspezifikation für den DataStore. Weitere Informationen finden Sie unter https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.
dataStore

object (DataStore)

Optional. Der Datenspeicher.

Datastore

JSON-Darstellung 
{
  "name": string,
  "type": enum (DataStoreType),
  "documentProcessingMode": enum (DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (ConnectorConfig)
  }
}
Felder
name

string

Erforderlich. Vollständiger Ressourcenname des DataStore. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

enum (DataStoreType)

Nur Ausgabe. Der Typ des Datenspeichers. Dieses Feld ist schreibgeschützt und wird vom Server ausgefüllt.
documentProcessingMode

enum (DocumentProcessingMode)

Nur Ausgabe. Der Dokumentverarbeitungsmodus für die Datenspeicherverbindung. Wird nur für PUBLIC_WEB- und UNSTRUCTURED-Datenspeicher festgelegt.
displayName

string

Nur Ausgabe. Der Anzeigename des Datenspeichers.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Datenspeichers.

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"
connectorConfig

object (ConnectorConfig)

Nur Ausgabe. Die Connector-Konfiguration für die Datenspeicherverbindung.

ConnectorConfig

JSON-Darstellung 
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
Felder
collection

string

Der Ressourcenname der Sammlung, zu der der Datenspeicher gehört.
collectionDisplayName

string

Der Anzeigename der Sammlung, zu der der Datenspeicher gehört.
dataSource

string

Der Name der Datenquelle. Beispiel: salesforce, jira, confluence, bigquery.

EngineSource

JSON-Darstellung 
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreSource)
    }
  ],
  "filter": string
}
Felder
engine

string

Erforderlich. Vollständiger Ressourcenname der Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
dataStoreSources[]

object (DataStoreSource)

Optional. Damit können Sie bestimmte DataStores innerhalb der Engine als Ziel auswählen. Wenn das Feld leer ist, wird die Suche auf alle DataStores angewendet, die mit der Engine verknüpft sind.
filter

string

Optional. Ein Filter, der auf die Suche in der Engine angewendet wird. Nicht relevant und wird nicht verwendet, wenn „data_store_sources“ angegeben ist. Weitere Informationen finden Sie unter https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.

BoostSpecs

JSON-Darstellung 
{
  "dataStores": [
    string
  ],
  "spec": [
    {
      object (BoostSpec)
    }
  ]
}
Felder
dataStores[]

string

Erforderlich. Der Datenspeicher, auf den die Konfiguration für die Steigerung angewendet wird. Vollständiger Ressourcenname des Datenspeichers, z. B. „projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}“.
spec[]

object (BoostSpec)

Erforderlich. Eine Liste mit Spezifikationen für das Boosting.

BoostSpec

JSON-Darstellung 
{
  "conditionBoostSpecs": [
    {
      object (ConditionBoostSpec)
    }
  ]
}
Felder
conditionBoostSpecs[]

object (ConditionBoostSpec)

Erforderlich. Eine Liste mit Spezifikationen für das Boosting.

ConditionBoostSpec

JSON-Darstellung 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
Felder
condition

string

Erforderlich. Der Ausdruck für eine Boost-Bedingung. Die Syntax ist dieselbe wie die Syntax für Filterausdrücke. Derzeit wird nur eine Liste von BCP-47-Sprachcodes als Bedingung unterstützt. Beispiel: So verbessern Sie Vorschläge in den Sprachen „en“ oder „fr“: (lang_code: ANY("en", "fr"))
boost

number

Optional. Stärke des Boostings, das im Bereich [-1, 1] liegen sollte. Negatives Boosting bedeutet Abwertung. Der Standardwert ist 0,0.

Wenn Sie den Wert auf 1,0 setzen, werden die Vorschläge deutlich hochgestuft. Das bedeutet jedoch nicht, dass das Top-Ergebnis immer ein geboosteter Vorschlag ist.

Wenn Sie den Wert auf -1,0 setzen, werden die Vorschläge stark herabgestuft. Es werden jedoch möglicherweise weiterhin andere relevante Vorschläge angezeigt.

Wenn Sie den Wert auf 0,0 festlegen, wird kein Boosting angewendet. Die Boost-Bedingung wird ignoriert.
boostControlSpec

object (BoostControlSpec)

Optional. Komplexe Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden definierten Attributwert.

BoostControlSpec

JSON-Darstellung 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Felder
fieldName

string

Optional. Der Name des Feldes, dessen Wert zur Bestimmung des Boost-Betrags verwendet wird.
attributeType

enum (AttributeType)

Optional. Der Attributtyp, der zum Ermitteln des Boost-Betrags verwendet werden soll. Der Attributwert kann aus dem Feldwert des angegebenen „field_name“ abgeleitet werden. Bei numerischen Werten ist das ganz einfach: attribute_value = numerical_field_value. Bei der Aktualität gilt jedoch: attribute_value = (time.now() – datetime_field_value).
interpolationType

enum (InterpolationType)

Optional. Der Interpolationstyp, der zum Verbinden der unten aufgeführten Kontrollpunkte verwendet wird.
controlPoints[]

object (ControlPoint)

Optional. Die Kontrollpunkte, mit denen die Kurve definiert wird. Die monotone Funktion (die oben über „interpolation_type“ definiert wurde) geht durch die hier aufgeführten Kontrollpunkte.

ControlPoint

JSON-Darstellung 
{
  "attributeValue": string,
  "boostAmount": number
}
Felder
attributeValue

string

Optional. Kann einer der folgenden Werte sein: 1. Der numerische Feldwert. 2. Die Dauerangabe für die Aktualität: Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]].
boostAmount

number

Optional. Der Wert zwischen -1 und 1, der angibt, um wieviel die Punktzahl erhöht werden soll, wenn „attribute_value“ dem oben angegebenen Wert entspricht.

ModalityConfig

JSON-Darstellung 
{
  "modalityType": enum (ModalityType),
  "rewriterConfig": {
    object (RewriterConfig)
  },
  "summarizationConfig": {
    object (SummarizationConfig)
  },
  "groundingConfig": {
    object (GroundingConfig)
  },
  "snippetsConfig": {
    object (SnippetsConfig)
  }
}
Felder
modalityType

enum (ModalityType)

Erforderlich. Der Modalitätstyp.
rewriterConfig

object (RewriterConfig)

Optional. Die Rewriter-Konfiguration.
summarizationConfig

object (SummarizationConfig)

Optional. Die Zusammenfassungskonfiguration.
groundingConfig

object (GroundingConfig)

Optional. Die Fundierungskonfiguration.
snippetsConfig

object (SnippetsConfig)

Optional. Die Snippets-Konfiguration.

RewriterConfig

JSON-Darstellung 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Felder
modelSettings

object (ModelSettings)

Erforderlich. Konfigurationen für das LLM-Modell.
prompt

string

Optional. Die Prompt-Definition. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
disabled

boolean

Optional. Gibt an, ob der Rewriter deaktiviert ist.

SummarizationConfig

JSON-Darstellung 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Felder
modelSettings

object (ModelSettings)

Optional. Konfigurationen für das LLM-Modell.
prompt

string

Optional. Die Prompt-Definition. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
disabled

boolean

Optional. Gibt an, ob die Zusammenfassung deaktiviert ist.

GroundingConfig

JSON-Darstellung 
{
  "groundingLevel": number,
  "disabled": boolean
}
Felder
groundingLevel

number

Optional. Der Fundierungsschwellenwert der Antwort basierend auf den abgerufenen Quellen. Der Wert hat einen konfigurierbaren Bereich von [1, 5]. Mit der Ebene wird die Fundierung der Antwort begrenzt. Das bedeutet, dass bei allen Antworten mit einem Fundierungswert unter dem Schwellenwert nur relevante Snippets zurückgegeben werden.

Wenn der Wert beispielsweise 3 ist, muss der Fundierungs-Score mindestens 3 betragen, damit die Antwort zurückgegeben wird.
disabled

boolean

Optional. Gibt an, ob die Fundierung deaktiviert ist.

SnippetsConfig

JSON-Darstellung 
{
  "enableSnippets": boolean,
  "maxSnippets": integer
}
Felder
enableSnippets

boolean

Optional. Gibt an, ob Snippets aktiviert sind.
maxSnippets

integer

Optional. Anzahl der Snippets, die pro Anfrage zurückgegeben werden sollen. Wenn nicht festgelegt, werden standardmäßig alle Snippets des Dienstes zurückgegeben.

PythonFunction

JSON-Darstellung 
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
Felder
name

string

Optional. Der Name der auszuführenden Python-Funktion. Muss mit einem im Python-Code definierten Python-Funktionsnamen übereinstimmen. Groß- und Kleinschreibung wird berücksichtigt. Wenn der Name nicht angegeben ist, wird die erste im Python-Code definierte Funktion verwendet.
pythonCode

string

Optional. Der Python-Code, der für das Tool ausgeführt werden soll.
description

string

Nur Ausgabe. Die Beschreibung der Python-Funktion, die aus dem Docstring des Python-Codes geparst wurde.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration für das Tool.

McpTool

JSON-Darstellung 
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (State)
}
Felder
name

string

Erforderlich. Der Name des MCP-Tools.
nameOverride

string

Optional. Die Namensüberschreibung des MCP-Tools. Dieses Feld wird ausgefüllt, wenn der Name durch eine Toolset-Überschreibung überschrieben wurde.
description

string

Optional. Die Beschreibung des MCP-Tools.
inputSchema

object (Schema)

Optional. Das Schema der Eingabeargumente des MCP-Tools.
outputSchema

object (Schema)

Optional. Das Schema der Ausgabeargumente des MCP-Tools.
serverAddress

string

Erforderlich. Die Serveradresse des MCP-Servers, z.B. „https://example.com/mcp/“. Wenn der Server mit dem MCP SDK erstellt wurde, sollte die URL mit „/mcp/“ enden. Es werden nur Streamable HTTP-Transport-basierte Server unterstützt. Dies entspricht der server_address im McpToolset. Weitere Informationen finden Sie unter https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

Optional. Authentifizierungsinformationen, die zum Ausführen des Tools auf dem MCP-Server erforderlich sind. Bei der Bearer-Token-Authentifizierung gilt das Token nur für die Ausführung von Tools, nicht für die Auflistung von Tools. Dazu müssen Tools ohne Authentifizierung aufgeführt werden können.
tlsConfig

object (TlsConfig)

Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration für VPC-SC, die zum Auflösen von Dienstnamen innerhalb eines Perimeters verwendet wird.
customHeaders

map (key: string, value: string)

Optional. Die benutzerdefinierten Header, die in der Anfrage an den MCP-Server gesendet werden sollen. Die Werte müssen das Format $context.variables.<name_of_variable> haben und können in den Sitzungsvariablen festgelegt werden. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Nur Ausgabe. Der dynamische Verfügbarkeitsstatus des Tools auf dem externen Server.

CustomHeadersEntry

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

string
value

string

FileSearchTool

JSON-Darstellung 
{
  "corpusType": enum (CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
Felder
corpusType

enum (CorpusType)

Optional. Der Typ des Korpus. Der Standardwert ist FULLY_MANAGED.
name

string

Erforderlich. Der Name des Tools.
description

string

Optional. Die Tool-Beschreibung.
fileCorpus

string

Optional. Das Corpus, in dem Dateien gespeichert werden. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

SystemTool

JSON-Darstellung 
{
  "name": string,
  "description": string
}
Felder
name

string

Erforderlich. Der Name des Systemtools.
description

string

Nur Ausgabe. Die Beschreibung des Systemtools.

AgentTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "agent": string
}
Felder
name

string

Erforderlich. Der Name des Agent-Tools.
description

string

Optional. Beschreibung des Zwecks des Tools.
agent

string

Optional. Der Ressourcenname des KI-Agenten, der der Einstiegspunkt des Tools ist. Format: projects/{project}/locations/{location}/agents/{agent}

WidgetTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
Felder
name

string

Erforderlich. Der Anzeigename des Widget-Tools.
description

string

Optional. Die Beschreibung des Widget-Tools.
widgetType

enum (WidgetType)

Optional. Der Typ des Widget-Tools. Wenn keine Angabe erfolgt, wird der Standardtyp CUSTOMIZED verwendet.
uiConfig

object (Struct format)

Optional. Konfiguration für das Rendern des Widgets.
dataMapping

object (DataMapping)

Optional. Die Zuordnung, die definiert, wie Daten aus einem Quelltool den Eingabeparametern des Widgets zugeordnet werden.
textResponseConfig

object (TextResponseConfig)

Optional. Konfiguration für Textantworten, die immer enthalten sind.
Union-Feld input. Die Eingabe des Widget-Tools. Für input ist nur einer der folgenden Werte zulässig:
parameters

object (Schema)

Optional. Die Eingabeparameter des Widget-Tools.

DataMapping

JSON-Darstellung 
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (Mode),
  "pythonScript": string
}
Felder
sourceToolName

string

Optional. Der Ressourcenname des Tools, das die Daten für das Widget bereitstellt, z.B. ein Suchtool oder eine benutzerdefinierte Funktion. Format: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
fieldMappings

map (key: string, value: string)

Optional. Eine Zuordnung von Widget-Eingabeparameterfeldern zu den entsprechenden Ausgabefeldern des Quelltools.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
pythonFunction

object (PythonFunction)

Optional. Konfiguration für eine Python-Funktion, mit der die Ausgabe des Quelltools in das Eingabeformat des Widgets transformiert wird.
mode

enum (Mode)

Optional. Der Modus des Datenabgleichs.
pythonScript
(deprecated)

string

Nicht mehr unterstützt: Verwenden Sie stattdessen python_function.

FieldMappingsEntry

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

string
value

string

TextResponseConfig

JSON-Darstellung 
{
  "type": enum (Type),
  "staticText": string,
  "textResponseInstruction": string
}
Felder
type

enum (Type)

Optional. Die Strategie für die Bereitstellung der Textantwort.
staticText

string

Optional. Die statische Textantwort, die zurückgegeben werden soll, wenn der Typ STATIC ist.
textResponseInstruction

string

Optional. Anweisung für das LLM, wie die Textantwort generiert werden soll. Wird als Beschreibung für den Textantwortparameter verwendet, wenn der Typ LLM_GENERATED ist.

RemoteAgentTool

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  },
  "apiAuthentication": {
    object (ApiAuthentication)
  }
}
Felder
name

string

Erforderlich. Der Name des Tools.
description

string

Erforderlich. Die Beschreibung des Tools.
agentCard

object (AgentCard)

Erforderlich. Die Agentenkarte des Remote-Agenten, der von diesem Tool aufgerufen wird.
apiAuthentication

object (ApiAuthentication)

Optional. Authentifizierungskonfiguration für den Aufruf des Remote-Agents.

AgentCard

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
Felder
name

string

Erforderlich. Ein menschenlesbarer Name für den KI-Agenten.
description

string

Erforderlich. Eine Beschreibung des Handlungs- bzw. Lösungsbereichs des KI-Agenten.
supportedInterfaces[]

object (AgentInterface)

Erforderlich. Geordnete Liste der unterstützten Schnittstellen. Der erste Eintrag wird bevorzugt.
version

string

Erforderlich. Die Version des Agents.
skills[]

object (AgentSkill)

Erforderlich. Skills stellen eine Einheit von Fähigkeiten dar, die ein Agent ausführen kann. Das ist zwar etwas abstrakt, stellt aber eine gezieltere Reihe von Aktionen dar, die der Agent mit hoher Wahrscheinlichkeit ausführen kann.

AgentInterface

JSON-Darstellung 
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
Felder
url

string

Erforderlich. Die URL, unter der diese Schnittstelle verfügbar ist. Muss in der Produktion eine gültige absolute HTTPS-URL sein. Beispiel: „https://api.beispiel.de/a2a/v1“, „https://grpc.beispiel.de/a2a“
protocolBinding

string

Erforderlich. Die an dieser URL unterstützte Protokollbindung. Dies ist ein offener Formularstring, der sich leicht für andere Protokollbindungen erweitern lässt. Die offiziell unterstützten Kern-Frameworks sind JSONRPC, GRPC und HTTP+JSON.
tenant

string

Die Mandanten-ID, die in der Anfrage verwendet werden soll, wenn der Agent aufgerufen wird.
protocolVersion

string

Erforderlich. Die Version des A2A Protocol, das von dieser Schnittstelle bereitgestellt wird. Verwenden Sie die neueste unterstützte Nebenversion pro Hauptversion. Beispiele: „0.3“, „1.0“

AgentSkill

JSON-Darstellung 
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
Felder
id

string

Erforderlich. Eine eindeutige Kennung für die Funktion des Agents.
name

string

Erforderlich. Ein für Menschen lesbarer Name für den Skill.
description

string

Erforderlich. Eine detaillierte Beschreibung des Skills.
tags[]

string

Erforderlich. Eine Reihe von Keywords, die die Fähigkeiten des Skills beschreiben.
examples[]

string

Beispiel-Prompts oder ‑Szenarien, die mit dieser Skill bearbeitet werden können.
inputModes[]

string

Die Menge der unterstützten Eingabemedientypen für diesen Skill, die die Standardeinstellungen des Agenten überschreiben.
outputModes[]

string

Die Menge der unterstützten Ausgabemedientypen für diesen Skill, die die Standardeinstellungen des Agenten überschreiben.

ToolFakeConfig

JSON-Darstellung 
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
Felder
enableFakeMode

boolean

Optional. Gibt an, ob das Tool den Fiktivmodus verwendet.
Union-Feld tool_response. Die Antwort ist entweder statisch oder wird von einer Python-Funktion bereitgestellt. Für tool_response ist nur einer der folgenden Werte zulässig:
codeBlock

object (CodeBlock)

Optional. Codeblock, der anstelle eines echten Tool-Aufrufs ausgeführt wird.

CodeBlock

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

string

Erforderlich. Python-Code, der im Tool-Fake-Modus aufgerufen wird. Erwartete Python-Funktionssignatur: Um alle Tool-Aufrufe abzufangen: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Um einen bestimmten Tool-Aufruf abzufangen: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Wenn die Funktion „None“ zurückgibt, wird stattdessen das echte Tool aufgerufen.

Beispiel

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "entryAgent": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "invalid": boolean,
  "etag": string
}
Felder
name

string

ID. Die eindeutige ID des Beispiels. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
displayName

string

Erforderlich. Anzeigename des Beispiels.
description

string

Optional. Eine menschenlesbare Beschreibung des Beispiels.
entryAgent

string

Optional. Der Agent, der die Unterhaltung ursprünglich bearbeitet. Wenn nichts angegeben ist, wird das Beispiel für eine Unterhaltung verwendet, die vom Stamm-Agent bearbeitet wird. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]

object (Message)

Optional. Die Sammlung von Nachrichten, aus denen die Unterhaltung besteht.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Beispiels.

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 des Beispiels.

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"
invalid

boolean

Nur Ausgabe. Das Beispiel kann ungültig werden, wenn referenzierte Ressourcen gelöscht werden. Ungültige Beispiele werden nicht als Few-Shot-Beispiele verwendet.
etag

string

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.

Nachricht

JSON-Darstellung 
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
Felder
role

string

Optional. Die Rolle in der Unterhaltung, z.B. „user“ (Nutzer) oder „agent“ (Agent).
chunks[]

object (Chunk)

Optional. Inhalt der Nachricht als Reihe von Chunks.
eventTime

string (Timestamp format)

Optional. Zeitstempel für das Senden oder Empfangen der Nachricht. Sollte nicht verwendet werden, wenn die Nachricht Teil einer example ist.

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

Chunk

JSON-Darstellung 
{

  // Union field data can be only one of the following:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of list of possible types for union field data.
}
Felder
Union-Feld data. Daten in Blöcke aufteilen. Für data ist nur einer der folgenden Werte zulässig:
text

string

Optional. Textdaten.
transcript

string

Optional. Transkript, das mit dem Audio verknüpft ist.
blob

object (Blob)

Optional. Blob-Daten.
payload

object (Struct format)

Optional. Benutzerdefinierte Nutzlastdaten.
image

object (Image)

Optional. Bilddaten.
toolCall

object (ToolCall)

Optional. Anfrage zur Toolausführung.
toolResponse

object (ToolResponse)

Optional. Antwort auf die Toolausführung.
agentTransfer

object (AgentTransfer)

Optional. Ereignis für die Übertragung von Agenten.
updatedVariables

object (Struct format)

Ein Struct stellt Variablen dar, die in der Unterhaltung aktualisiert wurden, wobei die Variablennamen als Schlüssel verwendet werden.
defaultVariables

object (Struct format)

Eine Struktur stellt Standardvariablen zu Beginn der Unterhaltung dar, die nach Variablennamen sortiert sind.

Blob

JSON-Darstellung 
{
  "mimeType": string,
  "data": string
}
Felder
mimeType

string

Erforderlich. Der IANA-Standard-MIME-Typ der Quelldaten.
data

string (bytes format)

Erforderlich. Rohbyte des Blobs.

Ein base64-codierter String.

Bild

JSON-Darstellung 
{
  "mimeType": string,
  "data": string
}
Felder
mimeType

string

Erforderlich. Der IANA-Standard-MIME-Typ der Quelldaten. Unterstützte Bildtypen: * image/png * image/jpeg * image/webp
data

string (bytes format)

Erforderlich. Rohbyte des Bildes.

Ein base64-codierter String.

ToolCall

JSON-Darstellung 
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Felder
id

string

Optional. Die eindeutige ID des Tool-Aufrufs. Wenn das Feld ausgefüllt ist, sollte der Client das Ausführungsergebnis mit der ID zum Abgleich in ToolResponse zurückgeben.
displayName

string

Nur Ausgabe. Anzeigename des Tools.
args

object (Struct format)

Optional. Die Eingabeparameter und ‑werte für das Tool im JSON-Objektformat.
parentToolCallId

string

Nur Ausgabe. Die ID des Tool-Aufrufs, der diesen Aufruf verursacht hat, wenn er von einem untergeordneten Agenten im Namen eines übergeordneten Aufrufs ausgegeben wurde. Leer für Aufrufe der obersten Ebene. Ermöglicht es einem Client, die Arbeit eines untergeordneten Agents unter dem Aufruf zu gruppieren, der ihn gestartet hat, anstatt jeden Schritt als gleichgeordnetes Element darzustellen.
agentName

string

Nur Ausgabe. Ein menschenlesbarer Name des KI-Agenten, der diesen Aufruf ausgegeben hat, z.B. „Contract Architect“. Leer, wenn der Root-Agent die Anfrage gestellt hat.
Union-Feld tool_identifier. Die Kennung des auszuführenden Tools. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool

string

Optional. Der Name des auszuführenden Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Optional. Das Toolset-Tool, das ausgeführt werden soll.

ToolsetTool

JSON-Darstellung 
{
  "toolset": string,
  "toolId": string
}
Felder
toolset

string

Erforderlich. Der Ressourcenname des Toolsets, aus dem dieses Tool abgeleitet wird. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolId

string

Optional. Die Tool-ID, nach der die Tools gefiltert werden sollen, um das Schema abzurufen.

ToolResponse

JSON-Darstellung 
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Felder
id

string

Optional. Die ID zum Abgleich des tool call, auf den sich die Antwort bezieht.
displayName

string

Nur Ausgabe. Anzeigename des Tools.
response

object (Struct format)

Erforderlich. Das Ergebnis der Tool-Ausführung im JSON-Objektformat. Verwenden Sie den Schlüssel „output“, um die Tool-Antwort anzugeben, und den Schlüssel „error“, um Fehlerdetails anzugeben (falls vorhanden). Wenn die Schlüssel „output“ und „error“ nicht angegeben sind, wird die gesamte „response“ als Ergebnis der Tool-Ausführung behandelt.
parentToolCallId

string

Nur Ausgabe. Die ID des Tool-Aufrufs, der diesen Aufruf verursacht hat, wenn er von einem untergeordneten Agenten im Namen eines übergeordneten Aufrufs ausgegeben wurde. Leer für Aufrufe der obersten Ebene. Ermöglicht es einem Client, die Arbeit eines untergeordneten Agents unter dem Aufruf zu gruppieren, der ihn gestartet hat, anstatt jeden Schritt als gleichgeordnetes Element darzustellen.
agentName

string

Nur Ausgabe. Ein menschenlesbarer Name des KI-Agenten, der diesen Aufruf ausgegeben hat, z.B. „Contract Architect“. Leer, wenn der Root-Agent die Anfrage gestellt hat.
Union-Feld tool_identifier. Die Kennung des Tools, das ausgeführt wurde. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool

string

Optional. Der Name des auszuführenden Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Optional. Das Toolset-Tool, das ausgeführt wurde.

AgentTransfer

JSON-Darstellung 
{
  "targetAgent": string,
  "displayName": string
}
Felder
targetAgent

string

Erforderlich. Der Agent, an den die Unterhaltung übertragen wird. Der Agent übernimmt die Unterhaltung ab diesem Punkt. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Nur Ausgabe. Anzeigename des KI-Agenten.

Schutzmaßnahme

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "enabled": boolean,
  "action": {
    object (TriggerAction)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field guardrail_type can be only one of the following:
  "contentFilter": {
    object (ContentFilter)
  },
  "llmPromptSecurity": {
    object (LlmPromptSecurity)
  },
  "llmPolicy": {
    object (LlmPolicy)
  },
  "modelSafety": {
    object (ModelSafety)
  },
  "codeCallback": {
    object (CodeCallback)
  }
  // End of list of possible types for union field guardrail_type.
}
Felder
name

string

ID. Die eindeutige ID der Richtlinie. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
displayName

string

Erforderlich. Anzeigename der Richtlinie.
description

string

Optional. Beschreibung der Richtlinie.
enabled

boolean

Optional. Gibt an, ob die Schutzvorrichtung aktiviert ist.
action

object (TriggerAction)

Optional. Aktion, die ausgeführt werden soll, wenn die Richtlinie ausgelöst wird.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung der Richtlinie.

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

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

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.
Union-Feld guardrail_type. Art der Schutzmaßnahme. Für guardrail_type ist nur einer der folgenden Werte zulässig:
contentFilter

object (ContentFilter)

Optional. Schutzmechanismus, der verhindert, dass bestimmte Inhalte in der Unterhaltung verwendet werden.
llmPromptSecurity

object (LlmPromptSecurity)

Optional. Schutzfunktion, die die Unterhaltung blockiert, wenn der Prompt basierend auf der LLM-Klassifizierung als unsicher eingestuft wird.
llmPolicy

object (LlmPolicy)

Optional. Guardrail, die die Unterhaltung blockiert, wenn die LLM-Antwort basierend auf der LLM-Klassifizierung als Richtlinienverstoß eingestuft wird.
modelSafety

object (ModelSafety)

Optional. Guardrail, die die Unterhaltung blockiert, wenn die LLM-Antwort basierend auf den Sicherheitseinstellungen des Modells als unsicher eingestuft wird.
codeCallback

object (CodeCallback)

Optional. Guardrail, die die Unterhaltung basierend auf dem Ergebnis der Callback-Ausführung möglicherweise blockiert.

ContentFilter

JSON-Darstellung 
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean
}
Felder
bannedContents[]

string

Optional. Liste verbotener Ausdrücke. Gilt sowohl für Nutzereingaben als auch für Antworten von KI-Agenten.
bannedContentsInUserInput[]

string

Optional. Liste verbotener Ausdrücke. Gilt nur für Nutzereingaben.
bannedContentsInAgentResponse[]

string

Optional. Liste verbotener Ausdrücke. Gilt nur für Antworten von Kundenservicemitarbeitern.
matchType

enum (MatchType)

Erforderlich. Keyword-Option für den Inhaltsfilter.
disregardDiacritics

boolean

Optional. Wenn der Wert „true“ ist, werden diakritische Zeichen beim Abgleich ignoriert.

LlmPromptSecurity

JSON-Darstellung 
{
  "failOpen": boolean,

  // Union field security_config can be only one of the following:
  "defaultSettings": {
    object (DefaultSecuritySettings)
  },
  "customPolicy": {
    object (LlmPolicy)
  }
  // End of list of possible types for union field security_config.
}
Felder
failOpen

boolean

Optional. Bestimmt das Verhalten, wenn bei der Schutzmaßnahme ein LLM-Fehler auftritt. – Bei „true“ wird die Schutzvorrichtung umgangen. – „false“ (Standard): Die Richtlinie wird ausgelöst bzw. blockiert.

Hinweis: Wenn eine benutzerdefinierte Richtlinie angegeben wird, wird dieses Feld zugunsten der „fail_open“-Konfiguration der Richtlinie ignoriert.
Union-Feld security_config. Definiert den Modus der Sicherheitskonfiguration. Der Nutzer muss eine der folgenden Konfigurationen auswählen. Für security_config ist nur einer der folgenden Werte zulässig:
defaultSettings

object (DefaultSecuritySettings)

Optional. Die vordefinierten Standardsicherheitseinstellungen des Systems verwenden. Wenn Sie diesen Modus auswählen möchten, fügen Sie eine leere „default_settings“-Nachricht in die Anfrage ein. Das Feld „default_prompt_template“ wird vom Server in der Antwort ausgefüllt.
customPolicy

object (LlmPolicy)

Optional. Verwenden Sie eine benutzerdefinierte LlmPolicy, um den Sicherheitsmechanismus zu konfigurieren.

DefaultSecuritySettings

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

string

Nur Ausgabe. Die vom System verwendete Standardvorlage für Prompts. Dieses Feld dient dazu, dem Nutzer anzuzeigen, welchen Prompt das System standardmäßig verwendet. Es ist OUTPUT_ONLY.

LlmPolicy

JSON-Darstellung 
{
  "maxConversationMessages": integer,
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "policyScope": enum (PolicyScope),
  "failOpen": boolean,
  "allowShortUtterance": boolean
}
Felder
maxConversationMessages

integer

Optional. Bei der Überprüfung dieser Richtlinie werden die letzten „n“ Nachrichten in der Unterhaltung berücksichtigt. Wenn kein Wert festgelegt ist, wird der Standardwert 10 verwendet.
modelSettings

object (ModelSettings)

Optional. Modelleinstellungen.
prompt

string

Erforderlich. Richtlinien-Prompt.
policyScope

enum (PolicyScope)

Erforderlich. Definiert, wann die Richtlinienprüfung während der Unterhaltung angewendet werden soll. Wenn sie auf „POLICY_SCOPE_UNSPECIFIED“ gesetzt ist, wird die Richtlinie auf die Nutzereingabe angewendet. Wenn die Richtlinie auf die Antwort des Agents angewendet wird, kommt es zu einer zusätzlichen Latenz, bevor der Agent antworten kann.
failOpen

boolean

Optional. Wenn während der Richtlinienprüfung ein Fehler auftritt, wird die Anfrage nicht blockiert und die Guardrail wird nicht ausgelöst.
allowShortUtterance

boolean

Optional. Standardmäßig wird die LLM-Richtlinienprüfung bei kurzen Äußerungen umgangen. Wenn Sie diese Einstellung aktivieren, wird die Richtlinienprüfung auf alle Äußerungen angewendet, auch auf solche, die normalerweise übersprungen würden.

ModelSafety

JSON-Darstellung 
{
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ]
}
Felder
safetySettings[]

object (SafetySetting)

Erforderlich. Liste der Sicherheitseinstellungen.

SafetySetting

JSON-Darstellung 
{
  "category": enum (HarmCategory),
  "threshold": enum (HarmBlockThreshold)
}
Felder
category

enum (HarmCategory)

Erforderlich. Die Schadenskategorie.
threshold

enum (HarmBlockThreshold)

Erforderlich. Der Schwellenwert für die Schadensblockierung

CodeCallback

JSON-Darstellung 
{
  "beforeAgentCallback": {
    object (Callback)
  },
  "afterAgentCallback": {
    object (Callback)
  },
  "beforeModelCallback": {
    object (Callback)
  },
  "afterModelCallback": {
    object (Callback)
  }
}
Felder
beforeAgentCallback

object (Callback)

Optional. Der Callback, der vor dem Aufrufen des Agents ausgeführt werden soll. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, in dem die Entscheidung erläutert wird. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
afterAgentCallback

object (Callback)

Optional. Der Callback, der nach dem Aufrufen des Agenten ausgeführt werden soll. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, in dem die Entscheidung erläutert wird. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
beforeModelCallback

object (Callback)

Optional. Der Callback, der vor dem Aufrufen des Modells ausgeführt werden soll. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, in dem die Entscheidung erläutert wird. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
afterModelCallback

object (Callback)

Optional. Der Callback, der nach dem Aufrufen des Modells ausgeführt werden soll. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, in dem die Entscheidung erläutert wird. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.

TriggerAction

JSON-Darstellung 
{

  // Union field action can be only one of the following:
  "respondImmediately": {
    object (RespondImmediately)
  },
  "transferAgent": {
    object (TransferAgent)
  },
  "generativeAnswer": {
    object (GenerativeAnswer)
  }
  // End of list of possible types for union field action.
}
Felder
Union-Feld action. Die erforderliche Aktion. Für action ist nur einer der folgenden Werte zulässig:
respondImmediately

object (RespondImmediately)

Optional. Sofort mit einer vorkonfigurierten Antwort reagieren.
transferAgent

object (TransferAgent)

Optional. Leiten Sie die Unterhaltung an einen anderen Kundenservicemitarbeiter weiter.
generativeAnswer

object (GenerativeAnswer)

Optional. Mit einer generativen Antwort antworten.

RespondImmediately

JSON-Darstellung 
{
  "responses": [
    {
      object (Response)
    }
  ]
}
Felder
responses[]

object (Response)

Erforderlich. Die Antwortvorlagen, aus denen der Agent auswählen kann. Die Antwort wird zufällig ausgewählt.

Antwort

JSON-Darstellung 
{
  "text": string,
  "disabled": boolean
}
Felder
text

string

Erforderlich. Text, mit dem der Agent antworten soll.
disabled

boolean

Optional. Gibt an, ob die Antwort deaktiviert ist. Deaktivierte Antworten werden vom KI-Agenten nicht verwendet.

TransferAgent

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

string

Erforderlich. Der Name des Agents, an den die Unterhaltung übertragen werden soll. Der Agent muss sich in derselben App wie der aktuelle Agent befinden. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

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

string

Erforderlich. Der Prompt, der für die generative Antwort verwendet werden soll.

Toolset

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
Felder
name

string

ID. Die eindeutige ID des Toolsets. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

Optional. Der Anzeigename des Toolsets. Muss innerhalb derselben App eindeutig sein.
description

string

Optional. Die Beschreibung des Toolsets.
timeout

string (Duration format)

Optional. Das Zeitlimit für die Toolset-Ausführung. Wenn nichts anderes festgelegt ist, beträgt das Standard-Zeitlimit 30 Sekunden für SYNCHRONOUS-Toolsets und 60 Sekunden für ASYNCHRONOUS-Toolsets.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung des Toolsets.

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 des Toolsets.

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

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

enum (ExecutionType)

Optional. Der Ausführungstyp der Tools im Toolset.
toolFakeConfig

object (ToolFakeConfig)

Optional. Konfiguration für das Verhalten von Tools im Fälschungsmodus.
Union-Feld toolset_type. Der Typ des Toolsets. Für toolset_type ist nur einer der folgenden Werte zulässig:
mcpToolset

object (McpToolset)

Optional. Ein Toolset, das eine Liste der Tools enthält, die vom MCP-Server angeboten werden.
openApiToolset

object (OpenApiToolset)

Optional. Ein Toolset, das eine Liste von Tools enthält, die durch ein OpenAPI-Schema definiert werden.
connectorToolset

object (ConnectorToolset)

Optional. Eine Sammlung von Tools, die aus einer Integration Connectors-Verbindung generiert werden.

McpToolset

JSON-Darstellung 
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Felder
serverAddress

string

Erforderlich. Die Adresse des MCP-Servers, z. B. „https://beispiel.de/mcp/“. Wenn der Server mit dem MCP SDK erstellt wurde, sollte die URL mit „/mcp/“ enden. Es werden nur Streamable HTTP-Transport-basierte Server unterstützt. Weitere Informationen finden Sie unter https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
apiAuthentication

object (ApiAuthentication)

Optional. Authentifizierungsinformationen, die für den Zugriff auf Tools und die Ausführung eines Tools auf dem MCP-Server erforderlich sind. Bei der Bearer-Token-Authentifizierung gilt das Token nur für die Ausführung von Tools, nicht für die Auflistung von Tools. Dazu müssen Tools ohne Authentifizierung aufgeführt werden können.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration für VPC-SC, die zum Auflösen von Dienstnamen innerhalb eines Perimeters verwendet wird.
tlsConfig

object (TlsConfig)

Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
customHeaders

map (key: string, value: string)

Optional. Die benutzerdefinierten Header, die in der Anfrage an den MCP-Server gesendet werden sollen. Die Werte müssen das Format $context.variables.<name_of_variable> haben und können in den Sitzungsvariablen festgelegt werden. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
toolOverrides[]

object (McpToolOverride)

Optional. Überschreibungen für einzelne Tools in diesem Toolset. So können Sie bestimmte Details wie Beschreibungen oder Namen überschreiben oder den Status der Tools fixieren, damit er nicht vollständig dynamisch ist.

CustomHeadersEntry

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

string
value

string

McpToolOverride

JSON-Darstellung 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Felder
tool

string

Erforderlich. Der ursprüngliche Name des Tools, wie er vom MCP-Server ausgegeben wird.
nameOverride

string

Optional. Wenn dieser Name vorhanden ist, wird er im Agent anstelle des ursprünglichen Namens verwendet. Dies wird hauptsächlich als Alias verwendet, wenn der MCP-Server schlecht benannte Tools anbietet.
descriptionOverride

string

Optional. Falls vorhanden, wird diese Beschreibung anstelle der ursprünglichen Beschreibung vom Server verwendet.
snapshot

object (McpToolDefinition)

Nur Ausgabe. Wenn das Tool vorhanden ist, wird es angepinnt und verwendet die Snapshot-Werte als Fallback, wenn der Server vorübergehend nicht verfügbar ist oder keine Überschreibung vorhanden ist.

McpToolDefinition

JSON-Darstellung 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Felder
description

string

Nur Ausgabe. Die Beschreibung des MCP-Tools. Dies kann durch description_override in McpToolOverride überschrieben werden.
inputSchema

object (Schema)

Nur Ausgabe. Das Schema der Eingabeargumente des MCP-Tools.
outputSchema

object (Schema)

Nur Ausgabe. Das Schema der Ausgabeargumente des MCP-Tools.

OpenApiToolset

JSON-Darstellung 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Felder
openApiSchema

string

Erforderlich. Das OpenAPI-Schema des Toolsets.
apiAuthentication

object (ApiAuthentication)

Optional. Von der API benötigte Authentifizierungsinformationen.
tlsConfig

object (TlsConfig)

Optional. Die TLS-Konfiguration. Benutzerdefinierte Serverzertifikate sind enthalten
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Optional. Service Directory-Konfiguration.
ignoreUnknownFields

boolean

Optional. Bei „true“ ignoriert der Agent unbekannte Felder in der API-Antwort für alle im OpenAPI-Schema definierten Vorgänge.
url

string

Optional. Die Server-URL des Open API-Schemas. Dieses Feld wird nur in Toolsets in den Umgebungsabhängigkeiten während des Exportvorgangs festgelegt, wenn das Schema eine Server-URL enthält. Wenn diese URL während des Importvorgangs in den Umgebungsabhängigkeiten vorhanden ist und das Schema den Platzhalter $env_var enthält, wird der Platzhalter im Schema ersetzt.

ConnectorToolset

JSON-Darstellung 
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Felder
connection

string

Erforderlich. Der vollständige Ressourcenname der referenzierten Integration Connectors-Verbindung. Format: projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

Optional. Konfiguriert, wie die Authentifizierung in Integration Connectors gehandhabt wird. Standardmäßig wird eine Administratorauthentifizierung in den Integration Connectors API-Anfragen übergeben. Sie können sie mit einer anderen Konfiguration für die Endnutzerauthentifizierung überschreiben. Hinweis: Für die Verbindung muss die Authentifizierungsüberschreibung aktiviert sein, damit Sie hier eine EUC-Konfiguration angeben können. Andernfalls schlägt die Erstellung des Toolsets fehl. Weitere Informationen finden Sie unter https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
connectorActions[]

object (Action)

Erforderlich. Die Liste der Connector-Aktionen/Entitätsvorgänge, für die Tools generiert werden sollen.

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_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

Richtung

Die Richtung der Übertragung.

Enums
DIRECTION_UNSPECIFIED Nicht angegebene Richtung.
PARENT_TO_CHILD Übertragung vom übergeordneten Agent zum untergeordneten Agent.
CHILD_TO_PARENT Übertragung vom untergeordneten zum übergeordneten Agent.

RequestLocation

Der Speicherort des API-Schlüssels in der Anfrage.

Enums
REQUEST_LOCATION_UNSPECIFIED Nicht angegeben. Dieser Wert sollte nicht verwendet werden.
HEADER Stellt den Schlüssel im HTTP-Header dar.
QUERY_STRING Stellt den Schlüssel im Abfragestring dar.

OauthGrantType

OAuth-Berechtigungstypen. Es wird nur die Gewährung von Clientanmeldedaten unterstützt.

Enums
OAUTH_GRANT_TYPE_UNSPECIFIED Nicht angegeben. Die Standardeinstellung ist CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Stellt den Ablauf für Clientanmeldedaten dar.

OperationType

Der Vorgang, der für die Entität ausgeführt werden soll.

Enums
OPERATION_TYPE_UNSPECIFIED Vorgangstyp nicht angegeben. Ungültig. Das Erstellen/Aktualisieren von ConnectorTool schlägt fehl.
LIST Vorgang auflisten.
GET Vorgang abrufen
CREATE Vorgang erstellen
UPDATE Aktualisierungsvorgang.
DELETE Löschvorgang.

DataStoreType

Der Typ des Datenspeichers.

Enums
DATA_STORE_TYPE_UNSPECIFIED Nicht angegeben. Dieser Wert gibt an, dass der Datenspeichertyp nicht angegeben ist. Er wird daher bei der Suche nicht verwendet.
PUBLIC_WEB Ein Datenspeicher, der öffentliche Webinhalte enthält.
UNSTRUCTURED Ein Datenspeicher, der unstrukturierte private Daten enthält.
FAQ Ein Datenspeicher, der strukturierte Daten enthält, die als FAQs verwendet werden.
CONNECTOR Ein Datenspeicher, der ein Connector zu einem selbst erhobenen oder einem Drittanbieterdienst ist.

DocumentProcessingMode

Der Dokumentverarbeitungsmodus des Datenspeichers.

Enums
DOCUMENT_PROCESSING_MODE_UNSPECIFIED Nicht angegeben.
DOCUMENTS Dokumente werden als Dokumente verarbeitet.
CHUNKS Dokumente werden in Blöcke unterteilt.

AttributeType

Das Attribut (oder die Funktion), auf das bzw. die das benutzerdefinierte Ranking angewendet werden soll.

Enums
ATTRIBUTE_TYPE_UNSPECIFIED Nicht angegebener AttributeType.
NUMERICAL Der Wert des numerischen Felds wird verwendet, um den Boost-Betrag dynamisch zu aktualisieren. In diesem Fall ist der „attribute_value“ (der x-Wert) des Kontrollpunkts der tatsächliche Wert des numerischen Felds, für das „boost_amount“ definiert ist.
FRESHNESS Im Anwendungsfall „Aktualität“ ist der Attributwert die Zeitspanne zwischen der aktuellen Uhrzeit und dem Datum im angegebenen Datums-/Uhrzeitfeld. Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]]. Beispiele: 5D, 3DT12H30M, T24H.

InterpolationType

Anzuwendender Interpolationstyp. Der Standardwert ist „linear“ (Piecewise Linear).

Enums
INTERPOLATION_TYPE_UNSPECIFIED Der Interpolationstyp ist nicht angegeben. In diesem Fall wird standardmäßig der Typ „Linear“ verwendet.
LINEAR Die „PiecewiseLinear“-Interpolation wird angewendet.

ModalityType

Der Modalitätstyp.

Enums
MODALITY_TYPE_UNSPECIFIED Nicht angegebener Modalitätstyp.
TEXT Textmodalität.
AUDIO Audio-Modalität

FilterParameterBehavior

Verhalten von Filterparametern.

Enums
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED Standardverhalten von Filtern. Filterparameter für Connector-Datenspeicher einbeziehen Bei den restlichen Datenspeichertypen wird der Filter-Eingabeparameter weggelassen.
ALWAYS_INCLUDE Fügen Sie immer einen Filterparameter für alle Datenspeichertypen ein.
NEVER_INCLUDE Der Filterparameter ist unabhängig vom Datenspeichertyp nie in der Liste der Tool-Parameter enthalten.

Bundesland

Stellt den dynamischen Verfügbarkeitsstatus des Tools dar.

Enums
STATE_UNSPECIFIED Standardstatus.
ACTIVE Das Tool ist verfügbar und wird aktiv vom Server angeboten.
INACTIVE Das Tool ist konfiguriert oder angepinnt, wird aber derzeit nicht vom Server angeboten.
STALE Das Tool ist auf dem Server vorhanden, stimmt aber nicht mit der Version auf dem Server überein.

CorpusType

Der Typ des Vertex-RAG-Korpus.

Enums
CORPUS_TYPE_UNSPECIFIED Nicht angegebener Korpus-Typ.
USER_OWNED Das Corpus wird vom Nutzer erstellt und gehört ihm.
FULLY_MANAGED Der Korpus wird vom Agenten erstellt.

WidgetType

Alle verfügbaren Widgettypen. Dieser Enum können in Zukunft neue Werte hinzugefügt werden.

Enums
WIDGET_TYPE_UNSPECIFIED Nicht angegebener Widget-Typ.
CUSTOM Benutzerdefinierter Widget-Typ.
PRODUCT_DETAILS Widget mit Produktdetails.
QUICK_ACTIONS Schnellaktionen-Widget
PRODUCT_COMPARISON Widget für den Produktvergleich.
ADVANCED_PRODUCT_DETAILS Widget mit weitergehenden Produktdetails
SHORT_FORM Kurzform-Widget
OVERALL_SATISFACTION Widget zur Gesamtzufriedenheit
ORDER_SUMMARY Widget für die Bestellübersicht
APPOINTMENT_DETAILS Widget mit Termin-Details.
APPOINTMENT_SCHEDULER Widget für die Terminplanung
CONTACT_FORM Kontaktformular-Widget

Modus

Die Strategie, die zum Zuordnen von Daten aus dem Quelltool zum Widget verwendet wird.

Enums
MODE_UNSPECIFIED Nicht angegebener Modus.
FIELD_MAPPING Verwenden Sie die field_mappings-Karte für die Datentransformation.
PYTHON_SCRIPT Verwenden Sie python_script für die Datentransformation.

Typ

Definiert, wie die Textantwort erstellt wird.

Enums
TYPE_UNSPECIFIED Nicht definierter Typ.
NONE Das LLM entscheidet dynamisch, ob neben dem Widget eine Textantwort generiert werden soll, basierend auf dem Gesprächskontext.
LLM_GENERATED Das LLM muss explizit eine Textantwort generieren.
STATIC Es wird immer eine vordefinierte statische Textantwort verwendet.

ExecutionType

Der Ausführungstyp des Tools oder Toolsets.

Enums
EXECUTION_TYPE_UNSPECIFIED Der Ausführungstyp ist nicht angegeben. Wenn kein Wert angegeben wird, gilt der Standardwert SYNCHRONOUS.
SYNCHRONOUS Das Tool wird synchron ausgeführt. Die Sitzung wird blockiert, bis das Tool zurückgegeben wird.
ASYNCHRONOUS Das Tool wird asynchron ausgeführt. Die Sitzung wird fortgesetzt, während das Tool ausgeführt wird.

MatchType

Keyword-Option für den Inhaltsfilter.

Enums
MATCH_TYPE_UNSPECIFIED Die Keyword-Option ist nicht angegeben.
SIMPLE_STRING_MATCH Inhalte werden zeichenweise auf Teilstrings abgeglichen.
WORD_BOUNDARY_STRING_MATCH Inhalte werden nur dann als Übereinstimmung erkannt, wenn das im Text gefundene Muster von Worttrennzeichen umgeben ist. Verbotene Ausdrücke können auch Worttrennzeichen enthalten.
REGEXP_MATCH Inhalte werden mithilfe der Syntax für reguläre Ausdrücke abgeglichen.

PolicyScope

Definiert, wann die Richtlinienprüfung während der Unterhaltung angewendet werden soll.

Enums
POLICY_SCOPE_UNSPECIFIED Der Richtlinienbereich ist nicht angegeben.
USER_QUERY Die Richtlinienprüfung wird durch Nutzereingaben ausgelöst.
AGENT_RESPONSE Die Richtlinienprüfung wird bei der Antwort des KI-Agents ausgelöst. Wenn Sie diesen Richtlinienbereich anwenden, kommt es zu zusätzlichen Latenzzeiten, bevor der Agent antworten kann.
USER_QUERY_AND_AGENT_RESPONSE Die Richtlinienprüfung wird sowohl bei Nutzereingaben als auch bei Antworten des KI-Agenten ausgelöst. Wenn Sie diesen Richtlinienbereich anwenden, kommt es zu zusätzlichen Latenzzeiten, bevor der Agent antworten kann.

HarmCategory

Schadenskategorie

Enums
HARM_CATEGORY_UNSPECIFIED Die Schadenskategorie ist nicht angegeben.
HARM_CATEGORY_HATE_SPEECH Die Schadenskategorie ist Hassrede.
HARM_CATEGORY_DANGEROUS_CONTENT Die Schadenskategorie ist gefährlicher Inhalt.
HARM_CATEGORY_HARASSMENT Die Schadenskategorie ist Belästigung.
HARM_CATEGORY_SEXUALLY_EXPLICIT Die Schadenskategorie umfasst sexuell anstößige Inhalte.
HARM_CATEGORY_PROFANITY Die Schadenskategorie ist Obszönität.
HARM_CATEGORY_TOXIC Die Schadenskategorie ist „Schädlich“.

HarmBlockThreshold

Wahrscheinlichkeitsbasierte Schwellenwertebenen für die Blockierung

Enums
HARM_BLOCK_THRESHOLD_UNSPECIFIED Unbekannter Schwellenwert für die Schadensblockierung
BLOCK_LOW_AND_ABOVE Niedrigen Schwellenwert und höher blockieren (d. h. mehr blockieren)
BLOCK_MEDIUM_AND_ABOVE Mittleren Schwellenwert und höher blockieren
BLOCK_ONLY_HIGH Nur einen hohen Schwellenwert blockieren (d. h. weniger blockieren)
BLOCK_NONE Nichts blockieren
OFF Sicherheitsfilter deaktivieren

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.

Destruktiver Hinweis: ✅ | Idempotenter Hinweis: ❌ | Nur-Lese-Hinweis: ❌ | Open-World-Hinweis: ❌