This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.

Changes in GA:

Name: Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
All changes: To see what else changed between preview and GA, see Switch from Discovery for Media to media recommendations in the Vertex AI Search documentation.

Method: projects.locations.collections.dataStores.completeQuery

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
IAM Permissions
Try it!

Completes the specified user input with keyword suggestions.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}:completeQuery

The URL uses gRPC Transcoding syntax.

Path parameters

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

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

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.