REST Resource: projects.locations.apps

Ressource: App

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

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 (App.ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (App.VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (App.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,
  "evaluationPersonas": [
    {
      object (EvaluationPersona)
    }
  ],
  "evaluationSettings": {
    object (EvaluationSettings)
  },
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
Felder
name

string

ID. Die eindeutige Kennung der App. Format: projects/{project}/locations/{location}/apps/{app}
displayName

string

Erforderlich. Anzeigename der App.
description

string

Optional. Eine menschenlesbare Beschreibung der App.
pinned

boolean

Optional. Gibt an, ob die App in der Liste der Apps angepinnt ist.
rootAgent

string

Optional. Der Root-Agent ist der Einstiegspunkt der Anwendung. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Optional. Spracheinstellungen der App.
timeZoneSettings

object (TimeZoneSettings)

Optional. Zeitzoneneinstellungen der App.
audioProcessingConfig

object (AudioProcessingConfig)

Optional. Konfiguration der Audioverarbeitung der App.
loggingSettings

object (LoggingSettings)

Optional. Logging-Einstellungen der App.
errorHandlingSettings

object (ErrorHandlingSettings)

Optional. Fehlerbehandlungseinstellungen der App.
modelSettings

object (ModelSettings)

Optional. Die Standardeinstellungen für das LLM-Modell der Anwendung. Einzelne Ressourcen (z.B. Agenten, Guardrails) können diese Konfigurationen bei Bedarf überschreiben.
toolExecutionMode

enum (App.ToolExecutionMode)

Optional. Der Tool-Ausführungsmodus für die Anwendung. Wenn nicht angegeben, wird standardmäßig PARALLEL verwendet.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Optional. Die Bewertungsschwellenwerte für die App.
variableDeclarations[]

object (App.VariableDeclaration)

Optional. Die Deklarationen der Variablen.
predefinedVariableDeclarations[]

object (App.VariableDeclaration)

Nur Ausgabe. Die Deklarationen vordefinierter Variablen für die App.
globalInstruction

string

Optional. Anweisungen für alle Agenten in der Anwendung. Mit dieser Anweisung können Sie eine stabile Identität oder Persönlichkeit für alle Agenten einrichten.
guardrails[]

string

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

object (DataStoreSettings)

Optional. Die Datenspeichereinstellungen für die Anwendung.
defaultChannelProfile

object (ChannelProfile)

Optional. Das von der App verwendete Standardkanalprofil.
metadata

map (key: string, value: string)

Optional. Metadaten zur App. In diesem Feld können zusätzliche Informationen zu den Details oder Verwendungszwecken der App gespeichert werden.

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

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung der App.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
etag

string

Nur Ausgabe. Etag, mit dem sichergestellt wird, dass sich das Objekt während eines Lesevorgangs mit anschließender Änderung und Schreibvorgang nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
deploymentCount

integer

Nur Ausgabe. Anzahl der Deployments in der Anwendung.
clientCertificateSettings

object (ClientCertificateSettings)

Optional. Die Standardeinstellungen für Clientzertifikate für die App.
vpcScSettings

object (VpcScSettings)

Optional. VPC-SC-Einstellungen für die Anwendung.
locked

boolean

Optional. Gibt an, ob die App für Änderungen gesperrt ist. Wenn die App gesperrt ist, werden Änderungen an den App-Ressourcen abgelehnt.
evaluationPersonas[]

object (EvaluationPersona)

Optional. Die Bewertungs-Personas für die App. In diesem Feld werden die Personas definiert, die für die Bewertung verwendet werden können. Es können maximal 30 Personas definiert werden.
evaluationSettings

object (EvaluationSettings)

Optional. Die Bewertungseinstellungen für die App.
validationErrors[]

string

Nur Ausgabe. Fehlkonfigurationen oder Warnungen in der App.
dashboardSettings

object (DashboardSettings)

Optional. Anwendungsspezifische Dashboard-Einstellungen zum Verknüpfen und Konfigurieren von Contact Center Insights-Dashboards.

LanguageSettings

Spracheinstellungen der App.

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 defaultLanguageCode.
enableMultilingualSupport

boolean

Optional. Aktiviert die Unterstützung mehrerer Sprachen. Wenn true, verwenden Agenten in der App vordefinierte Anweisungen, um die Verarbeitung mehrsprachiger Eingaben zu verbessern.
fallbackAction
(deprecated)

string

Optional. Eingestellt: Diese Funktion wird nicht mehr unterstützt. Verwenden Sie stattdessen enableMultilingualSupport, um die Verarbeitung mehrsprachiger Eingaben zu verbessern. Die Aktion, die ausgeführt werden soll, wenn ein Agent Eingaben in einer nicht unterstützten Sprache empfängt.

Das kann eine vordefinierte Aktion oder ein benutzerdefinierter Toolaufruf sein. Gültige Werte sind: – Der vollständige Ressourcenname eines Tools, der die Ausführung eines bestimmten Tools auslöst. – Eine vordefinierte Systemaktion wie „Eskalieren“ oder „Beenden“, die ein EndSession-Signal mit dem entsprechenden metadata auslöst, um die Unterhaltung zu beenden.

TimeZoneSettings

Zeitzoneneinstellungen der App.

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

string

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

AudioProcessingConfig

Konfiguration für die Verarbeitung und Bereitstellung der Audioeingabe und -ausgabe.

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

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

Optional. Konfiguration der Synthese der KI-Agentenantwort, Zuordnung vom Sprachcode zu SynthesizeSpeechConfig.

Wenn die Konfiguration für den angegebenen Sprachcode nicht gefunden wird, wird die Konfiguration für den Stamm-Sprachcode verwendet. Wenn die Zuordnung beispielsweise „en-us“ und „en“ enthält und der angegebene Sprachcode „en-gb“ ist, wird die Konfiguration „en“ verwendet.

Hinweis: Beim Sprachcode wird die Groß-/Kleinschreibung nicht berücksichtigt.

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

object (BargeInConfig)

Optional. Konfiguriert das Verhalten des KI-Agenten für die Unterbrechungsaktivitäten des Nutzers.
inactivityTimeout

string (Duration format)

Optional. Die Dauer der Nutzerinaktivität (keine Sprache oder Interaktion), bevor der Agent den Nutzer auffordert, wieder aktiv zu werden. Wenn nicht festgelegt, fordert der KI-Agent den Nutzer nicht zur erneuten Interaktion auf.

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

object (AmbientSoundConfig)

Optional. Konfiguration für den Umgebungsgeräusch, der mit der synthetisierten Antwort des KI-Agenten abgespielt werden soll, um die Natürlichkeit der Unterhaltung zu verbessern.
customVoiceSamples[]

object (CustomVoiceSample)

Optional. Konfiguriert benutzerdefinierte Sprachproben für das Klonen von Stimmen.

SynthesizeSpeechConfig

Konfiguration für die Synthese der KI-Agentenantwort.

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

string

Optional. Die Bezeichnung der Stimme. Wenn kein Wert festgelegt ist, wählt der Dienst eine Stimme anhand der anderen Parameter wie „languageCode“ aus.

Eine Liste der verfügbaren Stimmen finden Sie unter Unterstützte Stimmen und Sprachen von Cloud Text-to-Speech.
speakingRate

number

Optional. Die Sprechgeschwindigkeit im Bereich [0,25, 2,0]. 1,0 ist die natürliche Geschwindigkeit, mit der der betreffende Sprecher normalerweise spricht. 2,0 bedeutet doppelt so schnell, 0,5 halb so schnell. Werte außerhalb des Bereichs [0,25, 2,0] führen zu einem Fehler.
model

string

Optional. Das Modell, das zum Synthetisieren von Audio verwendet wird. Derzeit unterstützte Werte: - „gemini-3.1-flash-tts-preview“. Wenn leer, wird Chirp3-HD verwendet.
instruction

string

Optional. Die Anweisung, die zum Synthetisieren von Sprache verwendet wird, wenn ein generatives Modell verwendet wird.

BargeInConfig

Konfiguration für die Verarbeitung von Unterbrechungsaktivitäten des Nutzers.

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

boolean

Optional. Verworfen: disableBargeIn wird zugunsten von disableBargeInControl in ChannelProfile verworfen.

Deaktiviert das Unterbrechen durch den Nutzer, während der Agent spricht. Wenn „true“ festgelegt ist, werden Nutzereingaben während der Wiedergabe der Antwort des KI-Agenten ignoriert.
bargeInAwareness

boolean

Optional. Wenn diese Option aktiviert ist, passt der KI-Agent seine nächste Antwort an, wobei er davon ausgeht, dass der Nutzer die vorherige Nachricht des KI-Agenten nicht vollständig gehört hat. Diese Option sollte nicht in Szenarien verwendet werden, in denen die Antworten des Kundenservicemitarbeiters visuell dargestellt werden.

AmbientSoundConfig

Konfiguration für den Umgebungsgeräusch, der mit der synthetisierten Antwort des KI-Agenten abgespielt werden soll, um die Natürlichkeit der Unterhaltung zu verbessern.

JSON-Darstellung 
{
  "volumeGainDb": number,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prebuiltAmbientNoise": enum (AmbientSoundConfig.PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of mutually exclusive fields.
}
Felder
volumeGainDb

number

Optional. Lautstärkeverstärkung (in dB) der normalen nativen Lautstärke, die durch Umgebungsgeräusche unterstützt wird, im Bereich [-96,0, 16,0]. Wenn dieser Wert nicht festgelegt oder ein Wert von 0,0 (dB) eingestellt ist, erfolgt die Wiedergabe mit der natürlichen Signalamplitude. Bei einem Wert von –6,0 (dB) erfolgt die Wiedergabe mit einer Signalamplitude, die etwa halb so hoch wie die natürliche ist. Bei einem Wert von +6.0 (dB) erfolgt die Wiedergabe mit einer Signalamplitude, die etwa doppelt so hoch wie die natürliche ist. Es wird dringend empfohlen, +10 (dB) nicht zu überschreiten, da es bei einem höheren Wert in der Regel zu keiner effektiven Erhöhung der Lautstärke kommt.
Umgebungsgeräusche, die mit der synthetisierten Agent-Antwort abgespielt werden sollen, um die Natürlichkeit der Unterhaltung zu verbessern. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
prebuiltAmbientNoise
(deprecated)

enum (AmbientSoundConfig.PrebuiltAmbientNoise)

Optional. Eingestellt: prebuiltAmbientNoise wurde zugunsten von prebuiltAmbientSound eingestellt.
gcsUri

string

Optional. Umgebungsgeräusche als einkanalige WAV-Datei mit 16 kHz, die in Cloud Storage gespeichert ist.

Hinweis: Der CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com muss die Berechtigung storage.objects.get für das Cloud Storage-Objekt haben.
prebuiltAmbientSound

string

Optional. Name des vordefinierten Umgebungsgeräuschs. Gültige Werte sind: - „coffee_shop“ - „keyboard“ - „keypad“ - „hum“ - „office_1“ - „office_2“ - „office_3“ - „room_1“ - „room_2“ - „room_3“ - „room_4“ - „room_5“ - „air_conditioner“
Ende der sich gegenseitig ausschließenden Felder.

AmbientSoundConfig.PrebuiltAmbientNoise

Vordefinierte Umgebungsgeräusche.

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

CustomVoiceSample

Konfiguration für ein benutzerdefiniertes Sprachbeispiel, das für das Klonen von Stimmen verwendet wird.

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

string

Optional. Der benutzerdefinierte Name für das Custom Voice-Beispiel.
voiceSampleGcsUri

string

Optional. Der Cloud Storage-URI des Audiobeispiels für das Klonen von Stimmen. Das Audiobeispiel sollte eine einkanalige WAV-Datei mit 24 kHz sein.
consentAudioGcsUri

string

Optional. Audio zur Einwilligung in das Klonen der Stimme.
voiceInstruction

string

Optional. Anweisungen in natürlicher Sprache für den Sprachstil, den Ton, das Tempo oder die Aussprache.
previewAudioContent

string (bytes format)

Nur Ausgabe. Synthetisiertes Vorschau-Audio für Custom Voice, formatiert als kanonisches WAV (LINEAR16, 24 kHz, 16 Bit, Mono).

Ein base64-codierter String.
previewText

string

Optional. Text zum Synthetisieren von Vorschauaudio für die benutzerdefinierte Stimme.
warnings[]

object (CustomVoiceSample.Warning)

Nur Ausgabe. Warnmeldungen, die während der Verarbeitung des geklonten Sprachmodells aufgetreten sind (z.B. niedriger Audiopegel).
voiceInstructionMode

enum (CustomVoiceSample.VoiceInstructionMode)

Optional. Anweisungsmodus für die Sprachprobe. Wenn nicht angegeben, wird standardmäßig NO_INSTRUCTION verwendet.

CustomVoiceSample.Warning

Eine Warnmeldung, die während der Verarbeitung der Sprachprobe ausgegeben wird.

JSON-Darstellung 
{
  "message": string,
  "type": enum (CustomVoiceSample.Warning.WarningType)
}
Felder
message

string

Nur Ausgabe. Eine menschenlesbare Beschreibung der Warnung.
type

enum (CustomVoiceSample.Warning.WarningType)

Nur Ausgabe. Der Typ der Warnung.

CustomVoiceSample.Warning.WarningType

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

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

CustomVoiceSample.VoiceInstructionMode

Anweisungsmodus für die Sprachprobe.

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

LoggingSettings

Einstellungen, die das Logging-Verhalten der App beschreiben.

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

object (RedactionConfig)

Optional. Konfiguration für die Unkenntlichmachung sensibler Daten.
audioRecordingConfig

object (AudioRecordingConfig)

Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen. Die Audiodaten werden gemäß der Konfiguration in RedactionConfig entfernt.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Optional. Konfiguriert eine zusätzliche Aufzeichnung von nicht bearbeiteten Audiodaten. Damit kann eine Kopie der Rohaudiodaten beibehalten werden, wenn die Audioredaktion enabled ist, in der Regel zu Prüf- oder Monitoringzwecken.
bigqueryExportSettings

object (BigQueryExportSettings)

Optional. Konfiguriert das BigQuery-Exportverhalten für die Anwendung. Die Unterhaltungsdaten werden gemäß der Konfiguration in RedactionConfig entfernt.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Optional. Konfiguriert das BigQuery-Exportverhalten für die Anwendung. Wenn diese Option aktiviert ist, werden die nicht bearbeiteten Unterhaltungsdaten in BigQuery-Tabellen exportiert.
cloudLoggingSettings

object (CloudLoggingSettings)

Optional. Einstellungen, die das Cloud Logging-Verhalten für die Anwendung beschreiben.
conversationLoggingSettings

object (ConversationLoggingSettings)

Optional. Einstellungen, die das Logging-Verhalten für Unterhaltungen der Anwendung beschreiben.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Optional. Konfiguration, wie Audiointeraktionen für die Bewertung aufgezeichnet werden sollen. Standardmäßig ist die Audioaufzeichnung für Bewertungssitzungen nicht aktiviert.
metricAnalysisSettings

object (MetricAnalysisSettings)

Optional. Einstellungen, die das Verhalten bei der Erhebung von Unterhaltungsdaten für die LLM-Analysepipeline der App beschreiben.

RedactionConfig

Konfiguration, die angibt, wie sensible Daten behandelt werden sollen.

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

boolean

Optional. Wenn true, wird die Entfernung in verschiedenen Logging-Szenarien angewendet, einschließlich Unterhaltungsverlauf, Cloud Logging und Audioaufzeichnung.
inspectTemplate

string

Optional. Name der DLP-Prüfvorlage, um die Erkennung sensibler Datentypen zu konfigurieren.

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

string

Optional. Name der DLP-De-Identifikationsvorlage, die angibt, wie Inhalte de-identifiziert werden sollen.

Format: projects/{project}/locations/{location}/deidentifyTemplates/{deidentifyTemplate}

AudioRecordingConfig

Konfiguration für die Aufzeichnung der Audiointeraktionen.

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

string

Optional. Der Cloud Storage-Bucket zum Speichern der Audioaufnahmen der Sitzung. Der URI muss mit „gs://“ beginnen.

Wählen Sie einen Bucket-Standort aus, der Ihren Anforderungen an den Datenstandort entspricht.

Hinweis: Wenn sich der Cloud Storage-Bucket in einem anderen Projekt als die App befindet, müssen Sie dem CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Berechtigung storage.objects.create erteilen.
gcsPathPrefix

string

Optional. Das Cloud Storage-Pfadpräfix für Audioaufnahmen.

Dieses Präfix kann die folgenden Platzhalter enthalten, die bei der Bereitstellung dynamisch ersetzt werden: - $project: Projekt-ID - $location: App-Standort - $app: App-ID - $date: Sitzungsdatum im Format JJJJ-MM-TT - $session: Sitzungs-ID

Wenn das Pfadpräfix nicht angegeben ist, wird das Standardpräfix $project/$location/$app/$date/$session/ verwendet.

BigQueryExportSettings

Einstellungen, die das BigQuery-Exportverhalten für die App beschreiben.

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

Einstellungen, die das Cloud Logging-Verhalten für die Anwendung beschreiben.

JSON-Darstellung 
{
  "enableCloudLogging": boolean
}
Felder
enableCloudLogging

boolean

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

ConversationLoggingSettings

Einstellungen, die das Logging-Verhalten für Unterhaltungen der Anwendung beschreiben.

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

Einstellungen zur Beschreibung des Verhaltens bei der Datenerhebung für Unterhaltungen für die Pipeline für LLM-Analysemesswerte.

JSON-Darstellung 
{
  "llmMetricsOptedOut": boolean
}
Felder
llmMetricsOptedOut

boolean

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

ErrorHandlingSettings

Einstellungen, die beschreiben, wie Fehler in der App behandelt werden sollen.

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

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

Optional. Die Strategie, die für die Fehlerbehandlung verwendet werden soll.
fallbackResponseConfig

object (ErrorHandlingSettings.FallbackResponseConfig)

Optional. Konfiguration für die Verarbeitung von Fallback-Antworten.
endSessionConfig

object (ErrorHandlingSettings.EndSessionConfig)

Optional. Konfiguration zum Beenden der Sitzung bei Systemfehlern (z.B. LLM-Fehlern).

ErrorHandlingSettings.ErrorHandlingStrategy

Definiert die Strategie für die Fehlerbehandlung.

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

ErrorHandlingSettings.FallbackResponseConfig

Konfiguration für die Verarbeitung von Fallback-Antworten.

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

map (key: string, value: string)

Optional. Die Fallback-Nachrichten bei Systemfehlern (z.B. LLM-Fehlern), zugeordnet nach unterstütztem Sprachcode.

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

integer

Optional. Die maximale Anzahl von Fallback-Versuchen, bevor der Agent das Signal EndSession ausgibt.

ErrorHandlingSettings.EndSessionConfig

Konfiguration zum Beenden der Sitzung bei Systemfehlern (z.B. LLM-Fehlern).

JSON-Darstellung 
{
  "escalateSession": boolean
}
Felder
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 sessionEscalated = 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.

App.ToolExecutionMode

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

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

App.VariableDeclaration

Definiert die Struktur und die Metadaten für eine Variable.

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

string

Erforderlich. Der Name der Variablen. Der Name muss mit einem Buchstaben oder Unterstrich beginnen und darf nur Buchstaben, Ziffern oder Unterstriche enthalten.
description

string

Erforderlich. Die Beschreibung der Variable.
schema

object (Schema)

Erforderlich. Das Schema der Variable.

DataStoreSettings

Datenspeicherbezogene Einstellungen für die App.

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

object (DataStoreSettings.Engine)

Nur Ausgabe. Die Engines für die Anwendung.

DataStoreSettings.Engine

Eine Engine, mit der die Datenspeicher verbunden sind. Weitere Informationen finden Sie unter „Vertex AI Search“: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

JSON-Darstellung 
{
  "name": string,
  "type": enum (DataStoreSettings.Engine.Type)
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname der Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (DataStoreSettings.Engine.Type)

Nur Ausgabe. Der Typ der Engine.

DataStoreSettings.Engine.Type

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

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

ClientCertificateSettings

Einstellungen für benutzerdefinierte Clientzertifikate.

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

string

Erforderlich. Das TLS-Zertifikat im PEM-Format. Dieser String muss die Zeilen für den Anfangs-Header und den End-Footer enthalten.
privateKey

string

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

string

Optional. Der Name der Secret-Versionsressource des Secret Manager, in der die Passphrase zum Entschlüsseln des privaten Schlüssels gespeichert ist. Sollte nicht festgelegt werden, wenn der private Schlüssel nicht verschlüsselt ist. Format: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

VPC-SC-Einstellungen für die Anwendung.

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

string

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

EvaluationSettings

Einstellungen für die Bewertung.

JSON-Darstellung 
{
  "scenarioConversationInitiator": enum (EvaluationSettings.ScenarioConversationInitiator),
  "goldenRunMethod": enum (GoldenRunMethod),
  "goldenEvaluationToolCallBehaviour": enum (EvaluationToolCallBehaviour),
  "scenarioEvaluationToolCallBehaviour": enum (EvaluationToolCallBehaviour),
  "metricsConfig": {
    object (EvaluationMetricsConfig)
  },
  "scenarioExecutionMode": enum (EvaluationSettings.ScenarioExecutionMode),
  "evaluationRunCachingSettings": {
    object (EvaluationRunCachingSettings)
  }
}
Felder
scenarioConversationInitiator

enum (EvaluationSettings.ScenarioConversationInitiator)

Optional. Wer die Unterhaltung in einer Szenariobewertung beginnt.
goldenRunMethod

enum (GoldenRunMethod)

Optional. Die Standardmethode, die zum Ausführen von Golden-Bewertungen verwendet wird. Diese wird verwendet, wenn in der RunEvaluationRequest keine goldenRunMethod angegeben ist.
goldenEvaluationToolCallBehaviour

enum (EvaluationToolCallBehaviour)

Optional. Konfiguriert das Standardverhalten für Toolaufrufe für Golden-Evaluierungen.
scenarioEvaluationToolCallBehaviour

enum (EvaluationToolCallBehaviour)

Optional. Konfiguriert das Standardverhalten für Toolaufrufe bei Szenariobewertungen.
metricsConfig

object (EvaluationMetricsConfig)

Optional. Konfiguriert die Standardmesswerte für Bewertungen.
scenarioExecutionMode

enum (EvaluationSettings.ScenarioExecutionMode)

Optional. Der Ausführungsmodus für Szenariobewertungen. Wenn nichts angegeben ist, wird standardmäßig QUALITY_OPTIMIZED verwendet.
evaluationRunCachingSettings

object (EvaluationRunCachingSettings)

Optional. Die Caching-Einstellungen, die für den Bewertungsdurchlauf verwendet werden sollen.

EvaluationSettings.ScenarioConversationInitiator

Bestimmt, wer die Unterhaltung in einer Szenariobewertungssitzung beginnt.

Enums
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED Nicht angegeben. Die Standardeinstellung ist USER.
USER Der Nutzer beginnt die Unterhaltung.
AGENT Der KI-Agent beginnt die Unterhaltung.

DashboardSettings

Einstellungen für Dashboards, die mit der App verknüpft sind und in der Monitoring-Ansicht angezeigt werden.

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

string

Optional. Der Ressourcenname des Standard-Contact Center Insights-Dashboards, das mit der Anwendung verknüpft ist. Dieses Dashboard wird angezeigt, wenn Nutzer die Monitoring-Ansicht für die Anwendung aufrufen.

Format: projects/{project}/locations/{location}/dashboards/{dashboard}

Methoden

chatAiAssistant

 Führt Arc, den KI-Assistenten, für die angegebene Assistentensitzung aus.

create

 Erstellt eine neue Anwendung im angegebenen Projekt und am angegebenen Standort.

delete

 Löscht die angegebene App.

executeTool

 Führt das angegebene Tool mit den angegebenen Argumenten aus.

exportApp

 Exportiert die angegebene Anwendung.

generateAppResource

 Generiert bestimmte Ressourcen (z.B.

generateOnboardingSuggestions

 Generiert personalisierte Onboarding-Vorschläge für den Arc-Nullzustand: Klassifiziert den anfragenden Nutzer (neu / erkundend / wiederkehrend) anhand seines Assistant-Sitzungsverlaufs in der App und gibt Vorschlags-Chips (Sitzung fortsetzen, Arbeit fortsetzen oder etwas Neues beginnen) zurück, die gerendert werden, bevor eine Nachricht gesendet wird.

get

 Ruft Details zur angegebenen App ab.

getExtendedAgentCard

 Ruft die erweiterte KI-Agentenkarte für den authentifizierten KI-Agenten ab.

importApp

 Importiert die angegebene Anwendung.

importEvaluations

 Importiert Bewertungen in die App.

list

 Listet Anwendungen im angegebenen Projekt und am angegebenen Standort auf.

patch

 Aktualisiert die angegebene App.

retrieveToolSchema

 Ruft das Schema des angegebenen Tools ab.

runAssistant

 Führt den KI-Agenten für die angegebene Assistentensitzung aus.

runEvaluation

 Führt eine Bewertung der App aus.

testPersonaVoice

 Testet die Stimme einer Persona.