Méthode entity.search

Recherche les entités correspondant aux contraintes dans 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 d'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 la partie URL sous la forme ...?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" (tel que 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 contiennent 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 de entités. Par exemple, le préfixe "Jung" correspond à des entités et à des alias tels que comme "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ée dans JSON-LD et compatible avec Schémas schema.org (avec un nombre limité d'extensions externes).

L'exemple JSON-LD suivant montre comment le corps de la réponse est structuré:

{
  "@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 compatibles 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 du niveau de correspondance entre l'entité et les contraintes de la requête.

Remarque :Les URL d'image sont fournies pour vous aider à vérifier que vous avez sélectionné les la bonne entité. Comme pour tout contenu obtenu via les API Google, vous êtes de vous assurer que votre utilisation des images est conforme aux la loi.

Mots clés JSON-LD

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

Compatibilité avec schema.org

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

Pour chacun des types Schema.org (tels que Person) et des propriétés (comme name), il existe un URI complet correspondant, comme dans les exemples suivants:

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

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

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

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

Les types et propriétés définis comme extensions de schéma Google peuvent être développé avec http://schema.googleapis.com. Par exemple :

• EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
• description détaillée -> http://schema.googleapis.com/detailedDescription

La documentation relative à chaque type et propriété est disponible à l'adresse 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 de type de schema.org est la suivante:

• EntitySearchResult

Les extensions de propriété pour Schema.org sont les suivantes:

• detailedDescription
• resultScore