Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentEntity

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



2972
2973
2974
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2972

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) 


2913
2914
2915
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2913

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) 


2919
2920
2921
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2919

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


2924
2925
2926
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2924

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) 


2930
2931
2932
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2930

def mention_text
  @mention_text
end

#normalized_value ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue

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

Returns:



2935
2936
2937
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2935

def normalized_value
  @normalized_value
end

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



2942
2943
2944
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2942

def page_anchor
  @page_anchor
end

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



2948
2949
2950
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2948

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentProvenance

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

Returns:



2954
2955
2956
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2954

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) 


2959
2960
2961
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2959

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTextAnchor

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

Returns:



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

def text_anchor
  @text_anchor
end

#type ⇒ String

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

Returns:

  • (String) 


2970
2971
2972
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2970

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2977

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