com.google.cloud.aiplatform.v1beta1

Class GenerationConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.GenerationConfig

All Implemented Interfaces:

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

public final class GenerationConfig
extends com.google.protobuf.GeneratedMessageV3
implements GenerationConfigOrBuilder

 Generation config.
 

Protobuf type google.cloud.aiplatform.v1beta1.GenerationConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerationConfig.Builder Generation config.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANDIDATE_COUNT_FIELD_NUMBER
static int	FREQUENCY_PENALTY_FIELD_NUMBER
static int	MAX_OUTPUT_TOKENS_FIELD_NUMBER
static int	PRESENCE_PENALTY_FIELD_NUMBER
static int	RESPONSE_MIME_TYPE_FIELD_NUMBER
static int	RESPONSE_SCHEMA_FIELD_NUMBER
static int	STOP_SEQUENCES_FIELD_NUMBER
static int	TEMPERATURE_FIELD_NUMBER
static int	TOP_K_FIELD_NUMBER
static int	TOP_P_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getCandidateCount() Optional.
static GenerationConfig	getDefaultInstance()
GenerationConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
float	getFrequencyPenalty() Optional.
int	getMaxOutputTokens() Optional.
com.google.protobuf.Parser<GenerationConfig>	getParserForType()
float	getPresencePenalty() Optional.
String	getResponseMimeType() Optional.
com.google.protobuf.ByteString	getResponseMimeTypeBytes() Optional.
Schema	getResponseSchema() Optional.
SchemaOrBuilder	getResponseSchemaOrBuilder() Optional.
int	getSerializedSize()
String	getStopSequences(int index) Optional.
com.google.protobuf.ByteString	getStopSequencesBytes(int index) Optional.
int	getStopSequencesCount() Optional.
com.google.protobuf.ProtocolStringList	getStopSequencesList() Optional.
float	getTemperature() Optional.
float	getTopK() Optional.
float	getTopP() Optional.
boolean	hasCandidateCount() Optional.
boolean	hasFrequencyPenalty() Optional.
int	hashCode()
boolean	hasMaxOutputTokens() Optional.
boolean	hasPresencePenalty() Optional.
boolean	hasResponseSchema() Optional.
boolean	hasTemperature() Optional.
boolean	hasTopK() Optional.
boolean	hasTopP() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerationConfig.Builder	newBuilder()
static GenerationConfig.Builder	newBuilder(GenerationConfig prototype)
GenerationConfig.Builder	newBuilderForType()
protected GenerationConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerationConfig	parseDelimitedFrom(InputStream input)
static GenerationConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(byte[] data)
static GenerationConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(ByteBuffer data)
static GenerationConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(com.google.protobuf.ByteString data)
static GenerationConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerationConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerationConfig	parseFrom(InputStream input)
static GenerationConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerationConfig>	parser()
GenerationConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TEMPERATURE_FIELD_NUMBER

public static final int TEMPERATURE_FIELD_NUMBER

See Also:

Constant Field Values

TOP_P_FIELD_NUMBER

public static final int TOP_P_FIELD_NUMBER

See Also:

Constant Field Values

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER

See Also:

Constant Field Values

CANDIDATE_COUNT_FIELD_NUMBER

public static final int CANDIDATE_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

MAX_OUTPUT_TOKENS_FIELD_NUMBER

public static final int MAX_OUTPUT_TOKENS_FIELD_NUMBER

See Also:

Constant Field Values

STOP_SEQUENCES_FIELD_NUMBER

public static final int STOP_SEQUENCES_FIELD_NUMBER

See Also:

Constant Field Values

PRESENCE_PENALTY_FIELD_NUMBER

public static final int PRESENCE_PENALTY_FIELD_NUMBER

See Also:

Constant Field Values

FREQUENCY_PENALTY_FIELD_NUMBER

public static final int FREQUENCY_PENALTY_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_MIME_TYPE_FIELD_NUMBER

public static final int RESPONSE_MIME_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_SCHEMA_FIELD_NUMBER

public static final int RESPONSE_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasTemperature

public boolean hasTemperature()

 Optional. Controls the randomness of predictions.
 

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

Specified by:

hasTemperature in interface GenerationConfigOrBuilder

Returns:

Whether the temperature field is set.

getTemperature

public float getTemperature()

 Optional. Controls the randomness of predictions.
 

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

Specified by:

getTemperature in interface GenerationConfigOrBuilder

Returns:

The temperature.

hasTopP

public boolean hasTopP()

 Optional. If specified, nucleus sampling will be used.
 

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

Specified by:

hasTopP in interface GenerationConfigOrBuilder

Returns:

Whether the topP field is set.

getTopP

public float getTopP()

 Optional. If specified, nucleus sampling will be used.
 

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

Specified by:

getTopP in interface GenerationConfigOrBuilder

Returns:

The topP.

hasTopK

public boolean hasTopK()

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

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

Specified by:

hasTopK in interface GenerationConfigOrBuilder

Returns:

Whether the topK field is set.

getTopK

public float getTopK()

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

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

Specified by:

getTopK in interface GenerationConfigOrBuilder

Returns:

The topK.

hasCandidateCount

public boolean hasCandidateCount()

 Optional. Number of candidates to generate.
 

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

Specified by:

hasCandidateCount in interface GenerationConfigOrBuilder

Returns:

Whether the candidateCount field is set.

getCandidateCount

public int getCandidateCount()

 Optional. Number of candidates to generate.
 

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

Specified by:

getCandidateCount in interface GenerationConfigOrBuilder

Returns:

The candidateCount.

hasMaxOutputTokens

public boolean hasMaxOutputTokens()

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

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

Specified by:

hasMaxOutputTokens in interface GenerationConfigOrBuilder

Returns:

Whether the maxOutputTokens field is set.

getMaxOutputTokens

public int getMaxOutputTokens()

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

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

Specified by:

getMaxOutputTokens in interface GenerationConfigOrBuilder

Returns:

The maxOutputTokens.

getStopSequencesList

public com.google.protobuf.ProtocolStringList getStopSequencesList()

 Optional. Stop sequences.
 

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

Specified by:

getStopSequencesList in interface GenerationConfigOrBuilder

Returns:

A list containing the stopSequences.

getStopSequencesCount

public int getStopSequencesCount()

 Optional. Stop sequences.
 

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

Specified by:

getStopSequencesCount in interface GenerationConfigOrBuilder

Returns:

The count of stopSequences.

getStopSequences

public String getStopSequences(int index)

 Optional. Stop sequences.
 

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

Specified by:

getStopSequences in interface GenerationConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The stopSequences at the given index.

getStopSequencesBytes

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

 Optional. Stop sequences.
 

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

Specified by:

getStopSequencesBytes in interface GenerationConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the stopSequences at the given index.

hasPresencePenalty

public boolean hasPresencePenalty()

 Optional. Positive penalties.
 

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

Specified by:

hasPresencePenalty in interface GenerationConfigOrBuilder

Returns:

Whether the presencePenalty field is set.

getPresencePenalty

public float getPresencePenalty()

 Optional. Positive penalties.
 

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

Specified by:

getPresencePenalty in interface GenerationConfigOrBuilder

Returns:

The presencePenalty.

hasFrequencyPenalty

public boolean hasFrequencyPenalty()

 Optional. Frequency penalties.
 

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

Specified by:

hasFrequencyPenalty in interface GenerationConfigOrBuilder

Returns:

Whether the frequencyPenalty field is set.

getFrequencyPenalty

public float getFrequencyPenalty()

 Optional. Frequency penalties.
 

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

Specified by:

getFrequencyPenalty in interface GenerationConfigOrBuilder

Returns:

The frequencyPenalty.

getResponseMimeType

public String getResponseMimeType()

 Optional. Output response mimetype of the generated candidate text.
 Supported mimetype:
 - `text/plain`: (default) Text output.
 - `application/json`: JSON response in the candidates.
 The model needs to be prompted to output the appropriate response type,
 otherwise the behavior is undefined.
 This is a preview feature.
 

string response_mime_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseMimeType in interface GenerationConfigOrBuilder

Returns:

The responseMimeType.

getResponseMimeTypeBytes

public com.google.protobuf.ByteString getResponseMimeTypeBytes()

 Optional. Output response mimetype of the generated candidate text.
 Supported mimetype:
 - `text/plain`: (default) Text output.
 - `application/json`: JSON response in the candidates.
 The model needs to be prompted to output the appropriate response type,
 otherwise the behavior is undefined.
 This is a preview feature.
 

string response_mime_type = 13 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseMimeTypeBytes in interface GenerationConfigOrBuilder

Returns:

The bytes for responseMimeType.

hasResponseSchema

public boolean hasResponseSchema()

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

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

Specified by:

hasResponseSchema in interface GenerationConfigOrBuilder

Returns:

Whether the responseSchema field is set.

getResponseSchema

public Schema getResponseSchema()

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

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

Specified by:

getResponseSchema in interface GenerationConfigOrBuilder

Returns:

The responseSchema.

getResponseSchemaOrBuilder

public SchemaOrBuilder getResponseSchemaOrBuilder()

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

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

Specified by:

getResponseSchemaOrBuilder in interface GenerationConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

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

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerationConfig parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static GenerationConfig parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public GenerationConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerationConfig.Builder newBuilder()

newBuilder

public static GenerationConfig.Builder newBuilder(GenerationConfig prototype)

toBuilder

public GenerationConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerationConfig getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GenerationConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder