Método entities.search

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

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 que se buscará en el gráfico de conocimiento.
ids	string	Lista de IDs de entidades que se van a buscar en el gráfico de conocimiento. Para especificar varios IDs en la solicitud HTTP, repite el parámetro en la URL, como en ...?ids=A&ids=B.
languages	string	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 devueltas a las de los tipos especificados. Por ejemplo, puedes especificar `Person` (tal como se define en http://schema.org/Person) para limitar los resultados a entidades que representen a personas. Si se especifican varios tipos, las entidades devueltas contendrán uno o varios 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 los alias de las entidades. Por ejemplo, el prefijo "Jung" coincidirá con entidades y alias como "Jung", "Jungle" y "Jung-ho Kang".
limit	number	Limita el número de entidades que se van a devolver. El máximo es 500. El valor predeterminado es 20. Las solicitudes con límites altos tienen más probabilidades de agotar 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, presentada en formato JSON-LD y compatible con los esquemas de schema.org (con extensiones externas limitadas).

En el siguiente ejemplo de JSON-LD se 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	URI canónico de la entidad.
name	string	El nombre de la entidad.
@type	array	Lista de tipos de schema.org admitidos que coinciden con la entidad.
description	string	Una breve descripción de la entidad.
image	URL	Una imagen que ayude a identificar la entidad.
detailedDescription	string	Una descripción detallada de la entidad.
url	URL	La URL del sitio web oficial de la entidad, si está disponible.
resultScore	number	Un indicador de lo bien que se ha ajustado la entidad a las restricciones de la solicitud.

Nota: Las URLs de las imágenes se proporcionan para ayudarte a confirmar que has seleccionado la entidad correcta. Al igual que con todo el contenido que obtengas a través de las APIs de Google, eres responsable de asegurarte de que el uso que hagas de las imágenes cumpla la legislación aplicable.

Palabras clave de JSON-LD

Para obtener información sobre las palabras clave de JSON-LD, como @context , @vocab, @type o @id, consulta la especificación 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 información sobre estas extensiones, consulta la lista de extensiones de esquema.

Cada tipo (como Person) y propiedad (como name) de Schema.org tiene un URI completo correspondiente, como en los siguientes ejemplos:

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

• Thing -> http://schema.org/Thing

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

• description -> http://schema.org/description

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

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

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

Lista de extensiones de esquema

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

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

• EntitySearchResult

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

• detailedDescription
• resultScore