Class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGenerativeQuestionConfig

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

Overview

Configuration for a single generated question.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2betaGenerativeQuestionConfig

Returns a new instance of GoogleCloudRetailV2betaGenerativeQuestionConfig.



4405
4406
4407
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4405

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) 


4370
4371
4372
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4370

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) 


4377
4378
4379
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4377

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


4382
4383
4384
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4382

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) 


4387
4388
4389
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4387

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) 


4393
4394
4395
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4393

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) 


4398
4399
4400
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4398

def frequency
  @frequency
end

#generated_question ⇒ String

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

Returns:

  • (String) 


4403
4404
4405
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4403

def generated_question
  @generated_question
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4410
4411
4412
4413
4414
4415
4416
4417
4418
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 4410

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