CompleteQueryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Response of the autocomplete query.
Attributes |
|
---|---|
Name | Description |
completion_results |
MutableSequence[google.cloud.retail_v2.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 |
MutableSequence[google.cloud.retail_v2.types.CompleteQueryResponse.RecentSearchResult]
Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. 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 case. - They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens. |
attribute_results |
MutableMapping[str, google.cloud.retail_v2.types.CompleteQueryResponse.AttributeResult]
A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys: - brands
- categories
|
Classes
AttributeResult
AttributeResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Resource that represents attribute results. The list of suggestions for the attribute.
AttributeResultsEntry
AttributeResultsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
CompletionResult
CompletionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Resource that represents completion results.
RecentSearchResult
RecentSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Deprecated: Recent search of this user.