com.volcengine.model.maas.api

Interface Api.ParametersOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Api.Parameters, Api.Parameters.Builder

Enclosing class:

Api

public static interface Api.ParametersOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getDoSample() Whether or not to use sampling, use greedy decoding otherwise.
float	getFrequencyPenalty() Number between -2.0 and 2.0.
long	getLogprobs() optional int64 logprobs = 12;
long	getMaxNewTokens() The maximum number of tokens to generate, ignoring the number of tokens in the prompt
long	getMaxPromptTokens() the maximum number of prompt tokens, if prompt tokens length over this limit, it will be truncated as prompt[-max_prompt_tokens:]
long	getMaxTokens() The maximum number of tokens to generate in the char completion.
long	getMinNewTokens() the minimum number of tokens to generate
float	getPresencePenalty() Number between -2.0 and 2.0.
float	getRepetitionPenalty() The parameter for repetition penalty, from [1.0, 2.0]
String	getStop(int index) repeated string stop = 13;
com.google.protobuf.ByteString	getStopBytes(int index) repeated string stop = 13;
int	getStopCount() repeated string stop = 13;
List<String>	getStopList() repeated string stop = 13;
float	getTemperature() Exponential scaling output probability distribution
long	getTopK() The number of highest probability vocabulary tokens to keep for top-k-filtering.
float	getTopP() An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass
boolean	hasDoSample() Whether or not to use sampling, use greedy decoding otherwise.
boolean	hasFrequencyPenalty() Number between -2.0 and 2.0.
boolean	hasLogprobs() optional int64 logprobs = 12;
boolean	hasMaxNewTokens() The maximum number of tokens to generate, ignoring the number of tokens in the prompt
boolean	hasMaxPromptTokens() the maximum number of prompt tokens, if prompt tokens length over this limit, it will be truncated as prompt[-max_prompt_tokens:]
boolean	hasMaxTokens() The maximum number of tokens to generate in the char completion.
boolean	hasMinNewTokens() the minimum number of tokens to generate
boolean	hasPresencePenalty() Number between -2.0 and 2.0.
boolean	hasRepetitionPenalty() The parameter for repetition penalty, from [1.0, 2.0]
boolean	hasTemperature() Exponential scaling output probability distribution
boolean	hasTopK() The number of highest probability vocabulary tokens to keep for top-k-filtering.
boolean	hasTopP() An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass

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()

 Exponential scaling output probability distribution
 

optional float temperature = 1;

Returns:

Whether the temperature field is set.

getTemperature

float getTemperature()

 Exponential scaling output probability distribution
 

optional float temperature = 1;

Returns:

The temperature.

hasMaxTokens

boolean hasMaxTokens()

 The maximum number of tokens to generate in the char completion.
 

optional int64 max_tokens = 2;

Returns:

Whether the maxTokens field is set.

getMaxTokens

long getMaxTokens()

 The maximum number of tokens to generate in the char completion.
 

optional int64 max_tokens = 2;

Returns:

The maxTokens.

hasTopP

boolean hasTopP()

 An alternative to sampling with temperature, called nucleus sampling,
 where the model considers the results of the tokens with top_p probability
 mass
 

optional float top_p = 3;

Returns:

Whether the topP field is set.

getTopP

float getTopP()

 An alternative to sampling with temperature, called nucleus sampling,
 where the model considers the results of the tokens with top_p probability
 mass
 

optional float top_p = 3;

Returns:

The topP.

hasPresencePenalty

boolean hasPresencePenalty()

 Number between -2.0 and 2.0. Positive values penalize new tokens based
 on whether they appear in the text so far, increasing the model's
 likelihood to talk about new topics.
 

optional float presence_penalty = 4;

Returns:

Whether the presencePenalty field is set.

getPresencePenalty

float getPresencePenalty()

 Number between -2.0 and 2.0. Positive values penalize new tokens based
 on whether they appear in the text so far, increasing the model's
 likelihood to talk about new topics.
 

optional float presence_penalty = 4;

Returns:

The presencePenalty.

hasFrequencyPenalty

boolean hasFrequencyPenalty()

 Number between -2.0 and 2.0. Positive values penalize new tokens based on
 their existing frequency in the text so far, decreasing the model's
 likelihood to repeat the same line verbatim.
 

optional float frequency_penalty = 5;

Returns:

Whether the frequencyPenalty field is set.

getFrequencyPenalty

float getFrequencyPenalty()

 Number between -2.0 and 2.0. Positive values penalize new tokens based on
 their existing frequency in the text so far, decreasing the model's
 likelihood to repeat the same line verbatim.
 

optional float frequency_penalty = 5;

Returns:

The frequencyPenalty.

hasMaxNewTokens

boolean hasMaxNewTokens()

 The maximum number of tokens to generate, ignoring the number of tokens in
 the prompt
 

optional int64 max_new_tokens = 6;

Returns:

Whether the maxNewTokens field is set.

getMaxNewTokens

long getMaxNewTokens()

 The maximum number of tokens to generate, ignoring the number of tokens in
 the prompt
 

optional int64 max_new_tokens = 6;

Returns:

The maxNewTokens.

hasRepetitionPenalty

boolean hasRepetitionPenalty()

 The parameter for repetition penalty, from [1.0, 2.0]
 

optional float repetition_penalty = 7;

Returns:

Whether the repetitionPenalty field is set.

getRepetitionPenalty

float getRepetitionPenalty()

 The parameter for repetition penalty, from [1.0, 2.0]
 

optional float repetition_penalty = 7;

Returns:

The repetitionPenalty.

hasDoSample

boolean hasDoSample()

 Whether or not to use sampling, use greedy decoding otherwise. Default to
 false
 

optional bool do_sample = 8;

Returns:

Whether the doSample field is set.

getDoSample

boolean getDoSample()

 Whether or not to use sampling, use greedy decoding otherwise. Default to
 false
 

optional bool do_sample = 8;

Returns:

The doSample.

hasTopK

boolean hasTopK()

 The number of highest probability vocabulary tokens to keep for
 top-k-filtering.
 

optional int64 top_k = 9;

Returns:

Whether the topK field is set.

getTopK

long getTopK()

 The number of highest probability vocabulary tokens to keep for
 top-k-filtering.
 

optional int64 top_k = 9;

Returns:

The topK.

hasMinNewTokens

boolean hasMinNewTokens()

 the minimum number of tokens to generate
 

optional int64 min_new_tokens = 10;

Returns:

Whether the minNewTokens field is set.

getMinNewTokens

long getMinNewTokens()

 the minimum number of tokens to generate
 

optional int64 min_new_tokens = 10;

Returns:

The minNewTokens.

hasMaxPromptTokens

boolean hasMaxPromptTokens()

 the maximum number of prompt tokens, if prompt tokens length over this
 limit, it will be truncated as prompt[-max_prompt_tokens:]
 

optional int64 max_prompt_tokens = 11;

Returns:

Whether the maxPromptTokens field is set.

getMaxPromptTokens

long getMaxPromptTokens()

 the maximum number of prompt tokens, if prompt tokens length over this
 limit, it will be truncated as prompt[-max_prompt_tokens:]
 

optional int64 max_prompt_tokens = 11;

Returns:

The maxPromptTokens.

hasLogprobs

boolean hasLogprobs()

optional int64 logprobs = 12;

Returns:

Whether the logprobs field is set.

getLogprobs

long getLogprobs()

optional int64 logprobs = 12;

Returns:

The logprobs.

getStopList

List<String> getStopList()

repeated string stop = 13;

Returns:

A list containing the stop.

getStopCount

int getStopCount()

repeated string stop = 13;

Returns:

The count of stop.

getStop

String getStop(int index)

repeated string stop = 13;

Parameters:

index - The index of the element to return.

Returns:

The stop at the given index.

getStopBytes

com.google.protobuf.ByteString getStopBytes(int index)

repeated string stop = 13;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the stop at the given index.