Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntity
- Inherits:
-
Object
- Object
- Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntity
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb more...
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.
Instance Attribute Summary collapse
-
#confidence ⇒ Float
Optional.
-
#id ⇒ String
Optional.
-
#mention_id ⇒ String
Optional.
-
#mention_text ⇒ String
Optional.
-
#normalized_value ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue
Parsed and normalized entity value.
-
#page_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageAnchor
Referencing the visual context of the entity in the Document.pages.
-
#properties ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntity>
Optional.
-
#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentProvenance
Structure to identify provenance relationships between annotations in different revisions.
-
#redacted ⇒ Boolean
(also: #redacted?)
Optional.
-
#text_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentTextAnchor
Text reference indexing into the Document.text.
-
#type ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2DocumentEntity
constructor
A new instance of GoogleCloudDocumentaiV1beta2DocumentEntity.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2DocumentEntity
Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentEntity.
7898 7899 7900 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7898 def initialize(**args) update!(**args) end |
Instance Attribute Details
#confidence ⇒ Float
Optional. Confidence of detected Schema entity. Range [0, 1]
.
Corresponds to the JSON property confidence
7840 7841 7842 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7840 def confidence @confidence end |
#id ⇒ String
Optional. Canonical id. This will be a unique value in the entity list for
this document.
Corresponds to the JSON property id
7846 7847 7848 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7846 def id @id end |
#mention_id ⇒ String
Optional. Deprecated. Use id
field instead.
Corresponds to the JSON property mentionId
7851 7852 7853 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7851 def mention_id @mention_id end |
#mention_text ⇒ String
Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy
.
Corresponds to the JSON property mentionText
7856 7857 7858 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7856 def mention_text @mention_text end |
#normalized_value ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue
Parsed and normalized entity value.
Corresponds to the JSON property normalizedValue
7861 7862 7863 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7861 def normalized_value @normalized_value end |
#page_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentPageAnchor
Referencing the visual context of the entity in the Document.pages. Page
anchors can be cross-page, consist of multiple bounding polygons and
optionally reference specific layout element types.
Corresponds to the JSON property pageAnchor
7868 7869 7870 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7868 def page_anchor @page_anchor end |
#properties ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntity>
Optional. Entities can be nested to form a hierarchical data structure
representing the content in the document.
Corresponds to the JSON property properties
7874 7875 7876 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7874 def properties @properties end |
#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentProvenance
Structure to identify provenance relationships between annotations in
different revisions.
Corresponds to the JSON property provenance
7880 7881 7882 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7880 def provenance @provenance end |
#redacted ⇒ Boolean Also known as: redacted?
Optional. Whether the entity will be redacted for de-identification purposes.
Corresponds to the JSON property redacted
7885 7886 7887 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7885 def redacted @redacted end |
#text_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentTextAnchor
Text reference indexing into the Document.text.
Corresponds to the JSON property textAnchor
7891 7892 7893 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7891 def text_anchor @text_anchor end |
#type ⇒ String
Required. Entity type from a schema e.g. Address
.
Corresponds to the JSON property type
7896 7897 7898 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7896 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7903 def update!(**args) @confidence = args[:confidence] if args.key?(:confidence) @id = args[:id] if args.key?(:id) @mention_id = args[:mention_id] if args.key?(:mention_id) @mention_text = args[:mention_text] if args.key?(:mention_text) @normalized_value = args[:normalized_value] if args.key?(:normalized_value) @page_anchor = args[:page_anchor] if args.key?(:page_anchor) @properties = args[:properties] if args.key?(:properties) @provenance = args[:provenance] if args.key?(:provenance) @redacted = args[:redacted] if args.key?(:redacted) @text_anchor = args[:text_anchor] if args.key?(:text_anchor) @type = args[:type] if args.key?(:type) end |