@mailwoman/kind-classifier
v11.1.0
Published
Stage 2.5 of the runtime pipeline — categorize inputs by query shape (postcode_only / locality_only / structured_address / intersection / po_box / landmark / vague). Rule-based for v1.
Readme
@mailwoman/kind-classifier
This package is stage 2.5 of the Mailwoman runtime pipeline. It classifies the query kind.
It assigns an input to one of seven QueryKinds by combining rule-based scorers
over the QueryShape output. It returns alternatives alongside the top pick, so
the coordinator can fall back when the winning kind isn't actionable.
import { classifyKind } from "@mailwoman/kind-classifier"
const result = await classifyKind(queryShape, localeHint)
// result.kind → "structured_address"
// result.alternatives → [{kind: "intersection", confidence: 0.2}, ...]The seven query kinds
| Kind | Example |
| -------------------- | --------------------------------------------------- |
| structured_address | "1600 Amphitheatre Pkwy, Mountain View, CA 94043" |
| postcode_only | "94043" or "SW1A 1AA" |
| locality_only | "Mountain View" or "San Francisco" |
| intersection | "Market St & Van Ness Ave" |
| po_box | "PO Box 12345" |
| landmark | "Eiffel Tower" |
| vague | "somewhere near the river" |
API
classifyKind(shape: QueryShapeLike, locale?: LocaleHint): Promise<QueryKindResult>
classifyKindSync(shape: QueryShapeLike, locale?: LocaleHint): QueryKindResult
// Individual scorers
scoreStructuredAddress(input: NormalizedInputLite, shape: QueryShapeLike): number
scorePostcodeOnly(shape: QueryShapeLike): number
scoreLocalityOnly(shape: QueryShapeLike): number
scoreIntersection(input: NormalizedInputLite, shape: QueryShapeLike): number
scorePoBox(input: NormalizedInputLite, shape: QueryShapeLike): number
scoreLandmark(shape: QueryShapeLike): number
scoreVague(shape: QueryShapeLike): numberPipeline position
locale-hint → kind-classifier → phrase-grouper → classifier → ...Design
- Pure functions without ML. Version 1 is rule-based, and a trained classifier is deferred.
- Returns alternatives. The coordinator might skip a
locality_onlyparse and fall back to avaguehandler. The alternatives list makes that fallback possible. - Consumes
QueryShape+LocaleHintfrom the two preceding stages.
Related
@mailwoman/query-shape: supplies structural data to this stage.@mailwoman/locale-hint: supplies locale context.@mailwoman/phrase-grouper: stage 2.7, next in the pipeline.- Staged Pipeline Interface
