MCP Tools Reference: ces.googleapis.com

Strumento: create_app

Crea una nuova app nel progetto e nella località specificati.

Il seguente esempio mostra come utilizzare curl per richiamare lo strumento MCP create_app.

Curl Request 
                  
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
}'

Schema di input

Messaggio di richiesta per AgentService.CreateApp.

CreateAppRequest

Rappresentazione JSON 
{
  "parent": string,
  "appId": string,
  "app": {
    object (App)
  }
}
Campi
parent

string

Obbligatorio. Il nome della risorsa della posizione in cui creare un'app.
appId

string

Facoltativo. L'ID da utilizzare per l'app, che diventerà il componente finale del nome della risorsa dell'app. Se non viene fornito, all'app verrà assegnato automaticamente un ID univoco.
app

object (App)

Obbligatorio. L'app per creare.

App

Rappresentazione JSON 
{
  "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
}
Campi
name

string

Identificatore. L'identificatore univoco dell'app. Formato: projects/{project}/locations/{location}/apps/{app}
displayName

string

Obbligatorio. Nome visualizzato dell'app.
description

string

Facoltativo. Descrizione dell'app leggibile.
pinned

boolean

Facoltativo. Indica se l'app è bloccata nell'elenco delle app.
rootAgent

string

Facoltativo. L'agente principale è l'entry point dell'app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Facoltativo. Impostazioni della lingua dell'app.
timeZoneSettings

object (TimeZoneSettings)

Facoltativo. Impostazioni del fuso orario dell'app.
audioProcessingConfig

object (AudioProcessingConfig)

Facoltativo. Configurazione dell'elaborazione audio dell'app.
loggingSettings

object (LoggingSettings)

Facoltativo. Impostazioni di registrazione nel log dell'app.
errorHandlingSettings

object (ErrorHandlingSettings)

Facoltativo. Impostazioni di gestione degli errori dell'app.
modelSettings

object (ModelSettings)

Facoltativo. Le impostazioni predefinite del modello LLM per l'app. Le singole risorse (ad es. agenti, guardrail) possono eseguire l'override di queste configurazioni in base alle esigenze.
toolExecutionMode

enum (ToolExecutionMode)

Facoltativo. La modalità di esecuzione dello strumento per l'app. Se non viene fornita, il valore predefinito è PARALLEL.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Facoltativo. Le soglie di valutazione per l'app.
variableDeclarations[]

object (VariableDeclaration)

Facoltativo. Le dichiarazioni delle variabili.
predefinedVariableDeclarations[]

object (VariableDeclaration)

Solo output. Le dichiarazioni delle variabili predefinite per l'app.
globalInstruction

string

Facoltativo. Istruzioni per tutti gli agenti nell'app. Puoi utilizzare questa istruzione per impostare un'identità o una personalità stabile per tutti gli agenti.
guardrails[]

string

Facoltativo. Elenco di misure di salvaguardia per l'app. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Facoltativo. Le impostazioni del datastore per l'app.
defaultChannelProfile

object (ChannelProfile)

Facoltativo. Il profilo del canale predefinito utilizzato dall'app.
metadata

map (key: string, value: string)

Facoltativo. Metadati sull'app. Questo campo può essere utilizzato per memorizzare informazioni aggiuntive pertinenti ai dettagli o agli utilizzi previsti dell'app.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo output. Timestamp di creazione dell'app.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento dell'app.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
etag

string

Solo output. Etag utilizzato per garantire che l'oggetto non sia stato modificato durante un'operazione di lettura, modifica e scrittura. Se l'etag è vuoto, l'aggiornamento sovrascriverà eventuali modifiche simultanee.
deploymentCount

integer

Solo output. Numero di deployment nell'app.
clientCertificateSettings

object (ClientCertificateSettings)

Facoltativo. Le impostazioni predefinite del certificato client per l'app.
locked

boolean

Facoltativo. Indica se l'app è bloccata per le modifiche. Se l'app è bloccata, le modifiche alle risorse dell'app verranno rifiutate.

LanguageSettings

Rappresentazione JSON 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
Campi
defaultLanguageCode

string

Facoltativo. Il codice lingua predefinito dell'app.
supportedLanguageCodes[]

string

Facoltativo. Elenco dei codici lingua supportati dall'app, oltre a default_language_code.
enableMultilingualSupport

boolean

Facoltativo. Consente il supporto multilingue. Se è true, gli agenti nell'app utilizzeranno istruzioni predefinite per migliorare la gestione dell'input multilingue.
fallbackAction

string

Facoltativo. L'azione da eseguire quando un agente riceve input in una lingua non supportata.

Può trattarsi di un'azione predefinita o di una chiamata allo strumento personalizzata. I valori validi sono: - Il nome risorsa completo di uno strumento, che attiva l'esecuzione di uno strumento specifico. - Un'azione di sistema predefinita, ad esempio "escalate" o "exit", che attiva un segnale EndSession con metadata corrispondente per terminare la conversazione.

TimeZoneSettings

Rappresentazione JSON 
{
  "timeZone": string
}
Campi
timeZone

string

Facoltativo. Il fuso orario dell'app dal database dei fusi orari, ad esempio: America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

Rappresentazione JSON 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  }
}
Campi
synthesizeSpeechConfigs

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

Facoltativo. Configurazione della sintesi della risposta dell'agente, mapping dal codice della lingua a SynthesizeSpeechConfig.

Se la configurazione per il codice lingua specificato non viene trovata, verrà utilizzata la configurazione per il codice lingua principale. Ad esempio, se la mappa contiene "en-us" ed "en" e il codice lingua specificato è "en-gb", verrà utilizzata la configurazione "en".

Nota: il codice lingua non fa distinzione tra maiuscole e minuscole.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Facoltativo. Configura il comportamento dell'agente per le attività di interruzione dell'utente.
inactivityTimeout

string (Duration format)

Facoltativo. La durata dell'inattività dell'utente (nessun comando vocale o interazione) prima che l'agente gli chieda di riprendere l'interazione. Se non viene impostato, l'agente non chiederà all'utente di riprendere l'interazione.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
ambientSoundConfig

object (AmbientSoundConfig)

Facoltativo. Configurazione del suono ambientale da riprodurre con la risposta dell'agente sintetizzata, per migliorare la naturalezza della conversazione.

SynthesizeSpeechConfigsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
Campi
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Rappresentazione JSON 
{
  "voice": string,
  "speakingRate": number
}
Campi
voice

string

Facoltativo. Il nome della voce. Se non viene impostata, il servizio sceglierà una voce in base agli altri parametri, ad esempio language_code.

Per l'elenco delle voci disponibili, consulta Voci e lingue supportate di Cloud Text-to-Speech.
speakingRate

number

Facoltativo. La velocità di lettura nell'intervallo [0,25, 2,0]. 1.0 è la velocità nativa normale supportata dalla voce specifica. 2.0 è il doppio della velocità, mentre 0.5 è la metà della velocità. I valori al di fuori dell'intervallo [0,25, 2,0] restituiranno un errore.

BargeInConfig

Rappresentazione JSON 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Campi
disableBargeIn
(deprecated)

boolean

Facoltativo. Disattiva l'interruzione da parte dell'utente mentre l'agente sta parlando. Se è true, l'input utente durante la riproduzione della risposta dell'agente verrà ignorato.

Deprecato: disable_barge_in è deprecato a favore di disable_barge_in_control in ChannelProfile.
bargeInAwareness

boolean

Facoltativo. Se abilitato, l'agente adatterà la sua risposta successiva in base al presupposto che l'utente non abbia ascoltato l'intero messaggio precedente dell'agente. Non deve essere utilizzato negli scenari in cui le risposte dell'agente vengono visualizzate visivamente.

Durata

Rappresentazione JSON 
{
  "seconds": string,
  "nanos": integer
}
Campi
seconds

string (int64 format)

Secondi firmati dell'intervallo di tempo. Deve essere compreso tra -315.576.000.000 e +315.576.000.000 inclusi. Nota: questi limiti vengono calcolati in base a: 60 sec/min * 60 min/ora * 24 ore/giorno * 365,25 giorni/anno * 10.000 anni
nanos

integer

Frazioni di secondo con segno con risoluzione in nanosecondi dell'intervallo di tempo. Le durate inferiori a un secondo sono rappresentate con un campo seconds pari a 0 e un campo nanos positivo o negativo. Per durate di un secondo o più, un valore diverso da zero per il campo nanos deve avere lo stesso segno del campo seconds. Deve essere compreso tra -999.999.999 e +999.999.999 inclusi.

AmbientSoundConfig

Rappresentazione JSON 
{
  "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.
}
Campi
volumeGainDb

number

Facoltativo. Guadagno di volume (in dB) del volume nativo normale supportato dal rumore ambientale, nell'intervallo [-96,0, 16,0]. Se non è impostato o è impostato su un valore di 0, 0 dB, verrà riprodotto con l'ampiezza del segnale nativo normale. Un valore di -6,0 dB verrà riprodotto a circa metà dell'ampiezza del segnale nativo normale. Un valore di +6,0 (dB) verrà riprodotto a un'ampiezza circa doppia rispetto a quella normale del segnale nativo. Ti consigliamo vivamente di non superare +10 (dB), in quanto di solito non si verifica un aumento effettivo del volume per valori superiori.
Campo unione source. Rumore ambientale da riprodurre con la risposta dell'agente sintetizzata, per migliorare la naturalezza della conversazione. source può essere solo uno dei seguenti tipi:
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

Facoltativo. Deprecato: prebuilt_ambient_noise è deprecato a favore di prebuilt_ambient_sound.
gcsUri

string

Facoltativo. Rumore ambientale come file WAV mono a 16 kHz archiviato in Cloud Storage.

Nota: assicurati che il service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com disponga dell'autorizzazione storage.objects.get per l'oggetto Cloud Storage.
prebuiltAmbientSound

string

Facoltativo. Nome del suono ambientale predefinito. I valori validi sono: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

LoggingSettings

Rappresentazione JSON 
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
Campi
redactionConfig

object (RedactionConfig)

Facoltativo. Configurazione della modalità di oscuramento dei dati sensibili.
audioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configurazione della modalità di registrazione delle interazioni audio.
bigqueryExportSettings

object (BigQueryExportSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di esportazione BigQuery per l'app. Se abilitati, i dati delle conversazioni verranno esportati nelle tabelle BigQuery.
cloudLoggingSettings

object (CloudLoggingSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di Cloud Logging per l'app.
conversationLoggingSettings

object (ConversationLoggingSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di registrazione delle conversazioni per l'app.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configurazione della modalità di registrazione delle interazioni audio per la valutazione. Per impostazione predefinita, la registrazione audio non è attivata per le sessioni di valutazione.
metricAnalysisSettings

object (MetricAnalysisSettings)

Facoltativo. Impostazioni per descrivere i comportamenti di raccolta dei dati delle conversazioni per la pipeline di analisi LLM per l'app.

RedactionConfig

Rappresentazione JSON 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Campi
enableRedaction

boolean

Facoltativo. Se impostato su true, la redazione verrà applicata in vari scenari di logging, tra cui la cronologia delle conversazioni, Cloud Logging e la registrazione audio.
inspectTemplate

string

Facoltativo. Nome del modello di ispezione DLP per configurare il rilevamento dei tipi di dati sensibili.

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

string

Facoltativo. Nome del modello di anonimizzazione DLP per indicare come anonimizzare i contenuti.

Formato: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

Rappresentazione JSON 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
Campi
gcsBucket

string

Facoltativo. Il bucket Cloud Storage in cui archiviare le registrazioni audio della sessione. L'URI deve iniziare con "gs://".

Scegli una posizione del bucket che soddisfi i tuoi requisiti di residenza dei dati.

Nota: se il bucket Cloud Storage si trova in un progetto diverso dall'app, devi concedere l'autorizzazione storage.objects.create al service agent CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Facoltativo. Il prefisso del percorso Cloud Storage per le registrazioni audio.

Questo prefisso può includere i seguenti segnaposto, che verranno sostituiti dinamicamente al momento della pubblicazione: - $project: ID progetto - $location: posizione dell'app - $app: ID app - $date: data della sessione nel formato AAAA-MM-GG - $session: ID sessione

Se il prefisso del percorso non è specificato, verrà utilizzato il prefisso predefinito $project/$location/$app/$date/$session/.

BigQueryExportSettings

Rappresentazione JSON 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
Campi
enabled

boolean

Facoltativo. Indica se l'esportazione in BigQuery è attivata.
project

string

Facoltativo. L'ID progetto del set di dati BigQuery in cui esportare i dati.

Nota: se il set di dati BigQuery si trova in un progetto diverso dall'app, devi concedere il ruolo roles/bigquery.admin all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Facoltativo. Il set di dati BigQuery in cui esportare i dati.

CloudLoggingSettings

Rappresentazione JSON 
{
  "enableCloudLogging": boolean
}
Campi
enableCloudLogging

boolean

Facoltativo. Se abilitare Cloud Logging per le sessioni.

ConversationLoggingSettings

Rappresentazione JSON 
{
  "disableConversationLogging": boolean
}
Campi
disableConversationLogging

boolean

Facoltativo. Se disattivare la registrazione delle conversazioni per le sessioni.

MetricAnalysisSettings

Rappresentazione JSON 
{
  "llmMetricsOptedOut": boolean
}
Campi
llmMetricsOptedOut

boolean

Facoltativo. Se raccogliere i dati delle conversazioni per le metriche di analisi LLM. Se il valore è true, i dati delle conversazioni non verranno raccolti per le metriche di analisi LLM; in caso contrario, verranno raccolti.

ErrorHandlingSettings

Rappresentazione JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy)
}
Campi
errorHandlingStrategy

enum (ErrorHandlingStrategy)

Facoltativo. La strategia da utilizzare per la gestione degli errori.

ModelSettings

Rappresentazione JSON 
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
Campi
model

string

Facoltativo. Il modello LLM che l'agente deve utilizzare. Se non è impostato, l'agente erediterà il modello dall'agente principale.

Campo unione _temperature.

_temperature può essere solo uno dei seguenti tipi:
temperature

number

Facoltativo. Se impostata, questa temperatura verrà utilizzata per il modello LLM. La temperatura controlla la casualità delle risposte del modello. Le temperature più basse producono risposte più prevedibili. Le temperature più alte producono risposte più creative.

EvaluationMetricsThresholds

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

object (GoldenEvaluationMetricsThresholds)

Facoltativo. Le soglie delle metriche di valutazione secondo regole d'oro.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Facoltativo. Deprecato: utilizza golden_hallucination_metric_behavior. Il comportamento della metrica di allucinazione viene attualmente utilizzato per le valutazioni dorate.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Facoltativo. Il comportamento della metrica delle allucinazioni per le valutazioni di riferimento.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Facoltativo. Il comportamento della metrica di allucinazione per le valutazioni degli scenari.

GoldenEvaluationMetricsThresholds

Rappresentazione JSON 
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
Campi
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

Facoltativo. Le soglie delle metriche a livello di turno.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Facoltativo. Le soglie delle metriche del livello di aspettativa.
toolMatchingSettings

object (ToolMatchingSettings)

Facoltativo. Le impostazioni di corrispondenza dello strumento. Una chiamata allo strumento aggiuntiva è una chiamata allo strumento presente nell'esecuzione, ma che non corrisponde ad alcuna chiamata allo strumento nell'aspettativa di riferimento.

TurnLevelMetricsThresholds

Rappresentazione JSON 
{
  "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.
}
Campi
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Facoltativo. Il canale di similarità semantica da utilizzare per la valutazione.

Campo unione _semantic_similarity_success_threshold.

_semantic_similarity_success_threshold può essere solo uno dei seguenti tipi:
semanticSimilaritySuccessThreshold

integer

Facoltativo. La soglia di successo per la somiglianza semantica. Deve essere un numero intero compreso tra 0 e 4. Il valore predefinito è >= 3.

Campo unione _overall_tool_invocation_correctness_threshold.

_overall_tool_invocation_correctness_threshold può essere solo uno dei seguenti tipi:
overallToolInvocationCorrectnessThreshold

number

Facoltativo. La soglia di successo per la correttezza complessiva dell'invocazione dello strumento. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0.

ExpectationLevelMetricsThresholds

Rappresentazione JSON 
{

  // 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.
}
Campi

Campo unione _tool_invocation_parameter_correctness_threshold.

_tool_invocation_parameter_correctness_threshold può essere solo uno dei seguenti tipi:
toolInvocationParameterCorrectnessThreshold

number

Facoltativo. La soglia di successo per la correttezza dei parametri di chiamata dei singoli strumenti. Deve essere un numero in virgola mobile compreso tra 0 e 1. Il valore predefinito è 1.0.

ToolMatchingSettings

Rappresentazione JSON 
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
Campi
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Facoltativo. Comportamento per le chiamate di strumenti aggiuntivi. Il valore predefinito è FAIL.

VariableDeclaration

Rappresentazione JSON 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
Campi
name

string

Obbligatorio. Il nome della variabile. Il nome deve iniziare con una lettera o un trattino basso e contenere solo lettere, numeri o trattini bassi.
description

string

Obbligatorio. La descrizione della variabile.
schema

object (Schema)

Obbligatorio. Lo schema della variabile.

Schema

Rappresentazione JSON 
{
  "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.
}
Campi
type

enum (Type)

Obbligatorio. Il tipo di dati.
properties

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

Facoltativo. Proprietà di Type.OBJECT.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]

string

Facoltativo. Proprietà obbligatorie di Type.OBJECT.
description

string

Facoltativo. La descrizione dei dati.
items

object (Schema)

Facoltativo. Schema degli elementi di Type.ARRAY.
nullable

boolean

Facoltativo. Indica se il valore può essere null.
uniqueItems

boolean

Facoltativo. Indica che gli elementi nell'array devono essere univoci. Si applica solo a TYPE.ARRAY.
prefixItems[]

object (Schema)

Facoltativo. Schemi degli elementi iniziali di Type.ARRAY.
additionalProperties

object (Schema)

Facoltativo. Può essere un valore booleano o un oggetto e controlla la presenza di proprietà aggiuntive.
anyOf[]

object (Schema)

Facoltativo. Il valore deve essere convalidato rispetto a uno o più sottoschema nell'elenco.
enum[]

string

Facoltativo. Valori possibili dell'elemento di tipo primitivo con formato enum. Esempi: 1. Possiamo definire la direzione come : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Possiamo definire il numero di appartamento come : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

Facoltativo. Valore predefinito dei dati.
ref

string

Facoltativo. Consente riferimenti indiretti tra i nodi dello schema. Il valore deve essere un riferimento valido a un elemento secondario della radice defs.

Ad esempio, lo schema seguente definisce un riferimento a un nodo dello schema denominato "Pet":

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

Il valore della proprietà "pet" è un riferimento al nodo dello schema denominato "Pet". Per maggiori dettagli, visita la pagina https://json-schema.org/understanding-json-schema/structuring.
defs

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

Facoltativo. Una mappa delle definizioni da utilizzare per ref. Consentito solo nella radice dello schema.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title

string

Facoltativo. Il titolo dello schema.
minItems

string (int64 format)

Facoltativo. Numero minimo di elementi per Type.ARRAY.
maxItems

string (int64 format)

Facoltativo. Numero massimo di elementi per Type.ARRAY.

Campo unione _minimum.

_minimum può essere solo uno dei seguenti tipi:
minimum

number

Facoltativo. Valore minimo per Type.INTEGER e Type.NUMBER.

Campo unione _maximum.

_maximum può essere solo uno dei seguenti tipi:
maximum

number

Facoltativo. Valore massimo per Type.INTEGER e Type.NUMBER.

PropertiesEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string
value

object (Schema)

Valore

Rappresentazione JSON 
{

  // 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.
}
Campi
Campo unione kind. Il tipo di valore. kind può essere solo uno dei seguenti tipi:
nullValue

null

Rappresenta un valore null.
numberValue

number

Rappresenta un valore double.
stringValue

string

Rappresenta un valore stringa.
boolValue

boolean

Rappresenta un valore booleano.
structValue

object (Struct format)

Rappresenta un valore strutturato.
listValue

array (ListValue format)

Rappresenta un Value ripetuto.

Struct

Rappresentazione JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Campi
fields

map (key: string, value: value (Value format))

Mappa non ordinata di valori con tipo dinamico.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": value
}
Campi
key

string
value

value (Value format)

ListValue

Rappresentazione JSON 
{
  "values": [
    value
  ]
}
Campi
values[]

value (Value format)

Campo ripetuto di valori con tipo dinamico.

DefsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campi
key

string
value

object (Schema)

DataStoreSettings

Rappresentazione JSON 
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
Campi
engines[]

object (Engine)

Solo output. I motori dell'app.

Motore

Rappresentazione JSON 
{
  "name": string,
  "type": enum (Type)
}
Campi
name

string

Solo output. Il nome della risorsa del motore. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (Type)

Solo output. Il tipo di motore.

ChannelProfile

Rappresentazione JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "disableDtmf": boolean,
  "disableBargeInControl": boolean,
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "noiseSuppressionLevel": string
}
Campi
profileId

string

Facoltativo. L'identificatore univoco del profilo del canale.
channelType

enum (ChannelType)

Facoltativo. Il tipo di profilo del canale.
personaProperty

object (PersonaProperty)

Facoltativo. La proprietà della persona del profilo del canale.
disableDtmf

boolean

Facoltativo. Indica se disattivare la tecnologia multifrequenza a due toni (DTMF).
disableBargeInControl

boolean

Facoltativo. Se disattivare il controllo di interruzione dell'utente nella conversazione. - true: le interruzioni dell'utente sono disattivate mentre l'agente parla. - false: l'agente mantiene il controllo automatico su quando l'utente può interrompere.
webWidgetConfig

object (WebWidgetConfig)

Facoltativo. La configurazione del widget web.
noiseSuppressionLevel

string

Facoltativo. Il livello di eliminazione del rumore del profilo del canale. I valori disponibili sono "low", "moderate", "high", "very_high".

PersonaProperty

Rappresentazione JSON 
{
  "persona": enum (Persona)
}
Campi
persona

enum (Persona)

Facoltativo. La personalità del canale.

WebWidgetConfig

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

enum (Modality)

Facoltativo. La modalità del widget web.
theme

enum (Theme)

Facoltativo. Il tema del widget web.
webWidgetTitle

string

Facoltativo. Il titolo del widget web.
securitySettings

object (SecuritySettings)

Facoltativo. Le impostazioni di sicurezza del widget web.

SecuritySettings

Rappresentazione JSON 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Campi
enablePublicAccess

boolean

Facoltativo. Indica se l'accesso pubblico al widget web è abilitato. Se true, il widget web sarà accessibile pubblicamente. Se false, il widget web deve essere integrato con il tuo sistema di autenticazione e autorizzazione per restituire credenziali valide per l'accesso all'agente CES.
enableOriginCheck

boolean

Facoltativo. Indica se il controllo dell'origine per il widget web è abilitato. Se true, il widget web controllerà l'origine del sito web che lo carica e ne consentirà il caricamento solo nella stessa origine o in una delle origini consentite.
allowedOrigins[]

string

Facoltativo. Le origini autorizzate a ospitare il widget web. Un'origine è definita dalla RFC 6454. Se è vuoto, sono consentite tutte le origini. Sono consentite massimo 100 origini. Esempio: "https://example.com"
enableRecaptcha

boolean

Facoltativo. Indica se la verifica reCAPTCHA per il widget web è abilitata.

MetadataEntry

Rappresentazione JSON 
{
  "key": string,
  "value": string
}
Campi
key

string
value

string

Timestamp

Rappresentazione JSON 
{
  "seconds": string,
  "nanos": integer
}
Campi
seconds

string (int64 format)

Rappresenta i secondi di tempo UTC a partire dall'epoca Unix 1970-01-01T00:00:00Z. Deve essere compreso tra -62135596800 e 253402300799 inclusi (corrispondenti a 0001-01-01T00:00:00Z e 9999-12-31T23:59:59Z).
nanos

integer

Frazioni di secondo non negative con risoluzione in nanosecondi. Questo campo è la parte in nanosecondi della durata, non un'alternativa ai secondi. I valori negativi dei secondi con frazioni devono comunque avere valori non negativi dei nanosecondi che vengono conteggiati in avanti nel tempo. Deve essere compreso tra 0 e 999.999.999 inclusi.

ClientCertificateSettings

Rappresentazione JSON 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Campi
tlsCertificate

string

Obbligatorio. Il certificato TLS codificato in formato PEM. Questa stringa deve includere le righe di intestazione iniziale e piè di pagina finale.
privateKey

string

Obbligatorio. Il nome della risorsa della versione secret di Secret Manager che archivia la chiave privata codificata in formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Facoltativo. Il nome della risorsa della versione del secret SecretManager che archivia la passphrase per decriptare la chiave privata. Deve essere lasciato non impostato se la chiave privata non è criptata. Formato: projects/{project}/secrets/{secret}/versions/{version}

Schema di output

Questa risorsa rappresenta un'operazione a lunga esecuzione che è il risultato di una chiamata API di rete.

Operazione

Rappresentazione JSON 
{
  "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.
}
Campi
name

string

Il nome assegnato dal server, che è univoco solo all'interno dello stesso servizio che lo restituisce originariamente. Se utilizzi la mappatura HTTP predefinita, name deve essere un nome risorsa che termina con operations/{unique_id}.
metadata

object

Metadati specifici del servizio associati all'operazione. In genere contengono informazioni sullo stato di avanzamento e metadati comuni come l'ora di creazione. Alcuni servizi potrebbero non fornire questi metadati. Qualsiasi metodo che restituisce un'operazione a lunga esecuzione deve documentare il tipo di metadati, se presenti.

Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo "@type" contenente un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Se il valore è false, significa che l'operazione è ancora in corso. Se è true, l'operazione viene completata ed è disponibile error o response.
Campo unione result. Il risultato dell'operazione, che può essere un error o una response valida. Se done == false, né error né response vengono impostati. Se done == true, è possibile impostare esattamente uno tra error e response. Alcuni servizi potrebbero non fornire il risultato. result può essere solo uno dei seguenti tipi:
error

object (Status)

Il risultato di errore dell'operazione in caso di errore o annullamento.
response

object

La risposta normale e con esito positivo dell'operazione. Se il metodo originale non restituisce dati in caso di esito positivo, ad esempio Delete, la risposta è google.protobuf.Empty. Se il metodo originale è Get/Create/Update standard, la risposta deve essere la risorsa. Per gli altri metodi, la risposta deve avere il tipo XxxResponse, dove Xxx è il nome del metodo originale. Ad esempio, se il nome del metodo originale è TakeSnapshot(), il tipo di risposta dedotto è TakeSnapshotResponse.

Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo "@type" contenente un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.

Qualsiasi

Rappresentazione JSON 
{
  "typeUrl": string,
  "value": string
}
Campi
typeUrl

string

Identifica il tipo di messaggio Protobuf serializzato con un riferimento URI costituito da un prefisso che termina con una barra e il nome del tipo completo.

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

Questa stringa deve contenere almeno un carattere / e il contenuto dopo l'ultimo / deve essere il nome completo del tipo in forma canonica, senza un punto iniziale. Non scrivere uno schema su questi riferimenti URI in modo che i client non tentino di contattarli.

Il prefisso è arbitrario e le implementazioni di Protobuf devono semplicemente rimuovere tutto fino all'ultimo / incluso per identificare il tipo. type.googleapis.com/ è un prefisso predefinito comune richiesto da alcune implementazioni legacy. Questo prefisso non indica l'origine del tipo e non è previsto che gli URI che lo contengono rispondano a richieste.

Tutte le stringhe URL di tipo devono essere riferimenti URI validi con l'ulteriore limitazione (per il formato di testo) che il contenuto del riferimento deve essere costituito solo da caratteri alfanumerici, sequenze di escape codificate in percentuale e caratteri del seguente insieme (esclusi i backtick esterni): /-.~_!$&()*+,;=. Nonostante consentiamo le codifiche in percentuale, le implementazioni non devono eseguirne l'escape per evitare confusione con i parser esistenti. Ad esempio, type.googleapis.com%2FFoo deve essere rifiutato.

Nella progettazione originale di Any, è stata presa in considerazione la possibilità di avviare un servizio di risoluzione dei tipi in questi URL di tipo, ma Protobuf non ne ha mai implementato uno e considera il contatto con questi URL problematico e un potenziale problema di sicurezza. Non tentare di contattare gli URL dei tipi.
value

string (bytes format)

Contiene una serializzazione Protobuf del tipo descritto da type_url.

Una stringa con codifica in base64.

Stato

Rappresentazione JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campi
code

integer

Il codice di stato, che deve essere un valore enum di google.rpc.Code.
message

string

Un messaggio di errore rivolto agli sviluppatori, che deve essere in inglese. Qualsiasi messaggio di errore rivolto agli utenti deve essere localizzato e inviato nel campo google.rpc.Status.details o localizzato dal client.
details[]

object

Un elenco di messaggi contenenti i dettagli dell'errore. Esiste un insieme comune di tipi di messaggi da utilizzare per le API.

Un oggetto contenente campi di tipo arbitrario. Un campo aggiuntivo "@type" contenente un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.

Annotazioni dello strumento

Suggerimento distruttivo: ✅ | Suggerimento idempotente: ❌ | Suggerimento di sola lettura: ❌ | Suggerimento open world: ❌