Overview
Nearmap Roof Spotlight Index (RSI) measures the overall condition of a roof. It is a powerful tool that provides accurate insights about roof conditions for several industries including Insurance or Property Asset Management. It facilitates remote assessment for quick decision making, underpins operational efficiency and reduces inspection costs.
You can generate the RSI for a roof via the AI Feature API.
The API response contains a RSI score and confidence level generated using Nearmap's Generation 6 AI model.
RSI score measures the overall quality of a roof on a scale of 0-100, with 0 indicating a roof with severe defects and 100 indicating no visible defects. It is accompanied with a 0-1 confidence value. Together, the RSI score and confidence value provide an accurate summary of a roof’s condition.
RSI quick info
Available for properties in: | USA, AU |
---|
Available in APIs | AI Features API |
Available in Applications | Betterview |
How do I get the RSI?
You can get the RSI via the AI Feature API by including the following parameters in the request:
include=roofSpotlightIndex&systemVersionPrefix=gen6
Prerequisites
To be able to use the RSI product, the following conditions must be met:
- To retrieve RSI on Roof features, you must have a subscription for either the Roof Condition pack, the Advanced Roof Condition pack or any other pack that contains the
roof
feature class. - To retrieve RSI on Building Lifecycle features, you must have a subscription for the Building Structures pack or other packs that contain the
building lifecycle
feature class. - If the request contains a ‘packs’ parameter, the parameter list must contain one or more of the packs listed above.
Inputs
By default, RSI is calculated on the unclipped geometry of the roof. Therefore, if a roof extends beyond the boundary of the given AOI, roof features from beyond the given AOI will be incorporated into the RSI calculation.
If you want to clip the geometry of a roof to the given AOI use the parameter parcelMode=true
. This parameter will ensure only roof features within the given AOI are used in the RSI calculation, ignoring aspects of the roof extending beyond the given AOI.
Note: An exception to the above rule is where the roof area extending beyond the AOI is a small slither that is unlikely to belong to an adjacent property parcel. In this case, the extending roof slither is also included in the RSI calculation.
Example
GET https://api.nearmap.com/ai/features/v4/features.json?polygon=-112.008154,40.313049,-112.008186,40.312747,-112.008471,40.312771,-112.008424,40.313072,-112.008154,40.313049&systemVersionPrefix=gen6&packs=roof_cond,building_structures&include=roofSpotlightIndex&apiKey=xxx