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 query

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 nel URL come in ...?ids=A&ids=B
languages	string	L'elenco di codici lingua (definiti 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 vengono 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 di le entità. Ad esempio, il prefisso "Jung" corrisponderà a entità e alias come come "Jung", "Jungle" 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 JSON-LD e compatibile con 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 di tipi di schema.org supportati che corrispondono all'entità.
description	string	Una breve descrizione dell'entità.
image	URL	Un'immagine per 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 tra l'entità e i vincoli della richiesta.

Nota: gli URL immagine vengono forniti per aiutarti a confermare che hai selezionato l'entità corretta. Come per tutti i contenuti ottenuti tramite le API di Google, responsabile di garantire che l'uso delle immagini da parte tua sia conforme alle legale.

Parole chiave JSON-LD

Per parole chiave JSON-LD come @context , @vocab, @type oppure @id, consulta le specifiche JSON-LD.

Compatibilità di schema.org

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

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

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

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

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

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

I tipi e le proprietà definite come estensioni dello schema di Google possono essere espanso con http://schema.googleapis.com. Ad esempio:

• Risultato di ricerca entità -> http://schema.googleapis.com/EntitySearchResult
• Descrizione dettagliata -> http://schema.googleapis.com/detailedDescription

La documentazione relativa a ogni tipo e proprietà è disponibile l'URI corrispondente.

Elenco delle estensioni dello schema

Le estensioni dello schema utilizzate in questa API sono ospitate su http://schema.googleapis.com come estensioni esterne.

L'estensione type di schema.org è:

• EntitySearchResult

Le estensioni di proprietà di schema.org sono:

• detailedDescription
• resultScore