wl-api

Still not finished... (e.g. the output of some functions need further formatting also no test cases so far)

wl-api is a javascript API for web services provided by the project Wortschatz, University of Leipzig.

http://wortschatz.uni-leipzig.de/

For further informations on the services:

http://wortschatz.uni-leipzig.de/Webservices/

Their SOAP Web Service offers different research possibilities for their German dictionary, including informations on wordfrequencies, baseforms, left and right neighbours, collocations and semantic similarity. You can access those informations via SOAP requests. This module provides functions to generate the requests and get the informations from the corresponding answers.

You may also be interested in other language specific bindings:

• Ruby http://github.com/arbox/wlapi/
• Perl http://search.cpan.org/~schroeer/Lingua-DE-Wortschatz/
• Python https://github.com/lehmannro/libleipzig-python
• C# http://code-bude.net/2013/07/22/csharp-api-fuer-den-wortschatz-leipzig-thesaurus-webservic/
• PHP http://web.archive.org/web/20090418233940/http://blog.klassifikator.de/2009/03/php-implementierung-des-wortschatz-webservice-der-uni-leipzig/

I'd like to give special thanks to Andrej Belenkow whose implementation of an api for ruby (wlapi) helped me alot to understand how the soap requests for the Wortschatz Leipzig projects work.

You can easily use this module with nodejs projects.

##Synopsis

just install it via

npm install wl-api

or

npm install https://github.com/rostu/wl-api.git

after that you can use it like this:

var wlapi = require('wl-api');

wlapi.baseform("Wälder",function(err,callback){
    console.log(callback); --> [ [ 'Wald', 'N' ] ]
    }
); 

if there is no search reult for your query you get null

wlapi.baseform("Wildssdflder",function(err,callback){
    console.log(callback); --> null
    }
); 

and if something went wrong you get an JSON Object like:

{ Message: 'Query Error occured',
  Error: '<?xml version="1.0" encoding="utf-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><soapenv:Fault><faultcode>soapenv:Server.userException</faultcode><faultstring>java.lang.ArrayIndexOutOfBoundsException: 1</faultstring><detail><ns1:hostname xmlns:ns1="http://xml.apache.org/axis/">pcai055.informatik.uni-leipzig.de</ns1:hostname></detail></soapenv:Fault></soapenv:Body></soapenv:Envelope>' }

If you are going to do mass requests, you need private credentials, for that you can change the standard authorization("anonymous","anonymous") with a function:

wlapi.set_credentials(String user,String password);

To get private credentials you should contact the support team of the project Wortschatz.

#Methods all the following examples assume you have declared a variable wlapi that require wl-api e.g.

var wlapi = require('wl-api');

###baseform returns the lemmatized (base) form of the input word and a pos tag or returns array of possible baseforms with pos tags.

wlapi.baseform("Bäume",function(err,callback){
    console.log(callback); --> [ [ 'Baum', 'N' ] ]
    }
);  

###frequencies Returns the frequency and frequency class of the input word. Frequency class is computed in relation to the most frequent word in the corpus. The higher the class, the rarer the word.

wlapi.frequencies("Esel",function(err,callback){
    console.log(callback); --> [ '3524', '12' ]
    }
);  

###domain Returns categories for a given input word as an array.

wlapi.domain("Esel",function(err,callback){
    console.log(callback);--> [ 'Spezielle Zoologie','Säugetiere','Nutztiere','pejorativ','Menschen psychisch' ]
    }
);

###wordforms For a given word form returns all other word forms of the same lemma.

wlapi.wordforms("string word",int limit);

wlapi.wordforms("laufen",5,function(err,callback){
console.log(callback);--> [ 'läuft', 'laufen', 'lief', 'gelaufen', 'liefen' ]
    }
);

###synonyms Returns synonyms of the input word. In other words, this is a thesaurus.

wlapi.synonyms("string word",int limit);

wlapi.synonyms("Esel",5,function(err,callback){
console.log(callback);-->   [ [ 'Depp', 's' ],
                            [ 'Dummkopf', 's' ],
                           [ 'Grauchen', 'S' ],
                           [ 'Langohr', 'S' ],
                           [ 'Grautier', 'S' ] ]
   }
); 

###thesaurus Similarly the Synonyms services returns synonyms of the given input word. However, this first lemmatizes the input word and thus returns more synonyms.

wlapi.thesaurus("string word",int limit);

wlapi.wordforms("Esel",5,function(err,callback){
console.log(callback);-->[ 'Pferd', 'Esel', 'Rind', 'Kamel', 'Büffel' ]
    }
);

###sentences Returns sample sentences containing the input word.

wlapi.sentences("string word",int limit);

wlapi.sentences("Bücher", 2 , function(err,callback){
    console.log(callback);-->[ [ '40587352',
    'So etwas hilft der positiven Identifikation mit den Kandidaten, und das heißt: Alle begleitenden Produkte wie CDs oder Bücher verkaufen sich vermutlich besser.' ],
  [ '40586269',
    'Nachdem er 1973 die Leitung des Feuilletons aufgegeben hatte und stellvertretender Chefredakteur geworden war, wurde das Spektrum seiner Artikel und Bücher noch breiter.' ] ]
    }
);

###left_neighbours For a given input word, returns statistically significant left neighbours. (words co-occurring immediately to the left of the input word) wlapi.left_neighbours("string word",int limit);

wlapi.left_neighbours("Esel",5, function(err,callback){
  console.log(callback);-->[ [ 'Ochs', 'Esel', '40' ],
                          [ 'trojanischen', 'Esel', '21' ],
                          [ 'störrische', 'Esel', '21' ],
                          [ 'alter', 'Esel', '19' ],
                          [ 'dummer', 'Esel', '16' ] ]
    }
);

###right_neighbours For a given input word, returns statistically significant right neighbours. (words co-occurring immediately to the right of the input word). wlapi.right_neighbours("string word",int limit);

wlapi.right_neighbours("Esel",5, function(err,callback){
    console.log(callback); -->[ [ 'Esel', 'reitend', '23' ],
                              [ 'Esel', 'streck', '23' ],
                               [ 'Esel', 'Ziegen', '19' ],
                               [ 'Esel', 'reiten', '17' ],
                               [ 'Esel', 'I-Aah', '14]]
   }
);

###similarity Returns automatically computed contextually similar words of the input word. Such similar words may be antonyms, hyperonyms, synonyms, cohyponyms or other. Note that due to the huge amount of data any query to this services may take a long time. wlapi.similarity("string word",int limit);

wlapi.similarity("Esel",5, function(err,callback){
    console.log(callback);  -->[ [ 'Esel', 'Rappen', '18' ],
                              [ 'Esel', 'Gaul', '17' ],
                              [ 'Esel', 'Pferd', '17' ],
                              [ 'Esel', 'Roß', '15' ],
                              [ 'Esel', 'andern', '14' ] ]
   }
);

###experimental_synonyms This service delivers an experimental synonyms request for internal tests. wlapi.experimental_synonyms("string word",int limit);

wlapi.experimental_synonyms("Esel",5, function(err,callback){
    console.log(callback);  --> [ [ 'Grautier', 'v' ],
                                [ 'Langohr', 'v' ],
                                [ 'Lasttier', 'v' ],
                                [ 'Lama', 'v' ],
                                [ 'Muli', 'v' ] ]
 }
);

###right_collocation_finder Attempts to find linguistic collocations that occur to the right of the given input word. The parameter Wortart accepts four values A,V,N,S which stand for adjective, verb, noun and stopword, respectively. The parameter restricts the type of words found. wlapi.right_collocation_finder("string word",string postag,int limit);

wlapi.right_collocation_finder("Esel","V",5, function(err,callback){
    console.log(callback);-->   [ 'Esel', 'anbinden', 'V' ],
                                  [ 'Esel', 'anreiten', 'V' ],
                                  [ 'Esel', 'begegnen', 'V' ],
                                  [ 'Esel', 'bepacken', 'V' ],
                                  [ 'Esel', 'beschimpfen', 'V' ]]
  }
);

###left_collocation_finder Attempts to find linguistic collocations that occur to the left of the given input word. The parameter Wortart accepts four values A,V,N,S which stand for adjective, verb, noun and stopword, respectively. The parameter restricts the type of words found. wlapi.left_collocation_finder("string word",string postag,int limit);

wlapi.left_collocation_finder("Esel","A",7, function(err,callback){
    console.log(callback);--> [ 'Golden', 'A', 'Esel' ],
                              [ 'alt', 'A', 'Esel' ],
                              [ 'andalusisch', 'A', 'Esel' ],
                              [ 'beladen', 'A', 'Esel' ],
                              [ 'bepackt', 'A', 'Esel' ],
                              [ 'bockend', 'A', 'Esel' ],
                              [ 'dumm', 'A', 'Esel' ]]
    }
);

###cooccurrences Returns statistically significant co-occurrences of the input word. wlapi.cooccurrences("string word",int least significant,int limit);

wlapi.cooccurrences("Esel",200,5, function(err,callback){
    console.log(callback);-->[  [ 'Esel', 'Ochs', '484' ],
                                [ 'Esel', 'und', '364' ],
                                [ 'Esel', 'ein', '213' ] ]
    }
);

###cooccurrences_all Returns statistically significant co-occurrences of the input word. However, the accesses the unrestricted version of the co-occurrences table as in the Cooccurrences services, which means significantly longer wait times. ####to use this service you need a user account different from anonymous wlapi.cooccurrences("string word",int least significant,int limit);

wlapi.cooccurrences_all("Esel",200,5); 

####intersection Returns the intersection of the co-occurrences of the two given words. The result set is ordered according to the sum of the significances in descending order. Note that due to the join involved, this make take some time. ####to use this service you need a user account different from anonymous

wlapi.intersection("string word1",string word2,int limit);

###crossword Given a pattern and a length, returns words that match these parameters. --> not sure how this works..

wlapi.crossword("string word",int word_lenght,int limit);

####to be implemented: ngrams and ngram_references