RoboTagger Dokumentation - Benutzung des Webservices

Um mit dem Webservice Daten auszutauschen, muss eine POST-Anfrage mit dem Parameter rtXMLRequest an die URL

http://ws.robotagger.com:8080/WebService/

als XML gesendet werden.

Die Struktur des XML sieht wie folgt aus:

<?xml version="1.0" encoding="UTF-8"?>
<RTRequest>
    <apiKey></apiKey>
    <document>
    <annotypes>
       <annotype> Annotype 1 hier </annotype>
       <annotype> Annotype 2 hier </annotype>
       ...
    </annotypes>
    <content><![CDATA[ Text hier ]]></content>
    <url> URL hier </url>
    </document>
</RTRequest>

Erläuterungen:

apiKey Ethält den API Schlüssel
annotype Enthält die Werte, nach denen zu annotieren ist. Eine Liste der möglichen Einträge steht unter dieser Tabelle (Es ist möglich mehrere annotype-Elemente zu verwenden)
content Zu annotierender Inhalt im UTF-8 Format (nicht zusammen mit url verwenden)
url Die URL des zu annotierenden Dokuments (nicht zusammen mit content verwenden)

Folgende Werte sind für den annotype möglich:

  • Beruf
  • Betriebssystem
  • Fahrzeug
  • FahrzeugModel
  • FahrzeugTeil
  • Hardware
  • JobPosition
  • Kontinent
  • Land
  • MediaUnternehmen
  • Organisation
  • Person
  • ProgrammierSprache
  • ProvinzOderStaat
  • RegierungsOrganisation
  • Software
  • Sport
  • SportLeague
  • SportTeam
  • SpracheNegativ
  • SprachePositiv
  • Stadt
  • Technologie
  • Unternehmen
  • Waehrung

Ist die Anfrage valide, sendet der Webservice ein XML wie folgt zurück:

<?xml version="1.0" encoding="UTF-8"?>
    <RTDocument>
        <error></error>
        <topic></topic>
        <annotations>
           <annotation annoType="Unternehmen" annoSubType="Technologie" stringVal="Microsoft" occurrences="2" threshold="0.023423476"></annotation>
        </annotations>
    </RTDocument>

Hierbei ist

error Fehlercode
topic Das erkannte Topic
annotation annotype der Anotationstyp
annoSubType die Unterkategorie eines Annotationstyps sofern vorhanden
stringVal die eigentliche Annotation
occurrences Anzahl der Vorkommnisse im Text
threshold liegt zwischen 0 und 1 und repräsentiert die Wichtigkeit des Wortes für den Text