נתונים
תנאי גזירה
מסד הנתונים Open Beauty Facts זמין בכפוף לרישיון Open Database (מסדי נתונים).
התוכן הפרטני במסד הנתונים כפוף לרישיון Database Contents (תכני מסדי נתונים).
תמונות המוצרים זמינות בכפוף לרישיון Creative Commons Attribution ShareAlike (ייחוס-שיתוף זהה).
הן עשויות להכיל רכיבים חזותיים שעשויים להיות כפופים לזכויות יוצרים או לזכויות אחרות שניתן בחלק מהמקרים לעשות בהם שימוש מחדש (זכויות ציטוט או שימוש הוגן).
נא לקרוא את התנאים וההגבלות לשימוש ולגזירה בטרם גזירת הנתונים.
נא לספר לנו על הגזירה שלך
מאוד מעניין אותנו ללמוד למה משמשים הנתונים של Open Beauty Facts. ברשותך, נעריך מאוד אם יתאפשר לך לספר לנו איך השתמשת בנתונים שלנו כדי שנוכל לשתף זאת עם קהילת Open Beauty Facts. אפשר גם למלא את הטופס הזה כדי להגדיל את הסיכויים שהיישום שלך יוצג לקהל הרחב.
יישומון לניידים ל־Android ול־iPhone (דרושה עזרה!)
היטלים ותוצרי ייצוא של מסד הנתונים נוצרים מדי לילה. מסד הנתונים גודל מאוד, לכן ניתן למצוא דרכים שונות להשתמש בנתונים, בהתאם לצורת הייצוא.
מידע על השדות השונים להיטל ה־MongoDB ומערכי הייצוא ב־CSV זמין ב־https://world.openbeautyfacts.org/data/data-fields.txt
יצוא נתונים של MongoDB
נתוני כל המוצרים שלנו זמינים במאגר ייצור נתונים של MongoDB.
- קישור
- https://static.openbeautyfacts.org/data/openbeautyfacts-mongodbdump.gz
- sha256sum
- https://static.openbeautyfacts.org/data/gz-sha256sum
- md5sum
- https://static.openbeautyfacts.org/data/gz-md5sum
ייצוא הבדלים
ייצוא הבדלים יומי מסופק עבור 14 הימים האחרונים. אפשר למצוא את רשימת קובצי ההבדלים שזמינים כרגע ב־https://static.openbeautyfacts.org/data/delta/index.txt.
כל שורה מייצגת קובץ שזמין תחת https://static.openbeautyfacts.org/data/delta/{filename}.
שם הקובץ מכיל חותמות זמן יוניקס של השינוי הראשון והאחרון שכלול בקובץ ה־JSON כדי שניתן יהיה לייבא את קובצי ההבדלים (לאחר חילוץ) באמצעות mongoimport בסדר אלפביתי.
נא לשים לב שטבעו של mongoexport מאלץ מצב שבו קובצי השינויים לא יכולים לספר לך על מוצרים שנמחקו. כדי להסיר מוצרים שנמחקו ממסד הנתונים שלך, יהיה עליך לייבא את ההיטל המלא של MongoDB.
יצוא נתונים ב־CSV
מסד הנתונים השלם זמין גם בתצורתJSONL (לפעמים נקרא גם LDJSON או NDJSON) בו כל שורה היא פריט JSON. הוא מייצג את אותם הנתונים כמו בייצוא של MongoDB. הקובץ דחוס ב־gzip.
דרך הולמת לנצל את מסד הנתונים לרעה היא להשתמש ב־DuckDB, כלי ניתוחי פנים תהליכי שתוכנן לעבד כמויות גדולות של נתונים בשברירי שנייה. אפשר לקרוא את הרשומה בבלוג שלנו בה אנו חוקרים ומעבדים את מסד הנתונים של Open Beauty Facts עם DuckDB
יצוא נתונים ב־CSV
גרסה מפושטת של היטל ה־JSONL זמין גם בתצורת פרקט/Parquet. במהלך ההמרה, סיננו עמודות שמכילות פרטים כפולים, כאלה שמשמשים לניפוי שגיאות פנימי או שהם פשוט לא מעניינים את המשתמשים.
תבנית פרקט/Parquet הוכחה כשימושית:
- הנתונים מסודרים לפי עמודה, במקום לפי שורה, מה שחוסך בשטח אחסון ומאיץ את שאילתות הניתוח, כלומר, ניתן לבחור את העמודות שחשובות לך ובכך למטב ביצועים, אפילו במחשבים חלשים.
- דחיסת ופריסת נתונים יעילות במיוחד, מה שהופך אותה למיטבית לשיתוף סדרות נתונים גדולות מכל סוג שהוא
- תמיכה בסוגי נתונים מורכבים ומבני נתונים מקוננים מתקדמים.
סדרת הנתונים זמינה ב־Hugging Face, מערכת למידת מכונה בה מתכנתים וחוקרים יכולים לשתף מודלים ונתונים.
אפשר למצוא מידע בוויקי, כולל הנחיות לגזירת נתונים ושאילתות לדוגמה למתחילים.יצוא נתונים ב־CSV
הנתונים של כל המוצרים או חלקם, ניתנים להורדה בתבנית CSV (נתמכת על ידי LibreOffice, Excel ועוד תוכנות גיליונות נתונים) דרך טופס החיפוש המתקדם.
- קישור
- https://static.openbeautyfacts.org/data/en.openbeautyfacts.org.products.csv.gz (CSV דחוס ב־GZIP: ~ 0.9 ג״ב, ללא דחיסה: ~ 9 ג״ב)
קידוד הקובץ הוא Unicode UTF-8. התו המפריד בין שדות הוא <tab> (טאב).
עקרונות כלליים
מסד הנתונים זמין גם בתצורת RDF. אפשר לקרוא את ההכרזה בצרפתית.
דרושה עזרה עם OpenAPI
אפשר להוריד את כל התמונות ואת תוצאות המרת תמונה לטקסט מהשרת שלך או מ־AWS (דרך התוכנית AWS Open Data). אפשר לפנות לתיעוד שלנו כדי ללמוד עוד על איך להוריד תמונות.
תיעוד OpenAPI ל־API בתצורת JSON
API בתצורת JSON גם כן זמין לטובת קריאת נתונים על מוצר. ה־API הזה במיוחד משמש את היישומון לניידים של Open Beauty Facts עבור iPhone ו־Android.
אנו משפרים את ה־API עם הזמן אך אנו מקפידים מאוד לשמור על תאימות לאחור. נשמח לשמוע ממך אם זה משמש אותך כדי שנוכל לספר לך על שינויים אפשריים.
כתובת לקריאת נתוני מוצר: https://il.openbeautyfacts.org/api/v2/product/[barcode].json
היישומון ל־Android פותח ב־Kotlin.
לדוגמה: https://world.openfoodfacts.org/api/v2/product/737628064502.xml
API ניסיוני עם XML
אנו נשמח מאוד לסיים את תיעוד ה־API, להוסיף מקרי בוחן ולייצר אוטומציה של יצירת SDK. אם OpenAPI זה הצד החזק שלך, מאוד נשמח לקבל עזרה.אנו מזמינים אותך להשתמש ב־API למטרות פעילות מבצעית, כל עוד כל קריאת API שוות ערך לסריקה אמתית של משתמש. כל ניסיון לדלות את מסד הנתונים כולו דרך ה־API ייחסם כיוון שתוצאי ייצוא מלאים יומיים זמינים בעמוד זה ממש.
כמו כן, שליחת כותרות HTTP עם קריאות ה־API שלך היא דרך מצוינת בה נוכל ליצור אתך קשר במקרה שיש תקלות כלשהן.
הם יאפשרו לך לצרוך נתונים, כמו גם לאפשר למשתמשים שלך לתרום נתונים חדשים
עקרונות כלליים כדי לשמח את המשתמשים שלך
הקוד של היישומונים הרשמיים של Open Food Facts זמין ב־GitHub Flutter Kotlin Android Swift iOS
דוגמה: https://world.openbeautyfacts.org/api/v2/product/737628064502.xml
ה־API הזה לא מתוחזק באופן פעיל, ולא מתועד רשמית.מעטפות וערכות SDK
כנראה שיש לנו מעטפת לשפת הפיתוח המועדפת עליך. אם יש לנו, ניתן להשתמש בה ולשפר אותה. אם אין לנו, ניתן לעזור ביצירתה.
אנו מזמינים אותך לעשות שימוש חוזר בקוד המקור (הפתוח) ולסייע לנו לשפר אותו, למען כולם, בכל רחבי העולם.
אם המשתמשים שלך לא מצפים לתוצאות מיידית (למשל: יישומוני מאגרים)
- Cordova: GitHub (היישומון הרשמי הישן של Open Food Facts).
- DART: GitHub (Open Food Facts בלבד כרגע)
- Elixir: GitHub
אם המשתמשים שלך מצפים לתוצאות מיידית (למשל: יישומוני תזונה)
- מגישים תמונות (חזית/תזונה/רכיבים): הדבר הכי פחות מעיק על הלקוחות שלך
- רובוט הבינה המלאכותית של Open Beauty Facts - Robotoff - יגזור נתונים מהתמונות
- עם הזמן, יישומונים אחרים וקהילת Open Beauty Facts ימלאו את פערי הנתונים
אם המשתמשים שלך מצפים לתוצאות מיידית (למשל: יישומוני אלרגיות)
- מגישים רכיבים + קטגוריה > מקבלים ניתוח רכיבים, תוספים, מעוררי רגישות, רכיבים מנורמלים, צמחונות, טבעונות…
- אפשר להגיש תוויות לשיפור הערך המוסף
ערכות SDK
הקוד של היישומונים הרשמיים של Open Beauty Facts זמין ב־GitHub (Flutter, Kotlin Android ו־Swift iOS).
אנחנו שוקלים להפוך את בסיסי הקוד של Kotlin ו־Swift ל־SDKs של Kotlin ו־Swift, נשמח לעזרה :-)
אפשר לפתוח שרשור במאגר תיעוד ה־API שלנו
לכל שאלה בנוגע לנתונים, ניתן ליצור אתנו קשר בכתובת contact@openfoodfacts.org
ערכות SDK
- Cordova: GitHub (היישומון הרשמי הישן של Open Beauty Facts)
- DART: GitHub
- Elixir: GitHub - ערוץ הדיונים
- Go: GitHub - ערוץ הדיונים
- Java: GitHub - ערוץ הדיונים
- Kotlin: GitHub - ערוץ הדיונים
- PHP: GitHub - ערוץ הדיונים
- PHP (Laravel): GitHub - ערוץ הדיונים
- Python: GitHub - ערוץ הדיונים
- React Native: GitHub - ערוץ הדיונים
- Ruby: GitHub - ערוץ הדיונים
- Rust: GitHub - ערוץ הדיונים
- R: GitHub - ערוץ דיונים
- Swift: GitHub - ערוץ דיונים
- .NET/C#: GitHub - ערוץ דיונים
- Swift: GitHub - ערוץ דיונים
- .NET/C#: GitHub - ערוץ דיונים
דיון על נתונים, API ועל נתונים מיוצאים
אפשר לעיין בשו״ת הנפוצות על API וייצוא נתונים ושאלות נפוצות על Open Food Facts
ניתן להצטרף לחדר ה־Slack של Open Beauty Facts שזו הדרך המועדפת לשאול שאלות ולדבר על ה־API. נא לשאול את השאלות שלך בערוץ #api
אפשר לפתוח שרשור במאגר תיעוד ה־API שלנו
לכל שאלה בנוגע לנתונים, ניתן ליצור אתנו קשר בכתובת contact@openfoodfacts.org