Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentEntity

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

Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentEntity.



1502
1503
1504
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1502

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) 


1443
1444
1445
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1443

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) 


1449
1450
1451
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1449

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


1454
1455
1456
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1454

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) 


1460
1461
1462
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1460

def mention_text
  @mention_text
end

#normalized_value ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue

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

Returns:



1465
1466
1467
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1465

def normalized_value
  @normalized_value
end

#page_anchor ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentPageAnchor

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:



1472
1473
1474
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1472

def page_anchor
  @page_anchor
end

#properties ⇒ Array<Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentEntity>

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

Returns:



1478
1479
1480
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1478

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentProvenance

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

Returns:



1484
1485
1486
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1484

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) 


1489
1490
1491
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1489

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1DocumentTextAnchor

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

Returns:



1495
1496
1497
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1495

def text_anchor
  @text_anchor
end

#type ⇒ String

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

Returns:

  • (String) 


1500
1501
1502
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1500

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1507

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