public static final class Generator.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder> implements GeneratorOrBuilder
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.Protobuf type
google.cloud.dialogflow.cx.v3.Generator| Modifier and Type | Method and Description |
|---|---|
Generator.Builder |
addAllPlaceholders(Iterable<? extends Generator.Placeholder> values)
Optional.
|
Generator.Builder |
addPlaceholders(Generator.Placeholder.Builder builderForValue)
Optional.
|
Generator.Builder |
addPlaceholders(Generator.Placeholder value)
Optional.
|
Generator.Builder |
addPlaceholders(int index,
Generator.Placeholder.Builder builderForValue)
Optional.
|
Generator.Builder |
addPlaceholders(int index,
Generator.Placeholder value)
Optional.
|
Generator.Placeholder.Builder |
addPlaceholdersBuilder()
Optional.
|
Generator.Placeholder.Builder |
addPlaceholdersBuilder(int index)
Optional.
|
Generator.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Generator |
build() |
Generator |
buildPartial() |
Generator.Builder |
clear() |
Generator.Builder |
clearDisplayName()
Required.
|
Generator.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Generator.Builder |
clearModelParameter()
Parameters passed to the LLM to configure its behavior.
|
Generator.Builder |
clearName()
The unique identifier of the generator.
|
Generator.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Generator.Builder |
clearPlaceholders()
Optional.
|
Generator.Builder |
clearPromptText()
Required.
|
Generator.Builder |
clone() |
Generator |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
Generator.ModelParameter |
getModelParameter()
Parameters passed to the LLM to configure its behavior.
|
Generator.ModelParameter.Builder |
getModelParameterBuilder()
Parameters passed to the LLM to configure its behavior.
|
Generator.ModelParameterOrBuilder |
getModelParameterOrBuilder()
Parameters passed to the LLM to configure its behavior.
|
String |
getName()
The unique identifier of the generator.
|
com.google.protobuf.ByteString |
getNameBytes()
The unique identifier of the generator.
|
Generator.Placeholder |
getPlaceholders(int index)
Optional.
|
Generator.Placeholder.Builder |
getPlaceholdersBuilder(int index)
Optional.
|
List<Generator.Placeholder.Builder> |
getPlaceholdersBuilderList()
Optional.
|
int |
getPlaceholdersCount()
Optional.
|
List<Generator.Placeholder> |
getPlaceholdersList()
Optional.
|
Generator.PlaceholderOrBuilder |
getPlaceholdersOrBuilder(int index)
Optional.
|
List<? extends Generator.PlaceholderOrBuilder> |
getPlaceholdersOrBuilderList()
Optional.
|
Phrase |
getPromptText()
Required.
|
Phrase.Builder |
getPromptTextBuilder()
Required.
|
PhraseOrBuilder |
getPromptTextOrBuilder()
Required.
|
boolean |
hasModelParameter()
Parameters passed to the LLM to configure its behavior.
|
boolean |
hasPromptText()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Generator.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Generator.Builder |
mergeFrom(Generator other) |
Generator.Builder |
mergeFrom(com.google.protobuf.Message other) |
Generator.Builder |
mergeModelParameter(Generator.ModelParameter value)
Parameters passed to the LLM to configure its behavior.
|
Generator.Builder |
mergePromptText(Phrase value)
Required.
|
Generator.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Generator.Builder |
removePlaceholders(int index)
Optional.
|
Generator.Builder |
setDisplayName(String value)
Required.
|
Generator.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
Required.
|
Generator.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Generator.Builder |
setModelParameter(Generator.ModelParameter.Builder builderForValue)
Parameters passed to the LLM to configure its behavior.
|
Generator.Builder |
setModelParameter(Generator.ModelParameter value)
Parameters passed to the LLM to configure its behavior.
|
Generator.Builder |
setName(String value)
The unique identifier of the generator.
|
Generator.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The unique identifier of the generator.
|
Generator.Builder |
setPlaceholders(int index,
Generator.Placeholder.Builder builderForValue)
Optional.
|
Generator.Builder |
setPlaceholders(int index,
Generator.Placeholder value)
Optional.
|
Generator.Builder |
setPromptText(Phrase.Builder builderForValue)
Required.
|
Generator.Builder |
setPromptText(Phrase value)
Required.
|
Generator.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Generator.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Generator build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Generator buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Generator.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Generator.Builder>public Generator.Builder mergeFrom(Generator other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public Generator.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Generator.Builder>IOExceptionpublic String getName()
The unique identifier of the generator. Must be set for the [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] method. [Generators.CreateGenerate][] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
string name = 1;getName in interface GeneratorOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The unique identifier of the generator. Must be set for the [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] method. [Generators.CreateGenerate][] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
string name = 1;getNameBytes in interface GeneratorOrBuilderpublic Generator.Builder setName(String value)
The unique identifier of the generator. Must be set for the [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] method. [Generators.CreateGenerate][] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
string name = 1;value - The name to set.public Generator.Builder clearName()
The unique identifier of the generator. Must be set for the [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] method. [Generators.CreateGenerate][] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
string name = 1;public Generator.Builder setNameBytes(com.google.protobuf.ByteString value)
The unique identifier of the generator. Must be set for the [Generators.UpdateGenerator][google.cloud.dialogflow.cx.v3.Generators.UpdateGenerator] method. [Generators.CreateGenerate][] populates the name automatically. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>`.
string name = 1;value - The bytes for name to set.public String getDisplayName()
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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface GeneratorOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface GeneratorOrBuilderpublic Generator.Builder setDisplayName(String value)
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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];value - The displayName to set.public Generator.Builder clearDisplayName()
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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];public Generator.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];value - The bytes for displayName to set.public boolean hasPromptText()
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
hasPromptText in interface GeneratorOrBuilderpublic Phrase getPromptText()
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
getPromptText in interface GeneratorOrBuilderpublic Generator.Builder setPromptText(Phrase value)
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
public Generator.Builder setPromptText(Phrase.Builder builderForValue)
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
public Generator.Builder mergePromptText(Phrase value)
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
public Generator.Builder clearPromptText()
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
public Phrase.Builder getPromptTextBuilder()
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
public PhraseOrBuilder getPromptTextOrBuilder()
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
getPromptTextOrBuilder in interface GeneratorOrBuilderpublic List<Generator.Placeholder> getPlaceholdersList()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
getPlaceholdersList in interface GeneratorOrBuilderpublic int getPlaceholdersCount()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
getPlaceholdersCount in interface GeneratorOrBuilderpublic Generator.Placeholder getPlaceholders(int index)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
getPlaceholders in interface GeneratorOrBuilderpublic Generator.Builder setPlaceholders(int index, Generator.Placeholder value)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Builder setPlaceholders(int index, Generator.Placeholder.Builder builderForValue)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Builder addPlaceholders(Generator.Placeholder value)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Builder addPlaceholders(int index, Generator.Placeholder value)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Builder addPlaceholders(Generator.Placeholder.Builder builderForValue)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Builder addPlaceholders(int index, Generator.Placeholder.Builder builderForValue)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Builder addAllPlaceholders(Iterable<? extends Generator.Placeholder> values)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Builder clearPlaceholders()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Builder removePlaceholders(int index)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Placeholder.Builder getPlaceholdersBuilder(int index)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.PlaceholderOrBuilder getPlaceholdersOrBuilder(int index)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
getPlaceholdersOrBuilder in interface GeneratorOrBuilderpublic List<? extends Generator.PlaceholderOrBuilder> getPlaceholdersOrBuilderList()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
getPlaceholdersOrBuilderList in interface GeneratorOrBuilderpublic Generator.Placeholder.Builder addPlaceholdersBuilder()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public Generator.Placeholder.Builder addPlaceholdersBuilder(int index)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public List<Generator.Placeholder.Builder> getPlaceholdersBuilderList()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
public boolean hasModelParameter()
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;hasModelParameter in interface GeneratorOrBuilderpublic Generator.ModelParameter getModelParameter()
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;getModelParameter in interface GeneratorOrBuilderpublic Generator.Builder setModelParameter(Generator.ModelParameter value)
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;public Generator.Builder setModelParameter(Generator.ModelParameter.Builder builderForValue)
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;public Generator.Builder mergeModelParameter(Generator.ModelParameter value)
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;public Generator.Builder clearModelParameter()
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;public Generator.ModelParameter.Builder getModelParameterBuilder()
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;public Generator.ModelParameterOrBuilder getModelParameterOrBuilder()
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;getModelParameterOrBuilder in interface GeneratorOrBuilderpublic final Generator.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>public final Generator.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Generator.Builder>Copyright © 2025 Google LLC. All rights reserved.