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.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 717

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

  # Structure for referencing parent provenances.  When an element replaces
  # one of more other elements parent references identify the elements that
  # are replaced.
  # @!attribute [rw] revision
  #   @return [::Integer]
  #     The index of the [Document.revisions] identifying 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.
    OPERATION_TYPE_UNSPECIFIED = 0

    # Add an element.  Implicit if no `parents` are set for the provenance.
    ADD = 1

    # The element is removed.  No `parents` should be set.
    REMOVE = 2

    # Explicitly replaces the element(s) identified by `parents`.
    REPLACE = 3

    # Element is requested for human review.
    EVAL_REQUESTED = 4

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

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

Returns References to the original elements that are replaced.

Returns:



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 717

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

  # Structure for referencing parent provenances.  When an element replaces
  # one of more other elements parent references identify the elements that
  # are replaced.
  # @!attribute [rw] revision
  #   @return [::Integer]
  #     The index of the [Document.revisions] identifying 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.
    OPERATION_TYPE_UNSPECIFIED = 0

    # Add an element.  Implicit if no `parents` are set for the provenance.
    ADD = 1

    # The element is removed.  No `parents` should be set.
    REMOVE = 2

    # Explicitly replaces the element(s) identified by `parents`.
    REPLACE = 3

    # Element is requested for human review.
    EVAL_REQUESTED = 4

    # Element is review and approved at human review, confidence will be set
    # to 1.0
    EVAL_APPROVED = 5
  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.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 717

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

  # Structure for referencing parent provenances.  When an element replaces
  # one of more other elements parent references identify the elements that
  # are replaced.
  # @!attribute [rw] revision
  #   @return [::Integer]
  #     The index of the [Document.revisions] identifying 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.
    OPERATION_TYPE_UNSPECIFIED = 0

    # Add an element.  Implicit if no `parents` are set for the provenance.
    ADD = 1

    # The element is removed.  No `parents` should be set.
    REMOVE = 2

    # Explicitly replaces the element(s) identified by `parents`.
    REPLACE = 3

    # Element is requested for human review.
    EVAL_REQUESTED = 4

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

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

Returns The type of provenance operation.

Returns:



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 717

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

  # Structure for referencing parent provenances.  When an element replaces
  # one of more other elements parent references identify the elements that
  # are replaced.
  # @!attribute [rw] revision
  #   @return [::Integer]
  #     The index of the [Document.revisions] identifying 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.
    OPERATION_TYPE_UNSPECIFIED = 0

    # Add an element.  Implicit if no `parents` are set for the provenance.
    ADD = 1

    # The element is removed.  No `parents` should be set.
    REMOVE = 2

    # Explicitly replaces the element(s) identified by `parents`.
    REPLACE = 3

    # Element is requested for human review.
    EVAL_REQUESTED = 4

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