Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Generator.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#display_name
def display_name() -> ::String
Returns
- (::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.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#model_parameter
def model_parameter() -> ::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter
Returns
- (::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter) — Parameters passed to the LLM to configure its behavior.
#model_parameter=
def model_parameter=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter) — Parameters passed to the LLM to configure its behavior.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter) — Parameters passed to the LLM to configure its behavior.
#name
def name() -> ::String
Returns
-
(::String) — The unique identifier of the generator.
Must be set for the
Generators.UpdateGenerator
method. [Generators.CreateGenerate][] populates the name automatically.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>
.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — The unique identifier of the generator.
Must be set for the
Generators.UpdateGenerator
method. [Generators.CreateGenerate][] populates the name automatically.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>
.
Returns
-
(::String) — The unique identifier of the generator.
Must be set for the
Generators.UpdateGenerator
method. [Generators.CreateGenerate][] populates the name automatically.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>
.
#placeholders
def placeholders() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>
Returns
- (::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>) — Optional. List of custom placeholders in the prompt text.
#placeholders=
def placeholders=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>
Parameter
- value (::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>) — Optional. List of custom placeholders in the prompt text.
Returns
- (::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>) — Optional. List of custom placeholders in the prompt text.
#prompt_text
def prompt_text() -> ::Google::Cloud::Dialogflow::CX::V3::Phrase
Returns
- (::Google::Cloud::Dialogflow::CX::V3::Phrase) — Required. Prompt for the LLM model.
#prompt_text=
def prompt_text=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Phrase
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::Phrase) — Required. Prompt for the LLM model.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::Phrase) — Required. Prompt for the LLM model.