Class: Google::Cloud::DocumentAI::V1beta3::Document::Entity
- Inherits:
-
Object
- Object
- Google::Cloud::DocumentAI::V1beta3::Document::Entity
- 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
-
#confidence ⇒ ::Float
Optional.
-
#id ⇒ ::String
Optional.
-
#mention_id ⇒ ::String
Optional.
-
#mention_text ⇒ ::String
Optional.
-
#normalized_value ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Entity::NormalizedValue
Optional.
-
#page_anchor ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor
Optional.
-
#properties ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>
Optional.
-
#provenance ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Provenance
Optional.
-
#redacted ⇒ ::Boolean
Optional.
-
#text_anchor ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::TextAnchor
Optional.
-
#type ⇒ ::String
Entity type from a schema e.g.
Instance Attribute Details
#confidence ⇒ ::Float
Returns Optional. Confidence of detected Schema entity. Range [0, 1].
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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 in the document e.g. 1600 Amphitheatre Pkwy
. If
the entity is not present in the document, this field will be empty.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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 Entity type from a schema e.g. Address
.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 580 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] # 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 |