REST Resource: projects.locations.collections.dataStores.widgetConfigs

Recurso: WidgetConfig

O WidgetConfig captura configurações no nível do widget.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "enableAutocomplete": boolean,
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  },
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "dataStoreType": enum (DataStoreType),
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "enableSummarization": boolean,
  "enableSnippetResultSummary": boolean,
  "configId": string,
  "enableQualityFeedback": boolean,
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableSafeSearch": boolean,
  "enableConversationalSearch": boolean,
  "llmEnabled": boolean,
  "enableResultScore": boolean,
  "resultDisplayType": enum (ResultDisplayType),
  "minimumDataTermAccepted": boolean,
  "enableWebApp": boolean,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "collectionComponents": [
    {
      object (CollectionComponent)
    }
  ],
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
Campos
name

string

Imutável. O nome completo do recurso da configuração do widget. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
displayName

string

Obrigatório. O nome de exibição legível da configuração do widget. Usado na interface de descoberta.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que o WidgetConfig foi criado.

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

string (Timestamp format)

Apenas saída. Carimbo de data/hora da atualização do WidgetConfig.

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

boolean

Se o preenchimento automático deve ser ativado ou não.
fieldsUiComponentsMap
(deprecated)

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

A chave é o componente de UI. Mock. Atualmente, são aceitos title, thumbnail, url, custom1, custom2 e custom3.

O valor é o nome do campo com a visibilidade do dispositivo.

Os três campos personalizados são opcionais e podem ser adicionados ou removidos. title, thumbnail e url são componentes obrigatórios da UI que não podem ser removidos.
facetField[]
(deprecated)

object (FacetField)

A configuração e a aparência das facetas na visualização do usuário final.
dataStoreType

enum (DataStoreType)

Apenas saída. O tipo do repositório de dados principal.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

A especificação de pesquisa de conteúdo que configura o comportamento desejado da pesquisa de conteúdo.
enableSummarization
(deprecated)

boolean

Ative ou desative o resumo da resposta da pesquisa.
enableSnippetResultSummary
(deprecated)

boolean

Ative ou desative o resumo para cada resultado de trecho.
configId

string

Apenas saída. Identificador exclusivo ofuscado de um WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

Ative ou desative a coleta de feedback sobre a qualidade dos resultados da pesquisa dos usuários finais.
solutionType

enum (SolutionType)

Obrigatório. Imutável. Especifica o tipo de solução para que este WidgetConfig pode ser usado.
industryVertical

enum (IndustryVertical)

Apenas saída. O segmento do setor que o WidgetConfig registra. O segmento do setor WidgetConfig é baseado no Engine associado.
allowPublicAccess
(deprecated)

boolean

Se a integração sem autenticação com o widget é permitida. Se definido como "true", o acesso público à pesquisa ou a outras soluções do widget será permitido sem o token de autenticação fornecido pelo servidor de back-end hospedado pelo cliente.
allowlistedDomains[]
(deprecated)

string

Domínios na lista de permissões que podem carregar este widget.
llmEnabled

boolean

Apenas saída. Se o LLM está ativado no repositório de dados correspondente.
enableResultScore

boolean

Se a pontuação do resultado será mostrada.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

O tipo de snippet a ser mostrado no widget do UCS.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED para usuários atuais.
  • TRECHO para novos usuários da pesquisa enterprise que não são corporativos.
  • EXTRACTIVE_ANSWER para novos usuários da pesquisa enterprise.
minimumDataTermAccepted

boolean

Apenas saída. Se o cliente aceitou os termos de uso de dados.
enableWebApp
(deprecated)

boolean

Define se o app da Web independente será ativado.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Configurações de interface configuráveis por repositório de dados.
collectionComponents[]

object (CollectionComponent)

Apenas saída. Componentes de coleta que listam todas as coleções e repositórios de dados filhos associados à configuração do widget. Essas fontes de dados podem ser usadas para filtragem nas APIs de serviço de widget. Os usuários podem retornar resultados das fontes de dados selecionadas.

Para mecanismos de SaaS / empresariais, quando LookupWidgetConfig é chamado com view = WITH_AVAILABLE_CONNECTORS, essa lista também é aumentada com entradas de marcador de posição sintéticas para conectores que o chamador pode anexar, mas ainda não anexou. Consulte CollectionComponent para o contrato de marcador de posição. Portanto, o front-end pode renderizar uma lista unificada de fontes já anexadas e disponíveis para anexar iterando esse único campo. Para mecanismos do Enterprise e para o view padrão, somente os conectores já anexados são retornados (comportamento atual).
enableSearchAsYouType
(deprecated)

boolean

Se o comportamento de pesquisa enquanto você digita deve ser ativado para o widget da Pesquisa.
defaultSearchRequestOrderBy
(deprecated)

string

A ordenação padrão dos resultados da pesquisa, se especificada.

Usado para definir SearchRequest#orderBy em solicitações aplicáveis. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
uiSettings

object (UiSettings)

Descreve as configurações gerais de pesquisa de widgets, conforme mostrado na página de configuração de widgets do console do Cloud. Substitui as principais propriedades de nível superior descontinuadas.
accessSettings

object (AccessSettings)

Será usado para todas as configurações de acesso a widgets na página de integração do console do Cloud. Substitui as principais propriedades de nível superior descontinuadas.
uiBranding

object (UiBrandingSettings)

Descreve as configurações de marca UI interface do widget da Pesquisa, como título, logotipo, favicons e cores.
homepageSetting

object (HomepageSetting)

Opcional. Descreve as configurações da página inicial do widget.
assistantSettings

object (AssistantSettings)

Opcional. Apenas saída. Descreve as configurações do assistente do widget.
customerProvidedConfig

object (CustomerProvidedConfig)

Opcional. Apenas saída. Descreve as configurações relacionadas ao cliente, atualmente usadas apenas para clientes governamentais. Esse campo não pode ser modificado após a integração do projeto.
enablePrivateKnowledgeGraph

boolean

Opcional. Apenas saída. Define se o Mapa de informações particulares será ativado.
geminiBundle

boolean

Apenas saída. Indica se a assinatura é do pacote Gemini ou não.
batchAuthStatuses[]

object (BatchAuthStatus)

Apenas saída. Os status de autorização em lote para os conectores do widget.
nodes[]

object (Node)

Apenas saída. Os nós associados à configuração do widget.

UIComponentField

Campo de faceta que é mapeado para um componente de interface.

Representação JSON 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
Campos
field

string

Obrigatório. Nome do campo registrado. O formato é field.abc.
deviceVisibility[]

enum (DeviceVisibility)

A visibilidade do campo em diferentes tipos de dispositivos.
displayTemplate

string

O modelo para personalizar como o campo é mostrado. Um exemplo de valor seria uma string como: "Preço: {value}".

DeviceVisibility

A visibilidade do campo em diferentes tipos de dispositivos.

Tipos enumerados
DEVICE_VISIBILITY_UNSPECIFIED Valor padrão quando não especificado. O servidor retorna INVALID_ARGUMENT se usado em solicitações.
MOBILE O componente da interface está visível em dispositivos móveis.
DESKTOP O componente de interface está visível no cliente baseado em navegador.

FacetField

Campos de faceta que armazenam o mapeamento de campos para a aparência do widget do usuário final.

Representação JSON 
{
  "field": string,
  "displayName": string
}
Campos
field

string

Obrigatório. Nome do campo registrado. O formato é field.abc.
displayName

string

Opcional. O nome do campo que os usuários finais vão ver.

DataStoreType

O tipo do repositório de dados principal do widget.

Tipos enumerados
DATA_STORE_TYPE_UNSPECIFIED Tipo de repositório de dados não especificado.
STRUCTURED O repositório de dados principal contém um mecanismo de pesquisa para dados estruturados.
UNSTRUCTURED O repositório de dados principal contém um mecanismo de pesquisa para dados não estruturados.
BLENDED O repositório de dados principal é usado para pesquisa combinada com vários repositórios de dados.

ResultDisplayType

O tipo de resultado a ser mostrado no widget ucs.

Tipos enumerados
RESULT_DISPLAY_TYPE_UNSPECIFIED Tipo de exibição não especificado (o padrão é mostrar o snippet).
SNIPPET Mostrar resultados do campo de snippet.
EXTRACTIVE_ANSWER Mostrar resultados do campo de respostas extrativas.

DataStoreUiConfig

Configuração de componentes da UI para o repositório de dados.

Representação JSON 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
Campos
name

string

O nome do repositório de dados. Ele precisa estar no formato do nome do recurso do repositório de dados: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. Para APIs em WidgetService, como WidgetService.LookupWidgetConfig, o número do projeto e a parte de localização são apagados nesse campo.
id

string

Somente saída. O identificador do repositório de dados, usado para o serviço de widget. Por enquanto, ele se refere a dataStoreId. No futuro, vamos migrar o campo para o UUID do nome do repositório de dados criptografado.
facetField[]

object (FacetField)

Campos de faceta que armazenam o mapeamento de campos para a aparência do widget do usuário final.
fieldsUiComponentsMap

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

A chave é o componente de UI. Mock. Atualmente, são aceitos title, thumbnail, url, custom1, custom2 e custom3.

O valor é o nome do campo com a visibilidade do dispositivo.

Os três campos personalizados são opcionais e podem ser adicionados ou removidos. title, thumbnail e url são componentes obrigatórios da UI que não podem ser removidos.

CollectionComponent

Componente de coleta somente leitura que contém campos de coleções de repositório de dados que podem ser usados para filtragem.

Para mecanismos SaaS / empresariais, quando LookupWidgetConfig é chamado com view = WITH_AVAILABLE_CONNECTORS, instâncias dessa mensagem também são usadas para representar entradas de marcador de posição sintéticas para conectores que o chamador pode anexar, mas ainda não anexou. As entradas de marcador de posição têm connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (ou NO_AUTH), um connectorAuthState.authorization_uri vazio (o widget chama WidgetBuildAuthorizationUrl no clique de "Conectar" do usuário) e valores sintéticos de marcador de posição em name / id (consulte os comentários do campo). Os campos que só fazem sentido para conectores materializados (dataStoreComponents, tenant, actionConnector) não são definidos para entradas de marcador de posição.

Representação JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceVersion": number,
  "dataSourceDisplayName": string,
  "dataSourceEndUserDisplayName": string,
  "connectorIconLink": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  },
  "metadata": {
    object (ConnectorMetadata)
  },
  "isFirstParty": boolean,
  "tag": string
}
Campos
name

string

O nome da coleção. Precisa ser o nome do recurso da coleção. Formato: projects/{project}/locations/{location}/collections/{collectionId}. Para APIs em WidgetService, como WidgetService.LookupWidgetConfig, o número do projeto e a parte de localização são apagados nesse campo.

Para entradas de marcador de posição sintéticas (consulte o comentário no nível da mensagem), isso carrega um ID de coleção de marcador de posição sintético que não corresponde a uma coleção real. Os chamadores não podem tentar resolver / GET esse recurso até que o usuário autorize o conector.
id

string

Somente saída. O identificador da coleção, usado para o serviço de widget. Por enquanto, ele se refere a "collectionId". No futuro, vamos migrar o campo para o UUID do nome da coleção criptografada.

Para entradas de marcador de posição sintéticas (consulte o comentário no nível da mensagem), esse é um ID de marcador de posição sintético, não um collectionId real.
displayName

string

O nome de exibição da coleção.
dataStoreComponents[]

object (DataStoreComponent)

Para a coleção de repositório de dados, lista dos repositórios de dados filhos.
dataSource

string

O nome da fonte de dados, recuperado de Collection.data_connector.data_source.
dataSourceVersion

number

Apenas saída. A versão da definição do conector que apoia essa coleção, espelhando DataConnector.data_source_version.
dataSourceDisplayName

string

Apenas saída. O nome de exibição da fonte de dados.
dataSourceEndUserDisplayName

string

Apenas saída. O nome de exibição da fonte de dados voltado ao usuário, extraído de ConnectorSource.end_user_display_name. Quando não definido, os clientes voltam para dataSourceDisplayName.
connectorAuthState

object (ConnectorAuthState)

Apenas saída. O URI de autenticação da origem do conector.
metadata

object (ConnectorMetadata)

Apenas saída. Metadados do conector voltados ao usuário (title, description, shortDescription, author, note), recuperados do registro ConnectorSource.metadata (unidos por fonte de dados). Mostrado na página de detalhes do conector.
isFirstParty

boolean

Apenas saída. Se é um conector próprio (do Google) ou de terceiros. Usado pelo front-end para agrupar conectores próprios e de terceiros.
tag

string

Apenas saída. O rótulo independente da versão do conector que oferece suporte a essa coleção, espelhando DataConnector.tag. Ao contrário do ID do repositório de dados fixado na versão, ele sobrevive a uma atualização da versão do conector. Portanto, um conector atualizado mantém a mesma tag.

Não é uma chave exclusiva. Como DataConnector.tag documentos, vários conectores podem compartilhar uma tag no mesmo (projeto, local, coleção, dataSource), e a pesquisa baseada em tag é resolvida para aquele com o maior createTime. Os clientes não podem tratar isso como um identificador de conector.

Fica vazio quando o conector foi criado antes do lançamento da gravação de tag e para entradas de marcador de posição sintéticas, que não têm DataConnector subjacente. Preenchido somente quando ConnectorsFeature.enable_connector_tag está ativado.

DataStoreComponent

Componente de repositório de dados somente leitura que contém campos de repositórios de dados que podem ser usados para filtragem. É filho de CollectionComponent.

Representação JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "dataStoreConfigType": enum (DataStoreConfigType)
}
Campos
name

string

O nome do repositório de dados. Ele precisa estar no formato do nome do recurso do repositório de dados: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. Para APIs em WidgetService, como WidgetService.LookupWidgetConfig, o número do projeto e a parte de localização são apagados nesse campo.
id

string

Somente saída. O identificador do repositório de dados, usado para o serviço de widget. Por enquanto, ele se refere a dataStoreId. No futuro, vamos migrar o campo para o UUID do nome do repositório de dados criptografado.
displayName

string

O nome de exibição do repositório de dados.
entityName

string

O nome da entidade, recuperado de Collection.data_connector.entities.entityName.
dataStoreConfigType

enum (DataStoreConfigType)

Apenas saída. O tipo da configuração do repositório de dados.

DataStoreConfigType

O tipo da configuração do repositório de dados.

Tipos enumerados
DATA_STORE_CONFIG_TYPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
ALLOW_DB_CONFIG O repositório de dados está conectado ao AlloyDB
THIRD_PARTY_OAUTH_CONFIG O repositório de dados está conectado a uma fonte de dados de terceiros.
NOTEBOOKLM_CONFIG O repositório de dados está conectado ao NotebookLM Enterprise.

ConnectorAuthState

Conector somente leitura no estado de autenticação CollectionComponent.

Representação JSON 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
Campos
authState

enum (AuthState)

Apenas saída. O estado de autorização do conector de dados.
authorizationUri

string

Apenas saída. O URI de autorização do conector de dados.

Para entradas de marcador de posição sintético CollectionComponent (retornadas por LookupWidgetConfig com view = WITH_AVAILABLE_CONNECTORS em mecanismos SaaS / Business), este campo fica vazio. O widget precisa chamar WidgetService.WidgetBuildAuthorizationUrl quando o usuário clicar em "Conectar" para receber um URL de autorização recém-criado.
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora da atualização do estado de autorização.

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

AuthState

O estado de autorização do conector de dados.

Tipos enumerados
AUTH_STATE_UNSPECIFIED Valor padrão. Também retornado para entradas de marcador de posição sintético CollectionComponent apresentadas por LookupWidgetConfig com view = WITH_AVAILABLE_CONNECTORS (somente SaaS / empresas). Essas entradas representam conectores que o autor da chamada pode anexar, mas ainda não anexou.
AUTHORIZED O usuário autorizou o conector de dados.
EXPIRED A autorização do usuário para o conector de dados expirou.
ACTIONS_DISABLED O usuário ainda pode fazer solicitações de pesquisa, mas as ações precisam ser ativadas.
NO_AUTH O conector de dados não requer autorização. Também usado para entradas de marcador de posição cujo conector subjacente não exige OAuth do usuário.

ConnectorMetadata

Metadados voltados ao usuário para o conector, mostrados na página de detalhes dele (título, descrição, shortDescription, autor, observação).

Representação JSON 
{
  "title": string,
  "description": string,
  "shortDescription": string,
  "author": string,
  "note": string
}
Campos
title

string

Opcional. Mostra o título do conector.
description

string

Opcional. Descrição legível por humanos do conector, mostrada na página de detalhes dele. Um conector tem uma única descrição.
shortDescription

string

Opcional. Descrição curta do conector, com o tamanho de uma legenda (por exemplo, mostrada abaixo do nome do conector nas visualizações de lista e detalhes).
author

string

Opcional. A parte que criou o conector, por exemplo, "Google" ou o nome de um provedor terceirizado. Permite que os usuários finais vejam quem criou um conector (futuro: conectores criados por terceiros).
note

string

Opcional. Observação de várias linhas e formato livre sobre os recursos do conector ou uma observação personalizada que pode ser definida para o conector.

UiSettings

Descreve as configurações gerais da UI de widgets (ou app da Web) conforme mostrado na página de configuração da UI do console do Cloud.

Representação JSON 
{
  "interactionType": enum (InteractionType),
  "generativeAnswerConfig": {
    object (GenerativeAnswerConfig)
  },
  "resultDescriptionType": enum (ResultDisplayType),
  "enableAutocomplete": boolean,
  "enableSafeSearch": boolean,
  "enableQualityFeedback": boolean,
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "disableUserEventsCollection": boolean,
  "enableVisualContentSummary": boolean,
  "enablePeopleSearch": boolean,
  "enableCreateAgentButton": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "modelConfigInfo": {
    object (ModelConfigInfo)
  },
  "sourceAdminDisplayNameEnabled": boolean,
  "onedrivePickerEnabled": boolean,
  "googleDrivePickerEnabled": boolean
}
Campos
interactionType

enum (InteractionType)

Descreve o tipo de interação do widget (ou app da Web).
generativeAnswerConfig

object (GenerativeAnswerConfig)

Descreve a configuração de respostas generativas.
resultDescriptionType

enum (ResultDisplayType)

Controla se o trecho do resultado é exibido e como (snippet ou resposta extraída). O padrão é "nenhum resultado" se não for especificado.
enableAutocomplete

boolean

Se o preenchimento automático deve ser ativado ou não.
enableQualityFeedback

boolean

Ative ou desative a coleta de feedback sobre a qualidade dos resultados da pesquisa dos usuários finais.
enableSearchAsYouType

boolean

Se o comportamento de pesquisa enquanto você digita deve ser ativado para o widget da Pesquisa.
defaultSearchRequestOrderBy

string

A ordenação padrão dos resultados da pesquisa, se especificada.

Usado para definir SearchRequest#orderBy em solicitações aplicáveis. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
dataStoreUiConfigs[]

object (DataStoreUiConfig)

Por configuração de repositório de dados.
disableUserEventsCollection

boolean

Se definido como verdadeiro, o widget não vai coletar eventos do usuário.
enableVisualContentSummary

boolean

Se definido como "true", o widget vai ativar o resumo de conteúdo visual nas solicitações de pesquisa aplicáveis. Usado apenas pela pesquisa de saúde.
enableCreateAgentButton

boolean

Opcional. Se definido como "true", o widget vai ativar o botão "Criar agente".
features

map (key: string, value: enum (FeatureState))

Apenas saída. Configuração de recursos para que o mecanismo ative ou desative recursos. Teclas compatíveis:

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • speech-to-text
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • canvas-app-builder
  • skills
  • skill-sharing
  • skill-sharing-without-admin-approval
  • disable-projects
  • sobi
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
  • workflow-agents
  • in-app-notifications
modelConfigs

map (key: string, value: enum (ModelState))

Apenas saída. Mapeia um nome de modelo para a configuração específica dele neste mecanismo. Isso permite que os usuários administradores ativem/desativem modelos individuais. Isso armazena apenas modelos cujos estados são substituídos pelo administrador.

Quando o estado não é especificado ou modelConfigs está vazio para esse modelo, o sistema decide se ele deve estar disponível ou não com base na configuração padrão. Por exemplo, um modelo de prévia precisa ser desativado por padrão se o administrador não tiver escolhido ativá-lo.
searchAddonSpec

object (SearchAddonSpec)

Opcional. O SearchAddonSpec é usado para desativar complementos na pesquisa. Esse campo só é compatível com solicitações de pesquisa.
modelConfigInfo

object (ModelConfigInfo)

Apenas saída. A visualização resolvida do lado do servidor da configuração do seletor de modelos. Contém a lista ordenada de modelos que devem aparecer no menu suspenso do seletor de modelos e o modelo que deve ser selecionado por padrão.

Os clientes precisam renderizar isso diretamente, sem aplicar filtragem, ordenação ou localização próprias. O mapa modelConfigs legado acima é mantido para compatibilidade com versões anteriores de clientes que ainda não migraram para consumir esse campo.
sourceAdminDisplayNameEnabled

boolean

Opcional. Se o nome de exibição configurado pelo administrador para conectores de dados deve aparecer na interface de fontes de widgets (em vez do tipo de conector). Ativação. O padrão é "false".
onedrivePickerEnabled

boolean

Apenas saída. Indica se o seletor de arquivos do OneDrive está disponível para usuários finais. Calculado pelo back-end com base na ativação do conector de administrador (edição Business) ou nos conectores do OneDrive anexados (edição Enterprise), combinado com o recurso de administrador disable-onedrive-upload atual.

optional declarado para que um false calculado explicitamente seja serializado com a presença do campo. Um bool proto3 simples descarta um false padrão na rede, o que impedia os clientes de distinguir "seletor desativado" (false) de "campo não preenchido" (não definido).
googleDrivePickerEnabled

boolean

Apenas saída. Se o seletor de arquivos do Google Drive está disponível para usuários finais. Declarou optional pelo mesmo motivo de presença de campo que onedrivePickerEnabled acima.

InteractionType

Descreve o tipo de interação.

Tipos enumerados
INTERACTION_TYPE_UNSPECIFIED Não especificado. O padrão é SEARCH_ONLY.
SEARCH_ONLY Pesquisar sem uma resposta generativa.
SEARCH_WITH_ANSWER Pesquise com a resposta generativa.
SEARCH_WITH_FOLLOW_UPS Pesquise com a resposta generativa que permite fazer perguntas complementares. Também conhecida como pesquisa em várias etapas.

GenerativeAnswerConfig

Descreve a configuração da resposta generativa.

Representação JSON 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "imageSource": enum (ImageSource)
}
Campos
resultCount

integer

O número de principais resultados para gerar a resposta. Até 10.
modelVersion

string

A versão do modelo usada para gerar a resposta.
modelPromptPreamble

string

Texto no início do comando que instrui o modelo que gera a resposta.
maxRephraseSteps

integer

Número máximo de etapas de reformulação. O número máximo é de cinco etapas. Se não for definido ou for definido como < 1, o padrão será 1.
languageCode

string

Código do idioma para o resumo. Use tags de idioma definidas pelo BCP47. Observação: este é um recurso experimental.
ignoreNonAnswerSeekingQuery

boolean

Opcional. Especifica se é necessário filtrar consultas que não buscam respostas. O valor padrão é false.

Nenhuma resposta é retornada se a consulta de pesquisa for classificada como uma consulta que não busca respostas. Se esse campo estiver definido como true, vamos pular a geração de respostas para consultas que não buscam respostas e retornar mensagens de substituição.
ignoreAdversarialQuery

boolean

Opcional. Especifica se as consultas adversárias devem ser filtradas.
ignoreLowRelevantContent

boolean

Opcional. Especifica se as consultas que não são relevantes para o conteúdo devem ser filtradas.
imageSource

enum (ImageSource)

Opcional. Origem da imagem retornada na resposta.

ImageSource

Origem da imagem retornada na resposta.

Tipos enumerados
IMAGE_SOURCE_UNSPECIFIED Origem da imagem não especificada (o recurso multimodal fica desativado por padrão)
ALL_AVAILABLE_SOURCES Comportamento quando o serviço determina a escolha entre todas as fontes disponíveis.
CORPUS_IMAGE_ONLY Incluir imagem do corpus na resposta.
FIGURE_GENERATION_ONLY Aciona a geração de figuras na resposta.

FeatureState

O estado do recurso para o mecanismo.

Tipos enumerados
FEATURE_STATE_UNSPECIFIED O estado do recurso não foi especificado.
FEATURE_STATE_ON O recurso está ativado para ser acessível.
FEATURE_STATE_OFF O recurso está desativado para ficar inacessível.

ModelState

O estado do modelo para o mecanismo.

Tipos enumerados
MODEL_STATE_UNSPECIFIED O estado do modelo não foi especificado.
MODEL_ENABLED O modelo foi ativado pelo administrador.
MODEL_DISABLED O modelo foi desativado pelo admin.

SearchAddonSpec

O SearchAddonSpec é usado para desativar complementos na pesquisa. Por padrão, se esse campo não for especificado, os complementos serão ativados sempre que aplicável.

Representação JSON 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
Campos
semanticAddOnDisabled

boolean

Opcional. Se for verdadeiro, o complemento semântico será desativado. O complemento semântico inclui incorporações e jetstream.
kpiPersonalizationAddOnDisabled

boolean

Opcional. Se for "true", desativa a nova classificação e a personalização de eventos para otimizar os KPIs e personalizar os resultados.
generativeAnswerAddOnDisabled

boolean

Opcional. Se for verdadeiro, o complemento de respostas generativas será desativado. O complemento de respostas generativas inclui linguagem natural para filtros e respostas simples.

ModelConfigInfo

A visualização resolvida do lado do servidor da configuração do seletor de modelos para o usuário final. O back-end calcula isso por solicitação aplicando, em ordem: avaliação de flags do Mendel, regras de disponibilidade regional com base na localização do mecanismo e substituições do painel de administração de modelConfigs.

O back-end é a única fonte de verdade para essa configuração. Os clientes precisam renderizar resolvedModels diretamente no menu suspenso do seletor de modelos, na ordem fornecida, sem aplicar filtragem, ordenação ou localização próprias.

Representação JSON 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string,
  "autoModelId": string
}
Campos
resolvedModels[]

object (ResolvedModel)

Apenas saída. A lista de modelos disponíveis para o usuário final no seletor de modelos, na ordem em que devem ser exibidos.
defaultModelId

string

Apenas saída. O modelId do modelo que deve ser selecionado por padrão no seletor quando o usuário final não fez uma escolha explícita. O valor é sempre um dos modelIds presentes em resolvedModels.
autoModelId

string

Apenas saída. O modelId que um cliente precisa enviar quando o usuário final escolhe a entrada "Automático" (o modelId vazio).

Preenchido apenas para plataformas que não têm um modo "Automático" verdadeiro. Nesses casos, deixar o modelo sem definição faria com que ele voltasse a um padrão da plataforma em vez de um modelo escolhido pelo back-end. Vazio em todas as outras plataformas, quando "Auto" é resolvido do lado do servidor e quando nenhum dos modelos classificados da plataforma está disponível. Quando definido, ele é sempre um dos modelIds não vazios presentes em resolvedModels.

ResolvedModel

Um único modelo resolvido para ficar disponível ao usuário final no seletor de modelos, com todos os metadados de exibição localizados.

Representação JSON 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "label": string,
  "adminView": {
    object (AdminView)
  },
  "promoted": boolean,
  "iconUrl": string,
  "family": string
}
Campos
modelId

string

Apenas saída. Identificador exclusivo do modelo (por exemplo, gemini-2.5-flash, gemini-3.1-pro-preview).

É o mesmo identificador que os clientes transmitem de volta ao serviço do Google Assistente para selecionar esse modelo. Modelos virtuais / "pseudo" (por exemplo, gemini-fast) também são valores válidos aqui. Eles são resolvidos para o modelo concreto subjacente no back-end.
displayName

string

Apenas saída. Nome de exibição localizado do modelo (por exemplo, Gemini 3.1 Pro). Localizado do lado do servidor com base no LookupWidgetConfigRequest.language_code e no LookupWidgetConfigRequest.region_code da solicitação.
icon

string

Apenas saída. Token de ícone compatível com GM3 associado ao modelo (por exemplo, rocket_launch, bolt, graph_5).
description

string

Apenas saída. Texto de descrição localizada (por exemplo, state-of-the-art reasoning). Localizado usando a mesma localidade de displayName.
isPreview

boolean

Apenas saída. Se o modelo está em pré-lançamento. Os clientes precisam mostrar isso com um selo "Prévia" na UI do seletor.
label

string

Apenas saída. Rótulo curto mostrado no ícone da barra de seleção compacta (por exemplo, 3.x Flash) em vez do displayName completo (Gemini 3.x Flash). Volta para displayName quando o registro de back-end não especifica um rótulo curto distinto.
adminView

object (AdminView)

Apenas saída. Metadados da interface do administrador, preenchidos apenas para a página de controle de recursos do administrador do console (consulte AdminView). Não definido para interfaces de usuário final.
promoted

boolean

Apenas saída. Se este modelo deve ser promovido no banner da página inicial do chat da GE.
iconUrl

string

Apenas saída. URL absoluto de uma marca a ser renderizada em vez de icon, para modelos em que o logotipo do fornecedor não é um glifo GM3.

O icon permanece preenchido como substituto. Assim, um cliente que não renderiza imagens ou não consegue buscar essa imagem mostra o glifo em vez de nada.
family

string

Apenas saída. Agrupa modelos que são renderizados juntos no seletor. Os modelos que compartilham um valor formam um grupo. Se estiver vazio, o modelo não pertence a nenhum grupo.

Comparado apenas para igualdade. Nunca é analisado nem mostrado a um usuário, portanto, não é localizado.

AdminView

Metadados da interface do administrador. Preenchido apenas quando a solicitação é originada da página "Controle de recursos" do administrador do console do Cloud. Não definido para interfaces de usuário final (Web, dispositivos móveis). Permite que a página Administrador renderize a tabela de alternância diretamente do back-end, em vez de um registro codificado do lado do cliente.

Representação JSON 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
Campos
adminOverridable

boolean

Apenas saída. Se o administrador pode alternar o estado ativado/desativado deste modelo usando UiSettings.model_configs. Derivado de MODEL_TAG_ADMIN_OVERRIDABLE. Quando é "false", o modelo é "forçado" e o estado dele é governado por enabledByDefault.
enabledByDefault

boolean

Apenas saída. Indica se o modelo está ativado quando o administrador não define uma substituição explícita em UiSettings.model_configs. Derivado de MODEL_TAG_ENABLED_BY_DEFAULT.
regions[]

string

Apenas saída. Regiões em que esse modelo é lançado.

AccessSettings

Descreve as configurações de acesso a widgets.

Representação JSON 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
Campos
allowPublicAccess

boolean

Se o acesso público não autenticado é permitido.
allowlistedDomains[]

string

Lista de domínios que podem integrar o widget da Pesquisa.
enableWebApp

boolean

Se o acesso ao app da Web está ativado.
workforceIdentityPoolProvider

string

Opcional. O provedor de pool de identidade de força de trabalho usado para acessar o widget.
languageCode

string

Opcional. Código do idioma da interface do usuário. Use tags de idioma definidas pelo BCP47. Se não for definido, o código de idioma padrão será "en-US".

UiBrandingSettings

Descreve as configurações de branding da UI do widget.

Representação JSON 
{
  "logo": {
    object (Image)
  }
}
Campos

Imagem

Opções para armazenar uma imagem.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "url": string
  // End of mutually exclusive fields.
}
Campos
Várias maneiras de armazenar uma imagem, ou seja, como um URL ou uma string codificada em base64. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
url

string

URL da imagem.
Fim dos campos mutuamente exclusivos.

HomepageSetting

Descreve a configuração da página inicial do widget. Ela inclui todas as configurações e configurações relacionadas à página inicial, como atalhos.

Representação JSON 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
Campos
shortcuts[]

object (Shortcut)

Opcional. Os atalhos que serão exibidos na página inicial.

Atalho

Descreve uma entidade de atalho (também conhecido como conteúdo fixado) na página inicial. A página inicial vai renderizar esses atalhos na mesma ordem em que a API os retorna. Se um cliente quiser reordenar ou remover um atalho, a UI sempre vai fornecer a nova lista completa de atalhos.

Representação JSON 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
Campos
title

string

Opcional. Título do atalho.
icon

object (Image)

Opcional. URL do ícone do atalho.
destinationUri

string

Opcional. URL de destino do atalho.

AssistantSettings

Descreve as configurações do assistente do widget.

Representação JSON 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
Campos
googleSearchGroundingEnabled
(deprecated)

boolean

Se a chave de ativação/desativação do embasamento da Pesquisa Google é mostrada ou não. Obsoleto. Use webGroundingType.
webGroundingType

enum (WebGroundingType)

Opcional. O tipo de embasamento da Web a ser usado.
defaultWebGroundingToggleOff

boolean

Apenas saída. Esse campo controla a opção de ativação/desativação padrão da fundamentação na Web para usuários finais se webGroundingType estiver definido como WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Por padrão, esse campo é definido como "false". Se webGroundingType for WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, os usuários finais terão o embasamento na Web ativado por padrão na interface. Se for "true", a opção de ativar/desativar o embasamento será desativada por padrão na UI. Os usuários finais ainda podem ativar o embasamento da Web na UI se ele estiver ativado.
disableLocationContext

boolean

Opcional. Apenas saída. Se o contexto de localização do usuário deve ser desativado.

WebGroundingType

O tipo de embasamento da Web a ser usado.

Tipos enumerados
WEB_GROUNDING_TYPE_UNSPECIFIED Configuração padrão não especificada. É o mesmo que "desativado".
WEB_GROUNDING_TYPE_DISABLED O embasamento na Web está desativado.

CustomerProvidedConfig

Configurações fornecidas pelo cliente.

Representação JSON 
{
  "customerType": enum (CustomerType),
  "complianceLevel": enum (ComplianceLevel)
}
Campos
customerType

enum (CustomerType)

Tipo de cliente.
complianceLevel

enum (ComplianceLevel)

Apenas saída. O nível de compliance do Assured Workloads do cliente.

customerType recolhe todos os níveis de compliance em um único valor GOVERNMENT_CUSTOMER. Portanto, um cliente que restringe um recurso em um nível específico em vez de no status do governo como um todo precisa ler esse campo.

CustomerType

Tipo de cliente.

Tipos enumerados
DEFAULT_CUSTOMER Tipo de cliente padrão.
GOVERNMENT_CUSTOMER Tipo de cliente governamental. Alguns recursos estão desativados para clientes do governo devido a requisitos legais.

ComplianceLevel

Nível de compliance do Assured Workloads do projeto do cliente.

Não congelado: outros níveis podem ser adicionados à medida que mais regimes de compliance forem aceitos. Portanto, um cliente precisa tratar um valor não reconhecido como restrito pelo governo, e não como irrestrito.

Tipos enumerados
COMPLIANCE_LEVEL_UNSPECIFIED O projeto não tem um nível de compliance do Assured Workloads ou informa um que esta versão da API não modela.
COMPLIANCE_LEVEL_FEDRAMP_HIGH Nível de conformidade do FedRAMP de nível alto.
COMPLIANCE_LEVEL_IL4 Nível de compliance do nível de impacto 4 (IL4).
COMPLIANCE_LEVEL_IL5 Nível de compliance do nível de impacto 5 (IL5).

BatchAuthStatus

Descreve o status da autorização em lote de um batchAuthorizationGroup.

Representação JSON 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
Campos
placeholder

string

Apenas saída. É o nome completo do recurso do marcador de posição do grupo de autorização em lote. Este não é um conector de dados real (não existe na tabela DataConnector no Spanner). É um nome de recurso que existe apenas em "connector_authorization" na tabela de usuários. Por exemplo, projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.
batchAuthorizationGroup

string

Apenas saída. O grupo de autorização em lote a que o marcador de posição pertence.
connectorAuthState

object (ConnectorAuthState)

Apenas saída. O estado de autorização atual para este conector.

Nó

Representa uma única unidade computacional ou lógica reutilizável.

Representação JSON 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
Campos
displayName

string

Apenas saída. Um nome legível para o nó.
iconUrl

string

Apenas saída. Um identificador ou URL que aponta para um ícone que representa esse tipo de nó.
description

string

Apenas saída. Uma descrição detalhada do que o nó faz.
parameterSchema

object (Struct format)

Apenas saída. O esquema de parâmetros da ferramenta.

Espera-se que esse esquema esteja em conformidade com o padrão de esquema OpenAPI (consulte https://spec.openapis.org/oas/v3.0.3.html e AIP-146). Ele descreve a estrutura esperada dos parâmetros aceitos por esse nó.
outputSchema

object (Struct format)

Apenas saída. O esquema de saída da ferramenta.

Espera-se que esse esquema esteja em conformidade com o padrão de esquema OpenAPI (consulte https://spec.openapis.org/oas/v3.0.3.html/ e AIP-146). Ele descreve a estrutura da saída produzida por esse nó.
type

enum (Type)

Apenas saída. O tipo do nó.

Tipo

Identifica o tipo do nó no fluxo do agente.

Tipos enumerados
TYPE_UNSPECIFIED Tipo não especificado.
TRIGGER Tipo de gatilho.
FLOW tipo de fluxo.
CONNECTOR Tipo de conector.

Métodos

get

 Recebe um WidgetConfig.

patch

 Atualiza um WidgetConfig.