Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity

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

Returns a new instance of GoogleCloudDocumentaiV1DocumentEntity.



1020
1021
1022
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1020

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) 


961
962
963
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 961

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) 


967
968
969
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 967

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


972
973
974
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 972

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) 


978
979
980
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 978

def mention_text
  @mention_text
end

#normalized_value ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityNormalizedValue

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

Returns:



983
984
985
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 983

def normalized_value
  @normalized_value
end

#page_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageAnchor

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:



990
991
992
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 990

def page_anchor
  @page_anchor
end

#properties ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity>

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

Returns:



996
997
998
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 996

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentProvenance

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

Returns:



1002
1003
1004
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1002

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) 


1007
1008
1009
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1007

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentTextAnchor

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

Returns:



1013
1014
1015
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1013

def text_anchor
  @text_anchor
end

#type ⇒ String

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

Returns:

  • (String) 


1018
1019
1020
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1018

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1025

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