Class: Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/document.rb

Overview

Parsed and normalized entity value.

Instance Attribute Summary collapse

Instance Attribute Details

#address_value ⇒ ::Google::Type::PostalAddress

Returns 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:



785
786
787
788
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 785

class NormalizedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#boolean_value ⇒ ::Boolean

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



785
786
787
788
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 785

class NormalizedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#date_value ⇒ ::Google::Type::Date

Returns 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:



785
786
787
788
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 785

class NormalizedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#datetime_value ⇒ ::Google::Type::DateTime

Returns 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:



785
786
787
788
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 785

class NormalizedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#float_value ⇒ ::Float

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



785
786
787
788
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 785

class NormalizedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#integer_value ⇒ ::Integer

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



785
786
787
788
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 785

class NormalizedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#money_value ⇒ ::Google::Type::Money

Returns 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:



785
786
787
788
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 785

class NormalizedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text ⇒ ::String

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


785
786
787
788
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 785

class NormalizedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end