API Dokumentation - Request

Der Request kann als GET oder als POST Request an die URL
 https://api.neofonie.de/rest/txt/analyzer
erfolgen. Das zu annotierende Dokument und die Auswahl der anzuwendenden Services werden als Parameter übergeben.

Dokument

Das zu annotierende Dokument kann direkt als Text übergeben werden.

Alternativ kann auch einfach die URL einer zu analysierenden Webseite angegeben werden. In diesem Fall wird die Webseite gecrawlt, der wesentliche Textinhalt bestimmt und verarbeitet. Fremde Elemente wie die Navigation oder Teaser-Texte werden aussortiert.

Services

Das Dokument kann mit verschiedenen Techniken analysiert werden. Zur Auswahl stehen folgende Services

entities Named Entities auf Basis der Wikidata Ontologie.
tags Schlagwörter, die im Text vorkommen, den Inhalt gut beschreiben und zusammenfassen.
categories Zuordnung des Texts zu den Kategorien Politik, Wirtschaft, Auto & Technik, Internet, Kultur, Politik, Reisen, Vermischtes, Wissenschaft.
dates Datumsangaben und Zeiträume.
entities-ml Alternativer Named Entity Service basierend auf einem Machine Learning Verfahren.
measures Maßzahlen die im Text enthalten sind.

Servicesteuerung

Für einzelne Services stehen weitere Parameter zur Verfügung, mit denen die Analyse oder das Ergebnis beeinflusst werden können.

Beispielanfrage

Beispiel für einen POST Request, bei dem das Dokument direkt als Text übergeben wird:

curl "https://api.neofonie.de/rest/txt/analyzer" \
    -H "X-Api-Key: ..." \
    --data-urlencode text='Angela Merkel wurde am 17. Juli 1954 in Hamburg als Angela Dorothea Kasner geboren.' \
    -d services='entities'

Beispiel für einen GET Request, bei dem das Dokument von der angegebenen Webseite geholt wird:

curl "https://api.neofonie.de/rest/txt/analyzer?url=http://www.neofonie.de&services=entities" \
    -H "X-Api-Key: ..."

Parameterübersicht

Parameter Bereich Beschreibung
text Dokument Enthält das zu annotierende Dokument als Text. Für längere Texte empfiehlt sich, die Anfrage als POST Request abzusetzen und den Text im Request Body zu übergeben.

Erforderlich: entweder text oder url
Werte: Text
url Dokument URL der Webseite, deren Hauptinhalt analysiert werden soll.

Erforderlich: entweder text oder url
Werte: gültige HTTP URL
title Dokument Titel des Dokumentes. Durch die zusätzliche Angabe eines Titels kann das Ergebnis verbessert werden. Wird nur für folgende Services berücksichtigt: tags.

Erforderlich: nein
Werte: Text
teaser Dokument Teaser des Dokumentes. Durch die zusätzliche Angabe eines Teasers kann das Ergebnis verbessert werden. Wird nur für folgende Services berücksichtigt: tags.

Erforderlich: nein
Werte: Text
services Services Liste der anzufragenden Services.

Erforderlich: ja
Werte: komma-separierte Liste, die mindestens einen der unterstützten Services enthält: [entities, tags, categories, dates, entities-ml, measures]
language Servicesteuerung Sprache des Eingabetexts. Durch diese Angabe können gezielt sprachabhängige Komponenten aktiviert werden.

Erforderlich: nein, wird dann automatisch bestimmt
Werte: 'de' oder 'en'
ntags Servicesteuerung Anzahl der Schlagwörter, die maximal bestimmt werden sollen.
Service: tags.

Erforderlich: nein, Default: 10
Werte: nichtnegative ganze Zahl
ncategories Servicesteuerung Anzahl der zurückgegebenen Kategorien.
Service: categories.

Erforderlich: nein
Werte: nichtnegative ganze Zahl