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.



32030
32031
32032
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 32030

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>) 


31925
31926
31927
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31925

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) 


31933
31934
31935
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31933

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) 


31940
31941
31942
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31940

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:



31945
31946
31947
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31945

def facets
  @facets
end

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

Corresponds to the JSON property geoSearchDebugInfo

Returns:



31950
31951
31952
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31950

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:



31956
31957
31958
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31956

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:



31962
31963
31964
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31962

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) 


31968
31969
31970
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31968

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:



31974
31975
31976
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31974

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:



31980
31981
31982
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31980

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) 


31987
31988
31989
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31987

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:



31992
31993
31994
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31992

def results
  @results
end

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

Promotions for site search. Corresponds to the JSON property searchLinkPromotions

Returns:



31997
31998
31999
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 31997

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) 


32002
32003
32004
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 32002

def semantic_state
  @semantic_state
end

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

Information about the session. Corresponds to the JSON property sessionInfo

Returns:



32007
32008
32009
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 32007

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) 


32016
32017
32018
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 32016

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:



32021
32022
32023
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 32021

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) 


32028
32029
32030
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 32028

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32035
32036
32037
32038
32039
32040
32041
32042
32043
32044
32045
32046
32047
32048
32049
32050
32051
32052
32053
32054
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 32035

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