Class GenerationConfig (1.3.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 1.3.0keyboard_arrow_down
public final class GenerationConfig extends GeneratedMessageV3 implements GenerationConfigOrBuilder
Generation config.
Protobuf type google.cloud.vertexai.v1.GenerationConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CANDIDATE_COUNT_FIELD_NUMBER
public static final int CANDIDATE_COUNT_FIELD_NUMBER
Field Value
Type Description
int
FREQUENCY_PENALTY_FIELD_NUMBER
public static final int FREQUENCY_PENALTY_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
RESPONSE_MIME_TYPE_FIELD_NUMBER
public static final int RESPONSE_MIME_TYPE_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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static GenerationConfig . Builder newBuilder ()
newBuilder(GenerationConfig prototype)
public static GenerationConfig . Builder newBuilder ( GenerationConfig prototype )
public static GenerationConfig parseDelimitedFrom ( InputStream input )
public static GenerationConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static GenerationConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GenerationConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static GenerationConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GenerationConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static GenerationConfig parseFrom ( CodedInputStream input )
public static GenerationConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static GenerationConfig parseFrom ( InputStream input )
public static GenerationConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static GenerationConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GenerationConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<GenerationConfig> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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 ()
getFrequencyPenalty()
public float getFrequencyPenalty ()
Optional. Frequency penalties.
optional float frequency_penalty = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The frequencyPenalty.
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.
getParserForType()
public Parser<GenerationConfig> getParserForType ()
Overrides
getPresencePenalty()
public float getPresencePenalty ()
Optional. Positive penalties.
optional float presence_penalty = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The presencePenalty.
getResponseMimeType()
public String getResponseMimeType ()
Optional. Output response mimetype of the generated candidate text.
Supported mimetype:
text/plain: (default) Text output.application/json: JSON response in the candidates.
The model needs to be prompted to output the appropriate response type,
otherwise the behavior is undefined.
This is a preview feature.
string response_mime_type = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The responseMimeType.
getResponseMimeTypeBytes()
public ByteString getResponseMimeTypeBytes ()
Optional. Output response mimetype of the generated candidate text.
Supported mimetype:
text/plain: (default) Text output.application/json: JSON response in the candidates.
The model needs to be prompted to output the appropriate response type,
otherwise the behavior is undefined.
This is a preview feature.
string response_mime_type = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for responseMimeType.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getStopSequences(int index)
public String getStopSequences ( int index )
Optional. Stop sequences.
repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint 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
indexint 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];
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()
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()
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.
hasFrequencyPenalty()
public boolean hasFrequencyPenalty ()
Optional. Frequency penalties.
optional float frequency_penalty = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the frequencyPenalty 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.
hasPresencePenalty()
public boolean hasPresencePenalty ()
Optional. Positive penalties.
optional float presence_penalty = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the presencePenalty 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()
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()
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public GenerationConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GenerationConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public GenerationConfig . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-30 UTC."],[],[],null,[]]
