Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntity

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



3024
3025
3026
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3024

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) 


2965
2966
2967
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2965

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) 


2971
2972
2973
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2971

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


2976
2977
2978
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2976

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) 


2982
2983
2984
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2982

def mention_text
  @mention_text
end

#normalized_value ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue

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

Returns:



2987
2988
2989
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2987

def normalized_value
  @normalized_value
end

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



2994
2995
2996
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 2994

def page_anchor
  @page_anchor
end

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



3000
3001
3002
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3000

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentProvenance

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

Returns:



3006
3007
3008
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3006

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) 


3011
3012
3013
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3011

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentTextAnchor

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

Returns:



3017
3018
3019
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3017

def text_anchor
  @text_anchor
end

#type ⇒ String

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

Returns:

  • (String) 


3022
3023
3024
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3022

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 3029

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