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.



9116
9117
9118
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9116

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) 


9087
9088
9089
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9087

def display_name
  @display_name
end

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

Settings for LLM models. Corresponds to the JSON property llmModelSettings

Returns:



9092
9093
9094
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9092

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:



9097
9098
9099
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9097

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) 


9104
9105
9106
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9104

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:



9109
9110
9111
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9109

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:



9114
9115
9116
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9114

def prompt_text
  @prompt_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9121
9122
9123
9124
9125
9126
9127
9128
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9121

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