Skip to content
Snippets Groups Projects
Commit 613139f7 authored by Hampus Arvå's avatar Hampus Arvå
Browse files

Update README.md

parent 4bef85f3
No related branches found
No related tags found
No related merge requests found
# SAPIS
StilLett API Service
'SAPIS' is a restful web service based on Java Spring, implementing an API with
`SAPIS` is a restful web service based on Java Spring, implementing an API with
the ability to interpret options and input data as variables in an input JSON
object, passed to the 'SAPIS' service in a HTTP request. The open access of the
object, passed to the `SAPIS` service in a HTTP request. The open access of the
API allows for distribution of any web service uploaded to the same server
domain.
The API service can be reached from a server located at: http://www.ida.liu.se/projects/scream/services/sapis/service/, accepting POST requests.
## Current services
The current services implemented in 'SAPIS' are chosen from the research projects presented by Falkenjack et al., 2013 and Rennes and Jönsson, 2015.
The current services implemented in `SAPIS` are chosen from the research projects presented by Falkenjack et al., 2013 and Rennes and Jönsson, 2015.
1. The SurfaceMetrics (Falkenjack et al., 2013) service provides simple readability metrics such as LIX, OVIX, Nominal ratio, Mean sentence length and Mean word length.
2. The LexicalMetrics (Falkenjack et al., 2013) service provides a categorized frequency analysis from word occurrences in the basic Swedish vocabulary SweVoc dictionary.
3. The StructuralMetrics (Falkenjack et al., 2013) provides syntactic and morpho-syntactic features based on part-of-speech tags (openNLP) and dependency tags (MaltParser).
......@@ -22,7 +22,7 @@ text*, by Johan Falkenjack, Katarina Heimann Mühlenbock, and Arne Jönsson 2013
automatic simplification of Swedish texts*, by Evelina Rennes and Arne Jönsson 2015.
## HTTP request
'SAPIS' requires the input to be a JSON object containing the two variables options and
`SAPIS` requires the input to be a JSON object containing the two variables options and
document, where options specifies the choice of services and document specifies the string of
text to be analyzed/simplified. The chosen services are started in parallel and the result of each
service is merged into one single response.
......@@ -33,9 +33,9 @@ console of your browser (in java script by using console.log()) in order to easi
response JSON object and the values that is calculated.
### Java script examples
This section contains two examples on how to use 'SAPIS' with the services for calculating readability metrics and text simplification.
This section contains two examples on how to use `SAPIS` with the services for calculating readability metrics and text simplification.
This is an HTTP request, using jQuery.ajax, to 'SAPIS' and the services generating readability
This is an HTTP request, using jQuery.ajax, to `SAPIS` and the services generating readability
metrics: LexicalMetrics, SurfaceMetrics and StructuralMetrics.
var sapis_url = ’http://www.ida.liu.se/projects/scream/services/sapis/service/';
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment