# Web Application

For ease of use, we developed a simple FullStack application (a Flask-based API as a BackEnd and jQuery FrontEnd) to analyze job descriptions and predict relevant occupations, skills, and qualifications using the entity-linking model.

### Usage

First, activate the virtual environment as explained [here](/our-tech-stack/livelihoods-classifier/getting-started.md#dep). Then, run the following command in python in the `root` directory:

#### Running the API

**Run the Flask application**:

```bash
python app/server/matching.py
```

Or set the Flask application environment variable and use the Flask command:

```bash
export FLASK_APP=app/server/matching.py
flask run --host=0.0.0.0 --port=5001
```

### Example Usage

1. **Open the browser** and navigate to `http://127.0.0.1:5001/`.
2. **Paste a job description** into the provided text area.
3. **Click the "Analyze Job" button** to send the job description to the `/match` endpoint.
4. **View the results** under "Predicted Occupations," "Predicted Skills," and "Predicted Qualifications."

{% hint style="danger" %}
This app is just for demonstration purposes. If you wish to deploy this model, use a more reliable/secure strategy.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tabiya.org/our-tech-stack/livelihoods-classifier/web-application.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.