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.



8178
8179
8180
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8178

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. This also helps to identify a request during the customer support scenarios. Corresponds to the JSON property attributionToken

Returns:

  • (String) 


8123
8124
8125
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8123

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) 


8130
8131
8132
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8130

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:



8135
8136
8137
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8135

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) 


8141
8142
8143
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8141

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:



8147
8148
8149
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8147

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) 


8154
8155
8156
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8154

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:



8159
8160
8161
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8159

def results
  @results
end

#session_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo

Information about the session. Corresponds to the JSON property sessionInfo

Returns:



8164
8165
8166
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8164

def session_info
  @session_info
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:



8169
8170
8171
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8169

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) 


8176
8177
8178
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8176

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8183

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