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.



3830
3831
3832
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3830

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) 


3772
3773
3774
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3772

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) 


3778
3779
3780
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3778

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


3783
3784
3785
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3783

def mention_id
  @mention_id
end

#mention_text ⇒ String

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy. Corresponds to the JSON property mentionText

Returns:

  • (String) 


3788
3789
3790
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3788

def mention_text
  @mention_text
end

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

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

Returns:



3793
3794
3795
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3793

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:



3800
3801
3802
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3800

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:



3806
3807
3808
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3806

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:



3812
3813
3814
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3812

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) 


3817
3818
3819
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3817

def redacted
  @redacted
end

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

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

Returns:



3823
3824
3825
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3823

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) 


3828
3829
3830
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3828

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3835

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