Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

Response message for SearchService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchResponse

Returns a new instance of GoogleCloudDiscoveryengineV1SearchResponse.



6147
6148
6149
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6147

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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

Returns:

  • (String) 


6097
6098
6099
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6097

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

Returns:

  • (String) 


6104
6105
6106
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6104

def corrected_query
  @corrected_query
end

#facets ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseFacet>

Results of facets requested by user. Corresponds to the JSON property facets

Returns:



6109
6110
6111
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6109

def facets
  @facets
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

Returns:

  • (String) 


6115
6116
6117
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6115

def next_page_token
  @next_page_token
end

#query_expansion_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo

Information describing query expansion including whether expansion has occurred. Corresponds to the JSON property queryExpansionInfo

Returns:



6121
6122
6123
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6121

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

Returns:

  • (String) 


6128
6129
6130
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6128

def redirect_uri
  @redirect_uri
end

#results ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResult>

A list of matched documents. The order represents the ranking. Corresponds to the JSON property results

Returns:



6133
6134
6135
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6133

def results
  @results
end

#summary ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummary

Summary of the top N search results specified by the summary spec. Corresponds to the JSON property summary

Returns:



6138
6139
6140
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6138

def summary
  @summary
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

Returns:

  • (Fixnum) 


6145
6146
6147
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6145

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6152

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)
  @summary = args[:summary] if args.key?(:summary)
  @total_size = args[:total_size] if args.key?(:total_size)
end