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

Completes the user input with advanced keyword suggestions.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
completionConfig

string

Required. The completionConfig of the parent dataStore or engine resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Request body

The request body contains data with the following structure:

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

string

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

The query can not be empty for most of the suggestion types. If it is empty, an INVALID_ARGUMENT error is returned. The exception is when the suggestionTypes contains only the type RECENT_SEARCH, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.
queryModel

string

Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. 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 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
userInfo

object (UserInfo)

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
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.
boostSpec

object (BoostSpec)

Optional. Specification to boost suggestions matching the condition.
suggestionTypes[]

enum (SuggestionType)

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

Optional. Specification of each suggestion type.
experimentIds[]

string

Optional. experiment ids for this request.

Response body

If successful, the response body contains an instance of AdvancedCompleteQueryResponse.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the completionConfig resource:

  • discoveryengine.completionConfigs.completeQuery

For more information, see the IAM documentation.