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,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
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'humain. 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. Sinon, 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 dernière 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 ou non.
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.

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

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

object (FacetField)

La configuration et l'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 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 cette WidgetConfig peut être utilisée.
industryVertical

enum (IndustryVertical)

Uniquement en sortie. Verticale d'activité à laquelle WidgetConfig est associé. La verticale WidgetConfig est basée 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 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.
  • 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 datastores 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 les résultats des sources de données sélectionnées.

Pour les moteurs SaaS / Business, lorsque LookupWidgetConfig est appelé avec view = WITH_AVAILABLE_CONNECTORS, cette liste est également augmentée avec des entrées d'espace réservé synthétiques pour les connecteurs que l'appelant peut joindre, mais n'a pas encore joints (voir CollectionComponent pour le contrat d'espace réservé). Le frontend peut donc afficher une liste unifiée des sources déjà associées et de celles qui peuvent l'être en itérant ce champ unique. Pour les moteurs Enterprise et pour le view par défaut, seuls les connecteurs déjà associés sont renvoyés (comportement actuel).
enableSearchAsYouType
(deprecated)

boolean

Indique si le comportement de saisie semi-automatique doit être activé pour le widget 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 de widget 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 personnalisation 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é.
geminiBundle

boolean

Uniquement en sortie. Indique si l'abonnement est un forfait Gemini.
batchAuthStatuses[]

object (BatchAuthStatus)

Uniquement en sortie. États d'autorisation par lot pour les connecteurs du widget.
nodes[]

object (Node)

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

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 lorsqu'elle n'est pas spécifiée. Le serveur renvoie INVALID_ARGUMENT s'il est utilisé dans les requêtes.
MOBILE Le composant UI est visible sur les appareils mobiles.
DESKTOP Le composant d'interface utilisateur 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 visible par les utilisateurs finaux.

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é (extrait affiché par défaut).
SNIPPET Afficher les résultats du champ "Extrait".
EXTRACTIVE_ANSWER Afficher les résultats du champ "Réponses par extraction".

DataStoreUiConfig

Configuration du composant d'UI 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.

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

Les trois champs personnalisés sont facultatifs. Vous pouvez les ajouter ou les supprimer. 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 collections de data store pouvant être utilisés pour le filtrage.

Pour les moteurs SaaS / Business, lorsque LookupWidgetConfig est appelé avec view = WITH_AVAILABLE_CONNECTORS, les instances de ce message sont également utilisées pour représenter des entrées d'espace réservé synthétiques pour les connecteurs que l'appelant peut joindre, mais n'a pas encore joints. Les entrées d'espace réservé comportent connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (ou NO_AUTH), un connectorAuthState.authorization_uri vide (le widget appelle WidgetBuildAuthorizationUrl lorsque l'utilisateur clique sur "Associer") et des valeurs d'espace réservé synthétiques dans name / id (voir les commentaires des champs). Les champs qui n'ont de sens que pour les connecteurs matérialisés (dataStoreComponents, tenant, actionConnector) ne sont pas définis pour les entrées d'espace réservé.

Représentation JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceVersion": number,
  "dataSourceDisplayName": string,
  "dataSourceEndUserDisplayName": string,
  "connectorIconLink": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  },
  "metadata": {
    object (ConnectorMetadata)
  },
  "isFirstParty": boolean,
  "tag": 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.

Pour les entrées d'espace réservé synthétiques (voir le commentaire au niveau du message), cela correspond à un ID de collection d'espace réservé synthétique qui ne correspond pas à une collection réelle. Les appelants ne doivent pas tenter de résoudre / GET cette ressource tant que l'utilisateur n'a pas autorisé le connecteur.
id

string

Sortie uniquement. 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.

Pour les entrées d'espace réservé synthétiques (voir le commentaire au niveau du message), il s'agit d'un ID d'espace réservé synthétique, et non d'un véritable collectionId.
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.
dataSourceVersion

number

Uniquement en sortie. Version de la définition du connecteur qui sous-tend cette collection, en miroir de DataConnector.data_source_version.
dataSourceDisplayName

string

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

string

Uniquement en sortie. Nom à afficher de la source de données, visible par l'utilisateur final, provenant de ConnectorSource.end_user_display_name. Si elle n'est pas définie, les clients reviennent à dataSourceDisplayName.
connectorAuthState

object (ConnectorAuthState)

Uniquement en sortie. URI d'authentification de la source du connecteur.
metadata

object (ConnectorMetadata)

Uniquement en sortie. Métadonnées du connecteur visibles par l'utilisateur (title, description, shortDescription, author, note), récupérées à partir du registre ConnectorSource.metadata (jointes par source de données). Affiché sur la page d'informations sur le connecteur.
isFirstParty

boolean

Uniquement en sortie. Indique si le connecteur est propriétaire (appartenant à Google) ou tiers. Utilisé par le frontend pour regrouper les connecteurs first party et tiers.
tag

string

Uniquement en sortie. Libellé indépendant de la version du connecteur qui soutient cette collection, en écho à DataConnector.tag. Contrairement à l'ID du data store associé à une version spécifique, il survit à la mise à niveau de la version d'un connecteur. Par conséquent, un connecteur mis à niveau conserve le même tag.

Clé non unique. Comme indiqué dans les documents DataConnector.tag, plusieurs connecteurs peuvent partager un tag sous le même (projet, emplacement, collection, dataSource), et la recherche basée sur les tags est résolue sur celui avec le createTime le plus élevé. Les clients ne doivent pas traiter cela comme un identifiant de connecteur.

Vide lorsque le connecteur a été créé avant le lancement de l'écriture de tags, et pour les entrées d'espace réservé synthétiques, qui n'ont pas de DataConnector sous-jacent. Renseigné uniquement lorsque ConnectorsFeature.enable_connector_tag est activé.

DataStoreComponent

Composant de data store en lecture seule qui contient des champs de datastore 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.

ConnectorAuthState

Connecteur en lecture seule dans l'état d'authentification CollectionComponent.

Représentation JSON 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
Champs
authState

enum (AuthState)

Uniquement en sortie. État d'autorisation du connecteur de données.
authorizationUri

string

Uniquement en sortie. URI d'autorisation pour le connecteur de données.

Pour les entrées d'espace réservé synthétiques CollectionComponent (renvoyées par LookupWidgetConfig avec view = WITH_AVAILABLE_CONNECTORS sur les moteurs SaaS / Business), ce champ est laissé vide. Le widget doit appeler WidgetService.WidgetBuildAuthorizationUrl lorsque l'utilisateur clique sur "Connecter" pour obtenir une URL d'autorisation nouvellement créée.
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la mise à jour de l'état d'autorisation.

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".

AuthState

État d'autorisation du connecteur de données.

Enums
AUTH_STATE_UNSPECIFIED Valeur par défaut. Également renvoyé pour les entrées d'espace réservé synthétiques CollectionComponent générées par LookupWidgetConfig avec view = WITH_AVAILABLE_CONNECTORS (SaaS / Business uniquement). Ces entrées représentent les connecteurs que l'appelant peut joindre, mais qu'il n'a pas encore joints.
AUTHORIZED L'utilisateur a autorisé le connecteur de données.
EXPIRED L'autorisation utilisateur pour le connecteur de données a expiré.
ACTIONS_DISABLED L'utilisateur peut toujours effectuer des requêtes de recherche, mais les actions doivent être activées.
NO_AUTH Le connecteur de données ne nécessite aucune autorisation. Également utilisé pour les entrées d'espace réservé dont le connecteur sous-jacent ne nécessite pas l'autorisation OAuth de l'utilisateur.

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),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "modelConfigInfo": {
    object (ModelConfigInfo)
  },
  "sourceAdminDisplayNameEnabled": boolean,
  "onedrivePickerEnabled": boolean,
  "googleDrivePickerEnabled": boolean
}
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 l'affichage de l'extrait de résultat et la manière dont il est affiché (extrait ou réponse extractive). La valeur par défaut est "no result" (aucun résultat) si aucune valeur n'est spécifiée.
enableAutocomplete

boolean

Indique si la saisie semi-automatique doit être activée ou non.
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 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 "true", le widget active le résumé du contenu visuel pour les requêtes de recherche applicables. Utilisé uniquement par la recherche dans le secteur de la 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 pour que le moteur puisse les activer ou les désactiver. Clés acceptées :

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • speech-to-text
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • canvas-app-builder
  • skills
  • skill-sharing
  • skill-sharing-without-admin-approval
  • disable-projects
  • sobi
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
  • workflow-agents
  • in-app-notifications
modelConfigs

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

Uniquement en sortie. Mappe un nom de modèle à sa configuration spécifique pour ce moteur. Cela permet aux utilisateurs administrateurs d'activer ou de désactiver des modèles individuels. Seuls les modèles dont l'état est remplacé par l'administrateur sont stockés.

Lorsque l'état n'est pas spécifié ou que modelConfigs est vide pour ce modèle, le système décide si ce modèle doit être disponible ou non en fonction de la configuration par défaut. Par exemple, un modèle d'aperçu doit être désactivé par défaut si l'administrateur n'a pas choisi de l'activer.
searchAddonSpec

object (SearchAddonSpec)

Facultatif. SearchAddonSpec permet de désactiver les modules complémentaires pour la recherche. Ce champ n'est disponible que pour les demandes de recherche.
modelConfigInfo

object (ModelConfigInfo)

Uniquement en sortie. Vue côté serveur de la configuration du sélecteur de modèle. Contient à la fois la liste ordonnée des modèles qui doivent apparaître dans le menu déroulant du sélecteur de modèles et le modèle qui doit être sélectionné par défaut.

Les clients doivent afficher directement cette valeur, sans appliquer leur propre filtrage, tri ou localisation. L'ancienne carte modelConfigs ci-dessus est conservée pour assurer la rétrocompatibilité avec les clients qui n'ont pas encore migré vers l'utilisation de ce champ.
sourceAdminDisplayNameEnabled

boolean

Facultatif. Indique si le nom à afficher configuré par l'administrateur pour les connecteurs de données doit être affiché dans l'UI des sources de widgets (au lieu du type de connecteur). Activation ; la valeur par défaut est "false".
onedrivePickerEnabled

boolean

Uniquement en sortie. Indique si le sélecteur de fichiers OneDrive est disponible pour les utilisateurs finaux. Calculé par le backend à partir de l'activation du connecteur administrateur (édition Business) ou des connecteurs OneDrive associés (édition Enterprise), combiné à la fonctionnalité d'administration disable-onedrive-upload existante.

optional déclaré pour qu'un false calculé de manière explicite soit sérialisé avec la présence du champ. Un fichier bool proto3 brut dépose un false par défaut sur le réseau, ce qui empêchait les clients de distinguer "sélecteur désactivé" (false) de "champ non renseigné" (non défini).
googleDrivePickerEnabled

boolean

Uniquement en sortie. Indique si le sélecteur de fichiers Google Drive est disponible pour les utilisateurs finaux. optional déclaré pour la même raison de présence de champ que onedrivePickerEnabled ci-dessus.

InteractionType

Décrit le type d'interaction.

Enums
INTERACTION_TYPE_UNSPECIFIED Non spécifié. La valeur par défaut est SEARCH_ONLY.
SEARCH_ONLY Recherchez 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 est de cinq étapes. Si elle n'est pas définie ou est définie sur une valeur inférieure à 1, elle est définie sur 1 par défaut.
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. Spécifie 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éponses et renvoyons des messages de remplacement.
ignoreAdversarialQuery

boolean

Facultatif. Indique si les requêtes adversariales doivent être filtrées.
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.

ModelState

État du modèle pour le moteur.

Enums
MODEL_STATE_UNSPECIFIED L'état du modèle n'est pas spécifié.
MODEL_ENABLED Le modèle est activé par l'administrateur.
MODEL_DISABLED Le modèle est désactivé par l'administrateur.

SearchAddonSpec

SearchAddonSpec permet de désactiver les modules complémentaires pour la recherche. Par défaut, si ce champ n'est pas spécifié, les modules complémentaires sont activés partout où cela est possible.

Représentation JSON 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
Champs
semanticAddOnDisabled

boolean

Facultatif. Si la valeur est "true", le module complémentaire sémantique est désactivé. Le module complémentaire sémantique inclut les embeddings et Jetstream.
kpiPersonalizationAddOnDisabled

boolean

Facultatif. Si la valeur est "true", le re-classement et la personnalisation des événements sont désactivés pour optimiser les KPI et personnaliser les résultats.
generativeAnswerAddOnDisabled

boolean

Facultatif. Si la valeur est "true", le module complémentaire de réponses génératives est désactivé. Le module complémentaire de réponses génératives inclut le langage naturel pour les filtres et les réponses simples.

ModelConfigInfo

Vue côté serveur résolue de la configuration du sélecteur de modèle pour l'utilisateur final. Le backend calcule cette valeur par requête en appliquant, dans l'ordre : l'évaluation des flags Mendel, les règles de disponibilité régionale en fonction de l'emplacement du moteur et les remplacements du panneau d'administration à partir de modelConfigs.

Le backend est la source unique de vérité pour cette configuration. Les clients doivent afficher resolvedModels directement dans le menu déroulant du sélecteur de modèle, dans l'ordre fourni, sans appliquer leur propre filtrage, tri ou localisation.

Représentation JSON 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string,
  "autoModelId": string
}
Champs
resolvedModels[]

object (ResolvedModel)

Uniquement en sortie. Liste des modèles disponibles pour l'utilisateur final dans le sélecteur de modèles, dans l'ordre dans lequel ils doivent être affichés.
defaultModelId

string

Uniquement en sortie. Le modelId du modèle qui doit être sélectionné par défaut dans le sélecteur de modèle lorsque l'utilisateur final n'a pas fait de choix explicite. La valeur est toujours l'une des modelId présentes dans resolvedModels.
autoModelId

string

Uniquement en sortie. Le modelId qu'un client doit envoyer lorsque l'utilisateur final sélectionne l'entrée "Auto" (le modelId vide).

Ce champ n'est renseigné que pour les surfaces connues pour ne pas avoir de véritable mode "Auto", où le fait de laisser le modèle non défini reviendrait à utiliser un modèle par défaut de la plate-forme plutôt qu'un modèle choisi par le backend. Vide sur toutes les autres surfaces, lorsque "Auto" est résolu côté serveur et lorsqu'aucun des modèles classés de la surface n'est disponible. Lorsqu'il est défini, il s'agit toujours de l'un des modelId non vides présents dans resolvedModels.

ResolvedModel

Modèle unique qui est résolu pour être disponible pour l'utilisateur final dans le sélecteur de modèles, avec toutes ses métadonnées d'affichage localisées.

Représentation JSON 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "label": string,
  "adminView": {
    object (AdminView)
  },
  "promoted": boolean,
  "iconUrl": string,
  "family": string
}
Champs
modelId

string

Uniquement en sortie. Identifiant unique du modèle (par exemple, gemini-2.5-flash, gemini-3.1-pro-preview).

Il s'agit du même identifiant que celui que les clients renvoient au service d'assistance pour sélectionner ce modèle. Les modèles virtuels ou "pseudo" (par exemple, gemini-fast) sont également des valeurs valides. Ils sont résolus en modèle concret sous-jacent sur le backend.
displayName

string

Uniquement en sortie. Nom à afficher localisé du modèle (par exemple, Gemini 3.1 Pro). Localisé côté serveur en fonction des LookupWidgetConfigRequest.language_code et LookupWidgetConfigRequest.region_code de la requête.
icon

string

Uniquement en sortie. Jeton d'icône compatible avec GM3 associé au modèle (par exemple, rocket_launch, bolt, graph_5).
description

string

Uniquement en sortie. Texte de description localisé (par exemple, state-of-the-art reasoning). Localisé à l'aide du même paramètre régional que displayName.
isPreview

boolean

Uniquement en sortie. Indique si le modèle est actuellement en version preview. Les clients doivent l'indiquer à l'aide d'un badge "Aperçu" dans l'interface utilisateur du sélecteur.
label

string

Uniquement en sortie. Libellé court affiché dans le chip de la barre de sélection compacte (par exemple, 3.x Flash) par opposition au displayName complet (Gemini 3.x Flash). Revient à displayName lorsque le registre du backend ne spécifie pas de libellé court distinct.
adminView

object (AdminView)

Uniquement en sortie. Métadonnées de l'interface d'administration, renseignées uniquement pour la page "Contrôle des fonctionnalités" de la console d'administration (voir AdminView). Non définies pour les interfaces utilisateur final.
promoted

boolean

Uniquement en sortie. Indique si ce modèle doit être mis en avant dans la bannière de la page d'accueil du chat GE.
iconUrl

string

Uniquement en sortie. URL absolue d'une marque à afficher à la place de icon, pour les modèles dont le logo du fournisseur n'est pas un glyphe GM3.

icon reste renseigné comme solution de repli. Ainsi, un client qui n'affiche pas les images ou qui ne parvient pas à récupérer celle-ci affiche le glyphe au lieu de rien.
family

string

Uniquement en sortie. Regroupe les modèles qui s'affichent ensemble dans le sélecteur. Les modèles partageant une valeur forment un groupe. Une valeur vide signifie que le modèle n'appartient à aucun groupe.

Comparé uniquement pour l'égalité : n'est jamais analysé ni montré à un utilisateur. Il n'est donc pas localisé.

AdminView

Métadonnées de l'interface d'administration. Renseigné uniquement lorsque la demande provient de la page "Contrôle des fonctionnalités" de la console d'administration Cloud. Non défini pour les surfaces destinées aux utilisateurs finaux (Web, mobile). Permet à la page d'administration d'afficher son tableau d'activation directement à partir du backend au lieu d'un registre côté client codé en dur.

Représentation JSON 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
Champs
adminOverridable

boolean

Uniquement en sortie. Indique si l'administrateur peut activer ou désactiver ce modèle via UiSettings.model_configs. Dérivé de MODEL_TAG_ADMIN_OVERRIDABLE. Si la valeur est "false", le modèle est "forcé" et son état est régi par enabledByDefault.
enabledByDefault

boolean

Uniquement en sortie. Indique si le modèle est activé lorsque l'administrateur n'a défini aucune substitution explicite dans UiSettings.model_configs. Dérivé de MODEL_TAG_ENABLED_BY_DEFAULT.
regions[]

string

Uniquement en sortie. Régions dans lesquelles ce modèle est lancé.

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 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 pour l'interface utilisateur. Utilisez les balises de langue définies par BCP47. Si elle n'est pas défini, le code de langue par défaut est "en-US".

UiBrandingSettings

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

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

Image

Options pour stocker une image.

Représentation JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "url": string
  // End of mutually exclusive fields.
}
Champs
Différentes façons de stocker une image (par exemple, sous forme d'URL ou de chaîne encodée en base64). Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
url

string

URL de l'image.
Fin des champs qui s'excluent mutuellement.

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.

Raccourci

Décrit une entité de raccourci (c'est-à-dire un 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,
  "mapsGroundingType": enum (MapsGroundingType),
  "defaultMapsGroundingToggleOff": boolean
}
Champs
googleSearchGroundingEnabled
(deprecated)

boolean

Indique si le bouton bascule d'ancrage avec 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 si le contexte de localisation de l'utilisateur doit être désactivé.
mapsGroundingType

enum (MapsGroundingType)

Facultatif. Type d'ancrage Google Maps à utiliser.
defaultMapsGroundingToggleOff

boolean

Uniquement en sortie. Ce champ contrôle le bouton bascule d'ancrage Maps par défaut pour les utilisateurs finaux si mapsGroundingType est défini sur MAPS_GROUNDING_TYPE_GOOGLE_MAPS. Par défaut, ce champ est défini sur "false". Si mapsGroundingType est défini sur MAPS_GROUNDING_TYPE_GOOGLE_MAPS, l'ancrage de cartes sera 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 de cartes dans l'UI si l'ancrage de cartes est activé.

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é.

MapsGroundingType

Type d'ancrage Google Maps à utiliser.

Enums
MAPS_GROUNDING_TYPE_UNSPECIFIED Paramètre par défaut non spécifié. Cela revient à désactiver la fonctionnalité.
MAPS_GROUNDING_TYPE_DISABLED L'ancrage Maps est désactivé.
MAPS_GROUNDING_TYPE_GOOGLE_MAPS L'ancrage avec Google Maps est activé.

CustomerProvidedConfig

Configurations fournies par le client.

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

enum (CustomerType)

Type de client.
complianceLevel

enum (ComplianceLevel)

Uniquement en sortie. Niveau de conformité Assured Workloads du client.

customerType regroupe tous les niveaux de conformité en une seule valeur GOVERNMENT_CUSTOMER. Par conséquent, un client qui limite l'accès à une fonctionnalité à un niveau spécifique plutôt qu'à l'état gouvernemental dans son ensemble doit lire ce champ.

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'obligations légales.

ComplianceLevel

Niveau de conformité Assured Workloads du projet du client.

Non figé : d'autres niveaux pourront être ajoutés à mesure que d'autres régimes de conformité seront pris en charge. Un client doit donc traiter une valeur non reconnue comme étant soumise à des restrictions gouvernementales plutôt que comme étant non soumise à des restrictions.

Enums
COMPLIANCE_LEVEL_UNSPECIFIED Le projet ne dispose d'aucun niveau de conformité Assured Workloads ou en signale un que cette version de l'API ne modélise pas.
COMPLIANCE_LEVEL_FEDRAMP_HIGH Niveau de conformité FedRAMP élevé.
COMPLIANCE_LEVEL_IL4 Niveau de conformité 4 (IL4).
COMPLIANCE_LEVEL_IL5 Niveau de conformité 5 (IL5)

BatchAuthStatus

Décrit l'état d'autorisation par lot pour un batchAuthorizationGroup.

Représentation JSON 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
Champs
placeholder

string

Uniquement en sortie. Il s'agit du nom complet de la ressource de l'espace réservé du groupe d'autorisation par lot. Il ne s'agit pas d'un véritable connecteur de données (il n'existe pas dans la table DataConnector de Spanner). Il s'agit d'un nom de ressource qui n'existe que dans connector_authorization dans la table des utilisateurs. Par exemple, projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.
batchAuthorizationGroup

string

Uniquement en sortie. Groupe d'autorisation par lot auquel appartient le code de substitution.
connectorAuthState

object (ConnectorAuthState)

Uniquement en sortie. État d'autorisation actuel de ce connecteur.

Nœud

Représente une seule unité de calcul ou logique réutilisable.

Représentation JSON 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
Champs
displayName

string

Uniquement en sortie. Nom du nœud lisible par l'utilisateur.
iconUrl

string

Uniquement en sortie. Identifiant ou URL pointant vers une icône représentant ce type de nœud.
description

string

Uniquement en sortie. Description détaillée de ce que fait le nœud.
parameterSchema

object (Struct format)

Uniquement en sortie. Schéma des paramètres de l'outil.

Ce schéma doit être conforme à la norme OpenAPI Schema (voir https://spec.openapis.org/oas/v3.0.3.html et AIP-146). Elle décrit la structure attendue des paramètres acceptés par ce nœud.
outputSchema

object (Struct format)

Uniquement en sortie. Schéma de sortie de l'outil.

Ce schéma doit être conforme à la norme OpenAPI Schema (voir https://spec.openapis.org/oas/v3.0.3.html/ et AIP-146). Elle décrit la structure de la sortie produite par ce nœud.
type

enum (Type)

Uniquement en sortie. Type du nœud.

Type

Identifie le type de nœud dans le flux de l'agent.

Enums
TYPE_UNSPECIFIED Type non spécifié.
TRIGGER Type de déclencheur.
FLOW le type de flux.
CONNECTOR Type de connecteur.

Méthodes

get

 Récupère un WidgetConfig.

patch

 Mettez à jour une WidgetConfig.