IdCardV1
extends Inference
in package
Carte Nationale d'Identité API version 1 inference prediction.
Table of Contents
Properties
- $endpointName : string
- $endpointVersion : string
- $isRotationApplied : bool|null
- $pageId : int|null
- $pages : array<string|int, mixed>
- $prediction : Prediction
- $product : Product
Methods
- __construct() : mixed
- __toString() : string
Properties
$endpointName
public
static string
$endpointName
= "idcard_fr"
Name of the endpoint.
$endpointVersion
public
static string
$endpointVersion
= "1"
Version of the endpoint.
$isRotationApplied
public
bool|null
$isRotationApplied
Whether the document has had any rotation applied to it.
$pageId
public
int|null
$pageId
Optional page id for page-level predictions.
$pages
public
array<string|int, mixed>
$pages
A document's pages.
$prediction
public
Prediction
$prediction
A document's top-level Prediction.
$product
public
Product
$product
Name and version of a given product, as sent back by the API.
Methods
__construct()
public
__construct(array<string|int, mixed> $rawPrediction) : mixed
Parameters
- $rawPrediction : array<string|int, mixed>
-
Raw prediction from the HTTP response.
__toString()
public
__toString() : string
Return values
string —String representation.