Class: Google::Cloud::DocumentAI::V1beta3::Document::Provenance

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

Overview

Structure to identify provenance relationships between annotations in different revisions.

Defined Under Namespace

Modules: OperationType Classes: Parent

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ ::Integer

Returns The Id of this operation. Needs to be unique within the scope of the revision.

Returns:

  • (::Integer) —

    The Id of this operation. Needs to be unique within the scope of the revision.



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 787

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

  # The parent element the current element is based on. Used for
  # referencing/aligning, removal and replacement operations.
  # @!attribute [rw] revision
  #   @return [::Integer]
  #     The index of the index into current revision's parent_ids list.
  # @!attribute [rw] index
  #   @return [::Integer]
  #     The index of the parent item in the corresponding item list (eg. list
  #     of entities, properties within entities, etc.) in the parent revision.
  # @!attribute [rw] id
  #   @return [::Integer]
  #     The id of the parent provenance.
  class Parent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # If a processor or agent does an explicit operation on existing elements.
  module OperationType
    # Operation type unspecified. If no operation is specified a provenance
    # entry is simply used to match against a `parent`.
    OPERATION_TYPE_UNSPECIFIED = 0

    # Add an element.
    ADD = 1

    # Remove an element identified by `parent`.
    REMOVE = 2

    # Replace an element identified by `parent`.
    REPLACE = 3

    # Request human review for the element identified by `parent`.
    EVAL_REQUESTED = 4

    # Element is reviewed and approved at human review, confidence will be
    # set to 1.0.
    EVAL_APPROVED = 5

    # Element is skipped in the validation process.
    EVAL_SKIPPED = 6
  end
end

#parents ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Provenance::Parent>

Returns References to the original elements that are replaced.

Returns:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 787

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

  # The parent element the current element is based on. Used for
  # referencing/aligning, removal and replacement operations.
  # @!attribute [rw] revision
  #   @return [::Integer]
  #     The index of the index into current revision's parent_ids list.
  # @!attribute [rw] index
  #   @return [::Integer]
  #     The index of the parent item in the corresponding item list (eg. list
  #     of entities, properties within entities, etc.) in the parent revision.
  # @!attribute [rw] id
  #   @return [::Integer]
  #     The id of the parent provenance.
  class Parent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # If a processor or agent does an explicit operation on existing elements.
  module OperationType
    # Operation type unspecified. If no operation is specified a provenance
    # entry is simply used to match against a `parent`.
    OPERATION_TYPE_UNSPECIFIED = 0

    # Add an element.
    ADD = 1

    # Remove an element identified by `parent`.
    REMOVE = 2

    # Replace an element identified by `parent`.
    REPLACE = 3

    # Request human review for the element identified by `parent`.
    EVAL_REQUESTED = 4

    # Element is reviewed and approved at human review, confidence will be
    # set to 1.0.
    EVAL_APPROVED = 5

    # Element is skipped in the validation process.
    EVAL_SKIPPED = 6
  end
end

#revision ⇒ ::Integer

Returns The index of the revision that produced this element.

Returns:

  • (::Integer) —

    The index of the revision that produced this element.



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 787

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

  # The parent element the current element is based on. Used for
  # referencing/aligning, removal and replacement operations.
  # @!attribute [rw] revision
  #   @return [::Integer]
  #     The index of the index into current revision's parent_ids list.
  # @!attribute [rw] index
  #   @return [::Integer]
  #     The index of the parent item in the corresponding item list (eg. list
  #     of entities, properties within entities, etc.) in the parent revision.
  # @!attribute [rw] id
  #   @return [::Integer]
  #     The id of the parent provenance.
  class Parent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # If a processor or agent does an explicit operation on existing elements.
  module OperationType
    # Operation type unspecified. If no operation is specified a provenance
    # entry is simply used to match against a `parent`.
    OPERATION_TYPE_UNSPECIFIED = 0

    # Add an element.
    ADD = 1

    # Remove an element identified by `parent`.
    REMOVE = 2

    # Replace an element identified by `parent`.
    REPLACE = 3

    # Request human review for the element identified by `parent`.
    EVAL_REQUESTED = 4

    # Element is reviewed and approved at human review, confidence will be
    # set to 1.0.
    EVAL_APPROVED = 5

    # Element is skipped in the validation process.
    EVAL_SKIPPED = 6
  end
end

#type ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Provenance::OperationType

Returns The type of provenance operation.

Returns:



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 787

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

  # The parent element the current element is based on. Used for
  # referencing/aligning, removal and replacement operations.
  # @!attribute [rw] revision
  #   @return [::Integer]
  #     The index of the index into current revision's parent_ids list.
  # @!attribute [rw] index
  #   @return [::Integer]
  #     The index of the parent item in the corresponding item list (eg. list
  #     of entities, properties within entities, etc.) in the parent revision.
  # @!attribute [rw] id
  #   @return [::Integer]
  #     The id of the parent provenance.
  class Parent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # If a processor or agent does an explicit operation on existing elements.
  module OperationType
    # Operation type unspecified. If no operation is specified a provenance
    # entry is simply used to match against a `parent`.
    OPERATION_TYPE_UNSPECIFIED = 0

    # Add an element.
    ADD = 1

    # Remove an element identified by `parent`.
    REMOVE = 2

    # Replace an element identified by `parent`.
    REPLACE = 3

    # Request human review for the element identified by `parent`.
    EVAL_REQUESTED = 4

    # Element is reviewed and approved at human review, confidence will be
    # set to 1.0.
    EVAL_APPROVED = 5

    # Element is skipped in the validation process.
    EVAL_SKIPPED = 6
  end
end