Class Fulfillment.GeneratorSettings (0.84.0) 

public static final class Fulfillment.GeneratorSettings extends GeneratedMessageV3 implements Fulfillment.GeneratorSettingsOrBuilder

Generator settings used by the LLM to generate a text response.

Protobuf type google.cloud.dialogflow.cx.v3.Fulfillment.GeneratorSettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Fulfillment.GeneratorSettings

Static Fields

GENERATOR_FIELD_NUMBER

public static final int GENERATOR_FIELD_NUMBER
Field Value
Type Description
int

INPUT_PARAMETERS_FIELD_NUMBER

public static final int INPUT_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_PARAMETER_FIELD_NUMBER

public static final int OUTPUT_PARAMETER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Fulfillment.GeneratorSettings getDefaultInstance()
Returns
Type Description
Fulfillment.GeneratorSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Fulfillment.GeneratorSettings.Builder newBuilder()
Returns
Type Description
Fulfillment.GeneratorSettings.Builder

newBuilder(Fulfillment.GeneratorSettings prototype)

public static Fulfillment.GeneratorSettings.Builder newBuilder(Fulfillment.GeneratorSettings prototype)
Parameter
Name Description
prototype Fulfillment.GeneratorSettings
Returns
Type Description
Fulfillment.GeneratorSettings.Builder

parseDelimitedFrom(InputStream input)

public static Fulfillment.GeneratorSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Fulfillment.GeneratorSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Fulfillment.GeneratorSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Fulfillment.GeneratorSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Fulfillment.GeneratorSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Fulfillment.GeneratorSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Fulfillment.GeneratorSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Fulfillment.GeneratorSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Fulfillment.GeneratorSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Fulfillment.GeneratorSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Fulfillment.GeneratorSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Fulfillment.GeneratorSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Fulfillment.GeneratorSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Fulfillment.GeneratorSettings> parser()
Returns
Type Description
Parser<GeneratorSettings>

Methods

containsInputParameters(String key)

public boolean containsInputParameters(String key)

Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter city in the Generator, Dialogflow default to fill in the $city with $session.params.city. However, you may choose to fill $city with $session.params.desination-city.

  • Map key: parameter ID
  • Map value: session parameter name

map<string, string> input_parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Fulfillment.GeneratorSettings getDefaultInstanceForType()
Returns
Type Description
Fulfillment.GeneratorSettings

getGenerator()

public String getGenerator()

Required. The generator to call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>.

string generator = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The generator.

getGeneratorBytes()

public ByteString getGeneratorBytes()

Required. The generator to call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generators/<GeneratorID>.

string generator = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for generator.

getInputParameters() (deprecated)

public Map<String,String> getInputParameters()

Use #getInputParametersMap() instead.

Returns
Type Description
Map<String,String>

getInputParametersCount()

public int getInputParametersCount()

Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter city in the Generator, Dialogflow default to fill in the $city with $session.params.city. However, you may choose to fill $city with $session.params.desination-city.

  • Map key: parameter ID
  • Map value: session parameter name

map<string, string> input_parameters = 2;

Returns
Type Description
int

getInputParametersMap()

public Map<String,String> getInputParametersMap()

Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter city in the Generator, Dialogflow default to fill in the $city with $session.params.city. However, you may choose to fill $city with $session.params.desination-city.

  • Map key: parameter ID
  • Map value: session parameter name

map<string, string> input_parameters = 2;

Returns
Type Description
Map<String,String>

getInputParametersOrDefault(String key, String defaultValue)

public String getInputParametersOrDefault(String key, String defaultValue)

Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter city in the Generator, Dialogflow default to fill in the $city with $session.params.city. However, you may choose to fill $city with $session.params.desination-city.

  • Map key: parameter ID
  • Map value: session parameter name

map<string, string> input_parameters = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getInputParametersOrThrow(String key)

public String getInputParametersOrThrow(String key)

Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter city in the Generator, Dialogflow default to fill in the $city with $session.params.city. However, you may choose to fill $city with $session.params.desination-city.

  • Map key: parameter ID
  • Map value: session parameter name

map<string, string> input_parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getOutputParameter()

public String getOutputParameter()

Required. Output parameter which should contain the generator response.

string output_parameter = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The outputParameter.

getOutputParameterBytes()

public ByteString getOutputParameterBytes()

Required. Output parameter which should contain the generator response.

string output_parameter = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for outputParameter.

getParserForType()

public Parser<Fulfillment.GeneratorSettings> getParserForType()
Returns
Type Description
Parser<GeneratorSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Fulfillment.GeneratorSettings.Builder newBuilderForType()
Returns
Type Description
Fulfillment.GeneratorSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Fulfillment.GeneratorSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Fulfillment.GeneratorSettings.Builder toBuilder()
Returns
Type Description
Fulfillment.GeneratorSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException