What is a Reference ID?

A Reference ID is used to link the same object across multiple Ask requests. It ensures consistency and allows you to correlate extracted features with other elements in the drawing.

Why Use Reference IDs?

Consider a scenario where you request both AskFeatures and AskBalloons. The reference_id enables you to determine which feature corresponds to which balloon in the drawing.

Example

Here’s an example output for extracted features:

{
    "dimensions": [
        {
            "reference_id": 1,
            "label": 50
            ...
        }
    ]
}

And the associated response for balloons:

{
    "balloons": [{
        "reference_id": 1,
        "center": [55, 30]
    }]
}

In this case, the reference_id: 1 links the dimension labeled 50 to the balloon positioned at (55, 30), allowing seamless cross-referencing between different extracted data points.