- 3.79.0 (latest)
- 3.77.0
- 3.76.0
- 3.75.0
- 3.74.0
- 3.73.0
- 3.71.0
- 3.69.0
- 3.68.0
- 3.65.0
- 3.64.0
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface GenerationConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAudioTimestamp()
public abstract boolean getAudioTimestamp()Optional. If enabled, audio timestamp will be included in the request to the model.
optional bool audio_timestamp = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The audioTimestamp. |
getCandidateCount()
public abstract int getCandidateCount()Optional. Number of candidates to generate.
optional int32 candidate_count = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The candidateCount. |
getFrequencyPenalty()
public abstract float getFrequencyPenalty()Optional. Frequency penalties.
optional float frequency_penalty = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The frequencyPenalty. |
getLogprobs()
public abstract int getLogprobs()Optional. Logit probabilities.
optional int32 logprobs = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The logprobs. |
getMaxOutputTokens()
public abstract 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 abstract GenerationConfig.MediaResolution getMediaResolution()Optional. If specified, the media resolution specified will be used.
optional .google.cloud.aiplatform.v1beta1.GenerationConfig.MediaResolution media_resolution = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GenerationConfig.MediaResolution |
The mediaResolution. |
getMediaResolutionValue()
public abstract int getMediaResolutionValue()Optional. If specified, the media resolution specified will be used.
optional .google.cloud.aiplatform.v1beta1.GenerationConfig.MediaResolution media_resolution = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for mediaResolution. |
getModelConfig()
public abstract GenerationConfig.ModelConfig getModelConfig()Optional. Config for model selection.
.google.cloud.aiplatform.v1beta1.GenerationConfig.ModelConfig model_config = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GenerationConfig.ModelConfig |
The modelConfig. |
getModelConfigOrBuilder()
public abstract GenerationConfig.ModelConfigOrBuilder getModelConfigOrBuilder()Optional. Config for model selection.
.google.cloud.aiplatform.v1beta1.GenerationConfig.ModelConfig model_config = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GenerationConfig.ModelConfigOrBuilder |
|
getPresencePenalty()
public abstract float getPresencePenalty()Optional. Positive penalties.
optional float presence_penalty = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The presencePenalty. |
getResponseJsonSchema()
public abstract 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$anchortypeformattitledescriptionenum(for strings and numbers)itemsprefixItemsminItemsmaxItemsminimummaximumanyOfoneOf(interpreted the same asanyOf)propertiesadditionalPropertiesrequiredThe non-standard
propertyOrderingproperty 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
$refis set on a sub-schema, no other properties, except for than those starting as a$, may be set.
optional .google.protobuf.Value response_json_schema = 28 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Value |
The responseJsonSchema. |
getResponseJsonSchemaOrBuilder()
public abstract 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$anchortypeformattitledescriptionenum(for strings and numbers)itemsprefixItemsminItemsmaxItemsminimummaximumanyOfoneOf(interpreted the same asanyOf)propertiesadditionalPropertiesrequiredThe non-standard
propertyOrderingproperty 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
$refis 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 abstract 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 abstract 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 abstract 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 abstract GenerationConfig.Modality getResponseModalities(int index)Optional. The modalities of the response.
repeated .google.cloud.aiplatform.v1beta1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
GenerationConfig.Modality |
The responseModalities at the given index. |
getResponseModalitiesCount()
public abstract int getResponseModalitiesCount()Optional. The modalities of the response.
repeated .google.cloud.aiplatform.v1beta1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of responseModalities. |
getResponseModalitiesList()
public abstract List<GenerationConfig.Modality> getResponseModalitiesList()Optional. The modalities of the response.
repeated .google.cloud.aiplatform.v1beta1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Modality> |
A list containing the responseModalities. |
getResponseModalitiesValue(int index)
public abstract int getResponseModalitiesValue(int index)Optional. The modalities of the response.
repeated .google.cloud.aiplatform.v1beta1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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 abstract List<Integer> getResponseModalitiesValueList()Optional. The modalities of the response.
repeated .google.cloud.aiplatform.v1beta1.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 abstract 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.v1beta1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Schema |
The responseSchema. |
getResponseSchemaOrBuilder()
public abstract 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.v1beta1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SchemaOrBuilder |
|
getRoutingConfig()
public abstract GenerationConfig.RoutingConfig getRoutingConfig()Optional. Routing configuration.
optional .google.cloud.aiplatform.v1beta1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GenerationConfig.RoutingConfig |
The routingConfig. |
getRoutingConfigOrBuilder()
public abstract GenerationConfig.RoutingConfigOrBuilder getRoutingConfigOrBuilder()Optional. Routing configuration.
optional .google.cloud.aiplatform.v1beta1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GenerationConfig.RoutingConfigOrBuilder |
|
getSeed()
public abstract int getSeed()Optional. Seed.
optional int32 seed = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The seed. |
getSpeechConfig()
public abstract SpeechConfig getSpeechConfig()Optional. The speech generation config.
optional .google.cloud.aiplatform.v1beta1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SpeechConfig |
The speechConfig. |
getSpeechConfigOrBuilder()
public abstract SpeechConfigOrBuilder getSpeechConfigOrBuilder()Optional. The speech generation config.
optional .google.cloud.aiplatform.v1beta1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SpeechConfigOrBuilder |
|
getStopSequences(int index)
public abstract String getStopSequences(int index)Optional. Stop sequences.
repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The stopSequences at the given index. |
getStopSequencesBytes(int index)
public abstract ByteString getStopSequencesBytes(int index)Optional. Stop sequences.
repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the stopSequences at the given index. |
getStopSequencesCount()
public abstract 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 abstract List<String> getStopSequencesList()Optional. Stop sequences.
repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the stopSequences. |
getTemperature()
public abstract 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 abstract 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.v1beta1.GenerationConfig.ThinkingConfig thinking_config = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GenerationConfig.ThinkingConfig |
The thinkingConfig. |
getThinkingConfigOrBuilder()
public abstract 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.v1beta1.GenerationConfig.ThinkingConfig thinking_config = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GenerationConfig.ThinkingConfigOrBuilder |
|
getTopK()
public abstract 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 abstract 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 abstract boolean hasAudioTimestamp()Optional. If enabled, audio timestamp will be included in the request to the model.
optional bool audio_timestamp = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the audioTimestamp field is set. |
hasCandidateCount()
public abstract 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 abstract 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. |
hasLogprobs()
public abstract 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 abstract 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 abstract boolean hasMediaResolution()Optional. If specified, the media resolution specified will be used.
optional .google.cloud.aiplatform.v1beta1.GenerationConfig.MediaResolution media_resolution = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mediaResolution field is set. |
hasModelConfig()
public abstract boolean hasModelConfig()Optional. Config for model selection.
.google.cloud.aiplatform.v1beta1.GenerationConfig.ModelConfig model_config = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the modelConfig field is set. |
hasPresencePenalty()
public abstract 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 abstract 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$anchortypeformattitledescriptionenum(for strings and numbers)itemsprefixItemsminItemsmaxItemsminimummaximumanyOfoneOf(interpreted the same asanyOf)propertiesadditionalPropertiesrequiredThe non-standard
propertyOrderingproperty 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
$refis 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 abstract 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 abstract 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.v1beta1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the responseSchema field is set. |
hasRoutingConfig()
public abstract boolean hasRoutingConfig()Optional. Routing configuration.
optional .google.cloud.aiplatform.v1beta1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the routingConfig field is set. |
hasSeed()
public abstract 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 abstract boolean hasSpeechConfig()Optional. The speech generation config.
optional .google.cloud.aiplatform.v1beta1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the speechConfig field is set. |
hasTemperature()
public abstract 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 abstract 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.v1beta1.GenerationConfig.ThinkingConfig thinking_config = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the thinkingConfig field is set. |
hasTopK()
public abstract 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 abstract 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. |