Méthode entity.search

Recherche les entités correspondant aux contraintes dans le Knowledge Graph.

Requête HTTP

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

Paramètres de requête

Nom du paramètre Type Description
query string Chaîne littérale à rechercher dans le Knowledge Graph.
ids string Liste des ID d'entité à rechercher dans le Knowledge Graph. Pour spécifier plusieurs ID dans la requête HTTP, répétez le paramètre dans l'URL comme dans ...?ids=A&ids=B
languages string Liste des codes de langue (définis dans la norme ISO 639) avec lesquels exécuter la requête, par exemple "en".
types string Limite les entités renvoyées à celles des types spécifiés. Par exemple, vous pouvez spécifier "Person" (comme défini dans http://schema.org/Person) pour limiter les résultats aux entités représentant des personnes. Si plusieurs types sont spécifiés, les entités renvoyées contiendront un ou plusieurs de ces types.
indent boolean Active la mise en retrait des résultats JSON.
prefix boolean Active la correspondance de préfixe (sous-chaîne initiale) avec les noms et les alias des entités. Par exemple, le préfixe "Jung" correspond aux entités et aux alias, tels que "Jung", "Jungle" et "Jung-ho Kang".
limit number Limite le nombre d'entités à renvoyer. La valeur maximale est 500. La valeur par défaut est "20". Les requêtes avec des limites élevées ont plus de chances d'expirer.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Un message de réponse contient une liste d'entités, présentées au format JSON-LD et compatibles avec les schémas schema.org (avec des extensions externes limitées).

L'exemple JSON-LD suivant illustre la structure du corps de la réponse:

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

Champs de réponse

Nom du champ Type Description
@id string URI canonique de l'entité.
name string Nom de l'entité.
@type array Liste des types schema.org acceptés correspondant à l'entité.
description string Brève description de l'entité.
image URL Image permettant d'identifier l'entité.
detailedDescription string Description détaillée de l'entité.
url URL URL du site Web officiel de l'entité, si disponible.
resultScore number Indicateur de conformité de l'entité aux contraintes de la requête.

Mots clés JSON-LD

Pour les mots clés JSON-LD tels que @context, @vocab, @type ou @id, reportez-vous à la spécification JSON-LD.

Compatibilité schema.org

La réponse utilise le vocabulaire hébergé sur schema.org, avec des extensions limitées (par exemple, resultScore) compatibles avec le vocabulaire schema.org. Pour en savoir plus sur ces extensions, consultez la section Liste des extensions de schéma.

Pour chaque type (par exemple, Person) et chaque propriété (par exemple, name) Schema.org, il existe un URI complet correspondant, comme dans les exemples suivants:

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

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

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

Les types et les propriétés définis en tant qu'extensions de schéma Google peuvent être développés à l'aide de http://schema.googleapis.com. Par exemple :

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

La documentation de chaque type et propriété est disponible à l'URI correspondant.

Liste des extensions de schéma

Les extensions de schéma utilisées dans cette API sont hébergées sur http://schema.googleapis.com en tant qu'extensions externes.

L'extension type de schema.org est la suivante:

Les extensions property de schema.org sont les suivantes: