Method: projects.locations.collections.dataStores.completionConfig.completeQuery

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

Richiesta HTTP

POST https://discoveryengine.googleapis.com/v1beta/{completionConfig=projects/*/locations/*/collections/*/dataStores/*/completionConfig}:completeQuery

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
completionConfig

string

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

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
Campi
query

string

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

La query non può essere vuota per la maggior parte dei tipi di suggerimenti. Se è vuoto, viene restituito un errore INVALID_ARGUMENT. L'eccezione si verifica quando suggestionTypes contiene solo il tipo RECENT_SEARCH, la query può essere una stringa vuota. Questa funzionalità è chiamata "prefisso zero" e restituisce le query di ricerca recenti dell'utente data la query vuota.
queryModel

string

Specifica il modello di query di completamento automatico, che si applica solo a SuggestionType QUERY. 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
userInfo

object (UserInfo)

Facoltativo. Informazioni sull'utente finale.

Queste informazioni sull'identificatore devono essere le stesse di UserEvent.user_info e SearchRequest.user_info.
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.
boostSpec

object (BoostSpec)

Facoltativo. Specifica per aumentare i suggerimenti che corrispondono alla condizione.
suggestionTypes[]

enum (SuggestionType)

Facoltativo. Tipi di suggerimenti da restituire. Se vuoto o non specificato, vengono restituiti i suggerimenti per le query. Al momento è supportato un solo tipo di suggerimento.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

Facoltativo. Specifica di ogni tipo di suggerimento.
experimentIds[]

string

Facoltativo. ID esperimento per questa richiesta.

Corpo della risposta

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

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/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa completionConfig:

  • discoveryengine.completionConfigs.completeQuery

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