Class GenerationConfig (0.2.0)

public final class GenerationConfig extends GeneratedMessageV3 implements GenerationConfigOrBuilder

Generation config.

Protobuf type google.cloud.vertexai.v1beta1.GenerationConfig

Inheritance

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

Implements

GenerationConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CANDIDATE_COUNT_FIELD_NUMBER

public static final int CANDIDATE_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

ECHO_FIELD_NUMBER

public static final int ECHO_FIELD_NUMBER

Field Value
Type	Description
int

FREQUENCY_PENALTY_FIELD_NUMBER

public static final int FREQUENCY_PENALTY_FIELD_NUMBER

Field Value
Type	Description
int

LOGIT_BIAS_FIELD_NUMBER

public static final int LOGIT_BIAS_FIELD_NUMBER

Field Value
Type	Description
int

LOGPROBS_FIELD_NUMBER

public static final int LOGPROBS_FIELD_NUMBER

Field Value
Type	Description
int

MAX_OUTPUT_TOKENS_FIELD_NUMBER

public static final int MAX_OUTPUT_TOKENS_FIELD_NUMBER

Field Value
Type	Description
int

PRESENCE_PENALTY_FIELD_NUMBER

public static final int PRESENCE_PENALTY_FIELD_NUMBER

Field Value
Type	Description
int

STOP_SEQUENCES_FIELD_NUMBER

public static final int STOP_SEQUENCES_FIELD_NUMBER

Field Value
Type	Description
int

TEMPERATURE_FIELD_NUMBER

public static final int TEMPERATURE_FIELD_NUMBER

Field Value
Type	Description
int

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER

Field Value
Type	Description
int

TOP_P_FIELD_NUMBER

public static final int TOP_P_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static GenerationConfig getDefaultInstance()

Returns
Type	Description
GenerationConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static GenerationConfig.Builder newBuilder()

Returns
Type	Description
GenerationConfig.Builder

newBuilder(GenerationConfig prototype)

public static GenerationConfig.Builder newBuilder(GenerationConfig prototype)

Parameter
Name	Description
prototype	GenerationConfig

Returns
Type	Description
GenerationConfig.Builder

parseDelimitedFrom(InputStream input)

public static GenerationConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static GenerationConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GenerationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GenerationConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GenerationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GenerationConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static GenerationConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static GenerationConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GenerationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<GenerationConfig> parser()

Returns
Type	Description
Parser<GenerationConfig>

Methods

containsLogitBias(String key)

public boolean containsLogitBias(String key)

Optional. Logit bias.

map<string, float> logit_bias = 10 [(.google.api.field_behavior) = OPTIONAL];

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

AbstractMessage.equals(Object other)

getCandidateCount()

public int getCandidateCount()

Optional. Number of candidates to generate.

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

Returns
Type	Description
int	The candidateCount.

getDefaultInstanceForType()

public GenerationConfig getDefaultInstanceForType()

Returns
Type	Description
GenerationConfig

getEcho()

public boolean getEcho()

Optional. Echo.

bool echo = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The echo.

getFrequencyPenalty()

public float getFrequencyPenalty()

Optional. Frequency penalties.

float frequency_penalty = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
float	The frequencyPenalty.

getLogitBias() (deprecated)

public Map<String,Float> getLogitBias()

Use #getLogitBiasMap() instead.

Returns
Type	Description
Map<String,Float>

getLogitBiasCount()

public int getLogitBiasCount()

Optional. Logit bias.

map<string, float> logit_bias = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getLogitBiasMap()

public Map<String,Float> getLogitBiasMap()

Optional. Logit bias.

map<string, float> logit_bias = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,Float>

getLogitBiasOrDefault(String key, float defaultValue)

public float getLogitBiasOrDefault(String key, float defaultValue)

Optional. Logit bias.

map<string, float> logit_bias = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	float

Returns
Type	Description
float

getLogitBiasOrThrow(String key)

public float getLogitBiasOrThrow(String key)

Optional. Logit bias.

map<string, float> logit_bias = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
float

getLogprobs()

public int getLogprobs()

Optional. Logit probabilities.

int32 logprobs = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The logprobs.

getMaxOutputTokens()

public int getMaxOutputTokens()

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

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

Returns
Type	Description
int	The maxOutputTokens.

getParserForType()

public Parser<GenerationConfig> getParserForType()

Returns
Type	Description
Parser<GenerationConfig>

Overrides

GeneratedMessageV3.getParserForType()

getPresencePenalty()

public float getPresencePenalty()

Optional. Positive penalties.

float presence_penalty = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
float	The presencePenalty.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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.

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.

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

Returns
Type	Description
float	The topP.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public GenerationConfig.Builder newBuilderForType()

Returns
Type	Description
GenerationConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GenerationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
GenerationConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public GenerationConfig.Builder toBuilder()

Returns
Type	Description
GenerationConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException