# Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Generator (v1.12.1)

1.12.1 (latest) 1.12.0 1.11.0 1.10.1 1.9.0 1.8.0 1.7.0 1.6.1 1.5.0 1.4.0 1.3.0 1.2.0 1.1.1 1.0.0 0.26.0 0.25.0 0.24.2 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.1 0.14.0 0.13.0 0.12.0 0.11.0 0.10.2 0.9.0 0.8.1 0.7.1 0.6.0 0.5.0 0.4.0 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.

### #llm_model_settings

    def llm_model_settings() -> ::Google::Cloud::Dialogflow::CX::V3::LlmModelSettings

**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::LlmModelSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-LlmModelSettings)) --- The LLM model settings.

### #llm_model_settings=

    def llm_model_settings=(value) -> ::Google::Cloud::Dialogflow::CX::V3::LlmModelSettings

**Parameter**

- **value** ([::Google::Cloud::Dialogflow::CX::V3::LlmModelSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-LlmModelSettings)) --- The LLM model settings.
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::LlmModelSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-LlmModelSettings)) --- The LLM model settings.

### #model_parameter

    def model_parameter() -> ::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter

**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Generator-ModelParameter)) --- Parameters passed to the LLM to configure its behavior.
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::Generator::ModelParameter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Generators-Client#Google__Cloud__Dialogflow__CX__V3__Generators__Client_update_generator_instance_ "Google::Cloud::Dialogflow::CX::V3::Generators::Client#update_generator (method)") 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Generators-Client#Google__Cloud__Dialogflow__CX__V3__Generators__Client_update_generator_instance_ "Google::Cloud::Dialogflow::CX::V3::Generators::Client#update_generator (method)") 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Generators-Client#Google__Cloud__Dialogflow__CX__V3__Generators__Client_update_generator_instance_ "Google::Cloud::Dialogflow::CX::V3::Generators::Client#update_generator (method)") 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Phrase)) --- Required. Prompt for the LLM model.
**Returns**

- ([::Google::Cloud::Dialogflow::CX::V3::Phrase](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-Phrase)) --- Required. Prompt for the LLM model.