Class GenerationConfig.Builder (3.38.0)

public static final class GenerationConfig.Builder extends GeneratedMessageV3.Builder<GenerationConfig.Builder> implements GenerationConfigOrBuilder

Generation config.

Protobuf type google.cloud.aiplatform.v1beta1.GenerationConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GenerationConfig.Builder

Implements

GenerationConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllStopSequences(Iterable<String> values)

public GenerationConfig.Builder addAllStopSequences(Iterable<String> values)

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<String>` The stopSequences to add.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerationConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addStopSequences(String value)

public GenerationConfig.Builder addStopSequences(String value)

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The stopSequences to add.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

addStopSequencesBytes(ByteString value)

public GenerationConfig.Builder addStopSequencesBytes(ByteString value)

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes of the stopSequences to add.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

build()

public GenerationConfig build()

Returns
Type	Description
`GenerationConfig`

buildPartial()

public GenerationConfig buildPartial()

Returns
Type	Description
`GenerationConfig`

clear()

public GenerationConfig.Builder clear()

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCandidateCount()

public GenerationConfig.Builder clearCandidateCount()

Optional. Number of candidates to generate.

optional int32 candidate_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GenerationConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMaxOutputTokens()

public GenerationConfig.Builder clearMaxOutputTokens()

Optional. The maximum number of output tokens to generate per message.

optional int32 max_output_tokens = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerationConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearStopSequences()

public GenerationConfig.Builder clearStopSequences()

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

clearTemperature()

public GenerationConfig.Builder clearTemperature()

Optional. Controls the randomness of predictions.

optional float temperature = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

clearTopK()

public GenerationConfig.Builder clearTopK()

Optional. If specified, top-k sampling will be used.

optional float top_k = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

clearTopP()

public GenerationConfig.Builder clearTopP()

Optional. If specified, nucleus sampling will be used.

optional float top_p = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

clone()

public GenerationConfig.Builder clone()

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCandidateCount()

public int getCandidateCount()

Optional. Number of candidates to generate.

optional int32 candidate_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The candidateCount.

getDefaultInstanceForType()

public GenerationConfig getDefaultInstanceForType()

Returns
Type	Description
`GenerationConfig`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMaxOutputTokens()

public int getMaxOutputTokens()

Optional. The maximum number of output tokens to generate per message.

optional int32 max_output_tokens = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The maxOutputTokens.

getStopSequences(int index)

public String getStopSequences(int index)

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The stopSequences at the given index.

getStopSequencesBytes(int index)

public ByteString getStopSequencesBytes(int index)

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the stopSequences at the given index.

getStopSequencesCount()

public int getStopSequencesCount()

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of stopSequences.

getStopSequencesList()

public ProtocolStringList getStopSequencesList()

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ProtocolStringList`	A list containing the stopSequences.

getTemperature()

public float getTemperature()

Optional. Controls the randomness of predictions.

optional float temperature = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`float`	The temperature.

getTopK()

public float getTopK()

Optional. If specified, top-k sampling will be used.

optional float top_k = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`float`	The topK.

getTopP()

public float getTopP()

Optional. If specified, nucleus sampling will be used.

optional float top_p = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`float`	The topP.

hasCandidateCount()

public boolean hasCandidateCount()

Optional. Number of candidates to generate.

optional int32 candidate_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the candidateCount field is set.

hasMaxOutputTokens()

public boolean hasMaxOutputTokens()

Optional. The maximum number of output tokens to generate per message.

optional int32 max_output_tokens = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the maxOutputTokens field is set.

hasTemperature()

public boolean hasTemperature()

Optional. Controls the randomness of predictions.

optional float temperature = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the temperature field is set.

hasTopK()

public boolean hasTopK()

Optional. If specified, top-k sampling will be used.

optional float top_k = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the topK field is set.

hasTopP()

public boolean hasTopP()

Optional. If specified, nucleus sampling will be used.

optional float top_p = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the topP field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(GenerationConfig other)

public GenerationConfig.Builder mergeFrom(GenerationConfig other)

Parameter
Name	Description
`other`	`GenerationConfig`

Returns
Type	Description
`GenerationConfig.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerationConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public GenerationConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerationConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCandidateCount(int value)

public GenerationConfig.Builder setCandidateCount(int value)

Optional. Number of candidates to generate.

optional int32 candidate_count = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`int` The candidateCount to set.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GenerationConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMaxOutputTokens(int value)

public GenerationConfig.Builder setMaxOutputTokens(int value)

Optional. The maximum number of output tokens to generate per message.

optional int32 max_output_tokens = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`int` The maxOutputTokens to set.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStopSequences(int index, String value)

public GenerationConfig.Builder setStopSequences(int index, String value)

Optional. Stop sequences.

repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The stopSequences to set.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

setTemperature(float value)

public GenerationConfig.Builder setTemperature(float value)

Optional. Controls the randomness of predictions.

optional float temperature = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`float` The temperature to set.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

setTopK(float value)

public GenerationConfig.Builder setTopK(float value)

Optional. If specified, top-k sampling will be used.

optional float top_k = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`float` The topK to set.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

setTopP(float value)

public GenerationConfig.Builder setTopP(float value)

Optional. If specified, nucleus sampling will be used.

optional float top_p = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`float` The topP to set.

Returns
Type	Description
`GenerationConfig.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerationConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`GenerationConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)