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.



8251
8252
8253
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8251

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

Instance Attribute Details

#display_nameString

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)


8227
8228
8229
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8227

def display_name
  @display_name
end

#llm_model_settingsGoogle::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1LlmModelSettings

Settings for LLM models. Corresponds to the JSON property llmModelSettings



8232
8233
8234
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8232

def llm_model_settings
  @llm_model_settings
end

#nameString

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)


8239
8240
8241
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8239

def name
  @name
end

#placeholdersArray<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GeneratorPlaceholder>

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



8244
8245
8246
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8244

def placeholders
  @placeholders
end

#prompt_textGoogle::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Phrase

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



8249
8250
8251
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8249

def prompt_text
  @prompt_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8256
8257
8258
8259
8260
8261
8262
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 8256

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