Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponse
- 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
-
#attribution_token ⇒ String
A unique search token.
-
#corrected_query ⇒ String
Contains the spell corrected query, if found.
-
#facets ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseFacet>
Results of facets requested by user.
-
#next_page_token ⇒ String
A token that can be sent as SearchRequest.page_token to retrieve the next page.
-
#query_expansion_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo
Information describing query expansion including whether expansion has occurred.
-
#redirect_uri ⇒ String
The URI of a customer-defined redirect page.
-
#results ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResult>
A list of matched documents.
-
#session_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo
Information about the session.
-
#summary ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSummary
Summary of the top N search results specified by the summary spec.
-
#total_size ⇒ Fixnum
The estimated total count of matched items irrespective of pagination.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchResponse
constructor
A new instance of GoogleCloudDiscoveryengineV1SearchResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchResponse
Returns a new instance of GoogleCloudDiscoveryengineV1SearchResponse.
6884 6885 6886 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6884 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
6829 6830 6831 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6829 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
6836 6837 6838 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6836 def corrected_query @corrected_query end |
#facets ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseFacet>
Results of facets requested by user.
Corresponds to the JSON property facets
6841 6842 6843 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6841 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
6847 6848 6849 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6847 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
6853 6854 6855 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6853 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
6860 6861 6862 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6860 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
6865 6866 6867 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6865 def results @results end |
#session_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSessionInfo
Information about the session.
Corresponds to the JSON property sessionInfo
6870 6871 6872 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6870 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
6875 6876 6877 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6875 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
6882 6883 6884 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6882 def total_size @total_size end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6889 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 |