Sucht im Knowledge Graph nach Entitäten, die den Einschränkungen entsprechen.
HTTP-Anfrage
GET https://kgsearch.googleapis.com/v1/entities:search
Abfrageparameter
Parametername | Typ | Beschreibung |
---|---|---|
query |
string |
Ein literaler String, nach dem im Knowledge Graph gesucht werden soll. |
ids |
string |
Eine Liste von Entitäts-IDs, nach denen im Knowledge Graph gesucht werden soll. Wenn Sie mehrere IDs in der HTTP-Anfrage angeben möchten, wiederholen Sie den Parameter in der URL wie in ...?ids=A&ids=B. |
languages |
string |
Die Liste der Sprachcodes (gemäß ISO 639), mit denen die Abfrage ausgeführt werden soll, z. B. „en“. |
types |
string |
Beschränkt die zurückgegebenen Entitäten auf die angegebenen Typen. Sie können beispielsweise „Person“ angeben (wie in http://schema.org/Person definiert), um die Ergebnisse auf Entitäten zu beschränken, die Personen darstellen. Wenn mehrere Typen angegeben sind, enthalten die zurückgegebenen Entitäten einen oder mehrere dieser Typen. |
indent |
boolean |
Aktiviert das Einrücken von JSON-Ergebnissen. |
prefix |
boolean |
Aktiviert den Präfixabgleich (anfänglicher Teilstring) mit Namen und Aliassen von Entitäten. Mit dem Präfix „Jung“ werden beispielsweise Entitäten und Aliasse wie „Jung“, „Jungle“ und „Jung-ho Kang“ abgeglichen. |
limit |
number |
Beschränkt die Anzahl der zurückzugebenden Entitäten. Der Höchstwert ist 500. Der Standardwert ist 20. Bei Anfragen mit hohen Limits ist die Wahrscheinlichkeit von Zeitüberschreitungen höher. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Eine Antwortnachricht enthält eine Liste von Entitäten im JSON-LD-Format und kompatibel mit schema.org-Schemas (mit eingeschränkten externen Erweiterungen).
Das folgende JSON-LD-Beispiel zeigt, wie der Antworttext strukturiert ist:
{
"@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
}
]
}
Antwortfelder
Feldname | Typ | Beschreibung |
---|---|---|
@id |
string |
Der kanonische URI für die Entität. |
name |
string |
Der Name der Entität. |
@type |
array |
Die Liste der unterstützten schema.org-Typen, die der Entität entsprechen. |
description |
string |
Eine kurze Beschreibung der Entität. |
image |
URL |
Ein Bild, mit dem das Element identifiziert werden kann. |
detailedDescription |
string |
Eine detaillierte Beschreibung der Entität. |
url |
URL |
Die offizielle Website-URL des Rechtssubjekts, falls verfügbar. |
resultScore |
number |
Ein Indikator dafür, wie gut die Entität den Anfrageeinschränkungen entspricht. |
JSON-LD-Keywords
JSON-LD-Schlüsselwörter wie @context, @vocab, @type oder @id finden Sie in der JSON-LD-Spezifikation.
Schema.org-Kompatibilität
Für die Antwort wird das auf schema.org gehostete Vokabular mit eingeschränkten Erweiterungen (z. B. resultScore
) verwendet, die mit schema.org-Vokabular kompatibel sind.
Weitere Informationen zu diesen Erweiterungen finden Sie unter Liste der Schemaerweiterungen.
Für jeden Schema.org-Typ (z. B. Person
) und für alle Properties (z. B. name
) gibt es einen entsprechenden vollständigen URI, wie in den folgenden Beispielen gezeigt:
- Person -> http://schema.org/Person
Thing -> http://schema.org/Thing
name -> http://schema.org/name
description -> http://schema.org/description
Als Google-Schemaerweiterungen definierte Typen und Properties können mit http://schema.googleapis.com erweitert werden. Beispiel:
- EntitySearchResult -> http://schema.googleapis.com/EntitySearchResult
- detailDescription -> http://schema.googleapis.com/detailedDescription
Die Dokumentation für jeden Typ und jedes Attribut finden Sie im entsprechenden URI.
Liste der Schemaerweiterungen
Die in dieser API verwendeten Schemaerweiterungen werden unter http://schema.googleapis.com als externe Erweiterungen gehostet.
Die Typerweiterung für Schema.org lautet:
Dies sind die Property-Erweiterungen für Schema.org: