Class TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder (2.44.0)

public static final class TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder extends GeneratedMessageV3.Builder<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder> implements TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

Options to control foundation model tuning of the processor.

Protobuf type google.cloud.documentai.v1beta3.TrainProcessorVersionRequest.FoundationModelTuningOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

build()

public TrainProcessorVersionRequest.FoundationModelTuningOptions build()
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions

buildPartial()

public TrainProcessorVersionRequest.FoundationModelTuningOptions buildPartial()
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions

clear()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clear()
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

clearLearningRateMultiplier()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearLearningRateMultiplier()

Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.

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

Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

clearTrainSteps()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearTrainSteps()

Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.

int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

This builder for chaining.

clone()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clone()
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

getDefaultInstanceForType()

public TrainProcessorVersionRequest.FoundationModelTuningOptions getDefaultInstanceForType()
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLearningRateMultiplier()

public float getLearningRateMultiplier()

Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.

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

Returns
TypeDescription
float

The learningRateMultiplier.

getTrainSteps()

public int getTrainSteps()

Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.

int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The trainSteps.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(TrainProcessorVersionRequest.FoundationModelTuningOptions other)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeFrom(TrainProcessorVersionRequest.FoundationModelTuningOptions other)
Parameter
NameDescription
otherTrainProcessorVersionRequest.FoundationModelTuningOptions
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

setLearningRateMultiplier(float value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setLearningRateMultiplier(float value)

Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.

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

Parameter
NameDescription
valuefloat

The learningRateMultiplier to set.

Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides

setTrainSteps(int value)

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setTrainSteps(int value)

Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.

int32 train_steps = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The trainSteps to set.

Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
Overrides