Class: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig

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

Overview

Configuration for a single generated question.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2GenerativeQuestionConfig

Returns a new instance of GoogleCloudRetailV2GenerativeQuestionConfig.



1887
1888
1889
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1887

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

Instance Attribute Details

#allowed_in_conversation ⇒ Boolean Also known as: allowed_in_conversation?

Optional. Whether the question is asked at serving time. Corresponds to the JSON property allowedInConversation

Returns:

  • (Boolean) 


1852
1853
1854
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1852

def allowed_in_conversation
  @allowed_in_conversation
end

#catalog ⇒ String

Required. Resource name of the catalog. Format: projects/project/locations/ location/catalogs/catalog Corresponds to the JSON property catalog

Returns:

  • (String) 


1859
1860
1861
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1859

def catalog
  @catalog
end

#example_values ⇒ Array<String>

Output only. Values that can be used to answer the question. Corresponds to the JSON property exampleValues

Returns:

  • (Array<String>) 


1864
1865
1866
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1864

def example_values
  @example_values
end

#facet ⇒ String

Required. The facet to which the question is associated. Corresponds to the JSON property facet

Returns:

  • (String) 


1869
1870
1871
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1869

def facet
  @facet
end

#final_question ⇒ String

Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used. Corresponds to the JSON property finalQuestion

Returns:

  • (String) 


1875
1876
1877
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1875

def final_question
  @final_question
end

#frequency ⇒ Float

Output only. The ratio of how often a question was asked. Corresponds to the JSON property frequency

Returns:

  • (Float) 


1880
1881
1882
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1880

def frequency
  @frequency
end

#generated_question ⇒ String

Output only. The LLM generated question. Corresponds to the JSON property generatedQuestion

Returns:

  • (String) 


1885
1886
1887
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1885

def generated_question
  @generated_question
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1892
1893
1894
1895
1896
1897
1898
1899
1900
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1892

def update!(**args)
  @allowed_in_conversation = args[:allowed_in_conversation] if args.key?(:allowed_in_conversation)
  @catalog = args[:catalog] if args.key?(:catalog)
  @example_values = args[:example_values] if args.key?(:example_values)
  @facet = args[:facet] if args.key?(:facet)
  @final_question = args[:final_question] if args.key?(:final_question)
  @frequency = args[:frequency] if args.key?(:frequency)
  @generated_question = args[:generated_question] if args.key?(:generated_question)
end