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