Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntity

Inherits:
Object
  • Object
show all
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

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) ⇒ GoogleCloudDocumentaiV1beta2DocumentEntity

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentEntity.



5673
5674
5675
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5673

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) 


5605
5606
5607
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5605

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) 


5611
5612
5613
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5611

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


5616
5617
5618
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5616

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) 


5622
5623
5624
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5622

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) 


5630
5631
5632
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5630

def non_present
  @non_present
end

#normalized_value ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue

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

Returns:



5636
5637
5638
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5636

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

Returns:



5643
5644
5645
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5643

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

Returns:



5649
5650
5651
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5649

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

Returns:



5655
5656
5657
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5655

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) 


5660
5661
5662
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5660

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentTextAnchor

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

Returns:



5666
5667
5668
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5666

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) 


5671
5672
5673
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5671

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5678

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