Entidades de método

Busca entidades que coincidan con las restricciones en el Gráfico de conocimiento.

Solicitud HTTP

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

Parámetros de consulta

Nombre del parámetro Tipo Descripción
query string Una cadena literal para buscar en el Gráfico de conocimiento.
ids string Es una lista de los ID de entidades que se buscarán en el Gráfico de conocimiento. Para especificar varios ID en la solicitud HTTP, repite el parámetro en la URL, como en ...?ids=A&ids=B
languages string La lista de códigos de idioma (definidos en ISO 639) con los que se ejecutará la consulta, por ejemplo, "en".
types string Restringe las entidades que se muestran a las de los tipos especificados. Por ejemplo, puedes especificar "Person" (como se define en http://schema.org/Person) para restringir los resultados a entidades que representan personas. Si se especifican varios tipos, las entidades mostradas contendrán uno o más de estos tipos.
indent boolean Habilita la sangría de los resultados JSON.
prefix boolean Habilita la coincidencia de prefijos (subcadena inicial) con los nombres y alias de las entidades. Por ejemplo, un prefijo "Jung" coincidirá con entidades y alias como "Jung", "Jungle" y "Jung-ho Kang".
limit number Limita la cantidad de entidades que se mostrarán. El máximo es 500. El valor predeterminado es 20. Las solicitudes con límites altos tienen más probabilidades de agotarse el tiempo de espera.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Un mensaje de respuesta contiene una lista de entidades, presentadas en formato JSON-LD y compatibles con esquemas de schema.org (con extensiones externas limitadas).

El siguiente ejemplo de JSON-LD muestra cómo se estructura el cuerpo de la respuesta:

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

Campos de respuesta

Nombre del campo Tipo Descripción
@id string Es el URI canónico de la entidad.
name string Es el nombre de la entidad.
@type array Es la lista de tipos de schema.org compatibles que coinciden con la entidad.
description string Es una descripción breve de la entidad.
image URL Una imagen que ayuda a identificar la entidad.
detailedDescription string Una descripción detallada de la entidad.
url URL Es la URL del sitio web oficial de la entidad, si está disponible.
resultScore number Un indicador de qué tan bien coincidió la entidad con las restricciones de la solicitud.

Palabras clave de JSON-LD

Para las palabras clave de JSON-LD, como @context, @vocab, @type o @id, consulta las especificaciones de JSON-LD.

Compatibilidad con Schema.org

La respuesta usa el vocabulario alojado en schema.org, con extensiones limitadas (por ejemplo, resultScore) que son compatibles con el vocabulario de schema.org. Para obtener más detalles sobre estas extensiones, consulta la Lista de extensiones de esquema.

Para cada uno de los tipos (como Person) y las propiedades (como name) de Schema.org, hay un URI completo correspondiente, como en los siguientes ejemplos:

  • Persona -> http://schema.org/Person
  • Elemento -> http://schema.org/Thing

  • nombre -> http://schema.org/name

  • descripción -> http://schema.org/description

Los tipos y las propiedades definidos como extensiones de esquema de Google se pueden expandir con http://schema.googleapis.com. Por ejemplo,

  • EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
  • detailsDescription -> http://schema.googleapis.com/detailedDescription

La documentación para cada tipo y propiedad está disponible en el URI correspondiente.

Lista de extensiones de esquema

Las extensiones de esquema usadas en esta API se alojan en http://schema.googleapis.com como extensiones externas.

La extensión type de Schema.org es la siguiente:

Las extensiones de propiedad de Schema.org son las siguientes: