Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse

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

Overview

Response message for SearchService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaSearchResponse

Returns a new instance of GoogleCloudDiscoveryengineV1betaSearchResponse.



31384
31385
31386
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31384

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

Instance Attribute Details

#applied_controls ⇒ Array<String>

Controls applied as part of the Control service. Corresponds to the JSON property appliedControls

Returns:

  • (Array<String>) 


31279
31280
31281
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31279

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

Returns:

  • (String) 


31287
31288
31289
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31287

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) 


31294
31295
31296
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31294

def corrected_query
  @corrected_query
end

#facets ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseFacet>

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

Returns:



31299
31300
31301
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31299

def facets
  @facets
end

#geo_search_debug_info ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo>

Corresponds to the JSON property geoSearchDebugInfo

Returns:



31304
31305
31306
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31304

def geo_search_debug_info
  @geo_search_debug_info
end

#guided_search_result ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult

Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results. Corresponds to the JSON property guidedSearchResult

Returns:



31310
31311
31312
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31310

def guided_search_result
  @guided_search_result
end

#natural_language_query_understanding_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo

Information describing what natural language understanding was done on the input query. Corresponds to the JSON property naturalLanguageQueryUnderstandingInfo

Returns:



31316
31317
31318
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31316

def natural_language_query_understanding_info
  @natural_language_query_understanding_info
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) 


31322
31323
31324
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31322

def next_page_token
  @next_page_token
end

#one_box_results ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult>

A list of One Box results. There can be multiple One Box results of different types. Corresponds to the JSON property oneBoxResults

Returns:



31328
31329
31330
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31328

def one_box_results
  @one_box_results
end

#query_expansion_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo

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

Returns:



31334
31335
31336
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31334

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) 


31341
31342
31343
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31341

def redirect_uri
  @redirect_uri
end

#results ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult>

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

Returns:



31346
31347
31348
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31346

def results
  @results
end

#search_link_promotions ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchLinkPromotion>

Promotions for site search. Corresponds to the JSON property searchLinkPromotions

Returns:



31351
31352
31353
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31351

def search_link_promotions
  @search_link_promotions
end

#semantic_state ⇒ String

Output only. Indicates the semantic state of the search response. Corresponds to the JSON property semanticState

Returns:

  • (String) 


31356
31357
31358
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31356

def semantic_state
  @semantic_state
end

#session_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo

Information about the session. Corresponds to the JSON property sessionInfo

Returns:



31361
31362
31363
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31361

def session_info
  @session_info
end

#suggested_query ⇒ String

Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). Corresponds to the JSON property suggestedQuery

Returns:

  • (String) 


31370
31371
31372
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31370

def suggested_query
  @suggested_query
end

#summary ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummary

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

Returns:



31375
31376
31377
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31375

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) 


31382
31383
31384
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31382

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



31389
31390
31391
31392
31393
31394
31395
31396
31397
31398
31399
31400
31401
31402
31403
31404
31405
31406
31407
31408
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31389

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)
  @facets = args[:facets] if args.key?(:facets)
  @geo_search_debug_info = args[:geo_search_debug_info] if args.key?(:geo_search_debug_info)
  @guided_search_result = args[:guided_search_result] if args.key?(:guided_search_result)
  @natural_language_query_understanding_info = args[:natural_language_query_understanding_info] if args.key?(:natural_language_query_understanding_info)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @one_box_results = args[:one_box_results] if args.key?(:one_box_results)
  @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)
  @search_link_promotions = args[:search_link_promotions] if args.key?(:search_link_promotions)
  @semantic_state = args[:semantic_state] if args.key?(:semantic_state)
  @session_info = args[:session_info] if args.key?(:session_info)
  @suggested_query = args[:suggested_query] if args.key?(:suggested_query)
  @summary = args[:summary] if args.key?(:summary)
  @total_size = args[:total_size] if args.key?(:total_size)
end