API-Dokumentation

Mit TXTWerk können beliebige Texte nach semantischen Gesichtspunkten analysiert und automatisch mit Schlagworten und Metadaten angereichert werden. Dabei kommen verschiedene Sprachtechnologien und Machine-Learning-Methoden zum Einsatz. Die Texte werden thematisch klassifiziert, Schlagworte werden automatisch extrahiert, Daten und Zeiträume sowie Namenserwähnungen von Orten, Personen und Organisationen (Named Entities) werden erkannt und mit URIs aus dem Wikidata-Knowledge-Graph verlinkt. Dadurch sind Anwendungen in der Lage, unstrukturierte Texte anzureichern und in die Linked-Open-Data-Welt zu vernetzen.

Authentifizierung

Die Authentifizierung erfolgt durch die Angabe des Api-Keys als Header "X-Api-Key".

Beispielanfrage

Details zu den Parametern und eine ausführliche Beschreibung des Rückgabeformats finden sich in der Request- bzw. Response- Dokumentation..

Request

curl "https://api.txtwerk.de/rest/txt/analyzer" \
    -H "X-Api-Key: ..." \
    --data-urlencode text='TXTWerk ist die Textmining-API der Neofonie GmbH, ein in Berlin ansässiger Fullservice-Provider. Neben Entitäten und Schlagwörtern erkennt TXTWerk in Texten unter anderem auch Datumsangaben (z.B. 08.09.2023) und Maßzahlen (z.B. 24h) und ordnet jeden Text einer passenden Textklasse zu.' \
    -d services='entities,lexiconEntities,dates,categories,measures,tags,fingerprints,lexiconTags,nerEntities'

Response

{
- text: "TXTWerk ist die Textmining-API der Neofonie GmbH, ein in Berlin ansässiger Fullservice-Provider. Neben Entitäten und Schlagwörtern erkennt TXTWerk in Texten unter anderem auch Datumsangaben (z.B. 08.09.2023) und Maßzahlen (z.B. 24h) und ordnet jeden Text einer passenden Textklasse zu.",
- language: "de",
- tags: [
  - {
    - confidence: 0.9989658313414402,
    - term: "TXTWerk"
  - },
  - {
    - confidence: 0.9782419755349671,
    - term: "Entitäten"
  - },
  - {
    - confidence: 0.9732933133596776,
    - term: "Textmining-API"
  - },
  - {
    - confidence: 0.9365462323616698,
    - term: "Neofonie GmbH"
  - },
  - {
    - confidence: 0.8993179739843555,
    - term: "Schlagwörter"
  - },
  - {
    - confidence: 0.8814831569459867,
    - term: "Berlin"
  - },
  - {
    - confidence: 0.874798029178814,
    - term: "Fullservice-Provider"
  - }
- ]
- entities: [
  - {
    - confidence: 36.218177795410156,
    - relevance: 25.53207015991211,
    - surface: "GmbH",
    - label: "Gesellschaft mit beschränkter Haftung",
    - uri: "https://www.wikidata.org/wiki/Q460178",
    - type: "CONCEPT",
    - start: 44,
    - end: 48
  - },
  - {
    - confidence: 39.26929473876953,
    - relevance: 11.950702667236328,
    - surface: "Berlin",
    - label: "Berlin",
    - uri: "https://www.wikidata.org/wiki/Q64",
    - type: "PLACE",
    - start: 57,
    - end: 63
  - },
  - {
    - confidence: 95.73828125,
    - relevance: 35.542537689208984,
    - surface: "Texten",
    - label: "Text",
    - uri: "https://www.wikidata.org/wiki/Q234460",
    - type: "CONCEPT",
    - start: 150,
    - end: 156
  - }
- ]
- lexiconEntities: [
  - {
    - confidence: 100.0,
    - relevance: 33.77956008911133,
    - surface: "Neofonie GmbH",
    - label: "Neofonie GmbH",
    - uri: "Neofonie",
    - type: "Organisation",
    - userDefinedFields:
      - {
      - }
    - start: 35,
    - end: 48
  - }
- ]
- dates: [
  - {
    - surface: "08.09.2023",
    - start: 196,
    - end: 206,
    - dateStart:
      - {
        
        day: 8,
        
        month: 9,
        
        year: 2023,
        
        bc: false
      - }
    - dateEnd:
      - {
        
        day: 8,
        
        month: 9,
        
        year: 2023,
        
        bc: false
      - }
  - }
- ]
- categories: [
  - {
    - confidence: 0.9999914614615732,
    - label: "internet"
  - },
  - {
    - confidence: 8.5340630740002E-6,
    - label: "kultur"
  - },
  - {
    - confidence: 3.4390082461387908E-9,
    - label: "auto+technik"
  - },
  - {
    - confidence: 7.942384268635301E-10,
    - label: "wirtschaft"
  - },
  - {
    - confidence: 1.1799574174439144E-10,
    - label: "reisen"
  - },
  - {
    - confidence: 8.06441429999464E-11,
    - label: "wissenschaft"
  - },
  - {
    - confidence: 4.031349737157026E-11,
    - label: "politik"
  - },
  - {
    - confidence: 3.152736753221788E-12,
    - label: "sport"
  - }
- ]
- measures: [
  - {
    - start: 228,
    - end: 231,
    - text: "24h",
    - valueString: "24",
    - unitString: "h",
    - type: "TIME",
    - alias: [
    - "24 h",
    - "24h",
    - "24Stunde",
    - "24 Stunde",
    - "24 Stunden",
    - "24Stunden",
    - ]
  - }
- ]
- fingerprints: [
- 7493129,
- 18632078,
- 48467713,
- 64740551,
- 61803666,
- 57602,
- 20683602,
- 7169662,
- 124073776,
- 1324512,
- 48689911,
- 63618400,
- 82739683,
- 57114900,
- 86498997,
- 5531749,
- 43615458,
- 63266708,
- 35312651,
- 1767346,
- 166345084,
- 20994017,
- 10618634,
- 35187378,
- 52012568,
- 62221932,
- 101283997,
- 194238108,
- 24943142,
- 48857582,
- 214343186,
- 8807040,
- 11737208,
- 29004557,
- 33563369,
- 23510317,
- 54409541,
- 58494605,
- 55886581,
- 88208507,
- 10609552,
- 7042020,
- 21855281,
- 9560326,
- 22894461,
- 19569052,
- 11695122,
- 59192088,
- 11647472,
- 25992587,
- ]
- lexiconTags: [
  - {
    - id: "[unique id]",
    - tag: "ansässig",
    - score: 7.6243725,
    - analyzed: "ansässig",
    - observedSurfaces: [
      - {
        
        start: 64,
        
        end: 74,
        
        type: "TAG",
        
        observedSurface: "ansässiger",
        
        analyzed: "ansässig"
      - }
    - ]
  - }
- ]
- nerEntities: [
  - {
    - type: "ORGANISATION",
    - confidence: 0.6897694170475006,
    - start: 35,
    - end: 48,
    - surface: "Neofonie GmbH"
  - },
  - {
    - type: "PLACE",
    - confidence: 0.9957075119018555,
    - start: 57,
    - end: 63,
    - surface: "Berlin"
  - }
- ]
}