REST Resource: projects.locations.apps

Recurso: App

Una app sirve como contenedor de nivel superior para un grupo de agentes, incluido el agente raíz y sus subagentes, junto con sus configuraciones asociadas. Estos agentes trabajan en conjunto para lograr objetivos específicos dentro del contexto de la app.

Representación 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
}
Campos
name

string

Es el identificador. Es el identificador único de la app. Formato: projects/{project}/locations/{location}/apps/{app}
displayName

string

Obligatorio. Es el nombre visible de la app.
description

string

Es opcional. Es la descripción de la app legible por humanos.
pinned

boolean

Es opcional. Indica si la app está fijada en la lista de apps.
rootAgent

string

Es opcional. El agente raíz es el punto de entrada de la app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Es opcional. Es la configuración de idioma de la app.
timeZoneSettings

object (TimeZoneSettings)

Es opcional. Es la configuración de zona horaria de la app.
audioProcessingConfig

object (AudioProcessingConfig)

Es opcional. Es la configuración del procesamiento de audio de la app.
loggingSettings

object (LoggingSettings)

Es opcional. Es la configuración de registro de la app.
errorHandlingSettings

object (ErrorHandlingSettings)

Es opcional. Es la configuración de manejo de errores de la app.
modelSettings

object (ModelSettings)

Es opcional. Es la configuración predeterminada del modelo de LLM para la app. Los recursos individuales (p.ej., agentes y medidas de seguridad) pueden anular estas configuraciones según sea necesario.
toolExecutionMode

enum (App.ToolExecutionMode)

Es opcional. Es el modo de ejecución de la herramienta para la app. Si no se proporciona, se establecerá PARALLEL de forma predeterminada.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Es opcional. Son los umbrales de evaluación de la app.
variableDeclarations[]

object (App.VariableDeclaration)

Es opcional. Son las declaraciones de las variables.
predefinedVariableDeclarations[]

object (App.VariableDeclaration)

Solo salida. Son las declaraciones de las variables predefinidas para la app.
globalInstruction

string

Es opcional. Son instrucciones para todos los agentes de la app. Puedes usar esta instrucción para configurar una identidad o personalidad estable en todos los agentes.
guardrails[]

string

Es opcional. Lista de medidas de protección de la app. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Es opcional. Es la configuración del almacén de datos de la app.
defaultChannelProfile

object (ChannelProfile)

Es opcional. Es el perfil de canal predeterminado que usa la app.
metadata

map (key: string, value: string)

Es opcional. Son los metadatos sobre la app. Este campo se puede usar para almacenar información adicional relevante para los detalles de la app o los usos previstos.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de cuando se creó la app.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Marca de tiempo de la última actualización de la app.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
etag

string

Solo salida. Es el ETag que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si el ETag está vacío, la actualización reemplazará cualquier cambio simultáneo.
deploymentCount

integer

Solo salida. Es la cantidad de implementaciones en la app.
clientCertificateSettings

object (ClientCertificateSettings)

Es opcional. Es la configuración predeterminada del certificado de cliente para la app.
locked

boolean

Es opcional. Indica si la app está bloqueada para realizar cambios. Si la app está bloqueada, se rechazarán las modificaciones en los recursos de la app.

LanguageSettings

Es la configuración de idioma de la app.

Representación JSON 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
Campos
defaultLanguageCode

string

Es opcional. Es el código de idioma predeterminado de la app.
supportedLanguageCodes[]

string

Es opcional. Lista de códigos de idioma que admite la app, además de defaultLanguageCode.
enableMultilingualSupport

boolean

Es opcional. Habilita la compatibilidad multilingüe. Si es verdadero, los agentes de la app usarán instrucciones prediseñadas para mejorar el procesamiento de la entrada multilingüe.
fallbackAction

string

Es opcional. Es la acción que se realizará cuando un agente reciba entrada en un idioma no admitido.

Puede ser una acción predefinida o una llamada a herramienta personalizada. Los valores válidos son los siguientes: - El nombre completo del recurso de una herramienta, que activa una ejecución específica de la herramienta. - Una acción del sistema predefinida, como "derivar" o "salir", que activa un indicador EndSession con el metadata correspondiente para finalizar la conversación.

TimeZoneSettings

Es la configuración de zona horaria de la app.

Representación JSON 
{
  "timeZone": string
}
Campos
timeZone

string

Es opcional. La zona horaria de la app de la base de datos de zonas horarias, p.ej., America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

Es la configuración de cómo se debe procesar y entregar el audio de entrada y salida.

Representación JSON 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  }
}
Campos
synthesizeSpeechConfigs

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

Es opcional. Es la configuración de cómo se debe sintetizar la respuesta del agente, que asigna el código de idioma a SynthesizeSpeechConfig.

Si no se encuentra la configuración para el código de idioma especificado, se usará la configuración para el código de idioma raíz. Por ejemplo, si el mapa contiene "en-us" y "en", y el código de idioma especificado es "en-gb", se usará la configuración "en".

Nota: El código de idioma no distingue entre mayúsculas y minúsculas.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Es opcional. Configura el comportamiento del agente para las actividades de interrupción del usuario.
inactivityTimeout

string (Duration format)

Es opcional. Es la duración de la inactividad del usuario (sin voz ni interacción) antes de que el agente le solicite que vuelva a participar. Si no se establece, el agente no le solicitará al usuario que vuelva a participar.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
ambientSoundConfig

object (AmbientSoundConfig)

Es opcional. Es la configuración del sonido ambiente que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación.

SynthesizeSpeechConfig

Es la configuración de cómo se debe sintetizar la respuesta del agente.

Representación JSON 
{
  "voice": string,
  "speakingRate": number
}
Campos
voice

string

Opcional. El nombre de la voz. Si no se establece, el servicio elegirá una voz según los otros parámetros, como languageCode.

Para obtener la lista de voces disponibles, consulta Voces y lenguajes compatibles en Cloud Text-to-Speech.
speakingRate

number

Es opcional. Es la velocidad de habla en el intervalo [0.25, 2.0]. 1.0 es la velocidad nativa normal que admite la voz específica. 2.0 es el doble de rápido y 0.5 es la mitad. Los valores fuera del rango [0.25, 2.0] mostrarán un error.

BargeInConfig

Es la configuración sobre cómo se deben controlar las actividades de interrupción del usuario.

Representación JSON 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Campos
disableBargeIn
(deprecated)

boolean

Es opcional. Inhabilita la interrupción del usuario mientras el agente está hablando. Si es verdadero, se ignorará la entrada del usuario durante la reproducción de la respuesta del agente.

Obsoleto: disableBargeIn dejó de estar disponible y se reemplazó por disableBargeInControl en ChannelProfile.
bargeInAwareness

boolean

Es opcional. Si está habilitada, el agente adaptará su próxima respuesta según la suposición de que el usuario no escuchó el mensaje completo anterior del agente. No se debe usar en situaciones en las que las respuestas del agente se muestran de forma visual.

AmbientSoundConfig

Es la configuración del sonido ambiente que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación.

Representación 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.
}
Campos
volumeGainDb

number

Es opcional. Aumento de volumen (en dB) del volumen nativo normal admitido por el ruido ambiental, dentro del intervalo [-96.0, 16.0]. Si no se establece, o se establece en un valor de 0.0 (dB), se reproducirá en la amplitud de la señal nativa normal. Un valor de -6.0 (dB) se reproducirá aproximadamente a la mitad de la amplitud de la señal nativa normal. Un valor de +6.0 (dB) se reproducirá aproximadamente al doble de la amplitud de la señal nativa normal. Recomendamos no superar los +10 (dB) ya que, por lo general, no hay un aumento efectivo en la sonoridad para ningún valor superior.
Campo de unión source. Ruido ambiental que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación. source puede ser solo uno de los parámetros siguientes:
prebuiltAmbientNoise
(deprecated)

enum (AmbientSoundConfig.PrebuiltAmbientNoise)

Es opcional. Obsoleto: prebuiltAmbientNoise dejó de estar disponible y se reemplazó por prebuiltAmbientSound.
gcsUri

string

Es opcional. Ruido ambiental como un archivo WAV de 16 kHz y un solo canal almacenado en Cloud Storage.

Nota: Asegúrate de que el agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com tenga permiso storage.objects.get para el objeto de Cloud Storage.
prebuiltAmbientSound

string

Es opcional. Nombre del sonido ambiental prediseñado. Los valores válidos son los siguientes: "coffee_shop", "keyboard", "keypad", "hum", "office_1", "office_2", "office_3", "room_1", "room_2", "room_3", "room_4", "room_5" y "air_conditioner".

AmbientSoundConfig.PrebuiltAmbientNoise

Ruido ambiental prediseñado.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED No especificado.
RETAIL_STORE Ruido ambiental de una tienda minorista.
CONVENTION_HALL Ruido ambiental de un salón de convenciones.
OUTDOOR Ruido ambiental de una calle.

LoggingSettings

Es la configuración para describir los comportamientos de registro de la app.

Representación JSON 
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
Campos
redactionConfig

object (RedactionConfig)

Es opcional. Es la configuración de cómo se deben ocultar los datos sensibles.
audioRecordingConfig

object (AudioRecordingConfig)

Es opcional. Es la configuración de cómo se deben registrar las interacciones de audio.
bigqueryExportSettings

object (BigQueryExportSettings)

Es opcional. Es la configuración para describir los comportamientos de la exportación de BigQuery para la app. Los datos de conversación se exportarán a las tablas de BigQuery si está habilitada la exportación.
cloudLoggingSettings

object (CloudLoggingSettings)

Es opcional. Es la configuración para describir el comportamiento de Cloud Logging para la app.
conversationLoggingSettings

object (ConversationLoggingSettings)

Es opcional. Es la configuración para describir los comportamientos de registro de conversaciones de la app.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Es opcional. Es la configuración sobre cómo se deben registrar las interacciones de audio para la evaluación. De forma predeterminada, la grabación de audio no está habilitada para las sesiones de evaluación.
metricAnalysisSettings

object (MetricAnalysisSettings)

Es opcional. Es la configuración para describir los comportamientos de recopilación de datos de conversación para la canalización de análisis del LLM de la app.

RedactionConfig

Es la configuración para indicar cómo se deben controlar los datos sensibles.

Representación JSON 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Campos
enableRedaction

boolean

Es opcional. Si es verdadero, se aplicará el ocultamiento en varias situaciones de registro, como el historial de conversaciones, Cloud Logging y la grabación de audio.
inspectTemplate

string

Es opcional. Nombre de la plantilla de inspección de DLP para configurar la detección de tipos de datos sensibles.

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

string

Es opcional. Nombre de la plantilla de desidentificación de DLP para indicar cómo desidentificar el contenido.

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

AudioRecordingConfig

Es la configuración de cómo se deben registrar las interacciones de audio.

Representación JSON 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
Campos
gcsBucket

string

Es opcional. Bucket de Cloud Storage para almacenar las grabaciones de audio de la sesión. El URI debe comenzar con “gs://”.

Elige una ubicación de bucket que cumpla con tus requisitos de residencia de datos.

Nota: Si el bucket de Cloud Storage está en un proyecto diferente al de la app, debes otorgar permiso de storage.objects.create al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Es opcional. Es el prefijo de la ruta de acceso de Cloud Storage para las grabaciones de audio.

Este prefijo puede incluir los siguientes marcadores de posición, que se sustituirán de forma dinámica en el momento de la publicación: - $project: ID del proyecto - $location: ubicación de la app - $app: ID de la app - $date: fecha de la sesión en formato YYYY-MM-DD - $session: ID de la sesión

Si no se especifica el prefijo de ruta de acceso, se usará el prefijo predeterminado $project/$location/$app/$date/$session/.

BigQueryExportSettings

Es la configuración para describir los comportamientos de la exportación de BigQuery para la app.

Representación JSON 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
Campos
enabled

boolean

Es opcional. Indica si la exportación a BigQuery está habilitada.
project

string

Es opcional. Es el ID del proyecto del conjunto de datos de BigQuery al que se exportarán los datos.

Nota: Si el conjunto de datos de BigQuery se encuentra en un proyecto diferente al de la app, debes otorgar el rol de roles/bigquery.admin al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Es opcional. Es el conjunto de datos de BigQuery al que se exportarán los datos.

CloudLoggingSettings

Es la configuración para describir el comportamiento de Cloud Logging para la app.

Representación JSON 
{
  "enableCloudLogging": boolean
}
Campos
enableCloudLogging

boolean

Es opcional. Indica si se debe habilitar Cloud Logging para las sesiones.

ConversationLoggingSettings

Es la configuración para describir los comportamientos de registro de conversaciones de la app.

Representación JSON 
{
  "disableConversationLogging": boolean
}
Campos
disableConversationLogging

boolean

Es opcional. Indica si se debe inhabilitar el registro de conversaciones para las sesiones.

MetricAnalysisSettings

Es la configuración para describir los comportamientos de recopilación de datos de conversación para la canalización de métricas de análisis de LLM.

Representación JSON 
{
  "llmMetricsOptedOut": boolean
}
Campos
llmMetricsOptedOut

boolean

Es opcional. Indica si se deben recopilar datos de conversaciones para las métricas de análisis de LLM. Si es verdadero, no se recopilarán datos de conversaciones para las métricas de análisis de LLM. De lo contrario, se recopilarán datos de conversaciones.

ErrorHandlingSettings

Es la configuración para describir cómo se deben controlar los errores en la app.

Representación JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingSettings.ErrorHandlingStrategy)
}
Campos
errorHandlingStrategy

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

Es opcional. Estrategia que se usará para el manejo de errores.

ErrorHandlingSettings.ErrorHandlingStrategy

Define la estrategia para controlar los errores.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED Estrategia de manejo de errores no especificada. La configuración predeterminada es FALLBACK_RESPONSE.
NONE No se habilitó ningún control específico.
FALLBACK_RESPONSE En caso de errores del LLM, se mostrará un mensaje de resguardo al usuario.

App.ToolExecutionMode

Define el comportamiento de ejecución de la herramienta si el agente selecciona varias herramientas al mismo tiempo.

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED Modo de ejecución de la herramienta no especificado. El valor predeterminado es PARALLEL.
PARALLEL Si se seleccionan varias herramientas, se ejecutarán en paralelo, con el mismo ToolContext.
SEQUENTIAL Si se seleccionan varias herramientas, se ejecutarán de forma secuencial. La siguiente herramienta solo se ejecutará después de que se complete la anterior y pueda ver el ToolContext actualizado de la herramienta anterior.

EvaluationMetricsThresholds

Es la configuración del umbral para las métricas en una evaluación.

Representación JSON 
{
  "goldenEvaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)
}
Campos
goldenEvaluationMetricsThresholds

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds)

Es opcional. Son los umbrales de las métricas de evaluación de referencia.
hallucinationMetricBehavior
(deprecated)

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

Es opcional. Obsoleto: Usa goldenHallucinationMetricBehavior en su lugar. Actualmente, el comportamiento de la métrica de alucinación se usa para las evaluaciones de referencia.
goldenHallucinationMetricBehavior

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

Es opcional. Es el comportamiento de la métrica de alucinación para las evaluaciones de referencia.
scenarioHallucinationMetricBehavior

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

Es opcional. Es el comportamiento de la métrica de alucinación para las evaluaciones de situaciones.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

Es la configuración para las evaluaciones de referencia.

Representación JSON 
{
  "turnLevelMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (EvaluationMetricsThresholds.ToolMatchingSettings)
  }
}
Campos
turnLevelMetricsThresholds

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)

Es opcional. Son los umbrales de las métricas a nivel del turno.
expectationLevelMetricsThresholds

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)

Es opcional. Son los umbrales de las métricas del nivel de expectativa.
toolMatchingSettings

object (EvaluationMetricsThresholds.ToolMatchingSettings)

Es opcional. Es la configuración de la herramienta de correlación. Una llamada a herramienta adicional es una llamada a herramienta que está presente en la ejecución, pero no coincide con ninguna llamada a herramienta en la expectativa ideal.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

Son los umbrales de las métricas a nivel del turno.

Representación JSON 
{
  "semanticSimilarityChannel": enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel),
  "semanticSimilaritySuccessThreshold": integer,
  "overallToolInvocationCorrectnessThreshold": number
}
Campos
semanticSimilarityChannel

enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel)

Es opcional. Es el canal de similitud semántica que se usará para la evaluación.
semanticSimilaritySuccessThreshold

integer

Es opcional. Es el umbral de éxito para la similitud semántica. Debe ser un número entero entre 0 y 4. El valor predeterminado es >= 3.
overallToolInvocationCorrectnessThreshold

number

Es opcional. Es el umbral de éxito para la corrección general de la invocación de la herramienta. Debe ser un número de punto flotante entre 0 y 1. El valor predeterminado es 1.0.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

Es el canal de similitud semántica que se usará.

Enums
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED No se especificó la métrica. El valor predeterminado es TEXT.
TEXT Usa la similitud semántica del texto.
AUDIO Usar la similitud semántica de audio

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

Son los umbrales de las métricas de nivel de expectativa.

Representación JSON 
{
  "toolInvocationParameterCorrectnessThreshold": number
}
Campos
toolInvocationParameterCorrectnessThreshold

number

Es opcional. Es el umbral de éxito para la corrección de parámetros de invocación de herramientas individuales. Debe ser un número de punto flotante entre 0 y 1. El valor predeterminado es 1.0.

EvaluationMetricsThresholds.ToolMatchingSettings

Es la configuración para la coincidencia de llamadas a herramientas.

Representación JSON 
{
  "extraToolCallBehavior": enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)
}
Campos
extraToolCallBehavior

enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)

Es opcional. Comportamiento para las llamadas a herramientas adicionales. La configuración predeterminada es FAIL.

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

Define el comportamiento cuando se encuentra una llamada a herramienta adicional. Una llamada a herramienta adicional es una llamada a herramienta que está presente en la ejecución, pero no coincide con ninguna llamada a herramienta en la expectativa ideal.

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Comportamiento no especificado. La configuración predeterminada es FAIL.
FAIL La evaluación falla si se encuentra una llamada a herramienta adicional.
ALLOW Permite la llamada a herramienta adicional.

EvaluationMetricsThresholds.HallucinationMetricBehavior

Es el comportamiento de la métrica de alucinación. Independientemente del comportamiento, la métrica siempre se calculará. La diferencia es que, cuando se inhabilita, la métrica no se usa para calcular la puntuación general de la evaluación.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamiento de la métrica de alucinación sin especificar.
DISABLED Inhabilita la métrica de alucinación.
ENABLED Habilita la métrica de alucinación.

App.VariableDeclaration

Define la estructura y los metadatos de una variable.

Representación JSON 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
Campos
name

string

Obligatorio. Es el nombre de la variable. El nombre debe comenzar con una letra o un guion bajo, y solo puede contener letras, números o guiones bajos.
description

string

Obligatorio. Es la descripción de la variable.
schema

object (Schema)

Obligatorio. Es el esquema de la variable.

DataStoreSettings

Es la configuración relacionada con el almacén de datos de la app.

Representación JSON 
{
  "engines": [
    {
      object (DataStoreSettings.Engine)
    }
  ]
}
Campos
engines[]

object (DataStoreSettings.Engine)

Solo salida. Son los motores de la app.

DataStoreSettings.Engine

Es un motor al que se conectan los almacenes de datos. Consulta Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Representación JSON 
{
  "name": string,
  "type": enum (DataStoreSettings.Engine.Type)
}
Campos
name

string

Solo salida. Es el nombre del recurso del motor. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (DataStoreSettings.Engine.Type)

Solo salida. Es el tipo de motor.

DataStoreSettings.Engine.Type

Es el tipo de motor. Consulta la documentación disponible en https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType y https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enums
TYPE_UNSPECIFIED Tipo de motor sin especificar.
ENGINE_TYPE_CHAT Es el tipo de motor de chat. Es el motor SOLUTION_TYPE_CHAT de la app. Todos los almacenes de datos del conector que se agreguen a la app se agregarán a este motor.

ClientCertificateSettings

Es la configuración de los certificados de cliente personalizados.

Representación JSON 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Campos
tlsCertificate

string

Obligatorio. Certificado TLS codificado en formato PEM. Esta cadena debe incluir las líneas de encabezado de inicio y pie de página de finalización.
privateKey

string

Obligatorio. Nombre del recurso de la versión secreta de Secret Manager que almacena la clave privada codificada en formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Es opcional. Es el nombre del recurso de la versión secreta de Secret Manager que almacena la frase de contraseña para desencriptar la clave privada. Se debe dejar sin configurar si la clave privada no está encriptada. Formato: projects/{project}/secrets/{secret}/versions/{version}

Métodos

create

 Crea una app nueva en el proyecto y la ubicación especificados.

delete

 Borra la app especificada.

executeTool

 Ejecuta la herramienta determinada con los argumentos determinados.

exportApp

 Exporta la app especificada.

get

 Obtiene detalles de la app especificada.

importApp

 Importa la app especificada.

list

 Enumera las apps en el proyecto y la ubicación determinados.

patch

 Actualiza la app especificada.

retrieveToolSchema

 Recupera el esquema de la herramienta determinada.