Global taxonomies: Difference between revisions

From Open Food Facts wiki
No edit summary
Β 
(22 intermediate revisions by 3 users not shown)
Line 2: Line 2:
'''Open Food Facts''' uses multiple '''taxonomies''' for its inner workings. These taxonomies run from simple word lists with their translations, to complex hierarchies with relations between entries and attributes. The taxonomies are used to analyse and structure the information found on products.
'''Open Food Facts''' uses multiple '''taxonomies''' for its inner workings. These taxonomies run from simple word lists with their translations, to complex hierarchies with relations between entries and attributes. The taxonomies are used to analyse and structure the information found on products.


This page gives an overview of the taxonomies and some guiding principles that are valid for all taxonomies.
The [[Languages taxonomy]] for instance lists the most important languages in the world, translated into these languages. The [[Ingredients taxonomy]] lists all the ingredients that OFF has discovered on food products.


== Overview ==
This page gives an overview of the taxonomies and some guiding principles that are valid for all taxonomies. For each specific taxonomy there is a specific wikipage.
The list of taxonomies in use is:
* ''Additives classes taxonomy''
* ''Brands taxonomy'' for the producers of products and their corresponding brands. This taxonomy is not in use and still under construction (5-oct-2022);
* ''Categories taxonomy'' used to put similar products together, so that they can be compared, averages calculated and analysed as a group. For instance an orange juice of a specific brand can be compared to all orange juices;
* ''Countries taxonomy'' has a list of all countries, regions, areas, etc. in the world;
* ''Ingredients taxonomy'' for ingredients found on product ingredients lists. Some specific ingredients have been put into separate taxonomies, as these need special handling due to legal requirements:
** ''Additives taxonomy''
** ''Allergens taxonomy''
** ''Amino acids taxonomy''
** ''[[Ingredients processing taxonomy]]''
** ''Minerals taxonomy''
** ''Nucleotides taxonomy''
** ''Other nutritional substances taxonomy''
** ''Vitamins taxonomy''
* ''[[Labels taxonomy]]'' for every logo and claim by producer about product quality, supply chain, sourcing, diets, etc.;
* ''[[Languages taxonomy]]'' with a list of world languages in multiple languages;
* ''NOVA groups taxonomy''
* ''Packaging/recycling taxonomies'' have been spread out over several specific taxonomies:
** ''Materials taxonomy'' with a list of all possible materials that can be used;
** ''Shapes taxonomy'' which describe all the packaging parts the packaging can consist of;
** ''Recycling taxonomy'' with all ways packaging can be recycled;
* ''States taxonomy'' which describe how complete the data of a product on OFF is;


== Presentations ==
== Presentations ==
There are several other presentation and descriptions on taxonomies, which you might to look at, before diving into the details:
There are several other presentation and descriptions on taxonomies, which you might to look at, before diving into the details:
* [https://docs.google.com/presentation/d/1zL2fA3d_fuPvKKKmCGJ5aV_Ug-R-gXQbwSCcxf3dbo4/edit?usp=sharing Quick presentation of the taxonomies]
* [https://docs.google.com/presentation/d/1zL2fA3d_fuPvKKKmCGJ5aV_Ug-R-gXQbwSCcxf3dbo4/edit?usp=sharing Quick presentation of the taxonomies]
* [https://www.youtube.com/watch?v=b0xRwU_De9Q Lightning talk about taxonomies by LΓ©onore] (Open Food Facts days 2023) and [https://docs.google.com/presentation/d/1_QPKTCyDXNK6HgwHQ0W-ebYCfkB3U3NcL0xLQJJZ9TU/edit#slide=id.p the slides]
* A [https://yuktea.wordpress.com/2022/06/22/three-generations/ short intro by Yukti on her blog].
* A [https://yuktea.wordpress.com/2022/06/22/three-generations/ short intro by Yukti on her blog].


Line 70: Line 49:


==== Properties ====
==== Properties ====
In addition to names, on or more properties can be added to a term section. The following properties are supported:
In addition to names, one or more properties can be added to a term section. Β 
* ''Description'' - a short (three lines) description of the term section;
Β 
* ''Image (logo)'' - this allows to add an image/logo related to the term;
For a full listing of the properties that are used see [[Taxonomy Properties]].
* ''Opposite'' - to specify the opposite relation to another term, i.e. '''organic''' versus '''non-organic''';
he following properties are supported:
* ''Wikidata'' - a link to the term on Wikidata;
* ''Wikipedia'' a link the term with its equivalent on Wikipedia;
Each specific taxonomy might use additional properties.
Each specific taxonomy might use additional properties.


=== Structure ===
=== Structure ===
Each term section
The taxonomy is not a strict hierarchy: sections can have multiple parents. But cycles are not allowed. Formally it can be seen as a [https://en.wikipedia.org/wiki/Directed_acyclic_graph Directed Acyclic Graph].
The taxonomy is not a strict hierarchy: values can have multiple parents. But cycles are not allowed.
Β 
For instance in the categories taxonomy the category '''Apricots''', can have the parent '''Fresh Food''' and the parent '''Fruit'''.


== Implementation ==
== Implementation ==
Each taxonomy is implemented as simple text file.
Each taxonomy is implemented as simple text file. See [[Taxonomy implementation]]


=== Formatting ===
== Maintenance ==
An example taxonomy file is presented below to illustrate the formatting.
Anyone can contribute to the maintenance of these taxonomies. You might want to add a translation, add synonyms, new entries or parents. Have a look at [[Taxonomy Maintenance]].
<pre>
# stopwords
stopwords:en: some,stopwords
stopwords:fr: word,that,are,removed,when,matching


# synonyms that are not field values but that are contained in field values
== Taxonomy editor ==
synonyms:en: global, international
We have [https://ui.taxonomy.openfoodfacts.org/ a new tool to allow editing taxonomies]. The source code and bug report/feature requests are [https://github.com/openfoodfacts/taxonomy-editor located on GitHub]. We would welcome feedback on it.


en: value, a synonym value, another synonym value
== Overview ==
fr: valeur, une valeur synonyme, une autre valeur synonyme
The list of taxonomies in use is (these are the files in the [https://github.com/openfoodfacts/openfoodfacts-server/tree/main/taxonomies taxonomies folder] on Github:
Β 
* ''Additives classes taxonomy''
<en: value
* ''Brands taxonomy'' for the producers of products and their corresponding brands. This taxonomy is not in use and still under construction (5-oct-2022);
en: a child value, a synonym for a child value
* ''Categories taxonomy'' used to put similar products together, so that they can be compared, averages calculated and analysed as a group. For instance an orange juice of a specific brand can be compared to all orange juices;
fr: une valeur enfant, un synonyme d'une valeur enfant
* ''Countries taxonomy'' has a list of all countries, regions, areas, etc. in the world;
Β 
* ''Ingredients taxonomy'' for ingredients found on product ingredients lists. Some specific ingredients have been put into separate taxonomies, as these need special handling due to legal requirements:
<en: value
** ''Additives taxonomy''
en: another child value
** ''Allergens taxonomy''
Β 
** ''Amino acids taxonomy''
<en: a child value
** ''[[Ingredients processing taxonomy]]''
<en: another child value
** ''Minerals taxonomy''
en: a grand-child value
** ''Nucleotides taxonomy''
Β 
** ''Other nutritional substances taxonomy''
# properties
** ''Vitamins taxonomy''
en: value
* ''[[Labels taxonomy]]'' for every logo and claim by producer about product quality, supply chain, sourcing, diets, etc.;
fr: valeur
* ''[[Languages taxonomy]]'' with a list of world languages in multiple languages;
description:en: a property of value
* ''NOVA groups taxonomy''
description:fr: french version of the property
* [[Origins taxonomy]]
country_code:en: a property that is the same for all languages -> use English suffix en:
* ''Packaging/recycling taxonomies'' have been spread out over several specific taxonomies:
wikidata:en:Q89
** ''Materials taxonomy'' with a list of all possible materials that can be used;
Β 
** ''Shapes taxonomy'' which describe all the packaging parts the packaging can consist of;
</pre>
** ''Recycling taxonomy'' with all ways packaging can be recycled;
Β 
* ''States taxonomy'' which describe how complete the data of a product on OFF is;
==== Languages ====
Each language has a 2-letter prefix. e.g. "en" for English and "fr" for French.
Β 
A value can be defined in another language (which becomes the canonical language), e.g. <code>fr:soupes-a-l-oignon</code> could be the canonical value for "Onion Soups" if we don't have an English translation yet.
Β 
New values (e.g. categories that do not exist yet) should have an English canonical value.
Β 
When a field value needs to be translated to a target language, if the translation does not exist yet, English is shown (or the canonical language if the English translation does not exist either).


== Ideas ==
== Ideas ==
Β 
If you have any ideas for taxonomies, contact us on Slack and describe a proposal on this wiki.
=== Draft Taxonomies ===
=== Draft Taxonomies ===
There are some ideas of creating other taxonomies:
There are some ideas of creating other taxonomies:
Line 137: Line 103:
* [[Global IGP taxonomy]]
* [[Global IGP taxonomy]]
* [[Global EC marks taxonomy]]
* [[Global EC marks taxonomy]]
* [[Diets taxonomy]]


TBD: the following texts will be updated and/or placed in separate pages. @aleene 5-10-2022
== Access ==
The taxonomies can be viewed on Github, via the products on the website and with an API. This is detailed on a separate page:
[[Taxonomy access]].
[[Category:Taxonomies]]




==== Singular or plural? ====
== Get in touch ==
Generally, we use the plural for categories but some of them are in singular. We don't put the plural form when it has a different meaning. For example Beef and Beefs. We are talking of the meat and not the animal, so there is no "s". But "Rillettes" in french (and others languages) doesn't have a singular form.
{{Box
Β 
| 1Β  Β  = Slack channel
Sometimes plural or singular depends on the language. The situation for dutch is described in [[Dutch translation issues]].
| 2Β  Β  = [https://openfoodfacts.slack.com/messages/C02VDSWHT/ #taxonomies]
Β 
}}
If the category is in plural form, the translations should be in the plural form.
Β 
<pre>
@stephane new proposal (not yet adopted, to be discussed)
In the categories taxonomy, always use the plural (en:beers, fr:bières).
Then add the singular (especially if it's not a simple rule like removing the final s) in a property:
singular:en:beer
singular:fr:bière
For the ingredients taxonomy, do the reverse:
always use the singular for the main entry, and then add the plural:
en:tomato
plural:en:tomatoes
</pre>
Β 
== Getting taxonomies files ==
Β 
=== Finding new opportunities for taxonomization ===
* A good trick to find candidates for taxonomization is
Β  * https://world.openfoodfacts.org/categories?filter=-
Β  * https://world.openfoodfacts.org/labels?filter=-
Β  * https://world.openfoodfacts.org/origins?filter=-
Β  * https://world.openfoodfacts.org/ingredients?filter=-
* Everything in italics is up for grabs
Β 
=== Taxonomies in JSON format ===
Every taxonomy is also available as a json on OpenFoodFacts. Use
* <code><nowiki>https://static.openfoodfacts.org/data/taxonomies/</nowiki><taxonomy name>.json</code>
* or <code><nowiki>https://static.openfoodfacts.org/data/taxonomies/</nowiki><taxonomy name>.full.json</code> to get additional properties
Β 
Example for categories:
* https://static.openfoodfacts.org/data/taxonomies/categories.json
* https://static.openfoodfacts.org/data/taxonomies/categories-full.json
Β 
=== Taxonomy API ===
We have a basic taxonomy API to get information about a taxonomy.
Β 
Eg. to get information about ''en:carrots'' entry in ''categories'' taxonomy:
Β 
https://world.openfoodfacts.org/api/v2/taxonomy?tagtype=categories&tags=en:carrots
Β 
you can add ''lc'' (language code) parameter to ask for more than one language. ''cc'' is used for country code.
Β 
Eg. to add french information on previous request:
Β 
[https://world.openfoodfacts.org/api/v2/taxonomy?tagtype=categories&tags=en:carrots&lc=en%2Cfr&cc=fr https://world.openfoodfacts.org/api/v2/taxonomy?tagtype=categories&tags=en:carrots&lc=en,fr&cc=fr]
Β 
== Building and deploying taxonomies ==
Β 
Changes to taxonomies on GitHub are not deployed instantly, the need to be built, deployed, and products need to be re-processed with the new taxonomy.
Β 
* [[How to build and deploy taxonomies]]
Β 
== More info ==
For detailed information specific for the ingredients taxonomy see [[Project:Ingredients ontology|Ingredients Ontology]].
[[Category:Taxonomies]]

Latest revision as of 08:46, 8 August 2024

Introduction

Open Food Facts uses multiple taxonomies for its inner workings. These taxonomies run from simple word lists with their translations, to complex hierarchies with relations between entries and attributes. The taxonomies are used to analyse and structure the information found on products.

The Languages taxonomy for instance lists the most important languages in the world, translated into these languages. The Ingredients taxonomy lists all the ingredients that OFF has discovered on food products.

This page gives an overview of the taxonomies and some guiding principles that are valid for all taxonomies. For each specific taxonomy there is a specific wikipage.

Presentations

There are several other presentation and descriptions on taxonomies, which you might to look at, before diving into the details:

Principles

There are some general principles that are valid for all taxonomies. A taxonomy consists of terms and stopwords.

Stopwords

Stopwords are words that can be ignored. These words can be found among ingredients, for instance, but are not ingredients themselves. Each language can have its own stopwords.

In the ingredients taxonomy, for instance, contains is not an ingredient.

Stopwords can be used to further extend synonyms. e.g. if "Γ " and "la" are stopwords for French, then "Yaourts fraise" will automatically be mapped to "Yaourts Γ  la fraise".

Generic synonyms

These are words that can be added to multiple names, but have not much meaning. This allows the system to filter them out so that you no not have to introduce them everywhere.

Terms

The main part of a taxonomy is a (very) large list of terms. A term consists of list of names in different languages, an optional parent and a list of properties.

Name

A name can be a specific ingredient, label, language, etc, depending on the taxonomy.

A name consists of two parts: a language code (see the Languages taxonomy) and one or more values. The language code determines the language of the values that follow. Thus one can find the value Authentic Trappist Product in the English language in the Labels taxonomy.

If a name can be translated to another language, a new name can be added for that language. For instance for the English name Banana you might want to add the name in Afrikaans (Piesang) or Amharic (αˆ™α‹).

Canonical term/value

Each term identifies a primary language that is used to identify the term. This is the canonical name for the term. Preferable this is the English name.

Synonyms

For each name it is possible to add synonyms. These will be used during ingredient recognition for instance. However only the main name will be used. For instance the Spanish translation for the english name Banana is PlΓ‘tano, to which the synonym Banana has been added.

Simple synonyms (simple singular) are done automatically when possible.

Synonyms are recursive: if Yoghurt is a synonym of Yogurt, then Banana yoghurt will automatically be added as a synonym of Banana yogurt.

Parents

Each term can have one (or more) parent terms. This allows to define an isa-relation between terms. For instance Fruit is the parent of Banana. The term Whole black olives in the categories taxonomy has the parent terms Black olives and Whole olives.

Properties

In addition to names, one or more properties can be added to a term section.

For a full listing of the properties that are used see Taxonomy Properties. he following properties are supported: Each specific taxonomy might use additional properties.

Structure

The taxonomy is not a strict hierarchy: sections can have multiple parents. But cycles are not allowed. Formally it can be seen as a Directed Acyclic Graph.

For instance in the categories taxonomy the category Apricots, can have the parent Fresh Food and the parent Fruit.

Implementation

Each taxonomy is implemented as simple text file. See Taxonomy implementation

Maintenance

Anyone can contribute to the maintenance of these taxonomies. You might want to add a translation, add synonyms, new entries or parents. Have a look at Taxonomy Maintenance.

Taxonomy editor

We have a new tool to allow editing taxonomies. The source code and bug report/feature requests are located on GitHub. We would welcome feedback on it.

Overview

The list of taxonomies in use is (these are the files in the taxonomies folder on Github:

  • Additives classes taxonomy
  • Brands taxonomy for the producers of products and their corresponding brands. This taxonomy is not in use and still under construction (5-oct-2022);
  • Categories taxonomy used to put similar products together, so that they can be compared, averages calculated and analysed as a group. For instance an orange juice of a specific brand can be compared to all orange juices;
  • Countries taxonomy has a list of all countries, regions, areas, etc. in the world;
  • Ingredients taxonomy for ingredients found on product ingredients lists. Some specific ingredients have been put into separate taxonomies, as these need special handling due to legal requirements:
    • Additives taxonomy
    • Allergens taxonomy
    • Amino acids taxonomy
    • Ingredients processing taxonomy
    • Minerals taxonomy
    • Nucleotides taxonomy
    • Other nutritional substances taxonomy
    • Vitamins taxonomy
  • Labels taxonomy for every logo and claim by producer about product quality, supply chain, sourcing, diets, etc.;
  • Languages taxonomy with a list of world languages in multiple languages;
  • NOVA groups taxonomy
  • Origins taxonomy
  • Packaging/recycling taxonomies have been spread out over several specific taxonomies:
    • Materials taxonomy with a list of all possible materials that can be used;
    • Shapes taxonomy which describe all the packaging parts the packaging can consist of;
    • Recycling taxonomy with all ways packaging can be recycled;
  • States taxonomy which describe how complete the data of a product on OFF is;

Ideas

If you have any ideas for taxonomies, contact us on Slack and describe a proposal on this wiki.

Draft Taxonomies

There are some ideas of creating other taxonomies:

Access

The taxonomies can be viewed on Github, via the products on the website and with an API. This is detailed on a separate page: Taxonomy access.


Get in touch

Slack channel