- Recurso: WidgetConfig
- Representação JSON
- UIComponentField
- DeviceVisibility
- FacetField
- DataStoreType
- ResultDisplayType
- DataStoreUiConfig
- CollectionComponent
- DataStoreComponent
- DataStoreConfigType
- UiSettings
- InteractionType
- GenerativeAnswerConfig
- ImageSource
- FeatureState
- AccessSettings
- UiBrandingSettings
- Imagem
- HomepageSetting
- Atalho
- AssistantSettings
- WebGroundingType
- CustomerProvidedConfig
- CustomerType
- Métodos
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 ( |
Campos | |
---|---|
name |
Imutável. O nome completo do recurso da configuração do widget. Formato: Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres. |
displayName |
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 |
Apenas saída. Carimbo de data/hora em que 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: |
updateTime |
Apenas saída. Carimbo de data/hora da atualização do 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: |
enableAutocomplete |
Se o preenchimento automático deve ser ativado. |
fieldsUiComponentsMap |
A chave é o componente de UI. Mock. Atualmente, são aceitos 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. |
facetField[] |
A configuração e a aparência das facetas na visualização do usuário final. |
dataStoreType |
Apenas saída. O tipo do repositório de dados principal. |
contentSearchSpec |
A especificação de pesquisa de conteúdo que configura o comportamento desejado da pesquisa de conteúdo. |
enableSummarization |
Ative ou desative o resumo da resposta da pesquisa. |
enableSnippetResultSummary |
Ative ou desative o resumo para cada resultado de trecho. |
configId |
Apenas saída. Identificador exclusivo ofuscado de uma |
enableQualityFeedback |
Ative ou desative a coleta de feedback sobre a qualidade dos resultados da pesquisa dos usuários finais. |
solutionType |
Obrigatório. Imutável. Especifica o tipo de solução para que este WidgetConfig pode ser usado. |
industryVertical |
Apenas saída. O segmento do setor que o WidgetConfig registra. O setor vertical WidgetConfig é baseado no |
allowPublicAccess |
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[] |
Domínios na lista de permissões que podem carregar este widget. |
enableSafeSearch |
Se a pesquisa segura precisa ser ativada. |
enableConversationalSearch |
Se a pesquisa conversacional (LLM, várias interações) é permitida ou não (não LLM, uma interação). |
llmEnabled |
Apenas saída. Se o LLM está ativado no repositório de dados correspondente. |
enableResultScore |
Indica se a pontuação do resultado será mostrada. |
resultDisplayType |
O tipo de snippet a ser exibido no widget do UCS.
|
minimumDataTermAccepted |
Apenas saída. Se o cliente aceitou os termos de uso de dados. |
enableWebApp |
Define se o app da Web independente será ativado. |
dataStoreUiConfigs[] |
Configurações de interface configuráveis por repositório de dados. |
collectionComponents[] |
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 |
Se o comportamento de pesquisa enquanto você digita deve ser ativado para o widget de pesquisa. |
defaultSearchRequestOrderBy |
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 |
Permite ativar/desativar recursos instáveis/experimentais no widget (ou app da Web). |
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 |
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 |
Descreve as configurações de branding da UI do widget de pesquisa, como título, logotipo, favicons e cores. |
homepageSetting |
Opcional. Descreve as configurações da página inicial do widget. |
assistantSettings |
Opcional. Apenas saída. Descreve as configurações do widget do Google Assistente. |
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 |
Opcional. Apenas saída. Define se o Mapa de informações particulares será ativado. |
UIComponentField
Campo de refinamento que mapeia para um componente de UI.
Representação JSON |
---|
{
"field": string,
"deviceVisibility": [
enum ( |
Campos | |
---|---|
field |
Obrigatório. Nome do campo registrado. O formato é |
deviceVisibility[] |
A visibilidade do campo em diferentes tipos de dispositivos. |
displayTemplate |
O modelo para personalizar a forma como o campo é exibido. 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 UI está visível no cliente baseado em navegador. |
FacetField
Campos de refinamento 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 |
Obrigatório. Nome do campo registrado. O formato é |
displayName |
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. |
SITE_SEARCH |
O repositório de dados principal contém um mecanismo de pesquisa do site. |
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 "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 ( |
Campos | |
---|---|
name |
O nome do repositório de dados. Ele precisa estar no formato do nome do recurso do repositório de dados: |
id |
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[] |
Campos de refinamento que armazenam o mapeamento de campos para a aparência do widget do usuário final. |
fieldsUiComponentsMap |
A chave é o componente de UI. Mock. Atualmente, são aceitos 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. |
CollectionComponent
Componente de coleção somente leitura que contém campos de coleções do repositório de dados que podem ser usados para filtragem.
Representação JSON |
---|
{
"name": string,
"id": string,
"displayName": string,
"dataStoreComponents": [
{
object ( |
Campos | |
---|---|
name |
O nome da coleção. Ele precisa ser o nome do recurso da coleção. Formato: |
id |
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. |
displayName |
O nome de exibição da coleção. |
dataStoreComponents[] |
Para a coleção de repositório de dados, liste os repositórios de dados filhos. |
dataSource |
O nome da fonte de dados, extraído de |
dataSourceDisplayName |
Apenas saída. O nome de exibição da fonte de dados. |
connectorIconLink |
Apenas saída. O link do ícone da origem do conector. |
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, "workspaceType": enum ( |
Campos | |
---|---|
name |
O nome do repositório de dados. Ele precisa estar no formato do nome do recurso do repositório de dados: |
id |
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 |
O nome de exibição do repositório de dados. |
entityName |
O nome da entidade, recuperado de |
workspaceType |
Apenas saída. Tipos de fontes do Workspace para dados do Workspace, recuperados de |
contentConfig |
Apenas saída. A configuração de conteúdo do repositório de dados. |
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. |
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 ( |
Campos | |
---|---|
interactionType |
Descreve o tipo de interação do widget (ou app da Web). |
generativeAnswerConfig |
Descreve a configuração de respostas generativas. |
resultDescriptionType |
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 |
Se o preenchimento automático deve ser ativado. |
enableSafeSearch |
Se a pesquisa segura precisa ser ativada. |
enableQualityFeedback |
Ative ou desative a coleta de feedback sobre a qualidade dos resultados da pesquisa dos usuários finais. |
enableSearchAsYouType |
Se o comportamento de pesquisa enquanto você digita deve ser ativado para o widget de pesquisa. |
defaultSearchRequestOrderBy |
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[] |
Por configuração de repositório de dados. |
disableUserEventsCollection |
Se definido como verdadeiro, o widget não vai coletar eventos do usuário. |
enableVisualContentSummary |
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. |
enablePeopleSearch |
Opcional. Se definido como "true", o widget vai ativar a pesquisa de pessoas. |
enableCreateAgentButton |
Opcional. Se definido como "true", o widget vai ativar o botão "Criar agente". |
features |
Apenas saída. Configuração de recursos para o mecanismo ativar ou desativar recursos. Chaves compatíveis:
|
InteractionType
Descreve o tipo de interação.
Tipos enumerados | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Não especificado. O padrão é SEARCH_ONLY. |
SEARCH_ONLY |
Pesquise 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 ( |
Campos | |
---|---|
resultCount |
O número de principais resultados para gerar a resposta. Até 10. |
modelVersion |
A versão do modelo usada para gerar a resposta. |
modelPromptPreamble |
Texto no início do comando que instrui o modelo a gerar a resposta. |
maxRephraseSteps |
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 |
Código do idioma do resumo. Use tags de idioma definidas pelo BCP47 (em inglês). Observação: este é um recurso experimental. |
disableRelatedQuestions |
Se a resposta gerada contém perguntas relacionadas sugeridas. |
ignoreNonAnswerSeekingQuery |
Opcional. Especifica se as consultas que não buscam respostas devem ser filtradas. O valor padrão é Nenhuma resposta é retornada se a consulta de pesquisa for classificada como uma consulta que não busca respostas. Se este campo estiver definido como |
ignoreAdversarialQuery |
Opcional. Especifica se as consultas adversárias devem ser filtradas. |
ignoreLowRelevantContent |
Opcional. Especifica se as consultas que não são relevantes para o conteúdo devem ser filtradas. |
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 é desativado para ficar inacessível. |
AccessSettings
Descreve as configurações de acesso ao widget.
Representação JSON |
---|
{ "allowPublicAccess": boolean, "allowlistedDomains": [ string ], "enableWebApp": boolean, "workforceIdentityPoolProvider": string, "languageCode": string } |
Campos | |
---|---|
allowPublicAccess |
Se o acesso público não autenticado é permitido. |
allowlistedDomains[] |
Lista de domínios que podem integrar o widget de pesquisa. |
enableWebApp |
Se o acesso ao app da Web está ativado. |
workforceIdentityPoolProvider |
Opcional. O provedor de pool de identidade de força de trabalho usado para acessar o widget. |
languageCode |
Opcional. Código do idioma da interface do usuário. Use tags de idioma definidas pelo BCP47 (em inglês). 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 ( |
Campos | |
---|---|
logo |
Imagem do logotipo. |
Imagem
Opções para armazenar uma imagem.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união storage_method . Várias maneiras de armazenar uma imagem, ou seja, como um URL ou uma string codificada em base64. storage_method pode ser apenas de um dos tipos a seguir: |
|
url |
URL da imagem. |
HomepageSetting
Descreve a configuração da página inicial do widget. Isso inclui todas as configurações e configurações relacionadas à página inicial, como atalhos.
Representação JSON |
---|
{
"shortcuts": [
{
object ( |
Campos | |
---|---|
shortcuts[] |
Opcional. Os atalhos a serem mostrados na página inicial. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number) |
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 ( |
Campos | |
---|---|
title |
Opcional. Título do atalho. |
icon |
Opcional. URL do ícone do atalho. |
destinationUri |
Opcional. URL de destino do atalho. |
AssistantSettings
Descreve as configurações do widget do Google Assistente.
Representação JSON |
---|
{
"googleSearchGroundingEnabled": boolean,
"webGroundingType": enum ( |
Campos | |
---|---|
googleSearchGroundingEnabled |
Indica se a opção de ativação/desativação da fundamentação da Pesquisa Google é mostrada. Obsoleto. Use |
webGroundingType |
Opcional. O tipo de embasamento da Web a ser usado. |
defaultWebGroundingToggleOff |
Apenas saída. Esse campo controla a alternância padrão de embasamento na Web para usuários finais se |
disableLocationContext |
Opcional. Apenas saída. Indica 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 da Web está desativado. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
O embasamento com a Pesquisa Google está ativado. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
O embasamento com a Pesquisa na Web corporativa está ativado. |
CustomerProvidedConfig
Configurações fornecidas pelo cliente.
Representação JSON |
---|
{
"customerType": enum ( |
Campos | |
---|---|
customerType |
Tipo de cliente. |
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. |
Métodos |
|
---|---|
|
Recebe um WidgetConfig . |