> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.repliers.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Quality Scores Feature Implementation Guide


## Overview

The Quality Scores feature leverages AI technology to evaluate and score the quality of real estate property images. This powerful addition to our imageInsights family enables users to filter, sort, and compare properties based on visual quality assessments, ultimately enhancing the property search experience.

## How Quality Scores Work

Quality scores are generated for specific areas of properties:

* Living rooms
* Bedrooms
* Kitchens
* Bathrooms
* Dining rooms
* Front of structure
* Back of structure

Each evaluated image receives both qualitative and quantitative scores:

**Qualitative scores** use descriptive terms:

*   Poor
*   Below average
*   Average
*   Above average
*   Excellent

**Quantitative scores** range from 1.0 to 6.0, providing numerical precision for filtering and sorting.

For each property feature (kitchen, bedroom, etc.), the system records the highest quality score among all images of that feature, which becomes the representative score in the property summary.

## API Response Structure

Quality scores are integrated into the `imageInsights` object of your API responses. Here's how the data is structured:

```json
"imageInsights": {
    "summary": {
        "quality": {
            "qualitative": {
                "features": {
                    "livingRoom": "excellent",
                    "frontOfStructure": "average",
                    "diningRoom": "above average",
                    "kitchen": "above average",
                    "bathroom": "above average",
                    "bedroom": "excellent"
                },
                "overall": "above average"
            },
            "quantitative": {
                "features": {
                    "livingRoom": 4.79,
                    "frontOfStructure": 3.81,
                    "diningRoom": 4.52,
                    "kitchen": 4.24,
                    "bathroom": 4.04,
                    "bedroom": 4.72
                },
                "overall": 4.13
            }
        }
    },
    "images": [
        // Individual image data with classifications and quality scores
    ]
}
```

Each image in the `images` array contains its own quality assessment:

```json
{
    "image": "IMG-N12089889_18.jpg",
    "quality": {
        "qualitative": "excellent",
        "quantitative": 4.7962913513
    }
}
```

## Filtering by Quality Scores

### Filtering by Qualitative Scores

You can filter listings by qualitative scores using these parameters:

* overallQuality
* kitchenQuality
* bedroomQuality
* bathroomQuality
* livingRoomQuality
* diningRoomQuality
* frontOfStructureQuality
* backOfStructureQuality

**Example**: Find properties with average overall quality:

```
https://api.repliers.io/listings?overallQuality=average
```

**Multiple values**: You can specify multiple acceptable quality levels:

```
https://api.repliers.io/listings?overallQuality=average&overallQuality=above average
```

**Combined filters**: Quality filters can be combined with other parameters:

```
https://api.repliers.io/listings?overallQuality=above average&type=sale&minBeds=4
```

### Filtering by Quantitative Scores

For more precise filtering, use quantitative score parameters:
* minQuality - Minimum quality score (1.0-6.0)
* maxQuality - Maximum quality score (1.0-6.0)

**Example**: Find properties with quality scores between 3.0 and 5.0:

```
https://api.repliers.io/listings?minQuality=3&maxQuality=5
```

## Business Use Cases

### Enhanced Property Filtering

Quality scores enable users to find properties that meet their standards for visual appeal and condition. This is particularly valuable for:

* Luxury market segments: Target high-end properties with "excellent" quality scores
* Investment opportunities: Find properties with lower quality scores that may have renovation potential
* Vacation rentals: Ensure properties have high-quality kitchens and living spaces for guest satisfaction

### Improved Property Sorting

Sort listings by quality to highlight the most visually appealing properties:

* Showcase premier listings: Display properties with highest quality scores at the top of search results
* Targeted marketing: Create featured collections of properties with exceptional quality in specific areas
* Client presentations: Organize property options by quality to streamline client decision-making

### Quality Insights Display

Present quality insights directly to users through your application:

* Property detail pages: Display quality badges for exceptional features (e.g., "Excellent Kitchen")
* Search result highlights: Add quality indicators to listing previews
* Quality breakdown sections: Show detailed quality analysis for each property area

### Comparative Property Analysis

Enable meaningful comparisons between properties based on quality:

* Side-by-side comparisons: Allow users to compare quality scores across multiple properties
* Feature-specific comparisons: Let users compare specific rooms or areas between properties
* Neighborhood benchmarking: Show how a property's quality compares to others in the same area

### More Accurate Price Estimates

Quality scores contribute to more precise property valuation:

* Quality-adjusted pricing models: Consider visual quality alongside traditional factors like square footage
* Premium calculation: Quantify the premium associated with high-quality features
* Renovation ROI analysis: Assess potential value increase from quality improvements

## Implementation Best Practices

1. **Integrate quality filters into your search interface** - Add quality filter options to your existing search functionality

2. **Display quality scores prominently** - Show quality indicators on listing previews and detail pages

3. **Implement quality-based sorting** - Add options to sort by overall quality or by specific room quality

4. **Create quality-based collections** - Group properties by quality tiers for targeted marketing

5. **Combine with other filters** - Allow users to find high-quality properties that also meet other criteria

6. **Use quantitative scores for advanced features** - Leverage the precision of numerical scores for sophisticated filtering and analytics

## API Parameters

| Parameter | Type | Description | Example |
| ---- |
| overallQuality | string | Overall quality level | overallQuality=above average |
| kitchenQuality | string | Kitchen quality level | kitchenQuality=excellent |
| bedroomQuality | string | Bedroom quality level | bedroomQuality=average |
| bathroomQuality | string | Bathroom quality level | bathroomQuality=above average |
| livingRoomQuality | string | Living room quality level | livingRoomQuality=excellent |
| diningRoomQuality | string | Dining room quality level | diningRoomQuality=above average |
| frontOfStructureQuality | string | Front exterior quality level | frontOfStructureQuality=average |
| backOfStructureQuality | string | Back exterior quality level | backOfStructureQuality=above average |
| minQuality | number | Minimum quantitative quality score | minQuality=3.5 |
| maxQuality | number | Maximum quantitative quality score | maxQuality=4.8 |
## Need Help?

For implementation assistance, additional information, or technical support, please contact our dedicated support team at [support@repliers.com](mailto:support@repliers.com). Our team is available to help you integrate the Quality Scores feature effectively into your application.

For API documentation updates and additional resources, visit our API reference at [https://docs.repliers.io](https://docs.repliers.io).