Metodo entity.search

Cerca nel Knowledge Graph le entità che corrispondono ai vincoli.

Richiesta HTTP

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

Parametri di ricerca

Nome del parametro	Tipo	Descrizione
query	string	Una stringa letterale da cercare nel Knowledge Graph.
ids	string	Un elenco di ID entità da cercare nel Knowledge Graph. Per specificare più ID nella richiesta HTTP, ripeti il parametro nell'URL come in ...?ids=A&ids=B
languages	string	L'elenco dei codici lingua (definito nella norma ISO 639) con cui eseguire la query, ad esempio "en".
types	string	Limita le entità restituite a quelle dei tipi specificati. Ad esempio, puoi specificare "Person" (come definito in http://schema.org/Person) per limitare i risultati alle entità che rappresentano persone. Se sono specificati più tipi, le entità restituite conterranno uno o più di questi tipi.
indent	boolean	Consente il rientro dei risultati JSON.
prefix	boolean	Abilita la corrispondenza del prefisso (sottostringa iniziale) con i nomi e gli alias delle entità. Ad esempio, un prefisso "Jung" corrisponderà a entità e alias come "Jung", "Jung" e "Jung-ho Kang".
limit	number	Limita il numero di entità da restituire. Il valore massimo è 500. Il valore predefinito è 20. Le richieste con limiti elevati hanno una maggiore probabilità di timeout.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Un messaggio di risposta contiene un elenco di entità, presentate in formato JSON-LD e compatibili con gli schemi schema.org (con estensioni esterne limitate).

Il seguente esempio JSON-LD mostra come è strutturato il corpo della risposta:

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

Campi di risposta

Nome campo	Tipo	Descrizione
@id	string	L'URI canonico dell'entità.
name	string	Il nome dell'entità.
@type	array	L'elenco dei tipi di schema.org supportati che corrispondono all'entità.
description	string	Una breve descrizione dell'entità.
image	URL	Un'immagine per aiutare a identificare l'entità.
detailedDescription	string	Una descrizione dettagliata dell'entità.
url	URL	L'URL del sito web ufficiale dell'entità, se disponibile.
resultScore	number	Un indicatore del livello di corrispondenza dell'entità con i vincoli della richiesta.

Nota: gli URL immagine vengono forniti per aiutarti a confermare di aver selezionato l'entità corretta. Come per tutti i contenuti ottenuti tramite le API di Google, è tua responsabilità garantire che l'utilizzo delle immagini rispetti la legge vigente.

Parole chiave JSON-LD

Per le parole chiave JSON-LD come @context, @vocab, @type o @id, fai riferimento alla specifica JSON-LD.

Compatibilità con schema.org

La risposta utilizza il vocabolario ospitato su schema.org, con estensioni limitate (ad esempio, resultScore) compatibili con il vocabolario di schema.org. Per maggiori dettagli su queste estensioni, consulta l'articolo Elenco delle estensioni dello schema.

Per ciascuno dei tipi di schema.org (come Person) e delle proprietà (come name) corrisponde un URI completo, come indicato nei seguenti esempi:

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

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

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

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

I tipi e le proprietà definiti come estensioni dello schema Google possono essere espansi con http://schema.googleapis.com. Ad esempio,

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

La documentazione per ogni tipo e proprietà è disponibile all'URI corrispondente.

Elenco delle estensioni dello schema

Le estensioni schema utilizzate in questa API sono ospitate all'indirizzo http://schema.googleapis.com come estensioni esterne.

L'estensione type per Schema.org è:

• EntitySearchResult

Le estensioni della proprietà di schema.org sono:

• detailedDescription
• resultScore