GenerationConfigOrBuilder (proto-google-cloud-aiplatform-v1beta1 0.73.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GenerationConfig, GenerationConfig.Builder
```
public interface GenerationConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getAudioTimestamp()` Optional.
`int`	`getCandidateCount()` Optional.
`float`	`getFrequencyPenalty()` Optional.
`int`	`getLogprobs()` Optional.
`int`	`getMaxOutputTokens()` Optional.
`GenerationConfig.MediaResolution`	`getMediaResolution()` Optional.
`int`	`getMediaResolutionValue()` Optional.
`float`	`getPresencePenalty()` 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.
`SpeechConfig`	`getSpeechConfig()` Optional.
`SpeechConfigOrBuilder`	`getSpeechConfigOrBuilder()` Optional.
`String`	`getStopSequences(int index)` Optional.
`com.google.protobuf.ByteString`	`getStopSequencesBytes(int index)` Optional.
`int`	`getStopSequencesCount()` Optional.
`List<String>`	`getStopSequencesList()` Optional.
`float`	`getTemperature()` Optional.
`float`	`getTopK()` Optional.
`float`	`getTopP()` Optional.
`boolean`	`hasAudioTimestamp()` Optional.
`boolean`	`hasCandidateCount()` Optional.
`boolean`	`hasFrequencyPenalty()` Optional.
`boolean`	`hasLogprobs()` Optional.
`boolean`	`hasMaxOutputTokens()` Optional.
`boolean`	`hasMediaResolution()` Optional.
`boolean`	`hasPresencePenalty()` Optional.
`boolean`	`hasResponseLogprobs()` Optional.
`boolean`	`hasResponseSchema()` Optional.
`boolean`	`hasRoutingConfig()` Optional.
`boolean`	`hasSeed()` Optional.
`boolean`	`hasSpeechConfig()` Optional.
`boolean`	`hasTemperature()` Optional.
`boolean`	`hasTopK()` Optional.
`boolean`	`hasTopP()` Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - hasTemperature
```
boolean hasTemperature()
```
```
 Optional. Controls the randomness of predictions.
 
```
    optional float temperature = 1 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the temperature field is set.
  - getTemperature
```
float getTemperature()
```
```
 Optional. Controls the randomness of predictions.
 
```
    optional float temperature = 1 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The temperature.
  - hasTopP
```
boolean hasTopP()
```
```
 Optional. If specified, nucleus sampling will be used.
 
```
    optional float top_p = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the topP field is set.
  - getTopP
```
float getTopP()
```
```
 Optional. If specified, nucleus sampling will be used.
 
```
    optional float top_p = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The topP.
  - hasTopK
```
boolean hasTopK()
```
```
 Optional. If specified, top-k sampling will be used.
 
```
    optional float top_k = 3 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the topK field is set.
  - getTopK
```
float getTopK()
```
```
 Optional. If specified, top-k sampling will be used.
 
```
    optional float top_k = 3 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The topK.
  - hasCandidateCount
```
boolean hasCandidateCount()
```
```
 Optional. Number of candidates to generate.
 
```
    optional int32 candidate_count = 4 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the candidateCount field is set.
  - getCandidateCount
```
int getCandidateCount()
```
```
 Optional. Number of candidates to generate.
 
```
    optional int32 candidate_count = 4 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The candidateCount.
  - hasMaxOutputTokens
```
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:
    
    Whether the maxOutputTokens field is set.
  - getMaxOutputTokens
```
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:
    
    The maxOutputTokens.
  - getStopSequencesList
```
List<String> getStopSequencesList()
```
```
 Optional. Stop sequences.
 
```
    repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    A list containing the stopSequences.
  - getStopSequencesCount
```
int getStopSequencesCount()
```
```
 Optional. Stop sequences.
 
```
    repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The count of stopSequences.
  - getStopSequences
```
String getStopSequences(int index)
```
```
 Optional. Stop sequences.
 
```
    repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The stopSequences at the given index.
  - getStopSequencesBytes
```
com.google.protobuf.ByteString getStopSequencesBytes(int index)
```
```
 Optional. Stop sequences.
 
```
    repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the stopSequences at the given index.
  - hasResponseLogprobs
```
boolean hasResponseLogprobs()
```
```
 Optional. If true, export the logprobs results in response.
 
```
    optional bool response_logprobs = 18 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the responseLogprobs field is set.
  - getResponseLogprobs
```
boolean getResponseLogprobs()
```
```
 Optional. If true, export the logprobs results in response.
 
```
    optional bool response_logprobs = 18 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The responseLogprobs.
  - hasLogprobs
```
boolean hasLogprobs()
```
```
 Optional. Logit probabilities.
 
```
    optional int32 logprobs = 7 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the logprobs field is set.
  - getLogprobs
```
int getLogprobs()
```
```
 Optional. Logit probabilities.
 
```
    optional int32 logprobs = 7 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The logprobs.
  - hasPresencePenalty
```
boolean hasPresencePenalty()
```
```
 Optional. Positive penalties.
 
```
    optional float presence_penalty = 8 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the presencePenalty field is set.
  - getPresencePenalty
```
float getPresencePenalty()
```
```
 Optional. Positive penalties.
 
```
    optional float presence_penalty = 8 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The presencePenalty.
  - hasFrequencyPenalty
```
boolean hasFrequencyPenalty()
```
```
 Optional. Frequency penalties.
 
```
    optional float frequency_penalty = 9 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the frequencyPenalty field is set.
  - getFrequencyPenalty
```
float getFrequencyPenalty()
```
```
 Optional. Frequency penalties.
 
```
    optional float frequency_penalty = 9 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The frequencyPenalty.
  - hasSeed
```
boolean hasSeed()
```
```
 Optional. Seed.
 
```
    optional int32 seed = 12 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the seed field is set.
  - getSeed
```
int getSeed()
```
```
 Optional. Seed.
 
```
    optional int32 seed = 12 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The seed.
  - getResponseMimeType
```
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:
    
    The responseMimeType.
  - getResponseMimeTypeBytes
```
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];
    Returns:
    
    The bytes for responseMimeType.
  - hasResponseSchema
```
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.v1beta1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the responseSchema field is set.
  - getResponseSchema
```
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.v1beta1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The responseSchema.
  - getResponseSchemaOrBuilder
```
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.v1beta1.Schema response_schema = 16 [(.google.api.field_behavior) = OPTIONAL];
  - hasRoutingConfig
```
boolean hasRoutingConfig()
```
```
 Optional. Routing configuration.
 
```
    optional .google.cloud.aiplatform.v1beta1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the routingConfig field is set.
  - getRoutingConfig
```
GenerationConfig.RoutingConfig getRoutingConfig()
```
```
 Optional. Routing configuration.
 
```
    optional .google.cloud.aiplatform.v1beta1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The routingConfig.
  - getRoutingConfigOrBuilder
```
GenerationConfig.RoutingConfigOrBuilder getRoutingConfigOrBuilder()
```
```
 Optional. Routing configuration.
 
```
    optional .google.cloud.aiplatform.v1beta1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];
  - hasAudioTimestamp
```
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:
    
    Whether the audioTimestamp field is set.
  - getAudioTimestamp
```
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:
    
    The audioTimestamp.
  - getResponseModalitiesList
```
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:
    
    A list containing the responseModalities.
  - getResponseModalitiesCount
```
int getResponseModalitiesCount()
```
```
 Optional. The modalities of the response.
 
```
    repeated .google.cloud.aiplatform.v1beta1.GenerationConfig.Modality response_modalities = 21 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The count of responseModalities.
  - getResponseModalities
```
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];
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The responseModalities at the given index.
  - getResponseModalitiesValueList
```
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:
    
    A list containing the enum numeric values on the wire for responseModalities.
  - getResponseModalitiesValue
```
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];
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The enum numeric value on the wire of responseModalities at the given index.
  - hasMediaResolution
```
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:
    
    Whether the mediaResolution field is set.
  - getMediaResolutionValue
```
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:
    
    The enum numeric value on the wire for mediaResolution.
  - getMediaResolution
```
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:
    
    The mediaResolution.
  - hasSpeechConfig
```
boolean hasSpeechConfig()
```
```
 Optional. The speech generation config.
 
```
    optional .google.cloud.aiplatform.v1beta1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the speechConfig field is set.
  - getSpeechConfig
```
SpeechConfig getSpeechConfig()
```
```
 Optional. The speech generation config.
 
```
    optional .google.cloud.aiplatform.v1beta1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The speechConfig.
  - getSpeechConfigOrBuilder
```
SpeechConfigOrBuilder getSpeechConfigOrBuilder()
```
```
 Optional. The speech generation config.
 
```
    optional .google.cloud.aiplatform.v1beta1.SpeechConfig speech_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Interface GenerationConfigOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

hasTemperature

getTemperature

hasTopP

getTopP

hasTopK

getTopK

hasCandidateCount

getCandidateCount

hasMaxOutputTokens

getMaxOutputTokens

getStopSequencesList

getStopSequencesCount

getStopSequences

getStopSequencesBytes

hasResponseLogprobs

getResponseLogprobs

hasLogprobs

getLogprobs

hasPresencePenalty

getPresencePenalty

hasFrequencyPenalty

getFrequencyPenalty

hasSeed

getSeed

getResponseMimeType

getResponseMimeTypeBytes

hasResponseSchema

getResponseSchema

getResponseSchemaOrBuilder

hasRoutingConfig

getRoutingConfig

getRoutingConfigOrBuilder

hasAudioTimestamp

getAudioTimestamp

getResponseModalitiesList

getResponseModalitiesCount

getResponseModalities

getResponseModalitiesValueList

getResponseModalitiesValue

hasMediaResolution

getMediaResolutionValue

getMediaResolution

hasSpeechConfig

getSpeechConfig

getSpeechConfigOrBuilder