public final class GenerationConfig extends GeneratedMessageV3 implements GenerationConfigOrBuilder
Generation config.
Protobuf type google.cloud.aiplatform.v1.GenerationConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CANDIDATE_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FREQUENCY_PENALTY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LOGPROBS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MAX_OUTPUT_TOKENS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PRESENCE_PENALTY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESPONSE_LOGPROBS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESPONSE_MIME_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESPONSE_SCHEMA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ROUTING_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SEED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STOP_SEQUENCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TEMPERATURE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOP_K_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOP_P_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static GenerationConfig getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static GenerationConfig.Builder newBuilder()
public static GenerationConfig.Builder newBuilder(GenerationConfig prototype)
public static GenerationConfig parseDelimitedFrom(InputStream input)
public static GenerationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerationConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static GenerationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GenerationConfig parseFrom(ByteString data)
public static GenerationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GenerationConfig parseFrom(CodedInputStream input)
public static GenerationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerationConfig parseFrom(InputStream input)
public static GenerationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerationConfig parseFrom(ByteBuffer data)
public static GenerationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<GenerationConfig> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
public GenerationConfig getDefaultInstanceForType()
public float getFrequencyPenalty()
Optional. Frequency penalties.
optional float frequency_penalty = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
float |
The frequencyPenalty.
|
Optional. Logit probabilities.
optional int32 logprobs = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The logprobs.
|
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.
|
public Parser<GenerationConfig> getParserForType()
Overrides
public float getPresencePenalty()
Optional. Positive penalties.
optional float presence_penalty = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
float |
The presencePenalty.
|
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.
|
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.
|
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.
|
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.
|
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];
public GenerationConfig.RoutingConfig getRoutingConfig()
Optional. Routing configuration.
optional .google.cloud.aiplatform.v1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];
public GenerationConfig.RoutingConfigOrBuilder getRoutingConfigOrBuilder()
Optional. Routing configuration.
optional .google.cloud.aiplatform.v1.GenerationConfig.RoutingConfig routing_config = 17 [(.google.api.field_behavior) = OPTIONAL];
Optional. Seed.
optional int32 seed = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The seed.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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.
|
public int getStopSequencesCount()
Optional. Stop sequences.
repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of stopSequences.
|
public ProtocolStringList getStopSequencesList()
Optional. Stop sequences.
repeated string stop_sequences = 6 [(.google.api.field_behavior) = OPTIONAL];
public float getTemperature()
Optional. Controls the randomness of predictions.
optional float temperature = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
float |
The temperature.
|
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.
|
Optional. If specified, nucleus sampling will be used.
optional float top_p = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
float |
The topP.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
Optional. Seed.
optional int32 seed = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the seed field is set.
|
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.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public GenerationConfig.Builder newBuilderForType()
protected GenerationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public GenerationConfig.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
