Package com.google.cloud.documentai.v1beta3

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.v1beta3.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.v1beta3.TrainProcessorVersionRequest.FoundationModelTuningOptions

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

    • getPreviousFineTunedProcessorVersionName

      public String getPreviousFineTunedProcessorVersionName()
       Optional. Resource name of a previously fine tuned version id to copy the
 overwritten configs from. The base_processor_version should be newer than
 the base processor version used to fine tune this provided processor
 version. Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
      string previous_fine_tuned_processor_version_name = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPreviousFineTunedProcessorVersionName in interface TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder
      Returns:
      The previousFineTunedProcessorVersionName.

    • getPreviousFineTunedProcessorVersionNameBytes

      public com.google.protobuf.ByteString getPreviousFineTunedProcessorVersionNameBytes()
       Optional. Resource name of a previously fine tuned version id to copy the
 overwritten configs from. The base_processor_version should be newer than
 the base processor version used to fine tune this provided processor
 version. Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
      string previous_fine_tuned_processor_version_name = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPreviousFineTunedProcessorVersionNameBytes in interface TrainProcessorVersionRequest.FoundationModelTuningOptionsOrBuilder
      Returns:
      The bytes for previousFineTunedProcessorVersionName.

    • setPreviousFineTunedProcessorVersionName

      public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setPreviousFineTunedProcessorVersionName(String value)
       Optional. Resource name of a previously fine tuned version id to copy the
 overwritten configs from. The base_processor_version should be newer than
 the base processor version used to fine tune this provided processor
 version. Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
      string previous_fine_tuned_processor_version_name = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The previousFineTunedProcessorVersionName to set.
      Returns:
      This builder for chaining.

    • clearPreviousFineTunedProcessorVersionName

      public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder clearPreviousFineTunedProcessorVersionName()
       Optional. Resource name of a previously fine tuned version id to copy the
 overwritten configs from. The base_processor_version should be newer than
 the base processor version used to fine tune this provided processor
 version. Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
      string previous_fine_tuned_processor_version_name = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setPreviousFineTunedProcessorVersionNameBytes

      public TrainProcessorVersionRequest.FoundationModelTuningOptions.Builder setPreviousFineTunedProcessorVersionNameBytes(com.google.protobuf.ByteString value)
       Optional. Resource name of a previously fine tuned version id to copy the
 overwritten configs from. The base_processor_version should be newer than
 the base processor version used to fine tune this provided processor
 version. Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
      string previous_fine_tuned_processor_version_name = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for previousFineTunedProcessorVersionName to set.
      Returns:
      This builder for chaining.