Class: Google::Cloud::DocumentAI::V1beta3::Document::Entity

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/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

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].



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
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.



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
end

#mention_id ⇒ ::String

Returns Optional. Deprecated. Use id field instead.

Returns:

  • (::String) —

    Optional. Deprecated. Use id field instead.



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
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.



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
end

#normalized_value ⇒ ::Google::Cloud::DocumentAI::V1beta3::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:



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
end

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

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

Returns:



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
end

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

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

Returns:



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
end

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

Returns Optional. The history of this annotation.

Returns:



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
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.



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
end

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

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

Returns:



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
end

#type ⇒ ::String

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

Returns:

  • (::String) —

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



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 616

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
  # @!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
  # @!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
  # @!attribute [rw] address_value
  #   @return [::Google::Type::PostalAddress]
  #     Postal address. See also:
  #     https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
  # @!attribute [rw] boolean_value
  #   @return [::Boolean]
  #     Boolean value. Can be used for entities with binary values, or for
  #     checkboxes.
  # @!attribute [rw] integer_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] float_value
  #   @return [::Float]
  #     Float value.
  # @!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 int 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
end