Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntity

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



3581
3582
3583
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3581

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) 


3513
3514
3515
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3513

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) 


3519
3520
3521
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3519

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


3524
3525
3526
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3524

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) 


3530
3531
3532
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3530

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) 


3538
3539
3540
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3538

def non_present
  @non_present
end

#normalized_value ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue

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

Returns:



3544
3545
3546
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3544

def normalized_value
  @normalized_value
end

#page_anchor ⇒ Google::Apis::DocumentaiV1beta2::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:



3551
3552
3553
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3551

def page_anchor
  @page_anchor
end

#properties ⇒ Array<Google::Apis::DocumentaiV1beta2::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:



3557
3558
3559
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3557

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance

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

Returns:



3563
3564
3565
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3563

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) 


3568
3569
3570
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3568

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor

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

Returns:



3574
3575
3576
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3574

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) 


3579
3580
3581
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3579

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3586

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