API Dokumentation - Response

Die Antwort ist immer im Json-Format und enthält neben dem analysierten Text und der Sprache des Textes pro angefragtem Service einen Antwortblock. Der Inhalt des Antwortblocks ist Service-spezifisch und enthält das eigentliche Analyse-Ergebnis für diesen Service. Er wurde hier zunächst weggelassen und wird für jeden Service weiter unten beschrieben.

Ein Beispiel für eine vollständige Antwort finden Sie im Abschnitt Überblick.

Antwortformat

  • {
    • text: "Angela Merkel wurde am 17. Juli 1954 in Hamburg als Angela Dorothea Kasner geboren.",
    • timestamp: 1400247994051,
    • language: "de",
    • entities: [
    • ]
    • tags: [
    • ]
    • dates: [
    • ]
    • categories: [
    • ]
  • }

Hat ein Service den Text erfolgreich analysiert, aber keine Ergebnisse gefunden, so ist in der Antwort der Service-Block mit einer leeren Ergebnisliste enthalten. Tritt bei der Anfrage an einen einzelnen Service ein Fehler auf, dann antwortet die Neofonie Textmining API mit dem HTTP-Status 200 und dem üblichen Antwortformat, in dem dann allerdings dieser eine Service nicht enthalten ist. Nicht angefragte Services sind generell nicht in der Antwort enthalten.

Beschreibung der einzelnen Felder:

text Der analysierte Text. Falls eine URL angegeben wurde, ist hier der von der Webseite extrahierte Text enthalten, der die Grundlage der Analyse war. Wurde der Text direkt über den Text-Parameter angegeben, ist er unverändert hier wieder enthalten.
language Die für den Text erkannte Sprache, z.B. "de" oder "ru".
timestamp Der Zeitstempel der Antwort (in Millisekunden seit 1. Januar 1970).

Antwortformat: Entities

  • {
    • entities: [
      • {
        • confidence: 47.150089263916016,
        • end: 13,
        • label: "Angela Merkel",
        • start: 0,
        • surface: "Angela Merkel",
        • type: "PERSON",
        • uri: "https://www.wikidata.org/wiki/Q567"
      • },
      • {
        • confidence: 46.01070785522461,
        • end: 47,
        • label: "Hamburg",
        • start: 40,
        • surface: "Hamburg",
        • type: "PLACE",
        • uri: "https://www.wikidata.org/wiki/Q1055"
      • },
      • {
        • confidence: 75.0,
        • end: 74,
        • label: null,
        • start: 52,
        • surface: "Angela Dorothea Kasner",
        • type: "PERSON",
        • uri: null
      • }
    • ]
  • }

Beschreibung der einzelnen Felder:

label Das eindeutige Label der Entität.
surface Die Oberflächenform der Entität im Text.
type Der Typ der Entität. Mögliche Werte sind "PERSON", "PLACE", "ORGANISATION", "JOBTITLE", "WORK", "EVENT", "CONCEPT". Dieser wird heuristisch ermittelt und kann in Einzelfällen vom erwarteten Wert abweichen. Beispiel: Eine Stadt kann als Arbeitgeber fungieren und wird ggf. als Organisation eingestuft.
uri Die Wikidata URI der Entität. Kann nicht gesetzt sein, falls der Typ der Entität zwar erkannt wird, aber die Entität nicht bekannt.
confidence Konfidenzwert, repräsentiert die Sicherheit bei der Entitätserkennung. Ein höherer Wert steht für eine sicherere Erkennung. Der Konfidenzwert hat keine obere Grenze.
start Die Startposition der Entität im Text.
end Die Endposition der Entität im Text.

Antwortformat: Entities ML

Mit dem Machine Learning (ML) Service werden Entitäten mit Hilfe eines Machine Learning Modells bestimmt. Dies ist generell akkurater bei spezielleren, d.h. weniger bekannten Entiäten, wie sie z.B. öfter in Blog Posts auftreten. Für bekanntere Entitäten, wie sie z.B. meist in Nachrichtenartikeln vorkommen, empfiehlt sich der reguläre Entity Service. Wenn sie sich unsicher sind, verwenden sie den regulären Entity Service. Das Antwortformat von Entities ML ist dabei identisch zum regulären Entity Service.

Antwortformat: Tags

  • {
    • tags: [
      • {
        • confidence: 0.9967904107197822,
        • term: "Angela Merkel"
      • },
      • {
        • confidence: 0.9927268430144784,
        • term: "Juli"
      • },
      • {
        • confidence: 0.9751561498425574,
        • term: "Hamburg"
      • },
      • {
        • confidence: 0.7406453816287002,
        • term: "Angela Dorothea Kasner"
      • }
    • ]
  • }

Beschreibung der einzelnen Felder:

term Das gefundene Schlagwort.
confidence Der Konfidenzwert des Schlagworts, immer zwischen 0 und 1.

Antwortformat: Dates

  • {
    • dates: [
      • {
        • dateEnd:
          • {
            • bc: false,
            • day: 17,
            • month: 7,
            • year: 1954
          • }
        • dateStart:
          • {
            • bc: false,
            • day: 17,
            • month: 7,
            • year: 1954
          • }
        • end: 36,
        • start: 23,
        • surface: "17. Juli 1954"
      • }
    • ]
  • }

Beschreibung der einzelnen Felder:

surface Die Oberflächenform des Datums im Text.
start Die Startposition des Datums im Text.
end Die Endposition des Datums im Text.
dateStart Das Startdatum. Ein Datum wird immer als Zeitraum repräsentiert, mit eventuell zusammenfallendem Start- und Enddatum.
dateEnd Das Enddatum.
day Der Tag des Start- bzw. Enddatums. Mögliche Werte sind 1-31.
month Der Monat des Start- bzw. Enddatums. Mögliche Werte sind 1-12.
year Das Jahr des Start- bzw. Enddatums.
bc Beschreibt, ob das Datum sich auf die Zeit vor Christus bezieht. Mögliche Werte sind true und false.

Antwortformat: Categories

  • {
    • categories: [
      • {
        • confidence: 0.9840945695370302,
        • label: "politik"
      • },
      • {
        • confidence: 0.010815793425103136,
        • label: "wirtschaft"
      • },
      • {
        • confidence: 0.005075348628913112,
        • label: "kultur"
      • },
      • {
        • confidence: 1.09702999767795e-05,
        • label: "sport"
      • },
      • {
        • confidence: 1.8793566199359706e-06,
        • label: "reisen"
      • },
      • {
        • confidence: 8.05313821392574e-07,
        • label: "wissenschaft"
      • },
      • {
        • confidence: 6.26958551045314e-07,
        • label: "internet"
      • },
      • {
        • confidence: 6.479984358403916e-09,
        • label: "auto+technik"
      • }
    • ]
  • }

Beschreibung der einzelnen Felder:

label Der Name der Kategorie. Mögliche Werte sind "politik", "wirtschaft", "auto+technik", "internet", "kultur", "reisen", "sport", "vermischtes", "wissenschaft"
confidence Der Konfidenzwert für die Kategorie, immer zwischen 0 und 1.

Antwortformat: Measures

  • {
    • measures: [
      • {
        • start: 8,
        • end: 15,
        • text: "2 Meter",
        • valueString: "2",
        • unitString: "Meter",
        • type: "LENGTH"
      • }
    • ]
  • }

Beschreibung der einzelnen Felder:

start Die Startposition der Maßzahl im Text.
end Die Endposition der Maßzahl im Text.
text Die Zeichenkette, so wie sie im Text vorkommt.
valueString Der Wert der Maßzahl als Zeichenkette, so wie sie im Text vorkommt.
unitString Die Einheit der Maßzahl als Zeichenkette, so wie sie im Text vorkommt.
type Der Typ der Maßzahl. Mögliche Werte sind "LENGTH", "AREA", "MASS", "TEMPERATURE", "VOLTAGE", "AMPERAGE", "RESISTANCE", "CHARGE", "CAPACITY", "CONDUCTANCE", "INDUCTANCE", "MAGNETIC_STRENGTH", "POWER", "ENERGY", "FORCE", "PRESSURE", "FREQUENCY", "VOLUME", "LUMINOSITY", "ILLUMINANCE", "SPIN", "SUBSTANCE", "RADIOACTIVITY", "CURRENCY", "TIME", "UNKNOWN"