Methodentity.search

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

คำขอ HTTP

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

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

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

ช่องคำตอบ

ชื่อช่อง Type คำอธิบาย
@id string URI ที่เป็น Canonical สำหรับเอนทิตี
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

  • Thing -> 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

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

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

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

ส่วนขยาย type ของ Schema.org คือ

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