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 parameters
Parameters
query
string
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
queryModel
string
Specifies the autocomplete data model. 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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis document details the \u003ccode\u003ecompleteQuery\u003c/code\u003e method, which is used to fetch query suggestions, within the Google Cloud Discovery Engine API.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003eGET\u003c/code\u003e request to a specific data store resource identified by the \u003ccode\u003edataStore\u003c/code\u003e path parameter.\u003c/p\u003e\n"],["\u003cp\u003eRequired query parameters include \u003ccode\u003equery\u003c/code\u003e, the user's typeahead input, and \u003ccode\u003euserPseudoId\u003c/code\u003e, a unique visitor identifier, and it includes optional parameters such as \u003ccode\u003equeryModel\u003c/code\u003e for the type of suggestions needed.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and a successful response returns a \u003ccode\u003eCompleteQueryResponse\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003ediscoveryengine.dataStores.completeQuery\u003c/code\u003e to access.\u003c/p\u003e\n"]]],[],null,[]]
