Ferramenta: create_app_version
Cria uma nova versão do app especificado.
O exemplo de código abaixo mostra como usar curl para chamar a ferramenta MCP create_app_version.
| 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": "create_app_version", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
Esquema de entrada
Mensagem de solicitação para AgentService.CreateAppVersion.
CreateAppVersionRequest
| Representação JSON |
|---|
{
"parent": string,
"appVersionId": string,
"appVersion": {
object ( |
| Campos | |
|---|---|
parent |
Obrigatório. O nome do recurso do app em que uma versão será criada. |
appVersionId |
Opcional. O ID a ser usado na versão do app, que se tornará o componente final do nome do recurso da versão do app. Se não for fornecido, um ID exclusivo será atribuído automaticamente à versão do app. |
appVersion |
Obrigatório. A versão do app a ser criada. |
AppVersion
| Representação JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"creator": string,
"createTime": string,
"updateTime": string,
"snapshot": {
object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo da versão do app. Formato: |
displayName |
Opcional. O nome de exibição da versão do app. |
description |
Opcional. A descrição da versão do app. |
creator |
Apenas saída. E-mail do usuário que criou a versão do app. |
createTime |
Apenas saída. Carimbo de data/hora de quando a versão do app foi criada. 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: |
updateTime |
Apenas saída. Carimbo de data/hora da última atualização da versão do app. 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: |
snapshot |
Apenas saída. O snapshot do app quando a versão é criada. |
etag |
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. |
Carimbo de data/hora
| Representação JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campos | |
|---|---|
seconds |
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 |
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. |
AppSnapshot
| Representação JSON |
|---|
{ "app": { object ( |
| Campos | |
|---|---|
app |
Opcional. As configurações básicas do app. |
agents[] |
Opcional. Lista de agentes no app. |
tools[] |
Opcional. Lista de ferramentas no app. |
examples[] |
Opcional. Lista de exemplos no app. |
guardrails[] |
Opcional. Lista de proteções no app. |
toolsets[] |
Opcional. Lista de conjuntos de ferramentas no app. |
App
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo do app. Formato: |
displayName |
Obrigatório. Nome de exibição do app. |
description |
Opcional. Descrição legível do app. |
pinned |
Opcional. Se o app está fixado na lista de apps. |
rootAgent |
Opcional. O agente raiz é o ponto de entrada do app. Formato: |
languageSettings |
Opcional. Configurações de idioma do app. |
timeZoneSettings |
Opcional. Configurações de fuso horário do app. |
audioProcessingConfig |
Opcional. Configuração de processamento de áudio do app. |
loggingSettings |
Opcional. Configurações de registro do app. |
errorHandlingSettings |
Opcional. Configurações de tratamento de erros do app. |
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 |
Opcional. O modo de execução da ferramenta para o app. Se não for fornecido, o padrão será PARALLEL. |
evaluationMetricsThresholds |
Opcional. Os limites de avaliação do app. |
variableDeclarations[] |
Opcional. As declarações das variáveis. |
predefinedVariableDeclarations[] |
Apenas saída. As declarações de variáveis predefinidas para o app. |
globalInstruction |
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[] |
Opcional. Lista de proteções para o app. Formato: |
dataStoreSettings |
Opcional. As configurações do repositório de dados do app. |
defaultChannelProfile |
Opcional. O perfil de canal padrão usado pelo app. |
metadata |
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 |
createTime |
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: |
updateTime |
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: |
etag |
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 |
Apenas saída. Número de implantações no app. |
clientCertificateSettings |
Opcional. As configurações padrão do certificado do cliente para o app. |
vpcScSettings |
Opcional. Configurações do VPC-SC para o app. |
locked |
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[] |
Apenas saída. Configurações incorretas ou avisos no app. |
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 |
Opcional. O código de idioma padrão do app. |
supportedLanguageCodes[] |
Opcional. Lista de códigos de idiomas compatíveis com o app, além do |
enableMultilingualSupport |
Opcional. Ativa o suporte multilíngue. Se for |
fallbackAction |
Opcional. Descontinuado: este recurso não é mais compatível. Use 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 |
TimeZoneSettings
| Representação JSON |
|---|
{ "timeZone": string } |
| Campos | |
|---|---|
timeZone |
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 ( |
| Campos | |
|---|---|
synthesizeSpeechConfigs |
Opcional. Configuração de como a resposta do agente deve ser sintetizada, mapeando o código de idioma para 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 |
bargeInConfig |
Opcional. Configura o comportamento do agente para as atividades de interrupção do usuário. |
inactivityTimeout |
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 " |
ambientSoundConfig |
Opcional. Configuração do som ambiente a ser reproduzido com a resposta sintetizada do agente para melhorar a naturalidade da conversa. |
customVoiceSamples[] |
Opcional. Configura amostras de voz personalizadas para clonagem de voz. |
SynthesizeSpeechConfigsEntry
| Representação JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campos | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| Representação JSON |
|---|
{ "voice": string, "speakingRate": number, "model": string, "instruction": string } |
| Campos | |
|---|---|
voice |
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 |
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 |
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 |
Opcional. A instrução usada para sintetizar a fala ao usar um modelo generativo. |
BargeInConfig
| Representação JSON |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| Campos | |
|---|---|
disableBargeIn |
Opcional. Descontinuado: o uso de 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 |
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 |
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 |
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 |
AmbientSoundConfig
| Representação JSON |
|---|
{ "volumeGainDb": number, // Union field |
| Campos | |
|---|---|
volumeGainDb |
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 |
Opcional. Descontinuado: o uso de |
gcsUri |
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 |
prebuiltAmbientSound |
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 ( |
| Campos | |
|---|---|
name |
Opcional. O nome definido pelo usuário para a amostra de voz personalizada. |
voiceSampleGcsUri |
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 |
Opcional. Áudio de consentimento para clonagem de voz. |
voiceInstruction |
Opcional. Instruções em linguagem natural para estilo, tom, ritmo ou pronúncia da voz. |
previewAudioContent |
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 |
Opcional. Texto para sintetizar o áudio de prévia da voz personalizada. |
warnings[] |
Apenas saída. Mensagens de aviso encontradas durante o processamento da clonagem de voz (por exemplo, nível de áudio baixo). |
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 ( |
| Campos | |
|---|---|
message |
Apenas saída. Uma descrição legível por humanos do aviso. |
type |
Apenas saída. O tipo do aviso. |
LoggingSettings
| Representação JSON |
|---|
{ "redactionConfig": { object ( |
| Campos | |
|---|---|
redactionConfig |
Opcional. Configuração de como os dados sensíveis devem ser encobertos. |
audioRecordingConfig |
Opcional. Configuração de como as interações de áudio devem ser gravadas. O áudio está sujeito à edição conforme configurado em |
unredactedAudioRecordingConfig |
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 é |
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 |
unredactedBigqueryExportSettings |
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 |
Opcional. Configurações para descrever os comportamentos do Cloud Logging para o app. |
conversationLoggingSettings |
Opcional. Configurações para descrever os comportamentos de registro de conversas do app. |
evaluationAudioRecordingConfig |
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 |
Opcional. Configurações para descrever os comportamentos de coleta de dados de conversas para o pipeline de análise de LLM do app. |
requiredRecordingConsent |
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 Quando |
RedactionConfig
| Representação JSON |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| Campos | |
|---|---|
enableRedaction |
Opcional. Se for |
inspectTemplate |
Opcional. Nome do modelo de inspeção da DLP para configurar a detecção de tipos de dados sensíveis. Formato: |
deidentifyTemplate |
Opcional. Nome do modelo de desidentificação da DLP para instruir sobre como desidentificar o conteúdo. Formato: |
AudioRecordingConfig
| Representação JSON |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| Campos | |
|---|---|
gcsBucket |
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 |
gcsPathPrefix |
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 |
BigQueryExportSettings
| Representação JSON |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| Campos | |
|---|---|
enabled |
Opcional. Indica se o BigQuery Export está ativado. |
project |
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 |
dataset |
Opcional. O ID do conjunto de dados do BigQuery para exportar os dados. |
CloudLoggingSettings
| Representação JSON |
|---|
{ "enableCloudLogging": boolean } |
| Campos | |
|---|---|
enableCloudLogging |
Opcional. Se o Cloud Logging deve ser ativado para as sessões. |
ConversationLoggingSettings
| Representação JSON |
|---|
{ "disableConversationLogging": boolean, "retentionWindow": string } |
| Campos | |
|---|---|
disableConversationLogging |
Opcional. Se o registro de conversas deve ser desativado para as sessões. |
retentionWindow |
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 " |
MetricAnalysisSettings
| Representação JSON |
|---|
{ "llmMetricsOptedOut": boolean } |
| Campos | |
|---|---|
llmMetricsOptedOut |
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 ( |
| Campos | |
|---|---|
errorHandlingStrategy |
Opcional. A estratégia a ser usada para o tratamento de erros. |
fallbackResponseConfig |
Opcional. Configuração para processar respostas de fallback. |
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 |
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 |
maxFallbackAttempts |
Opcional. O número máximo de tentativas de substituição antes que o agente emita o sinal |
CustomFallbackMessagesEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
EndSessionConfig
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união
|
|
escalateSession |
Opcional. Se a sessão deve ser encaminhada em |
ModelSettings
| Representação JSON |
|---|
{ "model": string, "thinkingLevel": enum ( |
| Campos | |
|---|---|
model |
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 |
Opcional. O nível de raciocínio do modelo. |
Campo de união
|
|
temperature |
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 ( |
| Campos | |
|---|---|
goldenEvaluationMetricsThresholds |
Opcional. Os limites das métricas de avaliação de ouro. |
hallucinationMetricBehavior |
Opcional. Descontinuado: use |
goldenHallucinationMetricBehavior |
Opcional. O comportamento da métrica de alucinação para avaliações de referência. |
scenarioHallucinationMetricBehavior |
Opcional. O comportamento da métrica de alucinação para avaliações de cenário. |
GoldenEvaluationMetricsThresholds
| Representação JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| Campos | |
|---|---|
turnLevelMetricsThresholds |
Opcional. Os limites das métricas no nível da rodada. |
expectationLevelMetricsThresholds |
Opcional. Os limites de métricas do nível de expectativa. |
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 ( |
| Campos | |
|---|---|
semanticSimilarityChannel |
Opcional. O canal de semelhança semântica a ser usado para avaliação. |
Campo de união
|
|
semanticSimilaritySuccessThreshold |
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
|
|
overallToolInvocationCorrectnessThreshold |
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 |
| Campos | |
|---|---|
Campo de união
|
|
toolInvocationParameterCorrectnessThreshold |
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 ( |
| Campos | |
|---|---|
extraToolCallBehavior |
Opcional. Comportamento para chamadas de ferramentas extras. O padrão é FAIL. |
VariableDeclaration
| Representação JSON |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| Campos | |
|---|---|
name |
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 |
Obrigatório. A descrição da variável. |
schema |
Obrigatório. O esquema da variável. |
Esquema
| Representação JSON |
|---|
{ "type": enum ( |
| Campos | |
|---|---|
type |
Obrigatório. O tipo dos dados. |
properties |
Opcional. Propriedades de Type.OBJECT. Um objeto com uma lista de pares |
required[] |
Opcional. Propriedades obrigatórias de Type.OBJECT. |
description |
Opcional. A descrição dos dados. |
items |
Opcional. Esquema dos elementos de Type.ARRAY. |
nullable |
Opcional. Indica se o valor pode ser nulo. |
uniqueItems |
Opcional. Indica que os itens na matriz precisam ser exclusivos. Aplica-se apenas a TYPE.ARRAY. |
prefixItems[] |
Opcional. Esquemas de elementos iniciais de Type.ARRAY. |
additionalProperties |
Opcional. Pode ser um booleano ou um objeto, controla a presença de outras propriedades. |
anyOf[] |
Opcional. O valor precisa ser validado em relação a qualquer um (ou mais) dos subesquemas na lista. |
enum[] |
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 |
Opcional. Valor padrão dos dados. |
ref |
Opcional. Permite referências indiretas entre nós de esquema. O valor precisa ser uma referência válida a um filho da raiz Por exemplo, o esquema a seguir define uma referência a um nó de esquema chamado "Pet": 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 |
Opcional. Um mapa de definições para uso por Um objeto com uma lista de pares |
title |
Opcional. O título do esquema. |
minItems |
Opcional. Número mínimo de elementos para Type.ARRAY. |
maxItems |
Opcional. Número máximo de elementos para Type.ARRAY. |
Campo de união
|
|
minimum |
Opcional. Valor mínimo para Type.INTEGER e Type.NUMBER. |
Campo de união
|
|
maximum |
Opcional. Valor máximo para Type.INTEGER e Type.NUMBER. |
PropertiesEntry
| Representação JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campos | |
|---|---|
key |
|
value |
|
Valor
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união kind. O tipo de valor. kind pode ser apenas de um dos tipos a seguir: |
|
nullValue |
Representa um |
numberValue |
Representa um número JSON. Não pode ser |
stringValue |
Representa uma string JSON. |
boolValue |
Representa um booleano JSON (literal |
structValue |
Representa um objeto JSON. |
listValue |
Representa uma matriz JSON. |
Struct
| Representação JSON |
|---|
{ "fields": { string: value, ... } } |
| Campos | |
|---|---|
fields |
Mapa não ordenado de valores digitados dinamicamente. Um objeto com uma lista de pares |
FieldsEntry
| Representação JSON |
|---|
{ "key": string, "value": value } |
| Campos | |
|---|---|
key |
|
value |
|
ListValue
| Representação JSON |
|---|
{ "values": [ value ] } |
| Campos | |
|---|---|
values[] |
Campo repetido de valores digitados dinamicamente. |
DefsEntry
| Representação JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campos | |
|---|---|
key |
|
value |
|
DataStoreSettings
| Representação JSON |
|---|
{
"engines": [
{
object ( |
| Campos | |
|---|---|
engines[] |
Apenas saída. Os mecanismos do app. |
Mecanismo
| Representação JSON |
|---|
{
"name": string,
"type": enum ( |
| Campos | |
|---|---|
name |
Apenas saída. O nome do recurso do mecanismo. Formato: |
type |
Apenas saída. O tipo de mecanismo. |
ChannelProfile
| Representação JSON |
|---|
{ "profileId": string, "channelType": enum ( |
| Campos | |
|---|---|
profileId |
Opcional. O identificador exclusivo do perfil do canal. |
channelType |
Opcional. O tipo do perfil do canal. |
personaProperty |
Opcional. A propriedade de persona do perfil do canal. |
webWidgetConfig |
Opcional. A configuração do widget da Web. |
whatsappConfig |
Opcional. Configuração específica para implantações do WhatsApp. |
instagramConfig |
Opcional. Configuração específica para implantações do Instagram. |
Campo de união
|
|
disableDtmf |
Opcional. Se a DTMF (frequência múltipla de dois tons) deve ser desativada. |
Campo de união
|
|
disableBargeInControl |
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
|
|
noiseSuppressionLevel |
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 ( |
| Campos | |
|---|---|
persona |
Opcional. A persona do canal. |
WebWidgetConfig
| Representação JSON |
|---|
{ "modality": enum ( |
| Campos | |
|---|---|
modality |
Opcional. A modalidade do widget da Web. |
theme |
Opcional. O tema do widget da Web. |
webWidgetTitle |
Opcional. O título do widget da Web. |
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 |
Opcional. Indica se o acesso público ao widget da Web está ativado. Se for |
enableOriginCheck |
Opcional. Indica se a verificação de origem do widget da Web está ativada. Se for |
allowedOrigins[] |
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 |
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 |
Obrigatório. O ID da conta do WhatsApp Business. |
phoneNumberId |
Obrigatório. O ID do número de telefone da Meta. |
phoneNumber |
Opcional. O número de telefone no formato E.164. |
displayName |
Apenas saída. O nome da página comercial da Meta que foi buscado. |
thumbnailUrl |
Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado. |
description |
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 |
Obrigatório. O ID da conta do Instagram. |
displayName |
Apenas saída. O nome da página comercial da Meta que foi buscado. |
thumbnailUrl |
Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado. |
description |
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 |
|
value |
|
ClientCertificateSettings
| Representação JSON |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| Campos | |
|---|---|
tlsCertificate |
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 |
Obrigatório. O nome do recurso da versão do secret do SecretManager que armazena a chave privada codificada no formato PEM. Formato: |
passphrase |
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: |
VpcScSettings
| Representação JSON |
|---|
{ "allowedOrigins": [ string ] } |
| Campos | |
|---|---|
allowedOrigins[] |
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 |
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: |
Agente
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "modelSettings": { object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo do agente. Formato: |
displayName |
Obrigatório. Nome de exibição do agente. |
description |
Opcional. Descrição do agente legível por humanos. |
modelSettings |
Opcional. Configurações do modelo de LLM. |
instruction |
Opcional. Instruções para o modelo de LLM orientar o comportamento do agente. |
tools[] |
Opcional. Lista de ferramentas disponíveis para o agente. Formato: |
childAgents[] |
Opcional. Lista de agentes filhos na árvore de agentes. Formato: |
beforeAgentCallbacks[] |
Opcional. Os callbacks a serem executados antes que o agente seja chamado. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
afterAgentCallbacks[] |
Opcional. Os callbacks que serão executados depois que o agente for chamado. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
beforeModelCallbacks[] |
Opcional. Os callbacks a serem executados antes que o modelo seja chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
afterModelCallbacks[] |
Opcional. Os callbacks a serem executados depois que o modelo é chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
beforeToolCallbacks[] |
Opcional. Os callbacks a serem executados antes que a ferramenta seja invocada. Se houver várias invocações de ferramentas, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
afterToolCallbacks[] |
Opcional. Os callbacks que serão executados depois que a ferramenta for invocada. Se houver várias invocações de ferramentas, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
createTime |
Apenas saída. Carimbo de data/hora em que o agente 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: |
updateTime |
Apenas saída. Carimbo de data/hora em que o agente 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: |
guardrails[] |
Opcional. Lista de proteções para o agente. Formato: |
etag |
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. |
toolsets[] |
Opcional. Lista de conjuntos de ferramentas para o agente. |
generatedSummary |
Apenas saída. Se o agente for gerado pelo assistente de LLM, esse campo vai conter um resumo descritivo da geração. |
transferRules[] |
Opcional. Regras de transferência de agentes. Se houver várias regras correspondentes, a primeira da lista será usada. |
validationErrors[] |
Apenas saída. Configurações incorretas ou erros no agente que podem afetar a qualidade dele. |
Campo de união agent_type. O tipo de agente. agent_type pode ser apenas de um dos tipos a seguir: |
|
llmAgent |
Opcional. O tipo de agente padrão. |
remoteDialogflowAgent |
Opcional. O agente remoto do Dialogflow que será usado para a execução do agente. Se esse campo for definido, todas as outras propriedades no nível do agente serão ignoradas. Observação: se o agente do Dialogflow estiver em um projeto diferente do app, conceda |
remoteA2aAgent |
Opcional. O agente A2A remoto que será usado para a execução do agente. |
RemoteDialogflowAgent
| Representação JSON |
|---|
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean, "languageCodeVariable": string } |
| Campos | |
|---|---|
agent |
Obrigatório. O nome do recurso do agente do Dialogflow. Formato: |
flowId |
Opcional. O ID do fluxo no agente do Dialogflow. |
environmentId |
Opcional. O ID do ambiente do agente do Dialogflow que será usado para a execução do agente. Se não for especificado, o ambiente de rascunho será usado. |
inputVariableMapping |
Opcional. O mapeamento dos nomes das variáveis do app para os nomes dos parâmetros de sessão do Dialogflow que serão enviados ao agente do Dialogflow como entrada. Um objeto com uma lista de pares |
outputVariableMapping |
Opcional. O mapeamento dos nomes dos parâmetros de sessão do Dialogflow para os nomes das variáveis do app que serão enviadas de volta ao agente do CES após o término da execução do agente do Dialogflow. Um objeto com uma lista de pares |
respectResponseInterruptionSettings |
Opcional. Indica se as configurações de interrupção no nível da mensagem definidas no agente do Dialogflow devem ser respeitadas.
|
languageCodeVariable |
Opcional. O nome da variável que contém o código do idioma a ser usado na sessão do Dialogflow. Se não for especificado, o código de idioma padrão do agente do Dialogflow será usado. |
InputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
RemoteA2aAgent
| Representação JSON |
|---|
{
"a2aConfig": {
object ( |
| Campos | |
|---|---|
a2aConfig |
Obrigatório. A configuração da conexão A2A. |
RemoteA2aConfig
| Representação JSON |
|---|
{ "apiAuthentication": { object ( |
| Campos | |
|---|---|
apiAuthentication |
Opcional. Configuração de autenticação para chamar o agente remoto. Opcional se a referência do registro já processar a autenticação. |
inputVariableMapping |
Opcional. Mapeamento de nomes de variáveis de entrada do agente remoto para nomes de variáveis do GECX. Um objeto com uma lista de pares |
outputVariableMapping |
Opcional. Mapeamento de nomes de variáveis de saída do agente remoto para nomes de variáveis do GECX. Um objeto com uma lista de pares |
streamingEnabled |
Opcional. Se o streaming está ativado para o agente remoto. |
contextId |
Opcional. Se não estiver vazio, as interações com o agente A2A remoto vão usar esse ID de contexto. Esse campo context_id pode se referir a uma variável de sessão como |
Campo de união agent_spec. Especificação do agente remoto. agent_spec pode ser apenas de um dos tipos a seguir: |
|
agentCard |
Opcional. O card completo do agente definido inline. |
agentRegistry |
Opcional. Referência ao agente no Agent Registry. Formato: |
AgentCard
| Representação JSON |
|---|
{ "name": string, "description": string, "supportedInterfaces": [ { object ( |
| Campos | |
|---|---|
name |
Obrigatório. Um nome do agente legível por humanos. |
description |
Obrigatório. Uma descrição do domínio de ação/espaço de solução do agente. |
supportedInterfaces[] |
Obrigatório. Lista ordenada de interfaces compatíveis. A primeira entrada é preferencial. |
version |
Obrigatório. A versão do agente. |
skills[] |
Obrigatório. As habilidades representam uma unidade de capacidade que um agente pode realizar. Isso pode parecer um pouco abstrato, mas representa um conjunto mais focado de ações que o agente tem grande probabilidade de realizar com sucesso. |
AgentInterface
| Representação JSON |
|---|
{ "url": string, "protocolBinding": string, "tenant": string, "protocolVersion": string } |
| Campos | |
|---|---|
url |
Obrigatório. O URL em que essa interface está disponível. Precisa ser um URL HTTPS absoluto válido em produção. Exemplo: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" |
protocolBinding |
Obrigatório. A vinculação de protocolo compatível com este URL. Essa é uma string de formato aberto, que pode ser facilmente estendida para outras vinculações de protocolo. Os principais oficialmente compatíveis são |
tenant |
ID do locatário a ser usado na solicitação ao chamar o agente. |
protocolVersion |
Obrigatório. A versão do protocolo A2A que essa interface expõe. Use a versão secundária mais recente compatível por versão principal. Exemplos: "0.3", "1.0" |
AgentSkill
| Representação JSON |
|---|
{ "id": string, "name": string, "description": string, "tags": [ string ], "examples": [ string ], "inputModes": [ string ], "outputModes": [ string ] } |
| Campos | |
|---|---|
id |
Obrigatório. Um identificador exclusivo para a habilidade do agente. |
name |
Obrigatório. Um nome legível por humanos para a habilidade. |
description |
Obrigatório. Uma descrição detalhada da habilidade. |
tags[] |
Obrigatório. Um conjunto de palavras-chave que descrevem as capacidades da habilidade. |
examples[] |
Exemplos de comandos ou cenários que essa habilidade pode processar. |
inputModes[] |
O conjunto de tipos de mídia de entrada compatíveis com essa habilidade, que substitui os padrões do agente. |
outputModes[] |
O conjunto de tipos de mídia de saída compatíveis com essa habilidade, que substitui os padrões do agente. |
ApiAuthentication
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união auth_config. A configuração de autenticação. auth_config pode ser apenas de um dos tipos a seguir: |
|
apiKeyConfig |
Opcional. Configuração para autenticação de chave de API. |
oauthConfig |
Opcional. Configuração do OAuth. |
serviceAgentIdTokenAuthConfig |
Opcional. Configuração para autenticação de token de ID gerada pelo agente de serviço do CES. |
serviceAccountAuthConfig |
Opcional. Configuração para autenticação de conta de serviço. |
bearerTokenConfig |
Opcional. Configuração para autenticação de token do portador. |
ApiKeyConfig
| Representação JSON |
|---|
{
"keyName": string,
"apiKeySecretVersion": string,
"requestLocation": enum ( |
| Campos | |
|---|---|
keyName |
Obrigatório. O nome do parâmetro ou do cabeçalho da chave de API. Por exemplo, Se a solicitação de API for "https://example.com/act?X-Api-Key= |
apiKeySecretVersion |
Obrigatório. O nome do recurso da versão do secret do Secret Manager que armazena a chave de API. Formato: Observação: conceda o papel |
requestLocation |
Obrigatório. Local da chave na solicitação. |
OAuthConfig
| Representação JSON |
|---|
{
"oauthGrantType": enum ( |
| Campos | |
|---|---|
oauthGrantType |
Obrigatório. Tipos de permissões de acesso OAuth. |
clientId |
Obrigatório. O ID do cliente do provedor OAuth. |
clientSecretVersion |
Obrigatório. O nome do recurso da versão do secret do Secret Manager que armazena a chave secreta do cliente. Formato: Observação: conceda o papel |
tokenEndpoint |
Obrigatório. O endpoint de token no provedor OAuth para trocar por um token de acesso. |
scopes[] |
Opcional. Os escopos do OAuth a serem concedidos. |
ServiceAccountAuthConfig
| Representação JSON |
|---|
{ "serviceAccount": string, "scopes": [ string ] } |
| Campos | |
|---|---|
serviceAccount |
Obrigatório. O endereço de e-mail da conta de serviço usada para autenticação. O CES usa essa conta de serviço para trocar um token de acesso, que é enviado no cabeçalho A conta de serviço precisa ter o papel |
scopes[] |
Opcional. Os escopos do OAuth a serem concedidos. Se não for especificado, o escopo padrão |
BearerTokenConfig
| Representação JSON |
|---|
{ "token": string } |
| Campos | |
|---|---|
token |
Obrigatório. O token do portador. Precisa estar no formato |
InputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
Callback
| Representação JSON |
|---|
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field |
| Campos | |
|---|---|
description |
Opcional. Descrição legível por humanos do callback. |
disabled |
Opcional. Se o callback está desativado. Os callbacks desativados são ignorados pelo agente. |
proactiveExecutionEnabled |
Opcional. Se ativado, o callback também será executado em saídas de modelo intermediárias. Essa configuração afeta apenas a chamada de retorno "After model". ATIVE COM CUIDADO. Normalmente, a chamada de retorno after_model_callback só precisa ser executada depois de receber todas as respostas do modelo. A ativação da execução proativa pode ter implicações negativas no custo e na latência da execução e só deve ser ativada em situações raras. |
Campo de união callback. O callback a ser executado. callback pode ser apenas de um dos tipos a seguir: |
|
pythonCode |
Obrigatório. O código Python a ser executado para o callback. |
AgentToolset
| Representação JSON |
|---|
{ "toolset": string, "toolIds": [ string ] } |
| Campos | |
|---|---|
toolset |
Obrigatório. O nome do recurso do conjunto de ferramentas. Formato: |
toolIds[] |
Opcional. Os IDs das ferramentas para filtrar o conjunto de ferramentas. |
TransferRule
| Representação JSON |
|---|
{ "childAgent": string, "direction": enum ( |
| Campos | |
|---|---|
childAgent |
Obrigatório. O nome do recurso do agente filho ao qual a regra se aplica. Formato: |
direction |
Obrigatório. A direção da transferência. |
Campo de união rule_type. O tipo de regra. rule_type pode ser apenas de um dos tipos a seguir: |
|
deterministicTransfer |
Opcional. Uma regra que transfere imediatamente para o agente de destino quando a condição é atendida. |
disablePlannerTransfer |
Opcional. Regra que impede o planejador de transferir para o agente de destino. |
DeterministicTransfer
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união condition_type. A condição a ser avaliada. condition_type pode ser apenas de um dos tipos a seguir: |
|
expressionCondition |
Opcional. Uma regra que avalia uma condição de estado da sessão. Se a condição for avaliada como verdadeira, a transferência vai ocorrer. |
pythonCodeCondition |
Opcional. Uma regra que usa um bloco de código Python para avaliar as condições. Se a condição for avaliada como verdadeira, a transferência vai ocorrer. |
ExpressionCondition
| Representação JSON |
|---|
{ "expression": string } |
| Campos | |
|---|---|
expression |
Obrigatório. A representação de string da condição cloud.api.Expression. |
PythonCodeCondition
| Representação JSON |
|---|
{ "pythonCode": string } |
| Campos | |
|---|---|
pythonCode |
Obrigatório. O código Python a ser executado. |
DisablePlannerTransfer
| Representação JSON |
|---|
{
"expressionCondition": {
object ( |
| Campos | |
|---|---|
expressionCondition |
Obrigatório. Se a condição for avaliada como verdadeira, o planejador não poderá transferir para o agente de destino. |
Ferramenta
| Representação JSON |
|---|
{ "name": string, "displayName": string, "executionType": enum ( |
| Campos | |
|---|---|
name |
Identificador. O nome do recurso da ferramenta. Formato:
Essas ferramentas são dinâmicas e somente de saída. Elas não podem ser referenciadas diretamente onde uma ferramenta é esperada. |
displayName |
Apenas saída. O nome de exibição da ferramenta, derivado com base no tipo dela. Por exemplo, o nome de exibição de uma [ClientFunction][Tool.ClientFunction] é derivado da propriedade |
executionType |
Opcional. O tipo de execução da ferramenta. |
timeout |
Opcional. O tempo limite para a execução da ferramenta. Se não for definido, o tempo limite padrão será de 30 segundos para ferramentas Duração em segundos com até nove dígitos fracionários, terminando em " |
createTime |
Apenas saída. Carimbo de data/hora de quando a ferramenta foi criada. 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: |
updateTime |
Apenas saída. Carimbo de data/hora de quando a ferramenta foi atualizada 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: |
etag |
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. |
generatedSummary |
Apenas saída. Se a ferramenta for gerada pelo assistente de LLM, esse campo vai conter um resumo descritivo da geração. |
toolFakeConfig |
Opcional. Configuração do comportamento da ferramenta no modo simulado. |
readOnly |
Apenas saída. Indica se a ferramenta é somente leitura. Se for verdadeiro, a ferramenta não poderá ser modificada pelo usuário. |
Campo de união tool_type. O tipo da ferramenta. tool_type pode ser apenas de um dos tipos a seguir: |
|
clientFunction |
Opcional. A função do cliente. |
openApiTool |
Opcional. A ferramenta de API aberta. |
googleSearchTool |
Opcional. A ferramenta Pesquisa Google. |
connectorTool |
Opcional. A ferramenta Integration Connectors. |
dataStoreTool |
Opcional. A ferramenta do repositório de dados. |
pythonFunction |
Opcional. A ferramenta de função do Python. |
mcpTool |
Opcional. A ferramenta MCP. Uma ferramenta do MCP não pode ser criada ou atualizada diretamente e é gerenciada pelo conjunto de ferramentas do MCP. |
fileSearchTool |
Opcional. A ferramenta de pesquisa de arquivos. |
systemTool |
Opcional. A ferramenta do sistema. |
agentTool |
Opcional. A ferramenta do agente. |
widgetTool |
Opcional. A ferramenta de widget. |
remoteAgentTool |
Opcional. A ferramenta de agente remoto. |
ClientFunction
| Representação JSON |
|---|
{ "name": string, "description": string, "parameters": { object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da função. |
description |
Opcional. A descrição da função. |
parameters |
Opcional. O esquema dos parâmetros da função. |
response |
Opcional. O esquema da resposta da função. |
OpenApiTool
| Representação JSON |
|---|
{ "openApiSchema": string, "name": string, "description": string, "apiAuthentication": { object ( |
| Campos | |
|---|---|
openApiSchema |
Obrigatório. O esquema OpenAPI no formato JSON ou YAML. |
name |
Opcional. O nome da ferramenta. Se não for fornecido, o nome da ferramenta será derivado do esquema OpenAPI, de |
description |
Opcional. A descrição da ferramenta. Se não for fornecida, a descrição da ferramenta será derivada do esquema OpenAPI, de |
apiAuthentication |
Opcional. Informações de autenticação exigidas pela API. |
tlsConfig |
Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente vai confiar. |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços. |
ignoreUnknownFields |
Opcional. Se for verdadeiro, o agente vai ignorar campos desconhecidos na resposta da API. |
url |
Opcional. O URL do servidor do esquema de API aberta. Esse campo só é definido em ferramentas nas dependências do ambiente durante o processo de exportação se o esquema tiver um URL de servidor. Durante o processo de importação, se esse URL estiver presente nas dependências do ambiente e o esquema tiver o marcador de posição $env_var, ele vai substituir o marcador no esquema. |
TlsConfig
| Representação JSON |
|---|
{
"caCerts": [
{
object ( |
| Campos | |
|---|---|
caCerts[] |
Obrigatório. Especifica uma lista de certificados de CA personalizados permitidos para verificação de HTTPS. |
CaCert
| Representação JSON |
|---|
{ "displayName": string, "cert": string } |
| Campos | |
|---|---|
displayName |
Obrigatório. O nome dos certificados de CA personalizados permitidos. Isso pode ser usado para eliminar a ambiguidade dos certificados de CA personalizados. |
cert |
Obrigatório. Os certificados de CA personalizados permitidos (no formato DER) para verificação de HTTPS. Isso substitui o repositório de confiança SSL padrão. Se esse campo estiver vazio ou não for especificado, o CES vai usar o repositório de confiança padrão do Google para verificar os certificados. Observação: verifique se os certificados do servidor HTTPS estão assinados com "nome alternativo do assunto". Por exemplo, um certificado pode ser autoassinado usando o seguinte comando: Uma string codificada em base64. |
ServiceDirectoryConfig
| Representação JSON |
|---|
{ "service": string } |
| Campos | |
|---|---|
service |
Obrigatório. O nome do serviço do Diretório de Serviços. Formato: |
GoogleSearchTool
| Representação JSON |
|---|
{
"name": string,
"description": string,
"contextUrls": [
string
],
"preferredDomains": [
string
],
"excludeDomains": [
string
],
"promptConfig": {
object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta. |
description |
Opcional. Descrição da finalidade da ferramenta. |
contextUrls[] |
Opcional. O conteúdo será buscado diretamente desses URLs para contexto e embasamento. Exemplo: "https://example.com/path.html". São permitidos no máximo 20 URLs. |
preferredDomains[] |
Opcional. Especifica os domínios para restringir os resultados da pesquisa. Exemplo: "example.com", "another.site". É possível especificar no máximo 20 domínios. |
excludeDomains[] |
Opcional. Lista de domínios que serão excluídos dos resultados da pesquisa. Exemplo: "example.com". É possível excluir até 2.000 domínios. |
promptConfig |
Opcional. Instruções de comando transmitidas ao planejador sobre como os resultados da pesquisa devem ser processados para texto e voz. |
PromptConfig
| Representação JSON |
|---|
{ "textPrompt": string, "voicePrompt": string } |
| Campos | |
|---|---|
textPrompt |
Opcional. Define o comando usado para as instruções do sistema ao interagir com o agente em conversas de chat. Se não for definido, o comando padrão será usado. |
voicePrompt |
Opcional. Define o comando usado para as instruções do sistema ao interagir com o agente em conversas por voz. Se não for definido, o comando padrão será usado. |
ConnectorTool
| Representação JSON |
|---|
{ "connection": string, "action": { object ( |
| Campos | |
|---|---|
connection |
Obrigatório. O nome completo do recurso da conexão do Integration Connectors referenciada. Formato: |
action |
Obrigatório. Ação que a ferramenta deve usar. |
authConfig |
Opcional. Configura como a autenticação é processada no Integration Connectors. Por padrão, uma autenticação de administrador é transmitida nas solicitações de API do Integration Connectors. É possível substituí-la por uma configuração de autenticação de usuário final diferente. Observação: a conexão precisa ter a substituição de autenticação ativada para especificar uma configuração de EUC aqui. Caso contrário, a criação da ConnectorTool vai falhar. Consulte https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override para mais detalhes. |
name |
Opcional. O nome da ferramenta que pode ser usada pelo agente para decidir se deve chamar essa ConnectorTool. |
description |
Opcional. A descrição da ferramenta que pode ser usada pelo agente para decidir se deve chamar essa ConnectorTool. |
Ação
| Representação JSON |
|---|
{ "inputFields": [ string ], "outputFields": [ string ], // Union field |
| Campos | |
|---|---|
inputFields[] |
Opcional. Campos de entidade para usar como entradas para a operação. Se nenhum campo for especificado, todos os campos da entidade serão usados. |
outputFields[] |
Opcional. Campos de entidade a serem retornados da operação. Se nenhum campo for especificado, todos os campos da entidade serão retornados. |
Campo de união action_spec. Especificação de uma ação a ser configurada para a ferramenta usar. action_spec pode ser apenas de um dos tipos a seguir: |
|
connectionActionId |
ID de uma ação de conexão para a ferramenta usar. |
entityOperation |
Configuração da operação de entidade para a ferramenta usar. |
EntityOperation
| Representação JSON |
|---|
{
"entityId": string,
"operation": enum ( |
| Campos | |
|---|---|
entityId |
Obrigatório. ID da entidade. |
operation |
Obrigatório. Operação a ser realizada na entidade. |
EndUserAuthConfig
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união auth_config. A configuração de autenticação. auth_config pode ser apenas de um dos tipos a seguir: |
|
oauth2AuthCodeConfig |
Autenticação do código de autorização do OAuth 2.0. |
oauth2JwtBearerConfig |
Autenticação de concessão de autorização do OAuth 2.0 do perfil JWT. |
Oauth2AuthCodeConfig
| Representação JSON |
|---|
{ "oauthToken": string } |
| Campos | |
|---|---|
oauthToken |
Obrigatório. Nome do parâmetro do token OAuth a ser transmitido. Precisa estar no formato |
Oauth2JwtBearerConfig
| Representação JSON |
|---|
{ "issuer": string, "subject": string, "clientKey": string } |
| Campos | |
|---|---|
issuer |
Obrigatório. Nome do parâmetro do emissor a ser transmitido. Precisa estar no formato |
subject |
Obrigatório. Nome do parâmetro de assunto a ser transmitido. Precisa estar no formato |
clientKey |
Obrigatório. Nome do parâmetro do cliente a ser transmitido. Precisa estar no formato |
DataStoreTool
| Representação JSON |
|---|
{ "name": string, "description": string, "boostSpecs": [ { object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta do repositório de dados. |
description |
Opcional. A descrição da ferramenta. |
boostSpecs[] |
Opcional. Especificação de otimização para impulsionar determinados documentos. |
modalityConfigs[] |
Opcional. As configurações de modalidade do repositório de dados. |
filterParameterBehavior |
Opcional. O comportamento do parâmetro de filtro. |
Campo de união search_source. Define a origem da pesquisa, que pode ser um único DataStore ou um Engine. search_source pode ser apenas de um dos tipos a seguir: |
|
dataStoreSource |
Opcional. Pesquise em um único DataStore específico. |
engineSource |
Opcional. Pesquise em um mecanismo (potencialmente em vários DataStores). |
DataStoreSource
| Representação JSON |
|---|
{
"filter": string,
"dataStore": {
object ( |
| Campos | |
|---|---|
filter |
Opcional. Especificação de filtro para o DataStore. Consulte: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
dataStore |
Opcional. O repositório de dados. |
DataStore
| Representação JSON |
|---|
{ "name": string, "type": enum ( |
| Campos | |
|---|---|
name |
Obrigatório. Nome completo do recurso do DataStore. Formato: |
type |
Apenas saída. O tipo do repositório de dados. Este campo é somente leitura e preenchido pelo servidor. |
documentProcessingMode |
Apenas saída. O modo de processamento de documentos para a conexão do repositório de dados. Definido apenas para repositórios de dados PUBLIC_WEB e UNSTRUCTURED. |
displayName |
Apenas saída. O nome de exibição do repositório de dados. |
createTime |
Apenas saída. O carimbo de data/hora em que o repositório de dados 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: |
connectorConfig |
Apenas saída. A configuração do conector para a conexão do repositório de dados. |
ConnectorConfig
| Representação JSON |
|---|
{ "collection": string, "collectionDisplayName": string, "dataSource": string } |
| Campos | |
|---|---|
collection |
Nome do recurso da coleção a que o repositório de dados pertence. |
collectionDisplayName |
Nome de exibição da coleção a que o repositório de dados pertence. |
dataSource |
O nome da fonte de dados. Exemplo: |
EngineSource
| Representação JSON |
|---|
{
"engine": string,
"dataStoreSources": [
{
object ( |
| Campos | |
|---|---|
engine |
Obrigatório. Nome completo do recurso do mecanismo. Formato: |
dataStoreSources[] |
Opcional. Use para segmentar DataStores específicos no mecanismo. Se estiver vazio, a pesquisa será aplicada a todos os DataStores associados ao mecanismo. |
filter |
Opcional. Um filtro aplicado à pesquisa no mecanismo. Não é relevante nem usado se "data_store_sources" for fornecido. Consulte: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
BoostSpecs
| Representação JSON |
|---|
{
"dataStores": [
string
],
"spec": [
{
object ( |
| Campos | |
|---|---|
dataStores[] |
Obrigatório. O repositório de dados em que a configuração de otimização é aplicada. Nome completo do recurso do DataStore, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
Obrigatório. Uma lista de especificações de otimização. |
BoostSpec
| Representação JSON |
|---|
{
"conditionBoostSpecs": [
{
object ( |
| Campos | |
|---|---|
conditionBoostSpecs[] |
Obrigatório. Uma lista de especificações de otimização. |
ConditionBoostSpec
| Representação JSON |
|---|
{
"condition": string,
"boost": number,
"boostControlSpec": {
object ( |
| Campos | |
|---|---|
condition |
Obrigatório. Uma expressão que especifica uma condição de otimização. A sintaxe é a mesma da expressão de filtro. No momento, a única condição aceita é uma lista de códigos de idioma BCP-47. Exemplo: para impulsionar sugestões nos idiomas en ou fr: (lang_code: ANY("en", "fr")) |
boost |
Opcional. Intensidade da otimização, que precisa estar em [-1, 1]. Reforço negativo significa rebaixamento. O padrão é 0.0. Definir como 1.0 oferece uma grande promoção às sugestões. No entanto, isso não significa necessariamente que o resultado principal será uma sugestão otimizada. Definir como -1.0 dá às sugestões um grande rebaixamento. No entanto, outras sugestões relevantes ainda podem ser mostradas. Definir como 0.0 significa que nenhuma otimização foi aplicada. A condição de otimização é ignorada. |
boostControlSpec |
Opcional. Especificação complexa para classificação personalizada com base no valor do atributo definido pelo cliente. |
BoostControlSpec
| Representação JSON |
|---|
{ "fieldName": string, "attributeType": enum ( |
| Campos | |
|---|---|
fieldName |
Opcional. O nome do campo cujo valor será usado para determinar o valor do aumento. |
attributeType |
Opcional. O tipo de atributo a ser usado para determinar o valor do aumento. O valor do atributo pode ser derivado do valor do campo do field_name especificado. No caso de valores numéricos, é simples, ou seja, attribute_value = numerical_field_value. No entanto, no caso de atualização, attribute_value = (time.now() - datetime_field_value). |
interpolationType |
Opcional. O tipo de interpolação a ser aplicado para conectar os pontos de controle listados abaixo. |
controlPoints[] |
Opcional. Os pontos de controle usados para definir a curva. A função monotônica (definida pelo interpolation_type acima) passa pelos pontos de controle listados aqui. |
ControlPoint
| Representação JSON |
|---|
{ "attributeValue": string, "boostAmount": number } |
| Campos | |
|---|---|
attributeValue |
Opcional. Pode ser um dos seguintes: 1. O valor numérico do campo. 2. A especificação de duração para atualização: o valor precisa ser formatado como um valor XSD |
boostAmount |
Opcional. O valor entre -1 e 1 para aumentar a pontuação se o attribute_value for avaliado como o valor especificado acima. |
ModalityConfig
| Representação JSON |
|---|
{ "modalityType": enum ( |
| Campos | |
|---|---|
modalityType |
Obrigatório. O tipo de modalidade. |
rewriterConfig |
Opcional. A configuração do reescritor. |
summarizationConfig |
Opcional. A configuração de resumo. |
groundingConfig |
Opcional. A configuração de embasamento. |
snippetsConfig |
Opcional. A configuração dos snippets. |
RewriterConfig
| Representação JSON |
|---|
{
"modelSettings": {
object ( |
| Campos | |
|---|---|
modelSettings |
Obrigatório. Configurações do modelo de LLM. |
prompt |
Opcional. A definição do comando. Se não for definido, o comando padrão será usado. |
disabled |
Opcional. Se o reescritor está desativado. |
SummarizationConfig
| Representação JSON |
|---|
{
"modelSettings": {
object ( |
| Campos | |
|---|---|
modelSettings |
Opcional. Configurações do modelo de LLM. |
prompt |
Opcional. A definição do comando. Se não for definido, o comando padrão será usado. |
disabled |
Opcional. Se a geração de resumos está desativada. |
GroundingConfig
| Representação JSON |
|---|
{ "groundingLevel": number, "disabled": boolean } |
| Campos | |
|---|---|
groundingLevel |
Opcional. O limite de embasamento da resposta com base nas fontes recuperadas. O valor tem um intervalo configurável de [1, 5]. O nível é usado para definir o limite de embasamento da resposta, o que significa que todas as respostas com uma pontuação de embasamento abaixo do limite vão retornar apenas snippets relevantes. Por exemplo, um nível de 3 significa que a pontuação de embasamento precisa ser 3 ou maior para que a resposta seja retornada. |
disabled |
Opcional. Se o embasamento está desativado. |
SnippetsConfig
| Representação JSON |
|---|
{ "enableSnippets": boolean, "maxSnippets": integer } |
| Campos | |
|---|---|
enableSnippets |
Opcional. Se os snippets estão ativados. |
maxSnippets |
Opcional. Número de snippets que serão retornados por consulta. Se não for definido, retorna todos os snippets do serviço por padrão. |
PythonFunction
| Representação JSON |
|---|
{
"name": string,
"pythonCode": string,
"description": string,
"serviceDirectoryConfig": {
object ( |
| Campos | |
|---|---|
name |
Opcional. O nome da função do Python a ser executada. Precisa corresponder a um nome de função do Python definido no código Python. Diferencia maiúsculas de minúsculas. Se o nome não for fornecido, a primeira função definida no código Python será usada. |
pythonCode |
Opcional. O código Python a ser executado para a ferramenta. |
description |
Apenas saída. A descrição da função do Python, analisada da docstring do código Python. |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços para a ferramenta. |
McpTool
| Representação JSON |
|---|
{ "name": string, "nameOverride": string, "description": string, "inputSchema": { object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta do MCP. |
nameOverride |
Opcional. A substituição do nome da ferramenta MCP. Isso será preenchido se o nome tiver sido substituído por uma substituição do Toolset. |
description |
Opcional. A descrição da ferramenta MCP. |
inputSchema |
Opcional. O esquema dos argumentos de entrada da ferramenta MCP. |
outputSchema |
Opcional. O esquema dos argumentos de saída da ferramenta MCP. |
serverAddress |
Obrigatório. O endereço do servidor MCP, por exemplo, "https://example.com/mcp/". Se o servidor for criado com o SDK do MCP, o URL precisará ter o sufixo "/mcp/". Somente servidores baseados em transporte HTTP transmissível são compatíveis. É o mesmo que server_address no McpToolset. Consulte https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para mais detalhes. |
apiAuthentication |
Opcional. Informações de autenticação necessárias para executar a ferramenta no servidor MCP. Para a autenticação de token do portador, o token se aplica apenas à execução de ferramentas, não à listagem de ferramentas. Isso exige que as ferramentas possam ser listadas sem autenticação. |
tlsConfig |
Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente deve confiar. |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços para VPC-SC, usada para resolver nomes de serviço em um perímetro. |
customHeaders |
Opcional. Os cabeçalhos personalizados que serão enviados na solicitação ao servidor MCP. Os valores precisam estar no formato Um objeto com uma lista de pares |
state |
Apenas saída. O estado de disponibilidade dinâmica da ferramenta no servidor externo. |
CustomHeadersEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
FileSearchTool
| Representação JSON |
|---|
{
"corpusType": enum ( |
| Campos | |
|---|---|
corpusType |
Opcional. O tipo do corpus. O padrão é FULLY_MANAGED. |
name |
Obrigatório. O nome da ferramenta. |
description |
Opcional. A descrição da ferramenta. |
fileCorpus |
Opcional. O corpus em que os arquivos estão armazenados. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |
SystemTool
| Representação JSON |
|---|
{ "name": string, "description": string } |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta do sistema. |
description |
Apenas saída. A descrição da ferramenta do sistema. |
AgentTool
| Representação JSON |
|---|
{ "name": string, "description": string, "agent": string } |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta do agente. |
description |
Opcional. Descrição da finalidade da ferramenta. |
agent |
Opcional. O nome do recurso do agente que é o ponto de entrada da ferramenta. Formato: |
WidgetTool
| Representação JSON |
|---|
{ "name": string, "description": string, "widgetType": enum ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome de exibição da ferramenta de widget. |
description |
Opcional. A descrição da ferramenta de widget. |
widgetType |
Opcional. O tipo da ferramenta de widget. Se não for especificado, o tipo padrão será CUSTOMIZED. |
uiConfig |
Opcional. Configuração para renderizar o widget. |
dataMapping |
Opcional. O mapeamento que define como os dados de uma ferramenta de origem são mapeados para os parâmetros de entrada do widget. |
textResponseConfig |
Opcional. Configuração para respostas de texto sempre incluídas. |
Campo de união input. A entrada da ferramenta de widget. input pode ser apenas de um dos tipos a seguir: |
|
parameters |
Opcional. Os parâmetros de entrada da ferramenta de widget. |
DataMapping
| Representação JSON |
|---|
{ "sourceToolName": string, "fieldMappings": { string: string, ... }, "pythonFunction": { object ( |
| Campos | |
|---|---|
sourceToolName |
Opcional. O nome do recurso da ferramenta que fornece os dados para o widget (por exemplo, uma ferramenta de pesquisa ou uma função personalizada). Formato: |
fieldMappings |
Opcional. Um mapa de campos de parâmetros de entrada do widget para os campos de saída correspondentes da ferramenta de origem. Um objeto com uma lista de pares |
pythonFunction |
Opcional. Configuração de uma função Python usada para transformar a saída da ferramenta de origem no formato de entrada do widget. |
mode |
Opcional. O modo do mapeamento de dados. |
pythonScript |
Descontinuado: use |
FieldMappingsEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
TextResponseConfig
| Representação JSON |
|---|
{
"type": enum ( |
| Campos | |
|---|---|
type |
Opcional. A estratégia para fornecer a resposta em texto. |
staticText |
Opcional. A resposta de texto estático a ser retornada quando o tipo é STATIC. |
textResponseInstruction |
Opcional. Instrução para o LLM sobre como gerar a resposta de texto. Usado como a descrição do parâmetro de resposta de texto se o tipo for LLM_GENERATED. |
RemoteAgentTool
| Representação JSON |
|---|
{ "name": string, "description": string, "agentCard": { object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta. |
description |
Obrigatório. A descrição da ferramenta. |
agentCard |
Obrigatório. O card do agente remoto que essa ferramenta invoca. |
apiAuthentication |
Opcional. Configuração de autenticação para chamar o agente remoto. |
statefulAgent |
Opcional. Quando ativada, a interação entre o app CXAS e o agente remoto vai compartilhar o mesmo contexto. Se o agente remoto retornar um context_id, ele será mantido durante toda a sessão para essa ferramenta de agente remoto. |
inputVariableMapping |
Opcional. Mapeamento de nomes de variáveis de entrada do agente remoto para nomes de variáveis do GECX. Um objeto com uma lista de pares |
outputVariableMapping |
Opcional. Mapeamento de nomes de variáveis de saída do agente remoto para nomes de variáveis do GECX. Um objeto com uma lista de pares |
InputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
ToolFakeConfig
| Representação JSON |
|---|
{ "enableFakeMode": boolean, // Union field |
| Campos | |
|---|---|
enableFakeMode |
Opcional. Se a ferramenta está usando o modo falso. |
Campo de união tool_response. A resposta é estática ou fornecida por uma função Python. tool_response pode ser apenas de um dos tipos a seguir: |
|
codeBlock |
Opcional. Bloco de código que será executado em vez de uma chamada de ferramenta real. |
CodeBlock
| Representação JSON |
|---|
{ "pythonCode": string } |
| Campos | |
|---|---|
pythonCode |
Obrigatório. Código Python que será invocado no modo de simulação da ferramenta. Assinatura de função Python esperada: para capturar todas as chamadas de ferramenta: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: para capturar uma chamada de ferramenta específica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: se a função retornar None, a ferramenta real será invocada. |
Exemplo
| Representação JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"entryAgent": string,
"messages": [
{
object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo do exemplo. Formato: |
displayName |
Obrigatório. Nome de exibição do exemplo. |
description |
Opcional. Descrição legível por humanos do exemplo. |
entryAgent |
Opcional. O agente que lida inicialmente com a conversa. Se não for especificado, o exemplo vai representar uma conversa processada pelo agente raiz. Formato: |
messages[] |
Opcional. A coleção de mensagens que compõem a conversa. |
createTime |
Apenas saída. Carimbo de data/hora em que o exemplo 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: |
updateTime |
Apenas saída. Carimbo de data/hora de quando o exemplo 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: |
invalid |
Apenas saída. O exemplo pode se tornar inválido se os recursos de referência forem excluídos. Exemplos inválidos não serão usados como exemplos few-shot. |
etag |
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. |
Mensagem
| Representação JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| Campos | |
|---|---|
role |
Opcional. O papel na conversa, por exemplo, usuário, agente. |
chunks[] |
Opcional. Conteúdo da mensagem como uma série de blocos. |
eventTime |
Opcional. Carimbo de data/hora de quando a mensagem foi enviada ou recebida. Não deve ser usado se a mensagem fizer parte de um 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: |
Pedaço
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união data. Dividir dados em blocos. data pode ser apenas de um dos tipos a seguir: |
|
text |
Opcional. Dados de texto. |
transcript |
Opcional. Transcrição associada ao áudio. |
blob |
Opcional. Dados de blob. |
payload |
Opcional. Dados de payload personalizados. |
image |
Opcional. Dados da imagem. |
toolCall |
Opcional. Solicitação de execução de ferramenta. |
toolResponse |
Opcional. Resposta da execução da ferramenta. |
agentTransfer |
Opcional. Evento de transferência do agente. |
updatedVariables |
Uma estrutura representa as variáveis que foram atualizadas na conversa, identificadas pelos nomes das variáveis. |
defaultVariables |
Uma struct representa variáveis padrão no início da conversa, identificadas por nomes de variáveis. |
Blob
| Representação JSON |
|---|
{ "mimeType": string, "data": string } |
| Campos | |
|---|---|
mimeType |
Obrigatório. O tipo MIME padrão da IANA dos dados de origem. |
data |
Obrigatório. Bytes brutos do blob. Uma string codificada em base64. |
Imagem
| Representação JSON |
|---|
{ "mimeType": string, "data": string, "altText": string } |
| Campos | |
|---|---|
mimeType |
Obrigatório. O tipo MIME padrão da IANA dos dados de origem. Os tipos de imagem compatíveis incluem: * image/png * image/jpeg * image/webp |
data |
Obrigatório. Bytes brutos da imagem. Uma string codificada em base64. |
altText |
Opcional. O texto alternativo da imagem. |
ToolCall
| Representação JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| Campos | |
|---|---|
id |
Opcional. O identificador exclusivo da chamada de ferramenta. Se preenchido, o cliente vai retornar o resultado da execução com o código correspondente em |
displayName |
Apenas saída. Nome de exibição da ferramenta. |
args |
Opcional. Os parâmetros de entrada e os valores da ferramenta no formato de objeto JSON. |
parentToolCallId |
Apenas saída. O ID da chamada de ferramenta que causou esta, quando foi emitida por um subagente trabalhando em nome de uma chamada pai. Vazio para chamadas de nível superior. Permite que um cliente agrupe o trabalho de um subagente na chamada que o iniciou, em vez de renderizar cada etapa como um irmão. |
agentName |
Apenas saída. Nome legível por humanos do agente que emitiu essa chamada, por exemplo, "Arquiteto de contratos". Vazio quando o agente raiz o emitiu. |
targetApp |
Apenas saída. O app que essa chamada segmenta, derivado pelo assistente dos argumentos de recurso da chamada: um nome de recurso de app, |
Campo de união tool_identifier. O identificador da ferramenta a ser executada. Pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir: |
|
tool |
Opcional. O nome da ferramenta a ser executada. Formato: |
toolsetTool |
Opcional. A ferramenta do conjunto de ferramentas a ser executada. |
ToolsetTool
| Representação JSON |
|---|
{ "toolset": string, "toolId": string } |
| Campos | |
|---|---|
toolset |
Obrigatório. O nome do recurso do conjunto de ferramentas de onde essa ferramenta é derivada. Formato: |
toolId |
Opcional. O ID da ferramenta para filtrar as ferramentas e recuperar o esquema. |
ToolResponse
| Representação JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| Campos | |
|---|---|
id |
Opcional. O código correspondente do |
displayName |
Apenas saída. Nome de exibição da ferramenta. |
response |
Obrigatório. O resultado da execução da ferramenta no formato de objeto JSON. Use a chave "output" para especificar a resposta da ferramenta e a chave "error" para especificar os detalhes do erro (se houver). Se as chaves "output" e "error" não forem especificadas, toda a "response" será tratada como resultado da execução da ferramenta. |
parentToolCallId |
Apenas saída. O ID da chamada de ferramenta que causou esta, quando foi emitida por um subagente trabalhando em nome de uma chamada pai. Vazio para chamadas de nível superior. Permite que um cliente agrupe o trabalho de um subagente na chamada que o iniciou, em vez de renderizar cada etapa como um irmão. |
agentName |
Apenas saída. Nome legível por humanos do agente que emitiu essa chamada, por exemplo, "Arquiteto de contratos". Vazio quando o agente raiz o emitiu. |
targetApp |
Apenas saída. O app que a ferramenta executada segmentou; espelha |
Campo de união tool_identifier. O identificador da ferramenta que foi executada. Pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir: |
|
tool |
Opcional. O nome da ferramenta a ser executada. Formato: |
toolsetTool |
Opcional. A ferramenta do conjunto que foi executada. |
AgentTransfer
| Representação JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| Campos | |
|---|---|
targetAgent |
Obrigatório. O agente para quem a conversa está sendo transferida. O agente vai assumir a conversa a partir desse momento. Formato: |
displayName |
Apenas saída. Nome de exibição do agente. |
Proteção
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo da proteção. Formato: |
displayName |
Obrigatório. Nome de exibição da proteção. |
description |
Opcional. Descrição da proteção. |
enabled |
Opcional. Se a proteção está ativada. |
action |
Opcional. Ação a ser tomada quando a proteção for acionada. |
createTime |
Apenas saída. Carimbo de data/hora de quando a barreira de proteção foi criada. 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: |
updateTime |
Apenas saída. Carimbo de data/hora de quando a proteção foi atualizada 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: |
etag |
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. |
Campo de união guardrail_type. Tipo de barreira de proteção. guardrail_type pode ser apenas de um dos tipos a seguir: |
|
contentFilter |
Opcional. Proteção que proíbe o uso de determinados conteúdos na conversa. |
llmPromptSecurity |
Opcional. Proteção que bloqueia a conversa se o comando for considerado inseguro com base na classificação do LLM. |
llmPolicy |
Opcional. Proteção que bloqueia a conversa se a resposta do LLM for considerada uma violação da política com base na classificação do LLM. |
modelSafety |
Opcional. Proteção que bloqueia a conversa se a resposta do LLM for considerada insegura com base nas configurações de segurança do modelo. |
codeCallback |
Opcional. Proteção que pode bloquear a conversa com base no resultado da execução do callback. |
supervisor |
Opcional. Proteção que executa a intervenção do supervisor. |
ContentFilter
| Representação JSON |
|---|
{
"bannedContents": [
string
],
"bannedContentsInUserInput": [
string
],
"bannedContentsInAgentResponse": [
string
],
"matchType": enum ( |
| Campos | |
|---|---|
bannedContents[] |
Opcional. Lista de frases proibidas. Aplica-se às entradas do usuário e às respostas do agente. |
bannedContentsInUserInput[] |
Opcional. Lista de frases proibidas. Aplica-se apenas às entradas do usuário. |
bannedContentsInAgentResponse[] |
Opcional. Lista de frases proibidas. Aplica-se apenas às respostas do agente. |
matchType |
Obrigatório. Tipo de correspondência para o filtro de conteúdo. |
disregardDiacritics |
Opcional. Se for verdadeiro, os diacríticos serão ignorados durante a correspondência. |
sensitiveWordsExemptions[] |
Opcional. Entradas da lista de palavras sensíveis que essa proteção permite. Válido apenas quando match_type é SENSITIVE_WORDS. Cada valor precisa ser igual a uma entrada da lista (não diferencia maiúsculas de minúsculas, espaços em branco ao redor são ignorados). Outros valores não têm efeito. Aplica-se apenas a esta proteção. No máximo 1.000 entradas de até 256 caracteres cada. |
LlmPromptSecurity
| Representação JSON |
|---|
{ "failOpen": boolean, // Union field |
| Campos | |
|---|---|
failOpen |
Opcional. Determina o comportamento quando a proteção encontra um erro de LLM. - Se for verdadeiro: a proteção é ignorada. - Se for falso (padrão): a proteção é acionada/bloqueada. Observação: se uma política personalizada for fornecida, esse campo será ignorado em favor da configuração "fail_open" da política. |
Campo de união security_config. Define o modo de configuração de segurança. O usuário precisa escolher uma das seguintes configurações. security_config pode ser apenas de um dos tipos a seguir: |
|
defaultSettings |
Opcional. Use as configurações de segurança padrão predefinidas do sistema. Para selecionar esse modo, inclua uma mensagem "default_settings" vazia na solicitação. O campo "default_prompt_template" será preenchido pelo servidor na resposta. |
customPolicy |
Opcional. Use uma LlmPolicy definida pelo usuário para configurar a proteção de segurança. |
DefaultSecuritySettings
| Representação JSON |
|---|
{ "defaultPromptTemplate": string } |
| Campos | |
|---|---|
defaultPromptTemplate |
Apenas saída. O modelo de comando padrão usado pelo sistema. Este campo serve para mostrar ao usuário qual comando o sistema usa por padrão. É OUTPUT_ONLY. |
LlmPolicy
| Representação JSON |
|---|
{ "maxConversationMessages": integer, "modelSettings": { object ( |
| Campos | |
|---|---|
maxConversationMessages |
Opcional. Ao verificar essa política, considere as últimas "n" mensagens na conversa. Quando não definido, um valor padrão de 10 será usado. |
modelSettings |
Opcional. Configurações do modelo. |
prompt |
Obrigatório. Comando de política. Oferece suporte a marcadores de posição de variáveis de sessão ( |
policyScope |
Obrigatório. Define quando aplicar a verificação de política durante a conversa. Se definida como |
failOpen |
Opcional. Se ocorrer um erro durante a verificação da política, falhe em aberto e não acione a proteção. |
allowShortUtterance |
Opcional. Por padrão, a verificação da política de LLM é ignorada para enunciados curtos. Ativar essa configuração aplica a verificação de política a todas as falas, incluindo aquelas que normalmente seriam ignoradas. |
ModelSafety
| Representação JSON |
|---|
{
"safetySettings": [
{
object ( |
| Campos | |
|---|---|
safetySettings[] |
Obrigatório. Lista de configurações de segurança. |
SafetySetting
| Representação JSON |
|---|
{ "category": enum ( |
| Campos | |
|---|---|
category |
Obrigatório. A categoria de dano. |
threshold |
Obrigatório. O limite do bloqueio de danos. |
CodeCallback
| Representação JSON |
|---|
{ "beforeAgentCallback": { object ( |
| Campos | |
|---|---|
beforeAgentCallback |
Opcional. O callback a ser executado antes que o agente seja chamado. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - 'decision': 'OK' ou 'TRIGGER'. - 'reason': uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento. |
afterAgentCallback |
Opcional. O callback a ser executado depois que o agente é chamado. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - 'decision': 'OK' ou 'TRIGGER'. - 'reason': uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento. |
beforeModelCallback |
Opcional. O callback a ser executado antes que o modelo seja chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - 'decision': 'OK' ou 'TRIGGER'. - 'reason': uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento. |
afterModelCallback |
Opcional. O callback a ser executado depois que o modelo é chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - 'decision': 'OK' ou 'TRIGGER'. - 'reason': uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento. |
Supervisor
| Representação JSON |
|---|
{ "type": enum ( |
| Campos | |
|---|---|
type |
Opcional. O tipo do supervisor. |
detectionMode |
Opcional. O modo de detecção do supervisor. |
TriggerAction
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união action. A ação a ser tomada. action pode ser apenas de um dos tipos a seguir: |
|
respondImmediately |
Opcional. Responda imediatamente com uma resposta pré-configurada. |
transferAgent |
Opcional. Transferir a conversa para outro agente. |
generativeAnswer |
Opcional. Responder com uma resposta generativa. |
RespondImmediately
| Representação JSON |
|---|
{
"responses": [
{
object ( |
| Campos | |
|---|---|
responses[] |
Obrigatório. As respostas automáticas que o agente pode escolher. A resposta é escolhida aleatoriamente. |
Resposta
| Representação JSON |
|---|
{ "text": string, "disabled": boolean } |
| Campos | |
|---|---|
text |
Obrigatório. Texto para o agente responder. |
disabled |
Opcional. Indica se a resposta está desativada. As respostas desativadas não são usadas pelo agente. |
TransferAgent
| Representação JSON |
|---|
{ "agent": string } |
| Campos | |
|---|---|
agent |
Obrigatório. O nome do agente para quem a conversa será transferida. O agente precisa estar no mesmo app que o agente atual. Formato: |
GenerativeAnswer
| Representação JSON |
|---|
{ "prompt": string } |
| Campos | |
|---|---|
prompt |
Obrigatório. O comando a ser usado para a resposta generativa. |
Conjunto de ferramentas
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "timeout": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo do conjunto de ferramentas. Formato: |
displayName |
Opcional. O nome de exibição do conjunto de ferramentas. Precisa ser exclusivo no mesmo app. |
description |
Opcional. A descrição do conjunto de ferramentas. |
timeout |
Opcional. O tempo limite para a execução do conjunto de ferramentas. Se não for definido, o tempo limite padrão será de 30 segundos para conjuntos de ferramentas Duração em segundos com até nove dígitos fracionários, terminando em " |
createTime |
Apenas saída. Carimbo de data/hora de quando o conjunto de ferramentas 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: |
updateTime |
Apenas saída. Carimbo de data/hora de quando o conjunto de ferramentas 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: |
etag |
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. |
executionType |
Opcional. O tipo de execução das ferramentas no conjunto. |
toolFakeConfig |
Opcional. Configuração do comportamento das ferramentas no modo simulado. |
Campo de união toolset_type. O tipo do conjunto de ferramentas. toolset_type pode ser apenas de um dos tipos a seguir: |
|
mcpToolset |
Opcional. Um conjunto de ferramentas que contém uma lista de ferramentas oferecidas pelo servidor MCP. |
openApiToolset |
Opcional. Um conjunto de ferramentas que contém uma lista de ferramentas definidas por um esquema da OpenAPI. |
connectorToolset |
Opcional. Um conjunto de ferramentas que gera ferramentas de uma conexão do Integration Connectors. |
McpToolset
| Representação JSON |
|---|
{ "serverAddress": string, "apiAuthentication": { object ( |
| Campos | |
|---|---|
serverAddress |
Obrigatório. O endereço do servidor MCP, por exemplo, "https://example.com/mcp/". Se o servidor for criado com o SDK do MCP, o URL precisará ter o sufixo "/mcp/". Somente servidores baseados em transporte HTTP transmissível são compatíveis. Consulte https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para mais detalhes. |
apiAuthentication |
Opcional. Informações de autenticação necessárias para acessar ferramentas e executar uma ferramenta no servidor MCP. Para a autenticação de token do portador, o token se aplica apenas à execução de ferramentas, não à listagem de ferramentas. Isso exige que as ferramentas possam ser listadas sem autenticação. |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços para VPC-SC, usada para resolver nomes de serviço em um perímetro. |
tlsConfig |
Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente deve confiar. |
customHeaders |
Opcional. Os cabeçalhos personalizados que serão enviados na solicitação ao servidor MCP. Os valores precisam estar no formato Um objeto com uma lista de pares |
toolOverrides[] |
Opcional. Substituições para ferramentas individuais dentro desse conjunto. Isso permite substituir detalhes específicos, como descrições, nomes ou fixar os estados das ferramentas para que não sejam totalmente dinâmicos. |
CustomHeadersEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
McpToolOverride
| Representação JSON |
|---|
{
"tool": string,
"nameOverride": string,
"descriptionOverride": string,
"snapshot": {
object ( |
| Campos | |
|---|---|
tool |
Obrigatório. O nome original da ferramenta, conforme emitido pelo servidor MCP. |
nameOverride |
Opcional. Se presente, essa ferramenta usa esse nome no agente em vez do nome original. Isso é usado principalmente como um alias se o servidor MCP oferecer ferramentas com nomes ruins. |
descriptionOverride |
Opcional. Se presente, essa ferramenta usa essa descrição em vez da original do servidor. |
snapshot |
Apenas saída. Se estiver presente, essa ferramenta será "Fixada" e usará os valores do snapshot como substitutos se o servidor ficar temporariamente indisponível ou se não houver uma substituição. |
McpToolDefinition
| Representação JSON |
|---|
{ "description": string, "inputSchema": { object ( |
| Campos | |
|---|---|
description |
Apenas saída. A descrição da ferramenta MCP. Isso pode ser substituído por |
inputSchema |
Apenas saída. O esquema dos argumentos de entrada da ferramenta MCP. |
outputSchema |
Apenas saída. O esquema dos argumentos de saída da ferramenta MCP. |
OpenApiToolset
| Representação JSON |
|---|
{ "openApiSchema": string, "apiAuthentication": { object ( |
| Campos | |
|---|---|
openApiSchema |
Obrigatório. O esquema OpenAPI do conjunto de ferramentas. |
apiAuthentication |
Opcional. Informações de autenticação exigidas pela API. |
tlsConfig |
Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços. |
ignoreUnknownFields |
Opcional. Se for verdadeiro, o agente vai ignorar campos desconhecidos na resposta da API para todas as operações definidas no esquema da OpenAPI. |
url |
Opcional. O URL do servidor do esquema de API aberta. Esse campo só é definido em conjuntos de ferramentas nas dependências do ambiente durante o processo de exportação se o esquema tiver um URL de servidor. Durante o processo de importação, se esse URL estiver presente nas dependências do ambiente e o esquema tiver o marcador de posição $env_var, ele vai substituir o marcador no esquema. |
ConnectorToolset
| Representação JSON |
|---|
{ "connection": string, "authConfig": { object ( |
| Campos | |
|---|---|
connection |
Obrigatório. O nome completo do recurso da conexão do Integration Connectors referenciada. Formato: |
authConfig |
Opcional. Configura como a autenticação é processada no Integration Connectors. Por padrão, uma autenticação de administrador é transmitida nas solicitações de API do Integration Connectors. É possível substituí-la por uma configuração de autenticação de usuário final diferente. Observação: a conexão precisa ter a substituição de autenticação ativada para especificar uma configuração de EUC aqui. Caso contrário, a criação do conjunto de ferramentas vai falhar. Consulte: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connectorActions[] |
Obrigatório. A lista de ações do conector/operações de entidade para as quais as ferramentas serão geradas. |
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_SEARCH |
O mecanismo SOLUTION_TYPE_SEARCH do app. Todos os repositórios de dados do conector adicionados ao app serão adicionados a esse mecanismo. |
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. |
RequestLocation
O local da chave de API na solicitação.
| Tipos enumerados | |
|---|---|
REQUEST_LOCATION_UNSPECIFIED |
Não especificado. Este valor não deve ser usado. |
HEADER |
Representa a chave no cabeçalho HTTP. |
QUERY_STRING |
Representa a chave na string de consulta. |
OauthGrantType
Tipos de permissões de acesso OAuth. Somente a concessão de credenciais do cliente é aceita.
| Tipos enumerados | |
|---|---|
OAUTH_GRANT_TYPE_UNSPECIFIED |
Não especificado. O padrão é CLIENT_CREDENTIAL. |
CLIENT_CREDENTIAL |
Representa o fluxo de credenciais do cliente. |
Direção
A direção da transferência.
| Tipos enumerados | |
|---|---|
DIRECTION_UNSPECIFIED |
Direção não especificada. |
PARENT_TO_CHILD |
Transferência do agente pai para o agente filho. |
CHILD_TO_PARENT |
Transferência do agente filho para o agente pai. |
OperationType
A operação a ser realizada na entidade.
| Tipos enumerados | |
|---|---|
OPERATION_TYPE_UNSPECIFIED |
Tipo de operação não especificado. Inválido. A criação/atualização da ConnectorTool vai falhar. |
LIST |
Operação de lista. |
GET |
Receber operação. |
CREATE |
Operação de criação. |
UPDATE |
Operação de atualização. |
DELETE |
Excluir operação. |
DataStoreType
O tipo do repositório de dados.
| Tipos enumerados | |
|---|---|
DATA_STORE_TYPE_UNSPECIFIED |
Não especificado. Esse valor indica que o tipo de repositório de dados não foi especificado, então ele não será usado durante a pesquisa. |
PUBLIC_WEB |
Um repositório de dados que contém conteúdo da web público. |
UNSTRUCTURED |
Um repositório de dados que contém dados privados não estruturados. |
FAQ |
Um repositório de dados que contém dados estruturados usados como perguntas frequentes. |
CONNECTOR |
Um repositório de dados que é um conector para um serviço próprio ou de terceiros. |
DocumentProcessingMode
O modo de processamento de documentos do repositório de dados.
| Tipos enumerados | |
|---|---|
DOCUMENT_PROCESSING_MODE_UNSPECIFIED |
Não especificado. |
DOCUMENTS |
Os documentos são processados como documentos. |
CHUNKS |
Os documentos são convertidos em blocos. |
AttributeType
O atributo (ou função) ao qual a classificação personalizada será aplicada.
| Tipos enumerados | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
AttributeType não especificado. |
NUMERICAL |
O valor do campo numérico será usado para atualizar dinamicamente o valor do aumento. Nesse caso, o attribute_value (o valor x) do ponto de controle será o valor real do campo numérico para o qual o boost_amount é especificado. |
FRESHNESS |
Para o caso de uso de atualização, o valor do atributo será a duração entre o horário atual e a data no campo de data e hora especificado. O valor precisa ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isso é: [nD][T[nH][nM][nS]]. Por exemplo, 5D, 3DT12H30M, T24H. |
InterpolationType
O tipo de interpolação a ser aplicado. O padrão é linear (linear por partes).
| Tipos enumerados | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
O tipo de interpolação não foi especificado. Nesse caso, o padrão é Linear. |
LINEAR |
A interpolação linear em trechos será aplicada. |
ModalityType
O tipo de modalidade.
| Tipos enumerados | |
|---|---|
MODALITY_TYPE_UNSPECIFIED |
Tipo de modalidade não especificado. |
TEXT |
Modalidade de texto. |
AUDIO |
Modalidade de áudio. |
FilterParameterBehavior
Comportamento do parâmetro de filtro.
| Tipos enumerados | |
|---|---|
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED |
Comportamento padrão do filtro. Inclua o filtro de inclusão para repositórios de dados do conector. Para os demais tipos de armazenamento de dados, o parâmetro de entrada do filtro é omitido. |
ALWAYS_INCLUDE |
Sempre inclua o filtro de inclusão para todos os tipos de repositório de dados. |
NEVER_INCLUDE |
O parâmetro de filtro nunca é incluído na lista de parâmetros de ferramenta, independentemente do tipo de repositório de dados. |
Estado
Representa o estado de disponibilidade dinâmica da ferramenta.
| Tipos enumerados | |
|---|---|
STATE_UNSPECIFIED |
Estado padrão. |
ACTIVE |
A ferramenta está disponível e é oferecida ativamente pelo servidor. |
INACTIVE |
A ferramenta está configurada ou fixada, mas não é oferecida pelo servidor no momento. |
STALE |
A ferramenta existe no servidor, mas não corresponde à versão dele. |
CorpusType
O tipo do corpus de RAG da Vertex.
| Tipos enumerados | |
|---|---|
CORPUS_TYPE_UNSPECIFIED |
Tipo de corpus não especificado. |
USER_OWNED |
O corpus é criado e pertence ao usuário. |
FULLY_MANAGED |
O corpus é criado pelo agente. |
WidgetType
Todos os tipos de widget disponíveis. Novos valores podem ser adicionados a esse tipo enumerado no futuro.
| Tipos enumerados | |
|---|---|
WIDGET_TYPE_UNSPECIFIED |
Tipo de widget não especificado. |
CUSTOM |
Tipo de widget personalizado. |
PRODUCT_CAROUSEL |
Widget de carrossel de produtos. |
PRODUCT_DETAILS |
Widget de detalhes do produto. |
QUICK_ACTIONS |
Widget de ações rápidas. |
PRODUCT_COMPARISON |
Widget de comparação de produtos. |
ADVANCED_PRODUCT_DETAILS |
Widget de detalhes do produto avançados. |
SHORT_FORM |
Widget de formato curto. |
OVERALL_SATISFACTION |
Widget de satisfação geral. |
ORDER_SUMMARY |
Widget de resumo do pedido. |
APPOINTMENT_DETAILS |
Widget de detalhes do agendamento. |
APPOINTMENT_SCHEDULER |
Widget de agendamento de horários. |
CONTACT_FORM |
Widget de formulário de contato. |
Modo
A estratégia usada para mapear dados da ferramenta de origem para o widget.
| Tipos enumerados | |
|---|---|
MODE_UNSPECIFIED |
Modo não especificado. |
FIELD_MAPPING |
Use o mapa field_mappings para transformação de dados. |
PYTHON_SCRIPT |
Use o python_script para transformação de dados. |
Tipo
Define como a resposta de texto é produzida.
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Tipo não especificado. |
NONE |
O LLM decide dinamicamente se vai gerar uma resposta de texto junto com o widget com base no contexto da conversa. |
LLM_GENERATED |
O LLM é explicitamente solicitado a gerar uma resposta de texto. |
STATIC |
Uma resposta de texto estática predefinida é sempre usada. |
ExecutionType
O tipo de execução da ferramenta ou do conjunto de ferramentas.
| Tipos enumerados | |
|---|---|
EXECUTION_TYPE_UNSPECIFIED |
O tipo de execução não foi especificado. Quando não especificado, o padrão é SYNCHRONOUS. |
SYNCHRONOUS |
A ferramenta é executada de forma síncrona. A sessão é bloqueada até que a ferramenta retorne. |
ASYNCHRONOUS |
A ferramenta é executada de forma assíncrona. A sessão vai continuar enquanto a ferramenta estiver em execução. |
MatchType
Tipo de correspondência para o filtro de conteúdo.
| Tipos enumerados | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
O tipo de correspondência não foi especificado. |
SIMPLE_STRING_MATCH |
O conteúdo é correspondido por substrings caractere por caractere. |
WORD_BOUNDARY_STRING_MATCH |
O conteúdo só será correspondente se o padrão encontrado no texto estiver cercado por delimitadores de palavras. As frases proibidas também podem conter delimitadores de palavras. |
REGEXP_MATCH |
A correspondência do conteúdo é feita usando a sintaxe de expressão regular. |
SENSITIVE_WORDS |
O conteúdo é comparado com uma lista de palavras e frases sensíveis gerenciada pelo sistema. Anexar uma proteção com esse tipo de correspondência a um app ou agente substitui o filtro padrão de palavras sensíveis para os agentes afetados. Desative a proteção para desativar o filtro padrão. |
PolicyScope
Define quando aplicar a verificação de política durante a conversa.
| Tipos enumerados | |
|---|---|
POLICY_SCOPE_UNSPECIFIED |
O escopo da política não foi especificado. |
USER_QUERY |
A verificação de política é acionada na entrada do usuário. |
AGENT_RESPONSE |
A verificação de política é acionada na resposta do agente. A aplicação desse escopo de política vai introduzir uma latência adicional antes que o agente possa responder. |
USER_QUERY_AND_AGENT_RESPONSE |
A verificação de política é acionada tanto na entrada do usuário quanto na resposta do agente. A aplicação desse escopo de política vai introduzir uma latência adicional antes que o agente possa responder. |
HarmCategory
Categoria de dano.
| Tipos enumerados | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
A categoria de danos não foi especificada. |
HARM_CATEGORY_HATE_SPEECH |
A categoria de danos é discurso de ódio. |
HARM_CATEGORY_DANGEROUS_CONTENT |
A categoria de danos é um conteúdo perigoso. |
HARM_CATEGORY_HARASSMENT |
A categoria de dano é assédio. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
A categoria de dano é conteúdo sexualmente explícito. |
HARM_CATEGORY_PROFANITY |
A categoria de dano é linguagem obscena. |
HARM_CATEGORY_TOXIC |
A categoria de dano é tóxica. |
HarmBlockThreshold
Níveis de limites baseados em probabilidade para bloqueio.
| Tipos enumerados | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
Limite de bloqueio de danos não especificado. |
BLOCK_LOW_AND_ABOVE |
Bloquear o limite inferior e superior (ou seja, bloquear mais). |
BLOCK_MEDIUM_AND_ABOVE |
Bloquear o limite médio e acima. |
BLOCK_ONLY_HIGH |
Bloquear apenas o limite superior (ou seja, bloquear menos). |
BLOCK_NONE |
Bloquear nenhum |
OFF |
Desative o filtro de segurança. |
Tipo
Tipo de supervisor.
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Tipo não especificado. |
INVALID_TEXT |
Tipo de problema de texto inválido. |
LANGUAGE_SHIFT |
Tipo de problema de mudança de idioma. |
SPEAKER_SHIFT |
Tipo de problema de mudança de locutor. |
AUDIO_MISMATCH |
Tipo de problema de incompatibilidade de áudio. |
MISSING_TOOL_CALL |
Tipo de problema de chamada de ferramenta ausente. |
CUSTOM |
Tipo de problema personalizado. |
CHOPPY_AUDIO |
Tipo de problema de áudio entrecortado. |
PROFANITY |
Tipo de problema de linguagem obscena do agente. |
DetectionMode
Modo de detecção do supervisor.
| Tipos enumerados | |
|---|---|
DETECTION_MODE_UNSPECIFIED |
O modo de detecção não foi especificado. O padrão é NON_BLOCKING. |
NON_BLOCKING |
Modo de detecção sem bloqueio. A resposta não é bloqueada quando a detecção do supervisor está em andamento. |
BLOCKING |
Modo de detecção de bloqueio. A resposta é bloqueada quando a detecção do supervisor está em andamento. |
Esquema de saída
No Pacote de engajamento do cliente (CES), uma versão do app é um snapshot dele em um momento específico. Ele é imutável e não pode ser modificado depois de criado.
AppVersion
| Representação JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"creator": string,
"createTime": string,
"updateTime": string,
"snapshot": {
object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo da versão do app. Formato: |
displayName |
Opcional. O nome de exibição da versão do app. |
description |
Opcional. A descrição da versão do app. |
creator |
Apenas saída. E-mail do usuário que criou a versão do app. |
createTime |
Apenas saída. Carimbo de data/hora de quando a versão do app foi criada. 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: |
updateTime |
Apenas saída. Carimbo de data/hora da última atualização da versão do app. 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: |
snapshot |
Apenas saída. O snapshot do app quando a versão é criada. |
etag |
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. |
Carimbo de data/hora
| Representação JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Campos | |
|---|---|
seconds |
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 |
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. |
AppSnapshot
| Representação JSON |
|---|
{ "app": { object ( |
| Campos | |
|---|---|
app |
Opcional. As configurações básicas do app. |
agents[] |
Opcional. Lista de agentes no app. |
tools[] |
Opcional. Lista de ferramentas no app. |
examples[] |
Opcional. Lista de exemplos no app. |
guardrails[] |
Opcional. Lista de proteções no app. |
toolsets[] |
Opcional. Lista de conjuntos de ferramentas no app. |
App
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo do app. Formato: |
displayName |
Obrigatório. Nome de exibição do app. |
description |
Opcional. Descrição legível do app. |
pinned |
Opcional. Se o app está fixado na lista de apps. |
rootAgent |
Opcional. O agente raiz é o ponto de entrada do app. Formato: |
languageSettings |
Opcional. Configurações de idioma do app. |
timeZoneSettings |
Opcional. Configurações de fuso horário do app. |
audioProcessingConfig |
Opcional. Configuração de processamento de áudio do app. |
loggingSettings |
Opcional. Configurações de registro do app. |
errorHandlingSettings |
Opcional. Configurações de tratamento de erros do app. |
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 |
Opcional. O modo de execução da ferramenta para o app. Se não for fornecido, o padrão será PARALLEL. |
evaluationMetricsThresholds |
Opcional. Os limites de avaliação do app. |
variableDeclarations[] |
Opcional. As declarações das variáveis. |
predefinedVariableDeclarations[] |
Apenas saída. As declarações de variáveis predefinidas para o app. |
globalInstruction |
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[] |
Opcional. Lista de proteções para o app. Formato: |
dataStoreSettings |
Opcional. As configurações do repositório de dados do app. |
defaultChannelProfile |
Opcional. O perfil de canal padrão usado pelo app. |
metadata |
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 |
createTime |
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: |
updateTime |
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: |
etag |
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 |
Apenas saída. Número de implantações no app. |
clientCertificateSettings |
Opcional. As configurações padrão do certificado do cliente para o app. |
vpcScSettings |
Opcional. Configurações do VPC-SC para o app. |
locked |
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[] |
Apenas saída. Configurações incorretas ou avisos no app. |
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 |
Opcional. O código de idioma padrão do app. |
supportedLanguageCodes[] |
Opcional. Lista de códigos de idiomas compatíveis com o app, além do |
enableMultilingualSupport |
Opcional. Ativa o suporte multilíngue. Se for |
fallbackAction |
Opcional. Descontinuado: este recurso não é mais compatível. Use 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 |
TimeZoneSettings
| Representação JSON |
|---|
{ "timeZone": string } |
| Campos | |
|---|---|
timeZone |
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 ( |
| Campos | |
|---|---|
synthesizeSpeechConfigs |
Opcional. Configuração de como a resposta do agente deve ser sintetizada, mapeando o código de idioma para 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 |
bargeInConfig |
Opcional. Configura o comportamento do agente para as atividades de interrupção do usuário. |
inactivityTimeout |
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 " |
ambientSoundConfig |
Opcional. Configuração do som ambiente a ser reproduzido com a resposta sintetizada do agente para melhorar a naturalidade da conversa. |
customVoiceSamples[] |
Opcional. Configura amostras de voz personalizadas para clonagem de voz. |
SynthesizeSpeechConfigsEntry
| Representação JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campos | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| Representação JSON |
|---|
{ "voice": string, "speakingRate": number, "model": string, "instruction": string } |
| Campos | |
|---|---|
voice |
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 |
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 |
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 |
Opcional. A instrução usada para sintetizar a fala ao usar um modelo generativo. |
BargeInConfig
| Representação JSON |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| Campos | |
|---|---|
disableBargeIn |
Opcional. Descontinuado: o uso de 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 |
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 |
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 |
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 |
AmbientSoundConfig
| Representação JSON |
|---|
{ "volumeGainDb": number, // Union field |
| Campos | |
|---|---|
volumeGainDb |
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 |
Opcional. Descontinuado: o uso de |
gcsUri |
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 |
prebuiltAmbientSound |
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 ( |
| Campos | |
|---|---|
name |
Opcional. O nome definido pelo usuário para a amostra de voz personalizada. |
voiceSampleGcsUri |
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 |
Opcional. Áudio de consentimento para clonagem de voz. |
voiceInstruction |
Opcional. Instruções em linguagem natural para estilo, tom, ritmo ou pronúncia da voz. |
previewAudioContent |
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 |
Opcional. Texto para sintetizar o áudio de prévia da voz personalizada. |
warnings[] |
Apenas saída. Mensagens de aviso encontradas durante o processamento da clonagem de voz (por exemplo, nível de áudio baixo). |
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 ( |
| Campos | |
|---|---|
message |
Apenas saída. Uma descrição legível por humanos do aviso. |
type |
Apenas saída. O tipo do aviso. |
LoggingSettings
| Representação JSON |
|---|
{ "redactionConfig": { object ( |
| Campos | |
|---|---|
redactionConfig |
Opcional. Configuração de como os dados sensíveis devem ser encobertos. |
audioRecordingConfig |
Opcional. Configuração de como as interações de áudio devem ser gravadas. O áudio está sujeito à edição conforme configurado em |
unredactedAudioRecordingConfig |
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 é |
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 |
unredactedBigqueryExportSettings |
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 |
Opcional. Configurações para descrever os comportamentos do Cloud Logging para o app. |
conversationLoggingSettings |
Opcional. Configurações para descrever os comportamentos de registro de conversas do app. |
evaluationAudioRecordingConfig |
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 |
Opcional. Configurações para descrever os comportamentos de coleta de dados de conversas para o pipeline de análise de LLM do app. |
requiredRecordingConsent |
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 Quando |
RedactionConfig
| Representação JSON |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| Campos | |
|---|---|
enableRedaction |
Opcional. Se for |
inspectTemplate |
Opcional. Nome do modelo de inspeção da DLP para configurar a detecção de tipos de dados sensíveis. Formato: |
deidentifyTemplate |
Opcional. Nome do modelo de desidentificação da DLP para instruir sobre como desidentificar o conteúdo. Formato: |
AudioRecordingConfig
| Representação JSON |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| Campos | |
|---|---|
gcsBucket |
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 |
gcsPathPrefix |
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 |
BigQueryExportSettings
| Representação JSON |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| Campos | |
|---|---|
enabled |
Opcional. Indica se o BigQuery Export está ativado. |
project |
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 |
dataset |
Opcional. O ID do conjunto de dados do BigQuery para exportar os dados. |
CloudLoggingSettings
| Representação JSON |
|---|
{ "enableCloudLogging": boolean } |
| Campos | |
|---|---|
enableCloudLogging |
Opcional. Se o Cloud Logging deve ser ativado para as sessões. |
ConversationLoggingSettings
| Representação JSON |
|---|
{ "disableConversationLogging": boolean, "retentionWindow": string } |
| Campos | |
|---|---|
disableConversationLogging |
Opcional. Se o registro de conversas deve ser desativado para as sessões. |
retentionWindow |
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 " |
MetricAnalysisSettings
| Representação JSON |
|---|
{ "llmMetricsOptedOut": boolean } |
| Campos | |
|---|---|
llmMetricsOptedOut |
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 ( |
| Campos | |
|---|---|
errorHandlingStrategy |
Opcional. A estratégia a ser usada para o tratamento de erros. |
fallbackResponseConfig |
Opcional. Configuração para processar respostas de fallback. |
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 |
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 |
maxFallbackAttempts |
Opcional. O número máximo de tentativas de substituição antes que o agente emita o sinal |
CustomFallbackMessagesEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
EndSessionConfig
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união
|
|
escalateSession |
Opcional. Se a sessão deve ser encaminhada em |
ModelSettings
| Representação JSON |
|---|
{ "model": string, "thinkingLevel": enum ( |
| Campos | |
|---|---|
model |
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 |
Opcional. O nível de raciocínio do modelo. |
Campo de união
|
|
temperature |
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 ( |
| Campos | |
|---|---|
goldenEvaluationMetricsThresholds |
Opcional. Os limites das métricas de avaliação de ouro. |
hallucinationMetricBehavior |
Opcional. Descontinuado: use |
goldenHallucinationMetricBehavior |
Opcional. O comportamento da métrica de alucinação para avaliações de referência. |
scenarioHallucinationMetricBehavior |
Opcional. O comportamento da métrica de alucinação para avaliações de cenário. |
GoldenEvaluationMetricsThresholds
| Representação JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| Campos | |
|---|---|
turnLevelMetricsThresholds |
Opcional. Os limites das métricas no nível da rodada. |
expectationLevelMetricsThresholds |
Opcional. Os limites de métricas do nível de expectativa. |
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 ( |
| Campos | |
|---|---|
semanticSimilarityChannel |
Opcional. O canal de semelhança semântica a ser usado para avaliação. |
Campo de união
|
|
semanticSimilaritySuccessThreshold |
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
|
|
overallToolInvocationCorrectnessThreshold |
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 |
| Campos | |
|---|---|
Campo de união
|
|
toolInvocationParameterCorrectnessThreshold |
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 ( |
| Campos | |
|---|---|
extraToolCallBehavior |
Opcional. Comportamento para chamadas de ferramentas extras. O padrão é FAIL. |
VariableDeclaration
| Representação JSON |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| Campos | |
|---|---|
name |
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 |
Obrigatório. A descrição da variável. |
schema |
Obrigatório. O esquema da variável. |
Esquema
| Representação JSON |
|---|
{ "type": enum ( |
| Campos | |
|---|---|
type |
Obrigatório. O tipo dos dados. |
properties |
Opcional. Propriedades de Type.OBJECT. Um objeto com uma lista de pares |
required[] |
Opcional. Propriedades obrigatórias de Type.OBJECT. |
description |
Opcional. A descrição dos dados. |
items |
Opcional. Esquema dos elementos de Type.ARRAY. |
nullable |
Opcional. Indica se o valor pode ser nulo. |
uniqueItems |
Opcional. Indica que os itens na matriz precisam ser exclusivos. Aplica-se apenas a TYPE.ARRAY. |
prefixItems[] |
Opcional. Esquemas de elementos iniciais de Type.ARRAY. |
additionalProperties |
Opcional. Pode ser um booleano ou um objeto, controla a presença de outras propriedades. |
anyOf[] |
Opcional. O valor precisa ser validado em relação a qualquer um (ou mais) dos subesquemas na lista. |
enum[] |
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 |
Opcional. Valor padrão dos dados. |
ref |
Opcional. Permite referências indiretas entre nós de esquema. O valor precisa ser uma referência válida a um filho da raiz Por exemplo, o esquema a seguir define uma referência a um nó de esquema chamado "Pet": 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 |
Opcional. Um mapa de definições para uso por Um objeto com uma lista de pares |
title |
Opcional. O título do esquema. |
minItems |
Opcional. Número mínimo de elementos para Type.ARRAY. |
maxItems |
Opcional. Número máximo de elementos para Type.ARRAY. |
Campo de união
|
|
minimum |
Opcional. Valor mínimo para Type.INTEGER e Type.NUMBER. |
Campo de união
|
|
maximum |
Opcional. Valor máximo para Type.INTEGER e Type.NUMBER. |
PropertiesEntry
| Representação JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campos | |
|---|---|
key |
|
value |
|
Valor
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união kind. O tipo de valor. kind pode ser apenas de um dos tipos a seguir: |
|
nullValue |
Representa um |
numberValue |
Representa um número JSON. Não pode ser |
stringValue |
Representa uma string JSON. |
boolValue |
Representa um booleano JSON (literal |
structValue |
Representa um objeto JSON. |
listValue |
Representa uma matriz JSON. |
Struct
| Representação JSON |
|---|
{ "fields": { string: value, ... } } |
| Campos | |
|---|---|
fields |
Mapa não ordenado de valores digitados dinamicamente. Um objeto com uma lista de pares |
FieldsEntry
| Representação JSON |
|---|
{ "key": string, "value": value } |
| Campos | |
|---|---|
key |
|
value |
|
ListValue
| Representação JSON |
|---|
{ "values": [ value ] } |
| Campos | |
|---|---|
values[] |
Campo repetido de valores digitados dinamicamente. |
DefsEntry
| Representação JSON |
|---|
{
"key": string,
"value": {
object ( |
| Campos | |
|---|---|
key |
|
value |
|
DataStoreSettings
| Representação JSON |
|---|
{
"engines": [
{
object ( |
| Campos | |
|---|---|
engines[] |
Apenas saída. Os mecanismos do app. |
Mecanismo
| Representação JSON |
|---|
{
"name": string,
"type": enum ( |
| Campos | |
|---|---|
name |
Apenas saída. O nome do recurso do mecanismo. Formato: |
type |
Apenas saída. O tipo de mecanismo. |
ChannelProfile
| Representação JSON |
|---|
{ "profileId": string, "channelType": enum ( |
| Campos | |
|---|---|
profileId |
Opcional. O identificador exclusivo do perfil do canal. |
channelType |
Opcional. O tipo do perfil do canal. |
personaProperty |
Opcional. A propriedade de persona do perfil do canal. |
webWidgetConfig |
Opcional. A configuração do widget da Web. |
whatsappConfig |
Opcional. Configuração específica para implantações do WhatsApp. |
instagramConfig |
Opcional. Configuração específica para implantações do Instagram. |
Campo de união
|
|
disableDtmf |
Opcional. Se a DTMF (frequência múltipla de dois tons) deve ser desativada. |
Campo de união
|
|
disableBargeInControl |
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
|
|
noiseSuppressionLevel |
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 ( |
| Campos | |
|---|---|
persona |
Opcional. A persona do canal. |
WebWidgetConfig
| Representação JSON |
|---|
{ "modality": enum ( |
| Campos | |
|---|---|
modality |
Opcional. A modalidade do widget da Web. |
theme |
Opcional. O tema do widget da Web. |
webWidgetTitle |
Opcional. O título do widget da Web. |
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 |
Opcional. Indica se o acesso público ao widget da Web está ativado. Se for |
enableOriginCheck |
Opcional. Indica se a verificação de origem do widget da Web está ativada. Se for |
allowedOrigins[] |
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 |
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 |
Obrigatório. O ID da conta do WhatsApp Business. |
phoneNumberId |
Obrigatório. O ID do número de telefone da Meta. |
phoneNumber |
Opcional. O número de telefone no formato E.164. |
displayName |
Apenas saída. O nome da página comercial da Meta que foi buscado. |
thumbnailUrl |
Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado. |
description |
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 |
Obrigatório. O ID da conta do Instagram. |
displayName |
Apenas saída. O nome da página comercial da Meta que foi buscado. |
thumbnailUrl |
Apenas saída. O URL da miniatura do perfil comercial da Meta que foi buscado. |
description |
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 |
|
value |
|
ClientCertificateSettings
| Representação JSON |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| Campos | |
|---|---|
tlsCertificate |
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 |
Obrigatório. O nome do recurso da versão do secret do SecretManager que armazena a chave privada codificada no formato PEM. Formato: |
passphrase |
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: |
VpcScSettings
| Representação JSON |
|---|
{ "allowedOrigins": [ string ] } |
| Campos | |
|---|---|
allowedOrigins[] |
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 |
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: |
Agente
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "modelSettings": { object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo do agente. Formato: |
displayName |
Obrigatório. Nome de exibição do agente. |
description |
Opcional. Descrição do agente legível por humanos. |
modelSettings |
Opcional. Configurações do modelo de LLM. |
instruction |
Opcional. Instruções para o modelo de LLM orientar o comportamento do agente. |
tools[] |
Opcional. Lista de ferramentas disponíveis para o agente. Formato: |
childAgents[] |
Opcional. Lista de agentes filhos na árvore de agentes. Formato: |
beforeAgentCallbacks[] |
Opcional. Os callbacks a serem executados antes que o agente seja chamado. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
afterAgentCallbacks[] |
Opcional. Os callbacks que serão executados depois que o agente for chamado. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
beforeModelCallbacks[] |
Opcional. Os callbacks a serem executados antes que o modelo seja chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
afterModelCallbacks[] |
Opcional. Os callbacks a serem executados depois que o modelo é chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
beforeToolCallbacks[] |
Opcional. Os callbacks a serem executados antes que a ferramenta seja invocada. Se houver várias invocações de ferramentas, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
afterToolCallbacks[] |
Opcional. Os callbacks que serão executados depois que a ferramenta for invocada. Se houver várias invocações de ferramentas, o callback será executado várias vezes. Os callbacks fornecidos são executados sequencialmente na ordem exata em que são fornecidos na lista. Se um callback retornar uma resposta substituída, a execução será interrompida e os callbacks restantes serão ignorados. |
createTime |
Apenas saída. Carimbo de data/hora em que o agente 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: |
updateTime |
Apenas saída. Carimbo de data/hora em que o agente 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: |
guardrails[] |
Opcional. Lista de proteções para o agente. Formato: |
etag |
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. |
toolsets[] |
Opcional. Lista de conjuntos de ferramentas para o agente. |
generatedSummary |
Apenas saída. Se o agente for gerado pelo assistente de LLM, esse campo vai conter um resumo descritivo da geração. |
transferRules[] |
Opcional. Regras de transferência de agentes. Se houver várias regras correspondentes, a primeira da lista será usada. |
validationErrors[] |
Apenas saída. Configurações incorretas ou erros no agente que podem afetar a qualidade dele. |
Campo de união agent_type. O tipo de agente. agent_type pode ser apenas de um dos tipos a seguir: |
|
llmAgent |
Opcional. O tipo de agente padrão. |
remoteDialogflowAgent |
Opcional. O agente remoto do Dialogflow que será usado para a execução do agente. Se esse campo for definido, todas as outras propriedades no nível do agente serão ignoradas. Observação: se o agente do Dialogflow estiver em um projeto diferente do app, conceda |
remoteA2aAgent |
Opcional. O agente A2A remoto que será usado para a execução do agente. |
RemoteDialogflowAgent
| Representação JSON |
|---|
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean, "languageCodeVariable": string } |
| Campos | |
|---|---|
agent |
Obrigatório. O nome do recurso do agente do Dialogflow. Formato: |
flowId |
Opcional. O ID do fluxo no agente do Dialogflow. |
environmentId |
Opcional. O ID do ambiente do agente do Dialogflow que será usado para a execução do agente. Se não for especificado, o ambiente de rascunho será usado. |
inputVariableMapping |
Opcional. O mapeamento dos nomes das variáveis do app para os nomes dos parâmetros de sessão do Dialogflow que serão enviados ao agente do Dialogflow como entrada. Um objeto com uma lista de pares |
outputVariableMapping |
Opcional. O mapeamento dos nomes dos parâmetros de sessão do Dialogflow para os nomes das variáveis do app que serão enviadas de volta ao agente do CES após o término da execução do agente do Dialogflow. Um objeto com uma lista de pares |
respectResponseInterruptionSettings |
Opcional. Indica se as configurações de interrupção no nível da mensagem definidas no agente do Dialogflow devem ser respeitadas.
|
languageCodeVariable |
Opcional. O nome da variável que contém o código do idioma a ser usado na sessão do Dialogflow. Se não for especificado, o código de idioma padrão do agente do Dialogflow será usado. |
InputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
RemoteA2aAgent
| Representação JSON |
|---|
{
"a2aConfig": {
object ( |
| Campos | |
|---|---|
a2aConfig |
Obrigatório. A configuração da conexão A2A. |
RemoteA2aConfig
| Representação JSON |
|---|
{ "apiAuthentication": { object ( |
| Campos | |
|---|---|
apiAuthentication |
Opcional. Configuração de autenticação para chamar o agente remoto. Opcional se a referência do registro já processar a autenticação. |
inputVariableMapping |
Opcional. Mapeamento de nomes de variáveis de entrada do agente remoto para nomes de variáveis do GECX. Um objeto com uma lista de pares |
outputVariableMapping |
Opcional. Mapeamento de nomes de variáveis de saída do agente remoto para nomes de variáveis do GECX. Um objeto com uma lista de pares |
streamingEnabled |
Opcional. Se o streaming está ativado para o agente remoto. |
contextId |
Opcional. Se não estiver vazio, as interações com o agente A2A remoto vão usar esse ID de contexto. Esse campo context_id pode se referir a uma variável de sessão como |
Campo de união agent_spec. Especificação do agente remoto. agent_spec pode ser apenas de um dos tipos a seguir: |
|
agentCard |
Opcional. O card completo do agente definido inline. |
agentRegistry |
Opcional. Referência ao agente no Agent Registry. Formato: |
AgentCard
| Representação JSON |
|---|
{ "name": string, "description": string, "supportedInterfaces": [ { object ( |
| Campos | |
|---|---|
name |
Obrigatório. Um nome do agente legível por humanos. |
description |
Obrigatório. Uma descrição do domínio de ação/espaço de solução do agente. |
supportedInterfaces[] |
Obrigatório. Lista ordenada de interfaces compatíveis. A primeira entrada é preferencial. |
version |
Obrigatório. A versão do agente. |
skills[] |
Obrigatório. As habilidades representam uma unidade de capacidade que um agente pode realizar. Isso pode parecer um pouco abstrato, mas representa um conjunto mais focado de ações que o agente tem grande probabilidade de realizar com sucesso. |
AgentInterface
| Representação JSON |
|---|
{ "url": string, "protocolBinding": string, "tenant": string, "protocolVersion": string } |
| Campos | |
|---|---|
url |
Obrigatório. O URL em que essa interface está disponível. Precisa ser um URL HTTPS absoluto válido em produção. Exemplo: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" |
protocolBinding |
Obrigatório. A vinculação de protocolo compatível com este URL. Essa é uma string de formato aberto, que pode ser facilmente estendida para outras vinculações de protocolo. Os principais oficialmente compatíveis são |
tenant |
ID do locatário a ser usado na solicitação ao chamar o agente. |
protocolVersion |
Obrigatório. A versão do protocolo A2A que essa interface expõe. Use a versão secundária mais recente compatível por versão principal. Exemplos: "0.3", "1.0" |
AgentSkill
| Representação JSON |
|---|
{ "id": string, "name": string, "description": string, "tags": [ string ], "examples": [ string ], "inputModes": [ string ], "outputModes": [ string ] } |
| Campos | |
|---|---|
id |
Obrigatório. Um identificador exclusivo para a habilidade do agente. |
name |
Obrigatório. Um nome legível por humanos para a habilidade. |
description |
Obrigatório. Uma descrição detalhada da habilidade. |
tags[] |
Obrigatório. Um conjunto de palavras-chave que descrevem as capacidades da habilidade. |
examples[] |
Exemplos de comandos ou cenários que essa habilidade pode processar. |
inputModes[] |
O conjunto de tipos de mídia de entrada compatíveis com essa habilidade, que substitui os padrões do agente. |
outputModes[] |
O conjunto de tipos de mídia de saída compatíveis com essa habilidade, que substitui os padrões do agente. |
ApiAuthentication
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união auth_config. A configuração de autenticação. auth_config pode ser apenas de um dos tipos a seguir: |
|
apiKeyConfig |
Opcional. Configuração para autenticação de chave de API. |
oauthConfig |
Opcional. Configuração do OAuth. |
serviceAgentIdTokenAuthConfig |
Opcional. Configuração para autenticação de token de ID gerada pelo agente de serviço do CES. |
serviceAccountAuthConfig |
Opcional. Configuração para autenticação de conta de serviço. |
bearerTokenConfig |
Opcional. Configuração para autenticação de token do portador. |
ApiKeyConfig
| Representação JSON |
|---|
{
"keyName": string,
"apiKeySecretVersion": string,
"requestLocation": enum ( |
| Campos | |
|---|---|
keyName |
Obrigatório. O nome do parâmetro ou do cabeçalho da chave de API. Por exemplo, Se a solicitação de API for "https://example.com/act?X-Api-Key= |
apiKeySecretVersion |
Obrigatório. O nome do recurso da versão do secret do Secret Manager que armazena a chave de API. Formato: Observação: conceda o papel |
requestLocation |
Obrigatório. Local da chave na solicitação. |
OAuthConfig
| Representação JSON |
|---|
{
"oauthGrantType": enum ( |
| Campos | |
|---|---|
oauthGrantType |
Obrigatório. Tipos de permissões de acesso OAuth. |
clientId |
Obrigatório. O ID do cliente do provedor OAuth. |
clientSecretVersion |
Obrigatório. O nome do recurso da versão do secret do Secret Manager que armazena a chave secreta do cliente. Formato: Observação: conceda o papel |
tokenEndpoint |
Obrigatório. O endpoint de token no provedor OAuth para trocar por um token de acesso. |
scopes[] |
Opcional. Os escopos do OAuth a serem concedidos. |
ServiceAccountAuthConfig
| Representação JSON |
|---|
{ "serviceAccount": string, "scopes": [ string ] } |
| Campos | |
|---|---|
serviceAccount |
Obrigatório. O endereço de e-mail da conta de serviço usada para autenticação. O CES usa essa conta de serviço para trocar um token de acesso, que é enviado no cabeçalho A conta de serviço precisa ter o papel |
scopes[] |
Opcional. Os escopos do OAuth a serem concedidos. Se não for especificado, o escopo padrão |
BearerTokenConfig
| Representação JSON |
|---|
{ "token": string } |
| Campos | |
|---|---|
token |
Obrigatório. O token do portador. Precisa estar no formato |
InputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
Callback
| Representação JSON |
|---|
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field |
| Campos | |
|---|---|
description |
Opcional. Descrição legível por humanos do callback. |
disabled |
Opcional. Se o callback está desativado. Os callbacks desativados são ignorados pelo agente. |
proactiveExecutionEnabled |
Opcional. Se ativado, o callback também será executado em saídas de modelo intermediárias. Essa configuração afeta apenas a chamada de retorno "After model". ATIVE COM CUIDADO. Normalmente, a chamada de retorno after_model_callback só precisa ser executada depois de receber todas as respostas do modelo. A ativação da execução proativa pode ter implicações negativas no custo e na latência da execução e só deve ser ativada em situações raras. |
Campo de união callback. O callback a ser executado. callback pode ser apenas de um dos tipos a seguir: |
|
pythonCode |
Obrigatório. O código Python a ser executado para o callback. |
AgentToolset
| Representação JSON |
|---|
{ "toolset": string, "toolIds": [ string ] } |
| Campos | |
|---|---|
toolset |
Obrigatório. O nome do recurso do conjunto de ferramentas. Formato: |
toolIds[] |
Opcional. Os IDs das ferramentas para filtrar o conjunto de ferramentas. |
TransferRule
| Representação JSON |
|---|
{ "childAgent": string, "direction": enum ( |
| Campos | |
|---|---|
childAgent |
Obrigatório. O nome do recurso do agente filho ao qual a regra se aplica. Formato: |
direction |
Obrigatório. A direção da transferência. |
Campo de união rule_type. O tipo de regra. rule_type pode ser apenas de um dos tipos a seguir: |
|
deterministicTransfer |
Opcional. Uma regra que transfere imediatamente para o agente de destino quando a condição é atendida. |
disablePlannerTransfer |
Opcional. Regra que impede o planejador de transferir para o agente de destino. |
DeterministicTransfer
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união condition_type. A condição a ser avaliada. condition_type pode ser apenas de um dos tipos a seguir: |
|
expressionCondition |
Opcional. Uma regra que avalia uma condição de estado da sessão. Se a condição for avaliada como verdadeira, a transferência vai ocorrer. |
pythonCodeCondition |
Opcional. Uma regra que usa um bloco de código Python para avaliar as condições. Se a condição for avaliada como verdadeira, a transferência vai ocorrer. |
ExpressionCondition
| Representação JSON |
|---|
{ "expression": string } |
| Campos | |
|---|---|
expression |
Obrigatório. A representação de string da condição cloud.api.Expression. |
PythonCodeCondition
| Representação JSON |
|---|
{ "pythonCode": string } |
| Campos | |
|---|---|
pythonCode |
Obrigatório. O código Python a ser executado. |
DisablePlannerTransfer
| Representação JSON |
|---|
{
"expressionCondition": {
object ( |
| Campos | |
|---|---|
expressionCondition |
Obrigatório. Se a condição for avaliada como verdadeira, o planejador não poderá transferir para o agente de destino. |
Ferramenta
| Representação JSON |
|---|
{ "name": string, "displayName": string, "executionType": enum ( |
| Campos | |
|---|---|
name |
Identificador. O nome do recurso da ferramenta. Formato:
Essas ferramentas são dinâmicas e somente de saída. Elas não podem ser referenciadas diretamente onde uma ferramenta é esperada. |
displayName |
Apenas saída. O nome de exibição da ferramenta, derivado com base no tipo dela. Por exemplo, o nome de exibição de uma [ClientFunction][Tool.ClientFunction] é derivado da propriedade |
executionType |
Opcional. O tipo de execução da ferramenta. |
timeout |
Opcional. O tempo limite para a execução da ferramenta. Se não for definido, o tempo limite padrão será de 30 segundos para ferramentas Duração em segundos com até nove dígitos fracionários, terminando em " |
createTime |
Apenas saída. Carimbo de data/hora de quando a ferramenta foi criada. 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: |
updateTime |
Apenas saída. Carimbo de data/hora de quando a ferramenta foi atualizada 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: |
etag |
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. |
generatedSummary |
Apenas saída. Se a ferramenta for gerada pelo assistente de LLM, esse campo vai conter um resumo descritivo da geração. |
toolFakeConfig |
Opcional. Configuração do comportamento da ferramenta no modo simulado. |
readOnly |
Apenas saída. Indica se a ferramenta é somente leitura. Se for verdadeiro, a ferramenta não poderá ser modificada pelo usuário. |
Campo de união tool_type. O tipo da ferramenta. tool_type pode ser apenas de um dos tipos a seguir: |
|
clientFunction |
Opcional. A função do cliente. |
openApiTool |
Opcional. A ferramenta de API aberta. |
googleSearchTool |
Opcional. A ferramenta Pesquisa Google. |
connectorTool |
Opcional. A ferramenta Integration Connectors. |
dataStoreTool |
Opcional. A ferramenta do repositório de dados. |
pythonFunction |
Opcional. A ferramenta de função do Python. |
mcpTool |
Opcional. A ferramenta MCP. Uma ferramenta do MCP não pode ser criada ou atualizada diretamente e é gerenciada pelo conjunto de ferramentas do MCP. |
fileSearchTool |
Opcional. A ferramenta de pesquisa de arquivos. |
systemTool |
Opcional. A ferramenta do sistema. |
agentTool |
Opcional. A ferramenta do agente. |
widgetTool |
Opcional. A ferramenta de widget. |
remoteAgentTool |
Opcional. A ferramenta de agente remoto. |
ClientFunction
| Representação JSON |
|---|
{ "name": string, "description": string, "parameters": { object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da função. |
description |
Opcional. A descrição da função. |
parameters |
Opcional. O esquema dos parâmetros da função. |
response |
Opcional. O esquema da resposta da função. |
OpenApiTool
| Representação JSON |
|---|
{ "openApiSchema": string, "name": string, "description": string, "apiAuthentication": { object ( |
| Campos | |
|---|---|
openApiSchema |
Obrigatório. O esquema OpenAPI no formato JSON ou YAML. |
name |
Opcional. O nome da ferramenta. Se não for fornecido, o nome da ferramenta será derivado do esquema OpenAPI, de |
description |
Opcional. A descrição da ferramenta. Se não for fornecida, a descrição da ferramenta será derivada do esquema OpenAPI, de |
apiAuthentication |
Opcional. Informações de autenticação exigidas pela API. |
tlsConfig |
Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente vai confiar. |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços. |
ignoreUnknownFields |
Opcional. Se for verdadeiro, o agente vai ignorar campos desconhecidos na resposta da API. |
url |
Opcional. O URL do servidor do esquema de API aberta. Esse campo só é definido em ferramentas nas dependências do ambiente durante o processo de exportação se o esquema tiver um URL de servidor. Durante o processo de importação, se esse URL estiver presente nas dependências do ambiente e o esquema tiver o marcador de posição $env_var, ele vai substituir o marcador no esquema. |
TlsConfig
| Representação JSON |
|---|
{
"caCerts": [
{
object ( |
| Campos | |
|---|---|
caCerts[] |
Obrigatório. Especifica uma lista de certificados de CA personalizados permitidos para verificação de HTTPS. |
CaCert
| Representação JSON |
|---|
{ "displayName": string, "cert": string } |
| Campos | |
|---|---|
displayName |
Obrigatório. O nome dos certificados de CA personalizados permitidos. Isso pode ser usado para eliminar a ambiguidade dos certificados de CA personalizados. |
cert |
Obrigatório. Os certificados de CA personalizados permitidos (no formato DER) para verificação de HTTPS. Isso substitui o repositório de confiança SSL padrão. Se esse campo estiver vazio ou não for especificado, o CES vai usar o repositório de confiança padrão do Google para verificar os certificados. Observação: verifique se os certificados do servidor HTTPS estão assinados com "nome alternativo do assunto". Por exemplo, um certificado pode ser autoassinado usando o seguinte comando: Uma string codificada em base64. |
ServiceDirectoryConfig
| Representação JSON |
|---|
{ "service": string } |
| Campos | |
|---|---|
service |
Obrigatório. O nome do serviço do Diretório de Serviços. Formato: |
GoogleSearchTool
| Representação JSON |
|---|
{
"name": string,
"description": string,
"contextUrls": [
string
],
"preferredDomains": [
string
],
"excludeDomains": [
string
],
"promptConfig": {
object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta. |
description |
Opcional. Descrição da finalidade da ferramenta. |
contextUrls[] |
Opcional. O conteúdo será buscado diretamente desses URLs para contexto e embasamento. Exemplo: "https://example.com/path.html". São permitidos no máximo 20 URLs. |
preferredDomains[] |
Opcional. Especifica os domínios para restringir os resultados da pesquisa. Exemplo: "example.com", "another.site". É possível especificar no máximo 20 domínios. |
excludeDomains[] |
Opcional. Lista de domínios que serão excluídos dos resultados da pesquisa. Exemplo: "example.com". É possível excluir até 2.000 domínios. |
promptConfig |
Opcional. Instruções de comando transmitidas ao planejador sobre como os resultados da pesquisa devem ser processados para texto e voz. |
PromptConfig
| Representação JSON |
|---|
{ "textPrompt": string, "voicePrompt": string } |
| Campos | |
|---|---|
textPrompt |
Opcional. Define o comando usado para as instruções do sistema ao interagir com o agente em conversas de chat. Se não for definido, o comando padrão será usado. |
voicePrompt |
Opcional. Define o comando usado para as instruções do sistema ao interagir com o agente em conversas por voz. Se não for definido, o comando padrão será usado. |
ConnectorTool
| Representação JSON |
|---|
{ "connection": string, "action": { object ( |
| Campos | |
|---|---|
connection |
Obrigatório. O nome completo do recurso da conexão do Integration Connectors referenciada. Formato: |
action |
Obrigatório. Ação que a ferramenta deve usar. |
authConfig |
Opcional. Configura como a autenticação é processada no Integration Connectors. Por padrão, uma autenticação de administrador é transmitida nas solicitações de API do Integration Connectors. É possível substituí-la por uma configuração de autenticação de usuário final diferente. Observação: a conexão precisa ter a substituição de autenticação ativada para especificar uma configuração de EUC aqui. Caso contrário, a criação da ConnectorTool vai falhar. Consulte https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override para mais detalhes. |
name |
Opcional. O nome da ferramenta que pode ser usada pelo agente para decidir se deve chamar essa ConnectorTool. |
description |
Opcional. A descrição da ferramenta que pode ser usada pelo agente para decidir se deve chamar essa ConnectorTool. |
Ação
| Representação JSON |
|---|
{ "inputFields": [ string ], "outputFields": [ string ], // Union field |
| Campos | |
|---|---|
inputFields[] |
Opcional. Campos de entidade para usar como entradas para a operação. Se nenhum campo for especificado, todos os campos da entidade serão usados. |
outputFields[] |
Opcional. Campos de entidade a serem retornados da operação. Se nenhum campo for especificado, todos os campos da entidade serão retornados. |
Campo de união action_spec. Especificação de uma ação a ser configurada para a ferramenta usar. action_spec pode ser apenas de um dos tipos a seguir: |
|
connectionActionId |
ID de uma ação de conexão para a ferramenta usar. |
entityOperation |
Configuração da operação de entidade para a ferramenta usar. |
EntityOperation
| Representação JSON |
|---|
{
"entityId": string,
"operation": enum ( |
| Campos | |
|---|---|
entityId |
Obrigatório. ID da entidade. |
operation |
Obrigatório. Operação a ser realizada na entidade. |
EndUserAuthConfig
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união auth_config. A configuração de autenticação. auth_config pode ser apenas de um dos tipos a seguir: |
|
oauth2AuthCodeConfig |
Autenticação do código de autorização do OAuth 2.0. |
oauth2JwtBearerConfig |
Autenticação de concessão de autorização do OAuth 2.0 do perfil JWT. |
Oauth2AuthCodeConfig
| Representação JSON |
|---|
{ "oauthToken": string } |
| Campos | |
|---|---|
oauthToken |
Obrigatório. Nome do parâmetro do token OAuth a ser transmitido. Precisa estar no formato |
Oauth2JwtBearerConfig
| Representação JSON |
|---|
{ "issuer": string, "subject": string, "clientKey": string } |
| Campos | |
|---|---|
issuer |
Obrigatório. Nome do parâmetro do emissor a ser transmitido. Precisa estar no formato |
subject |
Obrigatório. Nome do parâmetro de assunto a ser transmitido. Precisa estar no formato |
clientKey |
Obrigatório. Nome do parâmetro do cliente a ser transmitido. Precisa estar no formato |
DataStoreTool
| Representação JSON |
|---|
{ "name": string, "description": string, "boostSpecs": [ { object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta do repositório de dados. |
description |
Opcional. A descrição da ferramenta. |
boostSpecs[] |
Opcional. Especificação de otimização para impulsionar determinados documentos. |
modalityConfigs[] |
Opcional. As configurações de modalidade do repositório de dados. |
filterParameterBehavior |
Opcional. O comportamento do parâmetro de filtro. |
Campo de união search_source. Define a origem da pesquisa, que pode ser um único DataStore ou um Engine. search_source pode ser apenas de um dos tipos a seguir: |
|
dataStoreSource |
Opcional. Pesquise em um único DataStore específico. |
engineSource |
Opcional. Pesquise em um mecanismo (potencialmente em vários DataStores). |
DataStoreSource
| Representação JSON |
|---|
{
"filter": string,
"dataStore": {
object ( |
| Campos | |
|---|---|
filter |
Opcional. Especificação de filtro para o DataStore. Consulte: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
dataStore |
Opcional. O repositório de dados. |
DataStore
| Representação JSON |
|---|
{ "name": string, "type": enum ( |
| Campos | |
|---|---|
name |
Obrigatório. Nome completo do recurso do DataStore. Formato: |
type |
Apenas saída. O tipo do repositório de dados. Este campo é somente leitura e preenchido pelo servidor. |
documentProcessingMode |
Apenas saída. O modo de processamento de documentos para a conexão do repositório de dados. Definido apenas para repositórios de dados PUBLIC_WEB e UNSTRUCTURED. |
displayName |
Apenas saída. O nome de exibição do repositório de dados. |
createTime |
Apenas saída. O carimbo de data/hora em que o repositório de dados 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: |
connectorConfig |
Apenas saída. A configuração do conector para a conexão do repositório de dados. |
ConnectorConfig
| Representação JSON |
|---|
{ "collection": string, "collectionDisplayName": string, "dataSource": string } |
| Campos | |
|---|---|
collection |
Nome do recurso da coleção a que o repositório de dados pertence. |
collectionDisplayName |
Nome de exibição da coleção a que o repositório de dados pertence. |
dataSource |
O nome da fonte de dados. Exemplo: |
EngineSource
| Representação JSON |
|---|
{
"engine": string,
"dataStoreSources": [
{
object ( |
| Campos | |
|---|---|
engine |
Obrigatório. Nome completo do recurso do mecanismo. Formato: |
dataStoreSources[] |
Opcional. Use para segmentar DataStores específicos no mecanismo. Se estiver vazio, a pesquisa será aplicada a todos os DataStores associados ao mecanismo. |
filter |
Opcional. Um filtro aplicado à pesquisa no mecanismo. Não é relevante nem usado se "data_store_sources" for fornecido. Consulte: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
BoostSpecs
| Representação JSON |
|---|
{
"dataStores": [
string
],
"spec": [
{
object ( |
| Campos | |
|---|---|
dataStores[] |
Obrigatório. O repositório de dados em que a configuração de otimização é aplicada. Nome completo do recurso do DataStore, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
Obrigatório. Uma lista de especificações de otimização. |
BoostSpec
| Representação JSON |
|---|
{
"conditionBoostSpecs": [
{
object ( |
| Campos | |
|---|---|
conditionBoostSpecs[] |
Obrigatório. Uma lista de especificações de otimização. |
ConditionBoostSpec
| Representação JSON |
|---|
{
"condition": string,
"boost": number,
"boostControlSpec": {
object ( |
| Campos | |
|---|---|
condition |
Obrigatório. Uma expressão que especifica uma condição de otimização. A sintaxe é a mesma da expressão de filtro. No momento, a única condição aceita é uma lista de códigos de idioma BCP-47. Exemplo: para impulsionar sugestões nos idiomas en ou fr: (lang_code: ANY("en", "fr")) |
boost |
Opcional. Intensidade da otimização, que precisa estar em [-1, 1]. Reforço negativo significa rebaixamento. O padrão é 0.0. Definir como 1.0 oferece uma grande promoção às sugestões. No entanto, isso não significa necessariamente que o resultado principal será uma sugestão otimizada. Definir como -1.0 dá às sugestões um grande rebaixamento. No entanto, outras sugestões relevantes ainda podem ser mostradas. Definir como 0.0 significa que nenhuma otimização foi aplicada. A condição de otimização é ignorada. |
boostControlSpec |
Opcional. Especificação complexa para classificação personalizada com base no valor do atributo definido pelo cliente. |
BoostControlSpec
| Representação JSON |
|---|
{ "fieldName": string, "attributeType": enum ( |
| Campos | |
|---|---|
fieldName |
Opcional. O nome do campo cujo valor será usado para determinar o valor do aumento. |
attributeType |
Opcional. O tipo de atributo a ser usado para determinar o valor do aumento. O valor do atributo pode ser derivado do valor do campo do field_name especificado. No caso de valores numéricos, é simples, ou seja, attribute_value = numerical_field_value. No entanto, no caso de atualização, attribute_value = (time.now() - datetime_field_value). |
interpolationType |
Opcional. O tipo de interpolação a ser aplicado para conectar os pontos de controle listados abaixo. |
controlPoints[] |
Opcional. Os pontos de controle usados para definir a curva. A função monotônica (definida pelo interpolation_type acima) passa pelos pontos de controle listados aqui. |
ControlPoint
| Representação JSON |
|---|
{ "attributeValue": string, "boostAmount": number } |
| Campos | |
|---|---|
attributeValue |
Opcional. Pode ser um dos seguintes: 1. O valor numérico do campo. 2. A especificação de duração para atualização: o valor precisa ser formatado como um valor XSD |
boostAmount |
Opcional. O valor entre -1 e 1 para aumentar a pontuação se o attribute_value for avaliado como o valor especificado acima. |
ModalityConfig
| Representação JSON |
|---|
{ "modalityType": enum ( |
| Campos | |
|---|---|
modalityType |
Obrigatório. O tipo de modalidade. |
rewriterConfig |
Opcional. A configuração do reescritor. |
summarizationConfig |
Opcional. A configuração de resumo. |
groundingConfig |
Opcional. A configuração de embasamento. |
snippetsConfig |
Opcional. A configuração dos snippets. |
RewriterConfig
| Representação JSON |
|---|
{
"modelSettings": {
object ( |
| Campos | |
|---|---|
modelSettings |
Obrigatório. Configurações do modelo de LLM. |
prompt |
Opcional. A definição do comando. Se não for definido, o comando padrão será usado. |
disabled |
Opcional. Se o reescritor está desativado. |
SummarizationConfig
| Representação JSON |
|---|
{
"modelSettings": {
object ( |
| Campos | |
|---|---|
modelSettings |
Opcional. Configurações do modelo de LLM. |
prompt |
Opcional. A definição do comando. Se não for definido, o comando padrão será usado. |
disabled |
Opcional. Se a geração de resumos está desativada. |
GroundingConfig
| Representação JSON |
|---|
{ "groundingLevel": number, "disabled": boolean } |
| Campos | |
|---|---|
groundingLevel |
Opcional. O limite de embasamento da resposta com base nas fontes recuperadas. O valor tem um intervalo configurável de [1, 5]. O nível é usado para definir o limite de embasamento da resposta, o que significa que todas as respostas com uma pontuação de embasamento abaixo do limite vão retornar apenas snippets relevantes. Por exemplo, um nível de 3 significa que a pontuação de embasamento precisa ser 3 ou maior para que a resposta seja retornada. |
disabled |
Opcional. Se o embasamento está desativado. |
SnippetsConfig
| Representação JSON |
|---|
{ "enableSnippets": boolean, "maxSnippets": integer } |
| Campos | |
|---|---|
enableSnippets |
Opcional. Se os snippets estão ativados. |
maxSnippets |
Opcional. Número de snippets que serão retornados por consulta. Se não for definido, retorna todos os snippets do serviço por padrão. |
PythonFunction
| Representação JSON |
|---|
{
"name": string,
"pythonCode": string,
"description": string,
"serviceDirectoryConfig": {
object ( |
| Campos | |
|---|---|
name |
Opcional. O nome da função do Python a ser executada. Precisa corresponder a um nome de função do Python definido no código Python. Diferencia maiúsculas de minúsculas. Se o nome não for fornecido, a primeira função definida no código Python será usada. |
pythonCode |
Opcional. O código Python a ser executado para a ferramenta. |
description |
Apenas saída. A descrição da função do Python, analisada da docstring do código Python. |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços para a ferramenta. |
McpTool
| Representação JSON |
|---|
{ "name": string, "nameOverride": string, "description": string, "inputSchema": { object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta do MCP. |
nameOverride |
Opcional. A substituição do nome da ferramenta MCP. Isso será preenchido se o nome tiver sido substituído por uma substituição do Toolset. |
description |
Opcional. A descrição da ferramenta MCP. |
inputSchema |
Opcional. O esquema dos argumentos de entrada da ferramenta MCP. |
outputSchema |
Opcional. O esquema dos argumentos de saída da ferramenta MCP. |
serverAddress |
Obrigatório. O endereço do servidor MCP, por exemplo, "https://example.com/mcp/". Se o servidor for criado com o SDK do MCP, o URL precisará ter o sufixo "/mcp/". Somente servidores baseados em transporte HTTP transmissível são compatíveis. É o mesmo que server_address no McpToolset. Consulte https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para mais detalhes. |
apiAuthentication |
Opcional. Informações de autenticação necessárias para executar a ferramenta no servidor MCP. Para a autenticação de token do portador, o token se aplica apenas à execução de ferramentas, não à listagem de ferramentas. Isso exige que as ferramentas possam ser listadas sem autenticação. |
tlsConfig |
Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente deve confiar. |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços para VPC-SC, usada para resolver nomes de serviço em um perímetro. |
customHeaders |
Opcional. Os cabeçalhos personalizados que serão enviados na solicitação ao servidor MCP. Os valores precisam estar no formato Um objeto com uma lista de pares |
state |
Apenas saída. O estado de disponibilidade dinâmica da ferramenta no servidor externo. |
CustomHeadersEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
FileSearchTool
| Representação JSON |
|---|
{
"corpusType": enum ( |
| Campos | |
|---|---|
corpusType |
Opcional. O tipo do corpus. O padrão é FULLY_MANAGED. |
name |
Obrigatório. O nome da ferramenta. |
description |
Opcional. A descrição da ferramenta. |
fileCorpus |
Opcional. O corpus em que os arquivos estão armazenados. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |
SystemTool
| Representação JSON |
|---|
{ "name": string, "description": string } |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta do sistema. |
description |
Apenas saída. A descrição da ferramenta do sistema. |
AgentTool
| Representação JSON |
|---|
{ "name": string, "description": string, "agent": string } |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta do agente. |
description |
Opcional. Descrição da finalidade da ferramenta. |
agent |
Opcional. O nome do recurso do agente que é o ponto de entrada da ferramenta. Formato: |
WidgetTool
| Representação JSON |
|---|
{ "name": string, "description": string, "widgetType": enum ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome de exibição da ferramenta de widget. |
description |
Opcional. A descrição da ferramenta de widget. |
widgetType |
Opcional. O tipo da ferramenta de widget. Se não for especificado, o tipo padrão será CUSTOMIZED. |
uiConfig |
Opcional. Configuração para renderizar o widget. |
dataMapping |
Opcional. O mapeamento que define como os dados de uma ferramenta de origem são mapeados para os parâmetros de entrada do widget. |
textResponseConfig |
Opcional. Configuração para respostas de texto sempre incluídas. |
Campo de união input. A entrada da ferramenta de widget. input pode ser apenas de um dos tipos a seguir: |
|
parameters |
Opcional. Os parâmetros de entrada da ferramenta de widget. |
DataMapping
| Representação JSON |
|---|
{ "sourceToolName": string, "fieldMappings": { string: string, ... }, "pythonFunction": { object ( |
| Campos | |
|---|---|
sourceToolName |
Opcional. O nome do recurso da ferramenta que fornece os dados para o widget (por exemplo, uma ferramenta de pesquisa ou uma função personalizada). Formato: |
fieldMappings |
Opcional. Um mapa de campos de parâmetros de entrada do widget para os campos de saída correspondentes da ferramenta de origem. Um objeto com uma lista de pares |
pythonFunction |
Opcional. Configuração de uma função Python usada para transformar a saída da ferramenta de origem no formato de entrada do widget. |
mode |
Opcional. O modo do mapeamento de dados. |
pythonScript |
Descontinuado: use |
FieldMappingsEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
TextResponseConfig
| Representação JSON |
|---|
{
"type": enum ( |
| Campos | |
|---|---|
type |
Opcional. A estratégia para fornecer a resposta em texto. |
staticText |
Opcional. A resposta de texto estático a ser retornada quando o tipo é STATIC. |
textResponseInstruction |
Opcional. Instrução para o LLM sobre como gerar a resposta de texto. Usado como a descrição do parâmetro de resposta de texto se o tipo for LLM_GENERATED. |
RemoteAgentTool
| Representação JSON |
|---|
{ "name": string, "description": string, "agentCard": { object ( |
| Campos | |
|---|---|
name |
Obrigatório. O nome da ferramenta. |
description |
Obrigatório. A descrição da ferramenta. |
agentCard |
Obrigatório. O card do agente remoto que essa ferramenta invoca. |
apiAuthentication |
Opcional. Configuração de autenticação para chamar o agente remoto. |
statefulAgent |
Opcional. Quando ativada, a interação entre o app CXAS e o agente remoto vai compartilhar o mesmo contexto. Se o agente remoto retornar um context_id, ele será mantido durante toda a sessão para essa ferramenta de agente remoto. |
inputVariableMapping |
Opcional. Mapeamento de nomes de variáveis de entrada do agente remoto para nomes de variáveis do GECX. Um objeto com uma lista de pares |
outputVariableMapping |
Opcional. Mapeamento de nomes de variáveis de saída do agente remoto para nomes de variáveis do GECX. Um objeto com uma lista de pares |
InputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
ToolFakeConfig
| Representação JSON |
|---|
{ "enableFakeMode": boolean, // Union field |
| Campos | |
|---|---|
enableFakeMode |
Opcional. Se a ferramenta está usando o modo falso. |
Campo de união tool_response. A resposta é estática ou fornecida por uma função Python. tool_response pode ser apenas de um dos tipos a seguir: |
|
codeBlock |
Opcional. Bloco de código que será executado em vez de uma chamada de ferramenta real. |
CodeBlock
| Representação JSON |
|---|
{ "pythonCode": string } |
| Campos | |
|---|---|
pythonCode |
Obrigatório. Código Python que será invocado no modo de simulação da ferramenta. Assinatura de função Python esperada: para capturar todas as chamadas de ferramenta: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: para capturar uma chamada de ferramenta específica: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: se a função retornar None, a ferramenta real será invocada. |
Exemplo
| Representação JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"entryAgent": string,
"messages": [
{
object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo do exemplo. Formato: |
displayName |
Obrigatório. Nome de exibição do exemplo. |
description |
Opcional. Descrição legível por humanos do exemplo. |
entryAgent |
Opcional. O agente que lida inicialmente com a conversa. Se não for especificado, o exemplo vai representar uma conversa processada pelo agente raiz. Formato: |
messages[] |
Opcional. A coleção de mensagens que compõem a conversa. |
createTime |
Apenas saída. Carimbo de data/hora em que o exemplo 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: |
updateTime |
Apenas saída. Carimbo de data/hora de quando o exemplo 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: |
invalid |
Apenas saída. O exemplo pode se tornar inválido se os recursos de referência forem excluídos. Exemplos inválidos não serão usados como exemplos few-shot. |
etag |
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. |
Mensagem
| Representação JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| Campos | |
|---|---|
role |
Opcional. O papel na conversa, por exemplo, usuário, agente. |
chunks[] |
Opcional. Conteúdo da mensagem como uma série de blocos. |
eventTime |
Opcional. Carimbo de data/hora de quando a mensagem foi enviada ou recebida. Não deve ser usado se a mensagem fizer parte de um 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: |
Pedaço
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união data. Dividir dados em blocos. data pode ser apenas de um dos tipos a seguir: |
|
text |
Opcional. Dados de texto. |
transcript |
Opcional. Transcrição associada ao áudio. |
blob |
Opcional. Dados de blob. |
payload |
Opcional. Dados de payload personalizados. |
image |
Opcional. Dados da imagem. |
toolCall |
Opcional. Solicitação de execução de ferramenta. |
toolResponse |
Opcional. Resposta da execução da ferramenta. |
agentTransfer |
Opcional. Evento de transferência do agente. |
updatedVariables |
Uma estrutura representa as variáveis que foram atualizadas na conversa, identificadas pelos nomes das variáveis. |
defaultVariables |
Uma struct representa variáveis padrão no início da conversa, identificadas por nomes de variáveis. |
Blob
| Representação JSON |
|---|
{ "mimeType": string, "data": string } |
| Campos | |
|---|---|
mimeType |
Obrigatório. O tipo MIME padrão da IANA dos dados de origem. |
data |
Obrigatório. Bytes brutos do blob. Uma string codificada em base64. |
Imagem
| Representação JSON |
|---|
{ "mimeType": string, "data": string, "altText": string } |
| Campos | |
|---|---|
mimeType |
Obrigatório. O tipo MIME padrão da IANA dos dados de origem. Os tipos de imagem compatíveis incluem: * image/png * image/jpeg * image/webp |
data |
Obrigatório. Bytes brutos da imagem. Uma string codificada em base64. |
altText |
Opcional. O texto alternativo da imagem. |
ToolCall
| Representação JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| Campos | |
|---|---|
id |
Opcional. O identificador exclusivo da chamada de ferramenta. Se preenchido, o cliente vai retornar o resultado da execução com o código correspondente em |
displayName |
Apenas saída. Nome de exibição da ferramenta. |
args |
Opcional. Os parâmetros de entrada e os valores da ferramenta no formato de objeto JSON. |
parentToolCallId |
Apenas saída. O ID da chamada de ferramenta que causou esta, quando foi emitida por um subagente trabalhando em nome de uma chamada pai. Vazio para chamadas de nível superior. Permite que um cliente agrupe o trabalho de um subagente na chamada que o iniciou, em vez de renderizar cada etapa como um irmão. |
agentName |
Apenas saída. Nome legível por humanos do agente que emitiu essa chamada, por exemplo, "Arquiteto de contratos". Vazio quando o agente raiz o emitiu. |
targetApp |
Apenas saída. O app que essa chamada segmenta, derivado pelo assistente dos argumentos de recurso da chamada: um nome de recurso de app, |
Campo de união tool_identifier. O identificador da ferramenta a ser executada. Pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir: |
|
tool |
Opcional. O nome da ferramenta a ser executada. Formato: |
toolsetTool |
Opcional. A ferramenta do conjunto de ferramentas a ser executada. |
ToolsetTool
| Representação JSON |
|---|
{ "toolset": string, "toolId": string } |
| Campos | |
|---|---|
toolset |
Obrigatório. O nome do recurso do conjunto de ferramentas de onde essa ferramenta é derivada. Formato: |
toolId |
Opcional. O ID da ferramenta para filtrar as ferramentas e recuperar o esquema. |
ToolResponse
| Representação JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| Campos | |
|---|---|
id |
Opcional. O código correspondente do |
displayName |
Apenas saída. Nome de exibição da ferramenta. |
response |
Obrigatório. O resultado da execução da ferramenta no formato de objeto JSON. Use a chave "output" para especificar a resposta da ferramenta e a chave "error" para especificar os detalhes do erro (se houver). Se as chaves "output" e "error" não forem especificadas, toda a "response" será tratada como resultado da execução da ferramenta. |
parentToolCallId |
Apenas saída. O ID da chamada de ferramenta que causou esta, quando foi emitida por um subagente trabalhando em nome de uma chamada pai. Vazio para chamadas de nível superior. Permite que um cliente agrupe o trabalho de um subagente na chamada que o iniciou, em vez de renderizar cada etapa como um irmão. |
agentName |
Apenas saída. Nome legível por humanos do agente que emitiu essa chamada, por exemplo, "Arquiteto de contratos". Vazio quando o agente raiz o emitiu. |
targetApp |
Apenas saída. O app que a ferramenta executada segmentou; espelha |
Campo de união tool_identifier. O identificador da ferramenta que foi executada. Pode ser uma ferramenta persistente ou de um conjunto de ferramentas. tool_identifier pode ser apenas de um dos tipos a seguir: |
|
tool |
Opcional. O nome da ferramenta a ser executada. Formato: |
toolsetTool |
Opcional. A ferramenta do conjunto que foi executada. |
AgentTransfer
| Representação JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| Campos | |
|---|---|
targetAgent |
Obrigatório. O agente para quem a conversa está sendo transferida. O agente vai assumir a conversa a partir desse momento. Formato: |
displayName |
Apenas saída. Nome de exibição do agente. |
Proteção
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo da proteção. Formato: |
displayName |
Obrigatório. Nome de exibição da proteção. |
description |
Opcional. Descrição da proteção. |
enabled |
Opcional. Se a proteção está ativada. |
action |
Opcional. Ação a ser tomada quando a proteção for acionada. |
createTime |
Apenas saída. Carimbo de data/hora de quando a barreira de proteção foi criada. 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: |
updateTime |
Apenas saída. Carimbo de data/hora de quando a proteção foi atualizada 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: |
etag |
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. |
Campo de união guardrail_type. Tipo de barreira de proteção. guardrail_type pode ser apenas de um dos tipos a seguir: |
|
contentFilter |
Opcional. Proteção que proíbe o uso de determinados conteúdos na conversa. |
llmPromptSecurity |
Opcional. Proteção que bloqueia a conversa se o comando for considerado inseguro com base na classificação do LLM. |
llmPolicy |
Opcional. Proteção que bloqueia a conversa se a resposta do LLM for considerada uma violação da política com base na classificação do LLM. |
modelSafety |
Opcional. Proteção que bloqueia a conversa se a resposta do LLM for considerada insegura com base nas configurações de segurança do modelo. |
codeCallback |
Opcional. Proteção que pode bloquear a conversa com base no resultado da execução do callback. |
supervisor |
Opcional. Proteção que executa a intervenção do supervisor. |
ContentFilter
| Representação JSON |
|---|
{
"bannedContents": [
string
],
"bannedContentsInUserInput": [
string
],
"bannedContentsInAgentResponse": [
string
],
"matchType": enum ( |
| Campos | |
|---|---|
bannedContents[] |
Opcional. Lista de frases proibidas. Aplica-se às entradas do usuário e às respostas do agente. |
bannedContentsInUserInput[] |
Opcional. Lista de frases proibidas. Aplica-se apenas às entradas do usuário. |
bannedContentsInAgentResponse[] |
Opcional. Lista de frases proibidas. Aplica-se apenas às respostas do agente. |
matchType |
Obrigatório. Tipo de correspondência para o filtro de conteúdo. |
disregardDiacritics |
Opcional. Se for verdadeiro, os diacríticos serão ignorados durante a correspondência. |
sensitiveWordsExemptions[] |
Opcional. Entradas da lista de palavras sensíveis que essa proteção permite. Válido apenas quando match_type é SENSITIVE_WORDS. Cada valor precisa ser igual a uma entrada da lista (não diferencia maiúsculas de minúsculas, espaços em branco ao redor são ignorados). Outros valores não têm efeito. Aplica-se apenas a esta proteção. No máximo 1.000 entradas de até 256 caracteres cada. |
LlmPromptSecurity
| Representação JSON |
|---|
{ "failOpen": boolean, // Union field |
| Campos | |
|---|---|
failOpen |
Opcional. Determina o comportamento quando a proteção encontra um erro de LLM. - Se for verdadeiro: a proteção é ignorada. - Se for falso (padrão): a proteção é acionada/bloqueada. Observação: se uma política personalizada for fornecida, esse campo será ignorado em favor da configuração "fail_open" da política. |
Campo de união security_config. Define o modo de configuração de segurança. O usuário precisa escolher uma das seguintes configurações. security_config pode ser apenas de um dos tipos a seguir: |
|
defaultSettings |
Opcional. Use as configurações de segurança padrão predefinidas do sistema. Para selecionar esse modo, inclua uma mensagem "default_settings" vazia na solicitação. O campo "default_prompt_template" será preenchido pelo servidor na resposta. |
customPolicy |
Opcional. Use uma LlmPolicy definida pelo usuário para configurar a proteção de segurança. |
DefaultSecuritySettings
| Representação JSON |
|---|
{ "defaultPromptTemplate": string } |
| Campos | |
|---|---|
defaultPromptTemplate |
Apenas saída. O modelo de comando padrão usado pelo sistema. Este campo serve para mostrar ao usuário qual comando o sistema usa por padrão. É OUTPUT_ONLY. |
LlmPolicy
| Representação JSON |
|---|
{ "maxConversationMessages": integer, "modelSettings": { object ( |
| Campos | |
|---|---|
maxConversationMessages |
Opcional. Ao verificar essa política, considere as últimas "n" mensagens na conversa. Quando não definido, um valor padrão de 10 será usado. |
modelSettings |
Opcional. Configurações do modelo. |
prompt |
Obrigatório. Comando de política. Oferece suporte a marcadores de posição de variáveis de sessão ( |
policyScope |
Obrigatório. Define quando aplicar a verificação de política durante a conversa. Se definida como |
failOpen |
Opcional. Se ocorrer um erro durante a verificação da política, falhe em aberto e não acione a proteção. |
allowShortUtterance |
Opcional. Por padrão, a verificação da política de LLM é ignorada para enunciados curtos. Ativar essa configuração aplica a verificação de política a todas as falas, incluindo aquelas que normalmente seriam ignoradas. |
ModelSafety
| Representação JSON |
|---|
{
"safetySettings": [
{
object ( |
| Campos | |
|---|---|
safetySettings[] |
Obrigatório. Lista de configurações de segurança. |
SafetySetting
| Representação JSON |
|---|
{ "category": enum ( |
| Campos | |
|---|---|
category |
Obrigatório. A categoria de dano. |
threshold |
Obrigatório. O limite do bloqueio de danos. |
CodeCallback
| Representação JSON |
|---|
{ "beforeAgentCallback": { object ( |
| Campos | |
|---|---|
beforeAgentCallback |
Opcional. O callback a ser executado antes que o agente seja chamado. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - 'decision': 'OK' ou 'TRIGGER'. - 'reason': uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento. |
afterAgentCallback |
Opcional. O callback a ser executado depois que o agente é chamado. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - 'decision': 'OK' ou 'TRIGGER'. - 'reason': uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento. |
beforeModelCallback |
Opcional. O callback a ser executado antes que o modelo seja chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - 'decision': 'OK' ou 'TRIGGER'. - 'reason': uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento. |
afterModelCallback |
Opcional. O callback a ser executado depois que o modelo é chamado. Se houver várias chamadas para o modelo, o callback será executado várias vezes. Cada função de callback precisa retornar uma estrutura (por exemplo, um dict ou objeto) que contenha pelo menos: - 'decision': 'OK' ou 'TRIGGER'. - 'reason': uma string que explica a decisão. Uma decisão "TRIGGER" pode interromper o processamento. |
Supervisor
| Representação JSON |
|---|
{ "type": enum ( |
| Campos | |
|---|---|
type |
Opcional. O tipo do supervisor. |
detectionMode |
Opcional. O modo de detecção do supervisor. |
TriggerAction
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união action. A ação a ser tomada. action pode ser apenas de um dos tipos a seguir: |
|
respondImmediately |
Opcional. Responda imediatamente com uma resposta pré-configurada. |
transferAgent |
Opcional. Transferir a conversa para outro agente. |
generativeAnswer |
Opcional. Responder com uma resposta generativa. |
RespondImmediately
| Representação JSON |
|---|
{
"responses": [
{
object ( |
| Campos | |
|---|---|
responses[] |
Obrigatório. As respostas automáticas que o agente pode escolher. A resposta é escolhida aleatoriamente. |
Resposta
| Representação JSON |
|---|
{ "text": string, "disabled": boolean } |
| Campos | |
|---|---|
text |
Obrigatório. Texto para o agente responder. |
disabled |
Opcional. Indica se a resposta está desativada. As respostas desativadas não são usadas pelo agente. |
TransferAgent
| Representação JSON |
|---|
{ "agent": string } |
| Campos | |
|---|---|
agent |
Obrigatório. O nome do agente para quem a conversa será transferida. O agente precisa estar no mesmo app que o agente atual. Formato: |
GenerativeAnswer
| Representação JSON |
|---|
{ "prompt": string } |
| Campos | |
|---|---|
prompt |
Obrigatório. O comando a ser usado para a resposta generativa. |
Conjunto de ferramentas
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "timeout": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum ( |
| Campos | |
|---|---|
name |
Identificador. O identificador exclusivo do conjunto de ferramentas. Formato: |
displayName |
Opcional. O nome de exibição do conjunto de ferramentas. Precisa ser exclusivo no mesmo app. |
description |
Opcional. A descrição do conjunto de ferramentas. |
timeout |
Opcional. O tempo limite para a execução do conjunto de ferramentas. Se não for definido, o tempo limite padrão será de 30 segundos para conjuntos de ferramentas Duração em segundos com até nove dígitos fracionários, terminando em " |
createTime |
Apenas saída. Carimbo de data/hora de quando o conjunto de ferramentas 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: |
updateTime |
Apenas saída. Carimbo de data/hora de quando o conjunto de ferramentas 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: |
etag |
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. |
executionType |
Opcional. O tipo de execução das ferramentas no conjunto. |
toolFakeConfig |
Opcional. Configuração do comportamento das ferramentas no modo simulado. |
Campo de união toolset_type. O tipo do conjunto de ferramentas. toolset_type pode ser apenas de um dos tipos a seguir: |
|
mcpToolset |
Opcional. Um conjunto de ferramentas que contém uma lista de ferramentas oferecidas pelo servidor MCP. |
openApiToolset |
Opcional. Um conjunto de ferramentas que contém uma lista de ferramentas definidas por um esquema da OpenAPI. |
connectorToolset |
Opcional. Um conjunto de ferramentas que gera ferramentas de uma conexão do Integration Connectors. |
McpToolset
| Representação JSON |
|---|
{ "serverAddress": string, "apiAuthentication": { object ( |
| Campos | |
|---|---|
serverAddress |
Obrigatório. O endereço do servidor MCP, por exemplo, "https://example.com/mcp/". Se o servidor for criado com o SDK do MCP, o URL precisará ter o sufixo "/mcp/". Somente servidores baseados em transporte HTTP transmissível são compatíveis. Consulte https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http para mais detalhes. |
apiAuthentication |
Opcional. Informações de autenticação necessárias para acessar ferramentas e executar uma ferramenta no servidor MCP. Para a autenticação de token do portador, o token se aplica apenas à execução de ferramentas, não à listagem de ferramentas. Isso exige que as ferramentas possam ser listadas sem autenticação. |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços para VPC-SC, usada para resolver nomes de serviço em um perímetro. |
tlsConfig |
Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados em que o cliente deve confiar. |
customHeaders |
Opcional. Os cabeçalhos personalizados que serão enviados na solicitação ao servidor MCP. Os valores precisam estar no formato Um objeto com uma lista de pares |
toolOverrides[] |
Opcional. Substituições para ferramentas individuais dentro desse conjunto. Isso permite substituir detalhes específicos, como descrições, nomes ou fixar os estados das ferramentas para que não sejam totalmente dinâmicos. |
CustomHeadersEntry
| Representação JSON |
|---|
{ "key": string, "value": string } |
| Campos | |
|---|---|
key |
|
value |
|
McpToolOverride
| Representação JSON |
|---|
{
"tool": string,
"nameOverride": string,
"descriptionOverride": string,
"snapshot": {
object ( |
| Campos | |
|---|---|
tool |
Obrigatório. O nome original da ferramenta, conforme emitido pelo servidor MCP. |
nameOverride |
Opcional. Se presente, essa ferramenta usa esse nome no agente em vez do nome original. Isso é usado principalmente como um alias se o servidor MCP oferecer ferramentas com nomes ruins. |
descriptionOverride |
Opcional. Se presente, essa ferramenta usa essa descrição em vez da original do servidor. |
snapshot |
Apenas saída. Se estiver presente, essa ferramenta será "Fixada" e usará os valores do snapshot como substitutos se o servidor ficar temporariamente indisponível ou se não houver uma substituição. |
McpToolDefinition
| Representação JSON |
|---|
{ "description": string, "inputSchema": { object ( |
| Campos | |
|---|---|
description |
Apenas saída. A descrição da ferramenta MCP. Isso pode ser substituído por |
inputSchema |
Apenas saída. O esquema dos argumentos de entrada da ferramenta MCP. |
outputSchema |
Apenas saída. O esquema dos argumentos de saída da ferramenta MCP. |
OpenApiToolset
| Representação JSON |
|---|
{ "openApiSchema": string, "apiAuthentication": { object ( |
| Campos | |
|---|---|
openApiSchema |
Obrigatório. O esquema OpenAPI do conjunto de ferramentas. |
apiAuthentication |
Opcional. Informações de autenticação exigidas pela API. |
tlsConfig |
Opcional. A configuração de TLS. Inclui os certificados de servidor personalizados |
serviceDirectoryConfig |
Opcional. Configuração do Diretório de Serviços. |
ignoreUnknownFields |
Opcional. Se for verdadeiro, o agente vai ignorar campos desconhecidos na resposta da API para todas as operações definidas no esquema da OpenAPI. |
url |
Opcional. O URL do servidor do esquema de API aberta. Esse campo só é definido em conjuntos de ferramentas nas dependências do ambiente durante o processo de exportação se o esquema tiver um URL de servidor. Durante o processo de importação, se esse URL estiver presente nas dependências do ambiente e o esquema tiver o marcador de posição $env_var, ele vai substituir o marcador no esquema. |
ConnectorToolset
| Representação JSON |
|---|
{ "connection": string, "authConfig": { object ( |
| Campos | |
|---|---|
connection |
Obrigatório. O nome completo do recurso da conexão do Integration Connectors referenciada. Formato: |
authConfig |
Opcional. Configura como a autenticação é processada no Integration Connectors. Por padrão, uma autenticação de administrador é transmitida nas solicitações de API do Integration Connectors. É possível substituí-la por uma configuração de autenticação de usuário final diferente. Observação: a conexão precisa ter a substituição de autenticação ativada para especificar uma configuração de EUC aqui. Caso contrário, a criação do conjunto de ferramentas vai falhar. Consulte: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connectorActions[] |
Obrigatório. A lista de ações do conector/operações de entidade para as quais as ferramentas serão geradas. |
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_SEARCH |
O mecanismo SOLUTION_TYPE_SEARCH do app. Todos os repositórios de dados do conector adicionados ao app serão adicionados a esse mecanismo. |
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. |
RequestLocation
O local da chave de API na solicitação.
| Tipos enumerados | |
|---|---|
REQUEST_LOCATION_UNSPECIFIED |
Não especificado. Este valor não deve ser usado. |
HEADER |
Representa a chave no cabeçalho HTTP. |
QUERY_STRING |
Representa a chave na string de consulta. |
OauthGrantType
Tipos de permissões de acesso OAuth. Somente a concessão de credenciais do cliente é aceita.
| Tipos enumerados | |
|---|---|
OAUTH_GRANT_TYPE_UNSPECIFIED |
Não especificado. O padrão é CLIENT_CREDENTIAL. |
CLIENT_CREDENTIAL |
Representa o fluxo de credenciais do cliente. |
Direção
A direção da transferência.
| Tipos enumerados | |
|---|---|
DIRECTION_UNSPECIFIED |
Direção não especificada. |
PARENT_TO_CHILD |
Transferência do agente pai para o agente filho. |
CHILD_TO_PARENT |
Transferência do agente filho para o agente pai. |
OperationType
A operação a ser realizada na entidade.
| Tipos enumerados | |
|---|---|
OPERATION_TYPE_UNSPECIFIED |
Tipo de operação não especificado. Inválido. A criação/atualização da ConnectorTool vai falhar. |
LIST |
Operação de lista. |
GET |
Receber operação. |
CREATE |
Operação de criação. |
UPDATE |
Operação de atualização. |
DELETE |
Excluir operação. |
DataStoreType
O tipo do repositório de dados.
| Tipos enumerados | |
|---|---|
DATA_STORE_TYPE_UNSPECIFIED |
Não especificado. Esse valor indica que o tipo de repositório de dados não foi especificado, então ele não será usado durante a pesquisa. |
PUBLIC_WEB |
Um repositório de dados que contém conteúdo da web público. |
UNSTRUCTURED |
Um repositório de dados que contém dados privados não estruturados. |
FAQ |
Um repositório de dados que contém dados estruturados usados como perguntas frequentes. |
CONNECTOR |
Um repositório de dados que é um conector para um serviço próprio ou de terceiros. |
DocumentProcessingMode
O modo de processamento de documentos do repositório de dados.
| Tipos enumerados | |
|---|---|
DOCUMENT_PROCESSING_MODE_UNSPECIFIED |
Não especificado. |
DOCUMENTS |
Os documentos são processados como documentos. |
CHUNKS |
Os documentos são convertidos em blocos. |
AttributeType
O atributo (ou função) ao qual a classificação personalizada será aplicada.
| Tipos enumerados | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
AttributeType não especificado. |
NUMERICAL |
O valor do campo numérico será usado para atualizar dinamicamente o valor do aumento. Nesse caso, o attribute_value (o valor x) do ponto de controle será o valor real do campo numérico para o qual o boost_amount é especificado. |
FRESHNESS |
Para o caso de uso de atualização, o valor do atributo será a duração entre o horário atual e a data no campo de data e hora especificado. O valor precisa ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isso é: [nD][T[nH][nM][nS]]. Por exemplo, 5D, 3DT12H30M, T24H. |
InterpolationType
O tipo de interpolação a ser aplicado. O padrão é linear (linear por partes).
| Tipos enumerados | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
O tipo de interpolação não foi especificado. Nesse caso, o padrão é Linear. |
LINEAR |
A interpolação linear em trechos será aplicada. |
ModalityType
O tipo de modalidade.
| Tipos enumerados | |
|---|---|
MODALITY_TYPE_UNSPECIFIED |
Tipo de modalidade não especificado. |
TEXT |
Modalidade de texto. |
AUDIO |
Modalidade de áudio. |
FilterParameterBehavior
Comportamento do parâmetro de filtro.
| Tipos enumerados | |
|---|---|
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED |
Comportamento padrão do filtro. Inclua o filtro de inclusão para repositórios de dados do conector. Para os demais tipos de armazenamento de dados, o parâmetro de entrada do filtro é omitido. |
ALWAYS_INCLUDE |
Sempre inclua o filtro de inclusão para todos os tipos de repositório de dados. |
NEVER_INCLUDE |
O parâmetro de filtro nunca é incluído na lista de parâmetros de ferramenta, independentemente do tipo de repositório de dados. |
Estado
Representa o estado de disponibilidade dinâmica da ferramenta.
| Tipos enumerados | |
|---|---|
STATE_UNSPECIFIED |
Estado padrão. |
ACTIVE |
A ferramenta está disponível e é oferecida ativamente pelo servidor. |
INACTIVE |
A ferramenta está configurada ou fixada, mas não é oferecida pelo servidor no momento. |
STALE |
A ferramenta existe no servidor, mas não corresponde à versão dele. |
CorpusType
O tipo do corpus de RAG da Vertex.
| Tipos enumerados | |
|---|---|
CORPUS_TYPE_UNSPECIFIED |
Tipo de corpus não especificado. |
USER_OWNED |
O corpus é criado e pertence ao usuário. |
FULLY_MANAGED |
O corpus é criado pelo agente. |
WidgetType
Todos os tipos de widget disponíveis. Novos valores podem ser adicionados a esse tipo enumerado no futuro.
| Tipos enumerados | |
|---|---|
WIDGET_TYPE_UNSPECIFIED |
Tipo de widget não especificado. |
CUSTOM |
Tipo de widget personalizado. |
PRODUCT_CAROUSEL |
Widget de carrossel de produtos. |
PRODUCT_DETAILS |
Widget de detalhes do produto. |
QUICK_ACTIONS |
Widget de ações rápidas. |
PRODUCT_COMPARISON |
Widget de comparação de produtos. |
ADVANCED_PRODUCT_DETAILS |
Widget de detalhes do produto avançados. |
SHORT_FORM |
Widget de formato curto. |
OVERALL_SATISFACTION |
Widget de satisfação geral. |
ORDER_SUMMARY |
Widget de resumo do pedido. |
APPOINTMENT_DETAILS |
Widget de detalhes do agendamento. |
APPOINTMENT_SCHEDULER |
Widget de agendamento de horários. |
CONTACT_FORM |
Widget de formulário de contato. |
Modo
A estratégia usada para mapear dados da ferramenta de origem para o widget.
| Tipos enumerados | |
|---|---|
MODE_UNSPECIFIED |
Modo não especificado. |
FIELD_MAPPING |
Use o mapa field_mappings para transformação de dados. |
PYTHON_SCRIPT |
Use o python_script para transformação de dados. |
Tipo
Define como a resposta de texto é produzida.
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Tipo não especificado. |
NONE |
O LLM decide dinamicamente se vai gerar uma resposta de texto junto com o widget com base no contexto da conversa. |
LLM_GENERATED |
O LLM é explicitamente solicitado a gerar uma resposta de texto. |
STATIC |
Uma resposta de texto estática predefinida é sempre usada. |
ExecutionType
O tipo de execução da ferramenta ou do conjunto de ferramentas.
| Tipos enumerados | |
|---|---|
EXECUTION_TYPE_UNSPECIFIED |
O tipo de execução não foi especificado. Quando não especificado, o padrão é SYNCHRONOUS. |
SYNCHRONOUS |
A ferramenta é executada de forma síncrona. A sessão é bloqueada até que a ferramenta retorne. |
ASYNCHRONOUS |
A ferramenta é executada de forma assíncrona. A sessão vai continuar enquanto a ferramenta estiver em execução. |
MatchType
Tipo de correspondência para o filtro de conteúdo.
| Tipos enumerados | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
O tipo de correspondência não foi especificado. |
SIMPLE_STRING_MATCH |
O conteúdo é correspondido por substrings caractere por caractere. |
WORD_BOUNDARY_STRING_MATCH |
O conteúdo só será correspondente se o padrão encontrado no texto estiver cercado por delimitadores de palavras. As frases proibidas também podem conter delimitadores de palavras. |
REGEXP_MATCH |
A correspondência do conteúdo é feita usando a sintaxe de expressão regular. |
SENSITIVE_WORDS |
O conteúdo é comparado com uma lista de palavras e frases sensíveis gerenciada pelo sistema. Anexar uma proteção com esse tipo de correspondência a um app ou agente substitui o filtro padrão de palavras sensíveis para os agentes afetados. Desative a proteção para desativar o filtro padrão. |
PolicyScope
Define quando aplicar a verificação de política durante a conversa.
| Tipos enumerados | |
|---|---|
POLICY_SCOPE_UNSPECIFIED |
O escopo da política não foi especificado. |
USER_QUERY |
A verificação de política é acionada na entrada do usuário. |
AGENT_RESPONSE |
A verificação de política é acionada na resposta do agente. A aplicação desse escopo de política vai introduzir uma latência adicional antes que o agente possa responder. |
USER_QUERY_AND_AGENT_RESPONSE |
A verificação de política é acionada tanto na entrada do usuário quanto na resposta do agente. A aplicação desse escopo de política vai introduzir uma latência adicional antes que o agente possa responder. |
HarmCategory
Categoria de dano.
| Tipos enumerados | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
A categoria de danos não foi especificada. |
HARM_CATEGORY_HATE_SPEECH |
A categoria de danos é discurso de ódio. |
HARM_CATEGORY_DANGEROUS_CONTENT |
A categoria de danos é um conteúdo perigoso. |
HARM_CATEGORY_HARASSMENT |
A categoria de dano é assédio. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
A categoria de dano é conteúdo sexualmente explícito. |
HARM_CATEGORY_PROFANITY |
A categoria de dano é linguagem obscena. |
HARM_CATEGORY_TOXIC |
A categoria de dano é tóxica. |
HarmBlockThreshold
Níveis de limites baseados em probabilidade para bloqueio.
| Tipos enumerados | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
Limite de bloqueio de danos não especificado. |
BLOCK_LOW_AND_ABOVE |
Bloquear o limite inferior e superior (ou seja, bloquear mais). |
BLOCK_MEDIUM_AND_ABOVE |
Bloquear o limite médio e acima. |
BLOCK_ONLY_HIGH |
Bloquear apenas o limite superior (ou seja, bloquear menos). |
BLOCK_NONE |
Bloquear nenhum |
OFF |
Desative o filtro de segurança. |
Tipo
Tipo de supervisor.
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Tipo não especificado. |
INVALID_TEXT |
Tipo de problema de texto inválido. |
LANGUAGE_SHIFT |
Tipo de problema de mudança de idioma. |
SPEAKER_SHIFT |
Tipo de problema de mudança de locutor. |
AUDIO_MISMATCH |
Tipo de problema de incompatibilidade de áudio. |
MISSING_TOOL_CALL |
Tipo de problema de chamada de ferramenta ausente. |
CUSTOM |
Tipo de problema personalizado. |
CHOPPY_AUDIO |
Tipo de problema de áudio entrecortado. |
PROFANITY |
Tipo de problema de linguagem obscena do agente. |
DetectionMode
Modo de detecção do supervisor.
| Tipos enumerados | |
|---|---|
DETECTION_MODE_UNSPECIFIED |
O modo de detecção não foi especificado. O padrão é NON_BLOCKING. |
NON_BLOCKING |
Modo de detecção sem bloqueio. A resposta não é bloqueada quando a detecção do supervisor está em andamento. |
BLOCKING |
Modo de detecção de bloqueio. A resposta é bloqueada quando a detecção do supervisor está em andamento. |
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: ❌