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

Tìm kiếm Sơ đồ tri thức cho các thực thể phù hợp với cá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	Nội dung mô tả
query	string	Một chuỗi giá trị cố định để tìm kiếm trong Sơ đồ tri thức.
ids	string	Danh sách mã nhận dạng thực thể cần 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 các 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ể được trả về chỉ trong các thực thể thuộc loại đã chỉ định. Ví dụ: bạn có thể chỉ định "Person" (như định nghĩa trong http://schema.org/Person) để chỉ đưa ra kết quả cho những thực thể đại diện cho người dùng. Nếu bạn chỉ định nhiều loại, thì các thực thể được trả về sẽ chứa một hoặc nhiều loại trong số 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 đầu tiên) với tên và biệt hiệu 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 như "Jung", "Jungle" và "Jung-ho Kang".
limit	number	Giới hạn số lượng thực thể sẽ được trả về. Tối đa là 500. Giá trị mặc định là 20. Các yêu cầu có hạn mức cao có nguy cơ hết thời gian chờ cao hơn.

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

Thông báo phản hồi chứa danh sách các thực thể, được trình bày ở định dạng JSON-LD và tương thích với giản đồ schema.org (với phần mở rộng bên ngoài có giới hạn).

Ví dụ JSON-LD dưới đây thể hiện 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 câu trả lời

Tên trường	Loại	Nội dung 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ợ và khớp với thực thể.
description	string	Nội dung mô tả ngắn về thực thể.
image	URL	Hình ảnh giúp xác định thực thể.
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 thực thể (nếu có).
resultScore	number	Một chỉ báo về mức độ phù hợp của thực thể với các quy tắc ràng buộc về yêu cầu.

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

Từ khoá JSON-LD

Đối với các từ khoá JSON-LD như @context, @vocab, @type hoặc @id, hãy tham khảo thông số kỹ thuật 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 (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 phần mở rộng này, hãy xem bài viết Danh sách các 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) đều có một URI đầy đủ tương ứng, như trong các ví dụ sau:

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

• Thing -> 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ể được mở rộng bằng http://schema.googleapis.com. Ví dụ:

• EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
• detailDescription -> http://schema.googleapis.com/detailDescription

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

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

Các phần mở rộng về giản đồ dùng trong API này được lưu trữ tại http://schema.googleapis.com dưới dạng phần mở rộng bên ngoài.

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

• EntitySearchResult

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

• detailedDescription
• resultScore