Completes the user input with advanced keyword suggestions.
HTTP request
POST https://discoveryengine.googleapis.com/v1alpha/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
completion |
Required. The completionConfig of the parent dataStore or engine resource name for which the completion is performed, such as |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "query": string, "queryModel": string, "userPseudoId": string, "userInfo": { object ( |
Fields | |
---|---|
query |
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 |
query |
Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values:
Default values:
|
user |
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 This should be the same identifier as The field must be a UTF-8 encoded string with a length limit of 128 |
user |
Optional. Information about the end user. This should be the same identifier information as |
include |
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. |
boost |
Optional. Specification to boost suggestions matching the condition. |
suggestion |
Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. |
Response body
If successful, the response body contains an instance of AdvancedCompleteQueryResponse
.
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 completionConfig
resource:
discoveryengine.completionConfigs.completeQuery
For more information, see the IAM documentation.