חפש

ממשק ה-API של החיפוש מספק גישה לנתוני Freebase בהינתן שאילתת טקסט חופשי. למידע נוסף על יצירת שאילתות חיפוש מפורטות, אפשר לעיין במאמר סקירה כללית על חיפוש ובמדריך לחיפוש.

בקשה

בקשת HTTP

GET https://www.googleapis.com/freebase/v1/search

פרמטרים

כל הפרמטרים שבהמשך הם אופציונליים, אבל צריך להשתמש לפחות באחד מהפרמטרים query או filter.

שם הפרמטר ערך תיאור
פרמטרים אופציונליים
as_of_time string ערך MQL as_of_time לשימוש עם שאילתות mql_output.
callback string שם ה-method של JS לקריאות חוזרות (callback) של JSONP.
cursor integer הפרמטר cursor יחד עם הפרמטר limit מאפשרים לכם להציג מספר מוגדר של תוצאות בכל פעם. לדוגמה, כדי להציג 3 דפים של 10 תוצאות עוקבות, משתמשים ב- limit=10 וב-cursor=0, ואז ב-cursor=10 וב-cursor=20.
domain string הגבלה לנושאים עם מזהה הדומיין הזה ב-Freebase.
encode string הקידוד של התשובה. אפשר להשתמש בפרמטר הזה כדי להפעיל קידוד HTML.

הערכים הקבילים הם:
  • ‫"html": קידוד תווים מסוימים בתגובה (כמו תגים ואמפרסנד) באמצעות קידוד HTML.
  • ‫off: התגובה לא מקודדת. אסור להדפיס את התוצאות ישירות בדף אינטרנט בלי לבצע קודם escape לתוכן ב-HTML. (ברירת מחדל)
exact boolean שאילתה על שם ומפתחות מדויקים בלבד.
filter string

הפרמטר filter מאפשר ליצור כללים ומגבלות מורכבים יותר להחלה על השאילתה.

הערך filter הוא שפה פשוטה שתומכת בסמלים הבאים:

  • האופרטורים all, any, should ו-not
  • האופרנדים type, ‏domain, ‏name, ‏alias, ‏with ו-without
  • הסוגריים ( ו-) לקיבוץ ולסדר קדימות

מידע על השימוש במאפיין filter זמין במדריך לחיפוש.
format string פורמט מבני של תגובת ה-JSON.

הערכים הקבילים הם:
  • ‫entity: מידע בסיסי על הישויות. (ברירת מחדל)
  • ‫"ids": רשימה מסודרת של ids ב-Freebase.
  • ‫"mids": רשימה מסודרת של mids ב-Freebase.
indent boolean האם להוסיף כניסה לתוצאות ה-JSON.
lang string הקוד של השפה שבה רוצים להריץ את השאילתה. ברירת המחדל היא 'en'.
limit integer המספר המקסימלי של תוצאות שיוחזרו. כברירת מחדל, מוחזרות 20 התאמות בסדר יורד של רלוונטיות, אם יש כל כך הרבה התאמות. אפשר לבקש פחות או יותר התאמות באמצעות הפרמטר limit עם ערך אחר. (דוגמה.)
mql_output string שאילתת MQL להרצה מול התוצאות כדי לחלץ נתונים נוספים. אחרי שהשאילתה מורצת, המערכת מעבירה את מזהי המסמכים התואמים לשאילתת mql_output MQL כדי לאחזר נתונים בפועל לגבי ההתאמות. תוצאות ה-MQL ממוינות לפי ציון רלוונטיות בסדר יורד. 
prefixed boolean התאמה לפי תחילית לשמות ולכינויים.
query string מונח השאילתה לחיפוש.
scoring string אלגוריתם לדירוג הרלוונטיות שבו יש להשתמש.

הערכים הקבילים הם:
  • ‫"entity": שימוש ב-Freebase ובדירוג הפופולריות של הישות. (ברירת מחדל)
  • ‫"freebase": שימוש בדירוג ישויות של Freebase.
  • ‫schema: שימוש בדירוג סכימה למאפיינים ולסוגים.
spell string בקשה להצעות 'האם התכוונת ל'

הערכים הקבילים הם:
  • ‫'always': בקשה להצעות לאיות של כל שאילתה באורך של שלושה תווים לפחות.
  • ‫"no_results": בקשה להצעות איות אם לא נמצאו תוצאות.
  • ‫no_spelling: לא לבקש הצעות לאיות. (ברירת מחדל)
stemmed boolean שאילתה על שמות וכינויים עם גזירה. אסור להשתמש בתכונה הזו עם prefixed.
type string הגבלה לנושאים עם מזהה הסוג הזה ב-Freebase.
with string כלל מסנן להתאמה.
without string כלל מסנן שלא יתבצע חיפוש של התאמה אליו.

גוף הבקשה

אין לספק גוף בקשה בשיטה הזו.

תשובה

אם הפעולה בוצעה ללא שגיאות, התגובה היא מבנה JSON. 

{
  "status":"200 OK",
  "result":[
    {
      "mid":"/m/0b1zz",
      "name":"Nirvana",
      "notable":{"name":"Record Producer","id":"/music/producer"},
      "score":55.227268
    },{
      "mid":"/m/05b3c",
      "name":"Nirvana",
      "notable":{"name":"Belief","id":"/religion/belief"},
      "score":44.248726
    },{
      "mid":"/m/01h89tx",
      "name":"Nirvana",
      "notable":{"name":"Musical Album","id":"/music/album"},
      "score":30.371510
    },{
      "mid":"/m/01rn9fm",
      "name":"Nirvana",
      "notable":{"name":"Musical Group","id":"/music/musical_group"},
      "score":30.092449
    },{
      "mid":"/m/02_6qh",
      "name":"Nirvana",
      "notable":{"name":"Film","id":"/film/film"},
      "score":29.003593
    },{
      "mid":"/m/01rkx5",
      "name":"Nirvana Sutra",
      "score":21.344824
    }
  ],
  "cost":10,
  "hits":0
}