Farasa

RESTful Web API Code Snippets

for Segmentation Module

import json
import requests
url = 'https://farasa.qcri.org/webapi/segmentation/'
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/segmentation/";
        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/segmentation/", 
"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/segmentation/

Frequently Asked Questions

How can I use the jar file?

In case downloading the jar file, you can skip the building and compiling step.

How can I use the source code?

In case downloading the sourcecode of Farasa Segmenter module, unzip the file and then change to the home directory of the project "FarasaSegmenter" 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, there two ways; either in an interactive mode, just run the following command:

java -jar dist/farasaSeg.jar

Or, 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/farasaSeg.jar -i <inputfile> -o <output_file>

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

just build it as before using the shell script file "make.sh". Then import the jar file farasaSeg.jar into your project. The following is an example few line of code to show how to use Farasa segmentation package

package tryingfarasa;

import com.qcri.farasa.segmenter.Farasa;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;

public class TryingSeg {

    ...

    public static void main(String[] args) throws IOException, FileNotFoundException, ClassNotFoundException {
         ...

        Farasa farasa = new Farasa();
        ArrayList output = farasa.segmentLine("النص المراد معالجته");
                for(String s: output)
                System.out.println(s);
         ...
     }
     ...
}

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)

Word Segmentation Module

FARASA Demo

for Segmentation Module

RESTful Web API Code Snippets

for Segmentation Module

Frequently Asked Questions