Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentEntity

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



3896
3897
3898
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3896

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) 


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

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) 


3834
3835
3836
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3834

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


3839
3840
3841
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3839

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) 


3845
3846
3847
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3845

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) 


3853
3854
3855
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3853

def non_present
  @non_present
end

#normalized_value ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue

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

Returns:



3859
3860
3861
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3859

def normalized_value
  @normalized_value
end

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



3866
3867
3868
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3866

def page_anchor
  @page_anchor
end

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



3872
3873
3874
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3872

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentProvenance

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

Returns:



3878
3879
3880
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3878

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) 


3883
3884
3885
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3883

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentTextAnchor

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

Returns:



3889
3890
3891
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3889

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) 


3894
3895
3896
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3894

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3901

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