# Evaluation SK-QuAD Retrieval

## Dataset Structure

### Data Instances

- File for evaluation semantic search semantic_search_results.jsonl
  
**evaluation/semantic_search_results.jsonl**
```json
{
  "id": "1000005",
  "question": "Akú nadmorskú výšku má vrch Kremenec ?",
  "results": [
    {
      "id": 146848,
      "context": "Vrchol Vrchol Kremenca je zalesnený a neposkytuje výhľady, prechádzajú cez neho iba hraničné prieseky. Výhľady ponúka jeho okolie, vrchy v jeho blízkosti, ako Kamenná lúka () vzdialená približne 25 minút pešej chôdze a významný poľský vrch Wielka Rawka () vzdialený približne 45 minút pešej chôdze.",
      "title": "Kremenec (vrch v Bukovských vrchoch)",
      "url": "https://sk.wikipedia.org/wiki/Kremenec_(vrch_v_Bukovských_vrchoch)",
      "score": 0.8585323095321655,
      "probability_search": 0.072
    },
    {
      "id": 146844,
      "context": "Najvyšší bod Samotný vrchol Kremenca – najvyšší bod s nadmorskou výškou sa už nachádza mimo územia Slovenska, cca 150 metrov východnejšie od našej hranice, na poľsko-ukrajinskej štátnej hranici. Najvyšší bod na území Slovenska má nadmorskú výšku , tu sa nachádza žulový hraničný stĺp označujúci trojmedzie.",
      "title": "Kremenec (vrch v Bukovských vrchoch)",
      "url": "https://sk.wikipedia.org/wiki/Kremenec_(vrch_v_Bukovských_vrchoch)",
      "score": 0.8208335041999817,
      "probability_search": 0.07
    }
  ]
}
```

### Data Fields

**evaluation/semantic_search_results.jsonl**
- id: A unique identifier for each data instance.
- question: The question in Slovak language from SK-QuAD.
- results A list of searched results
  - id: A unique identifier for each answer.
  - context: The context of the answer.
  - title: The title of the article.
  - url: The URL of the article.
  - score: The score of the search result.
  - probability_search: The probability score 0-1 of the search result.


### How to Run Evaluation
- run python evaluation code with python 3.10

```shell
cd evaluation
python automatic_evaluation.py ../answering.jsonl semantic_search_results.jsonl
```