REST Resource: projects.locations.dataStores.widgetConfigs

Ressource : WidgetConfig

WidgetConfig capture les configurations au niveau du widget.

Représentation 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
}
Champs
name

string

Immuable. Nom complet de la ressource de configuration du widget. Format : projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères.
displayName

string

Obligatoire. Nom à afficher de la configuration du widget, lisible par l'utilisateur. Utilisé dans l'UI Discovery.

Ce champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 128 caractères. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création de WidgetConfig.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Le code temporel WidgetConfig a été modifié.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
enableAutocomplete
(deprecated)

boolean

Indique s'il faut activer ou non la saisie semi-automatique.
fieldsUiComponentsMap
(deprecated)

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

La clé est le composant d'UI. Mock. title, thumbnail, url, custom1, custom2, custom3 sont actuellement acceptés.

Cette valeur correspond au nom du champ ainsi qu'à la visibilité de l'appareil.

Les trois champs personnalisés sont facultatifs et peuvent être ajoutés ou supprimés. title, thumbnail et url sont des composants d'UI obligatoires qui ne peuvent pas être supprimés.
facetField[]
(deprecated)

object (FacetField)

Configuration et apparence des facettes dans la vue de l'utilisateur final.
dataStoreType

enum (DataStoreType)

Uniquement en sortie. Type du data store parent.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

Spécification de la recherche de contenu qui configure le comportement souhaité de la recherche de contenu.
enableSummarization
(deprecated)

boolean

Activez ou désactivez la synthèse pour la réponse de recherche.
enableSnippetResultSummary
(deprecated)

boolean

Activez ou désactivez le résumé pour chaque résultat d'extrait.
configId

string

Uniquement en sortie. Identifiant obscurci unique d'un WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

Activez ou désactivez la collecte des commentaires des utilisateurs finaux sur la qualité des résultats de recherche.
solutionType

enum (SolutionType)

Obligatoire. Immuable. Spécifie le type de solution pour lequel cette WidgetConfig peut être utilisée.
industryVertical

enum (IndustryVertical)

Uniquement en sortie. Secteur d'activité auquel WidgetConfig est associé. Le secteur d'activité WidgetConfig est basé sur le Engine associé.
allowPublicAccess
(deprecated)

boolean

Indique si l'intégration sans authentification avec le widget est autorisée. Si la valeur est définie sur "true", l'accès public à la recherche ou à d'autres solutions à partir du widget est autorisé sans jeton d'authentification fourni par le serveur backend hébergé par le client.
allowlistedDomains[]
(deprecated)

string

Domaines ajoutés à la liste d'autorisation pouvant charger ce widget.
llmEnabled

boolean

Uniquement en sortie. Indique si le LLM est activé dans le data store correspondant.
enableResultScore

boolean

Indique s'il faut afficher le score du résultat.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

Type d'extrait à afficher dans le widget UCS.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED pour les utilisateurs existants.
  • EXTRAIT pour les nouveaux utilisateurs de la recherche non Enterprise.
  • EXTRACTIVE_ANSWER pour les nouveaux utilisateurs de la recherche Enterprise.
minimumDataTermAccepted

boolean

Uniquement en sortie. Indique si le client a accepté les conditions d'utilisation des données.
enableWebApp
(deprecated)

boolean

Indique si l'application Web autonome doit être activée.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

Configurations d'UI configurables par data store.
collectionComponents[]

object (CollectionComponent)

Uniquement en sortie. Les composants de collecte qui listent toutes les collections et tous les magasins de données enfants associés à la configuration du widget. Ces sources de données peuvent être utilisées pour le filtrage dans les API du service de widget. Les utilisateurs peuvent renvoyer des résultats à partir des sources de données sélectionnées.
enableSearchAsYouType
(deprecated)

boolean

Indique si le comportement de saisie semi-automatique doit être activé pour le widget de recherche.
defaultSearchRequestOrderBy
(deprecated)

string

Ordre par défaut des résultats de recherche, le cas échéant.

Utilisé pour définir SearchRequest#orderBy sur les requêtes applicables. 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)

Permet d'activer/désactiver les fonctionnalités instables/expérimentales dans le widget (ou l'application Web)
uiSettings

object (UiSettings)

Décrit les paramètres généraux de recherche de widgets tels qu'ils apparaissent sur la page de configuration des widgets de la console cloud. Remplace les propriétés de premier niveau obsolètes.
accessSettings

object (AccessSettings)

Sera utilisé pour tous les paramètres d'accès aux widgets affichés sur la page d'intégration de la console Cloud. Remplace les propriétés de premier niveau obsolètes.
uiBranding

object (UiBrandingSettings)

Décrit les paramètres de branding de l'UI du widget Recherche, tels que le titre, le logo, les favicons et les couleurs du widget.
homepageSetting

object (HomepageSetting)

Facultatif. Décrit les paramètres de la page d'accueil du widget.
assistantSettings

object (AssistantSettings)

Facultatif. Uniquement en sortie. Décrit les paramètres de l'assistant du widget.
customerProvidedConfig

object (CustomerProvidedConfig)

Facultatif. Uniquement en sortie. Décrit les configurations liées au client, actuellement utilisées uniquement pour les clients gouvernementaux. Ce champ ne peut pas être modifié une fois le projet intégré.
enablePrivateKnowledgeGraph

boolean

Facultatif. Uniquement en sortie. Indique si le Knowledge Graph privé doit être activé.

Méthodes

get

 Récupère un WidgetConfig.