FinancialDocumentV1LineItem
in package
uses
FieldPositionMixin, FieldConfidenceMixin
List of line item details.
Table of Contents
Properties
- $boundingBox : Polygon|null
- $confidence : float
- $description : string|null
- $polygon : Polygon
- $productCode : string|null
- $quantity : float|null
- $taxAmount : float|null
- $taxRate : float|null
- $totalAmount : float|null
- $unitMeasure : string|null
- $unitPrice : float|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.
$confidence
public
float
$confidence
The confidence score.
$description
public
string|null
$description
The item description.
$polygon
public
Polygon
$polygon
A polygon containing the word in the document.
$productCode
public
string|null
$productCode
The product code referring to the item.
$quantity
public
float|null
$quantity
The item quantity
$taxAmount
public
float|null
$taxAmount
The item tax amount.
$taxRate
public
float|null
$taxRate
The item tax rate in percentage.
$totalAmount
public
float|null
$totalAmount
The item total amount.
$unitMeasure
public
string|null
$unitMeasure
The item unit of measure.
$unitPrice
public
float|null
$unitPrice
The item unit price.
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>