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 __.
|
pin_control_metadata |
google.cloud.retail_v2alpha.types.PinControlMetadata
Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin. |
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. |
conversational_search_result |
google.cloud.retail_v2alpha.types.SearchResponse.ConversationalSearchResult
This field specifies all related information that is needed on client side for UI rendering of conversational retail search. |
tile_navigation_result |
google.cloud.retail_v2alpha.types.SearchResponse.TileNavigationResult
This field specifies all related information for tile navigation that will be used in client side. |
Classes
ConversationalSearchResult
ConversationalSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
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.
TileNavigationResult
TileNavigationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)This field specifies all related information for tile navigation that will be used in client side.