MCP Tools Reference: ces.googleapis.com

Tool: create_app

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

Im folgenden Beispiel wird gezeigt, wie Sie mit curl das MCP-Tool create_app aufrufen.

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

Eingabeschema

Anfragenachricht für AgentService.CreateApp.

CreateAppRequest

JSON-Darstellung 
{
  "parent": string,
  "appId": string,
  "app": {
    object (App)
  }
}
Felder
parent

string

Erforderlich. Der Ressourcenname des Standorts, an dem eine App erstellt werden soll.
appId

string

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

object (App)

Erforderlich. Die zu erstellende 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)
  },
  "locked": boolean
}
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-Grenzwerte 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 Schutzmaßnahmen 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.
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.

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

string

Optional. 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 Agentenantwort synthetisiert werden soll, 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 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 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 Agents für die Unterbrechungsaktivitäten des Nutzers.
inactivityTimeout

string (Duration format)

Optional. Die Dauer der Inaktivität des Nutzers (keine Sprache oder Interaktion), bevor der Agent den Nutzer zur erneuten Interaktion auffordert. Wenn diese Einstellung nicht festgelegt ist, wird der Nutzer vom Kundenservicemitarbeiter nicht aufgefordert, sich noch einmal zu melden.

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 Agentenantwort wiedergegeben werden soll, um die Natürlichkeit der Unterhaltung zu verbessern.

SynthesizeSpeechConfigsEntry

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

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

JSON-Darstellung 
{
  "voice": string,
  "speakingRate": number
}
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.
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.

BargeInConfig

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

boolean

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

Eingestellt: disable_barge_in wird zugunsten von disable_barge_in_control in ChannelProfile eingestellt.
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 Grenzen 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 natürlichen Lautstärke, mit der der betreffende Sprecher normalerweise spricht, 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. Verworfen: prebuilt_ambient_noise wurde zugunsten von prebuilt_ambient_sound verworfen.
gcsUri

string

Optional. Umgebungsgeräusche als Mono-Channel-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)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
Felder
redactionConfig

object (RedactionConfig)

Optional. Konfiguration, wie sensible Daten entfernt werden sollen.
audioRecordingConfig

object (AudioRecordingConfig)

Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen.
bigqueryExportSettings

object (BigQueryExportSettings)

Optional. Einstellungen zur Beschreibung des BigQuery-Exportverhaltens für die App. Die Konversationsdaten 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 Audioaufzeichnung für Evaluationssitzungen nicht aktiviert.
metricAnalysisSettings

object (MetricAnalysisSettings)

Optional. Einstellungen zur Beschreibung des Verhaltens bei der Erhebung von Unterhaltungsdaten 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, einschließlich Konversationsverlauf, 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. Das BigQuery-Dataset, in das 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
}
Felder
disableConversationLogging

boolean

Optional. Gibt an, ob das Protokollieren von Unterhaltungen für die Sitzungen deaktiviert werden soll.

MetricAnalysisSettings

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

boolean

Optional. Gibt an, ob Unterhaltungsdaten für Messwerte zur Analyse von Large Language Models erfasst werden sollen. Bei „true“ werden keine Konversationsdaten für LLM-Analyse-Messwerte erhoben. Andernfalls werden Konversationsdaten erhoben.

ErrorHandlingSettings

JSON-Darstellung 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy)
}
Felder
errorHandlingStrategy

enum (ErrorHandlingStrategy)

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

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 Messwerts für Halluzinationen bei Szenariobewertungen.

GoldenEvaluationMetricsThresholds

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

object (TurnLevelMetricsThresholds)

Optional. Die Schwellenwerte für Messwerte auf Kampagnenebene.
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 nicht mit einem Tool-Aufruf in der Golden-Erwartung übereinstimmt.

TurnLevelMetricsThresholds

JSON-Darstellung 
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
Felder
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Optional. Der Channel für semantische Ähnlichkeit, der für die Bewertung verwendet werden soll.

Union-Feld _semantic_similarity_success_threshold.

Für _semantic_similarity_success_threshold ist nur einer der folgenden Werte zulässig:
semanticSimilaritySuccessThreshold

integer

Optional. Der Erfolgsschwellenwert für die semantische Ähnlichkeit. Muss eine Ganzzahl zwischen 0 und 4 sein. Der Standardwert ist >= 3.

Union-Feld _overall_tool_invocation_correctness_threshold.

Für _overall_tool_invocation_correctness_threshold ist nur einer der folgenden Werte zulässig:
overallToolInvocationCorrectnessThreshold

number

Optional. Der Schwellenwert für die korrekte Tool-Aufrufe 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 Tool-Aufruf. 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, Zahlen 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, die von ref verwendet werden. 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 einen Nullwert dar.
numberValue

number

Stellt einen Double-Wert dar.
stringValue

string

Stellt einen Stringwert dar.
boolValue

boolean

Stellt einen booleschen Wert dar.
structValue

object (Struct format)

Stellt einen strukturierten Wert dar.
listValue

array (ListValue format)

Stellt eine wiederholte Value 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)

Wiederholtes 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)
  },
  "disableDtmf": boolean,
  "disableBargeInControl": boolean,
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "noiseSuppressionLevel": string
}
Felder
profileId

string

Optional. Die eindeutige ID des Channelprofils.
channelType

enum (ChannelType)

Optional. Der Typ des Channelprofils.
personaProperty

object (PersonaProperty)

Optional. Die Persona-Eigenschaft des Kanalprofils.
disableDtmf

boolean

Optional. Gibt an, ob DTMF (Dual-Tone-Multifrequenz) deaktiviert werden soll.
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.
webWidgetConfig

object (WebWidgetConfig)

Optional. Die Konfiguration für das Web-Widget.
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 leer, 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.

MetadataEntry

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

string
value

string

Zeitstempel

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

string (int64 format)

Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss 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.

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

Ausgabeschema

Diese Ressource steht für einen Vorgang mit langer Ausführungszeit, der das Ergebnis eines Netzwerk-API-Aufrufs ist.

Vorgang

JSON-Darstellung 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Felder
name

string

Der vom Server zugewiesene Name, der nur innerhalb des Dienstes eindeutig ist, der ihn ursprünglich zurückgibt. Wenn Sie die Standard-HTTP-Zuordnung verwenden, sollte name ein Ressourcenname sein, der auf operations/{unique_id} endet.
metadata

object

Dienstspezifische Metadaten, die mit dem Vorgang verknüpft sind. Typischerweise enthalten sie Informationen zum Verlauf und gemeinsame Metadaten wie den Erstellungszeitpunkt. Solche Metadaten werden nicht von allen Diensten bereitgestellt. Jede Methode, die einen Vorgang mit langer Ausführungszeit zurückgibt, muss gegebenenfalls den Metadatentyp dokumentieren.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }
done

boolean

Ist der Wert false, bedeutet das, dass der Vorgang noch läuft. Ist der Wert hingegen true, ist der Vorgang abgeschlossen und entweder error oder response ist verfügbar.
Union-Feld result. Das Ergebnis des Vorgangs kann entweder ein error oder eine gültige response sein. Wenn done = false ist, wird weder error noch response festgelegt. Wenn done = true ist, kann genau ein error oder eine response festgelegt werden. Einige Dienste stellen das Ergebnis möglicherweise nicht bereit. Für result ist nur einer der folgenden Werte zulässig:
error

object (Status)

Das Fehlerergebnis des Vorgangs im Fall eines Fehlers oder Abbruchs.
response

object

Die normale, erfolgreiche Antwort des Vorgangs. Wenn die ursprüngliche Methode im Erfolgsfall keine Daten zurückgibt, wie bei Delete, lautet die Antwort google.protobuf.Empty. Ist die ursprüngliche Methode standardmäßig Get/Create/Update, sollte die Antwort die Ressource sein. Bei anderen Methoden sollte die Antwort vom Typ XxxResponse sein, wobei Xxx der Name der ursprünglichen Methode ist. Wenn zum Beispiel der Name der ursprünglichen Methode TakeSnapshot() ist, ist der gefolgerte Antworttyp TakeSnapshotResponse.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Beliebig

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

string

Gibt den Typ der serialisierten Protobuf-Nachricht mit einem URI-Verweis an, der aus einem Präfix, das mit einem Schrägstrich endet, und dem vollständig qualifizierten Typnamen besteht.

Beispiel: type.googleapis.com/google.protobuf.StringValue

Dieser String muss mindestens ein /-Zeichen enthalten. Der Inhalt nach dem letzten / muss der vollständig qualifizierte Name des Typs in kanonischer Form ohne führenden Punkt sein. Schreiben Sie kein Schema für diese URI-Referenzen, damit Clients nicht versuchen, sie zu kontaktieren.

Das Präfix ist beliebig und Protobuf-Implementierungen sollen einfach alles bis zum letzten / (einschließlich) entfernen, um den Typ zu ermitteln. type.googleapis.com/ ist ein häufiges Standardpräfix, das für einige ältere Implementierungen erforderlich ist. Dieses Präfix gibt nicht den Ursprung des Typs an und URIs, die es enthalten, werden voraussichtlich nicht auf Anfragen reagieren.

Alle Typ-URL-Strings müssen gültige URI-Referenzen sein. Für das Textformat gilt die zusätzliche Einschränkung, dass der Inhalt der Referenz nur aus alphanumerischen Zeichen, prozentual codierten Escape-Sequenzen und Zeichen aus der folgenden Menge bestehen darf (ohne die äußeren Backticks): /-.~_!$&()*+,;=. Obwohl wir Prozentcodierungen zulassen, sollten Implementierungen sie nicht dekodieren, um Verwechslungen mit vorhandenen Parsern zu vermeiden. Beispiel: type.googleapis.com%2FFoo sollte abgelehnt werden.

Im ursprünglichen Design von Any wurde die Möglichkeit in Betracht gezogen, einen Dienst zur Typauflösung unter diesen Typ-URLs zu starten. Protobuf hat jedoch nie einen solchen Dienst implementiert und betrachtet das Kontaktieren dieser URLs als problematisch und als potenzielles Sicherheitsproblem. Versuchen Sie nicht, URLs vom Typ „Kontakt“ aufzurufen.
value

string (bytes format)

Enthält eine Protobuf-Serialisierung des Typs, der durch „type_url“ beschrieben wird.

Ein base64-codierter String.

Status

JSON-Darstellung 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.
message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede für Nutzer sichtbare Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.
details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

Tool-Annotationen

Destruktiver Hinweis: ✅ | Idempotenter Hinweis: ❌ | Nur-Lese-Hinweis: ❌ | Open-World-Hinweis: ❌