Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Document::Entity (v0.3.0)

Version 0.3.0

• 1.3.0 (latest)
• 1.2.0
• 1.1.1
• 1.0.0
• 0.23.1
• 0.22.0
• 0.21.1
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.2
• 0.16.2
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.4

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Document::Entity.

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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#confidence

def confidence() -> ::Float

Returns

• (::Float) — Optional. Confidence of detected Schema entity. Range [0, 1].

#confidence=

def confidence=(value) -> ::Float

Parameter

• value (::Float) — Optional. Confidence of detected Schema entity. Range [0, 1].

Returns

• (::Float) — Optional. Confidence of detected Schema entity. Range [0, 1].

#id

def id() -> ::String

Returns

• (::String) — Optional. Canonical id. This will be a unique value in the entity list for this document.

#id=

def id=(value) -> ::String

Parameter

• value (::String) — 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.

#mention_id

def mention_id() -> ::String

Returns

• (::String) — Optional. Deprecated. Use id field instead.

#mention_id=

def mention_id=(value) -> ::String

Parameter

• value (::String) — Optional. Deprecated. Use id field instead.

Returns

• (::String) — Optional. Deprecated. Use id field instead.

#mention_text

def mention_text() -> ::String

Returns

• (::String) — 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.

#mention_text=

def mention_text=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#normalized_value

def normalized_value() -> ::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue

Returns

• (::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue) — 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.

#normalized_value=

def normalized_value=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue

Parameter

• value (::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue) — 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

• (::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue) — 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.

#page_anchor

def page_anchor() -> ::Google::Cloud::DocumentAI::V1::Document::PageAnchor

Returns

• (::Google::Cloud::DocumentAI::V1::Document::PageAnchor) — Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

#page_anchor=

def page_anchor=(value) -> ::Google::Cloud::DocumentAI::V1::Document::PageAnchor

Parameter

• value (::Google::Cloud::DocumentAI::V1::Document::PageAnchor) — Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

Returns

• (::Google::Cloud::DocumentAI::V1::Document::PageAnchor) — Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

#properties

def properties() -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>

Returns

• (::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>) — Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

#properties=

def properties=(value) -> ::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>) — Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>) — Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

#provenance

def provenance() -> ::Google::Cloud::DocumentAI::V1::Document::Provenance

Returns

• (::Google::Cloud::DocumentAI::V1::Document::Provenance) — Optional. The history of this annotation.

#provenance=

def provenance=(value) -> ::Google::Cloud::DocumentAI::V1::Document::Provenance

Parameter

• value (::Google::Cloud::DocumentAI::V1::Document::Provenance) — Optional. The history of this annotation.

Returns

• (::Google::Cloud::DocumentAI::V1::Document::Provenance) — Optional. The history of this annotation.

#redacted

def redacted() -> ::Boolean

Returns

• (::Boolean) — Optional. Whether the entity will be redacted for de-identification purposes.

#redacted=

def redacted=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. Whether the entity will be redacted for de-identification purposes.

Returns

• (::Boolean) — Optional. Whether the entity will be redacted for de-identification purposes.

#text_anchor

def text_anchor() -> ::Google::Cloud::DocumentAI::V1::Document::TextAnchor

Returns

• (::Google::Cloud::DocumentAI::V1::Document::TextAnchor) — Optional. Provenance of the entity. Text anchor indexing into the Document.text.

#text_anchor=

def text_anchor=(value) -> ::Google::Cloud::DocumentAI::V1::Document::TextAnchor

Parameter

• value (::Google::Cloud::DocumentAI::V1::Document::TextAnchor) — Optional. Provenance of the entity. Text anchor indexing into the Document.text.

Returns

• (::Google::Cloud::DocumentAI::V1::Document::TextAnchor) — Optional. Provenance of the entity. Text anchor indexing into the Document.text.

#type

def type() -> ::String

Returns

• (::String) — Entity type from a schema e.g. Address.

#type=

def type=(value) -> ::String

Parameter

• value (::String) — Entity type from a schema e.g. Address.

Returns

• (::String) — Entity type from a schema e.g. Address.