Package com.google.cloud.documentai.v1

Class TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder>

com.google.cloud.documentai.v1.TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

All Implemented Interfaces:

TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

TrainProcessorVersionRequest.FoundationModelTuningOptions

public static final class TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder
extends com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder>
implements TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

 Options to control foundation model tuning of the processor.
 

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

Method Summary

Modifier and Type	Method	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions	build()
TrainProcessorVersionRequest.FoundationModelTuningOptions	buildPartial()
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	clear()
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	clearLearningRateMultiplier()	Optional.
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	clearTrainSteps()	Optional.
TrainProcessorVersionRequest.FoundationModelTuningOptions	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
float	getLearningRateMultiplier()	Optional.
int	getTrainSteps()	Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	mergeFrom(TrainProcessorVersionRequest.FoundationModelTuningOptions other)
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	mergeFrom(com.google.protobuf.Message other)
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	setLearningRateMultiplier(float value)	Optional.
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	setTrainSteps(int value)	Optional.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder>

clear

public TrainProcessorVersionRequest.FoundationModelTuningOptions.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.GeneratedMessage.Builder<TrainProcessorVersionRequest.FoundationModelTuningOptions.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.GeneratedMessage.Builder<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder>

getDefaultInstanceForType

public TrainProcessorVersionRequest.FoundationModelTuningOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public TrainProcessorVersionRequest.FoundationModelTuningOptions build()

Specified by:

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

Specified by:

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

buildPartial

public TrainProcessorVersionRequest.FoundationModelTuningOptions buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public TrainProcessorVersionRequest.FoundationModelTuningOptions.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<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder>

mergeFrom

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder mergeFrom(TrainProcessorVersionRequest.FoundationModelTuningOptions other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder>

mergeFrom

public TrainProcessorVersionRequest.FoundationModelTuningOptions.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<TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder>

Throws:

IOException

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];

Specified by:

getTrainSteps in interface TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

Returns:

The trainSteps.

setTrainSteps

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];

Parameters:

value - The trainSteps to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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];

Specified by:

getLearningRateMultiplier in interface TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

Returns:

The learningRateMultiplier.

setLearningRateMultiplier

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];

Parameters:

value - The learningRateMultiplier to set.

Returns:

This builder for chaining.

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:

This builder for chaining.