Skip to content

Extract

Extractor endpoints

extract_headlines(request) async

Endpoint for extracting headlines from remark

Parameters:

Name Type Description Default
request ExtractHeadlinesRequest

house data

 required

Returns:

Name Type Description
response ExtractHeadlinesResponse

all patterns and the best of them
Source code in app/routers/extract.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
@router.post('/extract_headlines', response_model=response_schema.ExtractHeadlinesResponse,
             response_model_exclude_none=True)
async def extract_headlines(request: request_schema.ExtractHeadlinesRequest):
    """
    Endpoint for extracting headlines from remark

    Parameters
    ----------
    request : request_schema.ExtractHeadlinesRequest
        house data

    Returns
    -------
    response : response_schema.ExtractHeadlinesResponse
        all patterns and the best of them
    """
    listing_id = request.listing_id
    remark = request.remark
    min_length = request.min_char
    headlines, all_patterns = services.extract_headlines(remark, min_length)
    return response_schema.ExtractHeadlinesResponse(listing_id=listing_id, headlines=headlines,
                                                    all_patterns=all_patterns)

process_remark(request) async

Sentencize the remark and extract the home related patterns from it

Parameters:

Name Type Description Default
request ProcessRemarkRequest

house data

 required

Returns:

Name Type Description
response ProcessRemarkResponse

all patterns and the best of them
Source code in app/routers/extract.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
@router.post('/process_remark', response_model=response_schema.ProcessRemarkResponse,
             response_model_exclude_none=True)
async def process_remark(request: request_schema.ProcessRemarkRequest):
    """
    Sentencize the remark and extract the home related patterns from it

    Parameters
    ----------
    request : request_schema.ProcessRemarkRequest
        house data

    Returns
    -------
    response : response_schema.ProcessRemarkResponse
        all patterns and the best of them
    """

    headlines, all_patterns = services.extract_headlines(remark=request.remark,
                                                         min_length=request.min_char)
    sentences = services.sentencize(text=request.remark)
    return response_schema.ProcessRemarkResponse(listing_id=request.listing_id,
                                                 headlines=headlines,
                                                 sentences=sentences)

extract_features(request) async

Endpoint for extracting features

Parameters:

Name Type Description Default
request ExtractFeaturesRequest

home data

 required

Returns:

Name Type Description
response ExtractFeaturesResponse

list of features of the house
Source code in app/routers/extract.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
@router.post('/extract_features', response_model=response_schema.ExtractFeaturesResponse,
             response_model_exclude_none=True)
async def extract_features(request: request_schema.ExtractFeaturesRequest):
    """
    Endpoint for extracting features

    Parameters
    ----------
    request : request_schema.ExtractFeaturesRequest
        home data

    Returns
    -------
    response : response_schema.ExtractFeaturesResponse
        list of features of the house
    """
    listing_id = request.listing_id
    remark = request.remark

    features = services.extract_features(remark)
    return response_schema.ExtractFeaturesResponse(listing_id=listing_id, features=features)

return_unique_features() async

Endpoint for getting unique features

Returns:

Name Type Description
response UniqueFeatures

list of unique features
Source code in app/routers/extract.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
@router.get('/unique_features', response_model=response_schema.UniqueFeaturesResponse,
            response_model_exclude_none=True)
async def return_unique_features():
    """
    Endpoint for getting unique features

    Returns
    -------
    response : response_schema.UniqueFeatures
        list of unique features
    """
    features = services.return_unique_features()
    return response_schema.UniqueFeaturesResponse(features=features)