Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Generator

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

Overview

Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1Generator

Returns a new instance of GoogleCloudDialogflowCxV3beta1Generator.



8396
8397
8398
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8396

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

Instance Attribute Details

#display_name ⇒ String

Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user- utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment. Corresponds to the JSON property displayName

Returns:

  • (String) 


8367
8368
8369
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8367

def display_name
  @display_name
end

#llm_model_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmModelSettings

Settings for LLM models. Corresponds to the JSON property llmModelSettings

Returns:



8372
8373
8374
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8372

def llm_model_settings
  @llm_model_settings
end

#model_parameter ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GeneratorModelParameter

Parameters to be passed to the LLM. If not set, default values will be used. Corresponds to the JSON property modelParameter

Returns:



8377
8378
8379
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8377

def model_parameter
  @model_parameter
end

#name ⇒ String

The unique identifier of the generator. Must be set for the Generators. UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: projects//locations//agents//generators/. Corresponds to the JSON property name

Returns:

  • (String) 


8384
8385
8386
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8384

def name
  @name
end

#placeholders ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GeneratorPlaceholder>

Optional. List of custom placeholders in the prompt text. Corresponds to the JSON property placeholders

Returns:



8389
8390
8391
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8389

def placeholders
  @placeholders
end

#prompt_text ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Phrase

Text input which can be used for prompt or banned phrases. Corresponds to the JSON property promptText

Returns:



8394
8395
8396
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8394

def prompt_text
  @prompt_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8401
8402
8403
8404
8405
8406
8407
8408
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8401

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @llm_model_settings = args[:llm_model_settings] if args.key?(:llm_model_settings)
  @model_parameter = args[:model_parameter] if args.key?(:model_parameter)
  @name = args[:name] if args.key?(:name)
  @placeholders = args[:placeholders] if args.key?(:placeholders)
  @prompt_text = args[:prompt_text] if args.key?(:prompt_text)
end