Class SearchResponse (1.7.0)

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

Response message for SearchService.Search method.

Attributes

NameDescription
results Sequence[google.cloud.retail_v2beta.types.SearchResponse.SearchResult]
A list of matched items. The order represents the ranking.
facets Sequence[google.cloud.retail_v2beta.types.SearchResponse.Facet]
Results of facets requested by user.
total_size int
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.
corrected_query str
If spell correction applies, the corrected query. Otherwise, empty.
attribution_token str
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
next_page_token str
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.
query_expansion_info google.cloud.retail_v2beta.types.SearchResponse.QueryExpansionInfo
Query expansion information for the returned results.
redirect_uri str
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.
applied_controls Sequence[str]
The fully qualified resource name of applied `controls
invalid_condition_boost_specs Sequence[google.cloud.retail_v2beta.types.SearchRequest.BoostSpec.ConditionBoostSpec]
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.

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.