Class: Google::Cloud::DocumentAI::V1::Document::Entity

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

Overview

An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.

Defined Under Namespace

Modules: Method Classes: NormalizedValue

Instance Attribute Summary collapse

Instance Attribute Details

#confidence ⇒ ::Float

Returns Optional. Confidence of detected Schema entity. Range [0, 1].

Returns:

  • (::Float) —

    Optional. Confidence of detected Schema entity. Range [0, 1].



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#id ⇒ ::String

Returns Optional. Canonical id. This will be a unique value in the entity list for this document.

Returns:

  • (::String) —

    Optional. Canonical id. This will be a unique value in the entity list for this document.



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#mention_id ⇒ ::String

Returns Optional. Deprecated. Use id field instead.

Returns:

  • (::String) —

    Optional. Deprecated. Use id field instead.



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#mention_text ⇒ ::String

Returns Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

Returns:

  • (::String) —

    Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#method ⇒ ::Google::Cloud::DocumentAI::V1::Document::Entity::Method

Returns Optional. Specifies how the entity's value is obtained.

Returns:



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#normalized_value ⇒ ::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue

Returns Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.

Returns:



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#page_anchor ⇒ ::Google::Cloud::DocumentAI::V1::Document::PageAnchor

Returns Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

Returns:



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#properties ⇒ ::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>

Returns Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

Returns:



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#provenance ⇒ ::Google::Cloud::DocumentAI::V1::Document::Provenance

Returns Optional. The history of this annotation.

Returns:



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#redacted ⇒ ::Boolean

Returns Optional. Whether the entity will be redacted for de-identification purposes.

Returns:

  • (::Boolean) —

    Optional. Whether the entity will be redacted for de-identification purposes.



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#text_anchor ⇒ ::Google::Cloud::DocumentAI::V1::Document::TextAnchor

Returns Optional. Provenance of the entity. Text anchor indexing into the Document.text.

Returns:



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end

#type ⇒ ::String

Returns Required. Entity type from a schema e.g. Address.

Returns:

  • (::String) —

    Required. Entity type from a schema e.g. Address.



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
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
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 730

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

  # Parsed and normalized entity value.
  # @!attribute [rw] money_value
  #   @return [::Google::Type::Money]
  #     Money value. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
  #
  #     Note: The following fields are mutually exclusive: `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] date_value
  #   @return [::Google::Type::Date]
  #     Date value. Includes year, month, day. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
  #
  #     Note: The following fields are mutually exclusive: `date_value`, `money_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] datetime_value
  #   @return [::Google::Type::DateTime]
  #     DateTime value. Includes date, time, and timezone. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
  #
  #     Note: The following fields are mutually exclusive: `datetime_value`, `money_value`, `date_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  #
  #     Note: The following fields are mutually exclusive: `address_value`, `money_value`, `date_value`, `datetime_value`, `boolean_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  #
  #     Note: The following fields are mutually exclusive: `boolean_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `integer_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  #
  #     Note: The following fields are mutually exclusive: `integer_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `float_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  #
  #     Note: The following fields are mutually exclusive: `float_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `signature_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] signature_value
  #   @return [::Boolean]
  #     Note: The following fields are mutually exclusive: `signature_value`, `money_value`, `date_value`, `datetime_value`, `address_value`, `boolean_value`, `integer_value`, `float_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] text
  #   @return [::String]
  #     Optional. An optional field to store a normalized string.
  #     For some entity types, one of respective `structured_value` fields may
  #     also be populated. Also not all the types of `structured_value` will be
  #     normalized. For example, some processors may not generate `float`
  #     or `integer` normalized text by default.
  #
  #     Below are sample formats mapped to structured values.
  #
  #     - Money/Currency type (`money_value`) is in the ISO 4217 text format.
  #     - Date type (`date_value`) is in the ISO 8601 text format.
  #     - Datetime type (`datetime_value`) is in the ISO 8601 text format.
  class NormalizedValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies how the entity's value is obtained.
  module Method
    # When the method is not specified, it should be treated as `EXTRACT`.
    METHOD_UNSPECIFIED = 0

    # The entity's value is directly extracted as-is from the document
    # text.
    EXTRACT = 1

    # The entity's value is derived through inference and is not
    # necessarily an exact text extraction from the document.
    DERIVE = 2
  end
end