Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo

Inherits:

Object

• Object
• Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo

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 more...

Overview

Information describing query expansion including whether expansion has occurred.

Instance Attribute Summary

• #expanded_query ⇒ Boolean (also: #expanded_query?)

  Bool describing whether query expansion has occurred.

• #pinned_result_count ⇒ Fixnum

  Number of pinned results.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo constructor

  A new instance of GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo.

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6190

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

Instance Attribute Details

#expanded_query ⇒ Boolean Also known as: expanded_query?

Bool describing whether query expansion has occurred. Corresponds to the JSON property expandedQuery

Returns:

• (Boolean)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6181

def expanded_query
  @expanded_query
end

#pinned_result_count ⇒ Fixnum

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true. Corresponds to the JSON property pinnedResultCount

Returns:

• (Fixnum)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6188

def pinned_result_count
  @pinned_result_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6195

def update!(**args)
  @expanded_query = args[:expanded_query] if args.key?(:expanded_query)
  @pinned_result_count = args[:pinned_result_count] if args.key?(:pinned_result_count)
end