शर्तों से मेल खाने वाली इकाइयों के लिए नॉलेज ग्राफ़ खोजता है.
एचटीटीपी अनुरोध
GET https://kgsearch.googleapis.com/v1/entities:search
क्वेरी पैरामीटर
पैरामीटर का नाम | टाइप | जानकारी |
---|---|---|
query |
string |
'नॉलेज ग्राफ़' में खोजी जाने वाली लिटरल स्ट्रिंग. |
ids |
string |
नॉलेज ग्राफ़ में खोजने के लिए, इकाई के आईडी की सूची. एचटीटीपी अनुरोध में कई आईडी बताने के लिए, यूआरएल में पैरामीटर को ...?ids=A&ids=B के तौर पर दोहराएं |
languages |
string |
क्वेरी चलाने के लिए, भाषा कोड (ISO 639 में बताया गया है) की सूची. जैसे, `en`. |
types |
string |
दी गई इकाइयों को सिर्फ़ बताए गए टाइप तक सीमित करता है. उदाहरण के लिए, `परीक्षा` तय करें (जैसा कि http://schema.org/Person में बताया गया है) कि नतीजों में सिर्फ़ ऐसी इकाइयों को शामिल किया जाए जो लोगों से जुड़ी हों. अगर एक से ज़्यादा टाइप दिए गए हैं, तो दिखाई गई इकाइयों में इनमें से एक या ज़्यादा तरह की चीज़ें शामिल होंगी. |
indent |
boolean |
JSON के नतीजों को इंडेंट करने की सुविधा चालू करता है. |
prefix |
boolean |
इकाइयों और नामों के प्रीफ़िक्स से शुरू होने वाली प्रीफ़िक्स (शुरुआती सबस्ट्रिंग) चालू करता है. उदाहरण के लिए, `जंग` प्रीफ़िक्स, `जंग`, `जंगल`, और `जंग-हो कांग` जैसी इकाइयों और उपनामों का मिलान करेगा. |
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 |
इकाई के लिए कैननिकल यूआरआई. |
name |
string |
इकाई का नाम. |
@type |
array |
काम करने वाले schema.org की सूची, जिसका मिलान इकाई से होता है. |
description |
string |
इकाई के बारे में कम शब्दों में जानकारी. |
image |
URL |
इकाई की पहचान करने में मदद के लिए इमेज. |
detailedDescription |
string |
इकाई के बारे में पूरी जानकारी. |
url |
URL |
अगर इकाई उपलब्ध है, तो आधिकारिक वेबसाइट का यूआरएल. |
resultScore |
number |
इस बात का संकेत कि इकाई, अनुरोध की सीमाओं से कितनी अच्छी तरह मेल खाती है. |
JSON-LD कीवर्ड
@context, @vocap, @type या @id जैसे JSON-LD कीवर्ड के लिए, JSON-LD की जानकारी देखें.
Schema.org के साथ काम करने की सुविधा
इस जवाब में schema.org पर मौजूद शब्दावली का इस्तेमाल किया जाता है. इसमें सीमित एक्सटेंशन (उदाहरण के लिए, resultScore
) शामिल होते हैं, जो schema.org शब्दावली के साथ काम करते हैं.
इन एक्सटेंशन के बारे में ज़्यादा जानकारी के लिए, स्कीमा एक्सटेंशन की सूची देखें.
हर schema.org टाइप (जैसे कि Person
) और प्रॉपर्टी (जैसे कि name
) के लिए, नीचे दिया गया एक पूरा यूआरआई मौजूद होता है:
- व्यक्ति -> http://schema.org/Person
चीज़ -> http://schema.org/Thing
नाम -> http://schema.org/name
ब्यौरा -> http://schema.org/description
Google स्कीमा एक्सटेंशन के तौर पर बताए गए टाइप और प्रॉपर्टी http://schema.googleapis.com से बड़े किए जा सकते हैं. उदाहरण के लिए,
- EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
- ज़्यादा जानकारी -> http://schema.googleapis.com/detailedDescription
हर तरह और प्रॉपर्टी के दस्तावेज़, उनसे जुड़े यूआरआई में उपलब्ध हैं.
स्कीमा एक्सटेंशन की सूची
इस एपीआई में इस्तेमाल किए जाने वाले स्कीमा एक्सटेंशन, http://schema.googleapis.com पर बाहरी एक्सटेंशन के तौर पर होस्ट किए जाते हैं.
Schema.org का टाइप एक्सटेंशन यह होता है:
Schema.org के प्रॉपर्टी एक्सटेंशन: