Question format proposal
After loading a product, the client (web, iOS, Android) will request the Robotoff server a question (on
/api/v1/questions/{barcode}). 1
A question includes an insight and metadata such that the client knows how to display the question and what kind of
input is expected from the user. All data returned by Robotoff is localized with respect to the lang parameter
provided by the client.
Question formats
For all formats, a I don't know button will offer the user the possibility to leave without answering the question.
Addition: Binary choice (add-binary)
Add a fact about a product, by accepting (1) or rejecting (0) the insight.
For instance:
- add a new label (
en:organic) - add a new packager code (
EMB 52052B) - Add a new category (
en:pastas)
Format
- type (str, required) - The question type (
add-binary) - question (str, required) - The question, in the user locale
- value (str, optional) - The suggested value for the field
- image_url (str, optional) - An image to display
- insight_id (str, required) - ID of the insight
value or image_url cannot be both missing.
Examples
{
"type": "add-binary",
"question": "Does the product belong to this category ?",
"value": "Pastas",
"insight_id": "{INSIGHT_ID}",
"insight_type": "category",
"barcode": "{BARCODE}"
}
{
"type": "add-binary",
"question": "Does the product have this label?",
"value": "EU Organic",
"ref_image_url": "https://static.openfoodfacts.org/images/lang/fr/labels/bio-europeen.135x90.png",
"source_image_url": "https://static.openfoodfacts.org/images/products/542/503/557/7122/1.jpg",
"insight_id": "{INSIGHT_ID}",
"insight_type": "label",
"barcode": "{BARCODE}"
}
The ref_image_url can be used to display an image in the question interface, such as labels (IGP, organic,...).
The source_image_url is the URL of the image from which the insight was extracted, if any.
The client returns the insight ID and the annotation (0, -1 or 1). 2