pii.recognizers.address_recognizer#

Module Contents#

Classes#

AddressRecognizer

Address Detector based on usaddress library

API#

class pii.recognizers.address_recognizer.AddressRecognizer#

Bases: presidio_analyzer.LocalRecognizer

Address Detector based on usaddress library

Typical US address format:

  • The recipient’s first and last name

  • Street number and name (address line 1)

  • Apartment or unit and its number (address line 2)

  • City, state and zip code (include all of this on one line with a comma between city and state, but not zip code)

  • Country

analyze(
text: str,
entities,
nlp_artifacts,
) → list[presidio_analyzer.RecognizerResult]#
load() → None#