Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue (v1.4.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue.

Parsed and normalized entity value.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#address_value

def address_value() -> ::Google::Type::PostalAddress
Returns
  • (::Google::Type::PostalAddress) — Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

    Note: The following fields are mutually exclusive: address_value, money_value, date_value, datetime_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#address_value=

def address_value=(value) -> ::Google::Type::PostalAddress
Parameter
  • value (::Google::Type::PostalAddress) — Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

    Note: The following fields are mutually exclusive: address_value, money_value, date_value, datetime_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Type::PostalAddress) — Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

    Note: The following fields are mutually exclusive: address_value, money_value, date_value, datetime_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#boolean_value

def boolean_value() -> ::Boolean
Returns
  • (::Boolean) — Boolean value. Can be used for entities with binary values, or for checkboxes.

    Note: The following fields are mutually exclusive: boolean_value, money_value, date_value, datetime_value, address_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#boolean_value=

def boolean_value=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Boolean value. Can be used for entities with binary values, or for checkboxes.

    Note: The following fields are mutually exclusive: boolean_value, money_value, date_value, datetime_value, address_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Boolean) — Boolean value. Can be used for entities with binary values, or for checkboxes.

    Note: The following fields are mutually exclusive: boolean_value, money_value, date_value, datetime_value, address_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#date_value

def date_value() -> ::Google::Type::Date
Returns
  • (::Google::Type::Date) — Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

    Note: The following fields are mutually exclusive: date_value, money_value, datetime_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#date_value=

def date_value=(value) -> ::Google::Type::Date
Parameter
  • value (::Google::Type::Date) — Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

    Note: The following fields are mutually exclusive: date_value, money_value, datetime_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Type::Date) — Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

    Note: The following fields are mutually exclusive: date_value, money_value, datetime_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#datetime_value

def datetime_value() -> ::Google::Type::DateTime
Returns
  • (::Google::Type::DateTime) — DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

    Note: The following fields are mutually exclusive: datetime_value, money_value, date_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#datetime_value=

def datetime_value=(value) -> ::Google::Type::DateTime
Parameter
  • value (::Google::Type::DateTime) — DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

    Note: The following fields are mutually exclusive: datetime_value, money_value, date_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Type::DateTime) — DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

    Note: The following fields are mutually exclusive: datetime_value, money_value, date_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#float_value

def float_value() -> ::Float
Returns
  • (::Float) — Float value.

    Note: The following fields are mutually exclusive: float_value, money_value, date_value, datetime_value, address_value, boolean_value, integer_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#float_value=

def float_value=(value) -> ::Float
Parameter
  • value (::Float) — Float value.

    Note: The following fields are mutually exclusive: float_value, money_value, date_value, datetime_value, address_value, boolean_value, integer_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Float) — Float value.

    Note: The following fields are mutually exclusive: float_value, money_value, date_value, datetime_value, address_value, boolean_value, integer_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#integer_value

def integer_value() -> ::Integer
Returns
  • (::Integer) — Integer value.

    Note: The following fields are mutually exclusive: integer_value, money_value, date_value, datetime_value, address_value, boolean_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#integer_value=

def integer_value=(value) -> ::Integer
Parameter
  • value (::Integer) — Integer value.

    Note: The following fields are mutually exclusive: integer_value, money_value, date_value, datetime_value, address_value, boolean_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Integer) — Integer value.

    Note: The following fields are mutually exclusive: integer_value, money_value, date_value, datetime_value, address_value, boolean_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#money_value

def money_value() -> ::Google::Type::Money
Returns
  • (::Google::Type::Money) — Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

    Note: The following fields are mutually exclusive: money_value, date_value, datetime_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#money_value=

def money_value=(value) -> ::Google::Type::Money
Parameter
  • value (::Google::Type::Money) — Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

    Note: The following fields are mutually exclusive: money_value, date_value, datetime_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Type::Money) — Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

    Note: The following fields are mutually exclusive: money_value, date_value, datetime_value, address_value, boolean_value, integer_value, float_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text

def text() -> ::String
Returns
  • (::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.

#text=

def text=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.