class Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse

Response message for SearchService.Search method.

Attributes

attribution_token[RW]

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` @return [String]

corrected_query[RW]

If spell correction applies, the corrected query. Otherwise, empty. Corresponds to the JSON property `correctedQuery` @return [String]

facets[RW]

Results of facets requested by user. Corresponds to the JSON property `facets` @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet>]

next_page_token[RW]

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` @return [String]

query_expansion_info[RW]

Information describing query expansion including whether expansion has occurred. Corresponds to the JSON property `queryExpansionInfo` @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo]

redirect_uri[RW]

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. Corresponds to the JSON property `redirectUri` @return [String]

results[RW]

A list of matched items. The order represents the ranking. Corresponds to the JSON property `results` @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseSearchResult>]

total_size[RW]

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` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/retail_v2alpha/classes.rb, line 3325
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/retail_v2alpha/classes.rb, line 3330
def update!(**args)
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
  @facets = args[:facets] if args.key?(:facets)
  @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