com.google.cloud.dialogflow.cx.v3

Class Generator

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.cx.v3.Generator

All Implemented Interfaces:

GeneratorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Generator
extends com.google.protobuf.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.v3.Generator

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Generator.Builder Generators contain prompt to be sent to the LLM model to generate text.
static class	Generator.ModelParameter Parameters to be passed to the LLM.
static interface	Generator.ModelParameterOrBuilder
static class	Generator.Placeholder Represents a custom placeholder in the prompt text.
static interface	Generator.PlaceholderOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISPLAY_NAME_FIELD_NUMBER
static int	MODEL_PARAMETER_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PLACEHOLDERS_FIELD_NUMBER
static int	PROMPT_TEXT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Generator	getDefaultInstance()
Generator	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
Generator.ModelParameter	getModelParameter() 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.
com.google.protobuf.Parser<Generator>	getParserForType()
Generator.Placeholder	getPlaceholders(int index) Optional.
int	getPlaceholdersCount() Optional.
List<Generator.Placeholder>	getPlaceholdersList() Optional.
Generator.PlaceholderOrBuilder	getPlaceholdersOrBuilder(int index) Optional.
List<? extends Generator.PlaceholderOrBuilder>	getPlaceholdersOrBuilderList() Optional.
Phrase	getPromptText() Required.
PhraseOrBuilder	getPromptTextOrBuilder() Required.
int	getSerializedSize()
int	hashCode()
boolean	hasModelParameter() Parameters passed to the LLM to configure its behavior.
boolean	hasPromptText() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Generator.Builder	newBuilder()
static Generator.Builder	newBuilder(Generator prototype)
Generator.Builder	newBuilderForType()
protected Generator.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Generator	parseDelimitedFrom(InputStream input)
static Generator	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Generator	parseFrom(byte[] data)
static Generator	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Generator	parseFrom(ByteBuffer data)
static Generator	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Generator	parseFrom(com.google.protobuf.ByteString data)
static Generator	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Generator	parseFrom(com.google.protobuf.CodedInputStream input)
static Generator	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Generator	parseFrom(InputStream input)
static Generator	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Generator>	parser()
Generator.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

PROMPT_TEXT_FIELD_NUMBER

public static final int PROMPT_TEXT_FIELD_NUMBER

See Also:

Constant Field Values

PLACEHOLDERS_FIELD_NUMBER

public static final int PLACEHOLDERS_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_PARAMETER_FIELD_NUMBER

public static final int MODEL_PARAMETER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public 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;

Specified by:

getName in interface GeneratorOrBuilder

Returns:

The name.

getNameBytes

public 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;

Specified by:

getNameBytes in interface GeneratorOrBuilder

Returns:

The bytes for name.

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];

Specified by:

getDisplayName in interface GeneratorOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public 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];

Specified by:

getDisplayNameBytes in interface GeneratorOrBuilder

Returns:

The bytes for displayName.

hasPromptText

public boolean hasPromptText()

 Required. Prompt for the LLM model.
 

.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasPromptText in interface GeneratorOrBuilder

Returns:

Whether the promptText field is set.

getPromptText

public Phrase getPromptText()

 Required. Prompt for the LLM model.
 

.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPromptText in interface GeneratorOrBuilder

Returns:

The promptText.

getPromptTextOrBuilder

public PhraseOrBuilder getPromptTextOrBuilder()

 Required. Prompt for the LLM model.
 

.google.cloud.dialogflow.cx.v3.Phrase prompt_text = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPromptTextOrBuilder in interface GeneratorOrBuilder

getPlaceholdersList

public 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];

Specified by:

getPlaceholdersList in interface GeneratorOrBuilder

getPlaceholdersOrBuilderList

public 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];

Specified by:

getPlaceholdersOrBuilderList in interface GeneratorOrBuilder

getPlaceholdersCount

public 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];

Specified by:

getPlaceholdersCount in interface GeneratorOrBuilder

getPlaceholders

public 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];

Specified by:

getPlaceholders in interface GeneratorOrBuilder

getPlaceholdersOrBuilder

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];

Specified by:

getPlaceholdersOrBuilder in interface GeneratorOrBuilder

hasModelParameter

public boolean hasModelParameter()

 Parameters passed to the LLM to configure its behavior.
 

.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;

Specified by:

hasModelParameter in interface GeneratorOrBuilder

Returns:

Whether the modelParameter field is set.

getModelParameter

public Generator.ModelParameter getModelParameter()

 Parameters passed to the LLM to configure its behavior.
 

.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;

Specified by:

getModelParameter in interface GeneratorOrBuilder

Returns:

The modelParameter.

getModelParameterOrBuilder

public Generator.ModelParameterOrBuilder getModelParameterOrBuilder()

 Parameters passed to the LLM to configure its behavior.
 

.google.cloud.dialogflow.cx.v3.Generator.ModelParameter model_parameter = 8;

Specified by:

getModelParameterOrBuilder in interface GeneratorOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Generator parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Generator parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Generator parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Generator parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Generator parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Generator parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Generator parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static Generator parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static Generator parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static Generator parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static Generator parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static Generator parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public Generator.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Generator.Builder newBuilder()

newBuilder

public static Generator.Builder newBuilder(Generator prototype)

toBuilder

public Generator.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Generator.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Generator getDefaultInstance()

parser

public static com.google.protobuf.Parser<Generator> parser()

getParserForType

public com.google.protobuf.Parser<Generator> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Generator getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder