חיפוש ב-Knowledge Graph אחר ישויות שתואמות למגבלות.
בקשת HTTP
GET https://kgsearch.googleapis.com/v1/entities:search
פרמטרים של שאילתה
שם הפרמטר | תיאור | התיאור |
---|---|---|
query |
string |
מחרוזת מילולית לחיפוש ב-Knowledge Graph. |
ids |
string |
רשימה של מזהי ישויות שאפשר לחפש ב-Knowledge Graph. כדי לציין מזהים מרובים בבקשת ה-HTTP, יש לחזור על הפרמטר בכתובת ה-URL, באופן הבא: ...?ids=A&ids=B |
languages |
string |
רשימת קודי השפה (מוגדרים ב-ISO 639) שלגביהם יש להריץ את השאילתה, לדוגמה 'en'. |
types |
string |
מגבילה ישויות מוחזרות לאלה מהסוגים שצוינו. לדוגמה, ניתן לציין 'אדם' (כפי שמוגדר ב-http://schema.org/Person) כדי להגביל את התוצאות לישויות שמייצגות אנשים. אם יצוינו כמה סוגים, הישויות שיוחזרו יכילו אחד או יותר מהסוגים האלה. |
indent |
boolean |
מאפשר כניסת פסקה של תוצאות JSON. |
prefix |
boolean |
הפעלת התאמת קידומת (מחרוזת משנה ראשונית) לשמות ולכינויים של ישויות. לדוגמה, התחילית 'Jung' תתאים לישויות ולכינויים כמו 'Jung' , 'Jungle' ו-'Jung-ho Kang'. |
limit |
number |
הגבלת מספר הישויות שיש להחזיר. המקסימום הוא 500. ברירת המחדל היא 20. לבקשות עם מגבלות גבוהות יש סיכוי גבוה יותר שיפוג התוקף שלהן. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
הודעת תגובה מכילה רשימת ישויות, שמוצגת בפורמט JSON-LD ותואמת לסכימות של schema.org (עם תוספים חיצוניים מוגבלים).
בדוגמה הבאה של JSON-LD אפשר לראות את המבנה של גוף התגובה:
{
"@context": {
"@vocab": "http://schema.org/",
"goog": "http://schema.googleapis.com/",
"resultScore": "goog:resultScore",
"detailedDescription": "goog:detailedDescription",
"EntitySearchResult": "goog:EntitySearchResult",
"kg": "http://g.co/kg"
},
"@type": "ItemList",
"itemListElement": [
{
"@type": "EntitySearchResult",
"result": {
"@id": "kg:/m/0dl567",
"name": "Taylor Swift",
"@type": [
"Thing",
"Person"
],
"description": "Singer-songwriter",
"image": {
"contentUrl": "https://t1.gstatic.com/images?q=tbn:ANd9GcQmVDAhjhWnN2OWys2ZMO3PGAhupp5tN2LwF_BJmiHgi19hf8Ku",
"url": "https://en.wikipedia.org/wiki/Taylor_Swift",
"license": "http://creativecommons.org/licenses/by-sa/2.0"
},
"detailedDescription": {
"articleBody": "Taylor Alison Swift is an American singer-songwriter and actress. Raised in Wyomissing, Pennsylvania, she moved to Nashville, Tennessee, at the age of 14 to pursue a career in country music. ",
"url": "http://en.wikipedia.org/wiki/Taylor_Swift",
"license": "https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License"
},
"url": "http://taylorswift.com/"
},
"resultScore": 4850
}
]
}
שדות תשובה
שם השדה | תיאור | התיאור |
---|---|---|
@id |
string |
ה-URI הקנוני של הישות. |
name |
string |
שם הישות. |
@type |
array |
רשימת הסוגים הנתמכים של schema.org שתואמים לישות. |
description |
string |
תיאור קצר של הישות. |
image |
URL |
תמונה שעוזרת לזהות את הישות. |
detailedDescription |
string |
תיאור מפורט של הישות. |
url |
URL |
כתובת האתר הרשמית של הישות, אם קיימת. |
resultScore |
number |
אינדיקטור שמציין עד כמה הישות התאימה למגבלות הבקשה. |
מילות מפתח ב-JSON-LD
למילות מפתח בפורמט JSON-LD, כמו @context, @vocab, @type או @id, עיינו במפרט JSON-LD.
תאימות ל-Schema.org
התגובה כוללת את אוצר המילים שמתארח ב-schema.org, עם תוספים מוגבלים (לדוגמה, resultScore
) שתואמים לאוצר המילים של schema.org.
למידע נוסף על התוספים האלה, ראו רשימה של תוספי סכימה.
לכל אחד מהסוגים של Schema.org (כגון Person
) ומאפיינים (כגון name
) יש URI מלא תואם, כמו בדוגמאות הבאות:
- אדם -> http://schema.org/Person
Thing -> http://schema.org/Thing
name -> http://schema.org/name
תיאור -> http://schema.org/description
אפשר להרחיב סוגים ומאפיינים שמוגדרים כתוספי סכימה של Google בכתובת http://schema.googleapis.com. לדוגמה,
- EntitySearchResults -> http://schema.googleapis.com/EntitySearchResult
- detailDescription -> http://schema.googleapis.com/detailedDescription
התיעוד לכל סוג ונכס זמין ב-URI המתאים.
רשימה של תוספי סכימה
תוספי סכימה שנמצאים בשימוש ב-API הזה מתארחים בכתובת http://schema.googleapis.com בתור תוספים חיצוניים.
התוסף type ל-Schema.org הוא:
סיומות הנכסים של Schema.org הן: