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 principale 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 completamento automatico 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 è vuota, 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 è chiamata funzionalità "prefisso zero", che 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 dall'utente.
  • search-history - Utilizzo dei suggerimenti generati dalla cronologia passata delle chiamate API SearchService.Search. Non utilizzarlo quando non è presente traffico per l'API Search.
  • user-event - Utilizzo dei suggerimenti generati dagli eventi di ricerca importati dall'utente.
  • document-completable - Utilizzo dei suggerimenti presi direttamente dai campi dei documenti importati dall'utente contrassegnati come completabili.

Valori predefiniti:

  • document è il modello predefinito per i datastore regolari.
  • search-history è il modello predefinito per i datastore di ricerca sui siti.
userPseudoId

string

Facoltativo. Un identificatore univoco per monitorare i visitatori. Ad esempio, può essere implementato con un cookie HTTP, che deve essere in grado di identificare in modo univoco un visitatore su un singolo dispositivo. Questo identificatore univoco non deve cambiare se il visitatore esegue l'accesso o la disconnessione dal sito web.

Questo campo NON deve avere un valore fisso come unknown_visitor.

Questo deve essere lo stesso identificatore di UserEvent.user_pseudo_id e SearchRequest.user_pseudo_id.

Il campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 128
userInfo

object (UserInfo)

Facoltativo. Informazioni sull'utente finale.

Queste devono essere le stesse informazioni sull'identificatore di UserEvent.user_info e SearchRequest.user_info.
includeTailSuggestions

boolean

Indica se devono essere restituiti suggerimenti di coda se non sono presenti suggerimenti che corrispondono alla query completa. Anche se impostato su true, se sono presenti 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

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

Per saperne di più, consulta la 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.