REST Resource: projects.locations.apps

Risorsa: App

Un'app funge da contenitore di primo livello per un gruppo di agenti, tra cui l'agente principale e i relativi agenti secondari, 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)
  },
  "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 (App.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 (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 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

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

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

SynthesizeSpeechConfig

Configurazione della sintesi della risposta dell'agente.

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

string

Facoltativo. Il nome della voce. Se non viene impostato, 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à 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

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

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: disableBargeIn è deprecato a favore di disableBargeInControl 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.

AmbientSoundConfig

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

Rappresentazione JSON 
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (AmbientSoundConfig.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 (AmbientSoundConfig.PrebuiltAmbientNoise)

Facoltativo. Deprecato: prebuiltAmbientNoise è deprecato a favore di prebuiltAmbientSound.
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"

AmbientSoundConfig.PrebuiltAmbientNoise

Rumore ambientale predefinito.

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

LoggingSettings

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

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

Configurazione per indicare come devono essere gestiti i dati sensibili.

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/{inspectTemplate}
deidentifyTemplate

string

Facoltativo. Nome del modello 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 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

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

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

Rappresentazione JSON 
{
  "enableCloudLogging": boolean
}
Campi
enableCloudLogging

boolean

Facoltativo. Se abilitare Cloud Logging per le sessioni.

ConversationLoggingSettings

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

Rappresentazione JSON 
{
  "disableConversationLogging": boolean
}
Campi
disableConversationLogging

boolean

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

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

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

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

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

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

ErrorHandlingSettings.ErrorHandlingStrategy

Definisce la strategia per la gestione degli errori.

Enum
ERROR_HANDLING_STRATEGY_UNSPECIFIED Strategia di gestione degli errori non specificata. Il valore predefinito è FALLBACK_RESPONSE.
NONE Non è attivata alcuna gestione specifica.
FALLBACK_RESPONSE In caso di errori del modello linguistico di grandi dimensioni, all'utente verrà restituito un messaggio di riserva.

App.ToolExecutionMode

Definisce il comportamento di esecuzione dello strumento 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, questi verranno eseguiti in parallelo, con lo stesso ToolContext.
SEQUENTIAL Se vengono selezionati più strumenti, questi verranno eseguiti in sequenza. Lo strumento successivo verrà eseguito solo dopo il completamento di quello precedente e potrà visualizzare il ToolContext aggiornato.

EvaluationMetricsThresholds

Impostazioni delle soglie per le metriche in una valutazione.

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

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds)

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

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

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

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

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

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

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

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

Impostazioni per le valutazioni di riferimento.

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

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)

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

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)

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

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

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

Soglie delle metriche di livello.

Rappresentazione JSON 
{
  "semanticSimilarityChannel": enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel),
  "semanticSimilaritySuccessThreshold": integer,
  "overallToolInvocationCorrectnessThreshold": number
}
Campi
semanticSimilarityChannel

enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel)

Facoltativo. Il canale di similarità semantica da utilizzare per la valutazione.
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.
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.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

Canale di similarità semantica da utilizzare.

Enum
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED Metrica non specificata. Il valore predefinito è TEXT.
TEXT Utilizza la somiglianza semantica del testo.
AUDIO Utilizza la somiglianza semantica audio.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

Soglie delle metriche del livello di aspettativa.

Rappresentazione JSON 
{
  "toolInvocationParameterCorrectnessThreshold": number
}
Campi
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.

EvaluationMetricsThresholds.ToolMatchingSettings

Impostazioni per le chiamate dello strumento di corrispondenza.

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

enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)

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

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

Definisce il comportamento quando viene rilevata una chiamata di strumento aggiuntiva. 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.

Enum
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Comportamento non specificato. Il valore predefinito è FAIL.
FAIL Non superare la valutazione se viene rilevata una chiamata aggiuntiva allo strumento.
ALLOW Consenti la chiamata allo strumento aggiuntiva.

EvaluationMetricsThresholds.HallucinationMetricBehavior

Il comportamento della metrica di allucinazione. Indipendentemente dal comportamento, la metrica verrà sempre calcolata. La differenza è che, se disattivata, la metrica non viene utilizzata per calcolare il punteggio di valutazione complessivo.

Enum
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamento della metrica di allucinazione non specificato.
DISABLED Disattiva la metrica delle allucinazioni.
ENABLED Attiva la metrica di allucinazione.

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 dell'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 gli archivi dati 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 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}

Metodi

create

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

delete

 Elimina l'app specificata.

executeTool

 Esegue lo strumento specificato con gli argomenti indicati.

exportApp

 Esporta l'app specificata.

get

 Recupera i dettagli dell'app specificata.

importApp

 Importa l'app specificata.

list

 Elenca le app nel progetto e nella località specifici.

patch

 Aggiorna l'app specificata.

retrieveToolSchema

 Recupera lo schema dello strumento specificato.