Class GenerationConfig (1.5.0)

public final class GenerationConfig extends GeneratedMessageV3 implements GenerationConfigOrBuilder

Generation config.

Protobuf type google.cloud.vertexai.v1.GenerationConfig

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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()
Returns
Type Description
GenerationConfig

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()
Returns
Type Description
Parser<GenerationConfig>
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
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.

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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public GenerationConfig.Builder toBuilder()
Returns
Type Description
GenerationConfig.Builder

writeTo(CodedOutputStream output)

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