Class SearchResponse (1.19.0)

Version 1.19.0

• 1.23.1 (latest)
• 1.23.0
• 1.22.0
• 1.21.2
• 1.20.1
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

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

Response message for SearchService.Search method.

Attributes
Name	Description
results	MutableSequence[google.cloud.retail_v2alpha.types.SearchResponse.SearchResult] A list of matched items. The order represents the ranking.
facets	MutableSequence[google.cloud.retail_v2alpha.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 Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
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_v2alpha.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 is performed, and only redirect_uri and attribution_token are set in the response.
applied_controls	MutableSequence[str] The fully qualified resource name of applied controls __.
invalid_condition_boost_specs	MutableSequence[google.cloud.retail_v2alpha.types.SearchRequest.BoostSpec.ConditionBoostSpec] The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
experiment_info	MutableSequence[google.cloud.retail_v2alpha.types.ExperimentInfo] Metadata related to A/B testing Experiment associated with this response. Only exists when an experiment is triggered.

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.