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

A phrase in the text that 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].



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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 in the document e.g. 1600 Amphitheatre Pkwy.

Returns:

  • (::String)

    Optional. Text value in the document e.g. 1600 Amphitheatre Pkwy.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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:



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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:



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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:



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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:



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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:



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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 Entity type from a schema e.g. Address.

Returns:

  • (::String)

    Entity type from a schema e.g. Address.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 532

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] text
  #   @return [::String]
  #     Required. Normalized entity value stored as a string. This field is populated for
  #     supported document type (e.g. Invoice). For some entity types, one of
  #     respective 'structured_value' fields may also be populated.
  #
  #     - 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