com.google.cloud.aiplatform.v1

Class GenerationConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1.GenerationConfig

All Implemented Interfaces:

GenerationConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class GenerationConfig
extends com.google.protobuf.GeneratedMessage
implements GenerationConfigOrBuilder

 Generation config.
 

Protobuf type google.cloud.aiplatform.v1.GenerationConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerationConfig.Builder Generation config.
static class	GenerationConfig.MediaResolution Media resolution for the input media.
static class	GenerationConfig.Modality The modalities of the response.
static class	GenerationConfig.RoutingConfig The configuration for routing the request to a specific model.
static interface	GenerationConfig.RoutingConfigOrBuilder
static class	GenerationConfig.ThinkingConfig Config for thinking features.
static interface	GenerationConfig.ThinkingConfigOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUDIO_TIMESTAMP_FIELD_NUMBER
static int	CANDIDATE_COUNT_FIELD_NUMBER
static int	FREQUENCY_PENALTY_FIELD_NUMBER
static int	IMAGE_CONFIG_FIELD_NUMBER
static int	LOGPROBS_FIELD_NUMBER
static int	MAX_OUTPUT_TOKENS_FIELD_NUMBER
static int	MEDIA_RESOLUTION_FIELD_NUMBER
static int	PRESENCE_PENALTY_FIELD_NUMBER
static int	RESPONSE_JSON_SCHEMA_FIELD_NUMBER
static int	RESPONSE_LOGPROBS_FIELD_NUMBER
static int	RESPONSE_MIME_TYPE_FIELD_NUMBER
static int	RESPONSE_MODALITIES_FIELD_NUMBER
static int	RESPONSE_SCHEMA_FIELD_NUMBER
static int	ROUTING_CONFIG_FIELD_NUMBER
static int	SEED_FIELD_NUMBER
static int	SPEECH_CONFIG_FIELD_NUMBER
static int	STOP_SEQUENCES_FIELD_NUMBER
static int	TEMPERATURE_FIELD_NUMBER
static int	THINKING_CONFIG_FIELD_NUMBER
static int	TOP_K_FIELD_NUMBER
static int	TOP_P_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAudioTimestamp() Optional.
int	getCandidateCount() Optional.
static GenerationConfig	getDefaultInstance()
GenerationConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
float	getFrequencyPenalty() Optional.
ImageConfig	getImageConfig() Optional.
ImageConfigOrBuilder	getImageConfigOrBuilder() Optional.
int	getLogprobs() Optional.
int	getMaxOutputTokens() Optional.
GenerationConfig.MediaResolution	getMediaResolution() Optional.
int	getMediaResolutionValue() Optional.
com.google.protobuf.Parser<GenerationConfig>	getParserForType()
float	getPresencePenalty() Optional.
com.google.protobuf.Value	getResponseJsonSchema() Optional.
com.google.protobuf.ValueOrBuilder	getResponseJsonSchemaOrBuilder() Optional.
boolean	getResponseLogprobs() Optional.
String	getResponseMimeType() Optional.
com.google.protobuf.ByteString	getResponseMimeTypeBytes() Optional.
GenerationConfig.Modality	getResponseModalities(int index) Optional.
int	getResponseModalitiesCount() Optional.
List<GenerationConfig.Modality>	getResponseModalitiesList() Optional.
int	getResponseModalitiesValue(int index) Optional.
List<Integer>	getResponseModalitiesValueList() Optional.
Schema	getResponseSchema() Optional.
SchemaOrBuilder	getResponseSchemaOrBuilder() Optional.
GenerationConfig.RoutingConfig	getRoutingConfig() Optional.
GenerationConfig.RoutingConfigOrBuilder	getRoutingConfigOrBuilder() Optional.
int	getSeed() Optional.
int	getSerializedSize()
SpeechConfig	getSpeechConfig() Optional.
SpeechConfigOrBuilder	getSpeechConfigOrBuilder() Optional.
String	getStopSequences(int index) Optional.
com.google.protobuf.ByteString	getStopSequencesBytes(int index) Optional.
int	getStopSequencesCount() Optional.
com.google.protobuf.ProtocolStringList	getStopSequencesList() Optional.
float	getTemperature() Optional.
GenerationConfig.ThinkingConfig	getThinkingConfig() Optional.
GenerationConfig.ThinkingConfigOrBuilder	getThinkingConfigOrBuilder() Optional.
float	getTopK() Optional.
float	getTopP() Optional.
boolean	hasAudioTimestamp() Optional.
boolean	hasCandidateCount() Optional.
boolean	hasFrequencyPenalty() Optional.
int	hashCode()
boolean	hasImageConfig() Optional.
boolean	hasLogprobs() Optional.
boolean	hasMaxOutputTokens() Optional.
boolean	hasMediaResolution() Optional.
boolean	hasPresencePenalty() Optional.
boolean	hasResponseJsonSchema() Optional.
boolean	hasResponseLogprobs() Optional.
boolean	hasResponseSchema() Optional.
boolean	hasRoutingConfig() Optional.
boolean	hasSeed() Optional.
boolean	hasSpeechConfig() Optional.
boolean	hasTemperature() Optional.
boolean	hasThinkingConfig() Optional.
boolean	hasTopK() Optional.
boolean	hasTopP() Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerationConfig.Builder	newBuilder()
static GenerationConfig.Builder	newBuilder(GenerationConfig prototype)
GenerationConfig.Builder	newBuilderForType()
protected GenerationConfig.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static GenerationConfig	parseDelimitedFrom(InputStream input)
static GenerationConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(byte[] data)
static GenerationConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(ByteBuffer data)
static GenerationConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(com.google.protobuf.ByteString data)
static GenerationConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerationConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(InputStream input)
static GenerationConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerationConfig>	parser()
GenerationConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TEMPERATURE_FIELD_NUMBER

public static final int TEMPERATURE_FIELD_NUMBER

See Also:

Constant Field Values

TOP_P_FIELD_NUMBER

public static final int TOP_P_FIELD_NUMBER

See Also:

Constant Field Values

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER

See Also:

Constant Field Values

CANDIDATE_COUNT_FIELD_NUMBER

public static final int CANDIDATE_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

MAX_OUTPUT_TOKENS_FIELD_NUMBER

public static final int MAX_OUTPUT_TOKENS_FIELD_NUMBER

See Also:

Constant Field Values

STOP_SEQUENCES_FIELD_NUMBER

public static final int STOP_SEQUENCES_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_LOGPROBS_FIELD_NUMBER

public static final int RESPONSE_LOGPROBS_FIELD_NUMBER

See Also:

Constant Field Values

LOGPROBS_FIELD_NUMBER

public static final int LOGPROBS_FIELD_NUMBER

See Also:

Constant Field Values

PRESENCE_PENALTY_FIELD_NUMBER

public static final int PRESENCE_PENALTY_FIELD_NUMBER

See Also:

Constant Field Values

FREQUENCY_PENALTY_FIELD_NUMBER

public static final int FREQUENCY_PENALTY_FIELD_NUMBER

See Also:

Constant Field Values

SEED_FIELD_NUMBER

public static final int SEED_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_MIME_TYPE_FIELD_NUMBER

public static final int RESPONSE_MIME_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_SCHEMA_FIELD_NUMBER

public static final int RESPONSE_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_JSON_SCHEMA_FIELD_NUMBER

public static final int RESPONSE_JSON_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

ROUTING_CONFIG_FIELD_NUMBER

public static final int ROUTING_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

AUDIO_TIMESTAMP_FIELD_NUMBER

public static final int AUDIO_TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_MODALITIES_FIELD_NUMBER

public static final int RESPONSE_MODALITIES_FIELD_NUMBER

See Also:

Constant Field Values

MEDIA_RESOLUTION_FIELD_NUMBER

public static final int MEDIA_RESOLUTION_FIELD_NUMBER

See Also:

Constant Field Values

SPEECH_CONFIG_FIELD_NUMBER

public static final int SPEECH_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

THINKING_CONFIG_FIELD_NUMBER

public static final int THINKING_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

IMAGE_CONFIG_FIELD_NUMBER

public static final int IMAGE_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

hasTemperature

public boolean hasTemperature()

 Optional. Controls the randomness of predictions.
 

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

Specified by:

hasTemperature in interface GenerationConfigOrBuilder

Returns:

Whether the temperature field is set.

getTemperature

public float getTemperature()

 Optional. Controls the randomness of predictions.
 

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

Specified by:

getTemperature in interface GenerationConfigOrBuilder

Returns:

The temperature.

hasTopP

public boolean hasTopP()

 Optional. If specified, nucleus sampling will be used.
 

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

Specified by:

hasTopP in interface GenerationConfigOrBuilder

Returns:

Whether the topP field is set.

getTopP

public float getTopP()

 Optional. If specified, nucleus sampling will be used.
 

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

Specified by:

getTopP in interface GenerationConfigOrBuilder

Returns:

The topP.

hasTopK

public boolean hasTopK()

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

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

Specified by:

hasTopK in interface GenerationConfigOrBuilder

Returns:

Whether the topK field is set.

getTopK

public float getTopK()

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

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

Specified by:

getTopK in interface GenerationConfigOrBuilder

Returns:

The topK.

hasCandidateCount

public boolean hasCandidateCount()

 Optional. Number of candidates to generate.
 

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

Specified by:

hasCandidateCount in interface GenerationConfigOrBuilder

Returns:

Whether the candidateCount field is set.

getCandidateCount

public int getCandidateCount()

 Optional. Number of candidates to generate.
 

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

Specified by:

getCandidateCount in interface GenerationConfigOrBuilder

Returns:

The candidateCount.

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];

Specified by:

hasMaxOutputTokens in interface GenerationConfigOrBuilder

Returns:

Whether the maxOutputTokens field is set.

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];

Specified by:

getMaxOutputTokens in interface GenerationConfigOrBuilder

Returns:

The maxOutputTokens.

getStopSequencesList

public com.google.protobuf.ProtocolStringList getStopSequencesList()

 Optional. Stop sequences.
 

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

Specified by:

getStopSequencesList in interface GenerationConfigOrBuilder

Returns:

A list containing the stopSequences.

getStopSequencesCount

public int getStopSequencesCount()

 Optional. Stop sequences.
 

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

Specified by:

getStopSequencesCount in interface GenerationConfigOrBuilder

Returns:

The count of stopSequences.

getStopSequences

public String getStopSequences(int index)

 Optional. Stop sequences.
 

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

Specified by:

getStopSequences in interface GenerationConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The stopSequences at the given index.

getStopSequencesBytes

public com.google.protobuf.ByteString getStopSequencesBytes(int index)

 Optional. Stop sequences.
 

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

Specified by:

getStopSequencesBytes in interface GenerationConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the stopSequences at the given index.

hasResponseLogprobs

public boolean hasResponseLogprobs()

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

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

Specified by:

hasResponseLogprobs in interface GenerationConfigOrBuilder

Returns:

Whether the responseLogprobs field is set.

getResponseLogprobs

public boolean getResponseLogprobs()

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

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

Specified by:

getResponseLogprobs in interface GenerationConfigOrBuilder

Returns:

The responseLogprobs.

hasLogprobs

public boolean hasLogprobs()

 Optional. Logit probabilities.
 

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

Specified by:

hasLogprobs in interface GenerationConfigOrBuilder

Returns:

Whether the logprobs field is set.

getLogprobs

public int getLogprobs()

 Optional. Logit probabilities.
 

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

Specified by:

getLogprobs in interface GenerationConfigOrBuilder

Returns:

The logprobs.

hasPresencePenalty

public boolean hasPresencePenalty()

 Optional. Positive penalties.
 

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

Specified by:

hasPresencePenalty in interface GenerationConfigOrBuilder

Returns:

Whether the presencePenalty field is set.

getPresencePenalty

public float getPresencePenalty()

 Optional. Positive penalties.
 

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

Specified by:

getPresencePenalty in interface GenerationConfigOrBuilder

Returns:

The presencePenalty.

hasFrequencyPenalty

public boolean hasFrequencyPenalty()

 Optional. Frequency penalties.
 

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

Specified by:

hasFrequencyPenalty in interface GenerationConfigOrBuilder

Returns:

Whether the frequencyPenalty field is set.

getFrequencyPenalty

public float getFrequencyPenalty()

 Optional. Frequency penalties.
 

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

Specified by:

getFrequencyPenalty in interface GenerationConfigOrBuilder

Returns:

The frequencyPenalty.

hasSeed

public boolean hasSeed()

 Optional. Seed.
 

optional int32 seed = 12 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasSeed in interface GenerationConfigOrBuilder

Returns:

Whether the seed field is set.

getSeed

public int getSeed()

 Optional. Seed.
 

optional int32 seed = 12 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSeed in interface GenerationConfigOrBuilder

Returns:

The seed.

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];

Specified by:

getResponseMimeType in interface GenerationConfigOrBuilder

Returns:

The responseMimeType.

getResponseMimeTypeBytes

public com.google.protobuf.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];

Specified by:

getResponseMimeTypeBytes in interface GenerationConfigOrBuilder

Returns:

The bytes for responseMimeType.

hasResponseSchema

public boolean hasResponseSchema()

 Optional. The `Schema` object allows the definition of input and output
 data types. These types can be objects, but also primitives and arrays.
 Represents a select subset of an [OpenAPI 3.0 schema
 object](https://spec.openapis.org/oas/v3.0.3#schema).
 If set, a compatible response_mime_type must also be set.
 Compatible mimetypes:
 `application/json`: Schema for JSON response.
 

optional .google.cloud.aiplatform.v1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasResponseSchema in interface GenerationConfigOrBuilder

Returns:

Whether the responseSchema field is set.

getResponseSchema

public Schema getResponseSchema()

 Optional. The `Schema` object allows the definition of input and output
 data types. These types can be objects, but also primitives and arrays.
 Represents a select subset of an [OpenAPI 3.0 schema
 object](https://spec.openapis.org/oas/v3.0.3#schema).
 If set, a compatible response_mime_type must also be set.
 Compatible mimetypes:
 `application/json`: Schema for JSON response.
 

optional .google.cloud.aiplatform.v1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseSchema in interface GenerationConfigOrBuilder

Returns:

The responseSchema.

getResponseSchemaOrBuilder

public SchemaOrBuilder getResponseSchemaOrBuilder()

 Optional. The `Schema` object allows the definition of input and output
 data types. These types can be objects, but also primitives and arrays.
 Represents a select subset of an [OpenAPI 3.0 schema
 object](https://spec.openapis.org/oas/v3.0.3#schema).
 If set, a compatible response_mime_type must also be set.
 Compatible mimetypes:
 `application/json`: Schema for JSON response.
 

optional .google.cloud.aiplatform.v1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseSchemaOrBuilder in interface GenerationConfigOrBuilder

hasResponseJsonSchema

public boolean hasResponseJsonSchema()

 Optional. Output schema of the generated response. This is an alternative
 to `response_schema` that accepts [JSON Schema](https://json-schema.org/).

 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];

Specified by:

hasResponseJsonSchema in interface GenerationConfigOrBuilder

Returns:

Whether the responseJsonSchema field is set.

getResponseJsonSchema

public com.google.protobuf.Value getResponseJsonSchema()

 Optional. Output schema of the generated response. This is an alternative
 to `response_schema` that accepts [JSON Schema](https://json-schema.org/).

 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];

Specified by:

getResponseJsonSchema in interface GenerationConfigOrBuilder

Returns:

The responseJsonSchema.

getResponseJsonSchemaOrBuilder

public com.google.protobuf.ValueOrBuilder getResponseJsonSchemaOrBuilder()

 Optional. Output schema of the generated response. This is an alternative
 to `response_schema` that accepts [JSON Schema](https://json-schema.org/).

 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];

Specified by:

getResponseJsonSchemaOrBuilder in interface GenerationConfigOrBuilder

hasRoutingConfig

public boolean hasRoutingConfig()

 Optional. Routing configuration.
 

optional .google.cloud.aiplatform.v1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRoutingConfig in interface GenerationConfigOrBuilder

Returns:

Whether the routingConfig field is set.

getRoutingConfig

public GenerationConfig.RoutingConfig getRoutingConfig()

 Optional. Routing configuration.
 

optional .google.cloud.aiplatform.v1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRoutingConfig in interface GenerationConfigOrBuilder

Returns:

The routingConfig.

getRoutingConfigOrBuilder

public GenerationConfig.RoutingConfigOrBuilder getRoutingConfigOrBuilder()

 Optional. Routing configuration.
 

optional .google.cloud.aiplatform.v1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRoutingConfigOrBuilder in interface GenerationConfigOrBuilder

hasAudioTimestamp

public boolean hasAudioTimestamp()

 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];

Specified by:

hasAudioTimestamp in interface GenerationConfigOrBuilder

Returns:

Whether the audioTimestamp field is set.

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];

Specified by:

getAudioTimestamp in interface GenerationConfigOrBuilder

Returns:

The audioTimestamp.

getResponseModalitiesList

public List<GenerationConfig.Modality> getResponseModalitiesList()

 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.
 

repeated .google.cloud.aiplatform.v1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseModalitiesList in interface GenerationConfigOrBuilder

Returns:

A list containing the responseModalities.

getResponseModalitiesCount

public int getResponseModalitiesCount()

 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.
 

repeated .google.cloud.aiplatform.v1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseModalitiesCount in interface GenerationConfigOrBuilder

Returns:

The count of responseModalities.

getResponseModalities

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.
 

repeated .google.cloud.aiplatform.v1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseModalities in interface GenerationConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The responseModalities at the given index.

getResponseModalitiesValueList

public List<Integer> getResponseModalitiesValueList()

 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.
 

repeated .google.cloud.aiplatform.v1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseModalitiesValueList in interface GenerationConfigOrBuilder

Returns:

A list containing the enum numeric values on the wire for responseModalities.

getResponseModalitiesValue

public int getResponseModalitiesValue(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.
 

repeated .google.cloud.aiplatform.v1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseModalitiesValue in interface GenerationConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of responseModalities at the given index.

hasMediaResolution

public boolean hasMediaResolution()

 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];

Specified by:

hasMediaResolution in interface GenerationConfigOrBuilder

Returns:

Whether the mediaResolution field is set.

getMediaResolutionValue

public int getMediaResolutionValue()

 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];

Specified by:

getMediaResolutionValue in interface GenerationConfigOrBuilder

Returns:

The enum numeric value on the wire for mediaResolution.

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];

Specified by:

getMediaResolution in interface GenerationConfigOrBuilder

Returns:

The mediaResolution.

hasSpeechConfig

public boolean hasSpeechConfig()

 Optional. The speech generation config.
 

optional .google.cloud.aiplatform.v1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasSpeechConfig in interface GenerationConfigOrBuilder

Returns:

Whether the speechConfig field is set.

getSpeechConfig

public SpeechConfig getSpeechConfig()

 Optional. The speech generation config.
 

optional .google.cloud.aiplatform.v1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSpeechConfig in interface GenerationConfigOrBuilder

Returns:

The speechConfig.

getSpeechConfigOrBuilder

public SpeechConfigOrBuilder getSpeechConfigOrBuilder()

 Optional. The speech generation config.
 

optional .google.cloud.aiplatform.v1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSpeechConfigOrBuilder in interface GenerationConfigOrBuilder

hasThinkingConfig

public boolean hasThinkingConfig()

 Optional. Config for thinking features.
 An error will be returned if this field is set for models that don't
 support thinking.
 

.google.cloud.aiplatform.v1.GenerationConfig.ThinkingConfig thinking_config = 25 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasThinkingConfig in interface GenerationConfigOrBuilder

Returns:

Whether the thinkingConfig field is set.

getThinkingConfig

public GenerationConfig.ThinkingConfig getThinkingConfig()

 Optional. Config for thinking features.
 An error will be returned if this field is set for models that don't
 support thinking.
 

.google.cloud.aiplatform.v1.GenerationConfig.ThinkingConfig thinking_config = 25 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getThinkingConfig in interface GenerationConfigOrBuilder

Returns:

The thinkingConfig.

getThinkingConfigOrBuilder

public GenerationConfig.ThinkingConfigOrBuilder getThinkingConfigOrBuilder()

 Optional. Config for thinking features.
 An error will be returned if this field is set for models that don't
 support thinking.
 

.google.cloud.aiplatform.v1.GenerationConfig.ThinkingConfig thinking_config = 25 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getThinkingConfigOrBuilder in interface GenerationConfigOrBuilder

hasImageConfig

public boolean hasImageConfig()

 Optional. Config for image generation features.
 

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

Specified by:

hasImageConfig in interface GenerationConfigOrBuilder

Returns:

Whether the imageConfig field is set.

getImageConfig

public ImageConfig getImageConfig()

 Optional. Config for image generation features.
 

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

Specified by:

getImageConfig in interface GenerationConfigOrBuilder

Returns:

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];

Specified by:

getImageConfigOrBuilder in interface GenerationConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GenerationConfig parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerationConfig parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerationConfig parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerationConfig parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerationConfig parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerationConfig parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerationConfig parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static GenerationConfig parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static GenerationConfig parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static GenerationConfig parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static GenerationConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static GenerationConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public GenerationConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerationConfig.Builder newBuilder()

newBuilder

public static GenerationConfig.Builder newBuilder(GenerationConfig prototype)

toBuilder

public GenerationConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerationConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static GenerationConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<GenerationConfig> parser()

getParserForType

public com.google.protobuf.Parser<GenerationConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public GenerationConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder