Class: Google::Cloud::DocumentAI::V1::TrainProcessorVersionRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/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}.



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 742

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

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1::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::V1::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::V1::TrainProcessorVersionRequest::CustomDocumentExtractionOptions

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

Returns:



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 742

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

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1::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::V1::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::V1::DocumentSchema

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

Returns:



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 742

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

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1::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::V1::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::V1::TrainProcessorVersionRequest::FoundationModelTuningOptions

Returns Options to control foundation model tuning of a processor.

Returns:



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 742

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

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1::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::V1::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::V1::TrainProcessorVersionRequest::InputData

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

Returns:



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 742

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

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1::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::V1::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}.



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 742

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

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1::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::V1::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::V1::ProcessorVersion

Returns Required. The processor version to be created.

Returns:



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'proto_docs/google/cloud/documentai/v1/document_processor_service.rb', line 742

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

  # The input data used to train a new
  # {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
  # @!attribute [rw] training_documents
  #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
  #     The documents used for training the new version.
  # @!attribute [rw] test_documents
  #   @return [::Google::Cloud::DocumentAI::V1::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::V1::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