Google Cloud Document Ai V1 Client - Class NormalizedValue (2.1.2)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class NormalizedValue.

Parsed and normalized entity value.

Generated from protobuf message google.cloud.documentai.v1.Document.Entity.NormalizedValue

Namespace

Google \ Cloud \ DocumentAI \ V1 \ Document \ Entity

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ money_value Google\Type\Money

Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
↳ date_value Google\Type\Date

Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
↳ datetime_value Google\Type\DateTime

DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
↳ address_value Google\Type\PostalAddress

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

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

Integer value.
↳ float_value float

Float value.
↳ 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.

getMoneyValue

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

Returns
Type Description
Google\Type\Money|null

hasMoneyValue

setMoneyValue

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

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this

getDateValue

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

Returns
Type Description
Google\Type\Date|null

hasDateValue

setDateValue

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

Parameter
Name Description
var Google\Type\Date
Returns
Type Description
$this

getDatetimeValue

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

Returns
Type Description
Google\Type\DateTime|null

hasDatetimeValue

setDatetimeValue

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

Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getAddressValue

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

Returns
Type Description
Google\Type\PostalAddress|null

hasAddressValue

setAddressValue

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

Parameter
Name Description
var Google\Type\PostalAddress
Returns
Type Description
$this

getBooleanValue

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

Returns
Type Description
bool

hasBooleanValue

setBooleanValue

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getIntegerValue

Integer value.

Returns
Type Description
int

hasIntegerValue

setIntegerValue

Integer value.

Parameter
Name Description
var int
Returns
Type Description
$this

getFloatValue

Float value.

Returns
Type Description
float

hasFloatValue

setFloatValue

Float value.

Parameter
Name Description
var float
Returns
Type Description
$this

getText

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
Type Description
string

setText

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getStructuredValue

Returns
Type Description
string