Class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
- Inherits:
-
Object
- Object
- Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb
Overview
Response message for SearchService.Search method.
Instance Attribute Summary collapse
-
#applied_controls ⇒ Array<String>
The fully qualified resource name of applied controls.
-
#attribution_token ⇒ String
A unique search token.
-
#corrected_query ⇒ String
Contains the spell corrected query, if found.
-
#experiment_info ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo>
Metadata related to A/B testing Experiment associated with this response.
-
#facets ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet>
Results of facets requested by user.
-
#invalid_condition_boost_specs ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec>
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
-
#next_page_token ⇒ String
A token that can be sent as SearchRequest.page_token to retrieve the next page.
-
#query_expansion_info ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseQueryExpansionInfo
Information describing query expansion including whether expansion has occurred.
-
#redirect_uri ⇒ String
The URI of a customer-defined redirect page.
-
#results ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult>
A list of matched items.
-
#total_size ⇒ Fixnum
The estimated total count of matched items irrespective of pagination.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudRetailV2SearchResponse
constructor
A new instance of GoogleCloudRetailV2SearchResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudRetailV2SearchResponse
Returns a new instance of GoogleCloudRetailV2SearchResponse.
5127 5128 5129 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5127 def initialize(**args) update!(**args) end |
Instance Attribute Details
#applied_controls ⇒ Array<String>
The fully qualified resource name of applied controls.
Corresponds to the JSON property appliedControls
5063 5064 5065 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5063 def applied_controls @applied_controls end |
#attribution_token ⇒ String
A unique search token. This should be included in the UserEvent logs resulting
from this search, which enables accurate attribution of search model
performance.
Corresponds to the JSON property attributionToken
5070 5071 5072 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5070 def attribution_token @attribution_token end |
#corrected_query ⇒ String
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.
Corresponds to the JSON property correctedQuery
5077 5078 5079 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5077 def corrected_query @corrected_query end |
#experiment_info ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo>
Metadata related to A/B testing Experiment associated with this response. Only
exists when an experiment is triggered.
Corresponds to the JSON property experimentInfo
5083 5084 5085 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5083 def experiment_info @experiment_info end |
#facets ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet>
Results of facets requested by user.
Corresponds to the JSON property facets
5088 5089 5090 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5088 def facets @facets end |
#invalid_condition_boost_specs ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec>
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied
during serving.
Corresponds to the JSON property invalidConditionBoostSpecs
5094 5095 5096 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5094 def invalid_condition_boost_specs @invalid_condition_boost_specs end |
#next_page_token ⇒ String
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.
Corresponds to the JSON property nextPageToken
5100 5101 5102 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5100 def next_page_token @next_page_token end |
#query_expansion_info ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseQueryExpansionInfo
Information describing query expansion including whether expansion has
occurred.
Corresponds to the JSON property queryExpansionInfo
5106 5107 5108 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5106 def query_expansion_info @query_expansion_info end |
#redirect_uri ⇒ String
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.
Corresponds to the JSON property redirectUri
5113 5114 5115 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5113 def redirect_uri @redirect_uri end |
#results ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult>
A list of matched items. The order represents the ranking.
Corresponds to the JSON property results
5118 5119 5120 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5118 def results @results end |
#total_size ⇒ Fixnum
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.
Corresponds to the JSON property totalSize
5125 5126 5127 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5125 def total_size @total_size end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 |
# File 'lib/google/apis/retail_v2/classes.rb', line 5132 def update!(**args) @applied_controls = args[:applied_controls] if args.key?(:applied_controls) @attribution_token = args[:attribution_token] if args.key?(:attribution_token) @corrected_query = args[:corrected_query] if args.key?(:corrected_query) @experiment_info = args[:experiment_info] if args.key?(:experiment_info) @facets = args[:facets] if args.key?(:facets) @invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info) @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri) @results = args[:results] if args.key?(:results) @total_size = args[:total_size] if args.key?(:total_size) end |