Google Cloud Document Ai V1 Client - Class NormalizedValue (1.2.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

Methods

__construct

Constructor.

Parameters
NameDescription
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

Returns
TypeDescription
Google\Type\Money|null

hasMoneyValue

setMoneyValue

Parameter
NameDescription
var Google\Type\Money
Returns
TypeDescription
$this

getDateValue

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

Returns
TypeDescription
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
NameDescription
var Google\Type\Date
Returns
TypeDescription
$this

getDatetimeValue

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

Returns
TypeDescription
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
NameDescription
var Google\Type\DateTime
Returns
TypeDescription
$this

getAddressValue

Returns
TypeDescription
Google\Type\PostalAddress|null

hasAddressValue

setAddressValue

Parameter
NameDescription
var Google\Type\PostalAddress
Returns
TypeDescription
$this

getBooleanValue

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

Returns
TypeDescription
bool

hasBooleanValue

setBooleanValue

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getIntegerValue

Integer value.

Returns
TypeDescription
int

hasIntegerValue

setIntegerValue

Integer value.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFloatValue

Float value.

Returns
TypeDescription
float

hasFloatValue

setFloatValue

Float value.

Parameter
NameDescription
var float
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getStructuredValue

Returns
TypeDescription
string