Dokumentation

Übersicht

  1. Frequenzanalyse
  2. Stimmungserkennung
  3. Eigennamenerkennung & Wikification
  4. Themenerkennung
  5. Wortartenanalyse

Implementierungen

Die API-Aufrufe, die in dieser Dokumentation dargestellt sind, sind bewusst allgemein gehalten und können in vielen Programmiersprachen umgesetzt werden. Viele unserer Kunden greifen auf Python als Programmiersprache zurück und nutzen das Paket requests zur Kommunikation mit unserer API.

1. Frequenzanalyse

Frequenzanalyse

Schnittstelle

/analyze POST

Anfrage

{
    "credentials": "api_key",
    "text": "Gorillas leben im mittleren Afrika und ebenso wie die Schimpansen nur nördlich des Kongo-Flusses. Die Verbreitungsgebiete der zwei Gorilla-Arten liegen jedoch rund 1000 Kilometer voneinander entfernt. Westliche Gorillas leben nahe dem Golf von Guinea, wobei der Cross-River-Gorilla nur ein kleines Gebiet in der Grenzregion zwischen Nigeria und Kamerun bewohnt. Westliche Flachlandgorillas sind vom südlichen Kamerun und dem Westen der Zentralafrikanischen Republik über Äquatorialguinea, Gabun und die Republik Kongo bis in die angolanische Exklave Cabinda verbreitet. Die Population im äußersten Westen der Demokratischen Republik Kongo dürfte ausgestorben sein.",
    "processors": [
        "ngrams"
    ],
    "options": {
        "ngram_normalization": "lemma"
    }
}

Rückgabe

"ngrams": {
            "unigrams": [
                [
                    "Republik",
                    3
                ],
                [
                    "Gorilla",
                    2
                ],
                [
                    "leben",
                    2
                ],
                [
                    "westlich",
                    2
                ],
                [
                    "Westen",
                    2
                ],
                [
                    "Kongo",
                    2
                ],
                [
                    "Kamerun",
                    2
                ],
                [
                    "mittler",
                    1
                ],
                [
                    "Schimpanse",
                    1
                ],
                [
                    "nördlich",
                    1
                ],
                [
                    "Verbreitungsgebiete",
                    1
                ],
                [
                    "liegen",
                    1
                ],
                [
                    "1000",
                    1
                ],
                [
                    "Kilometer",
                    1
                ],
                [
                    "voneinander",
                    1
                ]
            ],
            "bigrams": [
                [
                    "Gorilla leben",
                    2
                ],
                [
                    "Republik Kongo",
                    2
                ],
                [
                    "mittler Afrika",
                    1
                ],
                [
                    "Gorilla-Arten liegen",
                    1
                ],
                [
                    "1000 Kilometer",
                    1
                ],
                [
                    "Kilometer voneinander",
                    1
                ],
                [
                    "voneinander entfernen",
                    1
                ],
                [
                    "westlich Gorilla",
                    1
                ],
                [
                    "leben nahe",
                    1
                ],
                [
                    "Kamerun bewohnen",
                    1
                ],
                [
                    "westlich Flachlandgorillas",
                    1
                ],
                [
                    "südlich Kamerun",
                    1
                ],
                [
                    "angolanische Exklave",
                    1
                ],
                [
                    "Exklave Cabinda",
                    1
                ]
            ],
            "trigrams": [
                [
                    "leben im mittler",
                    1
                ],
                [
                    "Schimpanse nur nördlich",
                    1
                ],
                [
                    "nördlich der Kongo-Flusses",
                    1
                ],
                [
                    "1000 Kilometer voneinander",
                    1
                ],
                [
                    "Kilometer voneinander entfernen",
                    1
                ],
                [
                    "westlich Gorilla leben",
                    1
                ],
                [
                    "Gorilla leben nahe",
                    1
                ],
                [
                    "nahe der Golf",
                    1
                ],
                [
                    "wobei der Cross-River-Gorilla",
                    1
                ],
                [
                    "Grenzregion zwischen Nigeria",
                    1
                ],
                [
                    "Nigeria und Kamerun",
                    1
                ],
                [
                    "Westen der Zentralafrikanischen",
                    1
                ],
                [
                    "Republik über Äquatorialguinea",
                    1
                ],
                [
                    "angolanische Exklave Cabinda",
                    1
                ]
            ]
        }

Normalisierungsoptionen sind: “lemma”, “lower”.

2. Stimmungserkennung

Stimmungserkennung

Schnittstelle

/analyze POST

Anfrage

{
    "credentials": "api_key",
    "text": "The worst polling ever, and then they’ll be back in four years to do it again.",
    "language": "en",
    "processors": [
        "sentiment"
    ]
}

Rückgabe

"sentiment": {
            "value": "negative",
            "confidence": 0.728,
            "model": "sentibanana_EN"
        }

Stimmungsmodelle sind für Deutsch und Englisch verfügbar.

3. Eigennamenerkennung & Wikification

Eigennamenerkennung

Schnittstelle

/analyze POST

Anfrage

{
    "credentials": "api_key",
    "text": "Nordrhein-Westfalen ist das bevölkerungsreichste der 16 Länder in Deutschland. Die Landeshauptstadt ist Düsseldorf, die einwohnerreichste Stadt ist Köln.",
    "language": "de",
    "processors": [
        "entities"
    ]
}

Rückgabe

"entities": [
            {
                "confidence": 0.9819,
                "charStart": 0,
                "charEnd": 19,
                "token": "Nordrhein-Westfalen",
                "ner_type": "wikification",
                "wikipedia": 3513,
                "wikidata": "Q1198"
            },
            {
                "confidence": 0.5692,
                "charStart": 66,
                "charEnd": 77,
                "token": "Deutschland",
                "ner_type": "wikification",
                "wikipedia": 1497705,
                "wikidata": "Q183"
            },
            {
                "confidence": 0.6795,
                "charStart": 104,
                "charEnd": 114,
                "token": "Düsseldorf",
                "ner_type": "wikification",
                "wikipedia": 1175,
                "wikidata": "Q1718"
            },
            {
                "confidence": 0.65,
                "charStart": 148,
                "charEnd": 152,
                "token": "Köln",
                "ner_type": "wikification",
                "wikipedia": 2648,
                "wikidata": "Q365"
            }
        ]

Entitätenerkennung und -Linking ist für Deutsch, Französisch, Italienisch und Englisch verfügbar.

4. Themenerkennung

Themenerkennung

Schnittstelle

/analyze POST

Anfrage

{
    "credentials": "api_key",
    "text": "Nordrhein-Westfalen ist das bevölkerungsreichste der 16 Länder in Deutschland. Die Landeshauptstadt ist Düsseldorf, die einwohnerreichste Stadt ist Köln.",
    "language": "de",
    "processors": [
        "topics"
    ]
}

Rückgabe

"topics": [
            {
                "impact": 1.0,
                "topic": "States of Germany"
            },
            {
                "impact": 1.0,
                "topic": "North Rhine-Westphalia"
            },
            {
                "impact": 1.0,
                "topic": "Germany"
            },
            {
                "impact": 1.0,
                "topic": "Sovereign state"
            },
            {
                "impact": 1.0,
                "topic": "Country"
            },
            {
                "impact": 1.0,
                "topic": "Federation"
            },
            {
                "impact": 1.0,
                "topic": "Republic"
            },
            {
                "impact": 1.0,
                "topic": "Rechtsstaat"
            },
            {
                "impact": 1.0,
                "topic": "Administrative division"
            }
        ]

Themenerkennung ist für Deutsch, Französisch, Italienisch und Englisch verfügbar.

5. Wortartenanalyse

Wortartenanalyse

Schnittstelle

/analyze POST

Anfrage

{
    "credentials": "api_key",
    "text": "Nordrhein-Westfalen ist das bevölkerungsreichste der 16 Länder in Deutschland. Die Landeshauptstadt ist Düsseldorf, die einwohnerreichste Stadt ist Köln.",
    "language": "de",
    "processors": [
        "tokens"
    ]
}

Rückgabe

"tokens": [
            {
                "token": "Nordrhein-Westfalen",
                "pos": "PROPN",
                "tag": "NE",
                "lemma": "Nordrhein-Westfalen",
                "dep": "sb",
                "stopword": false,
                "charOffset": 0,
                "length": 19
            },
            {
                "token": "ist",
                "pos": "AUX",
                "tag": "VAFIN",
                "lemma": "sein",
                "dep": "ROOT",
                "stopword": true,
                "charOffset": 20,
                "length": 3
            },
            {
                "token": "das",
                "pos": "DET",
                "tag": "ART",
                "lemma": "der",
                "dep": "nk",
                "stopword": true,
                "charOffset": 24,
                "length": 3
            },
            {
                "token": "bevölkerungsreichste",
                "pos": "NOUN",
                "tag": "NN",
                "lemma": "bevölkerungsreichste",
                "dep": "pd",
                "stopword": false,
                "charOffset": 28,
                "length": 20
            },
            {
                "token": "der",
                "pos": "DET",
                "tag": "ART",
                "lemma": "der",
                "dep": "nk",
                "stopword": true,
                "charOffset": 49,
                "length": 3
            },
            {
                "token": "16",
                "pos": "NUM",
                "tag": "CARD",
                "lemma": "16",
                "dep": "nk",
                "stopword": false,
                "charOffset": 53,
                "length": 2
            },
            {
                "token": "Länder",
                "pos": "NOUN",
                "tag": "NN",
                "lemma": "Land",
                "dep": "ag",
                "stopword": false,
                "charOffset": 56,
                "length": 6
            },
            {
                "token": "in",
                "pos": "ADP",
                "tag": "APPR",
                "lemma": "in",
                "dep": "mnr",
                "stopword": true,
                "charOffset": 63,
                "length": 2
            },
            {
                "token": "Deutschland",
                "pos": "PROPN",
                "tag": "NE",
                "lemma": "Deutschland",
                "dep": "nk",
                "stopword": false,
                "charOffset": 66,
                "length": 11
            },
            {
                "token": ".",
                "pos": "PUNCT",
                "tag": "$.",
                "lemma": ".",
                "dep": "punct",
                "stopword": false,
                "charOffset": 77,
                "length": 1
            },
            {
                "token": "Die",
                "pos": "DET",
                "tag": "ART",
                "lemma": "der",
                "dep": "nk",
                "stopword": true,
                "charOffset": 79,
                "length": 3
            },
            {
                "token": "Landeshauptstadt",
                "pos": "NOUN",
                "tag": "NN",
                "lemma": "Landeshauptstadt",
                "dep": "pd",
                "stopword": false,
                "charOffset": 83,
                "length": 16
            },
            {
                "token": "ist",
                "pos": "AUX",
                "tag": "VAFIN",
                "lemma": "sein",
                "dep": "ROOT",
                "stopword": true,
                "charOffset": 100,
                "length": 3
            },
            {
                "token": "Düsseldorf",
                "pos": "PROPN",
                "tag": "NE",
                "lemma": "Düsseldorf",
                "dep": "pd",
                "stopword": false,
                "charOffset": 104,
                "length": 10
            },
            {
                "token": ",",
                "pos": "PUNCT",
                "tag": "$,",
                "lemma": ",",
                "dep": "punct",
                "stopword": false,
                "charOffset": 114,
                "length": 1
            },
            {
                "token": "die",
                "pos": "DET",
                "tag": "ART",
                "lemma": "der",
                "dep": "nk",
                "stopword": true,
                "charOffset": 116,
                "length": 3
            },
            {
                "token": "einwohnerreichste",
                "pos": "ADJ",
                "tag": "ADJA",
                "lemma": "einwohnerreichste",
                "dep": "nk",
                "stopword": false,
                "charOffset": 120,
                "length": 17
            },
            {
                "token": "Stadt",
                "pos": "NOUN",
                "tag": "NN",
                "lemma": "Stadt",
                "dep": "sb",
                "stopword": false,
                "charOffset": 138,
                "length": 5
            },
            {
                "token": "ist",
                "pos": "AUX",
                "tag": "VAFIN",
                "lemma": "sein",
                "dep": "cj",
                "stopword": true,
                "charOffset": 144,
                "length": 3
            },
            {
                "token": "Köln",
                "pos": "PROPN",
                "tag": "NE",
                "lemma": "Köln",
                "dep": "pd",
                "stopword": false,
                "charOffset": 148,
                "length": 4
            },
            {
                "token": ".",
                "pos": "PUNCT",
                "tag": "$.",
                "lemma": ".",
                "dep": "punct",
                "stopword": false,
                "charOffset": 152,
                "length": 1
            }
        ]
Menü