README.md

---
license: cc-by-4.0
task_categories:
- question-answering
language:
- pt
size_categories:
- 1M<n<10M
---

# Quati Information Retrieval Dataset

Quati dataset aims to support Brazilian Portuguese (pt-br) Information Retrieval (IR) systems development, providing document passagens originally created in pt-br, as well as queries (topics) created by native speakers.


## License

Quati is licensed under [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/).


## Citation Information

```
@misc{bueno2024quati,
      title={Quati: A Brazilian Portuguese Information Retrieval Dataset from Native Speakers}, 
      author={Mirelle Bueno and Eduardo Seiti de Oliveira and Rodrigo Nogueira and Roberto A. Lotufo and Jayr Alencar Pereira},
      year={2024},
      eprint={2404.06976},
      archivePrefix={arXiv},
      primaryClass={cs.IR}
}
```

## About Quati and how to use

Quati dataset is currently released in two versions: one with 1 million passages, and a larger one with 10 million passages. So far we have prepared only validation *qrels* for both versions, annotating 50 topics with an average of 97.78 passages per query on the 10M version, and 38.66 passages per query on the 1M version. 

Quati can be used to evaluate any Information Retrieval system target Brazilian Portuguese Language documents. The dataset creation and annotation pipeline can also be used to further expand the passages annotation, or to create other IR datasets targeting specific Languages. Please refer to [our publication](https://arxiv.org/abs/2404.06976) for further details about the dataset and its creation process.


### Obtaining the 1M dataset version

```python
>>> quati_1M_passages = load_dataset("unicamp-dl/quati", "quati_1M_passages")
>>> quati_1M_passages['quati_1M_passages'][0]
{'passage_id': 'clueweb22-pt0000-00-00003_1',
 'passage': 'Se você precisar de ajuda, visite o website nacional sobre a COVID-19 ou ligue para a linha de apoio à COVID-19 808 24 24 24 Perguntas mais frequentes Posso viajar entre Sintra e Cascais? Quais são as restrições de viagem em Cascais? Qual o número de telefone de apoio para a COVID 19 em Cascais? Preciso utilizar máscara facial no transporte público em Cascais? A prática do distanciamento social é compulsória em Cascais? O que eu devo fazer caso apresente sintomas da COVID-19 quando chegar em Cascais? Última atualização: 25 Abr 2022 Aplicam-se exceções, para detalhes completos: European Union. Estamos trabalhando ininterruptamente para lhe trazer as últimas informações de viagem relacionadas à COVID-19. Esta informação é compilada a partir de fontes oficiais. Ao melhor de nosso conhecimento, está correta de acordo com a última atualização. Visite Avisos de Viagem Rome2rio para ajuda geral. Perguntas & Respostas Qual a maneira mais econômica de ir de Sintra para Cascais? Qual a maneira mais rápida de ir de Sintra para Cascais? Existe um ônibus direto entre Sintra e Cascais? Qual a distância entre Sintra e Cascais? Como viajar de Sintra para Cascais sem carro? Qual a distância entre Sintra e Cascais? Aonde pegar ônibus de Sintra para Cascais?'}
```

### Obtaining the complete 10M dataset version

```python
>>> quati_10M_all = load_dataset("unicamp-dl/quati", "quati_10M_passages")
>>> quati_10M_all
DatasetDict({
    quati_10M_passages_part_00: Dataset({
        features: ['passage_id', 'passage'],
        num_rows: 2000000
    })
    quati_10M_passages_part_01: Dataset({
        features: ['passage_id', 'passage'],
        num_rows: 2000000
    })
    quati_10M_passages_part_02: Dataset({
        features: ['passage_id', 'passage'],
        num_rows: 2000000
    })
    quati_10M_passages_part_03: Dataset({
        features: ['passage_id', 'passage'],
        num_rows: 2000000
    })
    quati_10M_passages_part_04: Dataset({
        features: ['passage_id', 'passage'],
        num_rows: 2000000
    })
})
```
It is possible to download only single parts of the 10M dataset directly passing the corresponding configuration name ― e.g. `quati_10M_passages_part_02`.


### Obtaining the qrels

```python
>>> quati_1M_qrels = load_dataset("unicamp-dl/quati", "quati_1M_qrels")
>>> quati_1M_qrels['quati_1M_qrels'][0]
{'query_id': 1, 'passage_id': 'clueweb22-pt0000-78-09747_0', 'score': 1}
```

```python
>>> quati_10M_qrels = load_dataset("unicamp-dl/quati", "quati_10M_qrels")
>>> quati_10M_qrels['quati_10M_qrels'][2560]
{'query_id': 105, 'passage_id': 'clueweb22-pt0001-93-08394_4', 'score': 0}
```

### Obtaining the topics

```python
>>> quati_all_topics = load_dataset("unicamp-dl/quati", "quati_all_topics")
>>> quati_all_topics['quati_all_topics'][-1]
{'query_id': 199,
 'query': 'Quais foram os principais artistas do Impressionismo?'}
```

```python
>>> quati_test_topics = load_dataset("unicamp-dl/quati", "quati_test_topics")
>>> quati_test_topics['quati_test_topics'][0]
{'query_id': 1, 'query': 'Qual a maior característica da fauna brasileira?'}
```

### Cloning the dataset repository from Hugging Face

It is possible to obtain the entire dataset cloning it git repository from Hugging Face Hub:

```
git clone [email protected]:datasets/unicamp-dl/quati quati_dataset
```