Class Fulfillment.GeneratorSettings.Builder (0.79.0)

public static final class Fulfillment.GeneratorSettings.Builder extends GeneratedMessageV3.Builder<Fulfillment.GeneratorSettings.Builder> implements Fulfillment.GeneratorSettingsOrBuilder

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

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Fulfillment.GeneratorSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

build()

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

buildPartial()

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

clear()

public Fulfillment.GeneratorSettings.Builder clear()
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Fulfillment.GeneratorSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

clearGenerator()

public Fulfillment.GeneratorSettings.Builder clearGenerator()

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
Fulfillment.GeneratorSettings.Builder

This builder for chaining.

clearInputParameters()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public Fulfillment.GeneratorSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

clearOutputParameter()

public Fulfillment.GeneratorSettings.Builder clearOutputParameter()

Required. Output parameter which should contain the generator response.

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

Returns
Type Description
Fulfillment.GeneratorSettings.Builder

This builder for chaining.

clone()

public Fulfillment.GeneratorSettings.Builder clone()
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

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

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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()
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

getMutableInputParameters() (deprecated)

public Map<String,String> getMutableInputParameters()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Fulfillment.GeneratorSettings other)

public Fulfillment.GeneratorSettings.Builder mergeFrom(Fulfillment.GeneratorSettings other)
Parameter
Name Description
other Fulfillment.GeneratorSettings
Returns
Type Description
Fulfillment.GeneratorSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Fulfillment.GeneratorSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Fulfillment.GeneratorSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Fulfillment.GeneratorSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

putAllInputParameters(Map<String,String> values)

public Fulfillment.GeneratorSettings.Builder putAllInputParameters(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
Fulfillment.GeneratorSettings.Builder

putInputParameters(String key, String value)

public Fulfillment.GeneratorSettings.Builder putInputParameters(String key, String value)

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
value String
Returns
Type Description
Fulfillment.GeneratorSettings.Builder

removeInputParameters(String key)

public Fulfillment.GeneratorSettings.Builder removeInputParameters(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
Fulfillment.GeneratorSettings.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Fulfillment.GeneratorSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

setGenerator(String value)

public Fulfillment.GeneratorSettings.Builder setGenerator(String value)

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) = { ... }

Parameter
Name Description
value String

The generator to set.

Returns
Type Description
Fulfillment.GeneratorSettings.Builder

This builder for chaining.

setGeneratorBytes(ByteString value)

public Fulfillment.GeneratorSettings.Builder setGeneratorBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for generator to set.

Returns
Type Description
Fulfillment.GeneratorSettings.Builder

This builder for chaining.

setOutputParameter(String value)

public Fulfillment.GeneratorSettings.Builder setOutputParameter(String value)

Required. Output parameter which should contain the generator response.

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

Parameter
Name Description
value String

The outputParameter to set.

Returns
Type Description
Fulfillment.GeneratorSettings.Builder

This builder for chaining.

setOutputParameterBytes(ByteString value)

public Fulfillment.GeneratorSettings.Builder setOutputParameterBytes(ByteString value)

Required. Output parameter which should contain the generator response.

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

Parameter
Name Description
value ByteString

The bytes for outputParameter to set.

Returns
Type Description
Fulfillment.GeneratorSettings.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Fulfillment.GeneratorSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Fulfillment.GeneratorSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Fulfillment.GeneratorSettings.Builder
Overrides