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.



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 913

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

    # Updates any fields within the given provenance scope of the message. It
    # overwrites the fields rather than replacing them.  Use this when you
    # want to update a field value of an entity without also updating all the
    # child properties.
    UPDATE = 7

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

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

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

    # Deprecated. 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:



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 913

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

    # Updates any fields within the given provenance scope of the message. It
    # overwrites the fields rather than replacing them.  Use this when you
    # want to update a field value of an entity without also updating all the
    # child properties.
    UPDATE = 7

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

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

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

    # Deprecated. 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.



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 913

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

    # Updates any fields within the given provenance scope of the message. It
    # overwrites the fields rather than replacing them.  Use this when you
    # want to update a field value of an entity without also updating all the
    # child properties.
    UPDATE = 7

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

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

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

    # Deprecated. 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:



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 913

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

    # Updates any fields within the given provenance scope of the message. It
    # overwrites the fields rather than replacing them.  Use this when you
    # want to update a field value of an entity without also updating all the
    # child properties.
    UPDATE = 7

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

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

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

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