BillOfLadingV1Consignee
in package
uses
FieldPositionMixin, FieldConfidenceMixin
The party to whom the goods are being shipped.
Table of Contents
Properties
- $address : string|null
- $boundingBox : Polygon|null
- $confidence : float
- $email : string|null
- $name : string|null
- $phone : string|null
- $polygon : Polygon
Methods
- __construct() : mixed
- __toString() : string
- toFieldList() : string
- Output in a format suitable for inclusion in a field list.
- 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
$address
public
string|null
$address
The address of the consignee.
$boundingBox
public
Polygon|null
$boundingBox
A right rectangle containing the word in the document.
$confidence
public
float
$confidence
The confidence score.
public
string|null
$email
The email of the shipper.
$name
public
string|null
$name
The name of the consignee.
$phone
public
string|null
$phone
The phone number of the consignee.
$polygon
public
Polygon
$polygon
A polygon containing the word in the document.
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.
toFieldList()
Output in a format suitable for inclusion in a field list.
public
toFieldList() : 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>