- Risorsa: WidgetConfig
- Rappresentazione JSON
- UIComponentField
- DeviceVisibility
- FacetField
- DataStoreType
- ResultDisplayType
- DataStoreUiConfig
- CollectionComponent
- DataStoreComponent
- DataStoreConfigType
- UiSettings
- InteractionType
- GenerativeAnswerConfig
- ImageSource
- FeatureState
- AccessSettings
- UiBrandingSettings
- Immagine
- HomepageSetting
- Scorciatoia
- AssistantSettings
- WebGroundingType
- CustomerProvidedConfig
- CustomerType
- Metodi
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 ( |
Campi | |
---|---|
name |
Immutabile. Il nome completo della risorsa della configurazione del widget. Formato: Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri. |
displayName |
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 |
Solo output. Timestamp della creazione di 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: |
updateTime |
Solo output. Timestamp dell'aggiornamento di 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: |
enableAutocomplete |
Se attivare o meno il completamento automatico. |
fieldsUiComponentsMap |
La chiave è il componente UI. Simulazione. Attualmente supportati Il valore è il nome del campo insieme alla visibilità del dispositivo. I tre campi personalizzati sono facoltativi e possono essere aggiunti o rimossi. |
facetField[] |
La configurazione e l'aspetto dei prospetti nella visualizzazione dell'utente finale. |
dataStoreType |
Solo output. Il tipo di datastore padre. |
contentSearchSpec |
La specifica di ricerca dei contenuti che configura il comportamento desiderato della ricerca dei contenuti. |
enableSummarization |
Attiva o disattiva il riepilogo per la risposta della ricerca. |
enableSnippetResultSummary |
Attiva o disattiva il riepilogo per ogni risultato di snippet. |
configId |
Solo output. Identificatore univoco offuscato di un |
enableQualityFeedback |
Attiva o disattiva la raccolta del feedback sulla qualità dei risultati di ricerca degli utenti finali. |
solutionType |
Obbligatorio. Immutabile. Specifica il tipo di soluzione per cui è possibile utilizzare questo WidgetConfig. |
industryVertical |
Solo output. Il verticale di settore registrato da WidgetConfig. Il verticale del settore WidgetConfig si basa sul |
allowPublicAccess |
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[] |
Domini inclusi nella lista consentita che possono caricare questo widget. |
enableSafeSearch |
Indica se attivare safe search. |
enableConversationalSearch |
Se consentire o meno la ricerca conversazionale (LLM, in più passaggi). |
llmEnabled |
Solo output. Se l'LLM è abilitato nel datastore corrispondente. |
enableResultScore |
Se mostrare il punteggio del risultato. |
resultDisplayType |
Il tipo di snippet da visualizzare nel widget UCS.
|
minimumDataTermAccepted |
Solo output. Se il cliente ha accettato i termini per l'utilizzo dei dati. |
enableWebApp |
Se abilitare l'app web autonoma. |
dataStoreUiConfigs[] |
Configurazioni della UI configurabili per datastore. |
collectionComponents[] |
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 |
Se attivare il comportamento di ricerca durante la digitazione per il widget di ricerca |
defaultSearchRequestOrderBy |
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 |
Consente di attivare/disattivare le funzionalità instabili/sperimentali nel widget (o nell'app web) |
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 |
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 |
Descrive le impostazioni di branding dell'interfaccia utente del widget Ricerca, come titolo, logo, favicon e colori del widget. |
homepageSetting |
Facoltativo. Descrive le impostazioni della home page del widget. |
assistantSettings |
Facoltativo. Solo output. Descrive le impostazioni dell'assistente del widget. |
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 |
Facoltativo. Solo output. Se attivare il Knowledge Graph privato. |
UIComponentField
Campo sfaccettatura mappato a un componente UI.
Rappresentazione JSON |
---|
{
"field": string,
"deviceVisibility": [
enum ( |
Campi | |
---|---|
field |
Obbligatorio. Nome del campo registrato. Il formato è |
deviceVisibility[] |
La visibilità dei campi su diversi tipi di dispositivi. |
displayTemplate |
Il modello per personalizzare la modalità di 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 gli utenti finali.
Rappresentazione JSON |
---|
{ "field": string, "displayName": string } |
Campi | |
---|---|
field |
Obbligatorio. Nome del campo registrato. Il formato è |
displayName |
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. |
SITE_SEARCH |
Il datastore padre contiene un motore di ricerca interno al sito. |
STRUCTURED |
Il datastore padre contiene un motore di ricerca per i 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 delle risposte estrattive. |
DataStoreUiConfig
Configurazione del componente UI per il datastore.
Rappresentazione JSON |
---|
{ "name": string, "id": string, "facetField": [ { object ( |
Campi | |
---|---|
name |
Il nome del datastore. Deve essere il nome della risorsa del datastore. Formato: |
id |
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[] |
Campi delle sfaccettature che memorizzano la mappatura dei campi all'aspetto del widget per gli utenti finali. |
fieldsUiComponentsMap |
La chiave è il componente UI. Simulazione. Attualmente supportati Il valore è il nome del campo insieme alla visibilità del dispositivo. I tre campi personalizzati sono facoltativi e possono essere aggiunti o rimossi. |
CollectionComponent
Componente di raccolta di sola lettura che contiene i campi delle raccolte del datastore che possono essere utilizzati per il filtraggio
Rappresentazione JSON |
---|
{
"name": string,
"id": string,
"displayName": string,
"dataStoreComponents": [
{
object ( |
Campi | |
---|---|
name |
Il nome della raccolta. Deve essere il nome della risorsa raccolta. Formato: |
id |
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. |
displayName |
Il nome visualizzato della raccolta. |
dataStoreComponents[] |
Per la raccolta di datastore, elenco dei datastore secondari. |
dataSource |
Il nome dell'origine dati, recuperato da |
dataSourceDisplayName |
Solo output. Il nome visualizzato dell'origine dati. |
connectorIconLink |
Solo output. Il link all'icona dell'origine del connettore. |
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, "workspaceType": enum ( |
Campi | |
---|---|
name |
Il nome del datastore. Deve essere il nome della risorsa del datastore. Formato: |
id |
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 |
Il nome visualizzato del datastore. |
entityName |
Il nome dell'entità, recuperato da |
workspaceType |
Solo output. Tipi di origini Workspace per i dati di Workspace, recuperati da |
contentConfig |
Solo output. La configurazione dei contenuti del datastore. |
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 |
L'datastore è connesso a un'origine dati di terze parti. |
NOTEBOOKLM_CONFIG |
Il datastore è connesso a NotebookLM Enterprise. |
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 ( |
Campi | |
---|---|
interactionType |
Descrive il tipo di interazione con il widget (o l'app web) |
generativeAnswerConfig |
Descrive la configurazione delle risposte generative. |
resultDescriptionType |
Controlla se l'estrazione dei risultati viene visualizzata e in che modo (snippet o risposta estrattiva). Se non specificato, il valore predefinito è nessun risultato. |
enableAutocomplete |
Se attivare o meno il completamento automatico. |
enableSafeSearch |
Indica se attivare safe search. |
enableQualityFeedback |
Attiva o disattiva la raccolta del feedback sulla qualità dei risultati di ricerca degli utenti finali. |
enableSearchAsYouType |
Se attivare la ricerca durante la digitazione per il widget di ricerca. |
defaultSearchRequestOrderBy |
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[] |
Per configurazione del datastore. |
disableUserEventsCollection |
Se impostato su true, il widget non raccoglierà gli eventi utente. |
enableVisualContentSummary |
Se il valore è impostato su true, il widget attiverà il riepilogo dei contenuti visivi per le richieste di ricerca applicabili. Utilizzato solo dalla ricerca sanitaria. |
enablePeopleSearch |
Facoltativo. Se è impostato su true, il widget attiverà People Search. |
enableCreateAgentButton |
Facoltativo. Se viene impostato su true, il widget attiva il pulsante di creazione dell'agente. |
features |
Solo output. Configurazione delle funzionalità per il motore per attivare o disattivare le funzionalità. Chiavi supportate:
|
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 multiconversazionale. |
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 ( |
Campi | |
---|---|
resultCount |
Il numero di primi risultati da cui generare la risposta. Fino a 10. |
modelVersion |
La versione del modello utilizzata per generare la risposta. |
modelPromptPreamble |
Testo all'inizio del prompt che indica al modello che genera la risposta. |
maxRephraseSteps |
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 |
Codice lingua per il riepilogo. Utilizza i tag di lingua definiti da BCP47. Nota: questa è una funzionalità sperimentale. |
disableRelatedQuestions |
Se la risposta generata contiene domande correlate suggerite. |
ignoreNonAnswerSeekingQuery |
Facoltativo. Specifica se filtrare le query che non cercano risposte. Il valore predefinito è Se la query di ricerca viene classificata come query che non cerca risposte, non viene restituita alcuna risposta. Se questo campo è impostato su |
ignoreAdversarialQuery |
Facoltativo. Specifica se filtrare le query avversative. |
ignoreLowRelevantContent |
Facoltativo. Specifica se filtrare le query non pertinenti per i contenuti. |
imageSource |
Facoltativo. L'origine dell'immagine restituita nella risposta. |
ImageSource
L'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 cifre 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. |
AccessSettings
Descrive le impostazioni di accesso ai widget.
Rappresentazione JSON |
---|
{ "allowPublicAccess": boolean, "allowlistedDomains": [ string ], "enableWebApp": boolean, "workforceIdentityPoolProvider": string, "languageCode": string } |
Campi | |
---|---|
allowPublicAccess |
Se è consentito l'accesso pubblico non autenticato. |
allowlistedDomains[] |
Elenco dei domini autorizzati a integrare il widget di ricerca. |
enableWebApp |
Indica se l'accesso all'app web è abilitato. |
workforceIdentityPoolProvider |
Facoltativo. Il provider di pool di identità per la forza lavoro utilizzato per accedere al widget. |
languageCode |
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 di branding dell'interfaccia utente del widget.
Rappresentazione JSON |
---|
{
"logo": {
object ( |
Campi | |
---|---|
logo |
Immagine del logo. |
Immagine
Opzioni per archiviare un'immagine.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo unione storage_method . Diversi modi per archiviare un'immagine, ad esempio come URL o stringa con codifica base64. storage_method può essere solo uno dei seguenti: |
|
url |
URL immagine. |
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 ( |
Campi | |
---|---|
shortcuts[] |
Facoltativo. Le scorciatoie da visualizzare nella home page. 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) |
Scorciatoia
Descrive un'entità di scorciatoia (ovvero i contenuti in evidenza) nella home page. La home page visualizzerà queste scorciatoie nello stesso ordine restituito dall'API. Se un cliente vuole riordinare o rimuovere una scorciatoia, la UI deve sempre fornire il nuovo elenco completo di scorciatoie.
Rappresentazione JSON |
---|
{
"title": string,
"icon": {
object ( |
Campi | |
---|---|
title |
Facoltativo. Il titolo della scorciatoia. |
icon |
Facoltativo. URL dell'icona della scorciatoia. |
destinationUri |
Facoltativo. URL di destinazione della scorciatoia. |
AssistantSettings
Descrive le impostazioni dell'assistente del widget.
Rappresentazione JSON |
---|
{
"googleSearchGroundingEnabled": boolean,
"webGroundingType": enum ( |
Campi | |
---|---|
googleSearchGroundingEnabled |
Indica se il pulsante di attivazione/disattivazione del grounding della Ricerca Google viene mostrato. Deprecato. Utilizza invece |
webGroundingType |
Facoltativo. Il tipo di grounding web da utilizzare. |
defaultWebGroundingToggleOff |
Solo output. Questo campo controlla l'attivazione/disattivazione predefinita della base web per gli utenti finali se |
disableLocationContext |
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. |
WEB_GROUNDING_TYPE_GOOGLE_SEARCH |
Il grounding con la Ricerca Google è abilitato. |
WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH |
Il grounding con la ricerca web aziendale è abilitato. |
CustomerProvidedConfig
Configurazioni fornite dal cliente.
Rappresentazione JSON |
---|
{
"customerType": enum ( |
Campi | |
---|---|
customerType |
Tipo di cliente. |
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. |
Metodi |
|
---|---|
|
Riceve un WidgetConfig . |