Class SearchResponse

Response message for SearchService.Search method.

Attributes
NameDescription
Sequence[google.cloud.retail_v2.types.SearchResponse.SearchResult]results
A list of matched items. The order represents the ranking.
Sequence[google.cloud.retail_v2.types.SearchResponse.Facet]facets
Results of facets requested by user.
inttotal_size
The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
strcorrected_query
If spell correction applies, the corrected query. Otherwise, empty.
strattribution_token
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
strnext_page_token
A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
google.cloud.retail_v2.types.SearchResponse.QueryExpansionInfoquery_expansion_info
Query expansion information for the returned results.
strredirect_uri
The URI of a customer-defined redirect page. If redirect action is triggered, no search will be performed, and only redirect_uri and attribution_token will be set in the response.

Inheritance

builtins.object > proto.message.Message > SearchResponse

Classes

Facet

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

A facet result.

QueryExpansionInfo

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

Information describing query expansion including whether expansion has occurred.

SearchResult

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

Represents the search results.

Properties

raw_page

API documentation for retail_v2.types.SearchResponse.raw_page property.