Class CompleteQueryResponse (1.6.1)

CompleteQueryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Response of the auto-complete query.

Attributes

NameDescription
completion_results Sequence[google.cloud.retail_v2alpha.types.CompleteQueryResponse.CompletionResult]
Results of the matching suggestions. The result list is ordered and the first result is top suggestion.
attribution_token str
A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.
recent_search_results Sequence[google.cloud.retail_v2alpha.types.CompleteQueryResponse.RecentSearchResult]
Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in enabling it. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: - They are ordered from latest to oldest. - They are matched with CompleteQueryRequest.query case insensitively. - They are transformed to lower cases. - They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.

Inheritance

builtins.object > proto.message.Message > CompleteQueryResponse

Classes

CompletionResult

CompletionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Resource that represents completion results.

RecentSearchResult

RecentSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Recent search of this user.