Method: projects.locations.dataStores.completeQuery

Completa l'input utente specificato con i suggerimenti per le parole chiave.

Richiesta HTTP

GET https://discoveryengine.googleapis.com/v1/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
dataStore

string

Obbligatorio. Il nome della risorsa del datastore padre per cui viene eseguito il completamento, ad esempio projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Parametri di query

Parametri
query

string

Obbligatorio. L'input di tipo ahead utilizzato per recuperare i suggerimenti. La lunghezza massima è di 128 caratteri.
queryModel

string

Specifica il modello dei dati di completamento automatico. Questa impostazione sostituisce qualsiasi modello specificato nella sezione Configurazione > Completamento automatico della console Cloud. Valori attualmente supportati:

  • document: utilizzo dei suggerimenti generati dai documenti importati dagli utenti.
  • search-history: utilizzo di suggerimenti generati dalla cronologia passata delle chiamate API SearchService.Search. Non utilizzarlo quando non c'è traffico per l'API Search.
  • user-event: utilizzo dei suggerimenti generati dagli eventi di ricerca importati dagli utenti.
  • document-completable: utilizza i suggerimenti presi direttamente dai campi dei documenti importati dagli utenti contrassegnati come completabili.

Valori predefiniti:

  • document è il modello predefinito per i normali datastore.
  • search-history è il modello predefinito per gli archivi dati della ricerca sui siti.
userPseudoId

string

Un identificatore univoco per il monitoraggio dei visitatori. Ad esempio, questa operazione può essere implementata con un cookie HTTP, che dovrebbe essere in grado di identificare in modo univoco un visitatore su un singolo dispositivo. Questo identificatore univoco non deve cambiare se il visitatore accede o esce dal sito web.

Questo campo NON deve avere un valore fisso come unknown_visitor.

Deve essere lo stesso identificatore di UserEvent.user_pseudo_id e SearchRequest.user_pseudo_id.

Il campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
includeTailSuggestions

boolean

Indica se devono essere restituite le proposte di coda se non sono presenti suggerimenti che corrispondono all'intera query. Anche se impostato su true, se ci sono suggerimenti che corrispondono alla query completa, questi vengono restituiti e non vengono restituiti suggerimenti di coda.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di CompleteQueryResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa dataStore:

  • discoveryengine.dataStores.completeQuery

Per saperne di più, consulta la documentazione di IAM.