Cerca in 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 di codici lingua (definiti in 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 "Persona" (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 delle entità. Ad esempio, un prefisso "Jung" corrisponderà a entità e alias 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 più probabilità di andare in timeout. |
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Un messaggio di risposta contiene un elenco di entità, presentato in formato JSON-LD e compatibile con gli schemi schema.org (con estensioni esterne limitate).
L'esempio JSON-LD seguente 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 della risposta
Nome campo | Tipo | Descrizione |
---|---|---|
@id |
string |
L'URI canonico dell'entità. |
name |
string |
Il nome dell'entità. |
@type |
array |
L'elenco dei tipi schema.org supportati che corrispondono all'entità. |
description |
string |
Una breve descrizione dell'entità. |
image |
URL |
Un'immagine per identificare meglio l'entità. |
detailedDescription |
string |
Una descrizione dettagliata dell'entità. |
url |
URL |
L'URL ufficiale del sito web dell'entità, se disponibile. |
resultScore |
number |
Un indicatore del livello di corrispondenza dei vincoli della richiesta all'entità. |
Parole chiave JSON-LD
Per le parole chiave JSON-LD come @context, @vocab, @type o @id, consulta le specifiche JSON-LD.
Compatibilità di 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
Elenco delle estensioni di schema.
Per ogni tipo di schema.org (come Person
) e per proprietà (come name
) è presente un URI completo corrispondente, come nei seguenti esempi:
- Persona -> http://schema.org/Person
Thing -> http://schema.org/Thing
name -> http://schema.org/name
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
- dettagliataDescrizione -> http://schema.googleapis.com/detailedDescription
La documentazione di ogni tipo e proprietà è disponibile all'URI corrispondente.
Elenco di estensioni dello schema
Le estensioni schema utilizzate in questa API sono ospitate su http://schema.googleapis.com come estensioni esterne.
L'estensione type di schema.org è:
Le estensioni proprietà di Schema.org sono: