Thực thể phương thức.search

Tìm kiếm Sơ đồ tri thức để tìm những thực thể phù hợp với quy tắc ràng buộc.

Yêu cầu HTTP

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

Tham số truy vấn

Tên thông số	Loại	Mô tả
query	string	Một chuỗi cố định cần tìm kiếm trong Sơ đồ tri thức.
ids	string	Danh sách mã nhận dạng thực thể để tìm kiếm trong Sơ đồ tri thức. Để chỉ định nhiều mã nhận dạng trong yêu cầu HTTP, hãy lặp lại tham số đó trong URL như trong ...?ids=A&ids=B
languages	string	Danh sách mã ngôn ngữ (được định nghĩa trong ISO 639) để chạy truy vấn, chẳng hạn như "en".
types	string	Giới hạn các thực thể trả về ở những loại đã chỉ định. Ví dụ: bạn có thể chỉ định "Person" (như định nghĩa trong http://schema.org/Person) để giới hạn kết quả ở các thực thể đại diện cho con người. Nếu bạn chỉ định nhiều loại, các đối tượng được trả về sẽ chứa một hoặc nhiều loại này.
indent	boolean	Cho phép thụt lề kết quả JSON.
prefix	boolean	Cho phép so khớp tiền tố (chuỗi con ban đầu) với tên và bí danh của thực thể. Ví dụ: tiền tố "Jung" sẽ khớp với các thực thể và biệt hiệu, chẳng hạn như như "Jung", "Jungle" và "Jung-ho Kang".
limit	number	Giới hạn số lượng thực thể được trả về. Tối đa là 500. Giá trị mặc định là 20. Yêu cầu có giới hạn cao thì càng có nhiều khả năng hết thời gian chờ.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Tin nhắn phản hồi chứa danh sách các thực thể, trình bày bằng Định dạng JSON-LD và tương thích với Giản đồ schema.org (với tiện ích bên ngoài bị hạn chế).

Ví dụ JSON-LD dưới đây cho thấy cấu trúc của nội dung phản hồi:

{
  "@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
    }
  ]
}

Trường phản hồi

Tên trường	Loại	Mô tả
@id	string	URI chính tắc cho thực thể.
name	string	Tên thực thể.
@type	array	Danh sách các loại schema.org được hỗ trợ khớp với thực thể.
description	string	Nội dung mô tả ngắn về thực thể.
image	URL	Một hình ảnh giúp xác định đối tượng.
detailedDescription	string	Nội dung mô tả chi tiết về thực thể.
url	URL	URL trang web chính thức của pháp nhân (nếu có).
resultScore	number	Chỉ báo cho biết mức độ phù hợp của thực thể với các quy tắc ràng buộc đối với yêu cầu.

Lưu ý: Chúng tôi cung cấp URL hình ảnh để giúp bạn xác nhận rằng bạn đã chọn đúng pháp nhân. Giống như với tất cả nội dung bạn nhận được qua API của Google, bạn chịu trách nhiệm đảm bảo rằng việc bạn sử dụng hình ảnh tuân thủ luật.

Từ khóa JSON-LD

Đối với các từ khoá JSON-LD, chẳng hạn như @context , @vocab, @type hoặc @id, hãy tham khảo Quy cách JSON-LD.

Khả năng tương thích với schema.org

Câu trả lời sử dụng từ vựng được lưu trữ tại schema.org, với một số phần mở rộng hạn chế (đối với ví dụ: resultScore) tương thích với từ vựng trên schema.org. Để biết thêm thông tin chi tiết về các tiện ích này, hãy xem Danh sách phần mở rộng giản đồ.

Đối với mỗi loại Schema.org (chẳng hạn như Person) và thuộc tính (chẳng hạn như name) có một URI đầy đủ tương ứng, như trong các ví dụ sau:

• Người -> http://schema.org/Person

• Điều -> http://schema.org/Thing

• tên -> http://schema.org/name

• mô tả -> http://schema.org/description

Các loại và thuộc tính được xác định là phần mở rộng giản đồ của Google có thể là được mở rộng bằng http://schema.googleapis.com. Ví dụ:

• EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
• mô tả chi tiết -> http://schema.googleapis.com/detailedDescription

Tài liệu cho từng loại và thuộc tính có sẵn tại URI tương ứng.

Danh sách phần mở rộng giản đồ

Các tiện ích giản đồ được sử dụng trong API này được lưu trữ tại http://schema.googleapis.com dưới dạng tiện ích bên ngoài.

Phần mở rộng loại cho Schema.org là:

• EntitySearchResult

Các phần mở rộng của thuộc tính cho Schema.org là:

• detailedDescription
• resultScore