class Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity
An entity that could be a phrase in the text or a property belongs to the document. It is a known entity type, such as a person, an organization, or location.
Attributes
Optional. Confidence of detected Schema entity. Range [0, 1]. Corresponds to the JSON property `confidence` @return [Float]
Optional. Canonical id. This will be a unique value in the entity list for this document. Corresponds to the JSON property `id` @return [String]
Optional. Deprecated. Use `id` field instead. Corresponds to the JSON property `mentionId` @return [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. Corresponds to the JSON property `mentionText` @return [String]
Parsed and normalized entity value. Corresponds to the JSON property `normalizedValue` @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityNormalizedValue]
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` @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageAnchor]
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. Corresponds to the JSON property `properties` @return [Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity>]
Structure to identify provenance relationships between annotations in different revisions. Corresponds to the JSON property `provenance` @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentProvenance]
Optional. Whether the entity will be redacted for de-identification purposes. Corresponds to the JSON property `redacted` @return [Boolean]
Optional. Whether the entity will be redacted for de-identification purposes. Corresponds to the JSON property `redacted` @return [Boolean]
Text reference indexing into the Document.text. Corresponds to the JSON property `textAnchor` @return [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentTextAnchor]
Entity type from a schema e.g. `Address`. Corresponds to the JSON property `type` @return [String]
Public Class Methods
# File lib/google/apis/documentai_v1/classes.rb, line 1123 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/documentai_v1/classes.rb, line 1128 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