Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec

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

Defines guided search spec.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec.



5726
5727
5728
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5726

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

Instance Attribute Details

#enable_refinement_attributes ⇒ Boolean Also known as: enable_refinement_attributes?

Whether or not to enable and include refinement attributes in gudied search result. Corresponds to the JSON property enableRefinementAttributes

Returns:

  • (Boolean) 


5711
5712
5713
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5711

def enable_refinement_attributes
  @enable_refinement_attributes
end

#enable_related_questions ⇒ Boolean Also known as: enable_related_questions?

Whether or not to enable and include related questions in search response. Corresponds to the JSON property enableRelatedQuestions

Returns:

  • (Boolean) 


5717
5718
5719
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5717

def enable_related_questions
  @enable_related_questions
end

#max_related_questions ⇒ Fixnum

Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3. Corresponds to the JSON property maxRelatedQuestions

Returns:

  • (Fixnum) 


5724
5725
5726
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5724

def max_related_questions
  @max_related_questions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5731
5732
5733
5734
5735
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5731

def update!(**args)
  @enable_refinement_attributes = args[:enable_refinement_attributes] if args.key?(:enable_refinement_attributes)
  @enable_related_questions = args[:enable_related_questions] if args.key?(:enable_related_questions)
  @max_related_questions = args[:max_related_questions] if args.key?(:max_related_questions)
end