Class: Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

Overview

Request message for the TrainProcessorVersion method.

Defined Under Namespace

Classes: CustomDocumentExtractionOptions, FoundationModelTuningOptions, InputData

Instance Attribute Summary collapse

Instance Attribute Details

#base_processor_version ⇒ ::String

Returns Optional. The processor version to use as a base for training. This processor version must be a child of parent. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.

Returns:

  • (::String) —

    Optional. The processor version to use as a base for training. This processor version must be a child of parent. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 813

class TrainProcessorVersionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for testing the trained version.
  class InputData
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to control the training of the Custom Document Extraction (CDE)
  # Processor.
  # @!attribute [rw] training_method
  #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions::TrainingMethod]
  #     Training method to use for CDE training.
  class CustomDocumentExtractionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Training Method for CDE. `TRAINING_METHOD_UNSPECIFIED` will fall back to
    # `MODEL_BASED`.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end

  # Options to control foundation model tuning of the processor.
  # @!attribute [rw] train_steps
  #   @return [::Integer]
  #     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.
  # @!attribute [rw] learning_rate_multiplier
  #   @return [::Float]
  #     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.
  class FoundationModelTuningOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#custom_document_extraction_options ⇒ ::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions

Returns Options to control Custom Document Extraction (CDE) Processor.

Returns:



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 813

class TrainProcessorVersionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for testing the trained version.
  class InputData
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to control the training of the Custom Document Extraction (CDE)
  # Processor.
  # @!attribute [rw] training_method
  #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions::TrainingMethod]
  #     Training method to use for CDE training.
  class CustomDocumentExtractionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Training Method for CDE. `TRAINING_METHOD_UNSPECIFIED` will fall back to
    # `MODEL_BASED`.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end

  # Options to control foundation model tuning of the processor.
  # @!attribute [rw] train_steps
  #   @return [::Integer]
  #     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.
  # @!attribute [rw] learning_rate_multiplier
  #   @return [::Float]
  #     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.
  class FoundationModelTuningOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#document_schema ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentSchema

Returns Optional. The schema the processor version will be trained with.

Returns:



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 813

class TrainProcessorVersionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for testing the trained version.
  class InputData
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to control the training of the Custom Document Extraction (CDE)
  # Processor.
  # @!attribute [rw] training_method
  #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions::TrainingMethod]
  #     Training method to use for CDE training.
  class CustomDocumentExtractionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Training Method for CDE. `TRAINING_METHOD_UNSPECIFIED` will fall back to
    # `MODEL_BASED`.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end

  # Options to control foundation model tuning of the processor.
  # @!attribute [rw] train_steps
  #   @return [::Integer]
  #     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.
  # @!attribute [rw] learning_rate_multiplier
  #   @return [::Float]
  #     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.
  class FoundationModelTuningOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#foundation_model_tuning_options ⇒ ::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::FoundationModelTuningOptions

Returns Options to control foundation model tuning of a processor.

Returns:



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 813

class TrainProcessorVersionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for testing the trained version.
  class InputData
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to control the training of the Custom Document Extraction (CDE)
  # Processor.
  # @!attribute [rw] training_method
  #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions::TrainingMethod]
  #     Training method to use for CDE training.
  class CustomDocumentExtractionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Training Method for CDE. `TRAINING_METHOD_UNSPECIFIED` will fall back to
    # `MODEL_BASED`.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end

  # Options to control foundation model tuning of the processor.
  # @!attribute [rw] train_steps
  #   @return [::Integer]
  #     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.
  # @!attribute [rw] learning_rate_multiplier
  #   @return [::Float]
  #     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.
  class FoundationModelTuningOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#input_data ⇒ ::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::InputData

Returns Optional. The input data used to train the ProcessorVersion.

Returns:



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 813

class TrainProcessorVersionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for testing the trained version.
  class InputData
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to control the training of the Custom Document Extraction (CDE)
  # Processor.
  # @!attribute [rw] training_method
  #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions::TrainingMethod]
  #     Training method to use for CDE training.
  class CustomDocumentExtractionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Training Method for CDE. `TRAINING_METHOD_UNSPECIFIED` will fall back to
    # `MODEL_BASED`.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end

  # Options to control foundation model tuning of the processor.
  # @!attribute [rw] train_steps
  #   @return [::Integer]
  #     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.
  # @!attribute [rw] learning_rate_multiplier
  #   @return [::Float]
  #     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.
  class FoundationModelTuningOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parent ⇒ ::String

Returns Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.

Returns:

  • (::String) —

    Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 813

class TrainProcessorVersionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for testing the trained version.
  class InputData
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to control the training of the Custom Document Extraction (CDE)
  # Processor.
  # @!attribute [rw] training_method
  #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions::TrainingMethod]
  #     Training method to use for CDE training.
  class CustomDocumentExtractionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Training Method for CDE. `TRAINING_METHOD_UNSPECIFIED` will fall back to
    # `MODEL_BASED`.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end

  # Options to control foundation model tuning of the processor.
  # @!attribute [rw] train_steps
  #   @return [::Integer]
  #     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.
  # @!attribute [rw] learning_rate_multiplier
  #   @return [::Float]
  #     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.
  class FoundationModelTuningOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#processor_version ⇒ ::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion

Returns Required. The processor version to be created.

Returns:



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 813

class TrainProcessorVersionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
  #     The documents used for testing the trained version.
  class InputData
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options to control the training of the Custom Document Extraction (CDE)
  # Processor.
  # @!attribute [rw] training_method
  #   @return [::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest::CustomDocumentExtractionOptions::TrainingMethod]
  #     Training method to use for CDE training.
  class CustomDocumentExtractionOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Training Method for CDE. `TRAINING_METHOD_UNSPECIFIED` will fall back to
    # `MODEL_BASED`.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end

  # Options to control foundation model tuning of the processor.
  # @!attribute [rw] train_steps
  #   @return [::Integer]
  #     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.
  # @!attribute [rw] learning_rate_multiplier
  #   @return [::Float]
  #     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.
  class FoundationModelTuningOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end