Fair Housing Validator
API for checking text in case of fair housing violation, profanity or competitors.
Endpoints
- /api/check_status checking the API status
Endpoint will return 200 OK if it is available.
- /api/check_competitors checking competitors
Check if competitors names and profanities are exist in the given text. The field is_all_valid will be identified if there are violation in any of the sentence. The banned_words field will be filed with possible violations.
NOTE THAT COMPANY NAMES WILL BE DETECTED IF THERE WRITTEN IN TITLECASE.
List of competitors names. Corcoran, Sothebys, Compass, Brown Harris Stevens, The Agency, Houlihan Lawrence, Daniel Gale, Triplemint, Bespoke, Nestseekers, Serhant, Keller Williams, Bond, Oxford, R NY, Signature, Saunders, Engel & Volkers.
- /api/validate_text checking fair housing violation, profanity and competitors
Check if any fair housing violations, competitors names or profanities are exist in the given text. Endpoint will return the segmented sentences and the is_valid boolean for identifying the presence of any of them in the sentence. The probability field means the probability of sentence being not valid. The location field start and end are the starting and ending indices of the sentence. The field is_all_valid will be identified if there are violation in any of the sentence. The banned_words field will be filed with possible competitors names and profanities.
- /api/validate_hud checking housing discrimination under fair housing act
Check if any housing discrimination under the fair housing act exist in the given text. Endpoint will return the segmented sentences. The sentence filed shows segmented sentence and the probability field means the probability of sentence being not valid.