Class GenerationConfig (3.86.0)

public final class GenerationConfig extends GeneratedMessage implements GenerationConfigOrBuilder

Generation config.

Protobuf type google.cloud.aiplatform.v1.GenerationConfig

Inheritance

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

Implements

GenerationConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

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

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

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

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

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

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

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

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

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

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

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

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

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

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AUDIO_TIMESTAMP_FIELD_NUMBER

public static final int AUDIO_TIMESTAMP_FIELD_NUMBER

Field Value
Type	Description
`int`

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`

IMAGE_CONFIG_FIELD_NUMBER

public static final int IMAGE_CONFIG_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`

MEDIA_RESOLUTION_FIELD_NUMBER

public static final int MEDIA_RESOLUTION_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_JSON_SCHEMA_FIELD_NUMBER

public static final int RESPONSE_JSON_SCHEMA_FIELD_NUMBER

Field Value
Type	Description
`int`

RESPONSE_LOGPROBS_FIELD_NUMBER

public static final int RESPONSE_LOGPROBS_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`

RESPONSE_MODALITIES_FIELD_NUMBER

public static final int RESPONSE_MODALITIES_FIELD_NUMBER

Field Value
Type	Description
`int`

RESPONSE_SCHEMA_FIELD_NUMBER

public static final int RESPONSE_SCHEMA_FIELD_NUMBER

Field Value
Type	Description
`int`

ROUTING_CONFIG_FIELD_NUMBER

public static final int ROUTING_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

SEED_FIELD_NUMBER

public static final int SEED_FIELD_NUMBER

Field Value
Type	Description
`int`

SPEECH_CONFIG_FIELD_NUMBER

public static final int SPEECH_CONFIG_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`

THINKING_CONFIG_FIELD_NUMBER

public static final int THINKING_CONFIG_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

AbstractMessage.equals(Object other)

getAudioTimestamp()

public boolean getAudioTimestamp()

Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.

optional bool audio_timestamp = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The audioTimestamp.

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.

getImageConfig()

public ImageConfig getImageConfig()

Optional. Config for image generation features.

optional .google.cloud.aiplatform.v1.ImageConfig image_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ImageConfig`	The imageConfig.

getImageConfigOrBuilder()

public ImageConfigOrBuilder getImageConfigOrBuilder()

Optional. Config for image generation features.

optional .google.cloud.aiplatform.v1.ImageConfig image_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ImageConfigOrBuilder`

getLogprobs()

public int getLogprobs()

Optional. Logit probabilities.

optional 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.

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

Returns
Type	Description
`int`	The maxOutputTokens.

getMediaResolution()

public GenerationConfig.MediaResolution getMediaResolution()

Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.

optional .google.cloud.aiplatform.v1.GenerationConfig.MediaResolution media_resolution = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`GenerationConfig.MediaResolution`	The mediaResolution.

getMediaResolutionValue()

public int getMediaResolutionValue()

optional .google.cloud.aiplatform.v1.GenerationConfig.MediaResolution media_resolution = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for mediaResolution.

getParserForType()

public Parser<GenerationConfig> getParserForType()

Returns
Type	Description
`Parser<GenerationConfig>`

Overrides

GeneratedMessage.getParserForType()

getPresencePenalty()

public float getPresencePenalty()

Optional. Positive penalties.

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

Returns
Type	Description
`float`	The presencePenalty.

getResponseJsonSchema()

public Value getResponseJsonSchema()

Optional. Output schema of the generated response. This is an alternative to response_schema that accepts JSON Schema.

If set, response_schema must be omitted, but response_mime_type is required.

While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported:

$id
$defs
$ref
$anchor
type
format
title
description
enum (for strings and numbers)
items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
oneOf (interpreted the same as anyOf)
properties
additionalProperties
required

The non-standard propertyOrdering property may also be set.

Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $, may be set.

optional .google.protobuf.Value response_json_schema = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Value`	The responseJsonSchema.

getResponseJsonSchemaOrBuilder()

public ValueOrBuilder getResponseJsonSchemaOrBuilder()

Optional. Output schema of the generated response. This is an alternative to response_schema that accepts JSON Schema.

If set, response_schema must be omitted, but response_mime_type is required.

While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported:

$id
$defs
$ref
$anchor
type
format
title
description
enum (for strings and numbers)
items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
oneOf (interpreted the same as anyOf)
properties
additionalProperties
required

The non-standard propertyOrdering property may also be set.

Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $, may be set.

optional .google.protobuf.Value response_json_schema = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ValueOrBuilder`

getResponseLogprobs()

public boolean getResponseLogprobs()

Optional. If true, export the logprobs results in response.

optional bool response_logprobs = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The responseLogprobs.

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.

getResponseModalities(int index)

public GenerationConfig.Modality getResponseModalities(int index)

Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to [TEXT, IMAGE], the response will include both text and an image.