עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=opensearch
(main | opensearch)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
חיפוש בוויקי בפרוטוקול OpenSearch.
פרמטרים:
- search
מחרוזת לחיפוש.
- הפרמטר הזה נדרש.
- namespace
מרחבי השם שבהם יתבצע החיפוש. לשדה זה אין משמעות אם search מתחיל עם תחילית תקינה של מרחב שם.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 128, 200, 201, 204, 205, 206, 207, 274, 275, 420, 421, 828, 829, 2300, 2301, 2302, 2303
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- ברירת המחדל: 0
- limit
מספר התוצאות המרבי להחזרה.
- סוג: מספר שלם או max
- הערך חייב להיות בין 1 ל־500.
- ברירת המחדל: 10
- profile
באיזה פרופיל חיפוש להשתמש.
- strict
- פרופיל מחמיר שבו מוסָרים מעט סימני פיסוק, אבל סימנים דיאקריטיים וסימני הטעמה נשמרים.
- normal
- מוסָרים סימני פיסוק אחדים, סימנים דיאקריטיים מסוימים ומילות עצירה מסוימות.
- normal-subphrases
- כמה סימני פיסוק וכמה סימני ניקוד ומילות העצירה מוסָרים. זה יהיה תואם עם תת־ביטויים (זה יכול להיות תת־ביטויים או תת־דפים בהתאם להגדרה פנימית של הוויקי).
- fuzzy
- דומה לרגיל עם תיקון שגיאות הקלדה (נתמכות שתי שגיאות הקלדה).
- fast-fuzzy
- פרופיל מטושטש ניסיוני (יכול להיות מוסר בכל זמן)
- fuzzy-subphrases
- דומה לתיקון שגיאות כתיב רגיל (עד שתי שגיאות כתיב נתמכות). זה תואם גם לתת־ביטויים (זה יכול להיות תת־ביטויים או תת־דפים בהתאם להגדרה פנימית של הוויקי).
- classic
- תחילית קלאסית, שבה מוסָרים מעט סימני פיסוק וסימנים דיאקריטיים אחדים.
- engine_autoselect
- לתת למנוע החיפוש לבחור את הפרופיל הטוב ביותר לשימוש.
- אחד מהערכים הבאים: classic, engine_autoselect, fast-fuzzy, fuzzy, fuzzy-subphrases, normal, normal-subphrases, strict
- ברירת המחדל: engine_autoselect
- suggest
- מיושן.
כבר לא בשימוש.
- סוג: בוליאני (פרטים)
- redirects
איך לטפל בהפניות:
- return
- להחזיר את ההפניה עצמה.
- resolve
- להחזיר את דף היעד. יכול להחזיר פחות מ־limit תוצאות.
מסיבות היסטוריות, ברירת המחדל היא "return" עבור format=json ו־"resolve" עבור תסדירים אחרים.
- אחד מהערכים הבאים: resolve, return
- format
תסדיר הפלט.
- אחד מהערכים הבאים: json, jsonfm, xml, xmlfm
- ברירת המחדל: json
- warningsaserror
אם אזהרות מוּעלות עם format=json, להחזיר שגיאת API במקום להתעלם מהן.
- סוג: בוליאני (פרטים)
דוגמה:
- חיפוש דפים שמתחילים ב־Te.
- api.php?action=opensearch&search=Te [פתיחה בארגז חול]