Health Card V1

Sample Code:

class HealthCardV1(raw_prediction)

Health Card API version 1 inference prediction.

static get_endpoint_info(klass)

Retrives the endpoint information for an Inference.

Should never retrieve info for CustomV1, as a custom endpoint should be created to use CustomV1.

Parameters:

klass (Type[Inference]) – product subclass to access endpoint information.

Return type:

Dict[str, str]

endpoint_name: Optional[str] = 'french_healthcard'

Name of the endpoint.

endpoint_version: Optional[str] = '1'

Version of the endpoint.

is_rotation_applied: Optional[bool]

Whether the document has had any rotation applied to it.

page_id: Optional[int]

Optional page id for page-level predictions.

pages: List[Page[HealthCardV1Document]]

Page-level prediction(s).

prediction: HealthCardV1Document

Document-level prediction.

product: Product

Name and version of a given product, as sent back by the API.

class HealthCardV1Document(raw_prediction, page_id=None)

Health Card API version 1.0 document data.

Parameters:

• raw_prediction (Dict[str, Any]) –

• page_id (Optional[int]) –

given_names: List[StringField]

The given names of the card holder.

issuance_date: DateField

The date when the carte vitale document was issued.

social_security: StringField

The social security number of the card holder.

surname: StringField

The surname of the card holder.