class Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue

Parsed and normalized entity value.

Attributes

address_value[RW]

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 i18n-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: support. google.com/business/answer/6397478 Corresponds to the JSON property `addressValue` @return [Google::Apis::DocumentaiV1beta3::GoogleTypePostalAddress]

boolean_value[RW]

Boolean value. Can be used for entities with binary values, or for checkboxes. Corresponds to the JSON property `booleanValue` @return [Boolean]

boolean_value?[RW]

Boolean value. Can be used for entities with binary values, or for checkboxes. Corresponds to the JSON property `booleanValue` @return [Boolean]

date_value[RW]

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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and ` google.protobuf.Timestamp`. Corresponds to the JSON property `dateValue` @return [Google::Apis::DocumentaiV1beta3::GoogleTypeDate]

datetime_value[RW]

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 is 0, the DateTime is considered not to have a specific year. month and day must have valid, non- zero values. 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` @return [Google::Apis::DocumentaiV1beta3::GoogleTypeDateTime]

float_value[RW]

Float value. Corresponds to the JSON property `floatValue` @return [Float]

integer_value[RW]

Integer value. Corresponds to the JSON property `integerValue` @return [Fixnum]

money_value[RW]

Represents an amount of money with its currency type. Corresponds to the JSON property `moneyValue` @return [Google::Apis::DocumentaiV1beta3::GoogleTypeMoney]

text[RW]

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 int 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` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/documentai_v1beta3/classes.rb, line 3073
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/documentai_v1beta3/classes.rb, line 3078
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