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 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.



6387
6388
6389
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6387

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) 


6328
6329
6330
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6328

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) 


6334
6335
6336
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6334

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


6339
6340
6341
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6339

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) 


6345
6346
6347
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6345

def mention_text
  @mention_text
end

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

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

Returns:



6350
6351
6352
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6350

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:



6357
6358
6359
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6357

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:



6363
6364
6365
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6363

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:



6369
6370
6371
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6369

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) 


6374
6375
6376
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6374

def redacted
  @redacted
end

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

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

Returns:



6380
6381
6382
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6380

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) 


6385
6386
6387
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6385

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6392

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