Interface GenerationConfigOrBuilder (1.13.0) 

public interface GenerationConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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.

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.

getPresencePenalty()

public abstract float getPresencePenalty()

Optional. Positive penalties.

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

Returns
Type Description
float

The presencePenalty.

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.

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.vertexai.v1.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.vertexai.v1.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.vertexai.v1.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.vertexai.v1.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.

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 int

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

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

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.

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.

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.

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.

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.vertexai.v1.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.vertexai.v1.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.

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.

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.