Class TrainProcessorVersionRequest.FoundationModelTuningOptions (2.45.0)

Version 2.45.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public static final class TrainProcessorVersionRequest.FoundationModelTuningOptions extends GeneratedMessageV3 implements TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

Options to control foundation model tuning of the processor.

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

Inheritance

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

Implements

TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

LEARNING_RATE_MULTIPLIER_FIELD_NUMBER

public static final int LEARNING_RATE_MULTIPLIER_FIELD_NUMBER

Field Value
Type	Description
int

TRAIN_STEPS_FIELD_NUMBER

public static final int TRAIN_STEPS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static TrainProcessorVersionRequest.FoundationModelTuningOptions getDefaultInstance()

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilder()

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

newBuilder(TrainProcessorVersionRequest.FoundationModelTuningOptions prototype)

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

Parameter
Name	Description
prototype	TrainProcessorVersionRequest.FoundationModelTuningOptions

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

parseDelimitedFrom(InputStream input)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TrainProcessorVersionRequest.FoundationModelTuningOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<TrainProcessorVersionRequest.FoundationModelTuningOptions> parser()

Returns
Type	Description
Parser<FoundationModelTuningOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public TrainProcessorVersionRequest.FoundationModelTuningOptions getDefaultInstanceForType()

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions

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
Type	Description
float	The learningRateMultiplier.

getParserForType()

public Parser<TrainProcessorVersionRequest.FoundationModelTuningOptions> getParserForType()

Returns
Type	Description
Parser<FoundationModelTuningOptions>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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
Type	Description
int	The trainSteps.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilderForType()

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder toBuilder()

Returns
Type	Description
TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException