DocumentBarcode Class

A barcode object.

Inheritance

builtins.object

DocumentBarcode

Constructor

DocumentBarcode(**kwargs: Any)

Methods

from_dict	Converts a dict in the shape of a DocumentBarcode to the model itself.
to_dict	Returns a dict representation of DocumentBarcode.

from_dict

Converts a dict in the shape of a DocumentBarcode to the model itself.

from_dict(data: Dict[str, Any]) -> DocumentBarcode

Parameters

Name	Description
data Required	dict A dictionary in the shape of DocumentBarcode.

Returns

Type	Description
DocumentBarcode	DocumentBarcode

to_dict

Returns a dict representation of DocumentBarcode.

to_dict() -> Dict[str, Any]

Returns

Type	Description
Dict[str, Any]	Dict[str, Any]

Attributes

confidence

Confidence of correctly extracting the barcode.

confidence: float

kind

Barcode kind. Known values are "QRCode", "PDF417", "UPCA", "UPCE", "Code39", "Code128", "EAN8", "EAN13", "DataBar", "Code93", "Codabar", "DataBarExpanded", "ITF", "MicroQRCode", "Aztec", "DataMatrix", "MaxiCode".

kind: Literal['QRCode', 'PDF417', 'UPCA', 'UPCE', 'Code39', 'Code128', 'EAN8', 'EAN13', 'DataBar', 'Code93', 'Codabar', 'DataBarExpanded', 'ITF', 'MicroQRCode', 'Aztec', 'DataMatrix', 'MaxiCode']

polygon

Bounding polygon of the barcode.

polygon: Sequence[Point]

span

Location of the barcode in the reading order concatenated content.

span: DocumentSpan

value

Barcode value.

value: str