Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse

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

Overview

Response message for SearchService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchResponse

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchResponse.



11790
11791
11792
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11790

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


11711
11712
11713
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11711

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. Corresponds to the JSON property attributionToken

Returns:

  • (String) 


11718
11719
11720
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11718

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) 


11725
11726
11727
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11725

def corrected_query
  @corrected_query
end

#facets ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseFacet>

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

Returns:



11730
11731
11732
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11730

def facets
  @facets
end

#geo_search_debug_info ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo>

Corresponds to the JSON property geoSearchDebugInfo

Returns:



11735
11736
11737
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11735

def geo_search_debug_info
  @geo_search_debug_info
end

#guided_search_result ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult

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:



11741
11742
11743
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11741

def guided_search_result
  @guided_search_result
end

#natural_language_query_understanding_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo

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

Returns:



11747
11748
11749
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11747

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) 


11753
11754
11755
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11753

def next_page_token
  @next_page_token
end

#query_expansion_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo

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

Returns:



11759
11760
11761
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11759

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) 


11766
11767
11768
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11766

def redirect_uri
  @redirect_uri
end

#results ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult>

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

Returns:



11771
11772
11773
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11771

def results
  @results
end

#session_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo

Information about the session. Corresponds to the JSON property sessionInfo

Returns:



11776
11777
11778
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11776

def session_info
  @session_info
end

#summary ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummary

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

Returns:



11781
11782
11783
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11781

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) 


11788
11789
11790
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11788

def total_size
  @total_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 11795

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