- 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
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 ( |
Campos | |
---|---|
name |
Imutável. O nome completo do recurso da configuração do widget. Formato: Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres. |
displayName |
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 |
Apenas saída. Data/hora de criação do 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: |
updateTime |
Apenas saída. Data/hora em que o 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: |
enableAutocomplete |
Se deve ou não ativar a conclusão automática. |
fieldsUiComponentsMap |
A chave é o componente da IU. Simulação. Atualmente, são suportados 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. |
facetField[] |
A configuração e o aspeto das facetas na vista do utilizador final. |
dataStoreType |
Apenas saída. O tipo do arquivo de dados principal. |
contentSearchSpec |
A especificação de pesquisa de conteúdo que configura o comportamento desejado da pesquisa de conteúdo. |
enableSummarization |
Ativar ou desativar a geração de resumos para a resposta de pesquisa. |
enableSnippetResultSummary |
Ative ou desative o resumo para cada resultado de fragmento. |
configId |
Apenas saída. Identificador único ocultado de um |
enableQualityFeedback |
Ativar ou desativar a recolha de feedback sobre a qualidade dos resultados da pesquisa dos utilizadores finais. |
solutionType |
Obrigatório. Imutável. Especifica o tipo de solução para o qual esta WidgetConfig pode ser usada. |
industryVertical |
Apenas saída. A vertical da indústria que o WidgetConfig regista. O vertical da indústria WidgetConfig baseia-se no |
allowPublicAccess |
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[] |
Domínios na lista de autorizações que podem carregar este widget. |
enableSafeSearch |
Ativar ou não a pesquisa segura. |
enableConversationalSearch |
Se deve permitir a pesquisa conversacional (GML, várias interações) ou não (não GML, interação única). |
llmEnabled |
Apenas saída. Se o MDG está ativado no arquivo de dados correspondente. |
enableResultScore |
Mostrar ou não a pontuação do resultado. |
resultDisplayType |
O tipo de fragmento a apresentar no widget do UCS.
|
minimumDataTermAccepted |
Apenas saída. Se o cliente aceitou os termos de utilização de dados. |
enableWebApp |
Ativar ou não a app Web autónoma. |
dataStoreUiConfigs[] |
Configurações da IU configuráveis por arquivo de dados. |
collectionComponents[] |
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 |
Se deve ativar o comportamento de pesquisa à medida que escreve para o widget de pesquisa |
defaultSearchRequestOrderBy |
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 |
Permite ativar/desativar funcionalidades instáveis/experimentais no widget (ou na app Web) |
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 |
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 |
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 |
Opcional. Descreve as definições da página inicial do widget. |
assistantSettings |
Opcional. Apenas saída. Descreve as definições do assistente do widget. |
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 |
Opcional. Apenas saída. Se quer ativar o Gráfico de Conhecimento privado. |
UIComponentField
Campo de faceta que é mapeado para um componente da IU.
Representação JSON |
---|
{
"field": string,
"deviceVisibility": [
enum ( |
Campos | |
---|---|
field |
Obrigatório. Nome do campo registado. O formato é |
deviceVisibility[] |
A visibilidade dos campos em diferentes tipos de dispositivos. |
displayTemplate |
O modelo para personalizar a forma como o campo é apresentado. Um valor de exemplo seria uma string com o seguinte aspeto: "Preço: {value}". |
DeviceVisibility
A visibilidade do campo em diferentes tipos de dispositivos.
Enumerações | |
---|---|
DEVICE_VISIBILITY_UNSPECIFIED |
Valor predefinido quando não especificado. O servidor devolve INVALID_ARGUMENT se for usado em pedidos. |
MOBILE |
O componente da IU é visível em dispositivos móveis. |
DESKTOP |
O componente da IU é visível no cliente baseado no navegador. |
FacetField
Campos de facetas que armazenam o mapeamento de campos para a apresentação do widget do utilizador final.
Representação JSON |
---|
{ "field": string, "displayName": string } |
Campos | |
---|---|
field |
Obrigatório. Nome do campo registado. O formato é |
displayName |
Opcional. O nome do campo que os utilizadores finais veem. |
DataStoreType
O tipo do arquivo de dados principal do widget.
Enumerações | |
---|---|
DATA_STORE_TYPE_UNSPECIFIED |
Tipo de arquivo de dados não especificado. |
SITE_SEARCH |
O arquivo de dados principal contém um motor de pesquisa de sites. |
STRUCTURED |
O arquivo de dados principal contém um motor de pesquisa para dados estruturados. |
UNSTRUCTURED |
O arquivo de dados principal contém um motor de pesquisa para dados não estruturados. |
BLENDED |
O arquivo de dados principal é publicado para a pesquisa combinada com vários arquivos de dados. |
ResultDisplayType
O tipo de resultado a apresentar no widget do UCS.
Enumerações | |
---|---|
RESULT_DISPLAY_TYPE_UNSPECIFIED |
Tipo de apresentação não especificado (predefinição para mostrar fragmento). |
SNIPPET |
Apresentar resultados do campo de fragmento. |
EXTRACTIVE_ANSWER |
Apresentar resultados do campo de respostas extrativas. |
DataStoreUiConfig
Configuração de componentes da IU para o arquivo de dados.
Representação JSON |
---|
{ "name": string, "id": string, "facetField": [ { object ( |
Campos | |
---|---|
name |
O nome do arquivo de dados. Deve ser o formato do nome do recurso da loja de dados: |
id |
Apenas saída. O identificador do repositório de dados, usado para o serviço de widgets. Por agora, refere-se a dataStoreId. No futuro, vamos migrar o campo para o UUID do nome da loja de dados encriptada. |
facetField[] |
Campos de facetas que armazenam o mapeamento de campos para a apresentação do widget do utilizador final. |
fieldsUiComponentsMap |
A chave é o componente da IU. Simulação. Atualmente, são suportados 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. |
CollectionComponent
Componente de coleção só de leitura que contém campos de coleções de armazenamento 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. Deve ser o nome do recurso da coleção. Formato: |
id |
Apenas saída. O identificador da recolha, usado para o serviço de widgets. Por agora, refere-se a collectionId. No futuro, vamos migrar o campo para o UUID do nome da coleção encriptado. |
displayName |
O nome a apresentar da coleção. |
dataStoreComponents[] |
Para a recolha da loja de dados, lista das lojas de dados secundárias. |
dataSource |
O nome da origem de dados, obtido a partir de |
dataSourceDisplayName |
Apenas saída. O nome a apresentar da origem de dados. |
connectorIconLink |
Apenas saída. O link do ícone da origem do conetor. |
DataStoreComponent
Componente de arquivo de dados só de leitura que contém campos de arquivos de dados que podem ser usados para filtragem. É o elemento secundário de CollectionComponent
.
Representação JSON |
---|
{ "name": string, "id": string, "displayName": string, "entityName": string, "workspaceType": enum ( |
Campos | |
---|---|
name |
O nome do arquivo de dados. Deve ser o formato do nome do recurso da loja de dados: |
id |
Apenas saída. O identificador do repositório de dados, usado para o serviço de widgets. Por agora, refere-se a dataStoreId. No futuro, vamos migrar o campo para o UUID do nome da loja de dados encriptada. |
displayName |
O nome a apresentar da loja de dados. |
entityName |
O nome da entidade, obtido a partir de |
workspaceType |
Apenas saída. Tipos de fontes do Workspace para dados do Workspace, obtidos a partir de |
contentConfig |
Apenas saída. A configuração de conteúdo do arquivo de dados. |
dataStoreConfigType |
Apenas saída. O tipo de configuração do armazenamento de dados. |
DataStoreConfigType
O tipo de configuração do armazenamento de dados.
Enumerações | |
---|---|
DATA_STORE_CONFIG_TYPE_UNSPECIFIED |
Valor predefinido. Este valor não é usado. |
ALLOW_DB_CONFIG |
O arquivo de dados está associado ao AlloyDB |
THIRD_PARTY_OAUTH_CONFIG |
O armazenamento de dados está associado a uma origem de dados de terceiros. |
NOTEBOOKLM_CONFIG |
O repositório de dados está ligado ao NotebookLM Enterprise. |
UiSettings
Descreve as definições gerais da IU do widget (ou da app Web), conforme apresentadas na página de configuração da IU da consola na nuvem.
Representação JSON |
---|
{ "interactionType": enum ( |
Campos | |
---|---|
interactionType |
Descreve o tipo de interação do widget (ou da app Web) |
generativeAnswerConfig |
Descreve a configuração das respostas generativas. |
resultDescriptionType |
Controla se o trecho do resultado é apresentado e como (fragmento ou resposta extrativa). A predefinição é nenhum resultado se não for especificado. |
enableAutocomplete |
Se deve ou não ativar a conclusão automática. |
enableSafeSearch |
Ativar ou não a pesquisa segura. |
enableQualityFeedback |
Ativar ou desativar a recolha de feedback sobre a qualidade dos resultados da pesquisa dos utilizadores finais. |
enableSearchAsYouType |
Se deve ativar o comportamento de pesquisa à medida que escreve para o widget de pesquisa. |
defaultSearchRequestOrderBy |
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 |
dataStoreUiConfigs[] |
Por configuração do arquivo de dados. |
disableUserEventsCollection |
Se estiver definida como verdadeira, o widget não recolhe eventos do utilizador. |
enableVisualContentSummary |
Se estiver definida como verdadeira, o widget ativa o resumo de conteúdo visual em pedidos de pesquisa aplicáveis. Usado apenas pela pesquisa de cuidados de saúde. |
enablePeopleSearch |
Opcional. Se estiver definida como verdadeira, o widget permite a pesquisa de pessoas. |
enableCreateAgentButton |
Opcional. Se estiver definida como verdadeira, o widget ativa o botão de criação de agente. |
features |
Apenas saída. Configuração de funcionalidades para o motor ativar ou desativar funcionalidades. Chaves suportadas:
|
InteractionType
Descreve o tipo de interação.
Enumerações | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Não especificado. A predefinição é SEARCH_ONLY. |
SEARCH_ONLY |
Pesquise sem uma resposta generativa. |
SEARCH_WITH_ANSWER |
Pesquisar com a resposta generativa. |
SEARCH_WITH_FOLLOW_UPS |
Pesquise com a resposta generativa que suporta perguntas de seguimento. Também conhecida como pesquisa com várias interações. |
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 a partir dos quais a resposta é gerada. Até 10. |
modelVersion |
A versão do modelo usada para gerar a resposta. |
modelPromptPreamble |
Texto no início do comando que dá instruções ao modelo que gera a resposta. |
maxRephraseSteps |
Número máximo de passos de reformulação. O número máximo é de 5 passos. Se não for definido ou for definido como < 1, é definido como 1 por predefinição. |
languageCode |
Código do idioma para o resumo. Use etiquetas de idioma definidas pela norma BCP47. Nota: esta é uma funcionalidade experimental. |
disableRelatedQuestions |
Se a resposta gerada contém perguntas relacionadas sugeridas. |
ignoreNonAnswerSeekingQuery |
Opcional. Especifica se devem ser filtradas as consultas que não procuram respostas. O valor predefinido é Não é devolvida nenhuma resposta se a consulta de pesquisa for classificada como uma consulta que não procura respostas. Se este campo estiver definido como |
ignoreAdversarialQuery |
Opcional. Especifica se devem ser filtradas consultas adversariais. |
ignoreLowRelevantContent |
Opcional. Especifica se devem ser filtradas consultas que não sejam relevantes para o conteúdo. |
imageSource |
Opcional. Origem da imagem devolvida na resposta. |
ImageSource
Origem da imagem devolvida na resposta.
Enumerações | |
---|---|
IMAGE_SOURCE_UNSPECIFIED |
Origem da imagem não especificada (a funcionalidade multimodal está desativada por predefinição) |
ALL_AVAILABLE_SOURCES |
Comportamento quando o serviço determina a seleção a partir de todas as origens disponíveis. |
CORPUS_IMAGE_ONLY |
Incluir imagem do corpus na resposta. |
FIGURE_GENERATION_ONLY |
Aciona a geração de números na resposta. |
FeatureState
O estado da funcionalidade para o motor.
Enumerações | |
---|---|
FEATURE_STATE_UNSPECIFIED |
O estado da funcionalidade não está especificado. |
FEATURE_STATE_ON |
A funcionalidade está ativada para ser acessível. |
FEATURE_STATE_OFF |
A funcionalidade está desativada para ficar inacessível. |
AccessSettings
Descreve as definiçõ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 autorizados a integrar o widget de pesquisa. |
enableWebApp |
Se o acesso à app Web está ativado. |
workforceIdentityPoolProvider |
Opcional. O fornecedor do Workload Identity Pool usado para aceder ao widget. |
languageCode |
Opcional. Código do idioma da interface do utilizador. Use etiquetas de idioma definidas pela norma BCP47. Se não estiver definido, o código de idioma predefinido é "en-US". |
UiBrandingSettings
Descreve as definições de branding da IU do widget.
Representação JSON |
---|
{
"logo": {
object ( |
Campos | |
---|---|
logo |
Imagem de logótipo. |
Imagem
Opções para armazenar uma imagem.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união storage_method . Várias formas de armazenar uma imagem, ou seja, como um URL ou uma string codificada em base64. storage_method só pode ser uma das seguintes opções: |
|
url |
URL da imagem. |
HomepageSetting
Descreve a definição da página inicial do widget. Inclui todas as definições e configurações relacionadas com a página inicial, como atalhos.
Representação JSON |
---|
{
"shortcuts": [
{
object ( |
Campos | |
---|---|
shortcuts[] |
Opcional. Os atalhos a apresentar 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 conhecida como conteúdo fixado) na página inicial. A página inicial renderiza estes atalhos pela mesma ordem que a API devolve. Se um cliente quiser reordenar ou remover um atalho, a IU deve fornecer sempre 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 definições do assistente do widget.
Representação JSON |
---|
{
"googleSearchGroundingEnabled": boolean,
"webGroundingType": enum ( |
Campos | |
---|---|
googleSearchGroundingEnabled |
Se o botão ativar/desativar de fundamentação da Pesquisa Google é apresentado ou não. Descontinuado. Em alternativa, use |
webGroundingType |
Opcional. O tipo de baseamento na Web a usar. |
defaultWebGroundingToggleOff |
Apenas saída. Este campo controla a ativação/desativação da base Web predefinida para os utilizadores finais se |
disableLocationContext |
Opcional. Apenas saída. Se deve desativar o contexto de localização do utilizador. |
WebGroundingType
O tipo de baseamento na Web a usar.
Enumerações | |
---|---|
WEB_GROUNDING_TYPE_UNSPECIFIED |
Predefinição, definição não especificada. Isto é o mesmo que desativado. |
WEB_GROUNDING_TYPE_DISABLED |
A verificação da Web está desativada. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
A fundamentação com a Pesquisa Google está ativada. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
A fundamentação com a pesquisa Web empresarial está ativada. |
CustomerProvidedConfig
Configurações fornecidas pelo cliente.
Representação JSON |
---|
{
"customerType": enum ( |
Campos | |
---|---|
customerType |
Tipo de cliente. |
CustomerType
Tipo de cliente.
Enumerações | |
---|---|
DEFAULT_CUSTOMER |
Tipo de cliente predefinido. |
GOVERNMENT_CUSTOMER |
Tipo de cliente governamental. Algumas funcionalidades estão desativadas para clientes governamentais devido a requisitos legais. |
Métodos |
|
---|---|
|
Obtém um WidgetConfig . |