Please contact us for FREE access before proceeding to implement this API.
vekslv[at]rpi.edu
To get the list of measures, send the following http query:
http://cwl-projects.cogsci.rpi.edu/cgi-bin/msr/msr.cgi?msrs=1
To send a batch request for a specific measure, make http request to http://cwl-projects.cogsci.rpi.edu/cgi-bin/msr/msr.cgi, passing the following parameters
(using either POST or GET method):
- msr - the name of the MSR you would like to use
- terms - list of terms to be compared to terms2
- terms2 - if terms2 is not specified, terms2 = terms
e.g. http://cwl-projects.cogsci.rpi.edu/cgi-bin/msr/msr.cgi?msr=NSS-Gwikipedia&terms=['cat','dog','feline','man','woman','shoe']
OR
- msr - the name of the MSR you would like to use
- terms - pairs of terms to be compared
e.g. http://cwl-projects.cogsci.rpi.edu/cgi-bin/msr/msr.cgi?msr=NSS-Gwikipedia&terms=[('cat','dog'),('feline','man'),('woman','shoe')]
The resulting page will contain a link to a progress text file.
This progress text file may be requested at any time at the provided address.
It will tell you both, the current progress of the batch, and the address of a (partial or completed) tab-delimited results file.
The tab-delimited results file will have 3 columns: term1, term2, and score.
The results file will be deleted 30 days after its completion.
WARNINGS:
Try to submit all terms in lowercase, with no funny characters or whitespaces.
Colorado's LSA engine is the only measure that is currently capable of handling multi-word terms.
Do not submit multiple batch requests simultaneously -- it will only slow down the total time your job will take.
If your terms include apostrophes, you can include these terms in double-quotes. E.g. you cannot send ['wayne's world'], because it has an apostrophe within apostrophes, but you can send
terms=["wayne's world", 'party time', "excellent"]
Large batch jobs are ok to submit, BUT beware -- power failures and reboots will leave your job half-done.
GET vs POST: GET requests are limited by the allowed size of the location string. For bigger jobs you will need to submit POST requests.