Api.Parameters.Builder (volc-sdk-java 1.0.108 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>
    - - com.volcengine.model.maas.api.Api.Parameters.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Api.ParametersOrBuilder, Cloneable

Enclosing class:

Api.Parameters
```
public static final class Api.Parameters.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>
implements Api.ParametersOrBuilder
```
Protobuf type api.Parameters

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Api.Parameters.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Api.Parameters`	`build()`
`Api.Parameters`	`buildPartial()`
`Api.Parameters.Builder`	`clear()`
`Api.Parameters.Builder`	`clearDoSample()` Whether or not to use sampling, use greedy decoding otherwise.
`Api.Parameters.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Api.Parameters.Builder`	`clearFrequencyPenalty()` Number between -2.0 and 2.0.
`Api.Parameters.Builder`	`clearMaxNewTokens()` The maximum number of tokens to generate, ignoring the number of tokens in the prompt
`Api.Parameters.Builder`	`clearMaxTokens()` The maximum number of tokens to generate in the char completion.
`Api.Parameters.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Api.Parameters.Builder`	`clearPresencePenalty()` Number between -2.0 and 2.0.
`Api.Parameters.Builder`	`clearRepetitionPenalty()` The parameter for repetition penalty, from [1.0, 2.0]
`Api.Parameters.Builder`	`clearTemperature()` Exponential scaling output probability distribution
`Api.Parameters.Builder`	`clearTopK()` The number of highest probability vocabulary tokens to keep for top-k-filtering.
`Api.Parameters.Builder`	`clearTopP()` An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass
`Api.Parameters.Builder`	`clone()`
`Api.Parameters`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getDoSample()` Whether or not to use sampling, use greedy decoding otherwise.
`float`	`getFrequencyPenalty()` Number between -2.0 and 2.0.
`long`	`getMaxNewTokens()` The maximum number of tokens to generate, ignoring the number of tokens in the prompt
`long`	`getMaxTokens()` The maximum number of tokens to generate in the char completion.
`float`	`getPresencePenalty()` Number between -2.0 and 2.0.
`float`	`getRepetitionPenalty()` The parameter for repetition penalty, from [1.0, 2.0]
`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
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Api.Parameters.Builder`	`mergeFrom(Api.Parameters other)`
`Api.Parameters.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Api.Parameters.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Api.Parameters.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Api.Parameters.Builder`	`setDoSample(boolean value)` Whether or not to use sampling, use greedy decoding otherwise.
`Api.Parameters.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Api.Parameters.Builder`	`setFrequencyPenalty(float value)` Number between -2.0 and 2.0.
`Api.Parameters.Builder`	`setMaxNewTokens(long value)` The maximum number of tokens to generate, ignoring the number of tokens in the prompt
`Api.Parameters.Builder`	`setMaxTokens(long value)` The maximum number of tokens to generate in the char completion.
`Api.Parameters.Builder`	`setPresencePenalty(float value)` Number between -2.0 and 2.0.
`Api.Parameters.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Api.Parameters.Builder`	`setRepetitionPenalty(float value)` The parameter for repetition penalty, from [1.0, 2.0]
`Api.Parameters.Builder`	`setTemperature(float value)` Exponential scaling output probability distribution
`Api.Parameters.Builder`	`setTopK(long value)` The number of highest probability vocabulary tokens to keep for top-k-filtering.
`Api.Parameters.Builder`	`setTopP(float value)` An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass
`Api.Parameters.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

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.Builder<Api.Parameters.Builder>

clear
```
public Api.Parameters.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

getDefaultInstanceForType
```
public Api.Parameters getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Api.Parameters build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Api.Parameters buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Api.Parameters.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

setField

public Api.Parameters.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

clearField
```
public Api.Parameters.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

clearOneof
```
public Api.Parameters.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

setRepeatedField

public Api.Parameters.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

addRepeatedField

public Api.Parameters.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

mergeFrom
```
public Api.Parameters.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Api.Parameters.Builder>

mergeFrom

public Api.Parameters.Builder mergeFrom(Api.Parameters other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

mergeFrom
```
public Api.Parameters.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Api.Parameters.Builder>

Throws:

IOException

getTemperature
```
public float getTemperature()
```
```
 Exponential scaling output probability distribution
 
```
float temperature = 1;
Specified by:

getTemperature in interface Api.ParametersOrBuilder

Returns:

The temperature.

setTemperature

public Api.Parameters.Builder setTemperature(float value)

 Exponential scaling output probability distribution

float temperature = 1;

Parameters:: value - The temperature to set.
Returns:: This builder for chaining.

clearTemperature

public Api.Parameters.Builder clearTemperature()

 Exponential scaling output probability distribution

float temperature = 1;

Returns:: This builder for chaining.

getMaxTokens
```
public long getMaxTokens()
```
```
 The maximum number of tokens to generate in the char completion.
 
```
int64 max_tokens = 2;
Specified by:

getMaxTokens in interface Api.ParametersOrBuilder

Returns:

The maxTokens.

setMaxTokens

public Api.Parameters.Builder setMaxTokens(long value)

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

int64 max_tokens = 2;

Parameters:: value - The maxTokens to set.
Returns:: This builder for chaining.

clearMaxTokens

public Api.Parameters.Builder clearMaxTokens()

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

int64 max_tokens = 2;

Returns:: This builder for chaining.

getTopP

public 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

float top_p = 3;

Specified by:: getTopP in interface Api.ParametersOrBuilder
Returns:: The topP.

setTopP

public Api.Parameters.Builder setTopP(float value)

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

float top_p = 3;

Parameters:: value - The topP to set.
Returns:: This builder for chaining.

clearTopP

public Api.Parameters.Builder clearTopP()

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

float top_p = 3;

Returns:: This builder for chaining.

getPresencePenalty

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

float presence_penalty = 4;

Specified by:: getPresencePenalty in interface Api.ParametersOrBuilder
Returns:: The presencePenalty.

setPresencePenalty

public Api.Parameters.Builder setPresencePenalty(float value)

 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.

float presence_penalty = 4;

Parameters:: value - The presencePenalty to set.
Returns:: This builder for chaining.

clearPresencePenalty

public Api.Parameters.Builder clearPresencePenalty()

 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.

float presence_penalty = 4;

Returns:: This builder for chaining.

getFrequencyPenalty

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

float frequency_penalty = 5;

Specified by:: getFrequencyPenalty in interface Api.ParametersOrBuilder
Returns:: The frequencyPenalty.

setFrequencyPenalty

public Api.Parameters.Builder setFrequencyPenalty(float value)

 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.

float frequency_penalty = 5;

Parameters:: value - The frequencyPenalty to set.
Returns:: This builder for chaining.

clearFrequencyPenalty

public Api.Parameters.Builder clearFrequencyPenalty()

 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.

float frequency_penalty = 5;

Returns:: This builder for chaining.

getMaxNewTokens
```
public long getMaxNewTokens()
```
```
 The maximum number of tokens to generate, ignoring the number of tokens in
 the prompt
 
```
int64 max_new_tokens = 6;
Specified by:

getMaxNewTokens in interface Api.ParametersOrBuilder

Returns:

The maxNewTokens.

setMaxNewTokens

public Api.Parameters.Builder setMaxNewTokens(long value)

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

int64 max_new_tokens = 6;

Parameters:: value - The maxNewTokens to set.
Returns:: This builder for chaining.

clearMaxNewTokens

public Api.Parameters.Builder clearMaxNewTokens()

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

int64 max_new_tokens = 6;

Returns:: This builder for chaining.

getRepetitionPenalty
```
public float getRepetitionPenalty()
```
```
 The parameter for repetition penalty, from [1.0, 2.0]
 
```
float repetition_penalty = 7;
Specified by:

getRepetitionPenalty in interface Api.ParametersOrBuilder

Returns:

The repetitionPenalty.

setRepetitionPenalty
```
public Api.Parameters.Builder setRepetitionPenalty(float value)
```
```
 The parameter for repetition penalty, from [1.0, 2.0]
 
```
float repetition_penalty = 7;
Parameters:

value - The repetitionPenalty to set.

Returns:

This builder for chaining.

clearRepetitionPenalty

public Api.Parameters.Builder clearRepetitionPenalty()

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

float repetition_penalty = 7;

Returns:: This builder for chaining.

getDoSample

public boolean getDoSample()

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

bool do_sample = 8;

Specified by:: getDoSample in interface Api.ParametersOrBuilder
Returns:: The doSample.

setDoSample

public Api.Parameters.Builder setDoSample(boolean value)

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

bool do_sample = 8;

Parameters:: value - The doSample to set.
Returns:: This builder for chaining.

clearDoSample

public Api.Parameters.Builder clearDoSample()

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

bool do_sample = 8;

Returns:: This builder for chaining.

getTopK

public long getTopK()

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

int64 top_k = 9;

Specified by:: getTopK in interface Api.ParametersOrBuilder
Returns:: The topK.

setTopK

public Api.Parameters.Builder setTopK(long value)

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

int64 top_k = 9;

Parameters:: value - The topK to set.
Returns:: This builder for chaining.

clearTopK

public Api.Parameters.Builder clearTopK()

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

int64 top_k = 9;

Returns:: This builder for chaining.

setUnknownFields
```
public final Api.Parameters.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

mergeUnknownFields
```
public final Api.Parameters.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Api.Parameters.Builder>

Class Api.Parameters.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getTemperature

setTemperature

clearTemperature

getMaxTokens

setMaxTokens

clearMaxTokens

getTopP

setTopP

clearTopP

getPresencePenalty

setPresencePenalty

clearPresencePenalty

getFrequencyPenalty

setFrequencyPenalty

clearFrequencyPenalty

getMaxNewTokens

setMaxNewTokens

clearMaxNewTokens

getRepetitionPenalty

setRepetitionPenalty

clearRepetitionPenalty

getDoSample

setDoSample

clearDoSample

getTopK

setTopK

clearTopK

setUnknownFields

mergeUnknownFields