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,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "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 da configuração do widget legível por humanos. Usado na interface de descoberta.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, será retornado um erro INVALID_ARGUMENT.
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 em que o WidgetConfig foi atualizado.

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

Indica se o preenchimento automático está ativado.
fieldsUiComponentsMap
(deprecated)

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

A chave é o componente da UI. Simulação. Atualmente, há suporte para title, thumbnail, url, custom1, custom2, custom3.

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

Os três campos personalizados são opcionais e podem ser adicionados ou removidos. title, thumbnail, 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 pai.
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

Ativa ou desativa a sumarização da resposta da pesquisa.
enableSnippetResultSummary
(deprecated)

boolean

Ativa ou desativa o resumo de cada resultado de snippet.
configId

string

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

boolean

Ativa ou desativa a coleta de feedback de qualidade do resultado da pesquisa dos usuários finais.
solutionType

enum (SolutionType)

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

enum (IndustryVertical)

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

boolean

Indica se a integração sem autenticação com o widget é permitida. Se definido como verdadeiro, o acesso público à pesquisa ou 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 autorizados que podem carregar esse widget.
llmEnabled

boolean

Apenas saída. Indica 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 mostrado no widget UCS.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED para usuários atuais.
  • SNIPPET para novos usuários de pesquisa não corporativa.
  • EXTRACTIVE_ANSWER para novos usuários de pesquisa corporativa.
minimumDataTermAccepted

boolean

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

boolean

Indica se o app da Web independente está ativado.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

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

object (CollectionComponent)

Apenas saída. Componentes de coleção 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

Indica se o comportamento de pesquisa enquanto você digita está ativado para o widget de pesquisa.
defaultSearchRequestOrderBy
(deprecated)

string

A ordem 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 widget, conforme mostrado na página de configuração do widget do console do Cloud. Substitui as propriedades de nível superior descontinuadas.
accessSettings

object (AccessSettings)

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

object (UiBrandingSettings)

Descreve as configurações de marca da UI do widget de pesquisa, como o título, o logotipo, os favicons e as cores do widget.
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. Indica se o gráfico de conhecimento particular está ativado.
geminiBundle

boolean

Apenas saída. Indica se a assinatura é um pacote do Gemini.
nodes[]

object (Node)

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

Métodos

get

 Recebe um WidgetConfig.

patch

 Atualiza um WidgetConfig.