public final class Generator extends GeneratedMessageV3 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.v3beta1.Generator
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LLM_MODEL_SETTINGS_FIELD_NUMBER
public static final int LLM_MODEL_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_PARAMETER_FIELD_NUMBER
public static final int MODEL_PARAMETER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PLACEHOLDERS_FIELD_NUMBER
public static final int PLACEHOLDERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROMPT_TEXT_FIELD_NUMBER
public static final int PROMPT_TEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Generator getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Generator.Builder newBuilder()
newBuilder(Generator prototype)
public static Generator.Builder newBuilder(Generator prototype)
| Parameter |
| Name |
Description |
prototype |
Generator
|
public static Generator parseDelimitedFrom(InputStream input)
public static Generator parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Generator parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Generator parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Generator parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Generator parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Generator parseFrom(CodedInputStream input)
public static Generator parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Generator parseFrom(InputStream input)
public static Generator parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Generator parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Generator parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Generator> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Generator getDefaultInstanceForType()
getDisplayName()
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];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getLlmModelSettings()
public LlmModelSettings getLlmModelSettings()
The LLM model settings.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 9;
getLlmModelSettingsOrBuilder()
public LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder()
The LLM model settings.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 9;
getModelParameter()
public Generator.ModelParameter getModelParameter()
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3beta1.Generator.ModelParameter model_parameter = 8;
getModelParameterOrBuilder()
public Generator.ModelParameterOrBuilder getModelParameterOrBuilder()
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3beta1.Generator.ModelParameter model_parameter = 8;
getName()
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>.
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
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>.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Generator> getParserForType()
Overrides
getPlaceholders(int index)
public Generator.Placeholder getPlaceholders(int index)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getPlaceholdersCount()
public int getPlaceholdersCount()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getPlaceholdersList()
public List<Generator.Placeholder> getPlaceholdersList()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
getPlaceholdersOrBuilder(int index)
public Generator.PlaceholderOrBuilder getPlaceholdersOrBuilder(int index)
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getPlaceholdersOrBuilderList()
public List<? extends Generator.PlaceholderOrBuilder> getPlaceholdersOrBuilderList()
Optional. List of custom placeholders in the prompt text.
repeated .google.cloud.dialogflow.cx.v3beta1.Generator.Placeholder placeholders = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Generator.PlaceholderOrBuilder> |
|
getPromptText()
public Phrase getPromptText()
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3beta1.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Phrase |
The promptText.
|
getPromptTextOrBuilder()
public PhraseOrBuilder getPromptTextOrBuilder()
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3beta1.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasLlmModelSettings()
public boolean hasLlmModelSettings()
The LLM model settings.
.google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 9;
| Returns |
| Type |
Description |
boolean |
Whether the llmModelSettings field is set.
|
hasModelParameter()
public boolean hasModelParameter()
Parameters passed to the LLM to configure its behavior.
.google.cloud.dialogflow.cx.v3beta1.Generator.ModelParameter model_parameter = 8;
| Returns |
| Type |
Description |
boolean |
Whether the modelParameter field is set.
|
hasPromptText()
public boolean hasPromptText()
Required. Prompt for the LLM model.
.google.cloud.dialogflow.cx.v3beta1.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the promptText field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Generator.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Generator.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Generator.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
