Quality API
DRAFT
We introduce a new concept: "Candidate ingredient list". Those are ingredients list from mobile, generated by OCR, more or less trustworthy, that are not displayed on the Web version, nor in the ingredient list in the API, but are available in a specific API field.
It is strongly discouraged to use it as a substitute for ingredients lists. People may use it for gamification: get your users to check one another's contributions..
OCR Raw and Refined Data
ingredients_ocr_supporting_image
Example: 3439497014134_fr_ingredients.png Should the same as the image name you sent to Open Food Facts.
ingredients_raw_result_from_ocr
The output of the OCR, as you received it, without any user modifications. Ingredients - LAut, OâŹufs, sucre. Informations nutritionnelles
ingredients_candidate_from_ocr
Ingredients:Lait, Oeufs, sucre.
(Note: The ideal list is: Lait, Ĺufs, sucre.)
Context elements
ocr_engine_used
Examples: "Google Cloud Vision V1, Microsoft Vision API, Tesseract 0.88 without dictionnary"
app_name
Examples: "Ficus"
app_version
Examples: "1.0"
app_os
Examples: "iOS"
proofreading_duration
Examples: "45s"
barcode
Create Barcode ranges likely to be spam (eg cigarettes, electronicsâŚ)
Elements on the user's trustworthiness
user_trusted_by_app
Boolean: true, false
user_hashed_id
example: Wi80Nkc1OHhpdlEwbDhjVDVTUE84OE5ObDVLd1V6bU1KZE1xSVE9PQ
number_of_past_edits
example: 3, 176
user_country_from_ip
example: France, Germany, United States
user_ip
example: 66.249.83.204 (Note: you need consent from your users to send us their IP address. We won't do anything with it but convert it into a country, and store it in the API logs. If you have any doubts, please install your own copy of a IP2Country service)