REST Resource: projects.locations.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,
  "experimentalFeatures": {
    string: string,
    ...
  },
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean
}
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}.

Este 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 do usuário do Discovery.

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.
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 uma 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 setor vertical WidgetConfig é baseado no Engine associado.
allowPublicAccess
(deprecated)

boolean

Indica 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

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

enum (ResultDisplayType)

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

  • RESULT_DISPLAY_TYPE_UNSPECIFIED para usuários atuais.
  • TRECHO para novos usuários da pesquisa não empresarial.
  • EXTRACTIVE_ANSWER para novos usuários da pesquisa empresarial.
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.
enableSearchAsYouType
(deprecated)

boolean

Se o comportamento de pesquisa enquanto você digita deve ser ativado para o widget de 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
experimentalFeatures

map (key: string, value: string)

Permite ativar/desativar recursos instáveis/experimentais no widget (ou app da Web).
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 branding da UI do widget de 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 widget do Google Assistente.
customerProvidedConfig

object (CustomerProvidedConfig)

Opcional. Apenas saída. Descreve as configurações relacionadas ao cliente, atualmente usadas apenas para clientes do governo. 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.

Métodos

get

 Recebe um WidgetConfig.