REST Resource: projects.locations.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,
  "experimentalFeatures": {
    string: string,
    ...
  },
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean
}
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 codificata in 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 codificata in 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 della creazione di WidgetConfig.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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 normalizzato in base al fuso orario UTC 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. Simulazione. 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 della 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 è possibile utilizzare 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 il 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. Se l'LLM è abilitato nel datastore corrispondente.
enableResultScore

boolean

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 aziendale.
minimumDataTermAccepted

boolean

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

boolean

Se abilitare l'app web autonoma.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Configurazioni della UI configurabili per datastore.
collectionComponents[]

object (CollectionComponent)

Solo output. Componenti di raccolta che elencano tutte le raccolte e gli archivi dati 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.
enableSearchAsYouType
(deprecated)

boolean

Se attivare il comportamento di ricerca durante la digitazione per il widget di 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
experimentalFeatures

map (key: string, value: string)

Consente di attivare/disattivare le funzionalità instabili/sperimentali nel widget (o nell'app web)
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 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.

Metodi

get

 Riceve un WidgetConfig.