Class CompleteQueryResponse (0.4.2)

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

Response of the auto-complete query. .. attribute:: completion_results

Results of the matching suggestions. The result list is ordered and the first result is top suggestion.

:type: Sequence[google.cloud.retail_v2.types.CompleteQueryResponse.CompletionResult]

Attributes

NameDescription
attribution_token str
A unique complete token. This should be included in the SearchRequest resulting from this completion, which enables accurate attribution of complete model performance.
recent_search_results Sequence[google.cloud.retail_v2.types.CompleteQueryResponse.RecentSearchResult]
Matched recent searches of this user. This field is a restricted feature. Contact Retail Support (retail-search-support@google.com) 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.

Classes

CompletionResult

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

Resource that represents completion results. .. attribute:: suggestion

The suggestion for the query.

:type: str

RecentSearchResult

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

Recent search of this user. .. attribute:: recent_search

The recent search query.

:type: str