confidence #

The confidence is a value present in display, serial number, barcode, datamatrix, QR-code, OBIS-code and display-unit objects in the returned JSON response which represents the confidence of the respective value being correct.

The property can hold the value of either low, medium, or high. Depending on your application, you may instruct an end-user to take another image of the meter if the confidence is below your threshold.

Example response #

{
    "objects": [
        {
            "meter": {
                "objectId": "o-SpCZbeze",
                "objects": {
                    "display": [
                        {
                            "confidence": "high"
                        },
                        {
                            "confidence": "medium"
                        }
                    ],
                    "serialNumber": [
                        {
                            "confidence": "low"
                        }
                    ],
                    "barcode": [
                        {
                            "confidence": "high"
                        }
                    ]
                }
            }
        }
    ]
}

Example response from API version 2024-03-01 #

{
    "objects": [
        {
            "meter": {
                "objectId": "o-SpCZbeze",
                "objects": {
                    "display": [
                        {
                            "confidence": "high"
                        },
                        {
                            "confidence": "medium"
                        }
                    ],
                    "serialNumber": [
                        {
                            "confidence": "low"
                        }
                    ],
                    "barcode": [
                        {
                            "confidence": "high"
                        }
                    ],
                    "datamatrix": [
                        {
                            "confidence": "high"
                        }
                    ],
                    "qrCode": [
                        {
                            "confidence": "high"
                        }
                    ]
                }
            }
        }
    ]
}

Example response from API version 2025-01-01 #

{
    "objects": [
        {
            "meter": {
                "objectId": "o-SpCZbeze",
                "objects": {
                    "displayReading": [
                        {
                            "confidence": "high",
                            "objects": {
                                "obisCode": [
                                    {
                                        "confidence": "high",
                                    }
                                ],
                                "displayUnit": [
                                    {
                                        "confidence": "high",
                                    }
                                ]
                            }
                        },
                        {
                            "confidence": "medium",
                            "objects": {
                                "obisCode": [
                                    {
                                        "confidence": "low",
                                    }
                                ],
                                "displayUnit": [
                                    {
                                        "confidence": "medium",
                                    }
                                ]
                            }
                        }
                    ],
                    "serialNumber": [
                        {
                            "confidence": "low"
                        }
                    ],
                    "barcode": [
                        {
                            "confidence": "high"
                        }
                    ],
                    "datamatrix": [
                        {
                            "confidence": "high"
                        }
                    ],
                    "qrCode": [
                        {
                            "confidence": "high"
                        }
                    ]
                }
            }
        }
    ]
}