Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
- 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
-
#applied_controls ⇒ Array<String>
Controls applied as part of the Control service.
-
#attribution_token ⇒ String
A unique search token.
-
#corrected_query ⇒ String
Contains the spell corrected query, if found.
-
#facets ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseFacet>
Results of facets requested by user.
-
#guided_search_result ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult
Guided search result.
-
#next_page_token ⇒ String
A token that can be sent as SearchRequest.page_token to retrieve the next page.
-
#query_expansion_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo
Information describing query expansion including whether expansion has occurred.
-
#redirect_uri ⇒ String
The URI of a customer-defined redirect page.
-
#results ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult>
A list of matched documents.
-
#summary ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
Summary of the top N search result specified by the summary spec.
-
#total_size ⇒ Fixnum
The estimated total count of matched items irrespective of pagination.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchResponse
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaSearchResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchResponse
Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchResponse.
3415 3416 3417 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3415 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
3352 3353 3354 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3352 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
3359 3360 3361 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3359 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
3366 3367 3368 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3366 def corrected_query @corrected_query end |
#facets ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseFacet>
Results of facets requested by user.
Corresponds to the JSON property facets
3371 3372 3373 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3371 def facets @facets 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
3377 3378 3379 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3377 def guided_search_result @guided_search_result 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
3383 3384 3385 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3383 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
3389 3390 3391 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3389 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
3396 3397 3398 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3396 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
3401 3402 3403 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3401 def results @results end |
#summary ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
Summary of the top N search result specified by the summary spec.
Corresponds to the JSON property summary
3406 3407 3408 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3406 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
3413 3414 3415 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3413 def total_size @total_size end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3420 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) @guided_search_result = args[:guided_search_result] if args.key?(:guided_search_result) @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) @summary = args[:summary] if args.key?(:summary) @total_size = args[:total_size] if args.key?(:total_size) end |