Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentEntity

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/representations.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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3DocumentEntity

Returns a new instance of GoogleCloudDocumentaiV1beta3DocumentEntity.



5625
5626
5627
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5625

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

Returns:

  • (Float) 


5557
5558
5559
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5557

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

Returns:

  • (String) 


5563
5564
5565
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5563

def id
  @id
end

#mention_id ⇒ String

Optional. Deprecated. Use id field instead. Corresponds to the JSON property mentionId

Returns:

  • (String) 


5568
5569
5570
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5568

def mention_id
  @mention_id
end

#mention_text ⇒ 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

Returns:

  • (String) 


5574
5575
5576
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5574

def mention_text
  @mention_text
end

#non_present ⇒ Boolean Also known as: non_present?

Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. Corresponds to the JSON property nonPresent

Returns:

  • (Boolean) 


5582
5583
5584
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5582

def non_present
  @non_present
end

#normalized_value ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue

Parsed and normalized entity value. Corresponds to the JSON property normalizedValue

Returns:



5588
5589
5590
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5588

def normalized_value
  @normalized_value
end

#page_anchor ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageAnchor

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

Returns:



5595
5596
5597
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5595

def page_anchor
  @page_anchor
end

#properties ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentEntity>

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. Corresponds to the JSON property properties

Returns:



5601
5602
5603
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5601

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance

Structure to identify provenance relationships between annotations in different revisions. Corresponds to the JSON property provenance

Returns:



5607
5608
5609
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5607

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

Returns:

  • (Boolean) 


5612
5613
5614
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5612

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextAnchor

Text reference indexing into the Document.text. Corresponds to the JSON property textAnchor

Returns:



5618
5619
5620
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5618

def text_anchor
  @text_anchor
end

#type ⇒ String

Required. Entity type from a schema e.g. Address. Corresponds to the JSON property type

Returns:

  • (String) 


5623
5624
5625
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5623

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5630

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)
  @non_present = args[:non_present] if args.key?(:non_present)
  @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