Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntity

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

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentEntity.



5346
5347
5348
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5346

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) 


5287
5288
5289
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5287

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) 


5293
5294
5295
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5293

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


5298
5299
5300
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5298

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) 


5304
5305
5306
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5304

def mention_text
  @mention_text
end

#normalized_value ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue

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

Returns:



5309
5310
5311
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5309

def normalized_value
  @normalized_value
end

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



5316
5317
5318
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5316

def page_anchor
  @page_anchor
end

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



5322
5323
5324
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5322

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentProvenance

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

Returns:



5328
5329
5330
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5328

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) 


5333
5334
5335
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5333

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentTextAnchor

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

Returns:



5339
5340
5341
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5339

def text_anchor
  @text_anchor
end

#type ⇒ String

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

Returns:

  • (String) 


5344
5345
5346
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5344

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 5351

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