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.



3470
3471
3472
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3470

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) 


3402
3403
3404
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3402

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) 


3408
3409
3410
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3408

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


3413
3414
3415
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3413

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) 


3419
3420
3421
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3419

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) 


3427
3428
3429
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3427

def non_present
  @non_present
end

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

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

Returns:



3433
3434
3435
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3433

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:



3440
3441
3442
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3440

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:



3446
3447
3448
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3446

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:



3452
3453
3454
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3452

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) 


3457
3458
3459
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3457

def redacted
  @redacted
end

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

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

Returns:



3463
3464
3465
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3463

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) 


3468
3469
3470
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3468

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3475

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