Skip to content

Validate housing under discrimination endpoint

Endpoint for validating a text for possible housing discrimination under fair housing act

Parameters:

Name Type Description Default
request ValidateHUDRequest

request

 required

Returns:

Name Type Description
response ValidateHUDResponse

response
Source code in app/routers.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@router.post('/validate_hud', response_model=schemas.ValidateHUDResponse, response_model_exclude_none=True)
def validate_hud(request: schemas.ValidateHUDRequest) -> schemas.ValidateHUDResponse:
    """
    Endpoint for validating a text for possible housing discrimination under fair housing act

    Parameters
    ----------
    request: schemas.ValidateHUDResponse
        request
    Returns
    -------
    response: schemas.ValidateHUDResponse
        response
    """

    text, home_id = request.text, request.home_id

    sentences_predictions = services.validate_hud(text=text)
    return schemas.ValidateHUDResponse(home_id=home_id, sentences=sentences_predictions)