तरीके की इकाइयां.search

कंस्ट्रेंट से मेल खाने वाली इकाइयों के लिए नॉलेज ग्राफ़ की खोज करता है.

एचटीटीपी अनुरोध

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 जैसे JSON-LD कीवर्ड के लिए , @vocab, @type या @id, इसे देखें 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 के साथ बड़ा किया गया. उदाहरण के लिए,

  • इकाई के खोज नतीजे -> http://schema.googleapis.com/EntitySearchResult
  • पूरी जानकारी -> http://schema.googleapis.com/detailedDescription

हर टाइप और प्रॉपर्टी के लिए दस्तावेज़ यहां उपलब्ध हैं संबंधित यूआरआई.

स्कीमा एक्सटेंशन की सूची

इस एपीआई में इस्तेमाल किए गए स्कीमा एक्सटेंशन यहां होस्ट किए जाते हैं http://schema.googleapis.com बाहरी एक्सटेंशन के तौर पर.

Schema.org का टाइप एक्सटेंशन यह है:

Schema.org के प्रॉपर्टी एक्सटेंशन के बारे में यहां बताया गया है: