Method: locations.widgetCompleteQuery

Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It supports CompleteQuery with or without JWT token.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{location=locations/*}/widgetCompleteQuery

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
location

string

Required. The location resource where widget complete query will be performed. Format: locations/{location}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "configId": string,
  "completeQueryRequest": {
    object (CompleteQueryRequest)
  },
  "additionalParams": {
    object (AdditionalParams)
  }
}
Fields
configId

string

Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query.
completeQueryRequest

object (CompleteQueryRequest)

Required. The CompleteQuery request to perform auto-complete suggestion query.
additionalParams

object (AdditionalParams)

Additional params for security and privacy enhancement.

Response body

Response message for WidgetService.WidgetCompleteQuery method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "uToken": string,
  "widgetQuerySuggestions": [
    {
      object (WidgetQuerySuggestion)
    }
  ]
}
Fields
uToken

string

The token in response.
widgetQuerySuggestions[]

object (WidgetQuerySuggestion)

Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CompleteQueryRequest

Request message for CompletionService.CompleteQuery method.

JSON representation 
{
  "dataStore": string,
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "includeTailSuggestions": boolean
}
Fields
dataStore

string

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.
query

string

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
queryModel

string

Selects data model of query suggestions for serving. Currently supported values:

  • document - Using suggestions generated from user-imported documents.
  • search-history - Using suggestions generated from the past history of 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.
userPseudoId

string

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 and 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.
includeTailSuggestions

boolean

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.

WidgetQuerySuggestion

Suggestions as search queries.

JSON representation 
{
  "suggestion": string
}
Fields
suggestion

string

The suggestion for the query.