Methodentity.search

ค้นหากราฟความรู้สำหรับเอนทิตีที่ตรงกับข้อจำกัด

คำขอ HTTP

GET https://kgsearch.googleapis.com/v1/entities:search

พารามิเตอร์การค้นหา

ชื่อพารามิเตอร์ ประเภท คำอธิบาย
query string สตริงตรงตัวที่จะค้นหาในกราฟความรู้
ids string รายการรหัสเอนทิตีที่จะค้นหาในกราฟความรู้ หากต้องการระบุหลายรหัสในคำขอ HTTP ให้ใช้พารามิเตอร์ซ้ำใน URL เหมือนกับใน ...?ids=A&ids=B
languages string รายการรหัสภาษา (กำหนดใน ISO 639) เพื่อเรียกใช้การค้นหา เช่น "en"
types string จำกัดเอนทิตีที่แสดงผลไว้สำหรับประเภทที่ระบุ ตัวอย่างเช่น คุณสามารถระบุ "Person" (ตามที่ให้คำจำกัดความไว้ใน http://schema.org/Person) เพื่อจำกัดผลลัพธ์ไว้ที่เอนทิตีที่เป็นตัวแทนบุคคล หากระบุหลายประเภท เอนทิตีที่แสดงผลจะมีประเภทเหล่านี้อย่างน้อย 1 ประเภท
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 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

  • สิ่งของ -> 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

เอกสารสำหรับพร็อพเพอร์ตี้แต่ละประเภทและแต่ละพร็อพเพอร์ตี้มีให้บริการที่ URI ที่เกี่ยวข้อง

รายการส่วนขยายสคีมา

ส่วนขยายสคีมาที่ใช้ใน API นี้โฮสต์ที่ http://schema.googleapis.com เป็นส่วนขยายภายนอก

ส่วนขยายประเภทของ Schema.org มีดังนี้

ส่วนขยายพร็อพเพอร์ตี้ไปยัง Schema.org มีดังนี้