MCP Tools Reference: ces.googleapis.com

Ferramenta: update_app

Atualiza o app especificado. Sempre transmita uma máscara de atualização na entrada.

O exemplo de código abaixo mostra como usar curl para chamar a ferramenta MCP update_app.

Solicitação curl 
curl --location 'https://ces.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "update_app",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Esquema de entrada

Mensagem de solicitação para AgentService.UpdateApp.

UpdateAppRequest

Representação JSON 
{
  "app": {
    object (App)
  },
  "updateMask": string
}
Campos
app

object (App)

Obrigatório. O app a ser atualizado.
updateMask

string (FieldMask format)

Opcional. A máscara de campo é usada para controlar quais campos são atualizados. Se a máscara não estiver presente, todos os campos serão atualizados.

Uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

App

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
Campos
name

string

Identificador. O identificador exclusivo do app. Formato: projects/{project}/locations/{location}/apps/{app}
displayName

string

Obrigatório. Nome de exibição do app.
description

string

Opcional. Descrição legível do app.
pinned

boolean

Opcional. Se o app está fixado na lista de apps.
rootAgent

string

Opcional. O agente raiz é o ponto de entrada do app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Opcional. Configurações de idioma do app.
timeZoneSettings

object (TimeZoneSettings)

Opcional. Configurações de fuso horário do app.
audioProcessingConfig

object (AudioProcessingConfig)

Opcional. Configuração de processamento de áudio do app.
loggingSettings

object (LoggingSettings)

Opcional. Configurações de registro do app.
errorHandlingSettings

object (ErrorHandlingSettings)

Opcional. Configurações de tratamento de erros do app.
modelSettings

object (ModelSettings)

Opcional. As configurações padrão do modelo de LLM para o app. Recursos individuais (por exemplo, agentes, proteções) podem substituir essas configurações conforme necessário.
toolExecutionMode

enum (ToolExecutionMode)

Opcional. O modo de execução da ferramenta para o app. Se não for fornecido, o padrão será PARALLEL.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Opcional. Os limites de avaliação do app.
variableDeclarations[]

object (VariableDeclaration)

Opcional. As declarações das variáveis.
predefinedVariableDeclarations[]

object (VariableDeclaration)

Apenas saída. As declarações de variáveis predefinidas para o app.
globalInstruction

string

Opcional. Instruções para todos os agentes no app. Use essa instrução para configurar uma identidade ou personalidade estável em todos os agentes.
guardrails[]

string

Opcional. Lista de proteções para o app. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Opcional. As configurações do repositório de dados do app.
defaultChannelProfile

object (ChannelProfile)

Opcional. O perfil de canal padrão usado pelo app.
metadata

map (key: string, value: string)

Opcional. Metadados sobre o app. Esse campo pode ser usado para armazenar outras informações relevantes para os detalhes ou usos pretendidos do app.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de quando o app foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de quando o app foi atualizado pela última vez.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
etag

string

Apenas saída. Etag usada para garantir que o objeto não tenha sido alterado durante uma operação de leitura-modificação-gravação. Se a etag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.
deploymentCount

integer

Apenas saída. Número de implantações no app.
clientCertificateSettings

object (ClientCertificateSettings)

Opcional. As configurações padrão do certificado do cliente para o app.
vpcScSettings

object (VpcScSettings)

Opcional. Configurações do VPC-SC para o app.
locked

boolean

Opcional. Indica se o app está bloqueado para mudanças. Se o app estiver bloqueado, as modificações nos recursos dele serão rejeitadas.
validationErrors[]

string

Apenas saída. Configurações incorretas ou avisos no app.
dashboardSettings

object (DashboardSettings)

Opcional. Configurações de painel específicas do app para vincular e configurar painéis do Contact Center Insights.

LanguageSettings

Representação JSON 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
Campos
defaultLanguageCode

string

Opcional. O código de idioma padrão do app.
supportedLanguageCodes[]

string

Opcional. Lista de códigos de idiomas compatíveis com o app, além do default_language_code.
enableMultilingualSupport

boolean

Opcional. Ativa o suporte multilíngue. Se for true, os agentes no app vão usar instruções predefinidas para melhorar o processamento de entradas multilíngues.
fallbackAction
(deprecated)

string

Opcional. Descontinuado: este recurso não é mais compatível. Use enable_multilingual_support para melhorar o processamento de entradas multilíngues. A ação a ser realizada quando um agente recebe uma entrada em um idioma sem suporte.

Pode ser uma ação predefinida ou uma chamada de ferramenta personalizada. Os valores válidos são: - O nome completo do recurso de uma ferramenta, que aciona uma execução específica. - Uma ação predefinida do sistema, como "escalar" ou "sair", que aciona um sinal EndSession com o metadata correspondente para encerrar a conversa.

TimeZoneSettings

Representação JSON 
{
  "timeZone": string
}
Campos
timeZone

string

Opcional. O fuso horário do app do banco de dados de fuso horário, por exemplo, America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

Representação JSON 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
Campos
synthesizeSpeechConfigs

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

Opcional. Configuração de como a resposta do agente deve ser sintetizada, mapeando o código de idioma para SynthesizeSpeechConfig.

Se a configuração do código de idioma especificado não for encontrada, a configuração do código de idioma raiz será usada. Por exemplo, se o mapa tiver "en-us" e "en", e o código de idioma especificado for "en-gb", a configuração "en" será usada.

Observação: o código do idioma não diferencia maiúsculas de minúsculas.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Opcional. Configura o comportamento do agente para as atividades de interrupção do usuário.
inactivityTimeout

string (Duration format)

Opcional. A duração da inatividade do usuário (sem fala ou interação) antes que o agente peça para ele se engajar novamente. Se não for definido, o agente não vai pedir ao usuário para se reengajar.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
ambientSoundConfig

object (AmbientSoundConfig)

Opcional. Configuração do som ambiente a ser reproduzido com a resposta sintetizada do agente para melhorar a naturalidade da conversa.
customVoiceSamples[]

object (CustomVoiceSample)

Opcional. Configura amostras de voz personalizadas para clonagem de voz.

SynthesizeSpeechConfigsEntry

Representação JSON 
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
Campos
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Representação JSON 
{
  "voice": string,
  "speakingRate": number,
  "model": string,
  "instruction": string
}
Campos
voice

string

Opcional. Nome da voz. Se não for definida, o serviço vai escolher uma voz com base nos outros parâmetros, como language_code.

Para ver a lista de vozes disponíveis, consulte Vozes e idiomas compatíveis da Cloud Text-to-Speech.
speakingRate

number

Opcional. A taxa/velocidade de fala no intervalo [0,25, 2,0]. 1,0 é a velocidade nativa normal compatível com a voz específica. 2,0 é duas vezes mais rápido e 0,5 é metade da velocidade nativa. Valores fora do intervalo [0,25, 2,0] vão retornar um erro.
model

string

Opcional. O modelo usado para sintetizar áudio. Valores compatíveis no momento: - "gemini-3.1-flash-tts-preview". Se estiver vazio, o Chirp3-HD será usado.
instruction

string

Opcional. A instrução usada para sintetizar a fala ao usar um modelo generativo.

BargeInConfig

Representação JSON 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Campos
disableBargeIn
(deprecated)

boolean

Opcional. Descontinuado: o uso de disable_barge_in foi suspenso em favor de disable_barge_in_control em ChannelProfile.

Desativa a interrupção do usuário enquanto o agente está falando. Se for verdadeiro, a entrada do usuário durante a reprodução da resposta do agente será ignorada.
bargeInAwareness

boolean

Opcional. Se ativada, o agente vai adaptar a próxima resposta com base na suposição de que o usuário não ouviu a mensagem anterior completa. Isso não deve ser usado em cenários em que as respostas do agente são exibidas visualmente.

Duração

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Segundos assinados do período. Precisa ser de -315.576.000.000 a +315.576.000.000, inclusive. Observação: esses limites são calculados da seguinte forma: 60 s/min * 60 min/h * 24 h/dia * 365,25 dias/ano * 10.000 anos
nanos

integer

Frações assinadas de um segundo com resolução de nanossegundos do período. As durações menores que um segundo são representadas com um campo seconds de 0 e um campo nanos positivo ou negativo. Para durações de um segundo ou mais, um valor diferente de zero para o campo nanos precisa ter o mesmo sinal que o campo seconds. O valor precisa ser de -999.999.999 a +999.999.999.

AmbientSoundConfig

Representação JSON 
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of list of possible types for union field source.
}
Campos
volumeGainDb

number

Opcional. Ganho de volume (em dB) do volume nativo normal compatível com o ruído ambiente, no intervalo [-96,0, 16,0]. Se não for definido, ou ajustado para um valor de 0,0 (dB), será reproduzido na amplitude de sinal nativo normal. Um valor de -6,0 (dB) será reproduzido em aproximadamente metade da amplitude do sinal nativo normal. Um valor de +6,0 (dB) será reproduzido em aproximadamente o dobro da amplitude do sinal nativo normal. É altamente recomendável não exceder +10 (dB). Geralmente, não há aumento efetivo de volume para qualquer valor maior que isso.
Campo de união source. Ruído ambiente a ser reproduzido com a resposta sintetizada do agente para melhorar a naturalidade da conversa. source pode ser apenas de um dos tipos a seguir:
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

Opcional. Descontinuado: o uso de prebuilt_ambient_noise foi descontinuado e substituído por prebuilt_ambient_sound.
gcsUri

string

Opcional. Ruído ambiente como um arquivo WAV de 16 kHz de canal único armazenado no Cloud Storage.

Observação: verifique se o agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com tem a permissão storage.objects.get para o objeto do Cloud Storage.
prebuiltAmbientSound

string

Opcional. Nome do som ambiente predefinido. Os valores válidos são: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

CustomVoiceSample

Representação JSON 
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (Warning)
    }
  ],
  "voiceInstructionMode": enum (VoiceInstructionMode)
}
Campos
name

string

Opcional. O nome definido pelo usuário para a amostra de voz personalizada.
voiceSampleGcsUri

string

Opcional. O URI do Cloud Storage para a amostra de áudio para clonagem de voz. A amostra de áudio precisa ser um arquivo WAV de canal único de 24 kHz.
consentAudioGcsUri

string

Opcional. Áudio de consentimento para clonagem de voz.
voiceInstruction

string

Opcional. Instruções em linguagem natural para estilo, tom, ritmo ou pronúncia da voz.
previewAudioContent

string (bytes format)

Apenas saída. Áudio de prévia sintetizado para voz personalizada, formatado como WAV canônico (LINEAR16, 24 kHz, 16 bits, mono).

Uma string codificada em base64.
previewText

string

Opcional. Texto para sintetizar o áudio de prévia da voz personalizada.
warnings[]

object (Warning)

Apenas saída. Mensagens de aviso encontradas durante o processamento da clonagem de voz (por exemplo, nível de áudio baixo).
voiceInstructionMode

enum (VoiceInstructionMode)

Opcional. Modo de instrução para a amostra de voz. Se não for especificado, o padrão será NO_INSTRUCTION.

Aviso

Representação JSON 
{
  "message": string,
  "type": enum (WarningType)
}
Campos
message

string

Apenas saída. Uma descrição legível por humanos do aviso.
type

enum (WarningType)

Apenas saída. O tipo do aviso.

LoggingSettings

Representação 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)

Opcional. Configuração de como os dados sensíveis devem ser encobertos.
audioRecordingConfig

object (AudioRecordingConfig)

Opcional. Configuração de como as interações de áudio devem ser gravadas. O áudio está sujeito à edição conforme configurado em RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Opcional. Configura uma gravação extra de áudio sem edição. Isso pode ser usado para manter uma cópia de áudio bruta quando a edição de áudio é enabled, normalmente para fins de auditoria ou monitoramento.
bigqueryExportSettings

object (BigQueryExportSettings)

Opcional. Configura os comportamentos de exportação do BigQuery para o app. Os dados da conversa estão sujeitos a encobrimento, conforme configurado em RedactionConfig.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Opcional. Configura os comportamentos de exportação do BigQuery para o app. Os dados de conversa não editados serão exportados para tabelas do BigQuery se estiverem ativados.
cloudLoggingSettings

object (CloudLoggingSettings)

Opcional. Configurações para descrever os comportamentos do Cloud Logging para o app.
conversationLoggingSettings

object (ConversationLoggingSettings)

Opcional. Configurações para descrever os comportamentos de registro de conversas do app.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Opcional. Configuração de como as interações de áudio devem ser gravadas para a avaliação. Por padrão, a gravação de áudio não está ativada para sessões de avaliação.
metricAnalysisSettings

object (MetricAnalysisSettings)

Opcional. Configurações para descrever os comportamentos de coleta de dados de conversas para o pipeline de análise de LLM do app.
requiredRecordingConsent

boolean

Opcional. Se o app precisa informar o que pode ser gravado antes de manter qualquer registro.

Quando verdadeiro, uma sessão começa com a gravação desativada e permanece assim até que o cliente envie SessionInput.recording_control, que decide cada turno a partir desse momento. Isso inclui a gravação de áudio, o histórico de conversas, o BigQuery Export e o Cloud Logging.

Quando false, o padrão, as configurações acima decidem por conta própria, e o cliente não precisa enviar nada.

RedactionConfig

Representação JSON 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Campos
enableRedaction

boolean

Opcional. Se for true, a encobrimento será aplicada em vários cenários de geração de registros, incluindo histórico de conversas, Cloud Logging e gravação de áudio.
inspectTemplate

string

Opcional. Nome do modelo de inspeção da DLP para configurar a detecção de tipos de dados sensíveis.

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

string

Opcional. Nome do modelo de desidentificação da DLP para instruir sobre como desidentificar o conteúdo.

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

AudioRecordingConfig

Representação JSON 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
Campos
gcsBucket

string

Opcional. O bucket do Cloud Storage para armazenar as gravações de áudio da sessão. O URI precisa começar com "gs://".

Escolha um local de bucket que atenda aos seus requisitos de residência de dados.

Observação: se o bucket do Cloud Storage estiver em um projeto diferente do app, conceda a permissão storage.objects.create ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Opcional. O prefixo do caminho do Cloud Storage para gravações de áudio.

Esse prefixo pode incluir os seguintes marcadores de posição, que serão substituídos dinamicamente no momento da veiculação: - $project: ID do projeto - $location: local do app - $app: ID do app - $date: data da sessão no formato AAAA-MM-DD - $session: ID da sessão

Se o prefixo do caminho não for especificado, o prefixo padrão $project/$location/$app/$date/$session/ será usado.

BigQueryExportSettings

Representação JSON 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
Campos
enabled

boolean

Opcional. Indica se o BigQuery Export está ativado.
project

string

Opcional. O ID do projeto do conjunto de dados do BigQuery para onde os dados serão exportados.

Observação: se o conjunto de dados do BigQuery estiver em um projeto diferente do app, conceda o papel roles/bigquery.admin ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Opcional. O ID do conjunto de dados do BigQuery para exportar os dados.

CloudLoggingSettings

Representação JSON 
{
  "enableCloudLogging": boolean
}
Campos
enableCloudLogging

boolean

Opcional. Se o Cloud Logging deve ser ativado para as sessões.

ConversationLoggingSettings

Representação JSON 
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
Campos
disableConversationLogging

boolean

Opcional. Se o registro de conversas deve ser desativado para as sessões.
retentionWindow

string (Duration format)

Opcional. Controla a janela de retenção da conversa. Se não for definido, a conversa será retida por 365 dias.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

MetricAnalysisSettings

Representação JSON 
{
  "llmMetricsOptedOut": boolean
}
Campos
llmMetricsOptedOut

boolean

Opcional. Se os dados de conversa devem ser coletados para métricas de análise de LLM. Se for verdadeiro, os dados da conversa não serão coletados para as métricas de análise do LLM. Caso contrário, os dados da conversa serão coletados.

ErrorHandlingSettings

Representação JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (EndSessionConfig)
  }
}
Campos
errorHandlingStrategy

enum (ErrorHandlingStrategy)

Opcional. A estratégia a ser usada para o tratamento de erros.
fallbackResponseConfig

object (FallbackResponseConfig)

Opcional. Configuração para processar respostas de fallback.
endSessionConfig

object (EndSessionConfig)

Opcional. Configuração para encerrar a sessão em caso de erros do sistema (por exemplo, erros de LLM).

FallbackResponseConfig

Representação JSON 
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
Campos
customFallbackMessages

map (key: string, value: string)

Opcional. As mensagens de fallback em caso de erros do sistema (por exemplo, erros de LLM), mapeadas pelo código de idioma compatível.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts

integer

Opcional. O número máximo de tentativas de substituição antes que o agente emita o sinal EndSession.

CustomFallbackMessagesEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

EndSessionConfig

Representação JSON 
{

  // Union field _escalate_session can be only one of the following:
  "escalateSession": boolean
  // End of list of possible types for union field _escalate_session.
}
Campos

Campo de união _escalate_session.

_escalate_session pode ser apenas de um dos tipos a seguir:
escalateSession

boolean

Opcional. Se a sessão deve ser encaminhada em EndSession. Se a sessão for encaminhada, metadata in EndSession vai conter session_escalated = true. Consulte https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent para mais detalhes.

ModelSettings

Representação JSON 
{
  "model": string,
  "thinkingLevel": enum (ThinkingLevel),

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

string

Opcional. O modelo de LLM que o agente deve usar. Se não for definido, o agente vai herdar o modelo do agente pai.
thinkingLevel

enum (ThinkingLevel)

Opcional. O nível de raciocínio do modelo.

Campo de união _temperature.

_temperature pode ser apenas de um dos tipos a seguir:
temperature

number

Opcional. Se definida, essa temperatura será usada para o modelo de LLM. A temperatura controla a aleatoriedade das respostas do modelo. Temperaturas mais baixas produzem respostas mais previsíveis. Temperaturas mais altas produzem respostas mais criativas.

EvaluationMetricsThresholds

Representação JSON 
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
Campos
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

Opcional. Os limites das métricas de avaliação de ouro.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Opcional. Descontinuado: use golden_hallucination_metric_behavior. O comportamento da métrica de alucinação é usado atualmente para avaliações de ouro.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opcional. O comportamento da métrica de alucinação para avaliações de referência.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opcional. O comportamento da métrica de alucinação para avaliações de cenário.

GoldenEvaluationMetricsThresholds

Representação JSON 
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
Campos
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

Opcional. Os limites das métricas no nível da rodada.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Opcional. Os limites de métricas do nível de expectativa.
toolMatchingSettings

object (ToolMatchingSettings)

Opcional. As configurações de correspondência da ferramenta. Uma chamada de ferramenta extra é uma chamada de ferramenta que está presente na execução, mas não corresponde a nenhuma chamada de ferramenta na expectativa de ouro.

TurnLevelMetricsThresholds

Representação JSON 
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
Campos
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Opcional. O canal de semelhança semântica a ser usado para avaliação.

Campo de união _semantic_similarity_success_threshold.

_semantic_similarity_success_threshold pode ser apenas de um dos tipos a seguir:
semanticSimilaritySuccessThreshold

integer

Opcional. O limite de sucesso para similaridade semântica. O valor precisa ser um número inteiro entre 0 e 4. O padrão é >= 3.

Campo de união _overall_tool_invocation_correctness_threshold.

_overall_tool_invocation_correctness_threshold pode ser apenas de um dos tipos a seguir:
overallToolInvocationCorrectnessThreshold

number

Opcional. O limite de sucesso para a precisão geral da invocação de ferramentas. Precisa ser um número de ponto flutuante entre 0 e 1. O padrão é 1.0.

ExpectationLevelMetricsThresholds

Representação JSON 
{

  // Union field _tool_invocation_parameter_correctness_threshold can be only one
  // of the following:
  "toolInvocationParameterCorrectnessThreshold": number
  // End of list of possible types for union field
  // _tool_invocation_parameter_correctness_threshold.
}
Campos

Campo de união _tool_invocation_parameter_correctness_threshold.

_tool_invocation_parameter_correctness_threshold pode ser apenas de um dos tipos a seguir:
toolInvocationParameterCorrectnessThreshold

number

Opcional. O limite de sucesso para a correção do parâmetro de invocação de ferramenta individual. Precisa ser um número de ponto flutuante entre 0 e 1. O padrão é 1.0.

ToolMatchingSettings

Representação JSON 
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
Campos
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Opcional. Comportamento para chamadas de ferramentas extras. O padrão é FAIL.

VariableDeclaration

Representação JSON 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
Campos
name

string

Obrigatório. O nome da variável. O nome precisa começar com uma letra ou um sublinhado e conter apenas letras, números ou sublinhados.
description

string

Obrigatório. A descrição da variável.
schema

object (Schema)

Obrigatório. O esquema da variável.

Esquema

Representação JSON 
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
Campos
type

enum (Type)

Obrigatório. O tipo dos dados.
properties

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

Opcional. Propriedades de Type.OBJECT.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]

string

Opcional. Propriedades obrigatórias de Type.OBJECT.
description

string

Opcional. A descrição dos dados.
items

object (Schema)

Opcional. Esquema dos elementos de Type.ARRAY.
nullable

boolean

Opcional. Indica se o valor pode ser nulo.
uniqueItems

boolean

Opcional. Indica que os itens na matriz precisam ser exclusivos. Aplica-se apenas a TYPE.ARRAY.
prefixItems[]

object (Schema)

Opcional. Esquemas de elementos iniciais de Type.ARRAY.
additionalProperties

object (Schema)

Opcional. Pode ser um booleano ou um objeto, controla a presença de outras propriedades.
anyOf[]

object (Schema)

Opcional. O valor precisa ser validado em relação a qualquer um (ou mais) dos subesquemas na lista.
enum[]

string

Opcional. Valores possíveis do elemento de tipo primitivo com formato de tipo enumerado. Exemplos: 1. Podemos definir a direção como : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Podemos definir o número do apartamento como : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

Opcional. Valor padrão dos dados.
ref

string

Opcional. Permite referências indiretas entre nós de esquema. O valor precisa ser uma referência válida a um filho da raiz defs.

Por exemplo, o esquema a seguir define uma referência a um nó de esquema chamado "Pet":

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

O valor da propriedade "pet" é uma referência ao nó do esquema chamado "Pet". Veja mais detalhes em https://json-schema.org/understanding-json-schema/structuring.
defs

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

Opcional. Um mapa de definições para uso por ref. Permitido apenas na raiz do esquema.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title

string

Opcional. O título do esquema.
minItems

string (int64 format)

Opcional. Número mínimo de elementos para Type.ARRAY.
maxItems

string (int64 format)

Opcional. Número máximo de elementos para Type.ARRAY.

Campo de união _minimum.

_minimum pode ser apenas de um dos tipos a seguir:
minimum

number

Opcional. Valor mínimo para Type.INTEGER e Type.NUMBER.

Campo de união _maximum.

_maximum pode ser apenas de um dos tipos a seguir:
maximum

number

Opcional. Valor máximo para Type.INTEGER e Type.NUMBER.

PropertiesEntry

Representação JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campos
key

string
value

object (Schema)

Valor

Representação JSON 
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. O tipo de valor. kind pode ser apenas de um dos tipos a seguir:
nullValue

null

Representa um null JSON.
numberValue

number

Representa um número JSON. Não pode ser NaN, Infinity ou -Infinity, porque eles não são compatíveis com JSON. Isso também não pode representar valores Int64 grandes, já que o formato JSON geralmente não os aceita no tipo de número.
stringValue

string

Representa uma string JSON.
boolValue

boolean

Representa um booleano JSON (literal true ou false em JSON).
structValue

object (Struct format)

Representa um objeto JSON.
listValue

array (ListValue format)

Representa uma matriz JSON.

Struct

Representação JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Campos
fields

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

Mapa não ordenado de valores digitados dinamicamente.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Representação JSON 
{
  "key": string,
  "value": value
}
Campos
key

string
value

value (Value format)

ListValue

Representação JSON 
{
  "values": [
    value
  ]
}
Campos
values[]

value (Value format)

Campo repetido de valores digitados dinamicamente.

DefsEntry

Representação JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campos
key

string
value

object (Schema)

DataStoreSettings

Representação JSON 
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
Campos
engines[]

object (Engine)

Apenas saída. Os mecanismos do app.

Mecanismo

Representação JSON 
{
  "name": string,
  "type": enum (Type)
}
Campos
name

string

Apenas saída. O nome do recurso do mecanismo. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (Type)

Apenas saída. O tipo de mecanismo.

ChannelProfile

Representação JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
Campos
profileId

string

Opcional. O identificador exclusivo do perfil do canal.
channelType

enum (ChannelType)

Opcional. O tipo do perfil do canal.
personaProperty

object (PersonaProperty)

Opcional. A propriedade de persona do perfil do canal.
webWidgetConfig

object (WebWidgetConfig)

Opcional. A configuração do widget da Web.
whatsappConfig

object (WhatsAppConfig)

Opcional. Configuração específica para implantações do WhatsApp.
instagramConfig

object (InstagramConfig)

Opcional. Configuração específica para implantações do Instagram.

Campo de união _disable_dtmf.

_disable_dtmf pode ser apenas de um dos tipos a seguir:
disableDtmf

boolean

Opcional. Se a DTMF (frequência múltipla de dois tons) deve ser desativada.

Campo de união _disable_barge_in_control.

_disable_barge_in_control pode ser apenas de um dos tipos a seguir:
disableBargeInControl

boolean

Opcional. Se o controle de interrupção do usuário na conversa deve ser desativado. - true: as interrupções do usuário são desativadas enquanto o agente está falando. - false: o agente mantém o controle automático sobre quando o usuário pode interromper.

Campo de união _noise_suppression_level.

_noise_suppression_level pode ser apenas de um dos tipos a seguir:
noiseSuppressionLevel

string

Opcional. O nível de supressão de ruído do perfil do canal. Os valores disponíveis são "low", "moderate", "high", "very_high".

PersonaProperty

Representação JSON 
{
  "persona": enum (Persona)
}
Campos
persona

enum (Persona)

Opcional. A persona do canal.

WebWidgetConfig

Representação JSON 
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
Campos
modality

enum (Modality)

Opcional. A modalidade do widget da Web.
theme

enum (Theme)

Opcional. O tema do widget da Web.
webWidgetTitle

string

Opcional. O título do widget da Web.
securitySettings

object (SecuritySettings)

Opcional. As configurações de segurança do widget da Web.

SecuritySettings

Representação JSON 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Campos
enablePublicAccess

boolean

Opcional. Indica se o acesso público ao widget da Web está ativado. Se for true, o widget da Web será acessível publicamente. Se for false, o widget da Web precisará ser integrado ao seu próprio sistema de autenticação e autorização para retornar credenciais válidas para acessar o agente do CES.
enableOriginCheck

boolean

Opcional. Indica se a verificação de origem do widget da Web está ativada. Se for true, o widget da Web vai verificar a origem do site que o carrega e só vai permitir que ele seja carregado na mesma origem ou em qualquer uma das origens permitidas.
allowedOrigins[]

string

Opcional. As origens que podem hospedar o widget da Web. Uma origem é definida pela RFC 6454. Se estiver vazio, todas as origens serão permitidas. É permitido um máximo de 100 origens. Exemplo: "https://example.com"
enableRecaptcha

boolean

Opcional. Indica se a verificação reCAPTCHA para o widget da Web está ativada.

WhatsAppConfig

Representação JSON 
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campos
wabaId

string

Obrigatório. O ID da conta do WhatsApp Business.
phoneNumberId

string

Obrigatório. O ID do número de telefone da Meta.
phoneNumber

string

Opcional. O número de telefone no formato E.164.
displayName

string

Apenas saída. O nome da página comercial da Meta que foi buscado.
thumbnailUrl

string

Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado.
description

string

Apenas saída. A descrição da página ou do perfil comercial da Meta.

InstagramConfig

Representação JSON 
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campos
instagramAccountId

string

Obrigatório. O ID da conta do Instagram.
displayName

string

Apenas saída. O nome da página comercial da Meta que foi buscado.
thumbnailUrl

string

Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado.
description

string

Apenas saída. A descrição da página ou do perfil comercial da Meta.

MetadataEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

Carimbo de data/hora

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799, inclusive (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos

integer

Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa ser de 0 a 999.999.999.

ClientCertificateSettings

Representação JSON 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Campos
tlsCertificate

string

Obrigatório. O certificado TLS codificado no formato PEM. Essa string precisa incluir as linhas de cabeçalho de início e rodapé de fim.
privateKey

string

Obrigatório. O nome do recurso da versão do secret do SecretManager que armazena a chave privada codificada no formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Opcional. O nome do recurso da versão do secret do SecretManager que armazena a senha longa para descriptografar a chave privada. Não deve ser definida se a chave privada não estiver criptografada. Formato: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Representação JSON 
{
  "allowedOrigins": [
    string
  ]
}
Campos
allowedOrigins[]

string

Opcional. As origens HTTP(S) permitidas que as ferramentas da OpenAPI no app podem chamar diretamente quando o VPC Service Controls está ativado. Essas strings precisam corresponder exatamente à origem, incluindo a porta, se especificada. Por exemplo, "https://example.com" ou "https://example.com:443". Essa lista ainda não se aplica a ferramentas do Python que podem fazer chamadas HTTP diretas.

DashboardSettings

Representação JSON 
{
  "defaultDashboard": string
}
Campos
defaultDashboard

string

Opcional. O nome do recurso do painel padrão do Contact Center Insights associado ao app. Esse é o painel que será exibido quando os usuários acessarem a visualização de monitoramento do app.

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

FieldMask

Representação JSON 
{
  "paths": [
    string
  ]
}
Campos
paths[]

string

O conjunto de caminhos de máscara de campo.

PrebuiltAmbientNoise

Ruído ambiente predefinido.

Tipos enumerados
PREBUILT_AMBIENT_NOISE_UNSPECIFIED Não especificado.
RETAIL_STORE Ruído ambiente de uma loja de varejo.
CONVENTION_HALL Ruído ambiente de um centro de convenções.
OUTDOOR Ruído ambiente de uma rua.

WarningType

Tipo de aviso encontrado durante o processamento da amostra de voz.

Tipos enumerados
WARNING_TYPE_UNSPECIFIED Tipo de aviso não especificado.
LOW_AUDIO_LEVEL O nível de áudio da amostra de voz está muito baixo (por exemplo, baixa amplitude RMS).

VoiceInstructionMode

Modo de instrução para a amostra de voz.

Tipos enumerados
VOICE_INSTRUCTION_MODE_UNSPECIFIED Modo de instrução não especificado. O padrão é NO_INSTRUCTION.
NO_INSTRUCTION Nenhuma instrução de voz será usada.
GENERATE_INSTRUCTION A instrução de voz será gerada automaticamente pela IA com base na amostra de áudio.
CUSTOM_INSTRUCTION Instrução de voz personalizada fornecida pelo usuário.

ErrorHandlingStrategy

Define a estratégia para lidar com erros.

Tipos enumerados
ERROR_HANDLING_STRATEGY_UNSPECIFIED Estratégia de tratamento de erros não especificada.
NONE Nenhum tratamento específico está ativado.
FALLBACK_RESPONSE Uma mensagem de fallback será retornada ao usuário em caso de erros do sistema (por exemplo, erros de LLM).
END_SESSION Um sinal EndSession será emitido em caso de erros do sistema (por exemplo, erros de LLM).

ThinkingLevel

Configuração do nível de raciocínio do modelo.

Tipos enumerados
THINKING_LEVEL_UNSPECIFIED O nível de pensamento não foi especificado.
DEFAULT Nível de raciocínio padrão.
LOW Nível de raciocínio baixo.
MEDIUM Nível de raciocínio médio.
HIGH Nível de raciocínio alto.

ToolExecutionMode

Define o comportamento de execução da ferramenta se várias ferramentas forem selecionadas pelo agente ao mesmo tempo.

Tipos enumerados
TOOL_EXECUTION_MODE_UNSPECIFIED Modo de execução de ferramenta não especificado. O padrão é PARALLEL.
PARALLEL Se várias ferramentas forem selecionadas, elas serão executadas em paralelo, com o mesmo ToolContext.
SEQUENTIAL Se várias ferramentas forem selecionadas, elas serão executadas em sequência. A próxima ferramenta só será executada depois que a anterior for concluída e puder ver o ToolContext atualizado da ferramenta anterior.

SemanticSimilarityChannel

Canal de similaridade semântica a ser usado.

Tipos enumerados
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED Métrica não especificada. O padrão é TEXT.
TEXT Use a semelhança semântica de texto.
AUDIO Use a semelhança semântica de áudio.

ExtraToolCallBehavior

Define o comportamento quando uma chamada de ferramenta extra é encontrada. Uma chamada de ferramenta extra é uma chamada de ferramenta que está presente na execução, mas não corresponde a nenhuma chamada de ferramenta na expectativa de ouro.

Tipos enumerados
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Comportamento não especificado. O padrão é FAIL.
FAIL Falha na avaliação se uma chamada de ferramenta extra for encontrada.
ALLOW Permita a chamada de ferramenta extra.

HallucinationMetricBehavior

O comportamento da métrica de alucinação. Independentemente do comportamento, a métrica sempre será calculada. A diferença é que, quando desativada, a métrica não é usada para calcular a pontuação geral da avaliação.

Tipos enumerados
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamento não especificado da métrica de alucinação.
DISABLED Desativar a métrica de alucinação.
ENABLED Ativar a métrica de alucinação.

Tipo

Tipos de dados da OpenAPI.

Tipos enumerados
TYPE_UNSPECIFIED Tipo não especificado.
STRING Tipo string.
INTEGER Tipo inteiro.
NUMBER Tipo de número.
BOOLEAN Tipo booleano.
OBJECT Tipo de objeto.
ARRAY Tipo de matriz.

NullValue

Representa um null JSON.

NullValue é um sentinela, que usa um tipo enumerado com apenas um valor para representar o valor nulo da união de tipos Value.

Um campo do tipo NullValue com qualquer valor diferente de 0 é considerado inválido. A maioria dos serializadores ProtoJSON emite um Value com um null_value definido como um null JSON, independentemente do valor inteiro, e, portanto, faz uma ida e volta para um valor 0.

Tipos enumerados
NULL_VALUE Valor nulo.

Tipo

O tipo de mecanismo. Consulte a documentação disponível em 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.

Tipos enumerados
TYPE_UNSPECIFIED Tipo de mecanismo não especificado.
ENGINE_TYPE_CHAT Tipo de mecanismo de chat. O mecanismo SOLUTION_TYPE_CHAT do app. Todos os repositórios de dados do conector adicionados ao app serão adicionados a esse mecanismo.

ChannelType

O tipo do perfil do canal.

Tipos enumerados
UNKNOWN Tipo de canal desconhecido.
WEB_UI Canal da interface da Web.
API Canal da API.
TWILIO Canal da Twilio.
GOOGLE_TELEPHONY_PLATFORM Canal da plataforma de telefonia do Google.
CONTACT_CENTER_AS_A_SERVICE Canal de central de atendimento como serviço (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT Canal de central de atendimento como serviço (chat de CCaaS).
FIVE9 Canal da Five9.
CONTACT_CENTER_INTEGRATION Canal de integração de central de atendimento de terceiros.
WHATSAPP Canal do WhatsApp.
INSTAGRAM canal do Instagram.

Persona

A persona do canal.

Tipos enumerados
UNKNOWN Persona UNKNOWN.
CONCISE O agente mantém as respostas concisas e diretas.
CHATTY O agente fornece mais contexto, explicações e detalhes

Modalidade

Modalidade do widget da Web.

Tipos enumerados
MODALITY_UNSPECIFIED Modalidade desconhecida.
CHAT_AND_VOICE O widget aceita entrada de texto e voz.
VOICE_ONLY O widget só aceita entrada de voz.
CHAT_ONLY O widget só aceita entrada de chat.
CHAT_VOICE_AND_VIDEO O widget aceita entradas de chat, voz e vídeo.

Tema

Tema do widget da Web.

Tipos enumerados
THEME_UNSPECIFIED Tema desconhecido.
LIGHT Tema claro.
DARK Tema escuro.

Esquema de saída

Um app serve como um contêiner de nível superior para um grupo de agentes, incluindo o agente raiz e os subagentes, além das configurações associadas. Esses agentes trabalham juntos para alcançar metas específicas no contexto do app.

App

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
Campos
name

string

Identificador. O identificador exclusivo do app. Formato: projects/{project}/locations/{location}/apps/{app}
displayName

string

Obrigatório. Nome de exibição do app.
description

string

Opcional. Descrição legível do app.
pinned

boolean

Opcional. Se o app está fixado na lista de apps.
rootAgent

string

Opcional. O agente raiz é o ponto de entrada do app. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Opcional. Configurações de idioma do app.
timeZoneSettings

object (TimeZoneSettings)

Opcional. Configurações de fuso horário do app.
audioProcessingConfig

object (AudioProcessingConfig)

Opcional. Configuração de processamento de áudio do app.
loggingSettings

object (LoggingSettings)

Opcional. Configurações de registro do app.
errorHandlingSettings

object (ErrorHandlingSettings)

Opcional. Configurações de tratamento de erros do app.
modelSettings

object (ModelSettings)

Opcional. As configurações padrão do modelo de LLM para o app. Recursos individuais (por exemplo, agentes, proteções) podem substituir essas configurações conforme necessário.
toolExecutionMode

enum (ToolExecutionMode)

Opcional. O modo de execução da ferramenta para o app. Se não for fornecido, o padrão será PARALLEL.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Opcional. Os limites de avaliação do app.
variableDeclarations[]

object (VariableDeclaration)

Opcional. As declarações das variáveis.
predefinedVariableDeclarations[]

object (VariableDeclaration)

Apenas saída. As declarações de variáveis predefinidas para o app.
globalInstruction

string

Opcional. Instruções para todos os agentes no app. Use essa instrução para configurar uma identidade ou personalidade estável em todos os agentes.
guardrails[]

string

Opcional. Lista de proteções para o app. Formato: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Opcional. As configurações do repositório de dados do app.
defaultChannelProfile

object (ChannelProfile)

Opcional. O perfil de canal padrão usado pelo app.
metadata

map (key: string, value: string)

Opcional. Metadados sobre o app. Esse campo pode ser usado para armazenar outras informações relevantes para os detalhes ou usos pretendidos do app.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de quando o app foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de quando o app foi atualizado pela última vez.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
etag

string

Apenas saída. Etag usada para garantir que o objeto não tenha sido alterado durante uma operação de leitura-modificação-gravação. Se a etag estiver vazia, a atualização vai substituir todas as mudanças simultâneas.
deploymentCount

integer

Apenas saída. Número de implantações no app.
clientCertificateSettings

object (ClientCertificateSettings)

Opcional. As configurações padrão do certificado do cliente para o app.
vpcScSettings

object (VpcScSettings)

Opcional. Configurações do VPC-SC para o app.
locked

boolean

Opcional. Indica se o app está bloqueado para mudanças. Se o app estiver bloqueado, as modificações nos recursos dele serão rejeitadas.
validationErrors[]

string

Apenas saída. Configurações incorretas ou avisos no app.
dashboardSettings

object (DashboardSettings)

Opcional. Configurações de painel específicas do app para vincular e configurar painéis do Contact Center Insights.

LanguageSettings

Representação JSON 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
Campos
defaultLanguageCode

string

Opcional. O código de idioma padrão do app.
supportedLanguageCodes[]

string

Opcional. Lista de códigos de idiomas compatíveis com o app, além do default_language_code.
enableMultilingualSupport

boolean

Opcional. Ativa o suporte multilíngue. Se for true, os agentes no app vão usar instruções predefinidas para melhorar o processamento de entradas multilíngues.
fallbackAction
(deprecated)

string

Opcional. Descontinuado: este recurso não é mais compatível. Use enable_multilingual_support para melhorar o processamento de entradas multilíngues. A ação a ser realizada quando um agente recebe uma entrada em um idioma sem suporte.

Pode ser uma ação predefinida ou uma chamada de ferramenta personalizada. Os valores válidos são: - O nome completo do recurso de uma ferramenta, que aciona uma execução específica. - Uma ação predefinida do sistema, como "escalar" ou "sair", que aciona um sinal EndSession com o metadata correspondente para encerrar a conversa.

TimeZoneSettings

Representação JSON 
{
  "timeZone": string
}
Campos
timeZone

string

Opcional. O fuso horário do app do banco de dados de fuso horário, por exemplo, America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

Representação JSON 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
Campos
synthesizeSpeechConfigs

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

Opcional. Configuração de como a resposta do agente deve ser sintetizada, mapeando o código de idioma para SynthesizeSpeechConfig.

Se a configuração do código de idioma especificado não for encontrada, a configuração do código de idioma raiz será usada. Por exemplo, se o mapa tiver "en-us" e "en", e o código de idioma especificado for "en-gb", a configuração "en" será usada.

Observação: o código do idioma não diferencia maiúsculas de minúsculas.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Opcional. Configura o comportamento do agente para as atividades de interrupção do usuário.
inactivityTimeout

string (Duration format)

Opcional. A duração da inatividade do usuário (sem fala ou interação) antes que o agente peça para ele se engajar novamente. Se não for definido, o agente não vai pedir ao usuário para se reengajar.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
ambientSoundConfig

object (AmbientSoundConfig)

Opcional. Configuração do som ambiente a ser reproduzido com a resposta sintetizada do agente para melhorar a naturalidade da conversa.
customVoiceSamples[]

object (CustomVoiceSample)

Opcional. Configura amostras de voz personalizadas para clonagem de voz.

SynthesizeSpeechConfigsEntry

Representação JSON 
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
Campos
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Representação JSON 
{
  "voice": string,
  "speakingRate": number,
  "model": string,
  "instruction": string
}
Campos
voice

string

Opcional. Nome da voz. Se não for definida, o serviço vai escolher uma voz com base nos outros parâmetros, como language_code.

Para ver a lista de vozes disponíveis, consulte Vozes e idiomas compatíveis da Cloud Text-to-Speech.
speakingRate

number

Opcional. A taxa/velocidade de fala no intervalo [0,25, 2,0]. 1,0 é a velocidade nativa normal compatível com a voz específica. 2,0 é duas vezes mais rápido e 0,5 é metade da velocidade nativa. Valores fora do intervalo [0,25, 2,0] vão retornar um erro.
model

string

Opcional. O modelo usado para sintetizar áudio. Valores compatíveis no momento: - "gemini-3.1-flash-tts-preview". Se estiver vazio, o Chirp3-HD será usado.
instruction

string

Opcional. A instrução usada para sintetizar a fala ao usar um modelo generativo.

BargeInConfig

Representação JSON 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Campos
disableBargeIn
(deprecated)

boolean

Opcional. Descontinuado: o uso de disable_barge_in foi suspenso em favor de disable_barge_in_control em ChannelProfile.

Desativa a interrupção do usuário enquanto o agente está falando. Se for verdadeiro, a entrada do usuário durante a reprodução da resposta do agente será ignorada.
bargeInAwareness

boolean

Opcional. Se ativada, o agente vai adaptar a próxima resposta com base na suposição de que o usuário não ouviu a mensagem anterior completa. Isso não deve ser usado em cenários em que as respostas do agente são exibidas visualmente.

Duração

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Segundos assinados do período. Precisa ser de -315.576.000.000 a +315.576.000.000, inclusive. Observação: esses limites são calculados da seguinte forma: 60 s/min * 60 min/h * 24 h/dia * 365,25 dias/ano * 10.000 anos
nanos

integer

Frações assinadas de um segundo com resolução de nanossegundos do período. As durações menores que um segundo são representadas com um campo seconds de 0 e um campo nanos positivo ou negativo. Para durações de um segundo ou mais, um valor diferente de zero para o campo nanos precisa ter o mesmo sinal que o campo seconds. O valor precisa ser de -999.999.999 a +999.999.999.

AmbientSoundConfig

Representação JSON 
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of list of possible types for union field source.
}
Campos
volumeGainDb

number

Opcional. Ganho de volume (em dB) do volume nativo normal compatível com o ruído ambiente, no intervalo [-96,0, 16,0]. Se não for definido, ou ajustado para um valor de 0,0 (dB), será reproduzido na amplitude de sinal nativo normal. Um valor de -6,0 (dB) será reproduzido em aproximadamente metade da amplitude do sinal nativo normal. Um valor de +6,0 (dB) será reproduzido em aproximadamente o dobro da amplitude do sinal nativo normal. É altamente recomendável não exceder +10 (dB). Geralmente, não há aumento efetivo de volume para qualquer valor maior que isso.
Campo de união source. Ruído ambiente a ser reproduzido com a resposta sintetizada do agente para melhorar a naturalidade da conversa. source pode ser apenas de um dos tipos a seguir:
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

Opcional. Descontinuado: o uso de prebuilt_ambient_noise foi descontinuado e substituído por prebuilt_ambient_sound.
gcsUri

string

Opcional. Ruído ambiente como um arquivo WAV de 16 kHz de canal único armazenado no Cloud Storage.

Observação: verifique se o agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com tem a permissão storage.objects.get para o objeto do Cloud Storage.
prebuiltAmbientSound

string

Opcional. Nome do som ambiente predefinido. Os valores válidos são: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

CustomVoiceSample

Representação JSON 
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (Warning)
    }
  ],
  "voiceInstructionMode": enum (VoiceInstructionMode)
}
Campos
name

string

Opcional. O nome definido pelo usuário para a amostra de voz personalizada.
voiceSampleGcsUri

string

Opcional. O URI do Cloud Storage para a amostra de áudio para clonagem de voz. A amostra de áudio precisa ser um arquivo WAV de canal único de 24 kHz.
consentAudioGcsUri

string

Opcional. Áudio de consentimento para clonagem de voz.
voiceInstruction

string

Opcional. Instruções em linguagem natural para estilo, tom, ritmo ou pronúncia da voz.
previewAudioContent

string (bytes format)

Apenas saída. Áudio de prévia sintetizado para voz personalizada, formatado como WAV canônico (LINEAR16, 24 kHz, 16 bits, mono).

Uma string codificada em base64.
previewText

string

Opcional. Texto para sintetizar o áudio de prévia da voz personalizada.
warnings[]

object (Warning)

Apenas saída. Mensagens de aviso encontradas durante o processamento da clonagem de voz (por exemplo, nível de áudio baixo).
voiceInstructionMode

enum (VoiceInstructionMode)

Opcional. Modo de instrução para a amostra de voz. Se não for especificado, o padrão será NO_INSTRUCTION.

Aviso

Representação JSON 
{
  "message": string,
  "type": enum (WarningType)
}
Campos
message

string

Apenas saída. Uma descrição legível por humanos do aviso.
type

enum (WarningType)

Apenas saída. O tipo do aviso.

LoggingSettings

Representação 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)

Opcional. Configuração de como os dados sensíveis devem ser encobertos.
audioRecordingConfig

object (AudioRecordingConfig)

Opcional. Configuração de como as interações de áudio devem ser gravadas. O áudio está sujeito à edição conforme configurado em RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Opcional. Configura uma gravação extra de áudio sem edição. Isso pode ser usado para manter uma cópia de áudio bruta quando a edição de áudio é enabled, normalmente para fins de auditoria ou monitoramento.
bigqueryExportSettings

object (BigQueryExportSettings)

Opcional. Configura os comportamentos de exportação do BigQuery para o app. Os dados da conversa estão sujeitos a encobrimento, conforme configurado em RedactionConfig.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Opcional. Configura os comportamentos de exportação do BigQuery para o app. Os dados de conversa não editados serão exportados para tabelas do BigQuery se estiverem ativados.
cloudLoggingSettings

object (CloudLoggingSettings)

Opcional. Configurações para descrever os comportamentos do Cloud Logging para o app.
conversationLoggingSettings

object (ConversationLoggingSettings)

Opcional. Configurações para descrever os comportamentos de registro de conversas do app.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Opcional. Configuração de como as interações de áudio devem ser gravadas para a avaliação. Por padrão, a gravação de áudio não está ativada para sessões de avaliação.
metricAnalysisSettings

object (MetricAnalysisSettings)

Opcional. Configurações para descrever os comportamentos de coleta de dados de conversas para o pipeline de análise de LLM do app.
requiredRecordingConsent

boolean

Opcional. Se o app precisa informar o que pode ser gravado antes de manter qualquer registro.

Quando verdadeiro, uma sessão começa com a gravação desativada e permanece assim até que o cliente envie SessionInput.recording_control, que decide cada turno a partir desse momento. Isso inclui a gravação de áudio, o histórico de conversas, o BigQuery Export e o Cloud Logging.

Quando false, o padrão, as configurações acima decidem por conta própria, e o cliente não precisa enviar nada.

RedactionConfig

Representação JSON 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Campos
enableRedaction

boolean

Opcional. Se for true, a encobrimento será aplicada em vários cenários de geração de registros, incluindo histórico de conversas, Cloud Logging e gravação de áudio.
inspectTemplate

string

Opcional. Nome do modelo de inspeção da DLP para configurar a detecção de tipos de dados sensíveis.

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

string

Opcional. Nome do modelo de desidentificação da DLP para instruir sobre como desidentificar o conteúdo.

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

AudioRecordingConfig

Representação JSON 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
Campos
gcsBucket

string

Opcional. O bucket do Cloud Storage para armazenar as gravações de áudio da sessão. O URI precisa começar com "gs://".

Escolha um local de bucket que atenda aos seus requisitos de residência de dados.

Observação: se o bucket do Cloud Storage estiver em um projeto diferente do app, conceda a permissão storage.objects.create ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Opcional. O prefixo do caminho do Cloud Storage para gravações de áudio.

Esse prefixo pode incluir os seguintes marcadores de posição, que serão substituídos dinamicamente no momento da veiculação: - $project: ID do projeto - $location: local do app - $app: ID do app - $date: data da sessão no formato AAAA-MM-DD - $session: ID da sessão

Se o prefixo do caminho não for especificado, o prefixo padrão $project/$location/$app/$date/$session/ será usado.

BigQueryExportSettings

Representação JSON 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
Campos
enabled

boolean

Opcional. Indica se o BigQuery Export está ativado.
project

string

Opcional. O ID do projeto do conjunto de dados do BigQuery para onde os dados serão exportados.

Observação: se o conjunto de dados do BigQuery estiver em um projeto diferente do app, conceda o papel roles/bigquery.admin ao agente de serviço do CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Opcional. O ID do conjunto de dados do BigQuery para exportar os dados.

CloudLoggingSettings

Representação JSON 
{
  "enableCloudLogging": boolean
}
Campos
enableCloudLogging

boolean

Opcional. Se o Cloud Logging deve ser ativado para as sessões.

ConversationLoggingSettings

Representação JSON 
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
Campos
disableConversationLogging

boolean

Opcional. Se o registro de conversas deve ser desativado para as sessões.
retentionWindow

string (Duration format)

Opcional. Controla a janela de retenção da conversa. Se não for definido, a conversa será retida por 365 dias.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

MetricAnalysisSettings

Representação JSON 
{
  "llmMetricsOptedOut": boolean
}
Campos
llmMetricsOptedOut

boolean

Opcional. Se os dados de conversa devem ser coletados para métricas de análise de LLM. Se for verdadeiro, os dados da conversa não serão coletados para as métricas de análise do LLM. Caso contrário, os dados da conversa serão coletados.

ErrorHandlingSettings

Representação JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (EndSessionConfig)
  }
}
Campos
errorHandlingStrategy

enum (ErrorHandlingStrategy)

Opcional. A estratégia a ser usada para o tratamento de erros.
fallbackResponseConfig

object (FallbackResponseConfig)

Opcional. Configuração para processar respostas de fallback.
endSessionConfig

object (EndSessionConfig)

Opcional. Configuração para encerrar a sessão em caso de erros do sistema (por exemplo, erros de LLM).

FallbackResponseConfig

Representação JSON 
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
Campos
customFallbackMessages

map (key: string, value: string)

Opcional. As mensagens de fallback em caso de erros do sistema (por exemplo, erros de LLM), mapeadas pelo código de idioma compatível.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts

integer

Opcional. O número máximo de tentativas de substituição antes que o agente emita o sinal EndSession.

CustomFallbackMessagesEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

EndSessionConfig

Representação JSON 
{

  // Union field _escalate_session can be only one of the following:
  "escalateSession": boolean
  // End of list of possible types for union field _escalate_session.
}
Campos

Campo de união _escalate_session.

_escalate_session pode ser apenas de um dos tipos a seguir:
escalateSession

boolean

Opcional. Se a sessão deve ser encaminhada em EndSession. Se a sessão for encaminhada, metadata in EndSession vai conter session_escalated = true. Consulte https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent para mais detalhes.

ModelSettings

Representação JSON 
{
  "model": string,
  "thinkingLevel": enum (ThinkingLevel),

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

string

Opcional. O modelo de LLM que o agente deve usar. Se não for definido, o agente vai herdar o modelo do agente pai.
thinkingLevel

enum (ThinkingLevel)

Opcional. O nível de raciocínio do modelo.

Campo de união _temperature.

_temperature pode ser apenas de um dos tipos a seguir:
temperature

number

Opcional. Se definida, essa temperatura será usada para o modelo de LLM. A temperatura controla a aleatoriedade das respostas do modelo. Temperaturas mais baixas produzem respostas mais previsíveis. Temperaturas mais altas produzem respostas mais criativas.

EvaluationMetricsThresholds

Representação JSON 
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
Campos
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

Opcional. Os limites das métricas de avaliação de ouro.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Opcional. Descontinuado: use golden_hallucination_metric_behavior. O comportamento da métrica de alucinação é usado atualmente para avaliações de ouro.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opcional. O comportamento da métrica de alucinação para avaliações de referência.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opcional. O comportamento da métrica de alucinação para avaliações de cenário.

GoldenEvaluationMetricsThresholds

Representação JSON 
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
Campos
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

Opcional. Os limites das métricas no nível da rodada.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Opcional. Os limites de métricas do nível de expectativa.
toolMatchingSettings

object (ToolMatchingSettings)

Opcional. As configurações de correspondência da ferramenta. Uma chamada de ferramenta extra é uma chamada de ferramenta que está presente na execução, mas não corresponde a nenhuma chamada de ferramenta na expectativa de ouro.

TurnLevelMetricsThresholds

Representação JSON 
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
Campos
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Opcional. O canal de semelhança semântica a ser usado para avaliação.

Campo de união _semantic_similarity_success_threshold.

_semantic_similarity_success_threshold pode ser apenas de um dos tipos a seguir:
semanticSimilaritySuccessThreshold

integer

Opcional. O limite de sucesso para similaridade semântica. O valor precisa ser um número inteiro entre 0 e 4. O padrão é >= 3.

Campo de união _overall_tool_invocation_correctness_threshold.

_overall_tool_invocation_correctness_threshold pode ser apenas de um dos tipos a seguir:
overallToolInvocationCorrectnessThreshold

number

Opcional. O limite de sucesso para a precisão geral da invocação de ferramentas. Precisa ser um número de ponto flutuante entre 0 e 1. O padrão é 1.0.

ExpectationLevelMetricsThresholds

Representação JSON 
{

  // Union field _tool_invocation_parameter_correctness_threshold can be only one
  // of the following:
  "toolInvocationParameterCorrectnessThreshold": number
  // End of list of possible types for union field
  // _tool_invocation_parameter_correctness_threshold.
}
Campos

Campo de união _tool_invocation_parameter_correctness_threshold.

_tool_invocation_parameter_correctness_threshold pode ser apenas de um dos tipos a seguir:
toolInvocationParameterCorrectnessThreshold

number

Opcional. O limite de sucesso para a correção do parâmetro de invocação de ferramenta individual. Precisa ser um número de ponto flutuante entre 0 e 1. O padrão é 1.0.

ToolMatchingSettings

Representação JSON 
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
Campos
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Opcional. Comportamento para chamadas de ferramentas extras. O padrão é FAIL.

VariableDeclaration

Representação JSON 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
Campos
name

string

Obrigatório. O nome da variável. O nome precisa começar com uma letra ou um sublinhado e conter apenas letras, números ou sublinhados.
description

string

Obrigatório. A descrição da variável.
schema

object (Schema)

Obrigatório. O esquema da variável.

Esquema

Representação JSON 
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
Campos
type

enum (Type)

Obrigatório. O tipo dos dados.
properties

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

Opcional. Propriedades de Type.OBJECT.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]

string

Opcional. Propriedades obrigatórias de Type.OBJECT.
description

string

Opcional. A descrição dos dados.
items

object (Schema)

Opcional. Esquema dos elementos de Type.ARRAY.
nullable

boolean

Opcional. Indica se o valor pode ser nulo.
uniqueItems

boolean

Opcional. Indica que os itens na matriz precisam ser exclusivos. Aplica-se apenas a TYPE.ARRAY.
prefixItems[]

object (Schema)

Opcional. Esquemas de elementos iniciais de Type.ARRAY.
additionalProperties

object (Schema)

Opcional. Pode ser um booleano ou um objeto, controla a presença de outras propriedades.
anyOf[]

object (Schema)

Opcional. O valor precisa ser validado em relação a qualquer um (ou mais) dos subesquemas na lista.
enum[]

string

Opcional. Valores possíveis do elemento de tipo primitivo com formato de tipo enumerado. Exemplos: 1. Podemos definir a direção como : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Podemos definir o número do apartamento como : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

Opcional. Valor padrão dos dados.
ref

string

Opcional. Permite referências indiretas entre nós de esquema. O valor precisa ser uma referência válida a um filho da raiz defs.

Por exemplo, o esquema a seguir define uma referência a um nó de esquema chamado "Pet":

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

O valor da propriedade "pet" é uma referência ao nó do esquema chamado "Pet". Veja mais detalhes em https://json-schema.org/understanding-json-schema/structuring.
defs

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

Opcional. Um mapa de definições para uso por ref. Permitido apenas na raiz do esquema.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title

string

Opcional. O título do esquema.
minItems

string (int64 format)

Opcional. Número mínimo de elementos para Type.ARRAY.
maxItems

string (int64 format)

Opcional. Número máximo de elementos para Type.ARRAY.

Campo de união _minimum.

_minimum pode ser apenas de um dos tipos a seguir:
minimum

number

Opcional. Valor mínimo para Type.INTEGER e Type.NUMBER.

Campo de união _maximum.

_maximum pode ser apenas de um dos tipos a seguir:
maximum

number

Opcional. Valor máximo para Type.INTEGER e Type.NUMBER.

PropertiesEntry

Representação JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campos
key

string
value

object (Schema)

Valor

Representação JSON 
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. O tipo de valor. kind pode ser apenas de um dos tipos a seguir:
nullValue

null

Representa um null JSON.
numberValue

number

Representa um número JSON. Não pode ser NaN, Infinity ou -Infinity, porque eles não são compatíveis com JSON. Isso também não pode representar valores Int64 grandes, já que o formato JSON geralmente não os aceita no tipo de número.
stringValue

string

Representa uma string JSON.
boolValue

boolean

Representa um booleano JSON (literal true ou false em JSON).
structValue

object (Struct format)

Representa um objeto JSON.
listValue

array (ListValue format)

Representa uma matriz JSON.

Struct

Representação JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Campos
fields

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

Mapa não ordenado de valores digitados dinamicamente.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Representação JSON 
{
  "key": string,
  "value": value
}
Campos
key

string
value

value (Value format)

ListValue

Representação JSON 
{
  "values": [
    value
  ]
}
Campos
values[]

value (Value format)

Campo repetido de valores digitados dinamicamente.

DefsEntry

Representação JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Campos
key

string
value

object (Schema)

DataStoreSettings

Representação JSON 
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
Campos
engines[]

object (Engine)

Apenas saída. Os mecanismos do app.

Mecanismo

Representação JSON 
{
  "name": string,
  "type": enum (Type)
}
Campos
name

string

Apenas saída. O nome do recurso do mecanismo. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (Type)

Apenas saída. O tipo de mecanismo.

ChannelProfile

Representação JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
Campos
profileId

string

Opcional. O identificador exclusivo do perfil do canal.
channelType

enum (ChannelType)

Opcional. O tipo do perfil do canal.
personaProperty

object (PersonaProperty)

Opcional. A propriedade de persona do perfil do canal.
webWidgetConfig

object (WebWidgetConfig)

Opcional. A configuração do widget da Web.
whatsappConfig

object (WhatsAppConfig)

Opcional. Configuração específica para implantações do WhatsApp.
instagramConfig

object (InstagramConfig)

Opcional. Configuração específica para implantações do Instagram.

Campo de união _disable_dtmf.

_disable_dtmf pode ser apenas de um dos tipos a seguir:
disableDtmf

boolean

Opcional. Se a DTMF (frequência múltipla de dois tons) deve ser desativada.

Campo de união _disable_barge_in_control.

_disable_barge_in_control pode ser apenas de um dos tipos a seguir:
disableBargeInControl

boolean

Opcional. Se o controle de interrupção do usuário na conversa deve ser desativado. - true: as interrupções do usuário são desativadas enquanto o agente está falando. - false: o agente mantém o controle automático sobre quando o usuário pode interromper.

Campo de união _noise_suppression_level.

_noise_suppression_level pode ser apenas de um dos tipos a seguir:
noiseSuppressionLevel

string

Opcional. O nível de supressão de ruído do perfil do canal. Os valores disponíveis são "low", "moderate", "high", "very_high".

PersonaProperty

Representação JSON 
{
  "persona": enum (Persona)
}
Campos
persona

enum (Persona)

Opcional. A persona do canal.

WebWidgetConfig

Representação JSON 
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
Campos
modality

enum (Modality)

Opcional. A modalidade do widget da Web.
theme

enum (Theme)

Opcional. O tema do widget da Web.
webWidgetTitle

string

Opcional. O título do widget da Web.
securitySettings

object (SecuritySettings)

Opcional. As configurações de segurança do widget da Web.

SecuritySettings

Representação JSON 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Campos
enablePublicAccess

boolean

Opcional. Indica se o acesso público ao widget da Web está ativado. Se for true, o widget da Web será acessível publicamente. Se for false, o widget da Web precisará ser integrado ao seu próprio sistema de autenticação e autorização para retornar credenciais válidas para acessar o agente do CES.
enableOriginCheck

boolean

Opcional. Indica se a verificação de origem do widget da Web está ativada. Se for true, o widget da Web vai verificar a origem do site que o carrega e só vai permitir que ele seja carregado na mesma origem ou em qualquer uma das origens permitidas.
allowedOrigins[]

string

Opcional. As origens que podem hospedar o widget da Web. Uma origem é definida pela RFC 6454. Se estiver vazio, todas as origens serão permitidas. É permitido um máximo de 100 origens. Exemplo: "https://example.com"
enableRecaptcha

boolean

Opcional. Indica se a verificação reCAPTCHA para o widget da Web está ativada.

WhatsAppConfig

Representação JSON 
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campos
wabaId

string

Obrigatório. O ID da conta do WhatsApp Business.
phoneNumberId

string

Obrigatório. O ID do número de telefone da Meta.
phoneNumber

string

Opcional. O número de telefone no formato E.164.
displayName

string

Apenas saída. O nome da página comercial da Meta que foi buscado.
thumbnailUrl

string

Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado.
description

string

Apenas saída. A descrição da página ou do perfil comercial da Meta.

InstagramConfig

Representação JSON 
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Campos
instagramAccountId

string

Obrigatório. O ID da conta do Instagram.
displayName

string

Apenas saída. O nome da página comercial da Meta que foi buscado.
thumbnailUrl

string

Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado.
description

string

Apenas saída. A descrição da página ou do perfil comercial da Meta.

MetadataEntry

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string
value

string

Carimbo de data/hora

Representação JSON 
{
  "seconds": string,
  "nanos": integer
}
Campos
seconds

string (int64 format)

Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799, inclusive (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos

integer

Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa ser de 0 a 999.999.999.

ClientCertificateSettings

Representação JSON 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Campos
tlsCertificate

string

Obrigatório. O certificado TLS codificado no formato PEM. Essa string precisa incluir as linhas de cabeçalho de início e rodapé de fim.
privateKey

string

Obrigatório. O nome do recurso da versão do secret do SecretManager que armazena a chave privada codificada no formato PEM. Formato: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Opcional. O nome do recurso da versão do secret do SecretManager que armazena a senha longa para descriptografar a chave privada. Não deve ser definida se a chave privada não estiver criptografada. Formato: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Representação JSON 
{
  "allowedOrigins": [
    string
  ]
}
Campos
allowedOrigins[]

string

Opcional. As origens HTTP(S) permitidas que as ferramentas da OpenAPI no app podem chamar diretamente quando o VPC Service Controls está ativado. Essas strings precisam corresponder exatamente à origem, incluindo a porta, se especificada. Por exemplo, "https://example.com" ou "https://example.com:443". Essa lista ainda não se aplica a ferramentas do Python que podem fazer chamadas HTTP diretas.

DashboardSettings

Representação JSON 
{
  "defaultDashboard": string
}
Campos
defaultDashboard

string

Opcional. O nome do recurso do painel padrão do Contact Center Insights associado ao app. Esse é o painel que será exibido quando os usuários acessarem a visualização de monitoramento do app.

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

PrebuiltAmbientNoise

Ruído ambiente predefinido.

Tipos enumerados
PREBUILT_AMBIENT_NOISE_UNSPECIFIED Não especificado.
RETAIL_STORE Ruído ambiente de uma loja de varejo.
CONVENTION_HALL Ruído ambiente de um centro de convenções.
OUTDOOR Ruído ambiente de uma rua.

WarningType

Tipo de aviso encontrado durante o processamento da amostra de voz.

Tipos enumerados
WARNING_TYPE_UNSPECIFIED Tipo de aviso não especificado.
LOW_AUDIO_LEVEL O nível de áudio da amostra de voz está muito baixo (por exemplo, baixa amplitude RMS).

VoiceInstructionMode

Modo de instrução para a amostra de voz.

Tipos enumerados
VOICE_INSTRUCTION_MODE_UNSPECIFIED Modo de instrução não especificado. O padrão é NO_INSTRUCTION.
NO_INSTRUCTION Nenhuma instrução de voz será usada.
GENERATE_INSTRUCTION A instrução de voz será gerada automaticamente pela IA com base na amostra de áudio.
CUSTOM_INSTRUCTION Instrução de voz personalizada fornecida pelo usuário.

ErrorHandlingStrategy

Define a estratégia para lidar com erros.

Tipos enumerados
ERROR_HANDLING_STRATEGY_UNSPECIFIED Estratégia de tratamento de erros não especificada.
NONE Nenhum tratamento específico está ativado.
FALLBACK_RESPONSE Uma mensagem de fallback será retornada ao usuário em caso de erros do sistema (por exemplo, erros de LLM).
END_SESSION Um sinal EndSession será emitido em caso de erros do sistema (por exemplo, erros de LLM).

ThinkingLevel

Configuração do nível de raciocínio do modelo.

Tipos enumerados
THINKING_LEVEL_UNSPECIFIED O nível de pensamento não foi especificado.
DEFAULT Nível de raciocínio padrão.
LOW Nível de raciocínio baixo.
MEDIUM Nível de raciocínio médio.
HIGH Nível de raciocínio alto.

ToolExecutionMode

Define o comportamento de execução da ferramenta se várias ferramentas forem selecionadas pelo agente ao mesmo tempo.

Tipos enumerados
TOOL_EXECUTION_MODE_UNSPECIFIED Modo de execução de ferramenta não especificado. O padrão é PARALLEL.
PARALLEL Se várias ferramentas forem selecionadas, elas serão executadas em paralelo, com o mesmo ToolContext.
SEQUENTIAL Se várias ferramentas forem selecionadas, elas serão executadas em sequência. A próxima ferramenta só será executada depois que a anterior for concluída e puder ver o ToolContext atualizado da ferramenta anterior.

SemanticSimilarityChannel

Canal de similaridade semântica a ser usado.

Tipos enumerados
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED Métrica não especificada. O padrão é TEXT.
TEXT Use a semelhança semântica de texto.
AUDIO Use a semelhança semântica de áudio.

ExtraToolCallBehavior

Define o comportamento quando uma chamada de ferramenta extra é encontrada. Uma chamada de ferramenta extra é uma chamada de ferramenta que está presente na execução, mas não corresponde a nenhuma chamada de ferramenta na expectativa de ouro.

Tipos enumerados
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Comportamento não especificado. O padrão é FAIL.
FAIL Falha na avaliação se uma chamada de ferramenta extra for encontrada.
ALLOW Permita a chamada de ferramenta extra.

HallucinationMetricBehavior

O comportamento da métrica de alucinação. Independentemente do comportamento, a métrica sempre será calculada. A diferença é que, quando desativada, a métrica não é usada para calcular a pontuação geral da avaliação.

Tipos enumerados
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Comportamento não especificado da métrica de alucinação.
DISABLED Desativar a métrica de alucinação.
ENABLED Ativar a métrica de alucinação.

Tipo

Tipos de dados da OpenAPI.

Tipos enumerados
TYPE_UNSPECIFIED Tipo não especificado.
STRING Tipo string.
INTEGER Tipo inteiro.
NUMBER Tipo de número.
BOOLEAN Tipo booleano.
OBJECT Tipo de objeto.
ARRAY Tipo de matriz.

NullValue

Representa um null JSON.

NullValue é um sentinela, que usa um tipo enumerado com apenas um valor para representar o valor nulo da união de tipos Value.

Um campo do tipo NullValue com qualquer valor diferente de 0 é considerado inválido. A maioria dos serializadores ProtoJSON emite um Value com um null_value definido como um null JSON, independentemente do valor inteiro, e, portanto, faz uma ida e volta para um valor 0.

Tipos enumerados
NULL_VALUE Valor nulo.

Tipo

O tipo de mecanismo. Consulte a documentação disponível em 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.

Tipos enumerados
TYPE_UNSPECIFIED Tipo de mecanismo não especificado.
ENGINE_TYPE_CHAT Tipo de mecanismo de chat. O mecanismo SOLUTION_TYPE_CHAT do app. Todos os repositórios de dados do conector adicionados ao app serão adicionados a esse mecanismo.

ChannelType

O tipo do perfil do canal.

Tipos enumerados
UNKNOWN Tipo de canal desconhecido.
WEB_UI Canal da interface da Web.
API Canal da API.
TWILIO Canal da Twilio.
GOOGLE_TELEPHONY_PLATFORM Canal da plataforma de telefonia do Google.
CONTACT_CENTER_AS_A_SERVICE Canal de central de atendimento como serviço (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT Canal de central de atendimento como serviço (chat de CCaaS).
FIVE9 Canal da Five9.
CONTACT_CENTER_INTEGRATION Canal de integração de central de atendimento de terceiros.
WHATSAPP Canal do WhatsApp.
INSTAGRAM canal do Instagram.

Persona

A persona do canal.

Tipos enumerados
UNKNOWN Persona UNKNOWN.
CONCISE O agente mantém as respostas concisas e diretas.
CHATTY O agente fornece mais contexto, explicações e detalhes

Modalidade

Modalidade do widget da Web.

Tipos enumerados
MODALITY_UNSPECIFIED Modalidade desconhecida.
CHAT_AND_VOICE O widget aceita entrada de texto e voz.
VOICE_ONLY O widget só aceita entrada de voz.
CHAT_ONLY O widget só aceita entrada de chat.
CHAT_VOICE_AND_VIDEO O widget aceita entradas de chat, voz e vídeo.

Tema

Tema do widget da Web.

Tipos enumerados
THEME_UNSPECIFIED Tema desconhecido.
LIGHT Tema claro.
DARK Tema escuro.

Anotações de ferramentas

As anotações de ferramentas são enviadas aos clientes do MCP para descrever o risco básico de uma determinada ferramenta. A maioria dos clientes trata essas dicas como não confiáveis, mas elas podem ser usadas para decidir quando uma solicitação de confirmação pode ser enviada a um usuário.

Além da string de título, as seguintes dicas booleanas são definidas:

  • readOnlyHint: se for verdadeiro, a ferramenta não vai modificar o ambiente. Padrão: false.
  • destructiveHint: se for verdadeiro, a ferramenta poderá realizar ações destrutivas. Se for falso, a ferramenta só poderá realizar ações aditivas. Padrão: verdadeiro.
  • idempotentHint: se for verdadeiro, chamar a ferramenta repetidamente com os mesmos argumentos não terá efeito adicional no ambiente. Padrão: false.
  • openWorldHint: se for verdadeiro, a ferramenta poderá interagir com um "mundo aberto" de entidades externas. Se for falso, a ferramenta só poderá interagir com entidades internas. Por exemplo, uma ferramenta de pesquisa na Web seria de mundo aberto, enquanto uma ferramenta de memória não seria.

Dica destrutiva: ✅ | Dica idempotente: ❌ | Dica somente leitura: ❌ | Dica de mundo aberto: ❌