Метод entity.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	Ограничивает возвращаемые объекты объектами указанных типов. Например, вы можете указать «Лицо» (как определено в http://schema.org/Person ), чтобы ограничить результаты объектами, представляющими людей. Если указано несколько типов, возвращаемые сущности будут содержать один или несколько из этих типов.
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	Индикатор того, насколько хорошо объект соответствует ограничениям запроса.

Примечание. URL-адреса изображений предоставляются, чтобы помочь вам подтвердить, что вы выбрали правильный объект. Как и в случае со всем контентом, который вы получаете через API Google, вы несете ответственность за обеспечение того, чтобы использование вами изображений соответствовало действующему законодательству.

Ключевые слова 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/Вещь

• имя -> http://schema.org/имя

• описание -> 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 как внешние расширения .

Расширение типа для Schema.org:

• EntitySearchResult

Расширения свойств для Schema.org:

• Подробное описание
• результатоценка