Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Document::Entity (v1.1.1)

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 of the entity e.g. 1600 Amphitheatre Pkwy.

#mention_text=

def mention_text=(value) -> ::String
Parameter
  • value (::String) — Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.
Returns
  • (::String) — Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

#normalized_value

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

#normalized_value=

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

#page_anchor

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

#page_anchor=

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

#properties

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

#properties=

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

#provenance

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

#provenance=

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

#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

#text_anchor=

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

#type

def type() -> ::String
Returns
  • (::String) — Required. Entity type from a schema e.g. Address.

#type=

def type=(value) -> ::String
Parameter
  • value (::String) — Required. Entity type from a schema e.g. Address.
Returns
  • (::String) — Required. Entity type from a schema e.g. Address.