UsMailV2RecipientAddress
in package
uses
FieldPositionMixin, FieldConfidenceMixin
The addresses of the recipients.
Table of Contents
Properties
- $boundingBox : Polygon|null
- $city : string|null
- $complete : string|null
- $confidence : float
- $isAddressChange : bool
- $polygon : Polygon
- $postalCode : string|null
- $privateMailboxNumber : string|null
- $state : string|null
- $street : string|null
Methods
- __construct() : mixed
- __toString() : string
- toTableLine() : string
- Output in a format suitable for inclusion in an rST table.
- setConfidence() : void
- Sets the confidence score.
- setPosition() : void
- Sets the position of a field.
- printableValues() : array<string|int, mixed>
- Return values for printing as an array.
- tablePrintableValues() : array<string|int, mixed>
- Return values for printing inside an RST table.
Properties
$boundingBox
public
Polygon|null
$boundingBox
A right rectangle containing the word in the document.
$city
public
string|null
$city
The city of the recipient's address.
$complete
public
string|null
$complete
The complete address of the recipient.
$confidence
public
float
$confidence
The confidence score.
$isAddressChange
public
bool
$isAddressChange
Indicates if the recipient's address is a change of address.
$polygon
public
Polygon
$polygon
A polygon containing the word in the document.
$postalCode
public
string|null
$postalCode
The postal code of the recipient's address.
$privateMailboxNumber
public
string|null
$privateMailboxNumber
The private mailbox number of the recipient's address.
$state
public
string|null
$state
Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
$street
public
string|null
$street
The street of the recipient's address.
Methods
__construct()
public
__construct(array<string|int, mixed> $rawPrediction, int|null $pageId) : mixed
Parameters
- $rawPrediction : array<string|int, mixed>
-
Array containing the JSON document response.
- $pageId : int|null
-
Page number for multi pages document.
__toString()
public
__toString() : string
Return values
string —String representation.
toTableLine()
Output in a format suitable for inclusion in an rST table.
public
toTableLine() : string
Return values
stringsetConfidence()
Sets the confidence score.
protected
setConfidence(array<string|int, mixed> $rawPrediction) : void
Parameters
- $rawPrediction : array<string|int, mixed>
-
Raw prediction array.
setPosition()
Sets the position of a field.
protected
setPosition(array<string|int, mixed> $rawPrediction) : void
Parameters
- $rawPrediction : array<string|int, mixed>
-
Raw prediction array.
printableValues()
Return values for printing as an array.
private
printableValues() : array<string|int, mixed>
Return values
array<string|int, mixed>tablePrintableValues()
Return values for printing inside an RST table.
private
tablePrintableValues() : array<string|int, mixed>