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 | |
|---|---|
| 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 |
getMoneyValue
Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
Generated from protobuf field .google.type.Money money_value = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Type\Money|null | |
hasMoneyValue
setMoneyValue
Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
Generated from protobuf field .google.type.Money money_value = 2;
| 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
Generated from protobuf field .google.type.Date date_value = 3;
| 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
Generated from protobuf field .google.type.Date date_value = 3;
| 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
Generated from protobuf field .google.type.DateTime datetime_value = 4;
| 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
Generated from protobuf field .google.type.DateTime datetime_value = 4;
| 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
Generated from protobuf field .google.type.PostalAddress address_value = 5;
| 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
Generated from protobuf field .google.type.PostalAddress address_value = 5;
| 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.
Generated from protobuf field bool boolean_value = 6;
| Returns | |
|---|---|
| Type | Description |
bool | |
hasBooleanValue
setBooleanValue
Boolean value. Can be used for entities with binary values, or for checkboxes.
Generated from protobuf field bool boolean_value = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIntegerValue
Integer value.
Generated from protobuf field int32 integer_value = 7;
| Returns | |
|---|---|
| Type | Description |
int | |
hasIntegerValue
setIntegerValue
Integer value.
Generated from protobuf field int32 integer_value = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFloatValue
Float value.
Generated from protobuf field float float_value = 8;
| Returns | |
|---|---|
| Type | Description |
float | |
hasFloatValue
setFloatValue
Float value.
Generated from protobuf field float float_value = 8;
| 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 int 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.
Generated from protobuf field string text = 1 [(.google.api.field_behavior) = OPTIONAL];
| 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 int 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.
Generated from protobuf field string text = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStructuredValue
| Returns | |
|---|---|
| Type | Description |
string | |