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

Recurso: WidgetConfig

WidgetConfig captura configurações ao 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 tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
displayName

string

Obrigatório. O nome a apresentar da configuração do widget legível por humanos. Usado na IU do Discovery.

Este campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
createTime

string (Timestamp format)

Apenas saída. Data/hora de criação do WidgetConfig.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. Data/hora em que o WidgetConfig foi atualizado.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
enableAutocomplete
(deprecated)

boolean

Se deve ou não ativar a conclusão automática.
fieldsUiComponentsMap
(deprecated)

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

A chave é o componente da IU. Simulação. Atualmente, são suportados title, thumbnail, url, custom1, custom2 e custom3.

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

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

object (FacetField)

A configuração e o aspeto das facetas na vista do utilizador final.
dataStoreType

enum (DataStoreType)

Apenas saída. O tipo do arquivo 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

Ativar ou desativar a geração de resumos para a resposta de pesquisa.
enableSnippetResultSummary
(deprecated)

boolean

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

string

Apenas saída. Identificador único ocultado de um WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

Ativar ou desativar a recolha de feedback sobre a qualidade dos resultados da pesquisa dos utilizadores finais.
solutionType

enum (SolutionType)

Obrigatório. Imutável. Especifica o tipo de solução para o qual esta WidgetConfig pode ser usada.
industryVertical

enum (IndustryVertical)

Apenas saída. A vertical da indústria que o WidgetConfig regista. O vertical da indústria WidgetConfig baseia-se no Engine associado.
allowPublicAccess
(deprecated)

boolean

Indica se permite a integração sem autenticação com o widget. Se for definido como verdadeiro, o acesso público à pesquisa ou a outras soluções do widget é permitido sem o token de autenticação fornecido pelo servidor de back-end alojado pelo cliente.
allowlistedDomains[]
(deprecated)

string

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

boolean

Apenas saída. Se o MDG está ativado no arquivo de dados correspondente.
enableResultScore

boolean

Mostrar ou não a pontuação do resultado.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

O tipo de fragmento a apresentar no widget do UCS.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED para utilizadores existentes.
  • SNIPPET para novos utilizadores de pesquisa não empresariais.
  • EXTRACTIVE_ANSWER para novos utilizadores da pesquisa empresarial.
minimumDataTermAccepted

boolean

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

boolean

Ativar ou não a app Web autónoma.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Configurações da IU configuráveis por arquivo de dados.
collectionComponents[]

object (CollectionComponent)

Apenas saída. Componentes de recolha que apresentam todas as recolhas e armazenamentos de dados secundários associados à configuração do widget. Essas origens de dados podem ser usadas para filtragem em APIs de serviços de widgets. Os utilizadores podem devolver resultados das origens de dados selecionadas.
enableSearchAsYouType
(deprecated)

boolean

Se deve ativar o comportamento de pesquisa à medida que escreve para o widget de pesquisa
defaultSearchRequestOrderBy
(deprecated)

string

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

Usado para definir SearchRequest#orderBy em pedidos 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 funcionalidades instáveis/experimentais no widget (ou na app Web)
uiSettings

object (UiSettings)

Descreve as definições gerais de pesquisa de widgets, conforme apresentado na página de configuração de widgets da consola na nuvem. Substitui as principais propriedades de nível superior descontinuadas.
accessSettings

object (AccessSettings)

Vai ser usado para todas as definições de acesso aos widgets apresentadas na página de integração da Cloud Console. Substitui as principais propriedades de nível superior descontinuadas.
uiBranding

object (UiBrandingSettings)

Descreve as definições de branding da IU do widget de pesquisa, como o título, o logótipo, os ícones de favoritos e as cores do widget.
homepageSetting

object (HomepageSetting)

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

object (AssistantSettings)

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

object (CustomerProvidedConfig)

Opcional. Apenas saída. Descreve as configurações relacionadas com o cliente, atualmente usadas apenas para clientes governamentais. Não é possível modificar este campo após a integração do projeto.
enablePrivateKnowledgeGraph

boolean

Opcional. Apenas saída. Se quer ativar o Gráfico de Conhecimento privado.

Métodos

get

 Obtém um WidgetConfig.