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

Risorsa: WidgetConfig

WidgetConfig acquisisce le configurazioni a livello di widget.

Rappresentazione 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,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
Campi
name

string

Immutabile. Il nome completo della risorsa della configurazione del widget. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

Questo campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 1024 caratteri.
displayName

string

Obbligatorio. Il nome visualizzato della configurazione del widget leggibile. Utilizzato nell'interfaccia utente di Discovery.

Questo campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
createTime

string (Timestamp format)

Solo output. Timestamp di creazione di WidgetConfig.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. Timestamp dell'aggiornamento di WidgetConfig.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
enableAutocomplete
(deprecated)

boolean

Se attivare o meno il completamento automatico.
fieldsUiComponentsMap
(deprecated)

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

La chiave è il componente UI. Mock. Attualmente supportati title, thumbnail, url, custom1, custom2, custom3.

Il valore è il nome del campo insieme alla visibilità del dispositivo.

I tre campi personalizzati sono facoltativi e possono essere aggiunti o rimossi. title, thumbnail, url sono componenti UI obbligatori che non possono essere rimossi.
facetField[]
(deprecated)

object (FacetField)

La configurazione e l'aspetto dei prospetti nella visualizzazione dell'utente finale.
dataStoreType

enum (DataStoreType)

Solo output. Il tipo di datastore padre.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

La specifica di ricerca dei contenuti che configura il comportamento desiderato della ricerca dei contenuti.
enableSummarization
(deprecated)

boolean

Attiva o disattiva il riepilogo per la risposta di ricerca.
enableSnippetResultSummary
(deprecated)

boolean

Attiva o disattiva il riepilogo per ogni risultato di snippet.
configId

string

Solo output. Identificatore univoco offuscato di un WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

Attiva o disattiva la raccolta del feedback sulla qualità dei risultati di ricerca degli utenti finali.
solutionType

enum (SolutionType)

Obbligatorio. Immutabile. Specifica il tipo di soluzione per cui può essere utilizzato questo WidgetConfig.
industryVertical

enum (IndustryVertical)

Solo output. Il verticale di settore registrato da WidgetConfig. Il verticale del settore WidgetConfig si basa sul Engine associato.
allowPublicAccess
(deprecated)

boolean

Se consentire l'integrazione senza autenticazione con il widget. Se impostato su true, l'accesso pubblico alla ricerca o ad altre soluzioni dal widget è consentito senza token di autenticazione fornito dal server di backend ospitato dal cliente.
allowlistedDomains[]
(deprecated)

string

Domini inclusi nella lista consentita che possono caricare questo widget.
llmEnabled

boolean

Solo output. Indica se l'LLM è abilitato nel datastore corrispondente.
enableResultScore

boolean

Indica se mostrare il punteggio del risultato.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

Il tipo di snippet da visualizzare nel widget UCS.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED per gli utenti esistenti.
  • SNIPPET per i nuovi utenti della ricerca non aziendale.
  • EXTRACTIVE_ANSWER per i nuovi utenti della ricerca a livello aziendale.
minimumDataTermAccepted

boolean

Solo output. Indica se il cliente ha accettato i termini per l'utilizzo dei dati.
enableWebApp
(deprecated)

boolean

Indica se attivare l'app web autonoma.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Configurazioni UI configurabili per datastore.
collectionComponents[]

object (CollectionComponent)

Solo output. Componenti di raccolta che elencano tutte le raccolte e i datastore secondari associati alla configurazione del widget. Queste origini dati possono essere utilizzate per il filtraggio nelle API del servizio widget. Gli utenti possono restituire risultati provenienti dalle origini dati selezionate.

Per i motori SaaS / aziendali, quando LookupWidgetConfig viene chiamato con view = WITH_AVAILABLE_CONNECTORS, questo elenco viene ulteriormente arricchito con voci di segnaposto sintetiche per i connettori che il chiamante può allegare ma non ha ancora allegato (vedi CollectionComponent per il contratto segnaposto). Il frontend può quindi eseguire il rendering di un elenco unificato di origini già allegate e disponibili per l'allegato iterando questo singolo campo. Per i motori Enterprise e per view predefinito, vengono restituiti solo i connettori già collegati (comportamento attuale).
enableSearchAsYouType
(deprecated)

boolean

Se attivare il comportamento di ricerca durante la digitazione per il widget Ricerca
defaultSearchRequestOrderBy
(deprecated)

string

L'ordinamento predefinito dei risultati di ricerca, se specificato.

Utilizzato per impostare SearchRequest#orderBy nelle richieste applicabili. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
uiSettings

object (UiSettings)

Descrive le impostazioni generali di ricerca dei widget visualizzate nella pagina di configurazione dei widget della console Google Cloud. Sostituisce le proprietà di primo livello obsolete.
accessSettings

object (AccessSettings)

Verrà utilizzato per tutte le impostazioni di accesso ai widget visualizzate nella pagina di integrazione della console Google Cloud. Sostituisce le proprietà di primo livello obsolete.
uiBranding

object (UiBrandingSettings)

Descrive le impostazioni di branding dell'interfaccia utente del widget di ricerca, come titolo, logo, favicon e colori del widget.
homepageSetting

object (HomepageSetting)

Facoltativo. Descrive le impostazioni della home page del widget.
assistantSettings

object (AssistantSettings)

Facoltativo. Solo output. Descrive le impostazioni dell'assistente del widget.
customerProvidedConfig

object (CustomerProvidedConfig)

Facoltativo. Solo output. Descrive le configurazioni correlate al cliente, attualmente utilizzate solo per i clienti governativi. Questo campo non può essere modificato dopo l'onboarding del progetto.
enablePrivateKnowledgeGraph

boolean

Facoltativo. Solo output. Se attivare il Knowledge Graph privato.
geminiBundle

boolean

Solo output. Indica se l'abbonamento è un bundle Gemini o meno.
batchAuthStatuses[]

object (BatchAuthStatus)

Solo output. Gli stati di autorizzazione batch per i connettori del widget.
nodes[]

object (Node)

Solo output. I nodi associati alla configurazione del widget.

UIComponentField

Campo sfaccettatura mappato a un componente UI.

Rappresentazione JSON 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
Campi
field

string

Obbligatorio. Nome del campo registrato. Il formato è field.abc.
deviceVisibility[]

enum (DeviceVisibility)

La visibilità dei campi su diversi tipi di dispositivi.
displayTemplate

string

Il modello per personalizzare la visualizzazione del campo. Un valore di esempio potrebbe essere una stringa simile a: "Price: {value}".

DeviceVisibility

La visibilità del campo su diversi tipi di dispositivi.

Enum
DEVICE_VISIBILITY_UNSPECIFIED Valore predefinito se non specificato. Il server restituisce INVALID_ARGUMENT se utilizzato nelle richieste.
MOBILE Il componente UI è visibile sui dispositivi mobili.
DESKTOP Il componente UI è visibile sul client basato su browser.

FacetField

Campi delle sfaccettature che memorizzano la mappatura dei campi all'aspetto del widget per l'utente finale.

Rappresentazione JSON 
{
  "field": string,
  "displayName": string
}
Campi
field

string

Obbligatorio. Nome del campo registrato. Il formato è field.abc.
displayName

string

Facoltativo. Il nome del campo che vedranno gli utenti finali.

DataStoreType

Il tipo di datastore principale del widget.

Enum
DATA_STORE_TYPE_UNSPECIFIED Tipo di datastore non specificato.
STRUCTURED Il datastore principale contiene un motore di ricerca per dati strutturati.
UNSTRUCTURED Il datastore principale contiene un motore di ricerca per dati non strutturati.
BLENDED Il datastore principale viene utilizzato per la ricerca combinata con più datastore.

ResultDisplayType

Il tipo di risultato da visualizzare nel widget UCS.

Enum
RESULT_DISPLAY_TYPE_UNSPECIFIED Tipo di visualizzazione non specificato (per impostazione predefinita viene mostrato lo snippet).
SNIPPET Visualizza i risultati dal campo snippet.
EXTRACTIVE_ANSWER Mostra i risultati del campo Risposte estrattive.

DataStoreUiConfig

Configurazione del componente UI per il datastore.

Rappresentazione JSON 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
Campi
name

string

Il nome del datastore. Deve essere il nome della risorsa datastore. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. Per le API in WidgetService, ad esempio WidgetService.LookupWidgetConfig, il numero di progetto e la parte relativa alla località vengono cancellati in questo campo.
id

string

Solo output. L'identificatore del datastore, utilizzato per il servizio widget. Per ora si riferisce a dataStoreId, in futuro eseguiremo la migrazione del campo all'UUID del nome del datastore criptato.
facetField[]

object (FacetField)

Campi delle sfaccettature che memorizzano la mappatura dei campi all'aspetto del widget per l'utente finale.
fieldsUiComponentsMap

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

La chiave è il componente UI. Mock. Attualmente supportati title, thumbnail, url, custom1, custom2, custom3.

Il valore è il nome del campo insieme alla visibilità del dispositivo.

I tre campi personalizzati sono facoltativi e possono essere aggiunti o rimossi. title, thumbnail, url sono componenti UI obbligatori che non possono essere rimossi.

CollectionComponent

Componente di raccolta di sola lettura che contiene i campi delle raccolte del datastore che possono essere utilizzati per il filtraggio.

Per i motori SaaS / aziendali, quando LookupWidgetConfig viene chiamato con view = WITH_AVAILABLE_CONNECTORS, le istanze di questo messaggio vengono utilizzate anche per rappresentare voci segnaposto sintetiche per i connettori che il chiamante può allegare ma non ha ancora allegato. Le voci segnaposto hanno connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (o NO_AUTH), un connectorAuthState.authorization_uri vuoto (il widget chiama WidgetBuildAuthorizationUrl quando l'utente fa clic su "Connetti") e valori segnaposto sintetici in name / id (vedi i commenti dei campi). I campi che hanno senso solo per i connettori materializzati (dataStoreComponents, tenant, actionConnector) non vengono impostati per le voci segnaposto.

Rappresentazione JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceVersion": number,
  "dataSourceDisplayName": string,
  "dataSourceEndUserDisplayName": string,
  "connectorIconLink": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  },
  "metadata": {
    object (ConnectorMetadata)
  },
  "isFirstParty": boolean,
  "tag": string
}
Campi
name

string

Il nome della raccolta. Deve essere il nome della risorsa raccolta. Formato: projects/{project}/locations/{location}/collections/{collectionId}. Per le API in WidgetService, ad esempio WidgetService.LookupWidgetConfig, il numero di progetto e la parte relativa alla località vengono cancellati in questo campo.

Per le voci segnaposto sintetiche (vedi il commento a livello di messaggio), questo campo contiene un ID raccolta segnaposto sintetico che non corrisponde a una raccolta reale. I chiamanti non devono tentare di risolvere / GET questa risorsa finché l'utente non autorizza il connettore.
id

string

Solo output. L'identificatore della raccolta, utilizzato per il servizio widget. Per ora si riferisce a collectionId, in futuro eseguiremo la migrazione del campo all'UUID del nome della raccolta criptato.

Per le voci segnaposto sintetiche (vedi il commento a livello di messaggio), questo è un ID segnaposto sintetico, non un ID raccolta reale.
displayName

string

Il nome visualizzato della raccolta.
dataStoreComponents[]

object (DataStoreComponent)

Per la raccolta di datastore, elenco dei datastore secondari.
dataSource

string

Il nome dell'origine dati, recuperato da Collection.data_connector.data_source.
dataSourceVersion

number

Solo output. La versione della definizione del connettore che supporta questa raccolta, mirroring DataConnector.data_source_version.
dataSourceDisplayName

string

Solo output. Il nome visualizzato dell'origine dati.
dataSourceEndUserDisplayName

string

Solo output. Il nome visualizzato dell'origine dati rivolto all'utente finale, proveniente da ConnectorSource.end_user_display_name. Se non è impostato, i client tornano a dataSourceDisplayName.
connectorAuthState

object (ConnectorAuthState)

Solo output. L'URI di autenticazione dell'origine del connettore.
metadata

object (ConnectorMetadata)

Solo output. Metadati del connettore rivolti agli utenti (title, description, shortDescription, author, note), recuperati dal registro ConnectorSource.metadata (uniti per origine dati). Visualizzato nella pagina dei dettagli del connettore.
isFirstParty

boolean

Solo output. Se si tratta di un connettore proprietario (di proprietà di Google) anziché di un connettore di terze parti. Utilizzato dal frontend per raggruppare i connettori proprietari e di terze parti.
tag

string

Solo output. L'etichetta indipendente dalla versione del connettore che supporta questa raccolta, che rispecchia DataConnector.tag. A differenza dell'ID datastore con blocco della versione, sopravvive a un upgrade della versione del connettore, quindi un connettore aggiornato mantiene lo stesso tag.

Non è una chiave univoca. Come DataConnector.tag documenti, diversi connettori possono condividere un tag nello stesso (progetto, posizione, raccolta, dataSource) e la ricerca basata su tag viene risolta in quello con createTime maggiore. I client non devono considerarlo come un identificatore di connettore.

Vuoto quando il connettore è stato creato prima del lancio della scrittura dei tag e per le voci segnaposto sintetiche, che non hanno DataConnector sottostanti. Compilato solo quando ConnectorsFeature.enable_connector_tag è attivo.

DataStoreComponent

Componente datastore di sola lettura che contiene i campi dei datastore che possono essere utilizzati per il filtraggio. È il componente secondario di CollectionComponent.

Rappresentazione JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "dataStoreConfigType": enum (DataStoreConfigType)
}
Campi
name

string

Il nome del datastore. Deve essere il nome della risorsa datastore. Formato: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. Per le API in WidgetService, ad esempio WidgetService.LookupWidgetConfig, il numero di progetto e la parte relativa alla località vengono cancellati in questo campo.
id

string

Solo output. L'identificatore del datastore, utilizzato per il servizio widget. Per ora si riferisce a dataStoreId, in futuro eseguiremo la migrazione del campo all'UUID del nome del datastore criptato.
displayName

string

Il nome visualizzato del datastore.
entityName

string

Il nome dell'entità, recuperato da Collection.data_connector.entities.entityName.
dataStoreConfigType

enum (DataStoreConfigType)

Solo output. Il tipo di configurazione del datastore.

DataStoreConfigType

Il tipo di configurazione del datastore.

Enum
DATA_STORE_CONFIG_TYPE_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
ALLOW_DB_CONFIG Il datastore è connesso ad AlloyDB
THIRD_PARTY_OAUTH_CONFIG Il datastore è connesso a un'origine dati di terze parti.
NOTEBOOKLM_CONFIG Il datastore è connesso a NotebookLM Enterprise.

ConnectorAuthState

Connettore di sola lettura nello stato di autenticazione CollectionComponent.

Rappresentazione JSON 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
Campi
authState

enum (AuthState)

Solo output. Lo stato di autorizzazione del connettore dati.
authorizationUri

string

Solo output. L'URI di autorizzazione per il connettore dati.

Per le voci del segnaposto sintetico CollectionComponent (restituite da LookupWidgetConfig con view = WITH_AVAILABLE_CONNECTORS sui motori SaaS / aziendali), questo campo viene lasciato vuoto. Il widget deve chiamare WidgetService.WidgetBuildAuthorizationUrl quando l'utente fa clic su "Connetti" per ottenere un URL di autorizzazione appena creato.
updateTime

string (Timestamp format)

Solo output. Timestamp dell'aggiornamento dello stato di autorizzazione.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

AuthState

Lo stato di autorizzazione del connettore dati.

Enum
AUTH_STATE_UNSPECIFIED Valore predefinito. Restituiti anche per le voci di segnaposto sintetico CollectionComponent visualizzate da LookupWidgetConfig con view = WITH_AVAILABLE_CONNECTORS (solo SaaS / Business): queste voci rappresentano i connettori che il chiamante può allegare, ma non ha ancora allegato.
AUTHORIZED L'utente ha autorizzato il connettore dati.
EXPIRED L'autorizzazione utente per il connettore dati è scaduta.
ACTIONS_DISABLED L'utente può comunque effettuare richieste di ricerca, ma le azioni devono essere abilitate.
NO_AUTH Il connettore dati non richiede alcuna autorizzazione. Utilizzato anche per le voci segnaposto il cui connettore sottostante non richiede OAuth utente.

ConnectorMetadata

Metadati rivolti agli utenti per il connettore, visualizzati nella pagina dei dettagli del connettore (titolo, descrizione, shortDescription, autore, nota).

Rappresentazione JSON 
{
  "title": string,
  "description": string,
  "shortDescription": string,
  "author": string,
  "note": string
}
Campi
title

string

Facoltativo. Titolo visualizzato del connettore.
description

string

Facoltativo. Descrizione del connettore leggibile, visualizzata nella pagina dei dettagli del connettore. Un connettore ha una sola descrizione.
shortDescription

string

Facoltativo. Descrizione breve del connettore, della lunghezza di un sottotitolo (ad es. visualizzata sotto il nome del connettore nelle visualizzazioni elenco e dettagli).
author

string

Facoltativo. La parte che ha creato il connettore, ad esempio "Google" o il nome di un fornitore terzo. Consente agli utenti finali di vedere chi ha creato un connettore (in futuro: connettori creati da terze parti).
note

string

Facoltativo. Nota multilinea in formato libero sulle funzionalità del connettore o una nota personalizzata che può essere impostata per il connettore.

UiSettings

Descrive le impostazioni generali dell'interfaccia utente dei widget (o delle app web) visualizzate nella pagina di configurazione dell'interfaccia utente della console cloud.

Rappresentazione JSON 
{
  "interactionType": enum (InteractionType),
  "generativeAnswerConfig": {
    object (GenerativeAnswerConfig)
  },
  "resultDescriptionType": enum (ResultDisplayType),
  "enableAutocomplete": boolean,
  "enableSafeSearch": boolean,
  "enableQualityFeedback": boolean,
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "disableUserEventsCollection": boolean,
  "enableVisualContentSummary": boolean,
  "enablePeopleSearch": boolean,
  "enableCreateAgentButton": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "modelConfigInfo": {
    object (ModelConfigInfo)
  },
  "sourceAdminDisplayNameEnabled": boolean,
  "onedrivePickerEnabled": boolean,
  "googleDrivePickerEnabled": boolean
}
Campi
interactionType

enum (InteractionType)

Descrive il tipo di interazione con il widget (o l'app web)
generativeAnswerConfig

object (GenerativeAnswerConfig)

Descrive la configurazione delle risposte generative.
resultDescriptionType

enum (ResultDisplayType)

Controlla se l'estratto dei risultati viene visualizzato e in che modo (snippet o risposta estrattiva). Se non specificato, il valore predefinito è nessun risultato.
enableAutocomplete

boolean

Se attivare o meno il completamento automatico.
enableQualityFeedback

boolean

Attiva o disattiva la raccolta del feedback sulla qualità dei risultati di ricerca degli utenti finali.
enableSearchAsYouType

boolean

Se attivare o meno il comportamento di ricerca durante la digitazione per il widget Ricerca.
defaultSearchRequestOrderBy

string

L'ordinamento predefinito dei risultati di ricerca, se specificato.

Utilizzato per impostare SearchRequest#orderBy nelle richieste applicabili. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
dataStoreUiConfigs[]

object (DataStoreUiConfig)

Per configurazione del datastore.
disableUserEventsCollection

boolean

Se impostato su true, il widget non raccoglierà gli eventi utente.
enableVisualContentSummary

boolean

Se il valore è impostato su true, il widget abilita il riepilogo dei contenuti visivi nelle richieste di ricerca applicabili. Utilizzato solo dalla ricerca sanitaria.
enableCreateAgentButton

boolean

Facoltativo. Se viene impostato su true, il widget attiverà il pulsante di creazione dell'agente.
features

map (key: string, value: enum (FeatureState))

Solo output. Configurazione delle funzionalità per il motore per attivare o disattivare le funzionalità. Tasti supportati:

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • speech-to-text
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • canvas-app-builder
  • skills
  • skill-sharing
  • skill-sharing-without-admin-approval
  • disable-projects
  • sobi
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
  • workflow-agents
  • in-app-notifications
modelConfigs

map (key: string, value: enum (ModelState))

Solo output. Mappa un nome del modello alla relativa configurazione specifica per questo motore. Ciò consente agli utenti amministratori di attivare/disattivare i singoli modelli. Vengono memorizzati solo i modelli i cui stati vengono sostituiti dall'amministratore.

Quando lo stato non è specificato o modelConfigs è vuoto per questo modello, il sistema decide se il modello deve essere disponibile o meno in base alla configurazione predefinita. Ad esempio, un modello di anteprima deve essere disattivato per impostazione predefinita se l'amministratore non ha scelto di attivarlo.
searchAddonSpec

object (SearchAddonSpec)

Facoltativo. SearchAddonSpec viene utilizzato per disattivare i componenti aggiuntivi per la ricerca. Questo campo è supportato solo per le richieste di ricerca.
modelConfigInfo

object (ModelConfigInfo)

Solo output. La visualizzazione lato server risolta della configurazione del selettore di modelli. Contiene sia l'elenco ordinato dei modelli che devono essere visualizzati nel menu a discesa del selettore di modelli sia il modello che deve essere selezionato per impostazione predefinita.

I client devono eseguire il rendering direttamente senza applicare filtri, ordinamenti o localizzazioni personalizzati. La mappatura modelConfigs legacy riportata sopra viene mantenuta per la compatibilità con le versioni precedenti con i client che non hanno ancora eseguito la migrazione all'utilizzo di questo campo.
sourceAdminDisplayNameEnabled

boolean

Facoltativo. Indica se mostrare il nome visualizzato configurato dall'amministratore per i connettori dati nell'interfaccia utente delle origini dei widget (anziché il tipo di connettore). Attivazione; il valore predefinito è false.
onedrivePickerEnabled

boolean

Solo output. Indica se il selettore file di OneDrive è disponibile per gli utenti finali. Calcolato dal backend in base all'attivazione del connettore amministratore (versione Business) o ai connettori OneDrive collegati (Enterprise), in combinazione con la funzionalità amministratore disable-onedrive-upload esistente.

Dichiarato optional in modo che un false calcolato in modo esplicito venga serializzato con la presenza del campo. Un proto3 bool semplice rilascia un false predefinito sul cavo, il che impediva ai client di distinguere "selettore disattivato" (false) da "campo non compilato" (non impostato).
googleDrivePickerEnabled

boolean

Solo output. Indica se il selettore file di Google Drive è disponibile per gli utenti finali. Dichiarato optional per lo stesso motivo di presenza del campo di onedrivePickerEnabled sopra.

InteractionType

Descrive il tipo di interazione.

Enum
INTERACTION_TYPE_UNSPECIFIED Non specificato. Il valore predefinito è SEARCH_ONLY.
SEARCH_ONLY Cerca senza una risposta generativa.
SEARCH_WITH_ANSWER Cerca con la risposta generativa.
SEARCH_WITH_FOLLOW_UPS Esegui ricerche con la risposta generativa che supporta le domande aggiuntive. Nota anche come ricerca multichurn.

GenerativeAnswerConfig

Descrive la configurazione per la risposta generativa.

Rappresentazione JSON 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "imageSource": enum (ImageSource)
}
Campi
resultCount

integer

Il numero di primi risultati da cui generare la risposta. Fino a 10.
modelVersion

string

La versione del modello utilizzata per generare la risposta.
modelPromptPreamble

string

Testo all'inizio del prompt che indica al modello che genera la risposta.
maxRephraseSteps

integer

Numero massimo di passaggi per riformulare la query. Il numero massimo è 5 passaggi. Se non viene impostato o è impostato su < 1, il valore predefinito è 1.
languageCode

string

Codice lingua per il riepilogo. Utilizza i tag di lingua definiti da BCP47. Nota: questa è una funzionalità sperimentale.
ignoreNonAnswerSeekingQuery

boolean

Facoltativo. Specifica se filtrare le query che non cercano risposte. Il valore predefinito è false.

Non viene restituita alcuna risposta se la query di ricerca viene classificata come query che non cerca risposte. Se questo campo è impostato su true, saltiamo la generazione di risposte per le query che non cercano risposte e restituiamo invece messaggi di riserva.
ignoreAdversarialQuery

boolean

Facoltativo. Specifica se filtrare le query avversative.
ignoreLowRelevantContent

boolean

Facoltativo. Specifica se filtrare le query non pertinenti ai contenuti.
imageSource

enum (ImageSource)

Facoltativo. Origine dell'immagine restituita nella risposta.

ImageSource

Origine dell'immagine restituita nella risposta.

Enum
IMAGE_SOURCE_UNSPECIFIED Origine immagine non specificata (la funzionalità multimodale è disattivata per impostazione predefinita)
ALL_AVAILABLE_SOURCES Comportamento quando il servizio determina la selezione da tutte le origini disponibili.
CORPUS_IMAGE_ONLY Includi l'immagine dal corpus nella risposta.
FIGURE_GENERATION_ONLY Attiva la generazione di una figura nella risposta.

FeatureState

Lo stato della funzionalità per il motore.

Enum
FEATURE_STATE_UNSPECIFIED Lo stato della funzionalità non è specificato.
FEATURE_STATE_ON La funzionalità è attivata per essere accessibile.
FEATURE_STATE_OFF La funzionalità è disattivata per non essere accessibile.

ModelState

Lo stato del modello per il motore.

Enum
MODEL_STATE_UNSPECIFIED Lo stato del modello non è specificato.
MODEL_ENABLED Il modello è abilitato dall'amministratore.
MODEL_DISABLED Il modello è stato disattivato dall'amministratore.

SearchAddonSpec

SearchAddonSpec viene utilizzato per disattivare i componenti aggiuntivi per la ricerca. Per impostazione predefinita, se questo campo non viene specificato, i componenti aggiuntivi vengono attivati ovunque siano applicabili.

Rappresentazione JSON 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
Campi
semanticAddOnDisabled

boolean

Facoltativo. Se è true, il componente aggiuntivo semantico è disattivato. Il componente aggiuntivo semantico include embedding e jetstream.
kpiPersonalizationAddOnDisabled

boolean

Facoltativo. Se impostato su true, disattiva il ranking e la personalizzazione degli eventi per ottimizzare i KPI e personalizzare i risultati personali.
generativeAnswerAddOnDisabled

boolean

Facoltativo. Se true, il componente aggiuntivo per la generazione di risposte è disattivato. Il componente aggiuntivo per le risposte generate include il linguaggio naturale per i filtri e le risposte semplici.

ModelConfigInfo

La visualizzazione lato server risolta della configurazione del selettore di modelli per l'utente finale. Il backend calcola questo valore per richiesta applicando, in ordine: la valutazione dei flag Mendel, le regole di disponibilità regionali in base alla posizione del motore e gli override del pannello di amministrazione da modelConfigs.

Il backend è la Single Source Of Truth per questa configurazione; i client devono eseguire il rendering di resolvedModels direttamente nel menu a discesa del selettore di modelli, nell'ordine fornito, senza applicare filtri, ordinamenti o localizzazioni personalizzati.

Rappresentazione JSON 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string,
  "autoModelId": string
}
Campi
resolvedModels[]

object (ResolvedModel)

Solo output. L'elenco dei modelli disponibili per l'utente finale nel selettore di modelli, nell'ordine in cui devono essere visualizzati.
defaultModelId

string

Solo output. Il modelId del modello che deve essere selezionato per impostazione predefinita nel selettore di modelli quando l'utente finale non ha effettuato una scelta esplicita. Il valore è sempre uno dei modelId presenti in resolvedModels.
autoModelId

string

Solo output. Il modelId che un client deve inviare quando l'utente finale sceglie la voce "Automatico" (il modelId vuoto).

Compilato solo per le piattaforme che non hanno una vera modalità "Auto", in cui lasciare il modello non impostato ripristinerebbe un modello predefinito della piattaforma anziché un modello scelto dal backend. Vuoto su ogni altra superficie, dove "Auto" viene risolto lato server e quando nessuno dei modelli classificati della superficie è disponibile. Se impostato, è sempre uno dei modelId non vuoti presenti in resolvedModels.

ResolvedModel

Un unico modello risolto per essere disponibile per l'utente finale nel selettore di modelli, con tutti i relativi metadati visibili localizzati.

Rappresentazione JSON 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "label": string,
  "adminView": {
    object (AdminView)
  },
  "promoted": boolean,
  "iconUrl": string,
  "family": string
}
Campi
modelId

string

Solo output. Identificatore univoco del modello (ad es. gemini-2.5-flash, gemini-3.1-pro-preview).

Si tratta dello stesso identificatore che i client trasmettono al servizio di assistenza per selezionare questo modello. Anche i modelli virtuali / "pseudo" (ad es. gemini-fast) sono valori validi qui; vengono risolti nel modello concreto sottostante nel backend.
displayName

string

Solo output. Nome visualizzato localizzato del modello (ad es. Gemini 3.1 Pro). Localizzato lato server in base a LookupWidgetConfigRequest.language_code e LookupWidgetConfigRequest.region_code della richiesta.
icon

string

Solo output. Token icona compatibile con GM3 associato al modello (ad es. rocket_launch, bolt, graph_5).
description

string

Solo output. Testo della descrizione localizzata (ad es. state-of-the-art reasoning). Localizzato utilizzando le stesse impostazioni internazionali di displayName.
isPreview

boolean

Solo output. Indica se il modello è attualmente in anteprima. I client devono visualizzarlo tramite un badge "Anteprima" nell'interfaccia utente del selettore.
label

string

Solo output. Etichetta breve mostrata nel chip della barra del selettore compatto (ad es. 3.x Flash) anziché nell'etichetta completa displayName (Gemini 3.x Flash). Viene ripristinata l'etichetta displayName quando il registro di backend non specifica un'etichetta breve distinta.
adminView

object (AdminView)

Solo output. Metadati della superficie di amministrazione; compilati solo per la pagina Controllo funzionalità dell'amministratore della console (vedi AdminView). Non impostati per le superfici utente finale.
promoted

boolean

Solo output. Indica se questo modello deve essere promosso nel banner della home page della chat con l'IA generativa.
iconUrl

string

Solo output. URL assoluto di un marchio da visualizzare al posto di icon, per i modelli il cui logo del fornitore non è un glifo GM3.

icon rimane compilato come fallback, quindi un client che non esegue il rendering delle immagini o che non riesce a recuperare questa immagine mostra il glifo anziché nulla.
family

string

Solo output. Raggruppa i modelli che vengono visualizzati insieme nel selettore. I modelli che condividono un valore formano un gruppo; un valore vuoto indica che il modello non appartiene a nessun gruppo.

Viene confrontato solo per l'uguaglianza, non viene mai analizzato e non viene mai mostrato a un utente, pertanto non è localizzato.

AdminView

Metadati della superficie di amministrazione. Compilato solo quando la richiesta ha origine dalla pagina "Controllo funzionalità" dell'amministratore di Cloud Console; lasciato non impostato per le interfacce utente finale (web, mobile). Consente alla pagina Amministrazione di eseguire il rendering della tabella dei pulsanti di attivazione/disattivazione direttamente dal backend anziché da un registro lato client hardcoded.

Rappresentazione JSON 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
Campi
adminOverridable

boolean

Solo output. Indica se l'amministratore può attivare/disattivare lo stato di questo modello tramite UiSettings.model_configs. Derivato da MODEL_TAG_ADMIN_OVERRIDABLE. Se il valore è false, il modello è "forzato" e il suo stato è regolato da enabledByDefault.
enabledByDefault

boolean

Solo output. Indica se il modello è abilitato quando l'amministratore non ha impostato alcun override esplicito in UiSettings.model_configs. Derivato da MODEL_TAG_ENABLED_BY_DEFAULT.
regions[]

string

Solo output. Regioni in cui viene lanciato questo modello.

AccessSettings

Descrive le impostazioni di accesso ai widget.

Rappresentazione JSON 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
Campi
allowPublicAccess

boolean

Indica se è consentito l'accesso pubblico non autenticato.
allowlistedDomains[]

string

Elenco dei domini autorizzati a integrare il widget Ricerca.
enableWebApp

boolean

Indica se l'accesso all'app web è abilitato.
workforceIdentityPoolProvider

string

Facoltativo. Il provider di pool di identità per la forza lavoro utilizzato per accedere al widget.
languageCode

string

Facoltativo. Codice lingua per l'interfaccia utente. Utilizza i tag di lingua definiti da BCP47. Se non viene impostato, il codice lingua predefinito è "en-US".

UiBrandingSettings

Descrive le impostazioni relative ai brand della UI del widget.

Rappresentazione JSON 
{
  "logo": {
    object (Image)
  }
}
Campi

Immagine

Opzioni per archiviare un'immagine.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "url": string
  // End of mutually exclusive fields.
}
Campi
Vari modi per archiviare un'immagine, ad esempio come URL o stringa con codifica base64. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
url

string

URL immagine.
Fine dei campi che si escludono a vicenda.

HomepageSetting

Descrive l'impostazione della home page del widget. Include tutte le impostazioni e le configurazioni relative alla home page, ad esempio le scorciatoie.

Rappresentazione JSON 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
Campi
shortcuts[]

object (Shortcut)

Facoltativo. Le scorciatoie da visualizzare nella home page.

Scorciatoia

Descrive un'entità di scorciatoia (ovvero i contenuti bloccati) nella home page. La home page eseguirà il rendering di queste scorciatoie nello stesso ordine restituito dall'API. Se un cliente vuole riordinare o rimuovere una scorciatoia, l'interfaccia utente deve sempre fornire il nuovo elenco completo di scorciatoie.

Rappresentazione JSON 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
Campi
title

string

Facoltativo. Il titolo della scorciatoia.
icon

object (Image)

Facoltativo. URL dell'icona della scorciatoia.
destinationUri

string

Facoltativo. URL di destinazione della scorciatoia.

AssistantSettings

Descrive le impostazioni dell'assistente del widget.

Rappresentazione JSON 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
Campi
googleSearchGroundingEnabled
(deprecated)

boolean

Indica se il pulsante di attivazione/disattivazione del grounding della Ricerca Google viene mostrato o meno. Deprecato. Utilizza invece webGroundingType.
webGroundingType

enum (WebGroundingType)

Facoltativo. Il tipo di grounding web da utilizzare.
defaultWebGroundingToggleOff

boolean

Solo output. Questo campo controlla l'attivazione/disattivazione predefinita della base web per gli utenti finali se webGroundingType è impostato su WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Per impostazione predefinita, questo campo è impostato su false. Se webGroundingType è WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, l'utente finale avrà l'ancoraggio web attivato per impostazione predefinita nella UI. Se il valore è true, il pulsante di attivazione/disattivazione della base verrà disattivato per impostazione predefinita nell'UI. Gli utenti finali possono comunque attivare il grounding web nell'interfaccia utente se è abilitato.
disableLocationContext

boolean

Facoltativo. Solo output. Indica se disattivare il contesto della posizione dell'utente.

WebGroundingType

Il tipo di grounding web da utilizzare.

Enum
WEB_GROUNDING_TYPE_UNSPECIFIED Impostazione predefinita non specificata. Equivale a disattivato.
WEB_GROUNDING_TYPE_DISABLED Il grounding web è disattivato.

CustomerProvidedConfig

Configurazioni fornite dal cliente.

Rappresentazione JSON 
{
  "customerType": enum (CustomerType),
  "complianceLevel": enum (ComplianceLevel)
}
Campi
customerType

enum (CustomerType)

Tipo di cliente.
complianceLevel

enum (ComplianceLevel)

Solo output. Il livello di conformità di Assured Workloads del cliente.

customerType comprime ogni livello di conformità in un unico valore GOVERNMENT_CUSTOMER, quindi un client che limita una funzionalità a un livello specifico anziché allo stato governativo nel suo complesso deve leggere questo campo.

CustomerType

Tipo di cliente.

Enum
DEFAULT_CUSTOMER Tipo di cliente predefinito.
GOVERNMENT_CUSTOMER Tipo di cliente governativo. Alcune funzionalità sono disattivate per i clienti governativi a causa di requisiti legali.

ComplianceLevel

Livello di conformità Assured Workloads del progetto del cliente.

Non congelato: potrebbero essere aggiunti altri livelli man mano che vengono supportati più regimi di conformità, pertanto un client deve trattare un valore non riconosciuto come soggetto a restrizioni governative anziché come senza restrizioni.

Enum
COMPLIANCE_LEVEL_UNSPECIFIED Il progetto non ha un livello di conformità Assured Workloads o ne segnala uno che questa versione dell'API non modella.
COMPLIANCE_LEVEL_FEDRAMP_HIGH Livello di conformità FedRAMP High.
COMPLIANCE_LEVEL_IL4 Livello di conformità Impact Level 4 (IL4).
COMPLIANCE_LEVEL_IL5 Livello di conformità Impact Level 5 (IL5).

BatchAuthStatus

Descrive lo stato dell'autorizzazione batch per un batchAuthorizationGroup.

Rappresentazione JSON 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
Campi
placeholder

string

Solo output. È il nome completo della risorsa segnaposto del gruppo di autorizzazione batch. Questo non è un connettore dati reale (non esiste nella tabella DataConnector in Spanner). È un nome di risorsa esistente solo in connector_authorization nella tabella degli utenti. Ad esempio, projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.
batchAuthorizationGroup

string

Solo output. Il gruppo di autorizzazione batch a cui appartiene il segnaposto.
connectorAuthState

object (ConnectorAuthState)

Solo output. Lo stato di autorizzazione attuale per questo connettore.

Nodo

Rappresenta una singola unità computazionale o logica riutilizzabile.

Rappresentazione JSON 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
Campi
displayName

string

Solo output. Un nome leggibile per il nodo.
iconUrl

string

Solo output. Un identificatore o un URL che rimanda a un'icona che rappresenta questo tipo di nodo.
description

string

Solo output. Una descrizione dettagliata di ciò che fa il nodo.
parameterSchema

object (Struct format)

Solo output. Lo schema dei parametri dello strumento.

Questo schema deve essere conforme allo standard OpenAPI Schema (vedi https://spec.openapis.org/oas/v3.0.3.html e AIP-146). Descrive la struttura prevista dei parametri accettati da questo nodo.
outputSchema

object (Struct format)

Solo output. Lo schema di output dello strumento.

Questo schema deve essere conforme allo standard OpenAPI Schema (vedi https://spec.openapis.org/oas/v3.0.3.html/ e AIP-146). Descrive la struttura dell'output prodotto da questo nodo.
type

enum (Type)

Solo output. Il tipo di nodo.

Tipo

Identifica il tipo di nodo nel flusso dell'agente.

Enum
TYPE_UNSPECIFIED Tipo non specificato.
TRIGGER Tipo di trigger.
FLOW tipo di flusso.
CONNECTOR Tipo di connettore.

Metodi

get

 Riceve un WidgetConfig.

patch

 Aggiorna un WidgetConfig.