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, 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}.



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 704

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 fallback to
    # MODEL_BASED.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end
end

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

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

Returns:



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 704

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 fallback to
    # MODEL_BASED.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end
end

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

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

Returns:



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 704

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 fallback to
    # MODEL_BASED.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end
end

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

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

Returns:



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 704

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 fallback to
    # MODEL_BASED.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  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}.



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 704

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 fallback to
    # MODEL_BASED.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end
end

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

Returns Required. The processor version to be created.

Returns:



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 704

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 fallback to
    # MODEL_BASED.
    module TrainingMethod
      TRAINING_METHOD_UNSPECIFIED = 0

      MODEL_BASED = 1

      TEMPLATE_BASED = 2
    end
  end
end