Importer les données de saisie semi-automatique pour la recherche

La saisie semi-automatique est une fonctionnalité qui permet de prédire le reste du mot qu'un utilisateur saisit, ce qui peut améliorer l'expérience de recherche de l'utilisateur. Cette fonctionnalité peut fournir des suggestions basées sur l'ensemble de données ou sur les événements utilisateur que vous lui fournissez.

Envisagez d'importer des données de saisie semi-automatique uniquement si vous souhaitez disposer de commandes supplémentaires (Ne pas supprimer la liste, Liste de refus) ou si vous devez utiliser vos propres données de saisie semi-automatique. L'activation de l'apprentissage automatique est suffisante dans la plupart des cas où la saisie semi-automatique est nécessaire. L'apprentissage automatique fournit un ensemble de données de suggestions alimenté par le machine learning et basé sur les événements de recherche utilisateur. Pour savoir comment activer l'apprentissage automatique, consultez la page Saisie semi-automatique.

Remarque :Depuis septembre 2022, vous pouvez utiliser la console Cloud > Commandes > UI des commandes de saisie semi-automatique pour déclencher l'importation de données.

Ces instructions ne concernent que l'importation de vos propres données de saisie semi-automatique. Maintenez-le à jour si vous prévoyez d'utiliser votre ensemble de données avec saisie semi-automatique en permanence. Pour obtenir les résultats de la saisie semi-automatique au moment de la requête, consultez CompletionService.CompleteQuery. Les données de saisie semi-automatique ne sont utilisées que pour la recherche. Ces données ne sont pas utilisées dans les recommandations.

Avant de commencer

Avant de pouvoir importer vos informations de saisie semi-automatique, vous devez suivre les instructions de la section Avant de commencer, en particulier configurer votre projet, créer un compte de service et ajouter le compte de service à votre environnement local.

Vous devez disposer du rôle IAM Éditeur Retail pour effectuer l'importation.

Bonnes pratiques d'importation pour la saisie semi-automatique

Lorsque vous importez des données de saisie semi-automatique, veillez à appliquer les bonnes pratiques suivantes:

• Lisez le schéma BigQuery répertorié dans les sections suivantes et la documentation de l'API.

• N'utilisez pas de valeurs d'espace réservé.

• Incluez autant de champs que possible.

• Mettez à jour votre propre ensemble de données avec saisie semi-automatique si vous prévoyez d'utiliser votre propre ensemble de données importé.

• L'importation de données depuis un autre projet n'est pas autorisée.

Importer des données de saisie semi-automatique

Importer des données de saisie semi-automatique depuis BigQuery

Vertex AI Search pour le commerce est compatible avec l'importation de données BigQuery pour les listes de refus, les listes à ne pas supprimer et les listes de termes suggérés. Pour en savoir plus, consultez la section Saisie semi-automatique.

Pour importer des données de saisie semi-automatique au bon format depuis BigQuery, utilisez le schéma de saisie semi-automatique de Vertex AI Search pour le commerce afin de créer une table BigQuery au format approprié et de charger la table avec vos données de saisie semi-automatique. Importez ensuite vos données dans Vertex AI Search pour le commerce.

Pour plus d'informations sur les tables BigQuery, consultez la page Présentation des tables. Pour obtenir de l'aide sur les requêtes BigQuery, consultez la page Présentation des requêtes de données dans BigQuery.

Emplacement de l'ensemble de données BigQuery

Lorsque vous créez pour la première fois un ensemble de données BigQuery pour vos tables BigQuery avec saisie semi-automatique, assurez-vous que l'emplacement de l'ensemble de données est défini sur l'emplacement multirégional "US". Si vous ne le configurez pas correctement, votre requête d'importation échouera ultérieurement. Pour en savoir plus sur les emplacements des ensembles de données BigQuery, consultez la page Emplacements des ensembles de données dans la documentation BigQuery.

Insérer les données dans BigQuery

Utilisez le schéma de saisie semi-automatique de Vertex AI Search pour le commerce pour importer vos données de saisie semi-automatique dans BigQuery.

BigQuery peut utiliser le schéma pour vérifier si les données au format JSON présentent des noms et des types de champ corrects (tels que STRING, INTEGER et RECORD), mais n'est pas capable de vérifier :

• Si un champ de chaîne est mappé sur une valeur d'énumération reconnaissable.
• Si un champ de chaîne utilise le format approprié.
• Si la valeur d'un champ de type entier ou nombre à virgule flottante se situe dans une plage valide.
• Si un champ manquant est un champ obligatoire.

Pour garantir la qualité de vos données et de l'expérience de recherche des utilisateurs finaux, veillez à vous reporter au schéma et à la documentation de référence pour plus de détails sur les valeurs et sur les formats à utiliser.

Configurer l'accès à votre ensemble de données BigQuery

Pour configurer l'accès, assurez-vous que votre ensemble de données BigQuery se trouve dans le même projet que votre service Vertex AI Search pour le commerce et suivez les étapes ci-dessous.

1. Ouvrez la page "IAM" dans Google Cloud Console.

   Ouvrir la page IAM

2. Sélectionnez votre projet Vertex AI Search pour le commerce.

3. Sur la page IAM et administration, cliquez sur  Accorder l'accès.

4. Pour Nouveaux comptes principaux, saisissez [e-mail] et sélectionnez le rôle BigQuery > Lecteur de données BigQuery.

   Si vous ne souhaitez pas attribuer le rôle de lecteur de données sur l'ensemble du projet, vous pouvez l'ajouter directement au niveau de l'ensemble de données. En savoir plus

5. Cliquez sur Enregistrer.

Déclencher l'importation de données dans Vertex AI Search pour le commerce

Console

1. Accéder à la page "Contrôles"

2. Accédez à l'onglet Commandes de saisie semi-automatique.

3. Dans la section Listes de termes, recherchez le type de liste que vous prévoyez d'importer (Liste de refus, Liste de ne pas supprimer ou Liste des termes suggérés), puis cliquez sur Importer ou Remplacer.

   Le volet Import (Importer) s'ouvre.

4. Saisissez le chemin d'accès BigQuery de l'emplacement de vos données ou sélectionnez Parcourir pour sélectionner l'emplacement.

   Le chemin d'accès BigQuery doit se trouver dans le même projet et son schéma doit être correct. Pour le vérifier, cliquez sur Parcourir, puis sur le nom de la table pour afficher son contenu dans la console BigQuery.

5. Dans le volet Importer, cliquez sur Importer.

   L'importation commence. Vous pouvez quitter la page sans interrompre l'importation.

cURL

1. Créez un fichier de données pour les paramètres d'entrée de l'importation. Les valeurs de vos paramètres d'entrée varient selon que vous importez depuis Cloud Storage ou BigQuery.

   Utilisez l'objet BigQuerySource pour pointer vers votre ensemble de données BigQuery.

   • dataset-id : ID de l'ensemble de données BigQuery.
   • table-id : ID de la table BigQuery contenant vos données.
   • data-schema : pour la propriété dataSchema, utilisez les valeurs suggestions (par défaut), allowlist et denylist. Utilisez le schéma de saisie semi-automatique de Vertex AI Search pour le commerce.

   {
     "inputConfig":{
       "bigQuerySource": {
         "datasetId":"dataset-id",
         "tableId":"table-id",
         "dataSchema":"data-schema"
       }
     }
   }
   

2. Importez vos informations de saisie semi-automatique dans Vertex AI Search pour le commerce en envoyant une requête POST à la méthode REST CompletionData:import, en fournissant le nom du fichier de données (input.json dans l'exemple ci-dessous).

   curl -X POST \
   -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   -H "Content-Type: application/json; charset=utf-8" -d @./input.json
   "https://retail.googleapis.com/v2alpha/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/completionData:import"
   

   Vous pouvez vérifier l'état de manière automatisée avec l'API. Vous devriez recevoir un objet de réponse ressemblant à ceci :

   {
     "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456",
     "done": false
   }
   

   Le champ de nom est l'ID de l'objet d'opération. Pour demander l'état de cet objet, remplacez le champ "name" par la valeur renvoyée par la méthode d'importation. Une fois l'importation terminée, le champ done renvoie la valeur true:

   curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   "https://retail.googleapis.com/v2alpha/projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456"
   

   Une fois l'opération terminée, l'objet renvoyé a une valeur done de true et inclut un objet Status semblable à l'exemple suivant :

   {
     "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.retail.v2alpha.ImportMetadata",
       "createTime": "2020-01-01T03:33:33.000001Z",
       "updateTime": "2020-01-01T03:34:33.000001Z",
       "successCount": "2",
       "failureCount": "1"
     },
     "done": true
     "response": {
       "@type": "type.googleapis.com/google.cloud.retail.v2alpha.ImportCompletionDataResponse",
     }
   }
   

Format de données pour la saisie semi-automatique

Votre fichier JSON doit ressembler aux exemples suivants. Les sauts de ligne ne sont là que pour des raisons de lisibilité. Vous devez fournir une suggestion entière sur une seule ligne. Chaque suggestion doit figurer sur une ligne distincte.

Champs obligatoires pour la suggestion :

{
  "suggestion": "ABC",
  "globalScore": "0.5"
}

ou

{
  "suggestion": "ABC",
  "frequency": "100"
}

Durée de l'importation des données avec Autocomplete

Une importation à partir de BigQuery prend généralement entre quelques minutes et une heure.

Une fois l'importation de l'ensemble de données terminée, le champ done de l'objet d'opération est marqué comme vrai. Passé ce délai, un à deux jours supplémentaires peuvent être nécessaires pour que les données soient indexées et utilisées pour la diffusion en production.

Maintenir à jour votre ensemble de données avec saisie semi-automatique

Si vous prévoyez d'utiliser votre propre ensemble de données importé, il est recommandé de maintenir régulièrement l'ensemble de données importé à jour.

Mise à jour groupée

Vous pouvez utiliser la méthode d'importation pour mettre à jour la saisie semi-automatique de manière groupée. Procédez de la même manière que pour l'importation initiale, en suivant les étapes décrites dans la section Importer des données de saisie semi-automatique. Cette action remplacera l'intégralité de l'ensemble de données importé.

Surveiller l'état des importations

Pour toujours obtenir des suggestions de haute qualité lorsque vous utilisez la saisie semi-automatique, il est important de maintenir votre ensemble de données à jour. Vous devez surveiller les taux d'erreur d'importation et prendre des mesures, le cas échéant.

Schéma de saisie semi-automatique de Vertex AI Search pour le commerce

Lorsque vous importez un ensemble de données avec saisie semi-automatique depuis BigQuery, utilisez le schéma Vertex AI Search pour le commerce ci-dessous pour créer des tables BigQuery au format approprié et les charger avec vos données de saisie semi-automatique.

Schéma des suggestions

Cet ensemble de données permet de fournir vos propres suggestions de saisie semi-automatique avec vos propres scores.

Schéma JSON des suggestions de saisie semi-automatique pour Vertex AI Search pour le commerce

JSON

[
  {
    "description": "The suggestion text",
    "mode": "NULLABLE",
    "name": "suggestion",
    "type": "STRING"
  },
  {
    "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked. Only one of this and frequency should be set.",
    "mode": "NULLABLE",
    "name": "globalScore",
    "type": "FLOAT"
  },
  {
    "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.",
    "mode": "NULLABLE",
    "name": "frequency",
    "type": "INTEGER"
  },
  {
    "description": "BCP-47 language code of this suggestion.",
    "mode": "NULLABLE",
    "name": "languageCode",
    "type": "STRING"
  },
  {
    "description": "If two suggestions have the same groupID, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.",
    "mode": "NULLABLE",
    "name": "groupID",
    "type": "STRING"
  },
  {
    "description": "The score of this suggestion within its group",
    "mode": "NULLABLE",
    "name": "groupScore",
    "type": "FLOAT"
  },
  {
    "description": "Device type for this suggestion.",
    "mode": "NULLABLE",
    "name": "deviceType",
    "type": "STRING"
  },
  {
    "description": "Alternative matching phrases for this suggestion.",
    "mode": "REPEATED",
    "name": "alternativePhrases",
    "type": "STRING"
  },
  {
    "fields": [
      {
        "description": "The name of the custom attribute.",
        "mode": "NULLABLE",
        "name": "key",
        "type": "STRING"
      },
      {
        "fields": [
          {
            "description": "The textual values of this custom attribute.",
            "mode": "REPEATED",
            "name": "text",
            "type": "STRING"
          },
          {
            "description": "The numerical values of this custom attribute.",
            "mode": "REPEATED",
            "name": "numbers",
            "type": "FLOAT"
          }
        ],
        "mode": "NULLABLE",
        "name": "value",
        "type": "RECORD"
      }
    ],
    "description": "A custom attribute that is not explicitly modeled, which can be retrieved together with the suggestion at serving time.",
    "mode": "REPEATED",
    "name": "customAttributes",
    "type": "RECORD"
  }
]

Schéma de la liste de blocage

Cet ensemble de données est utilisé comme liste de blocage pour empêcher la suggestion de certaines expressions.

Fichier JSON du schéma de liste de blocage Vertex AI Search pour la saisie semi-automatique pour le commerce

JSON

[
  {
    "description": "The phrase to block from autocomplete suggestions.",
    "mode": "REQUIRED",
    "name": "phrase",
    "type": "STRING"
  },
  {
    "description": "The operator to apply for this phrase. Choose whether to block the exact phrase, or block any suggestions containing this phrase. Supported value \"EXACT_MATCH\", \"CONTAINS\"",
    "mode": "REQUIRED",
    "name": "operator",
    "type": "STRING"
  }
]

Schéma de la liste d'autorisation

Cet ensemble de données permet d'ignorer les processus postérieurs (tels que la correction orthographique et le filtrage sans résultat) pour toutes les expressions de cette liste d'autorisation.

JSON pour le schéma de la liste d'autorisation de saisie semi-automatique de Vertex AI Search pour le commerce

JSON

[
  {
    "description": "The phrase to be exempted from autocomplete post processing, e.g. spell correction, filtering",
    "mode": "REQUIRED",
    "name": "phrase",
    "type": "STRING"
  },
  {
    "description": "The operator to apply for this phrase. Whether to match the exact phrase, or any suggestions contain this phrase. Supported values are \"EXACT_MATCH\", \"CONTAINS\".",
    "mode": "REQUIRED",
    "name": "operator",
    "type": "STRING"
  }
]