NLP.Postal

Provides an interface for the libpostal NLP library

Documentation

data AddressParserOptions

Phantom type for a Ptr containing address parser options

data NormalizeOptions

Phantom type for a Ptr containing options for the normalizer

setup :: IO Int

Calls libpostal_setup() to set up the library Make sure you call this before anything else

setupParser :: IO Int

Calls libpostal_setup_parser() to set up the address parser Call this before trying to parse addresses

setupLanguageClassifier :: IO Int

Calls libpostal_setup_language_classifier() to set up the classifier Call this before doing address normaliation

getAddressParserDefaultOptions :: IO (Ptr AddressParserOptions)

Returns default parser options returned by libpostal_get_address_parser_default_options()

getDefaultNormalizeOptions :: IO (Ptr NormalizeOptions)

Returns default normalizer options returned by libpostal_get_default_options()

parseAddress :: Ptr AddressParserOptions -> Text -> IO [(Text, Text)]

Parse an address Calls libpostal_parse_address() to parse an address and returns the parsed parts as a list of key-value tuples (an association list).

expandAddress :: Ptr NormalizeOptions -> Text -> IO [Text]

Returns the expansion of an address Calls libpostal_expand_address() to normalize an address and return the list of normalized addresses.

tearDownParser :: IO ()

Calls libpostal_teardown_parser()

tearDownLanguageClassifier :: IO ()

Calls libpostal_teardown_language_classifier()

tearDown :: IO ()

Calls libpostal_teardown()