Methode entity.search

Durchsucht den Knowledge Graph nach Entitäten, die den Einschränkungen entsprechen.

HTTP-Anfrage

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

Suchparameter

Parametername Typ Beschreibung
query string Ein literaler String, nach dem im Knowledge Graph gesucht wird.
ids string Eine Liste der Entitäts-IDs, nach denen im Knowledge Graph gesucht wird. Wenn Sie mehrere IDs in der HTTP-Anfrage angeben möchten, wiederholen Sie den Parameter im URL wie in ...?ids=A&ids=B
languages string Die Liste der Sprachcodes (definiert in 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. Beispiel: Sie können „Person“ angeben (wie in http://schema.org/Person definiert). um die Ergebnisse auf Entitäten zu beschränken, die Personen repräsentieren. Wenn mehrere Typen angegeben sind, zurückgegebene Entitäten einen oder mehrere dieser Typen enthalten.
indent boolean Aktiviert das Einrücken von JSON-Ergebnissen.
prefix boolean Ermöglicht den Präfixabgleich (anfänglicher Teilstring) für die Namen und Aliasse von Entitäten. Mit dem Präfix „Jung“ werden z. B. Entitäten und Aliasse wie als "Jung", "Dschungel" und "Jung-ho Kang".
limit number Begrenzt die Anzahl der zurückzugebenden Entitäten. Der Höchstwert ist 500. Der Standardwert ist 20. Bei Anfragen mit hohen Limits ist die Wahrscheinlichkeit einer Zeitüberschreitung höher.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Eine Antwortnachricht enthält eine Liste von Entitäten, die in 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 mit der Entität übereinstimmen.
description string Eine kurze Beschreibung der Entität.
image URL Ein Bild zur Identifizierung der Entität.
detailedDescription string Eine detaillierte Beschreibung der Entität.
url URL Die offizielle Website-URL der Entität, falls verfügbar.
resultScore number Ein Indikator dafür, wie gut die Entität den Anfrageeinschränkungen entsprochen hat.

JSON-LD-Keywords

Für JSON-LD-Keywords wie @context , @vocab @type oder @id, siehe JSON-LD-Spezifikation.

Schema.org-Kompatibilität

Die Antwort verwendet das Vokabular, das unter schema.org mit eingeschränkten Erweiterungen (für Beispiel: resultScore), die mit dem schema.org-Vokabular kompatibel sind. Weitere Informationen zu diesen Erweiterungen finden Sie unter Liste der Schemaerweiterungen.

Für alle Schema.org-Typen (z. B. Person) und Properties (z. B. name) gibt es einen entsprechenden vollständigen URI, wie in den folgenden Beispielen gezeigt:

  • Person -> http://schema.org/Person
  • Ding -> http://schema.org/Thing

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

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

Als Google-Schemaerweiterungen definierte Typen und Eigenschaften können erweitert mit http://schema.googleapis.com. Beispiel:

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

Die Dokumentation für jeden Typ und jede Eigenschaft finden Sie auf der entsprechenden URI.

Liste der Schemaerweiterungen

In dieser API verwendete Schemaerweiterungen werden hier gehostet http://schema.googleapis.com als externe Erweiterungen.

Die Erweiterung type von Schema.org lautet:

Die property-Erweiterungen für Schema.org sind: