Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGenerativeQuestionConfig

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

Overview

Configuration for a single generated question.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaGenerativeQuestionConfig

Returns a new instance of GoogleCloudRetailV2alphaGenerativeQuestionConfig.



3352
3353
3354
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3352

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) 


3317
3318
3319
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3317

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) 


3324
3325
3326
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3324

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>) 


3329
3330
3331
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3329

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) 


3334
3335
3336
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3334

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) 


3340
3341
3342
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3340

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) 


3345
3346
3347
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3345

def frequency
  @frequency
end

#generated_question ⇒ String

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

Returns:

  • (String) 


3350
3351
3352
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3350

def generated_question
  @generated_question
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3357
3358
3359
3360
3361
3362
3363
3364
3365
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3357

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