Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity

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

Returns a new instance of GoogleCloudDocumentaiV1DocumentEntity.



1990
1991
1992
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1990

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) 


1932
1933
1934
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1932

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) 


1938
1939
1940
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1938

def id
  @id
end

#mention_id ⇒ String

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

Returns:

  • (String) 


1943
1944
1945
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1943

def mention_id
  @mention_id
end

#mention_text ⇒ String

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy. Corresponds to the JSON property mentionText

Returns:

  • (String) 


1948
1949
1950
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1948

def mention_text
  @mention_text
end

#normalized_value ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityNormalizedValue

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

Returns:



1953
1954
1955
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1953

def normalized_value
  @normalized_value
end

#page_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPageAnchor

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:



1960
1961
1962
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1960

def page_anchor
  @page_anchor
end

#properties ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity>

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

Returns:



1966
1967
1968
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1966

def properties
  @properties
end

#provenance ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentProvenance

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

Returns:



1972
1973
1974
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1972

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) 


1977
1978
1979
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1977

def redacted
  @redacted
end

#text_anchor ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentTextAnchor

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

Returns:



1983
1984
1985
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1983

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) 


1988
1989
1990
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1988

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1995

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