- Recurso: App
- Representação JSON
- LanguageSettings
- TimeZoneSettings
- AudioProcessingConfig
- SynthesizeSpeechConfig
- BargeInConfig
- AmbientSoundConfig
- AmbientSoundConfig.PrebuiltAmbientNoise
- CustomVoiceSample
- CustomVoiceSample.Warning
- CustomVoiceSample.Warning.WarningType
- CustomVoiceSample.VoiceInstructionMode
- LoggingSettings
- RedactionConfig
- AudioRecordingConfig
- BigQueryExportSettings
- CloudLoggingSettings
- ConversationLoggingSettings
- MetricAnalysisSettings
- ErrorHandlingSettings
- ErrorHandlingSettings.ErrorHandlingStrategy
- ErrorHandlingSettings.FallbackResponseConfig
- ErrorHandlingSettings.EndSessionConfig
- App.ToolExecutionMode
- App.VariableDeclaration
- DataStoreSettings
- DataStoreSettings.Engine
- DataStoreSettings.Engine.Type
- ClientCertificateSettings
- VpcScSettings
- EvaluationSettings
- EvaluationSettings.ScenarioConversationInitiator
- DashboardSettings
- Métodos
Recurso: App
Um app serve como um contêiner de nível superior para um grupo de agentes, incluindo o agente raiz e os subagentes, além das configurações associadas. Esses agentes trabalham juntos para alcançar metas específicas no contexto do app.
| 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. |
evaluationPersonas[] |
Opcional. As personas de avaliação do app. Esse campo é usado para definir as personas que podem ser usadas para avaliação. É possível definir no máximo 30 personas. |
evaluationSettings |
Opcional. As configurações de avaliação do app. |
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
Configurações de idioma do app.
| 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
Configurações de fuso horário do app.
| 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
Configuração de como o áudio de entrada e saída deve ser processado e entregue.
| 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. |
SynthesizeSpeechConfig
Configuração de como a resposta do agente deve ser sintetizada.
| 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 languageCode. 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
Configuração de como as atividades de interrupção do usuário devem ser processadas.
| 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. |
AmbientSoundConfig
Configuração do som ambiente a ser reproduzido com a resposta sintetizada do agente para melhorar a naturalidade da conversa.
| Representação JSON |
|---|
{
"volumeGainDb": number,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"prebuiltAmbientNoise": enum ( |
| 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. |
| Ruído ambiente a ser reproduzido com a resposta sintetizada do agente para melhorar a naturalidade da conversa. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
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" |
| Fim dos campos mutuamente exclusivos. | |
AmbientSoundConfig.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. |
CustomVoiceSample
Configuração de uma amostra de voz personalizada usada para clonagem de voz.
| 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. |
CustomVoiceSample.Warning
Uma mensagem de aviso encontrada durante o processamento da amostra de voz.
| 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. |
CustomVoiceSample.Warning.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). |
CustomVoiceSample.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. |
LoggingSettings
Configurações para descrever os comportamentos de geração de registros do app.
| 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
Configuração para instruir como os dados sensíveis devem ser processados.
| 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
Configuração de como as interações de áudio devem ser gravadas.
| 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
Configurações para descrever os comportamentos de exportação do BigQuery para o app.
| 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
Configurações para descrever os comportamentos do Cloud Logging para o app.
| Representação JSON |
|---|
{ "enableCloudLogging": boolean } |
| Campos | |
|---|---|
enableCloudLogging |
Opcional. Se o Cloud Logging deve ser ativado para as sessões. |
ConversationLoggingSettings
Configurações para descrever os comportamentos de registro de conversas do app.
| 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
Configurações para descrever os comportamentos de coleta de dados de conversas para o pipeline de métricas de análise de LLM.
| 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
Configurações para descrever como os erros devem ser tratados no app.
| 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). |
ErrorHandlingSettings.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). |
ErrorHandlingSettings.FallbackResponseConfig
Configuração para processar respostas de fallback.
| 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 |
ErrorHandlingSettings.EndSessionConfig
Configuração para encerrar a sessão em caso de erros do sistema (por exemplo, erros de LLM).
| Representação JSON |
|---|
{ "escalateSession": boolean } |
| Campos | |
|---|---|
escalateSession |
Opcional. Se a sessão deve ser encaminhada em |
App.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. |
App.VariableDeclaration
Define a estrutura e os metadados de uma variável.
| 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. |
DataStoreSettings
Configurações relacionadas ao repositório de dados do app.
| Representação JSON |
|---|
{
"engines": [
{
object ( |
| Campos | |
|---|---|
engines[] |
Apenas saída. Os mecanismos do app. |
DataStoreSettings.Engine
Um mecanismo ao qual os repositórios de dados estão conectados. Consulte a Vertex AI para Pesquisa: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
| 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. |
DataStoreSettings.Engine.Type
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. |
ClientCertificateSettings
Configurações para certificados do cliente personalizados.
| 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
Configurações do VPC-SC para o app.
| 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. |
EvaluationSettings
Configurações para avaliação.
| Representação JSON |
|---|
{ "scenarioConversationInitiator": enum ( |
| Campos | |
|---|---|
scenarioConversationInitiator |
Opcional. Quem inicia a conversa em uma avaliação de cenário. |
goldenRunMethod |
Opcional. O método padrão usado para executar avaliações de referência. Ele será usado se nenhum goldenRunMethod for especificado no RunEvaluationRequest. |
goldenEvaluationToolCallBehaviour |
Opcional. Configura o comportamento padrão de chamada de ferramenta para avaliações de referência. |
scenarioEvaluationToolCallBehaviour |
Opcional. Configura o comportamento padrão de chamada de ferramenta para avaliações de cenário. |
metricsConfig |
Opcional. Configura as métricas padrão para avaliações. |
scenarioExecutionMode |
Opcional. O modo de execução para avaliações de cenário. Se não for fornecido, o padrão será QUALITY_OPTIMIZED. |
evaluationRunCachingSettings |
Opcional. As configurações de armazenamento em cache a serem usadas na execução da avaliação. |
EvaluationSettings.ScenarioConversationInitiator
Determina quem inicia a conversa em uma sessão de avaliação de cenário.
| Tipos enumerados | |
|---|---|
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED |
Não especificado. O padrão é USER. |
USER |
O usuário inicia a conversa. |
AGENT |
O agente inicia a conversa. |
DashboardSettings
Configurações dos painéis associados ao app, que aparecem na visualização do Monitoring.
| 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: |
Métodos |
|
|---|---|
|
Executa o Arc, o assistente de IA, para a sessão especificada. |
|
Cria um novo app no projeto e no local especificados. |
|
Exclui o app especificado. |
|
Executa a ferramenta especificada com os argumentos fornecidos. |
|
Exporta o app especificado. |
|
Gera recursos específicos (por exemplo, |
|
Gera sugestões de integração personalizadas para o estado zero do Arc: classifica o usuário que faz a solicitação (novo / explorando / retornando) com base no histórico de sessões do assistente no app e retorna chips de sugestão de resposta (retomar uma sessão, continuar o trabalho ou começar algo novo) para renderizar antes que qualquer mensagem seja enviada. |
|
Recebe detalhes do app especificado. |
|
Recebe o card estendido do agente autenticado. |
|
Importa o app especificado. |
|
Importa avaliações para o app. |
|
Lista os apps no projeto e no local especificados. |
|
Atualiza o app especificado. |
|
Recupera o esquema da ferramenta fornecida. |
|
Executa o agente assistente para a sessão de assistente especificada. |
|
Executa uma avaliação do app. |
|
Testa a voz de uma persona. |