Package com.google.cloud.documentai.v1

Class TrainProcessorVersionRequest.FoundationModelTuningOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

All Implemented Interfaces:

TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

TrainProcessorVersionRequest

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

 Options to control foundation model tuning of the processor.
 

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	Options to control foundation model tuning of the processor.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LEARNING_RATE_MULTIPLIER_FIELD_NUMBER
static final int	TRAIN_STEPS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	getDefaultInstance()
TrainProcessorVersionRequest.FoundationModelTuningOptions	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
float	getLearningRateMultiplier()	Optional.
com.google.protobuf.Parser<TrainProcessorVersionRequest.FoundationModelTuningOptions>	getParserForType()
int	getSerializedSize()
int	getTrainSteps()	Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	newBuilder()
static TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	newBuilder(TrainProcessorVersionRequest.FoundationModelTuningOptions prototype)
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	newBuilderForType()
protected TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseDelimitedFrom(InputStream input)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(byte[] data)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(com.google.protobuf.ByteString data)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(InputStream input)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(ByteBuffer data)
static TrainProcessorVersionRequest.FoundationModelTuningOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TrainProcessorVersionRequest.FoundationModelTuningOptions>	parser()
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

TRAIN_STEPS_FIELD_NUMBER

public static final int TRAIN_STEPS_FIELD_NUMBER

See Also:

• Constant Field Values

LEARNING_RATE_MULTIPLIER_FIELD_NUMBER

public static final int LEARNING_RATE_MULTIPLIER_FIELD_NUMBER

See Also:

• Constant Field Values

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

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteBuffer data)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(com.google.protobuf.ByteString data)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(byte[] data)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(InputStream input)
                                                                           throws IOException

Throws:

IOException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseDelimitedFrom(InputStream input)
                                                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                    throws IOException

Throws:

IOException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                                                           throws IOException

Throws:

IOException

parseFrom

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws IOException

Throws:

IOException

newBuilderForType

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilder()

newBuilder

public static TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilder(TrainProcessorVersionRequest.FoundationModelTuningOptions prototype)

toBuilder

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static TrainProcessorVersionRequest.FoundationModelTuningOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<TrainProcessorVersionRequest.FoundationModelTuningOptions> parser()

getParserForType

public com.google.protobuf.Parser<TrainProcessorVersionRequest.FoundationModelTuningOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public TrainProcessorVersionRequest.FoundationModelTuningOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder