REST Resource: projects.locations.collections.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é.

UIComponentField

Champ de facette mappé à un composant d'UI.

Représentation JSON 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
Champs
field

string

Obligatoire. Nom de champ enregistré. Il a le format suivant : field.abc.
deviceVisibility[]

enum (DeviceVisibility)

Visibilité des champs sur différents types d'appareils
displayTemplate

string

Modèle permettant de personnaliser l'affichage du champ. Par exemple, une valeur peut être une chaîne qui ressemble à ceci : "Prix : {value}".

DeviceVisibility

Visibilité du champ sur différents types d'appareils.

Enums
DEVICE_VISIBILITY_UNSPECIFIED Valeur par défaut si aucune valeur n'est spécifiée. Le serveur renvoie INVALID_ARGUMENT si elle est utilisée dans les requêtes.
MOBILE Le composant d'UI est visible sur les appareils mobiles.
DESKTOP Le composant d'UI est visible sur le client basé sur le navigateur.

FacetField

Champs de facette qui stockent le mappage des champs à l'apparence du widget pour l'utilisateur final.

Représentation JSON 
{
  "field": string,
  "displayName": string
}
Champs
field

string

Obligatoire. Nom de champ enregistré. Il a le format suivant : field.abc.
displayName

string

Facultatif. Nom du champ que les utilisateurs finaux verront.

DataStoreType

Type du data store parent du widget.

Enums
DATA_STORE_TYPE_UNSPECIFIED Type de data store non spécifié.
STRUCTURED Le data store parent contient un moteur de recherche pour les données structurées.
UNSTRUCTURED Le data store parent contient un moteur de recherche pour les données non structurées.
BLENDED Le data store parent est utilisé pour la recherche combinée avec plusieurs datastores.

ResultDisplayType

Type de résultat à afficher dans le widget UCS.

Enums
RESULT_DISPLAY_TYPE_UNSPECIFIED Type d'affichage non spécifié (l'extrait s'affiche par défaut).
SNIPPET Afficher les résultats du champ "Extrait".
EXTRACTIVE_ANSWER Afficher les résultats du champ "Réponses extractives".

DataStoreUiConfig

Configuration des composants d'interface utilisateur pour le data store.

Représentation JSON 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
Champs
name

string

Nom du data store. Il doit s'agir du nom de ressource du data store. Format : projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. Pour les API sous WidgetService, telles que [WidgetService.LookUpWidgetConfig][], le numéro de projet et la partie emplacement sont effacés dans ce champ.
id

string

Sortie uniquement. Identifiant du data store, utilisé pour le service de widgets. Pour l'instant, il fait référence à dataStoreId. À l'avenir, nous migrerons le champ vers le nom chiffré du data store (UUID).
facetField[]

object (FacetField)

Champs de facette qui stockent le mappage des champs à l'apparence du widget pour l'utilisateur final.
fieldsUiComponentsMap

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.

CollectionComponent

Composant de collection en lecture seule qui contient des champs de collection du data store pouvant être utilisés pour le filtrage

Représentation JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceDisplayName": string,
  "connectorIconLink": string
}
Champs
name

string

Nom de la collection. Il doit s'agir du nom de ressource de la collection. Format : projects/{project}/locations/{location}/collections/{collectionId}. Pour les API sous WidgetService, telles que [WidgetService.LookUpWidgetConfig][], le numéro de projet et la partie emplacement sont effacés dans ce champ.
id

string

Uniquement en sortie. Identifiant de la collection, utilisé pour le service de widgets. Pour l'instant, il fait référence à collectionId. À l'avenir, nous migrerons le champ vers l'UUID du nom de la collection chiffrée.
displayName

string

Nom à afficher de la collection.
dataStoreComponents[]

object (DataStoreComponent)

Pour la collection de data store, liste des datastores enfants.
dataSource

string

Nom de la source de données, récupéré à partir de Collection.data_connector.data_source.
dataSourceDisplayName

string

Uniquement en sortie. Nom à afficher de la source de données.

DataStoreComponent

Composant de data store en lecture seule qui contient les champs de datastores pouvant être utilisés pour le filtrage. Il s'agit de l'enfant de CollectionComponent.

Représentation JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "workspaceType": enum (Type),
  "contentConfig": enum (ContentConfig),
  "dataStoreConfigType": enum (DataStoreConfigType)
}
Champs
name

string

Nom du data store. Il doit s'agir du nom de ressource du data store. Format : projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. Pour les API sous WidgetService, telles que [WidgetService.LookUpWidgetConfig][], le numéro de projet et la partie emplacement sont effacés dans ce champ.
id

string

Sortie uniquement. Identifiant du data store, utilisé pour le service de widgets. Pour l'instant, il fait référence à dataStoreId. À l'avenir, nous migrerons le champ vers le nom chiffré du data store (UUID).
displayName

string

Nom à afficher du data store.
entityName

string

Nom de l'entité, récupéré à partir de Collection.data_connector.entities.entityName.
workspaceType

enum (Type)

Uniquement en sortie. Types de sources Workspace pour les données Workspace, récupérés à partir de DataStore.workspace_config.type.
contentConfig

enum (ContentConfig)

Uniquement en sortie. Configuration du contenu du data store.
dataStoreConfigType

enum (DataStoreConfigType)

Uniquement en sortie. Type de configuration du data store.

DataStoreConfigType

Type de configuration du data store.

Enums
DATA_STORE_CONFIG_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
ALLOW_DB_CONFIG Le data store est connecté à AlloyDB
THIRD_PARTY_OAUTH_CONFIG Le data store est connecté à une source de données tierce.
NOTEBOOKLM_CONFIG Le data store est connecté à NotebookLM Enterprise.

UiSettings

Décrit les paramètres généraux de l'UI des widgets (ou des applications Web) tels qu'ils apparaissent sur la page de configuration de l'UI de la console cloud.

Représentation 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),
    ...
  }
}
Champs
interactionType

enum (InteractionType)

Décrit le type d'interaction avec le widget (ou l'application Web)
generativeAnswerConfig

object (GenerativeAnswerConfig)

Décrit la configuration des réponses génératives.
resultDescriptionType

enum (ResultDisplayType)

Contrôle si l'extrait de résultat est affiché et comment (extrait ou réponse extractive). La valeur par défaut est "aucun résultat" si aucune valeur n'est spécifiée.
enableAutocomplete

boolean

Indique s'il faut activer ou non la saisie semi-automatique.
enableQualityFeedback

boolean

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

boolean

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

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
dataStoreUiConfigs[]

object (DataStoreUiConfig)

Configuration par data store.
disableUserEventsCollection

boolean

Si la valeur est "true", le widget ne collectera pas les événements utilisateur.
enableVisualContentSummary

boolean

Si la valeur est définie sur "True", le widget activera le résumé du contenu visuel pour les demandes de recherche applicables. Utilisé uniquement par la recherche de soins de santé.
enableCreateAgentButton

boolean

Facultatif. Si la valeur est définie sur "true", le widget active le bouton "Créer un agent".
features

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

Uniquement en sortie. Configuration des fonctionnalités permettant au moteur d'activer ou de désactiver des fonctionnalités. Clés compatibles :

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload

InteractionType

Décrit le type d'interaction.

Enums
INTERACTION_TYPE_UNSPECIFIED Non spécifié. La valeur par défaut est SEARCH_ONLY.
SEARCH_ONLY Effectuez une recherche sans réponse générative.
SEARCH_WITH_ANSWER Recherchez avec la réponse générative.
SEARCH_WITH_FOLLOW_UPS Recherchez avec la réponse générative qui permet de poser des questions complémentaires. Également appelée recherche multitours.

GenerativeAnswerConfig

Décrit la configuration de la réponse générative.

Représentation JSON 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "imageSource": enum (ImageSource)
}
Champs
resultCount

integer

Nombre de meilleurs résultats à partir desquels générer la réponse. Jusqu'à 10.
modelVersion

string

Version du modèle utilisée pour générer la réponse.
modelPromptPreamble

string

Texte au début de la requête qui indique au modèle comment générer la réponse.
maxRephraseSteps

integer

Nombre maximal d'étapes de reformulation. Le nombre maximal d'étapes est de cinq. Si elle n'est pas définie ou est inférieure à 1, elle est définie par défaut sur 1.
languageCode

string

Code de langue du résumé. Utilisez les balises de langue définies par BCP47. Remarque : Il s'agit d'une fonctionnalité expérimentale.
ignoreNonAnswerSeekingQuery

boolean

Facultatif. Indique s'il faut filtrer les requêtes qui ne cherchent pas de réponse. La valeur par défaut est false.

Aucune réponse n'est renvoyée si la requête de recherche est classée comme requête ne cherchant pas de réponse. Si ce champ est défini sur true, nous ne générons pas de réponses pour les requêtes qui ne cherchent pas de réponse et nous renvoyons des messages de remplacement.
ignoreAdversarialQuery

boolean

Facultatif. Indique s'il faut filtrer les requêtes adversariales.
ignoreLowRelevantContent

boolean

Facultatif. Indique s'il faut filtrer les requêtes qui ne sont pas pertinentes pour le contenu.
imageSource

enum (ImageSource)

Facultatif. Source de l'image renvoyée dans la réponse.

ImageSource

Source de l'image renvoyée dans la réponse.

Enums
IMAGE_SOURCE_UNSPECIFIED Source d'image non spécifiée (la fonctionnalité multimodale est désactivée par défaut)
ALL_AVAILABLE_SOURCES Comportement lorsque le service détermine la sélection à partir de toutes les sources disponibles.
CORPUS_IMAGE_ONLY Incluez une image du corpus dans la réponse.
FIGURE_GENERATION_ONLY Déclenche la génération de figures dans la réponse.

FeatureState

État de la fonctionnalité pour le moteur.

Enums
FEATURE_STATE_UNSPECIFIED L'état de la fonctionnalité n'est pas spécifié.
FEATURE_STATE_ON La fonctionnalité est activée pour être accessible.
FEATURE_STATE_OFF La fonctionnalité est désactivée et donc inaccessible.

AccessSettings

Décrit les paramètres d'accès aux widgets.

Représentation JSON 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
Champs
allowPublicAccess

boolean

Indique si l'accès public non authentifié est autorisé.
allowlistedDomains[]

string

Liste des domaines autorisés à intégrer le widget de recherche.
enableWebApp

boolean

Indique si l'accès à l'application Web est activé.
workforceIdentityPoolProvider

string

Facultatif. Fournisseur de pool d'identités de personnel utilisé pour accéder au widget.
languageCode

string

Facultatif. Code de langue de l'interface utilisateur. Utilisez les balises de langue définies par BCP47. Si elle n'est pas définie, le code de langue par défaut est "en-US".

UiBrandingSettings

Décrit les paramètres de branding de l'UI du widget.

Représentation JSON 
{
  "logo": {
    object (Image)
  }
}
Champs

Image

Options de stockage d'une image.

Représentation JSON 
{

  // Union field storage_method can be only one of the following:
  "url": string
  // End of list of possible types for union field storage_method.
}
Champs
Champ d'union storage_method. Différentes façons de stocker une image (par exemple, sous forme d'URL ou de chaîne encodée en base64). storage_method ne peut être qu'un des éléments suivants :
url

string

URL de l'image.

HomepageSetting

Décrit le paramètre de page d'accueil du widget. Il inclut tous les paramètres et configurations liés à la page d'accueil, comme les raccourcis.

Représentation JSON 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
Champs
shortcuts[]

object (Shortcut)

Facultatif. Raccourcis à afficher sur la page d'accueil. 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)

Raccourci

Décrit une entité de raccourci (également appelée contenu épinglé) sur la page d'accueil. La page d'accueil affichera ces raccourcis dans le même ordre que celui renvoyé par l'API. Si un client souhaite réorganiser ou supprimer un raccourci, l'UI doit toujours fournir la nouvelle liste complète des raccourcis.

Représentation JSON 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
Champs
title

string

Facultatif. Titre du raccourci.
icon

object (Image)

Facultatif. URL de l'icône du raccourci.
destinationUri

string

Facultatif. URL de destination du raccourci.

AssistantSettings

Décrit les paramètres de l'assistant du widget.

Représentation JSON 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
Champs
googleSearchGroundingEnabled
(deprecated)

boolean

Indique si le bouton bascule d'ancrage de la recherche Google est affiché ou non. Obsolète. Utilisez plutôt webGroundingType.
webGroundingType

enum (WebGroundingType)

Facultatif. Type d'ancrage Web à utiliser.
defaultWebGroundingToggleOff

boolean

Uniquement en sortie. Ce champ contrôle le bouton bascule de l'ancrage Web par défaut pour les utilisateurs finaux si webGroundingType est défini sur WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. Par défaut, ce champ est défini sur "false". Si webGroundingType est défini sur WEB_GROUNDING_TYPE_GOOGLE_SEARCH ou WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, l'ancrage Web est activé par défaut pour les utilisateurs finaux dans l'UI. Si la valeur est "true", le bouton d'ancrage sera désactivé par défaut dans l'UI. Les utilisateurs finaux peuvent toujours activer l'ancrage Web dans l'interface utilisateur si cette option est activée.
disableLocationContext

boolean

Facultatif. Uniquement en sortie. Indique s'il faut désactiver le contexte de la position de l'utilisateur.

WebGroundingType

Type d'ancrage Web à utiliser.

Enums
WEB_GROUNDING_TYPE_UNSPECIFIED Paramètre par défaut non spécifié. Cela revient à désactiver la fonctionnalité.
WEB_GROUNDING_TYPE_DISABLED L'ancrage Web est désactivé.

CustomerProvidedConfig

Configurations fournies par le client.

Représentation JSON 
{
  "customerType": enum (CustomerType)
}
Champs
customerType

enum (CustomerType)

Type de client.

CustomerType

Type de client.

Enums
DEFAULT_CUSTOMER Type de client par défaut.
GOVERNMENT_CUSTOMER Type de client "Administration". Certaines fonctionnalités sont désactivées pour les clients du secteur public en raison d'exigences légales.

Méthodes

get

 Récupère un WidgetConfig.