zplCore.comzplCore.com

LabelEntity

public sealed class LabelEntity

A recognised piece of information with confidence, sources and evidence.

Constructors

SignatureDescription
# LabelEntity()

Properties

PropertyTypeDescription
Bounds { get; set; }ExtractBoxUnion of the source boxes.
Carrier { get; init; }stringCarrier id (ups, fedex, dhl, usps, royalmail …) for tracking numbers and carrier entities.
CheckDigitValid { get; init; }bool?Check digit result where the format has a public check digit (null: none or not verified).
Confidence { get; set; }doubleRule-based confidence 0–1 (not a probability).
required Evidence { get; set; }stringWhy the entity was recognised: keyword, pattern, GS1 AI, check digit, layout.
Normalized { get; init; }stringNormalised value: compact tracking number, ISO date, weight in kg/lb, E.164-like phone …
Properties { get; init; }SortedDictionary<string, string>Structured parts, e.g. address blocks: name, company, street, postalCode, city, state, country, countryCode, contact, phone, email; tracking numbers: service, format; dates: kind, ambiguous.
Sources { get; init; }List<EntitySource>
Type { get; init; }EntityType
required Value { get; init; }stringValue as printed or encoded (address blocks: the lines joined with "\n").

Methods

Method SignatureReturnsDescription
# ToString()string