Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue
- Inherits:
-
Object
- Object
- Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue
- 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 more...
Overview
Parsed and normalized entity value.
Instance Attribute Summary collapse
-
#address_value ⇒ Google::Apis::DocumentaiV1::GoogleTypePostalAddress
Represents a postal address, e.g.
-
#boolean_value ⇒ Boolean
(also: #boolean_value?)
Boolean value.
-
#date_value ⇒ Google::Apis::DocumentaiV1::GoogleTypeDate
Represents a whole or partial calendar date, such as a birthday.
-
#datetime_value ⇒ Google::Apis::DocumentaiV1::GoogleTypeDateTime
Represents civil time (or occasionally physical time).
-
#float_value ⇒ Float
Float value.
-
#integer_value ⇒ Fixnum
Integer value.
-
#money_value ⇒ Google::Apis::DocumentaiV1::GoogleTypeMoney
Represents an amount of money with its currency type.
-
#text ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue
constructor
A new instance of GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue
Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue.
7999 8000 8001 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7999 def initialize(**args) update!(**args) end |
Instance Attribute Details
#address_value ⇒ Google::Apis::DocumentaiV1::GoogleTypePostalAddress
Represents a postal address, e.g. for postal delivery or payments addresses.
Given a postal address, a postal service can deliver items to a premise, P.O.
Box or similar. It is not intended to model geographical locations (roads,
towns, mountains). In typical usage an address would be created via user input
or from importing existing data, depending on the type of process. Advice on
address input / editing: - Use an internationalization-ready address widget
such as https://github.com/google/libaddressinput) - Users should not be
presented with UI elements for input or editing of fields outside countries
where that field is used. For more guidance on how to use this schema, please
see: https://support.google.com/business/answer/6397478
Corresponds to the JSON property addressValue
7934 7935 7936 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7934 def address_value @address_value end |
#boolean_value ⇒ Boolean Also known as: boolean_value?
Boolean value. Can be used for entities with binary values, or for checkboxes.
Corresponds to the JSON property booleanValue
7939 7940 7941 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7939 def boolean_value @boolean_value end |
#date_value ⇒ Google::Apis::DocumentaiV1::GoogleTypeDate
Represents a whole or partial calendar date, such as a birthday. The time of
day and time zone are either specified elsewhere or are insignificant. The
date is relative to the Gregorian Calendar. This can represent one of the
following: * A full date, with non-zero year, month, and day values. * A month
and day, with a zero year (for example, an anniversary). * A year on its own,
with a zero month and a zero day. * A year and month, with a zero day (for
example, a credit card expiration date). Related types: * google.type.
TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
Corresponds to the JSON property dateValue
7952 7953 7954 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7952 def date_value @date_value end |
#datetime_value ⇒ Google::Apis::DocumentaiV1::GoogleTypeDateTime
Represents civil time (or occasionally physical time). This type can represent
a civil time in one of a few possible ways: * When utc_offset is set and
time_zone is unset: a civil time on a calendar day with a particular offset
from UTC. * When time_zone is set and utc_offset is unset: a civil time on a
calendar day in a particular time zone. * When neither time_zone nor
utc_offset is set: a civil time on a calendar day in local time. The date is
relative to the Proleptic Gregorian Calendar. If year, month, or day are 0,
the DateTime is considered not to have a specific year, month, or day
respectively. This type may also be used to represent a physical time if all
the date and time fields are set and either case of the time_offset
oneof is
set. Consider using Timestamp
message for physical time instead. If your use
case also would like to store the user's timezone, that can be done in another
field. This type is more flexible than some applications may want. Make sure
to document and validate your application's limitations.
Corresponds to the JSON property datetimeValue
7970 7971 7972 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7970 def datetime_value @datetime_value end |
#float_value ⇒ Float
Float value.
Corresponds to the JSON property floatValue
7975 7976 7977 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7975 def float_value @float_value end |
#integer_value ⇒ Fixnum
Integer value.
Corresponds to the JSON property integerValue
7980 7981 7982 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7980 def integer_value @integer_value end |
#money_value ⇒ Google::Apis::DocumentaiV1::GoogleTypeMoney
Represents an amount of money with its currency type.
Corresponds to the JSON property moneyValue
7985 7986 7987 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7985 def money_value @money_value end |
#text ⇒ String
Optional. An optional field to store a normalized string. For some entity
types, one of respective structured_value
fields may also be populated. Also
not all the types of structured_value
will be normalized. For example, some
processors may not generate float
or integer
normalized text by default.
Below are sample formats mapped to structured values. - Money/Currency type (
money_value
) is in the ISO 4217 text format. - Date type (date_value
) is in
the ISO 8601 text format. - Datetime type (datetime_value
) is in the ISO
8601 text format.
Corresponds to the JSON property text
7997 7998 7999 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 7997 def text @text end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 |
# File 'lib/google/apis/documentai_v1/classes.rb', line 8004 def update!(**args) @address_value = args[:address_value] if args.key?(:address_value) @boolean_value = args[:boolean_value] if args.key?(:boolean_value) @date_value = args[:date_value] if args.key?(:date_value) @datetime_value = args[:datetime_value] if args.key?(:datetime_value) @float_value = args[:float_value] if args.key?(:float_value) @integer_value = args[:integer_value] if args.key?(:integer_value) @money_value = args[:money_value] if args.key?(:money_value) @text = args[:text] if args.key?(:text) end |