REST Resource: projects.locations.apps

Risorsa: App

Un'app funge da container di primo livello per un gruppo di agenti, tra cui l'agente principale e i suoi sub-agenti, insieme alle configurazioni associate. Questi agenti collaborano per raggiungere obiettivi specifici nel contesto dell'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 (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)
  }
}
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. Se l'app è bloccata nella lista di 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 logging 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 (App.ToolExecutionMode)

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

object (EvaluationMetricsThresholds)

Facoltativo. Le soglie di valutazione dell'app.
variableDeclarations[]

object (App.VariableDeclaration)

Facoltativo. Le dichiarazioni delle variabili.
predefinedVariableDeclarations[]

object (App.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 configurare un'identità o una personalità stabile per tutti gli agenti.
guardrails[]

string

Facoltativo. Elenco di guardrail 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 relativi all'app. Questo campo può essere utilizzato per archiviare informazioni aggiuntive relative 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 della 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 cambiato 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.
vpcScSettings

object (VpcScSettings)

Facoltativo. Impostazioni VPC-SC 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.
evaluationPersonas[]

object (EvaluationPersona)

Facoltativo. I personas di valutazione per l'app. Questo campo viene utilizzato per definire i personas che possono essere utilizzati per la valutazione. È possibile definire un massimo di 30 personas.
evaluationSettings

object (EvaluationSettings)

Facoltativo. Le impostazioni di valutazione dell'app.
validationErrors[]

string

Solo output. Errori di configurazione o avvisi nell'app.
dashboardSettings

object (DashboardSettings)

Facoltativo. Impostazioni della dashboard specifiche per l'app per collegare e configurare le dashboard di Contact Center Insights.

LanguageSettings

Impostazioni della lingua dell'app.

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

boolean

Facoltativo. Abilita il supporto multilingue. Se true, gli agenti nell'app utilizzeranno istruzioni predefinite per migliorare la gestione degli input multilingue.
fallbackAction
(deprecated)

string

Facoltativo. Ritirata: questa funzionalità non è più supportata. Utilizza invece enableMultilingualSupport per migliorare la gestione dell'input multilingue. L'azione da eseguire quando un agente riceve un 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 completo della risorsa di uno strumento, che attiva l'esecuzione di uno strumento specifico. - Un'azione di sistema predefinita, come "escalate" o "exit", che attiva un segnale EndSession con il corrispondente metadata per terminare la conversazione.

TimeZoneSettings

Impostazioni del fuso orario dell'app.

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

Configurazione della modalità di elaborazione e distribuzione dell'audio di input e output.

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

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

Facoltativo. Configurazione della modalità di sintesi della risposta dell'agente, mappatura dal codice 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 parlato o interazione) prima che l'agente chieda all'utente di interagire di nuovo. Se non viene impostato, l'agente non chiederà all'utente di interagire nuovamente.

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 sintetizzata dell'agente, per migliorare la naturalezza della conversazione.
customVoiceSamples[]

object (CustomVoiceSample)

Facoltativo. Configura campioni di voce personalizzati per la clonazione della voce.

SynthesizeSpeechConfig

Configurazione della modalità di sintesi della risposta dell'agente.

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

string

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

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

number

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

string

Facoltativo. Il modello utilizzato per sintetizzare l'audio. Valori attualmente supportati: - "gemini-3.1-flash-tts-preview" Se vuoto, viene utilizzato Chirp3-HD.
instruction

string

Facoltativo. L'istruzione utilizzata per sintetizzare il parlato quando si utilizza un modello generativo.

BargeInConfig

Configurazione della modalità di gestione delle attività di interruzione da parte dell'utente.

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

boolean

Facoltativo. Deprecato: disableBargeIn è deprecato a favore di disableBargeInControl in ChannelProfile.

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

boolean

Facoltativo. Se questa opzione è attiva, 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 in scenari in cui le risposte dell'agente vengono visualizzate visivamente.

AmbientSoundConfig

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

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

number

Facoltativo. Guadagno del volume (in dB) del volume nativo normale supportato dal rumore ambientale, nell'intervallo [-96,0, 16,0]. Se non viene impostato o se viene impostato su un valore pari a 0, 0 (dB), la riproduzione avverrà con l'ampiezza del segnale nativo normale. Un valore di -6,0 (dB) verrà riprodotto a circa la metà dell'ampiezza del segnale nativo normale. Un valore di +6,0 (dB) verrà riprodotto a un'ampiezza pari a circa il doppio dell'ampiezza del segnale nativo normale. Ti consigliamo vivamente di non superare i +10 (dB), poiché in genere non si verifica un aumento effettivo del volume per valori superiori.
Rumore ambientale da riprodurre con la risposta sintetizzata dell'agente per migliorare la naturalezza della conversazione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
prebuiltAmbientNoise
(deprecated)

enum (AmbientSoundConfig.PrebuiltAmbientNoise)

Facoltativo. Deprecato: prebuiltAmbientNoise è deprecato e sostituito con prebuiltAmbientSound.
gcsUri

string

Facoltativo. Rumore ambientale sotto forma di file WAV monocanale a 16 kHz archiviato in Cloud Storage.

Nota: assicurati che l'agente di servizio 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"
Fine dei campi che si escludono a vicenda.

AmbientSoundConfig.PrebuiltAmbientNoise

Rumore ambientale predefinito.

Enum
PREBUILT_AMBIENT_NOISE_UNSPECIFIED Non specificato.
RETAIL_STORE Rumore ambientale di un negozio di vendita al dettaglio.
CONVENTION_HALL Rumore ambientale di una sala congressi.
OUTDOOR Rumore ambientale di una strada.

CustomVoiceSample

Configurazione di un campione di voce personalizzata utilizzato per la clonazione della voce.

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

string

Facoltativo. Il nome definito dall'utente per il campione di voce personalizzata.
voiceSampleGcsUri

string

Facoltativo. L'URI Cloud Storage del campione audio per la clonazione della voce. Il campione audio deve essere un file WAV monocanale a 24 kHz.
consentAudioGcsUri

string

Facoltativo. Audio di consenso per la clonazione vocale.
voiceInstruction

string

Facoltativo. Istruzioni in linguaggio naturale per lo stile, il tono, il ritmo o la pronuncia della voce.
previewAudioContent

string (bytes format)

Solo output. Audio di anteprima sintetizzato per la voce personalizzata, formattato come WAV canonico (LINEAR16, 24 kHz, 16 bit, mono).

Una stringa con codifica in base64.
previewText

string

Facoltativo. Testo per la sintesi dell'audio di anteprima per la voce personalizzata.
warnings[]

object (CustomVoiceSample.Warning)

Solo output. Messaggi di avviso riscontrati durante l'elaborazione della clonazione della voce (ad es. livello audio basso).
voiceInstructionMode

enum (CustomVoiceSample.VoiceInstructionMode)

Facoltativo. Modalità di istruzione per il campione vocale. Se non specificato, il valore predefinito è NO_INSTRUCTION.

CustomVoiceSample.Warning

Un messaggio di avviso visualizzato durante l'elaborazione del campione vocale.

Rappresentazione JSON 
{
  "message": string,
  "type": enum (CustomVoiceSample.Warning.WarningType)
}
Campi
message

string

Solo output. Una descrizione dell'avviso leggibile da una persona.
type

enum (CustomVoiceSample.Warning.WarningType)

Solo output. Il tipo di avviso.

CustomVoiceSample.Warning.WarningType

Tipo di avviso rilevato durante l'elaborazione del campione vocale.

Enum
WARNING_TYPE_UNSPECIFIED Tipo di avviso non specificato.
LOW_AUDIO_LEVEL Il livello audio del campione vocale è troppo basso (ad es. ampiezza RMS bassa).

CustomVoiceSample.VoiceInstructionMode

Modalità di istruzione per il campione vocale.

Enum
VOICE_INSTRUCTION_MODE_UNSPECIFIED Modalità di istruzione non specificata. Il valore predefinito è NO_INSTRUCTION.
NO_INSTRUCTION Non verranno utilizzate istruzioni vocali.
GENERATE_INSTRUCTION L'istruzione vocale verrà generata automaticamente dall'AI a partire dal campione audio.
CUSTOM_INSTRUCTION Istruzione vocale personalizzata fornita dall'utente.

LoggingSettings

Impostazioni per descrivere i comportamenti di logging dell'app.

Rappresentazione JSON 
{
  "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
}
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. L'audio è soggetto a oscuramento come configurato in RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Facoltativo. Configura una registrazione aggiuntiva dell'audio non oscurato. Può essere utilizzato per conservare una copia audio non elaborata quando l'oscuramento dell'audio è enabled, in genere per scopi di controllo o monitoraggio.
bigqueryExportSettings

object (BigQueryExportSettings)

Facoltativo. Configura i comportamenti di esportazione di BigQuery per l'app. I dati della conversazione sono soggetti a oscuramento come configurato in RedactionConfig.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Facoltativo. Configura i comportamenti di esportazione di BigQuery per l'app. Se l'opzione è abilitata, i dati della conversazione non oscurati 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 logging 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 dell'app.

RedactionConfig

Configurazione per indicare come devono essere gestiti i dati sensibili.

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

boolean

Facoltativo. Se true, l'oscuramento verrà applicato in vari scenari di logging, tra cui la cronologia delle conversazioni, Cloud Logging e la registrazione audio.
inspectTemplate

string

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

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

string

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

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

AudioRecordingConfig

Configurazione della modalità di registrazione delle interazioni audio.

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 località del bucket che soddisfi i tuoi requisiti di residenza dei dati.

Nota: se il bucket Cloud Storage si trova in un progetto diverso da quello dell'app, devi concedere l'autorizzazione storage.objects.create all'agente di servizio CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Facoltativo. Il prefisso del percorso di 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

Impostazioni per descrivere i comportamenti di BigQuery Export per l'app.

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

boolean

Facoltativo. Indica se l'esportazione in BigQuery è abilitata.
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 da quello dell'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. L'ID set di dati BigQuery in cui esportare i dati.

CloudLoggingSettings

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

Rappresentazione JSON 
{
  "enableCloudLogging": boolean
}
Campi
enableCloudLogging

boolean

Facoltativo. Indica se abilitare Cloud Logging per le sessioni.

ConversationLoggingSettings

Impostazioni per descrivere i comportamenti di logging delle conversazioni per l'app.

Rappresentazione JSON 
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
Campi
disableConversationLogging

boolean

Facoltativo. Indica se disattivare il logging delle conversazioni per le sessioni.
retentionWindow

string (Duration format)

Facoltativo. Controlla il periodo di conservazione della conversazione. Se non viene impostato, la conversazione verrà conservata per 365 giorni.

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

MetricAnalysisSettings

Impostazioni per descrivere i comportamenti di raccolta dei dati delle conversazioni per la pipeline delle metriche di analisi LLM.

Rappresentazione JSON 
{
  "llmMetricsOptedOut": boolean
}
Campi
llmMetricsOptedOut

boolean

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

ErrorHandlingSettings

Impostazioni per descrivere come devono essere gestiti gli errori nell'app.

Rappresentazione JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingSettings.ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (ErrorHandlingSettings.FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (ErrorHandlingSettings.EndSessionConfig)
  }
}
Campi
errorHandlingStrategy

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

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

object (ErrorHandlingSettings.FallbackResponseConfig)

Facoltativo. Configurazione per la gestione delle risposte di fallback.
endSessionConfig

object (ErrorHandlingSettings.EndSessionConfig)

Facoltativo. Configurazione per terminare la sessione in caso di errori di sistema (ad es. errori LLM).

ErrorHandlingSettings.ErrorHandlingStrategy

Definisce la strategia per la gestione degli errori.

Enum
ERROR_HANDLING_STRATEGY_UNSPECIFIED Strategia di gestione degli errori non specificata.
NONE Non è attiva alcuna gestione specifica.
FALLBACK_RESPONSE In caso di errori di sistema (ad es. errori LLM), all'utente verrà restituito un messaggio di riserva.
END_SESSION In caso di errori di sistema (ad es. errori LLM), verrà emesso un segnale EndSession.

ErrorHandlingSettings.FallbackResponseConfig

Configurazione per la gestione delle risposte di fallback.

Rappresentazione JSON 
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
Campi
customFallbackMessages

map (key: string, value: string)

Facoltativo. I messaggi di riserva in caso di errori di sistema (ad es. errori LLM), mappati in base al codice lingua supportato.

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

integer

Facoltativo. Il numero massimo di tentativi di fallback da effettuare prima che l'agente emetta l'indicatore EndSession.

ErrorHandlingSettings.EndSessionConfig

Configurazione per terminare la sessione in caso di errori di sistema (ad es. errori LLM).

Rappresentazione JSON 
{
  "escalateSession": boolean
}
Campi
escalateSession

boolean

Facoltativo. Se assegnare la sessione a un livello superiore in EndSession. Se la sessione viene riassegnata, metadata in EndSession conterrà sessionEscalated = true. Per maggiori dettagli, consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

App.ToolExecutionMode

Definisce il comportamento di esecuzione degli strumenti se l'agente seleziona più strumenti contemporaneamente.

Enum
TOOL_EXECUTION_MODE_UNSPECIFIED Modalità di esecuzione dello strumento non specificata. Il valore predefinito è PARALLEL.
PARALLEL Se vengono selezionati più strumenti, verranno eseguiti in parallelo con lo stesso ToolContext.
SEQUENTIAL Se vengono selezionati più strumenti, verranno eseguiti in sequenza. Lo strumento successivo verrà eseguito solo dopo il completamento dello strumento precedente e potrà visualizzare il ToolContext aggiornato dello strumento precedente.

App.VariableDeclaration

Definisce la struttura e i metadati di una variabile.

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.

DataStoreSettings

Impostazioni relative al datastore per l'app.

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

object (DataStoreSettings.Engine)

Solo output. I motori per l'app.

DataStoreSettings.Engine

Un motore a cui sono connessi i datastore. Consulta Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

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

string

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

enum (DataStoreSettings.Engine.Type)

Solo output. Il tipo di motore.

DataStoreSettings.Engine.Type

Il tipo di motore. Consulta la documentazione disponibile all'indirizzo https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType e https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enum
TYPE_UNSPECIFIED Tipo di motore non specificato.
ENGINE_TYPE_CHAT Tipo di motore di chat. Il motore SOLUTION_TYPE_CHAT per l'app. Tutti i datastore del connettore aggiunti all'app verranno aggiunti a questo motore.

ClientCertificateSettings

Impostazioni per i certificati client personalizzati.

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 del secret di SecretManager 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 di SecretManager che archivia la passphrase per decriptare la chiave privata. Deve essere lasciato vuoto se la chiave privata non è criptata. Formato: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Impostazioni VPC-SC per l'app.

Rappresentazione JSON 
{
  "allowedOrigins": [
    string
  ]
}
Campi
allowedOrigins[]

string

Facoltativo. Le origini HTTP(S) consentite che gli strumenti OpenAPI nell'app possono chiamare direttamente quando i Controlli di servizio VPC sono abilitati. Queste stringhe devono corrispondere esattamente all'origine, inclusa la porta, se specificata. Ad esempio, "https://example.com" o "https://example.com:443". Questo elenco non si applica ancora agli strumenti Python che potrebbero effettuare chiamate HTTP dirette.

EvaluationSettings

Impostazioni per la valutazione.

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

enum (EvaluationSettings.ScenarioConversationInitiator)

Facoltativo. Chi avvia la conversazione in una valutazione dello scenario.
goldenRunMethod

enum (GoldenRunMethod)

Facoltativo. Il metodo predefinito utilizzato per eseguire le valutazioni golden. Verrà utilizzato se non viene specificato goldenRunMethod in RunEvaluationRequest.
goldenEvaluationToolCallBehaviour

enum (EvaluationToolCallBehaviour)

Facoltativo. Configura il comportamento predefinito delle chiamate allo strumento per le valutazioni golden.
scenarioEvaluationToolCallBehaviour

enum (EvaluationToolCallBehaviour)

Facoltativo. Configura il comportamento predefinito della chiamata allo strumento per le valutazioni degli scenari.
metricsConfig

object (EvaluationMetricsConfig)

Facoltativo. Configura le metriche predefinite per le valutazioni.
scenarioExecutionMode

enum (EvaluationSettings.ScenarioExecutionMode)

Facoltativo. La modalità di esecuzione per le valutazioni degli scenari. Se non viene fornito, il valore predefinito sarà QUALITY_OPTIMIZED.
evaluationRunCachingSettings

object (EvaluationRunCachingSettings)

Facoltativo. Le impostazioni di memorizzazione nella cache da utilizzare per l'esecuzione della valutazione.

EvaluationSettings.ScenarioConversationInitiator

Determina chi avvia la conversazione in una sessione di valutazione dello scenario.

Enum
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED Non specificato. Il valore predefinito è USER.
USER L'utente avvia la conversazione.
AGENT L'agente avvia la conversazione.

DashboardSettings

Impostazioni per le dashboard associate all'app, che vengono visualizzate nella visualizzazione Monitoring.

Rappresentazione JSON 
{
  "defaultDashboard": string
}
Campi
defaultDashboard

string

Facoltativo. Il nome della risorsa della dashboard predefinita di Contact Center Insights associata all'app. Questa è la dashboard che verrà visualizzata quando gli utenti accedono alla visualizzazione Monitoraggio dell'app.

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

Metodi

chatAiAssistant

 Esegue Arc, l'assistente AI, per la sessione dell'assistente specificata.

create

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

delete

 Elimina l'app specificata.

executeTool

 Esegue lo strumento specificato con gli argomenti specificati.

exportApp

 Esporta l'app specificata.

generateAppResource

 Genera risorse specifiche (ad es.

generateOnboardingSuggestions

 Genera suggerimenti di onboarding personalizzati per lo stato zero di Arc: classifica l'utente richiedente (nuovo/esploratore/di ritorno) in base alla cronologia delle sessioni dell'assistente nell'app e restituisce chip di suggerimento (riprendi una sessione, continua il lavoro o inizia qualcosa di nuovo) da visualizzare prima dell'invio di un messaggio.

get

 Recupera i dettagli dell'app specificata.

getExtendedAgentCard

 Recupera la scheda dell'agente estesa per l'agente autenticato.

importApp

 Importa l'app specificata.

importEvaluations

 Importa le valutazioni nell'app.

list

 Elenca le app nel progetto e nella località specificati.

patch

 Aggiorna l'app specificata.

retrieveToolSchema

 Recupera lo schema dello strumento specificato.

runAssistant

 Esegue l'agente dell'assistente per la sessione dell'assistente specificata.

runEvaluation

 Esegue una valutazione dell'app.

testPersonaVoice

 Testa la voce di un personaggio.