--- title: "OneContact documentation" url: https://recursiveai.org/onecontact/docs/docs-map/ description: "Start with the README for the packages, the quick start and the results. Documents about the trained model packages are marked from 1.1. Coming from…" version: "1.0.0" source: https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/index.md --- # OneContact documentation Start with the [README](https://recursiveai.org/onecontact/docs/overview/) for the packages, the quick start and the results. Documents about the trained model packages are marked *from 1.1*. Coming from another library? Read [migrating.md](https://recursiveai.org/onecontact/docs/migrating/) first. The rest of this folder is ordered the way you will probably need it. Documents marked *maintainer* describe how the project is built and measured, not how to use it. ## Using the library ### Phones - [phones.md](https://recursiveai.org/onecontact/docs/phones/): parsing, validation, number types, every format, the as-you-type formatter, the matcher and its leniency levels, short numbers, example numbers, the metadata and how to load newer metadata. - [phones-geo.md](https://recursiveai.org/onecontact/docs/phones-geo/): the geocoder, carrier and time-zone mappers (`RecursiveAI.OneContact.Phones.Geo`), with the original-carrier caveat. ### Email - [email.md](https://recursiveai.org/onecontact/docs/email/): what `EmailAddress` reads (RFC 5322, RFC 6531), the canonical form, flags (role account, free provider, disposable), the key rules per provider, typo suggestions. ### Web addresses - [web.md](https://recursiveai.org/onecontact/docs/web/): `WebAddress`, WHATWG URL parsing, canonical form, tracking parameters, the key, social-profile flags. - [psl.md](https://recursiveai.org/onecontact/docs/psl/): the Public Suffix List lookups and how our additions sit beside the unmodified list. - [idna.md](https://recursiveai.org/onecontact/docs/idna/): internationalized host names (UTS #46). ### Addresses - [address-structural.md](https://recursiveai.org/onecontact/docs/address-structural/): the worldwide structural layer: fields, layout, required fields, postcode patterns, `Validate()`. - [address-rules-us-ca.md](https://recursiveai.org/onecontact/docs/address-rules-us-ca/): United States and Canada: parsing and the postal authorities' styles (USPS Publication 28, Canada Post). - Tier 2 countries, one document per group of postal authorities: [address-rules-tier2-a.md](https://recursiveai.org/onecontact/docs/address-rules-tier2-a/) (FR, BE, NL, LU, DE, AT, CH, LI, MC), [address-rules-tier2-b.md](https://recursiveai.org/onecontact/docs/address-rules-tier2-b/) (GB and Crown dependencies, IE, ES, PT, IT, MT, SM, VA, AD), [address-rules-tier2-c-north.md](https://recursiveai.org/onecontact/docs/address-rules-tier2-c-north/) (DK, SE, FI, NO, IS, EE, LV, LT), [address-rules-tier2-c-south.md](https://recursiveai.org/onecontact/docs/address-rules-tier2-c-south/) (PL, CZ, SK, SI, HR, HU, RO, MX, AU). - [address-last-line-orders.md](https://recursiveai.org/onecontact/docs/address-last-line-orders/): how the last line (postcode, town, region) is read in each country's order. - [address-country-undetermined.md](https://recursiveai.org/onecontact/docs/address-country-undetermined/): inferring the country from the text, and what is reported when several fit. - [address-dictionaries.md](https://recursiveai.org/onecontact/docs/address-dictionaries/) and [address-keys.md](https://recursiveai.org/onecontact/docs/address-keys/): expansion dictionaries and the address key. - [api-shapes.md](https://recursiveai.org/onecontact/docs/api-shapes/): parse overloads, reasons, regions, formats, explicit models, JSON and limits. ### Names and companies - [names.md](https://recursiveai.org/onecontact/docs/names/): person names: hints, classes, parts, casing restoration, order, multi-person splits. - [name-keys.md](https://recursiveai.org/onecontact/docs/name-keys/): the person key. - [company-names.md](https://recursiveai.org/onecontact/docs/company-names/): company names, ISO 20275 legal forms with ELF codes, DBA and c/o, the company key. ### Extraction - [extraction.md](https://recursiveai.org/onecontact/docs/extraction/): `ContactExtractor`: structured markup, visible text, obfuscation decoding, records, site merge, disagreements, limits. It carries the data-protection note. ### Models (from 1.1) Version 1.0 runs on rules and markup alone. The model packages follow in 1.1, after OneNLP 1.0; these documents describe them and the seam in core that they plug into. - [models.md](https://recursiveai.org/onecontact/docs/models/): how a model package reaches the parsers, what the Tier 1 model is, how it was trained. - [models-superset.md](https://recursiveai.org/onecontact/docs/models-superset/): the `RecursiveAI.OneContact.Models` package (United States, Canada and the Tier 2 countries). - [models-accurate.md](https://recursiveai.org/onecontact/docs/models-accurate/): the `RecursiveAI.OneContact.Models.Accurate` package. ### Keys, data and notices - Keys are described next to each kind: [phones.md](https://recursiveai.org/onecontact/docs/phones/), [email.md](https://recursiveai.org/onecontact/docs/email/), [web.md](https://recursiveai.org/onecontact/docs/web/), [address-keys.md](https://recursiveai.org/onecontact/docs/address-keys/), [name-keys.md](https://recursiveai.org/onecontact/docs/name-keys/), [company-names.md](https://recursiveai.org/onecontact/docs/company-names/). Any change to key rules ships as a new `KeyVersion`; a published version never changes. - [THIRD-PARTY-NOTICES.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/THIRD-PARTY-NOTICES.md): the licences and credits of the data the packages carry. - `upstream//PIN`: the exact upstream release and file hashes behind each compiled data table. ## Maintainers and evaluation - [architecture.md](https://recursiveai.org/onecontact/docs/architecture/) *(maintainer)*: how code and compiled data fit together, the data file format, how value types are shaped. - [tools-environment.md](https://recursiveai.org/onecontact/docs/tools-environment/) *(maintainer)*: where the tools keep data, models and evaluation sets. - [maintainers/refusal-rows.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/refusal-rows.md) *(maintainer)*: the honest-refusal rows, how wrong-country and invented readings are counted, and every cause found. - [maintainers/](https://github.com/recursive-ai-oss/onecontact-csharp/tree/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers) *(maintainer notes)*: measured rows and tuning history ([models-superset.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/models-superset.md), [models-tier1-measurements.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/models-tier1-measurements.md), [extraction-measurements.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/extraction-measurements.md), [address-recovery.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/address-recovery.md)), the address challenger models ([models-challenger.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/models-challenger.md)), the crawl-labelled span head ([extraction-crawl-training.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/extraction-crawl-training.md)), and how the real-text evaluation sets are built, labelled and scored ([evaluation-sets.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/evaluation-sets.md), [extraction-eval-sets.md](https://github.com/recursive-ai-oss/onecontact-csharp/blob/90204cd135c124cf1cb0ed3d7b2d40bab55e645b/docs/maintainers/extraction-eval-sets.md)). The sets themselves are private; only aggregate numbers are published. - Training data *(maintainer)*: [training-data-address-us-ca.md](https://recursiveai.org/onecontact/docs/training-data-address-us-ca/), [training-data-address-tier2-a.md](https://recursiveai.org/onecontact/docs/training-data-address-tier2-a/), [training-data-address-tier2-b.md](https://recursiveai.org/onecontact/docs/training-data-address-tier2-b/), [training-data-address-tier2-c.md](https://recursiveai.org/onecontact/docs/training-data-address-tier2-c/), [training-data-address-challenger.md](https://recursiveai.org/onecontact/docs/training-data-address-challenger/): which open registers are rendered into training examples, under which licences.