Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentEntity

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

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentEntity.



3652
3653
3654
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3652

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) 


3593
3594
3595
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3593

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) 


3599
3600
3601
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3599

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


3604
3605
3606
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3604

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) 


3610
3611
3612
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3610

def mention_text
  @mention_text
end

#normalized_value ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue

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

Returns:



3615
3616
3617
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3615

def normalized_value
  @normalized_value
end

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



3622
3623
3624
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3622

def page_anchor
  @page_anchor
end

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



3628
3629
3630
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3628

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance

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

Returns:



3634
3635
3636
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3634

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) 


3639
3640
3641
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3639

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTextAnchor

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

Returns:



3645
3646
3647
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3645

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) 


3650
3651
3652
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3650

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 3657

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