Configurare il completamento automatico

Questa pagina descrive la funzionalità di completamento automatico di base di Vertex AI Search. Il completamento automatico genera suggerimenti per le query in base ai primi caratteri inseriti per la query.

I suggerimenti generati dal completamento automatico variano a seconda del tipo di dati utilizzati dall'app di ricerca:

• Dati strutturati e non strutturati. Per impostazione predefinita, il completamento automatico genera suggerimenti in base ai contenuti dei documenti nel datastore. Dopo l'importazione dei documenti, per impostazione predefinita, il completamento automatico non inizia a generare suggerimenti finché non sono disponibili dati di qualità sufficiente, in genere un paio di giorni. Se invii richieste di completamento automatico tramite l'API, il completamento automatico può generare suggerimenti basati sulla cronologia delle ricerche o sugli eventi utente.

• Dati dei siti web. Per impostazione predefinita, il completamento automatico genera suggerimenti dalla cronologia delle ricerche. Il completamento automatico richiede traffico di ricerca reale. Dopo che è iniziato il traffico di ricerca, il completamento automatico impiega uno o due giorni prima di generare suggerimenti. I suggerimenti possono essere generati dai dati sottoposti a scansione del web provenienti da siti pubblici con il modello di dati dei documenti avanzati sperimentale.

• Dati sanitari. Per impostazione predefinita, viene utilizzata un'origine dati medica canonica per generare suggerimenti di completamento automatico per gli archivi dei dati sanitari.

Il modello di suggerimenti per le query determina il tipo di dati utilizzati dal completamento automatico per generare suggerimenti. Esistono quattro modelli di suggerimenti di query:

• Documenta. Il modello di documento genera suggerimenti dai documenti importati dall'utente. Questo modello non è disponibile per i dati dei siti web o per i dati sanitari.

• Campi configurabili. Il modello di campi compilabili suggerisce il testo preso direttamente dai campi di dati strutturati. Solo i campi annotati con completable vengono utilizzati per i suggerimenti di completamento automatico. Questo modello è disponibile solo per i dati strutturati.

• Cronologia delle ricerche. Il modello della cronologia delle ricerche genera suggerimenti dalla cronologia delle chiamate all'API SearchService.search. Non utilizzare questo modello se non è disponibile traffico per il metodo servingConfigs.search. Questo modello non è disponibile per i dati sanitari.

• Evento utente. Il modello di eventi utente genera suggerimenti dagli eventi di tipo search importati dall'utente. Questo modello non è disponibile per i dati sanitari.

Le richieste di completamento automatico vengono inviate utilizzando il metodo dataStores.completeQuery.

In alternativa, se non vuoi utilizzare un modello di suggerimenti di query, puoi utilizzare i suggerimenti importati che forniscono suggerimenti di completamento automatico in base a un elenco di suggerimenti importato. Per saperne di più, consulta Utilizzare un elenco importato di suggerimenti di completamento automatico.

Tipi di modelli disponibili in base al tipo di dati

La tabella seguente mostra i tipi di modelli di suggerimenti di query disponibili per ogni tipo di dato.

* : lo schema del documento deve contenere campi title o description oppure devono essere presenti campi specificati come proprietà chiave title o description. Consulta Aggiornare uno schema per i dati strutturati.

^† : i contenuti sottoposti a scansione del web possono essere utilizzati come origine dati solo se è attivato il modello dei dati dei documenti avanzati sperimentale per il completamento automatico. Consulta Modello di dati dei documenti avanzati.

Se non vuoi utilizzare il modello predefinito per il tuo tipo di dati, puoi specificare un modello diverso quando invii la richiesta di completamento automatico. Le richieste di completamento automatico vengono inviate utilizzando il metodo dataStores.completeQuery. Per informazioni, consulta le istruzioni dell'API: invia una richiesta di completamento automatico per scegliere un modello diverso.

Funzionalità di completamento automatico

Vertex AI Search supporta le seguenti funzionalità di completamento automatico per mostrare le previsioni più utili durante la ricerca:

Suggerimenti per la corrispondenza finale

I suggerimenti di corrispondenza finale vengono generati utilizzando la corrispondenza esatta del prefisso con l'ultima parola di una stringa di query.

Ad esempio, supponiamo che la query "canzoni con he" venga inviata in una richiesta di completamento automatico. Quando la corrispondenza finale è attivata, il completamento automatico potrebbe rilevare che il prefisso completo "canzoni con he" non ha corrispondenze. Tuttavia, l'ultima parola della query, "lui", ha una corrispondenza esatta del prefisso con "ciao mondo" e "ciao kitty". In questo caso, i suggerimenti restituiti sono "canzoni con hello world" e "canzoni con hello kitty" perché non sono disponibili suggerimenti con corrispondenza completa.

Puoi utilizzare questa funzionalità per ridurre i risultati vuoti dei suggerimenti e aumentare la loro diversità, il che è particolarmente utile nei casi in cui le origini dati (conteggio degli eventi utente, cronologia della ricerca e copertura degli argomenti dei documenti) sono limitate. Tuttavia, l'attivazione dei suggerimenti di corrispondenza finale può ridurre la qualità complessiva dei suggerimenti. Poiché la corrispondenza finale corrisponde solo alla parola finale del prefisso, alcuni suggerimenti restituiti potrebbero non avere senso. Ad esempio, una query come "canzoni con he" potrebbe ricevere un suggerimento di corrispondenza finale come "canzoni con guide per gli aiutanti".

I suggerimenti di corrispondenza finale vengono restituiti solo se:

1. include_tail_suggestions è impostato su true nella richiesta dataStores.completeQuery.

2. Non ci sono suggerimenti per la corrispondenza completa del prefisso per la query.

Proteggere da fughe di PII

La definizione di PII è ampia e le PII possono essere difficili da rilevare. Di conseguenza, Vertex AI Search non può garantire che le PII non vengano restituite nei suggerimenti di completamento automatico.

Vertex AI Search applica il servizio di ispezione Sensitive Data Protection per cercare e bloccare la visualizzazione di tipi comuni di PII come suggerimenti. Tuttavia, se i tuoi data store contengono PII o se utilizzi la cronologia delle ricerche o i modelli di suggerimenti di query sugli eventi utente, esamina quanto segue e intervieni di conseguenza:

1. Se i tipi di PII che vuoi proteggere sono abbastanza standard, come numeri di telefono e indirizzi email, inizia testando a fondo i suggerimenti di completamento automatico per la tua app. Vertex AI Search non può garantire che le PII non vengano restituite nei suggerimenti di completamento automatico.

2. Se vengono rilevate fughe di PII durante i test di completamento automatico o se sai già di dover proteggere PII non standard (ad esempio ID utente proprietari), prova a modificare la soglia di completamento automatico e i parametri di pubblicazione dei contenuti. Per ulteriori informazioni, consulta Ridurre il rischio di restituire suggerimenti che contengono PII.

3. Se la modifica dei parametri non è sufficiente per impedire la fuga di PII, implementa la tua soluzione DLP. Personalizza la soluzione DLP in base ai tipi di PII più probabili di essere trovati nei tuoi data store, negli eventi utente o nelle query di ricerca degli utenti. Puoi utilizzare Sensitive Data Protection o un servizio DLP di terze parti. Scegli uno dei metodi seguenti:

   • Filtra le PII prima di importare i documenti e gli eventi utente nei tuoi datastore.

   • Esamina i suggerimenti di completamento automatico prima di presentarli all'utente al momento della pubblicazione e blocca quelli che contengono PII.

4. Se utilizzi il modello della cronologia delle ricerche o degli eventi utente, aggiungi un testo informativo nella barra di ricerca per indicare agli utenti di non inserire PII nelle query di ricerca.

5. Se hai domande o riscontri difficoltà particolari con il blocco delle PII, contatta il tuo Customer Engineer (CE) o il team degli Account Google.

Attivare o disattivare il completamento automatico per un widget

Per attivare o disattivare il completamento automatico per un widget:

Aggiornare le impostazioni di completamento automatico

Per configurare le impostazioni di completamento automatico nell'interfaccia utente:

Ridurre il rischio di restituire suggerimenti che contengono PII

Gli utenti finali dispongono di tutti i tipi di informazioni che consentono l&#PII;identificazione personale, come patenti di guida e numeri di telefono, che dovrebbero mantenere private. Tuttavia, qualsiasi informazione PII potrebbe essere digitata nella barra di ricerca dagli utenti che cercano risultati specifici per loro.

Se utilizzi il modello di cronologia delle ricerche o degli eventi utente e c'è la possibilità che i tuoi utenti digitino PII nella barra di ricerca, puoi ridurre le fughe di PII modificando i seguenti parametri:

• queryFrequencyThreshold: prima che una query possa essere restituita come suggerimento di completamento automatico, deve essere stata inserita questo numero di volte.

• numUniqueUsersThreshold: prima che una query possa essere restituita come suggerimento di completamento automatico, deve essere stata inserita da questo numero di utenti unici. Il valore del campo userPseudoId nell'evento utente di ricerca determina se l'utente è univoco.

Esempio di caso d'uso

Ad esempio, prendi in considerazione un caso in cui gli utenti hanno numeri di conto che devono essere conservati privati.

Se è in uso il modello di suggerimento per la cronologia delle ricerche o per gli eventi utente, questi numeri di account, insieme a tutti gli altri termini cercati dagli utenti finali, vengono utilizzati per generare suggerimenti. Pertanto, se il numero di conto dell'utente A (YZ-46789A) è stato inserito ripetutamente nella barra di ricerca e l'utente B ha un numero di conto (YZ-42345B), quando l'utente B digita YZ-4 nella barra di ricerca, il suggerimento di completamento automatico restituito potrebbe essere il numero di conto dell'utente A.

Per ridurre la probabilità che si verifichi questo tipo di fuga di dati, l'amministratore delle applicazioni di IA decide di:

• Aumenta il valore del parametro queryFrequencyThreshold a 30. In questo caso, è molto improbabile che un numero di conto venga inserito così spesso. Tuttavia, le query di ricerca più frequenti verranno inserite almeno con questa frequenza.

• Aumenta il valore del parametro numUniqueUsersThreshold a 6. L'amministratore ritiene improbabile che lo stesso numero di account venga inserito nella barra di ricerca in sei eventi di ricerca ciascuno associato a un userPseudoId diverso.

Procedura

Esistono due parametri di soglia per il completamento automatico. Questi parametri non sono disponibili nella Google Cloud console, ma possono essere impostati con una chiamata all'API REST al metodo updateCompletionConfig.

Per configurare le impostazioni di soglia del completamento automatico, segui questi passaggi. Ogni passaggio è facoltativo, a seconda del parametro che vuoi modificare.

Aggiorna le annotazioni dei campi completabili nello schema

Per attivare il completamento automatico per i campi nello schema dei dati strutturati:

Inviare richieste di completamento automatico

Gli esempi riportati di seguito mostrano come inviare richieste di completamento automatico.

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

Utilizzare una lista bloccata per il completamento automatico

Puoi utilizzare una lista bloccata per evitare che termini specifici appaiano come suggerimenti di completamento automatico.

Prendiamo ad esempio un'azienda farmaceutica. Se un farmaco non è più approvato dalla FDA, ma è menzionato nei documenti nel proprio datastore, l'utente potrebbe voler impedire che venga visualizzato come query suggerita. L'azienda potrebbe aggiungere il nome del farmaco a una lista negativa per impedirne la proposta.

I limiti sono i seguenti:

• Una lista bloccata per datastore
• Il caricamento di una lista bloccata sovrascrive qualsiasi lista bloccata esistente per quel datastore
• Fino a 1000 termini per lista negativa
• I termini non fanno distinzione tra maiuscole e minuscole
• Dopo aver importato una lista di blocco, sono necessari 1-2 giorni prima che venga applicata

Ogni voce della lista negativa è composta da blockPhrase e matchOperator:

• blockPhrase: inserisci una stringa come termine della lista bloccata. I termini non fanno distinzione tra maiuscole e minuscole.
• matchOperator: accetta i seguenti valori:
  • EXACT_MATCH: impedisce che una corrispondenza esatta del termine della lista bloccata venga visualizzata come query suggerita.
  • CONTAINS: impedisce la visualizzazione di qualsiasi suggerimento contenente il termine della lista bloccata.

Di seguito è riportato un esempio di lista negativa con quattro voci:

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

Prima di importare una lista negativa, verifica che i controlli di accesso necessari siano impostati per l'accesso degli editor del motore di ricerca.

Le liste di blocco possono essere importate da dati JSON locali o da Cloud Storage. Per rimuovere una lista negativa da un datastore, eliminala.

Importa una lista bloccata dai dati JSON locali

Per importare una lista negativa da un file JSON locale contenente la lista negativa, procedi nel seguente modo:

1. Crea la lista di esclusione in un file JSON locale con il seguente formato. Assicurati che ogni voce della lista di blocco sia in una nuova riga senza interruzioni di riga.

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

2. Effettua una richiesta POST al metodo suggestionDenyListEntries:import specificando il nome del file 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"
   

   Sostituisci quanto segue:

   • DENYLIST_FILE: il percorso locale del file JSON contenente i termini della lista negativa.

   • PROJECT_ID: il numero o l'ID del tuo Google Cloud progetto.

   • DATA_STORE_ID: l'ID del datastore associato alla tua app.

Dopo aver importato la lista negativa, sono necessari 1-2 giorni per iniziare a filtrare i suggerimenti.

Importa una lista bloccata da Cloud Storage

Per importare una lista negativa da un file JSON in Cloud Storage, segui questi passaggi:

1. Crea la lista di esclusione in un file JSON con il seguente formato e importalo in un bucket Cloud Storage. Assicurati che ogni voce della lista negativa sia in una nuova riga senza interruzioni di riga.

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

2. Crea un file JSON locale contenente l'oggetto gcsSource. Utilizzalo per indicare la posizione del file della lista negativa in un bucket Cloud Storage.

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

   Sostituisci DENYLIST_STORAGE_LOCATION con la posizione della lista negativa in Cloud Storage. Puoi inserire un solo URI. L'URI deve essere inserito nel seguente formato: gs://BUCKET/FILE_PATH.

3. Esegui una richiesta POST al metodo suggestionDenyListEntries:import, incluso l'oggetto 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"
   

   Sostituisci quanto segue:

   • GCS_SOURCE_FILE: il percorso locale del file contenente l'oggetto gcsSource che rimanda alla lista bloccata.

   • PROJECT_ID: il numero o l'ID del tuo Google Cloud progetto.

   • DATA_STORE_ID: l'ID del datastore associato alla tua app.

Dopo aver importato la lista negativa, sono necessari 1-2 giorni per iniziare a filtrare i suggerimenti.

Eliminare definitivamente una lista bloccata

Per eliminare una lista negativa dal tuo datastore:

1. Esegui una richiesta POST al metodo 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"
   

   Sostituisci quanto segue:

   • PROJECT_ID: il numero o l'ID del tuo Google Cloud progetto.

   • DATA_STORE_ID: l'ID del datastore associato alla tua app.

Utilizzare un elenco di suggerimenti di completamento automatico importato

Puoi scegliere di fornire il tuo elenco di suggerimenti di completamento automatico anziché utilizzare quelli generati da un modello dei dati di completamento automatico.

Per la maggior parte delle applicazioni, l'utilizzo dei suggerimenti generati da uno dei modelli di dati di completamento automatico consente di ottenere risultati migliori. Tuttavia, in alcune rare situazioni i suggerimenti del modello potrebbero non soddisfare le tue esigenze e fornire un elenco discreto di suggerimenti offre agli utenti un'esperienza di completamento automatico migliore.

Ad esempio, una piccola libreria online importa il proprio elenco di titoli di libri come suggerimenti di completamento automatico. Quando un cliente inizia a digitare nella barra di ricerca, il suggerimento di completamento automatico sarà sempre il titolo di un libro dell'elenco importato. Quando l'elenco dei libri cambia, la libreria elimina l'elenco corrente e importa il nuovo elenco. Un estratto dall'elenco potrebbe avere il seguente aspetto:

{"suggestion": "Wuthering Heights", "globalScore": "0.52" },
{"suggestion": "The Time Machine", "globalScore": "0.26" },
{"suggestion": "Nicholas Nickleby", "globalScore": "0.38" },
{"suggestion": "A Little Princess", "globalScore": "0.71" },
{"suggestion": "The Scarlet Letter", "globalScore": "0.32" }

globalScore è un numero con rappresentazione in virgola mobile compreso nell'intervallo [0, 1] che viene utilizzato per assegnare un ranking al suggerimento. In alternativa, puoi utilizzare un punteggio frequency che sia un numero intero maggiore di uno. Il punteggio frequency viene utilizzato per classificare i suggerimenti quando globalScore non è disponibile (impostato su null).

Configurare e importare i suggerimenti di completamento automatico

Per configurare e importare un elenco di suggerimenti di completamento automatico da un BigQuery:

1. Crea l'elenco di suggerimenti e caricalo in una tabella BigQuery.

   Come minimo, devi fornire ogni suggerimento come stringa e un voto globale o una frequenza.

   Utilizza lo schema di tabella seguente per l'elenco di suggerimenti:

   [
     {
       "description": "The suggestion text",
       "mode": "REQUIRED",
       "name": "suggestion",
       "type": "STRING"
     },
     {
       "description": "Global score of this suggestion. Control how this suggestion would be scored and ranked. Set global score or frequency; not both.",
       "mode": "NULLABLE",
       "name": "globalScore",
       "type": "FLOAT"
     },
     {
       "description": "Frequency of this suggestion. Used to rank suggestions when the global score is not available.",
       "mode": "NULLABLE",
       "name": "frequency",
       "type": "INTEGER"
     }
   ]
   

   Consulta la documentazione di BigQuery per istruzioni su come creare una tabella BigQuery e caricarla con l'elenco di suggerimenti di completamento automatico.

2. Importa l'elenco da BigQuery.

   Esegui una richiesta POST al metodo completionSuggestions:import, includendo l'oggetto bigquerySource.

   curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -H "X-Goog-User-Project: PROJECT_ID" \
    "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/completionSuggestions:import" \
    -d '{
         "bigquery_source": {"project_id": "PROJECT_ID_SOURCE", "dataset_id": "DATASET_ID", "table_id": "TABLE_ID"}
    }'
   

   Sostituisci quanto segue:

   • PROJECT_ID: il numero o l'ID del tuo Google Cloud progetto.
   • DATA_STORE_ID: l'ID dello datastore di Vertex AI Search.
   • PROJECT_ID_SOURCE: il progetto che contiene il set di dati da importare.
   • DATASET_ID: l'ID set di dati per l'elenco di suggerimenti che vuoi importare
   • TABLE_ID: l'ID tabella per l'elenco di suggerimenti che vuoi importare

   Comando e risultato di esempio

   curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -H "X-Goog-User-Project: my-project-123" \
    "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/dataStores/my-data-store/completionSuggestions:import" \
    -d '{
   "bigquery_source": {"project_id": "my-project-123", "dataset_id": "autocomplete", "table_id": "import_suggestion2"}
   }'
       
   
   {
     "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/operations/import-completion-suggestion-7659310803143180509",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.ImportCompletionSuggestionsMetadata"
     }
   }
   

3. (Facoltativo) Prendi nota del valore name restituito e segui le istruzioni riportate in Ottenere i dettagli di un'operazione di lunga durata per sapere quando l'operazione di importazione è completata.

4. Se non hai attivato il completamento automatico per l'app, segui la procedura Aggiornare le impostazioni di completamento automatico. Assicurati di impostare Attiva completamento automatico su Ora.

5. Attendi un paio di giorni per il completamento dell'indicizzazione e la disponibilità dei suggerimenti importati.

Inviare una richiesta di completamento automatico

Per inviare una richiesta di completamento automatico che restituisce un suggerimento importato anziché un suggerimento di un modello di completamento automatico:

1. Segui la procedura per inviare una richiesta di completamento automatico a un altro modello e imposta AUTOCOMPLETE_MODEL su imported-suggestion.

   Comando e risultato di esempio

   curl -X GET \
       -H "Authorization: Bearer $(gcloud auth print-access-token)" \
       -H "X-Goog-User-Project: my-project-123" \
       "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/dataStores/my-data-store:completeQuery?query=t&query_model=imported-suggestion"
       
   
   Response:
   {
     "querySuggestions": [
       {
         "suggestion": "The Time Machine"
       },
       {
         "suggestion": "The Scarlet Letter"
       }
     ]
   }
   

Svuotare l'elenco dei suggerimenti di completamento automatico importati

Prima di importare un nuovo elenco di suggerimenti di completamento automatico, rimuovi quello esistente.

Per eliminare un elenco esistente di suggerimenti di completamento automatico:

1. Esegui una richiesta POST al metodo completionSuggestions: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/completionSuggestions:purge"
   

   Sostituisci quanto segue:

   • PROJECT_ID: il numero o l'ID del tuo Google Cloud progetto.

   • DATA_STORE_ID: l'ID del datastore associato alla tua app.

   Comando e risultato di esempio

   curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -H "X-Goog-User-Project: my-project-123" \
    "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/dataStores/my-data-store/completionSuggestions:purge"
       
   
   {
     "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/operations/purge-customer-imported_suggestions-3197526711414652502",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.PurgeCompletionSuggestionsMetadata",
       "createTime": "2024-06-27T17:07:09.551726728Z",
       "updateTime": "2024-06-27T17:07:09.551726728Z"
     },
     "done": true,
     "response": {
       "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.PurgeCompletionSuggestionsResponse",
       "purgeSucceeded": true
     }
   }
   

Modello dei dati dei documenti avanzato

Le applicazioni di IA forniscono un modello dei dati avanzato per il completamento automatico. In base ai documenti che importi, questo modello dei dati genera suggerimenti di completamento automatico di alta qualità sfruttando i modelli linguistici di grandi dimensioni (LLM) di Google.

Questa funzionalità è sperimentale. Se ti interessa utilizzare questa funzionalità, contatta il tuo Google Cloud team dedicato all'account e chiedi di essere aggiunto alla lista consentita.

Il modello dei dati dei documenti avanzati non è disponibile per la ricerca sanitaria o nelle regioni multiple degli Stati Uniti e dell'UE.