Configurer la saisie semi-automatique

Cette page décrit la fonctionnalité de saisie semi-automatique de base de Vertex AI Search. La saisie semi-automatique génère des suggestions de requêtes en fonction des premiers caractères saisis pour la requête.

Les suggestions générées par la saisie semi-automatique varient en fonction du type de données utilisé par l'application de recherche:

• Données structurées et non structurées Par défaut, la saisie semi-automatique génère des suggestions en fonction du contenu des documents du data store. Après l'importation de documents, par défaut, la saisie semi-automatique ne commence à générer de suggestions qu'une fois que suffisamment de données de qualité sont disponibles, généralement deux jours. Si vous envoyez des requêtes de saisie semi-automatique via l'API, la saisie semi-automatique peut générer des suggestions basées sur l'historique de recherche ou les événements utilisateur.

• Données sur le site Web : Par défaut, la saisie semi-automatique génère des suggestions à partir de l'historique des recherches. La saisie semi-automatique nécessite un trafic de recherche réel. Une fois le trafic de recherche lancé, la saisie semi-automatique met un jour ou deux avant de générer des suggestions. Des suggestions peuvent être générées à partir de données explorées sur le Web à partir de sites publics avec le modèle de données de documents avancé expérimental.

• Données de santé Par défaut, une source de données médicales canonique est utilisée pour générer des suggestions de saisie semi-automatique pour les data stores de santé. Pour la recherche dans le secteur de la santé, la saisie semi-automatique est une fonctionnalité en preview.

Le modèle de données de saisie semi-automatique détermine le type de données utilisé par la saisie semi-automatique pour générer des suggestions. Il existe quatre modèles de saisie semi-automatique:

• Document. Le modèle de document génère des suggestions à partir des documents importés par l'utilisateur. Ce modèle n'est pas disponible pour les données de site Web ni pour les données de santé.

• Champs à compléter Le modèle de champs à compléter suggère du texte extrait directement des champs de données structurées. Seuls les champs annotés avec completable sont utilisés pour les suggestions de saisie semi-automatique. Ce modèle n'est disponible que pour les données structurées.

• Historique des recherches Le modèle d'historique des recherches génère des suggestions à partir de l'historique des appels d'API SearchService.search. N'utilisez pas ce modèle si aucun trafic n'est disponible pour la méthode servingConfigs.search. Ce modèle n'est pas disponible pour les données de santé.

• Événement utilisateur Le modèle d'événement utilisateur génère des suggestions à partir des événements de recherche importés par l'utilisateur. Ce modèle n'est pas disponible pour les données de santé.

Les requêtes de saisie semi-automatique sont envoyées à l'aide de la méthode dataStores.completeQuery.

Le tableau suivant indique les types de modèles de saisie semi-automatique disponibles pour chaque type de données.

* : Le schéma de document doit contenir des champs title ou description, ou des champs qui ont été spécifiés comme propriétés de clé title ou description. Consultez Mettre à jour un schéma pour les données structurées.

^† : Le contenu exploré sur le Web ne peut être utilisé comme source de données que si le modèle de données de document avancé expérimental pour la saisie semi-automatique est activé. Consultez le modèle de données de document avancé.

Si vous ne souhaitez pas utiliser le modèle par défaut pour votre type de données, vous pouvez spécifier un autre modèle lorsque vous envoyez votre requête de saisie semi-automatique. Les requêtes de saisie semi-automatique sont envoyées à l'aide de la méthode dataStores.completeQuery. Pour en savoir plus, consultez Instructions de l'API: envoyer une requête de saisie semi-automatique pour choisir un autre modèle.

Fonctionnalités de saisie semi-automatique

Vertex AI Search est compatible avec les fonctionnalités de saisie semi-automatique suivantes pour afficher les prédictions les plus utiles lors de la recherche:

Suggestions de correspondance de fin

Les suggestions de correspondance de fin sont générées à l'aide d'une correspondance exacte de préfixe avec le dernier mot d'une chaîne de requête.

Par exemple, supposons que la requête "chansons avec he" soit envoyée dans une requête de saisie semi-automatique. Lorsque la correspondance de fin est activée, la saisie semi-automatique peut déterminer que le préfixe complet "chansons avec he" ne correspond à aucune recherche. Toutefois, le dernier mot de la requête, "il", présente une correspondance exacte de préfixe avec "hello world" et "hello kitty". Dans ce cas, les suggestions renvoyées sont "chansons avec hello world" et "chansons avec hello kitty", car il n'y a pas de suggestions de correspondance exacte.

Vous pouvez utiliser cette fonctionnalité pour réduire le nombre de suggestions vides et augmenter la diversité des suggestions. Elle est particulièrement utile lorsque les sources de données (nombre d'événements utilisateur, historique de recherche et couverture des sujets des documents) sont limitées. Toutefois, l'activation des suggestions de correspondance de fin peut réduire la qualité globale des suggestions. Étant donné que la correspondance de fin ne correspond qu'au dernier mot du préfixe, certaines suggestions renvoyées peuvent ne pas avoir de sens. Par exemple, une requête telle que "chansons avec he" peut recevoir une suggestion de correspondance de fin telle que "chansons avec guides d'aides".

Les suggestions de correspondance de fin ne sont renvoyées que si:

1. include_tail_suggestions est défini sur true dans la requête dataStores.completeQuery.

2. Aucune suggestion de correspondance exacte de préfixe n'est disponible pour la requête.

Activer ou désactiver la saisie semi-automatique pour un widget

Pour activer ou désactiver la saisie semi-automatique pour un widget, procédez comme suit:

Modifier les paramètres de saisie semi-automatique

Pour configurer les paramètres de saisie semi-automatique, procédez comme suit:

Mettre à jour les annotations de champ completable dans le schéma

Pour activer la saisie semi-automatique pour les champs du schéma de données structurées, procédez comme suit:

Envoyer des requêtes de saisie semi-automatique

Les exemples suivants montrent comment envoyer des requêtes de saisie semi-automatique.

using Google.Cloud.DiscoveryEngine.V1;

public sealed partial class GeneratedCompletionServiceClientSnippets
{
    /// <summary>Snippet for CompleteQuery</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void CompleteQueryRequestObject()
    {
        // Create client
        CompletionServiceClient completionServiceClient = CompletionServiceClient.Create();
        // Initialize request argument(s)
        CompleteQueryRequest request = new CompleteQueryRequest
        {
            DataStoreAsDataStoreName = DataStoreName.FromProjectLocationDataStore("[PROJECT]", "[LOCATION]", "[DATA_STORE]"),
            Query = "",
            QueryModel = "",
            UserPseudoId = "",
            IncludeTailSuggestions = false,
        };
        // Make the request
        CompleteQueryResponse response = completionServiceClient.CompleteQuery(request);
    }
}

package main

import (
	"context"

	discoveryengine "cloud.google.com/go/discoveryengine/apiv1"
	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := discoveryengine.NewCompletionClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &discoveryenginepb.CompleteQueryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb#CompleteQueryRequest.
	}
	resp, err := c.CompleteQuery(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

import com.google.cloud.discoveryengine.v1.CompleteQueryRequest;
import com.google.cloud.discoveryengine.v1.CompleteQueryResponse;
import com.google.cloud.discoveryengine.v1.CompletionServiceClient;
import com.google.cloud.discoveryengine.v1.DataStoreName;

public class SyncCompleteQuery {

  public static void main(String[] args) throws Exception {
    syncCompleteQuery();
  }

  public static void syncCompleteQuery() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
      CompleteQueryRequest request =
          CompleteQueryRequest.newBuilder()
              .setDataStore(
                  DataStoreName.ofProjectLocationDataStoreName(
                          "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                      .toString())
              .setQuery("query107944136")
              .setQueryModel("queryModel-184930495")
              .setUserPseudoId("userPseudoId-1155274652")
              .setIncludeTailSuggestions(true)
              .build();
      CompleteQueryResponse response = completionServiceClient.completeQuery(request);
    }
  }
}

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent data store resource name for which the completion is
 *  performed, such as
 *  `projects/* /locations/global/collections/default_collection/dataStores/default_data_store`.
 */
// const dataStore = 'abc123'
/**
 *  Required. The typeahead input used to fetch suggestions. Maximum length is
 *  128 characters.
 */
// const query = 'abc123'
/**
 *  Specifies the autocomplete data model. This overrides any model specified
 *  in the Configuration > Autocomplete section of the Cloud console. Currently
 *  supported values:
 *  * `document` - Using suggestions generated from user-imported documents.
 *  * `search-history` - Using suggestions generated from the past history of
 *  SearchService.Search google.cloud.discoveryengine.v1.SearchService.Search 
 *  API calls. Do not use it when there is no traffic for Search API.
 *  * `user-event` - Using suggestions generated from user-imported search
 *  events.
 *  * `document-completable` - Using suggestions taken directly from
 *  user-imported document fields marked as completable.
 *  Default values:
 *  * `document` is the default model for regular dataStores.
 *  * `search-history` is the default model for site search dataStores.
 */
// const queryModel = 'abc123'
/**
 *  A unique identifier for tracking visitors. For example, this could be
 *  implemented with an HTTP cookie, which should be able to uniquely identify
 *  a visitor on a single device. This unique identifier should not change if
 *  the visitor logs in or out of the website.
 *  This field should NOT have a fixed value such as `unknown_visitor`.
 *  This should be the same identifier as
 *  UserEvent.user_pseudo_id google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id 
 *  and
 *  SearchRequest.user_pseudo_id google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id.
 *  The field must be a UTF-8 encoded string with a length limit of 128
 *  characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 */
// const userPseudoId = 'abc123'
/**
 *  Indicates if tail suggestions should be returned if there are no
 *  suggestions that match the full query. Even if set to true, if there are
 *  suggestions that match the full query, those are returned and no
 *  tail suggestions are returned.
 */
// const includeTailSuggestions = true

// Imports the Discoveryengine library
const {CompletionServiceClient} = require('@google-cloud/discoveryengine').v1;

// Instantiates a client
const discoveryengineClient = new CompletionServiceClient();

async function callCompleteQuery() {
  // Construct request
  const request = {
    dataStore,
    query,
  };

  // Run request
  const response = await discoveryengineClient.completeQuery(request);
  console.log(response);
}

callCompleteQuery();

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1


def sample_complete_query():
    # Create a client
    client = discoveryengine_v1.CompletionServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.CompleteQueryRequest(
        data_store="data_store_value",
        query="query_value",
    )

    # Make the request
    response = client.complete_query(request=request)

    # Handle the response
    print(response)

require "google/cloud/discovery_engine/v1"

##
# Snippet for the complete_query call in the CompletionService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#complete_query.
#
def complete_query
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1::CompletionService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest.new

  # Call the complete_query method.
  result = client.complete_query request

  # The returned object is of type Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse.
  p result
end

Utiliser une liste de blocage pour la saisie semi-automatique

Vous pouvez utiliser une liste de blocage pour empêcher des termes spécifiques d'apparaître sous forme de suggestions de saisie automatique.

Prenons l'exemple d'une entreprise pharmaceutique. Si un médicament n'est plus approuvé par la FDA, mais qu'il est mentionné dans des documents de son data store, il peut souhaiter empêcher ce médicament d'apparaître en tant que requête suggérée. L'entreprise peut ajouter le nom de ce médicament à une liste de blocage pour éviter qu'il ne soit suggéré.

Les limites suivantes s'appliquent :

• Une liste de blocage par data store
• L'importation d'une liste de blocage écrase toute liste de blocage existante pour ce data store.
• Jusqu'à 1 000 termes par liste de blocage
• Les termes ne sont pas sensibles à la casse.
• Une fois qu'une liste de blocage a été importée, elle prend effet dans un délai de 1 à 2 jours.

Chaque entrée de votre liste de blocage se compose d'un blockPhrase et d'un matchOperator:

• blockPhrase: saisissez une chaîne comme terme de la liste de blocage. Les termes ne sont pas sensibles à la casse.
• matchOperator: accepte les valeurs suivantes :
  • EXACT_MATCH: empêche une correspondance exacte du terme de la liste de blocage d'apparaître en tant que requête suggérée.
  • CONTAINS: empêche l'affichage de toute suggestion contenant le terme de la liste de blocage.

Voici un exemple de liste de blocage avec quatre entrées:

{
    "entries": [
        {"blockPhrase":"Oranges","matchOperator":"CONTAINS"},
        {"blockPhrase":"bAd apples","matchOperator":"EXACT_MATCH"},
        {"blockPhrase":"Cool as A Cucumber","matchOperator":"EXACT_MATCH"},
        {"blockPhrase":"cherry pick","matchOperator":"CONTAINS"}
    ]
}

Avant d'importer une liste de blocage, vérifiez que les contrôles d'accès nécessaires sont définis pour l'accès des éditeurs du moteur de découverte.

Les listes de blocage peuvent être importées à partir de données JSON locales ou de Cloud Storage. Pour supprimer une liste de blocage d'un data store, purgez-la.

Importer une liste de blocage à partir de données JSON locales

Pour importer une liste de blocage à partir d'un fichier JSON local contenant votre liste de blocage, procédez comme suit:

1. Créez votre liste de blocage dans un fichier JSON local au format suivant. Assurez-vous que chaque entrée de la liste de blocage se trouve sur une nouvelle ligne, sans saut de ligne.

   {
       "inlineSource": {
           "entries": [
               { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" },
               { "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }
           ]
       }
   }

2. Envoyez une requête POST à la méthode suggestionDenyListEntries:import, en indiquant le nom de votre fichier JSON.

   curl -X POST \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       -H "Content-Type: application/json; charset=utf-8" \
       --data @DENYLIST_FILE \
     "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"
   

   • DENYLIST_FILE: chemin d'accès local du fichier JSON contenant les termes de la liste de blocage.
   • PROJECT_ID: numéro ou ID de votre projet Google Cloud.
   • DATA_STORE_ID: ID du data store associé à votre application.

Une fois votre liste de blocage importée, il faut compter un à deux jours pour commencer à filtrer les suggestions.

Importer une liste de blocage depuis Cloud Storage

Pour importer une liste de blocage à partir d'un fichier JSON dans Cloud Storage, procédez comme suit:

1. Créez votre liste de blocage dans un fichier JSON au format suivant, puis importez-le dans un bucket Cloud Storage. Assurez-vous que chaque entrée de la liste de blocage figure sur une nouvelle ligne, sans saut de ligne.

   { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" }
   { "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }

2. Créez un fichier JSON local contenant l'objet gcsSource. Utilisez-le pour pointer vers l'emplacement de votre fichier de liste de blocage dans un bucket Cloud Storage.

   {
       "gcsSource": {
           "inputUris": [ "DENYLIST_STORAGE_LOCATION" ]
       }
   }

   • DENYLIST_STORAGE_LOCATION: emplacement de votre liste de blocage dans Cloud Storage. Vous ne pouvez saisir qu'un seul URI. L'URI doit être saisi au format suivant : gs://BUCKET/FILE_PATH.

3. Envoyez une requête POST à la méthode suggestionDenyListEntries:import, y compris l'objet gcsSource.

   curl -X POST \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       -H "Content-Type: application/json; charset=utf-8" \
       --data @GCS_SOURCE_FILE \
      "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"
   

   • GCS_SOURCE_FILE: chemin d'accès local du fichier contenant l'objet gcsSource qui pointe vers votre liste de blocage.
   • PROJECT_ID: numéro ou ID de votre projet Google Cloud.
   • DATA_STORE_ID: ID du data store associé à votre application.

Une fois votre liste de blocage importée, il faut compter un à deux jours pour commencer à filtrer les suggestions.

Supprimer définitivement une liste de blocage

Pour supprimer une liste de blocage de votre data store, procédez comme suit:

1. Envoyez une requête POST à la méthode suggestionDenyListEntries:purge.

   curl -X POST \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
      "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:purge"
   

   • PROJECT_ID: numéro ou ID de votre projet Google Cloud.
   • DATA_STORE_ID: ID du data store associé à votre application.

Modèle de données de document avancé

Vertex AI Agent Builder fournit un modèle de données avancé pour la saisie semi-automatique. Sur la base des documents que vous importez, ce modèle de données génère des suggestions de saisie semi-automatique de haute qualité en exploitant les grands modèles de langage (LLM) de Google.

Cette fonctionnalité n'est pas disponible actuellement. Si vous souhaitez utiliser cette fonctionnalité, contactez l'équipe chargée de votre compte Google Cloud et demandez à être ajouté à la liste d'autorisation.

Cette fonctionnalité n'est pas disponible pour la recherche dans le secteur de la santé ni dans les ensembles multirégionaux des États-Unis et de l'UE.