Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentEntity

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

Returns a new instance of GoogleCloudDocumentaiV1beta3DocumentEntity.



5310
5311
5312
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5310

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) 


5251
5252
5253
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5251

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) 


5257
5258
5259
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5257

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


5262
5263
5264
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5262

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) 


5268
5269
5270
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5268

def mention_text
  @mention_text
end

#normalized_value ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue

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

Returns:



5273
5274
5275
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5273

def normalized_value
  @normalized_value
end

#page_anchor ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageAnchor

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:



5280
5281
5282
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5280

def page_anchor
  @page_anchor
end

#properties ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentEntity>

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

Returns:



5286
5287
5288
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5286

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentProvenance

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

Returns:



5292
5293
5294
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5292

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) 


5297
5298
5299
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5297

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextAnchor

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

Returns:



5303
5304
5305
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5303

def text_anchor
  @text_anchor
end

#type ⇒ String

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

Returns:

  • (String) 


5308
5309
5310
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5308

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5315

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