How it works
In order to track improvements over time, we use a comprehensive versioning system. It's important to understand that instead of simply versioning the software, our approach encompasses versioning the entire pipeline including the data production process, the data itself, and any API layer changes that affect the data output.
The version components include:
- AI system version
- Data output version
- Defensible Space version
- 3D Topography version
- CSV format version
AI system version
The data provided by the Fire Risk AI product is based on the latest Nearmap AI model; therefore, the AI model version is included as a part of Fire Risk AI version. To get more information on how the AI models are versioned, see the article About AI Generations.
The AI system version is included as a column in the Fire Risk AI CSV output with:
- Column heading:
system_version - Data:
gen5-tranquil_pool-1.0
Data output version
Each type of data output that you request is versioned. The version is incremented every time the data for the requested output is updated.
Defensible Space version
When you request data for Defensible Space, the version will be included as a column in the Fire Risk AI CSV output with:
- Column heading:
ds_version - Data:
1.0
3D Topography version
- When you request data for 3D Topography, the version will be included as a column in the Fire Risk AI CSV output with:
- Column heading:
3dtopo_version - Data:
1.0
Here's a description of the components of the version. For example, 1.0:
Component | Name | Description |
|---|
1 | Major version | Numerically ordered set of improvements that represent major enhancements in the pipeline that produces the data for the output and/or the data itself. |
0 | Minor version | Numerically ordered set of improvements that represent minor enhancements in the pipeline that produces the data output and/or the data itself. |
NOTE: When the minor or major component changes, the way the data is calculated changes and will most likely result in a change in the values produced.
CSV Format Version
This version represents the design and formatting version in which the data is structured and presented. A "CSV Format Version" will be displayed on the endpoint as shown below:
https://api.nearmap.com/ai/fire/v1/.....
NOTE: In the context of version changes for AI system version, data output version and CSV format version, it is important to consider the impact on backwards compatibility. When comparing two versions, it's crucial to exercise caution when detecting changes, as the enhancements in the newer version may obscure the actual on-the-ground modifications when trying to identify changes.