Class GenerationConfig.Builder (3.86.0) 

public static final class GenerationConfig.Builder extends GeneratedMessage.Builder<GenerationConfig.Builder> implements GenerationConfigOrBuilder

Generation config.

Protobuf type google.cloud.aiplatform.v1.GenerationConfig

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > GenerationConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllResponseModalities(Iterable<? extends GenerationConfig.Modality> values)

public GenerationConfig.Builder addAllResponseModalities(Iterable<? extends GenerationConfig.Modality> values)

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.GenerationConfig.Modality>

The responseModalities to add.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

addAllResponseModalitiesValue(Iterable<Integer> values)

public GenerationConfig.Builder addAllResponseModalitiesValue(Iterable<Integer> values)

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

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for responseModalities to add.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

addAllStopSequences(Iterable<String> values)

public GenerationConfig.Builder addAllStopSequences(Iterable<String> values)

Optional. Stop sequences.

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

Parameter
Name Description
values Iterable<String>

The stopSequences to add.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

addResponseModalities(GenerationConfig.Modality value)

public GenerationConfig.Builder addResponseModalities(GenerationConfig.Modality value)

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

Parameter
Name Description
value GenerationConfig.Modality

The responseModalities to add.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

addResponseModalitiesValue(int value)

public GenerationConfig.Builder addResponseModalitiesValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for responseModalities to add.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

addStopSequences(String value)

public GenerationConfig.Builder addStopSequences(String value)

Optional. Stop sequences.

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

Parameter
Name Description
value String

The stopSequences to add.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

addStopSequencesBytes(ByteString value)

public GenerationConfig.Builder addStopSequencesBytes(ByteString value)

Optional. Stop sequences.

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

Parameter
Name Description
value ByteString

The bytes of the stopSequences to add.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

build()

public GenerationConfig build()
Returns
Type Description
GenerationConfig

buildPartial()

public GenerationConfig buildPartial()
Returns
Type Description
GenerationConfig

clear()

public GenerationConfig.Builder clear()
Returns
Type Description
GenerationConfig.Builder
Overrides

clearAudioTimestamp()

public GenerationConfig.Builder clearAudioTimestamp()

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
GenerationConfig.Builder

This builder for chaining.

clearCandidateCount()

public GenerationConfig.Builder clearCandidateCount()

Optional. Number of candidates to generate.

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearFrequencyPenalty()

public GenerationConfig.Builder clearFrequencyPenalty()

Optional. Frequency penalties.

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearImageConfig()

public GenerationConfig.Builder clearImageConfig()

Optional. Config for image generation features.

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

Returns
Type Description
GenerationConfig.Builder

clearLogprobs()

public GenerationConfig.Builder clearLogprobs()

Optional. Logit probabilities.

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearMaxOutputTokens()

public GenerationConfig.Builder clearMaxOutputTokens()

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
GenerationConfig.Builder

This builder for chaining.

clearMediaResolution()

public GenerationConfig.Builder clearMediaResolution()

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

This builder for chaining.

clearPresencePenalty()

public GenerationConfig.Builder clearPresencePenalty()

Optional. Positive penalties.

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearResponseJsonSchema()

public GenerationConfig.Builder clearResponseJsonSchema()

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
GenerationConfig.Builder

clearResponseLogprobs()

public GenerationConfig.Builder clearResponseLogprobs()

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

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearResponseMimeType()

public GenerationConfig.Builder clearResponseMimeType()

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
GenerationConfig.Builder

This builder for chaining.

clearResponseModalities()

public GenerationConfig.Builder clearResponseModalities()

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearResponseSchema()

public GenerationConfig.Builder clearResponseSchema()

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

Returns
Type Description
GenerationConfig.Builder

clearRoutingConfig()

public GenerationConfig.Builder clearRoutingConfig()

Optional. Routing configuration.

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

Returns
Type Description
GenerationConfig.Builder

clearSeed()

public GenerationConfig.Builder clearSeed()

Optional. Seed.

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearSpeechConfig()

public GenerationConfig.Builder clearSpeechConfig()

Optional. The speech generation config.

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

Returns
Type Description
GenerationConfig.Builder

clearStopSequences()

public GenerationConfig.Builder clearStopSequences()

Optional. Stop sequences.

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearTemperature()

public GenerationConfig.Builder clearTemperature()

Optional. Controls the randomness of predictions.

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearThinkingConfig()

public GenerationConfig.Builder clearThinkingConfig()

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

Returns
Type Description
GenerationConfig.Builder

clearTopK()

public GenerationConfig.Builder clearTopK()

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

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

clearTopP()

public GenerationConfig.Builder clearTopP()

Optional. If specified, nucleus sampling will be used.

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

Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getImageConfigBuilder()

public ImageConfig.Builder getImageConfigBuilder()

Optional. Config for image generation features.

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

Returns
Type Description
ImageConfig.Builder

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

The enum numeric value on the wire for mediaResolution.

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.

getResponseJsonSchemaBuilder()

public Value.Builder getResponseJsonSchemaBuilder()

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
Builder

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.

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

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
GenerationConfig.Modality

The responseModalities at the given index.

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

Returns
Type Description
int

The count of responseModalities.

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

Returns
Type Description
List<Modality>

A list containing the responseModalities.

getResponseModalitiesValue(int index)

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

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of 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];

Returns
Type Description
List<Integer>

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

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

Returns
Type Description
Schema

The responseSchema.

getResponseSchemaBuilder()

public Schema.Builder getResponseSchemaBuilder()

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

Returns
Type Description
Schema.Builder

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

Returns
Type Description
SchemaOrBuilder

getRoutingConfig()

public GenerationConfig.RoutingConfig getRoutingConfig()

Optional. Routing configuration.

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

Returns
Type Description
GenerationConfig.RoutingConfig

The routingConfig.

getRoutingConfigBuilder()

public GenerationConfig.RoutingConfig.Builder getRoutingConfigBuilder()

Optional. Routing configuration.

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

Returns
Type Description
GenerationConfig.RoutingConfig.Builder

getRoutingConfigOrBuilder()

public GenerationConfig.RoutingConfigOrBuilder getRoutingConfigOrBuilder()

Optional. Routing configuration.

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

Returns
Type Description
GenerationConfig.RoutingConfigOrBuilder

getSeed()

public int getSeed()

Optional. Seed.

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

Returns
Type Description
int

The seed.

getSpeechConfig()

public SpeechConfig getSpeechConfig()

Optional. The speech generation config.

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

Returns
Type Description
SpeechConfig

The speechConfig.

getSpeechConfigBuilder()

public SpeechConfig.Builder getSpeechConfigBuilder()

Optional. The speech generation config.

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

Returns
Type Description
SpeechConfig.Builder

getSpeechConfigOrBuilder()

public SpeechConfigOrBuilder getSpeechConfigOrBuilder()

Optional. The speech generation config.

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

Returns
Type Description
SpeechConfigOrBuilder

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.

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

Returns
Type Description
GenerationConfig.ThinkingConfig

The thinkingConfig.

getThinkingConfigBuilder()

public GenerationConfig.ThinkingConfig.Builder getThinkingConfigBuilder()

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

Returns
Type Description
GenerationConfig.ThinkingConfig.Builder

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

Returns
Type Description
GenerationConfig.ThinkingConfigOrBuilder

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.

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

Returns
Type Description
boolean

Whether the audioTimestamp field is set.

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.

hasImageConfig()

public boolean hasImageConfig()

Optional. Config for image generation features.

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

Returns
Type Description
boolean

Whether the imageConfig field is set.

hasLogprobs()

public boolean hasLogprobs()

Optional. Logit probabilities.

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

Returns
Type Description
boolean

Whether the logprobs 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.

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

Returns
Type Description
boolean

Whether the mediaResolution 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.

hasResponseJsonSchema()

public boolean hasResponseJsonSchema()

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
boolean

Whether the responseJsonSchema field is set.

hasResponseLogprobs()

public boolean hasResponseLogprobs()

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

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

Returns
Type Description
boolean

Whether the responseLogprobs field is set.

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

Returns
Type Description
boolean

Whether the responseSchema field is set.

hasRoutingConfig()

public boolean hasRoutingConfig()

Optional. Routing configuration.

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

Returns
Type Description
boolean

Whether the routingConfig field is set.

hasSeed()

public boolean hasSeed()

Optional. Seed.

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

Returns
Type Description
boolean

Whether the seed field is set.

hasSpeechConfig()

public boolean hasSpeechConfig()

Optional. The speech generation config.

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

Returns
Type Description
boolean

Whether the speechConfig 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.

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

Returns
Type Description
boolean

Whether the thinkingConfig 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GenerationConfig other)

public GenerationConfig.Builder mergeFrom(GenerationConfig other)
Parameter
Name Description
other GenerationConfig
Returns
Type Description
GenerationConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerationConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerationConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GenerationConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GenerationConfig.Builder
Overrides

mergeImageConfig(ImageConfig value)

public GenerationConfig.Builder mergeImageConfig(ImageConfig value)

Optional. Config for image generation features.

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

Parameter
Name Description
value ImageConfig
Returns
Type Description
GenerationConfig.Builder

mergeResponseJsonSchema(Value value)

public GenerationConfig.Builder mergeResponseJsonSchema(Value value)

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

Parameter
Name Description
value Value
Returns
Type Description
GenerationConfig.Builder

mergeResponseSchema(Schema value)

public GenerationConfig.Builder mergeResponseSchema(Schema value)

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

Parameter
Name Description
value Schema
Returns
Type Description
GenerationConfig.Builder

mergeRoutingConfig(GenerationConfig.RoutingConfig value)

public GenerationConfig.Builder mergeRoutingConfig(GenerationConfig.RoutingConfig value)

Optional. Routing configuration.

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

Parameter
Name Description
value GenerationConfig.RoutingConfig
Returns
Type Description
GenerationConfig.Builder

mergeSpeechConfig(SpeechConfig value)

public GenerationConfig.Builder mergeSpeechConfig(SpeechConfig value)

Optional. The speech generation config.

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

Parameter
Name Description
value SpeechConfig
Returns
Type Description
GenerationConfig.Builder

mergeThinkingConfig(GenerationConfig.ThinkingConfig value)

public GenerationConfig.Builder mergeThinkingConfig(GenerationConfig.ThinkingConfig value)

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

Parameter
Name Description
value GenerationConfig.ThinkingConfig
Returns
Type Description
GenerationConfig.Builder

setAudioTimestamp(boolean value)

public GenerationConfig.Builder setAudioTimestamp(boolean value)

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

Parameter
Name Description
value boolean

The audioTimestamp to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setCandidateCount(int value)

public GenerationConfig.Builder setCandidateCount(int value)

Optional. Number of candidates to generate.

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

Parameter
Name Description
value int

The candidateCount to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setFrequencyPenalty(float value)

public GenerationConfig.Builder setFrequencyPenalty(float value)

Optional. Frequency penalties.

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

Parameter
Name Description
value float

The frequencyPenalty to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setImageConfig(ImageConfig value)

public GenerationConfig.Builder setImageConfig(ImageConfig value)

Optional. Config for image generation features.

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

Parameter
Name Description
value ImageConfig
Returns
Type Description
GenerationConfig.Builder

setImageConfig(ImageConfig.Builder builderForValue)

public GenerationConfig.Builder setImageConfig(ImageConfig.Builder builderForValue)

Optional. Config for image generation features.

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

Parameter
Name Description
builderForValue ImageConfig.Builder
Returns
Type Description
GenerationConfig.Builder

setLogprobs(int value)

public GenerationConfig.Builder setLogprobs(int value)

Optional. Logit probabilities.

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

Parameter
Name Description
value int

The logprobs to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setMaxOutputTokens(int value)

public GenerationConfig.Builder setMaxOutputTokens(int value)

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

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

Parameter
Name Description
value int

The maxOutputTokens to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setMediaResolution(GenerationConfig.MediaResolution value)

public GenerationConfig.Builder setMediaResolution(GenerationConfig.MediaResolution value)

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

Parameter
Name Description
value GenerationConfig.MediaResolution

The mediaResolution to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setMediaResolutionValue(int value)

public GenerationConfig.Builder setMediaResolutionValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for mediaResolution to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setPresencePenalty(float value)

public GenerationConfig.Builder setPresencePenalty(float value)

Optional. Positive penalties.

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

Parameter
Name Description
value float

The presencePenalty to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setResponseJsonSchema(Value value)

public GenerationConfig.Builder setResponseJsonSchema(Value value)

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

Parameter
Name Description
value Value
Returns
Type Description
GenerationConfig.Builder

setResponseJsonSchema(Value.Builder builderForValue)

public GenerationConfig.Builder setResponseJsonSchema(Value.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GenerationConfig.Builder

setResponseLogprobs(boolean value)

public GenerationConfig.Builder setResponseLogprobs(boolean value)

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

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

Parameter
Name Description
value boolean

The responseLogprobs to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setResponseMimeType(String value)

public GenerationConfig.Builder setResponseMimeType(String value)

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

Parameter
Name Description
value String

The responseMimeType to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setResponseMimeTypeBytes(ByteString value)

public GenerationConfig.Builder setResponseMimeTypeBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for responseMimeType to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setResponseModalities(int index, GenerationConfig.Modality value)

public GenerationConfig.Builder setResponseModalities(int index, GenerationConfig.Modality value)

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

Parameters
Name Description
index int

The index to set the value at.
value GenerationConfig.Modality

The responseModalities to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setResponseModalitiesValue(int index, int value)

public GenerationConfig.Builder setResponseModalitiesValue(int index, int value)

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

Parameters
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for responseModalities to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setResponseSchema(Schema value)

public GenerationConfig.Builder setResponseSchema(Schema value)

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

Parameter
Name Description
value Schema
Returns
Type Description
GenerationConfig.Builder

setResponseSchema(Schema.Builder builderForValue)

public GenerationConfig.Builder setResponseSchema(Schema.Builder builderForValue)

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

Parameter
Name Description
builderForValue Schema.Builder
Returns
Type Description
GenerationConfig.Builder

setRoutingConfig(GenerationConfig.RoutingConfig value)

public GenerationConfig.Builder setRoutingConfig(GenerationConfig.RoutingConfig value)

Optional. Routing configuration.

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

Parameter
Name Description
value GenerationConfig.RoutingConfig
Returns
Type Description
GenerationConfig.Builder

setRoutingConfig(GenerationConfig.RoutingConfig.Builder builderForValue)

public GenerationConfig.Builder setRoutingConfig(GenerationConfig.RoutingConfig.Builder builderForValue)

Optional. Routing configuration.

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

Parameter
Name Description
builderForValue GenerationConfig.RoutingConfig.Builder
Returns
Type Description
GenerationConfig.Builder

setSeed(int value)

public GenerationConfig.Builder setSeed(int value)

Optional. Seed.

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

Parameter
Name Description
value int

The seed to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setSpeechConfig(SpeechConfig value)

public GenerationConfig.Builder setSpeechConfig(SpeechConfig value)

Optional. The speech generation config.

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

Parameter
Name Description
value SpeechConfig
Returns
Type Description
GenerationConfig.Builder

setSpeechConfig(SpeechConfig.Builder builderForValue)

public GenerationConfig.Builder setSpeechConfig(SpeechConfig.Builder builderForValue)

Optional. The speech generation config.

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

Parameter
Name Description
builderForValue SpeechConfig.Builder
Returns
Type Description
GenerationConfig.Builder

setStopSequences(int index, String value)

public GenerationConfig.Builder setStopSequences(int index, String value)

Optional. Stop sequences.

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

Parameters
Name Description
index int

The index to set the value at.
value String

The stopSequences to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setTemperature(float value)

public GenerationConfig.Builder setTemperature(float value)

Optional. Controls the randomness of predictions.

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

Parameter
Name Description
value float

The temperature to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setThinkingConfig(GenerationConfig.ThinkingConfig value)

public GenerationConfig.Builder setThinkingConfig(GenerationConfig.ThinkingConfig value)

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

Parameter
Name Description
value GenerationConfig.ThinkingConfig
Returns
Type Description
GenerationConfig.Builder

setThinkingConfig(GenerationConfig.ThinkingConfig.Builder builderForValue)

public GenerationConfig.Builder setThinkingConfig(GenerationConfig.ThinkingConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue GenerationConfig.ThinkingConfig.Builder
Returns
Type Description
GenerationConfig.Builder

setTopK(float value)

public GenerationConfig.Builder setTopK(float value)

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

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

Parameter
Name Description
value float

The topK to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.

setTopP(float value)

public GenerationConfig.Builder setTopP(float value)

Optional. If specified, nucleus sampling will be used.

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

Parameter
Name Description
value float

The topP to set.
Returns
Type Description
GenerationConfig.Builder

This builder for chaining.