Farasa

RESTful Web API Code Snippets

for POS Tagging Module

import json
import requests
url = 'https://farasa.qcri.org/webapi/pos/'
text = 'يُشار إلى أن اللغة العربية' 
api_key = "#####################"
payload = {'text': text, 'api_key': api_key}
data = requests.post(url, data=payload)
result = json.loads(data.text)
print(result)

import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;

public class FarasaSegmenter {
    private static HttpURLConnection con;
    public static void main(String[] args) throws IOException {
        var url = "https://farasa.qcri.org/webapi/pos/";
        var text = "يُشار إلى أن اللغة العربية يتحدثها أكثر من 422 مليون";
        var api_key = "#####################";
        var urlParameters = "text=" + text + "&api_key=" + api_key;
        byte[] postData = urlParameters.getBytes(StandardCharsets.UTF_8);
        try {
            var myurl = new URL(url);
            con = (HttpURLConnection) myurl.openConnection();
            con.setDoOutput(true);
            con.setRequestMethod("POST");
            con.setRequestProperty("User-Agent", "Java client");
            con.setRequestProperty("Content-Type", "application/json");
            try (var wr = new DataOutputStream(con.getOutputStream())) {
                wr.write(postData);
            }
            try (var br = new BufferedReader(
                    new InputStreamReader(con.getInputStream()))) {
                String line = br.readLine();
                System.out.println(line);
            }
        } finally {
            con.disconnect();
        }
    }
}

var text ='يُشار إلى أن اللغة العربية';
var api_key = "#####################";
var settings = { "async": true, 
"crossDomain": true, 
"url": "https://farasa.qcri.org/webapi/pos/", 
"method": "POST", 
"headers": { "content-type": "application/json", "cache-control": "no-cache", }, 
"processData": false, "data": "{\"text\":"+"\""+text+"\", \"api_key\":"+"\""+api_key+"\"}"; 
$.ajax(settings).done(function (response) { console.log(response); });

curl --header "Content-Type: application/json" -d "{\"text\":\"'يُشار إلى أن اللغة العربية'\", \"api_key\":\"'###################'\"}" https://farasa.qcri.org/webapi/pos/

Frequently Asked Questions

How can I use the jar file?

In case downloading the jar file, you can skip the building and compiling step. You just need to create a directory "lib" in the same level where the jar file is and copy the jar file of Farasa Segmenter module to this directory. Furthermore, download the file "weka.jar" and place it in the directory as well.

How can I use the source code?

In case downloading the sourcecode of Farasa POS Tagger, unzip the file and then change to the home directory of the project "FarasaPOS" and exexute the following commands into the terminal to compile the sourcecode and build the jar file:

ant java
ant jar

How do I run the package standalone?

To run the package as a standalone, just pass a text file (where the encoding is utf-8) as input to the package and specify the output file name as following:

java -jar dist/farasaPOSJar.jar -i <inputfile> -o <output_file>

How do I use Farasa POS tagger package as a library in an application?

To use Farasa POS Tagger as a library in your application, just build it using the shell script file "make.sh". Then import the jar file FarasaPOS.jar into your project. The following is an example fews line of code to show how to use Farasa POS module

package tryingfarasa;

import com.qcri.farasa.segmenter.Farasa;
import com.qcri.farasa.pos.FarasaPOSTagger;
import com.qcri.farasa.pos.Sentence;
import com.qcri.farasa.pos.Clitic;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;

public class TryingFarasaPOS {
    public static void main(String[] args) throws IOException, FileNotFoundException, ClassNotFoundException,
    UnsupportedEncodingException, InterruptedException, Exception {


        Farasa farasa = new Farasa();
        FarasaPOSTagger farasaPOS = new FarasaPOSTagger(farasa);

        ArrayList segOutput = farasa.segmentLine("النص المراد معالجته");

        Sentence sentence = farasaPOS.tagLine(segOutput);

        for (Clitic w : sentence.clitics)
        System.out.println(w.surface + "/" + w.guessPOS + ((w.genderNumber!="")?"-"+w.genderNumber:"")+" ");
     }
}

Which Java version should I use?

We tried Java 7 and Java 8 to build and run the Farasa packages. Earlier version of java may not be suitable to build the packages due to some dependencies(where the encoding is utf-8)

POS Tagging Module

FARASA Demo

for POS Tagging Module

RESTful Web API Code Snippets

for POS Tagging Module

Frequently Asked Questions