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

Inherits:

Object

• Object
• Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue

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

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

  Postal address.

• #boolean_value ⇒ ::Boolean

  Boolean value.

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

  Date value.

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

  DateTime value.

• #float_value ⇒ ::Float

  Float value.

• #integer_value ⇒ ::Integer

  Integer value.

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

  Money value.

• #text ⇒ ::String

  Optional.

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.

Returns:

• (::Google::Type::PostalAddress) —

  Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 764

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.

Returns:

• (::Boolean) —

  Boolean value. Can be used for entities with binary values, or for checkboxes.

# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 764

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.

Returns:

• (::Google::Type::Date) —

  Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 764

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.

Returns:

• (::Google::Type::DateTime) —

  DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 764

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

#float_value ⇒ ::Float

Returns Float value.

Returns:

• (::Float) —

  Float value.

# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 764

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

#integer_value ⇒ ::Integer

Returns Integer value.

Returns:

• (::Integer) —

  Integer value.

# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 764

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.

Returns:

• (::Google::Type::Money) —

  Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 764

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.

# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 764

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