REST Resource: projects.locations.apps

Recurso: App

Una app funciona como un contenedor de nivel superior para un grupo de agentes, incluidos el agente raíz y sus agentes secundarios, junto con sus configuraciones asociadas. Estos agentes trabajan juntos 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)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
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 legible por humanos de la app.

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. La configuración de idioma de la app

timeZoneSettings

object (TimeZoneSettings)

Es opcional. Es la configuración de la 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. Configuración de manejo de errores de la app.

modelSettings

object (ModelSettings)

Es opcional. La configuración predeterminada del modelo de LLM para la app. Los recursos individuales (p.ej., agentes y protecciones) pueden anular estos parámetros de configuración 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á de forma predeterminada en PARALLEL.

evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

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

variableDeclarations[]

object (App.VariableDeclaration)

Es opcional. Las declaraciones de las variables.

predefinedVariableDeclarations[]

object (App.VariableDeclaration)

Solo salida. Son las declaraciones de 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. Es la lista de protecciones 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 la etiqueta de entidad que se usa para garantizar que el objeto no haya cambiado durante una operación de lectura, modificación y escritura. Si la etag está vacía, 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.

vpcScSettings

object (VpcScSettings)

Es opcional. La configuración de VPC-SC para la app.

locked

boolean

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

validationErrors[]

string

Solo salida. Configuraciones incorrectas o advertencias en la app

dashboardSettings

object (DashboardSettings)

Es opcional. Configuración del panel específica de la app para vincular y configurar los paneles de Estadísticas de Contact Center.

LanguageSettings

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. Es la 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 true, los agentes de la app usarán instrucciones precompiladas para mejorar el manejo de la entrada multilingüe.

fallbackAction
(deprecated)

string

Es opcional. Obsoleto: Esta función ya no es compatible. En su lugar, usa enableMultilingualSupport para mejorar el manejo de la entrada multilingüe. Es la acción que se debe realizar cuando un agente recibe una entrada en un idioma no admitido.

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

TimeZoneSettings

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

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

string

Es opcional. Es 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)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
Campos
synthesizeSpeechConfigs

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

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

Si no se encuentra la configuración del código de idioma especificado, se usará la configuración del 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 mayúsculas de 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 interactuar.

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

ambientSoundConfig

object (AmbientSoundConfig)

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

customVoiceSamples[]

object (CustomVoiceSample)

Es opcional. Configura muestras de voz personalizadas para la clonación de voz.

SynthesizeSpeechConfig

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

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

string

Opcional. El nombre de la voz. Si no se configura, 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 de Cloud Text-to-Speech.

speakingRate

number

Es opcional. La velocidad de habla en el rango [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] devolverán un error.

model

string

Es opcional. Es el modelo que se usa para sintetizar audio. Valores admitidos actualmente: - "gemini-3.1-flash-tts-preview" Si está vacío, se usa Chirp3-HD.

instruction

string

Es opcional. Es la instrucción que se usa para sintetizar la voz cuando se usa un modelo generativo.

BargeInConfig

Es la configuración de 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. Obsoleto: disableBargeIn dejó de estar disponible y se reemplazó por disableBargeInControl en ChannelProfile.

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.

bargeInAwareness

boolean

Es opcional. Si está habilitado, el agente adaptará su próxima respuesta en función de la suposición de que el usuario no escuchó el mensaje anterior completo 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 ambiental que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación.

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

number

Es opcional. Es la ganancia de volumen (en dB) del volumen nativo normal que admite el ruido ambiental, en el rango [-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.

Es el ruido ambiental que se reproducirá con la respuesta sintetizada del agente para mejorar la naturalidad de la conversación. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
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 de 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 el permiso storage.objects.get para el objeto de Cloud Storage.

prebuiltAmbientSound

string

Es opcional. Es el nombre del sonido ambiental predeterminado. 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" - "air_conditioner"

Fin de los campos mutuamente excluyentes.

AmbientSoundConfig.PrebuiltAmbientNoise

Ruido ambiental precompilado.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED No especificado.
RETAIL_STORE Ruido ambiental de una tienda minorista.
CONVENTION_HALL Ruido ambiental de una sala de convenciones.
OUTDOOR Ruido ambiental de una calle.

CustomVoiceSample

Es la configuración de una muestra de voz personalizada que se usa para la clonación de voz.

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

string

Es opcional. Es el nombre definido por el usuario para la muestra de voz personalizada.

voiceSampleGcsUri

string

Es opcional. Es el URI de Cloud Storage de la muestra de audio para la clonación de voz. La muestra de audio debe ser un archivo WAV de 24 kHz y un solo canal.

consentAudioGcsUri

string

Es opcional. Audio de consentimiento para la clonación de voz.

voiceInstruction

string

Es opcional. Son las instrucciones en lenguaje natural para el estilo, el tono, el ritmo o la pronunciación de la voz.

previewAudioContent

string (bytes format)

Solo salida. Es el audio de vista previa sintetizado para la voz personalizada, con formato WAV canónico (LINEAR16, 24 kHz, 16 bits, mono).

Es una cadena codificada en Base64.

previewText

string

Es opcional. Texto para sintetizar el audio de vista previa de la voz personalizada.

warnings[]

object (CustomVoiceSample.Warning)

Solo salida. Son los mensajes de advertencia que se encontraron durante el procesamiento de la clonación de voz (p.ej., nivel de audio bajo).

voiceInstructionMode

enum (CustomVoiceSample.VoiceInstructionMode)

Es opcional. Es el modo de instrucción para la muestra de voz. Si no se especifica, se establece de forma predeterminada como NO_INSTRUCTION.

CustomVoiceSample.Warning

Es un mensaje de advertencia que se encuentra durante el procesamiento de la muestra de voz.

Representación JSON
{
  "message": string,
  "type": enum (CustomVoiceSample.Warning.WarningType)
}
Campos
message

string

Solo salida. Es una descripción legible por humanos de la advertencia.

type

enum (CustomVoiceSample.Warning.WarningType)

Solo salida. Es el tipo de advertencia.

CustomVoiceSample.Warning.WarningType

Es el tipo de advertencia que se encontró durante el procesamiento de la muestra de voz.

Enums
WARNING_TYPE_UNSPECIFIED Indica que no se especificó el tipo de advertencia.
LOW_AUDIO_LEVEL El nivel de audio de la muestra de voz es demasiado bajo (p.ej., amplitud RMS baja).

CustomVoiceSample.VoiceInstructionMode

Es el modo de instrucción para la muestra de voz.

Enums
VOICE_INSTRUCTION_MODE_UNSPECIFIED Indica que no se especificó el modo de instrucción. La configuración predeterminada es NO_INSTRUCTION.
NO_INSTRUCTION No se usarán instrucciones por voz.
GENERATE_INSTRUCTION La IA generará automáticamente la instrucción de voz a partir de la muestra de audio.
CUSTOM_INSTRUCTION Instrucción de voz personalizada que proporciona el usuario.

LoggingSettings

Es la configuración que describe los comportamientos de registro de la app.

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

object (RedactionConfig)

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

audioRecordingConfig

object (AudioRecordingConfig)

Es opcional. Configuración de cómo se deben grabar las interacciones de audio. El audio está sujeto a ocultamiento según lo configurado en RedactionConfig.

unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Es opcional. Configura una grabación adicional de audio sin ocultar. Esto se puede usar para mantener una copia de audio sin procesar cuando se enabled la ocultación de audio, por lo general, con fines de auditoría o supervisión.

bigqueryExportSettings

object (BigQueryExportSettings)

Es opcional. Configura los comportamientos de BigQuery Export para la app. Los datos de la conversación están sujetos a ocultamiento, según se configura en RedactionConfig.

unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Es opcional. Configura los comportamientos de exportación de BigQuery para la app. Los datos de conversación sin ocultar se exportarán a las tablas de BigQuery si están habilitados.

cloudLoggingSettings

object (CloudLoggingSettings)

Es opcional. Es la configuración para describir los comportamientos de Cloud Logging de 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 de cómo se deben grabar 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. Son los parámetros de configuración que describen los comportamientos de recopilación de datos de conversaciones para la canalización de análisis de 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 true, se aplicará la ocultación 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 grabar las interacciones de audio.

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

string

Es opcional. El bucket de Cloud Storage para almacenar las grabaciones de audio de la sesión. El URI debe empezar 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 el permiso 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 AAAA-MM-DD - $session: ID de la sesión

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

BigQueryExportSettings

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

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

boolean

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

project

string

Es opcional. 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 está en un proyecto diferente al de la app, debes otorgar el rol roles/bigquery.admin al agente de servicio de CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

dataset

string

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

CloudLoggingSettings

Es la configuración para describir los comportamientos de Cloud Logging de 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,
  "retentionWindow": string
}
Campos
disableConversationLogging

boolean

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

retentionWindow

string (Duration format)

Es opcional. Controla el período de retención de la conversación. Si no se establece, la conversación se conservará durante 365 días.

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

MetricAnalysisSettings

Es la configuración para describir los comportamientos de recopilación de datos de conversaciones 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 conversación para las métricas de análisis de LLM. Si se establece como verdadero, no se recopilarán datos de conversación para las métricas de análisis de LLM; de lo contrario, se recopilarán datos de conversación.

ErrorHandlingSettings

Parámetros de configuración para describir cómo se deben controlar los errores en la app

Representación JSON
{
  "errorHandlingStrategy": enum (ErrorHandlingSettings.ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (ErrorHandlingSettings.FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (ErrorHandlingSettings.EndSessionConfig)
  }
}
Campos
errorHandlingStrategy

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

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

fallbackResponseConfig

object (ErrorHandlingSettings.FallbackResponseConfig)

Es opcional. Configuración para controlar las respuestas de resguardo.

endSessionConfig

object (ErrorHandlingSettings.EndSessionConfig)

Es opcional. Es la configuración para finalizar la sesión en caso de errores del sistema (p.ej., errores de LLM).

ErrorHandlingSettings.ErrorHandlingStrategy

Define la estrategia para controlar errores.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED Estrategia de manejo de errores no especificada.
NONE No se habilita ningún control específico.
FALLBACK_RESPONSE Se devolverá un mensaje de resguardo al usuario en caso de que se produzcan errores del sistema (p.ej., errores del LLM).
END_SESSION Se emitirá un indicador EndSession en caso de errores del sistema (p.ej., errores del LLM).

ErrorHandlingSettings.FallbackResponseConfig

Configuración para controlar las respuestas de resguardo.

Representación JSON
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
Campos
customFallbackMessages

map (key: string, value: string)

Es opcional. Son los mensajes de resguardo en caso de errores del sistema (p.ej., errores de LLM), asignados por el código de idioma admitido.

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

maxFallbackAttempts

integer

Es opcional. Es la cantidad máxima de intentos de resguardo que se deben realizar antes de que el agente emita el indicador EndSession.

ErrorHandlingSettings.EndSessionConfig

Es la configuración para finalizar la sesión en caso de errores del sistema (p.ej., errores de LLM).

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

boolean

Es opcional. Indica si se debe derivar la sesión en EndSession. Si se deriva la sesión, metadata in EndSession contendrá sessionEscalated = true. Consulta https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent para obtener más detalles.

App.ToolExecutionMode

Define el comportamiento de ejecución de las herramientas 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

Configuración de 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. 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

Configuración de 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 de nivel de expectativa.

toolMatchingSettings

object (EvaluationMetricsThresholds.ToolMatchingSettings)

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

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

Umbrales de métricas a nivel de 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 herramientas. 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 Métrica sin especificar. La configuración predeterminada es TEXT.
TEXT Usa la similitud semántica de texto.
AUDIO Usa la similitud semántica de audio.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

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

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

number

Es opcional. Es el umbral de éxito para la corrección de los 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

Configuración para las llamadas a la herramienta que coincidan.

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 la herramienta adicional. Una llamada a la herramienta adicional es una llamada a la herramienta que está presente en la ejecución, pero que no coincide con ninguna llamada a la herramienta en la expectativa de referencia.

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

EvaluationMetricsThresholds.HallucinationMetricBehavior

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 de evaluación general.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamiento de la métrica de alucinación no especificado.
DISABLED Inhabilitar 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

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

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 Indica que no se especificó el tipo de motor.
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

Configuración de los certificados de cliente personalizados.

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

string

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

privateKey

string

Obligatorio. Es el nombre del recurso de la versión del Secret de SecretManager 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 del Secret de Secret Manager que almacena la frase de contraseña para desencriptar la clave privada. Debe dejarse sin configurar si la clave privada no está encriptada. Formato: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

La configuración de VPC-SC para la app.

Representación JSON
{
  "allowedOrigins": [
    string
  ]
}
Campos
allowedOrigins[]

string

Es opcional. Son los orígenes HTTP(S) permitidos a los que las herramientas de OpenAPI de la app pueden llamar directamente cuando los Controles del servicio de VPC están habilitados. Estas cadenas deben coincidir exactamente con el origen, incluido el puerto si se especifica. Por ejemplo, "https://example.com" o "https://example.com:443". Esta lista aún no se aplica a las herramientas de Python que pueden realizar llamadas HTTP directas.

DashboardSettings

Es la configuración de los paneles asociados con la app, que se muestran en la vista de Monitoring.

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

string

Es opcional. Es el nombre del recurso del panel predeterminado de Estadísticas de Contact Center asociado con la app. Este es el panel que se mostrará cuando los usuarios naveguen a la vista de Supervisión de la app.

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

Métodos

create

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

delete

Borra la app especificada.

executeTool

Ejecuta la herramienta especificada con los argumentos proporcionados.

exportApp

Exporta la app especificada.

generateOnboardingSuggestions

Genera sugerencias de integración personalizadas para el estado cero de Arc: clasifica al usuario que realiza la solicitud (nuevo, explorando o recurrente) a partir de su historial de sesiones de asistente en la app y devuelve chips de sugerencias (reanudar una sesión, continuar el trabajo o comenzar algo nuevo) para renderizar antes de que se envíe cualquier mensaje.

get

Obtiene detalles de la app especificada.

getExtendedAgentCard

Obtiene la tarjeta de agente extendida para el agente autenticado.

importApp

Importa la app especificada.

list

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

patch

Actualiza la app especificada.

retrieveToolSchema

Recupera el esquema de la herramienta determinada.