Method: projects.locations.dataStores.completeQuery
Stay organized with collections
Save and categorize content based on your preferences.
Completes the specified user input with keyword suggestions.
HTTP request
GET https://discoveryengine.googleapis.com/v1alpha/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
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 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. 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.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of CompleteQueryResponse.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the dataStore resource:
discoveryengine.dataStores.completeQuery
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["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-03-03 UTC."],[[["This endpoint facilitates query completion suggestions, accessible via a `GET` HTTP request to the specified URL: `https://discoveryengine.googleapis.com/v1alpha/{dataStore=projects/*/locations/*/dataStores/*}:completeQuery`."],["The `dataStore` path parameter is mandatory, indicating the data store resource from which to fetch completion suggestions, using a format similar to: `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`."],["The `query` parameter, which is required, is used to input the typeahead text for which suggestions are needed, and it must not exceed 128 characters."],["The `queryModel` query parameter enables specifying the data model for generating suggestions, such as `document`, `search-history`, `user-event`, or `document-completable`, with different default values depending on the type of dataStore."],["This API endpoint requires the `discoveryengine.dataStores.completeQuery` IAM permission on the `dataStore` resource and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."]]],[]]
