Métodos entity.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 string literal para buscar en el Gráfico de conocimiento.
ids	string	Una lista de los ID de las entidades que se deben buscar en el Gráfico de conocimiento. Para especificar varios ID en la solicitud HTTP, repite el parámetro de la URL, como en ...?ids=A&ids=B.
languages	string	La lista de códigos de idioma (definidos en la norma ISO 639) para ejecutar la consulta, por ejemplo, "en".
types	string	Restringe las entidades mostradas a aquellas de los tipos especificados. Por ejemplo, puedes especificar "Persona" (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 resultados JSON.
prefix	boolean	Habilita la coincidencia de prefijo (subcadena inicial) con los nombres y los 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 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, presentadas en formato JSON-LD y compatibles con esquemas de schema.org (con extensiones externas limitadas).

El siguiente ejemplo JSON-LD muestra cómo está estructurado 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	El URI canónico de la entidad.
name	string	Es el nombre de la entidad.
@type	array	La lista de tipos de schema.org admitidos que coinciden con la entidad.
description	string	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	La URL del sitio web oficial de la entidad, si está disponible.
resultScore	number	Indicador del nivel de coincidencia de la entidad con las restricciones de la solicitud.

Nota: Las URL de las imágenes se proporcionan para ayudarte a confirmar que seleccionaste la entidad correcta. Al igual que con todo el contenido que obtienes a través de las API de Google, eres responsable de garantizar que tu uso de las imágenes satisfaga la ley aplicable.

Palabras clave JSON-LD

Para conocer 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 vocabulario alojado en schema.org, con extensiones limitadas (por ejemplo, resultScore) que son compatibles con vocabulario de schema.org. Para obtener más detalles sobre estas extensiones, consulta la Lista de extensiones de esquema.

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

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

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

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

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

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

• EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
• DetalladaDescripción -> 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 usadas en esta API se alojan en http://schema.googleapis.com como extensiones externas.

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

• EntitySearchResult;

Las extensiones de property a Schema.org son las siguientes:

• Descripción detallada
• ResultadoPuntuación