REST Resource: projects.locations.collections.engines.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,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "nodes": [
    {
      object (Node)
    }
  ]
}
Champs
name

string

Immuable. Nom complet de la ressource de la 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 d'une longueur maximale de 1 024 caractères.
displayName

string

Obligatoire. Nom d'affichage de la configuration du widget, sous forme intelligible. Utilisé dans l'interface utilisateur Discovery.

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

string (Timestamp format)

Uniquement en sortie. Code temporel de la 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. Code temporel de la mise à jour 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".
enableAutocomplete
(deprecated)

boolean

Indique si la saisie semi-automatique doit être activée.
fieldsUiComponentsMap
(deprecated)

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

La clé est le composant de l'interface utilisateur. Mock Actuellement compatible avec title, thumbnail, url, custom1, custom2, custom3.

La valeur correspond au nom du champ, ainsi qu'à sa visibilité sur 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'interface utilisateur 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 de 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 unique obscurci 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 ce WidgetConfig peut être utilisé.
industryVertical

enum (IndustryVertical)

Uniquement en sortie. Verticale d'activité dans laquelle le WidgetConfig est enregistré. La verticale du secteur d'activité WidgetConfig est basée sur l'Engine associé.
allowPublicAccess
(deprecated)

boolean

Indique si l'intégration sans authentification est autorisée avec le widget. Si la valeur est "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 autorisés pouvant charger ce widget.
llmEnabled

boolean

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

boolean

Indique si le score du résultat doit être affiché.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

Type d'extrait à afficher dans le widget UCS.

  • RESULT_DISPLAY_TYPE_UNSPECIFIED pour les utilisateurs existants.
  • SNIPPET pour les nouveaux utilisateurs de la recherche non d'entreprise.
  • EXTRACTIVE_ANSWER pour les nouveaux utilisateurs de la recherche d'entreprise.
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'interface utilisateur configurables par data store.
collectionComponents[]

object (CollectionComponent)

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

boolean

Indique si le comportement de saisie instantanée des résultats 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
uiSettings

object (UiSettings)

Décrit les paramètres généraux de recherche du widget tels qu'ils apparaissent sur la page de configuration du widget dans 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 au widget 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'interface utilisateur du widget de 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 du secteur public. Ce champ ne peut pas être modifié après l'intégration du projet.
enablePrivateKnowledgeGraph

boolean

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

boolean

Uniquement en sortie. Indique si l'abonnement est un bundle Gemini.
nodes[]

object (Node)

Uniquement en sortie. Nœuds associés à la configuration du widget.

Méthodes

get

 Récupère un WidgetConfig.

patch

 Met à jour un WidgetConfig.