Metadata-Version: 2.1
Name: pyalbert
Version: 0.7.5.dev1
Summary: The Albert toolkit -- CLI, libraries and lexicons
Author-email: Etalab <etalab@modernisation.gouv.fr>
License: MIT
Project-URL: Homepage, https://github.com/etalab-ia/albert
Project-URL: Source, https://github.com/etalab-ia/albert
Project-URL: Tracker, https://github.com/etalab-ia/albert/issues
Project-URL: Documentation, https://github.com/etalab-ia/albert/tree/main/docs
Keywords: IA,LLM
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: pydantic==2.8.2
Requires-Dist: docopt-ng==0.9.0
Requires-Dist: wget==3.2
Requires-Dist: elasticsearch==8.14.0
Requires-Dist: qdrant-client==1.10.1
Requires-Dist: requests==2.32.3
Requires-Dist: beautifulsoup4==4.12.3
Requires-Dist: lxml==5.2.2
Requires-Dist: numpy==1.26.4
Requires-Dist: pandas==2.2.1
Requires-Dist: langchain-text-splitters==0.0.1
Requires-Dist: python-dotenv==1.0.1
Requires-Dist: jinja2==3.1.4
Requires-Dist: lz4==4.3.3
Requires-Dist: huggingface-hub==0.23.4
Requires-Dist: tqdm==4.66.5
Provides-Extra: test
Requires-Dist: pytest==8.2.2; extra == "test"
Provides-Extra: devops
Requires-Dist: prompt_toolkit==3.0.39; extra == "devops"

<table align="center"><tr><td align="center" width="9999">
<img src="/docs/assets/etalab.jpg" align="center" alt="Project icon">

# Albert

| <a href="https://www.etalab.gouv.fr/"><b>Etalab</b></a> | <a href="https://github.com/etalab-ia/albert/tree/main/docs"><b>Documentation</b></a> | <a href="https://huggingface.co/AgentPublic"><b>HuggingFace</b></a> | 

</td></tr></table>

*[English version below](#english-version)*

## À propos

Albert est un projet d'agents conversationnels (*large language models*, LLM) pour l'administration française, développé par les équipes du Datalab d'[Etalab](https://www.etalab.gouv.fr/) de la [Direction Interministérielle du Numérique (DINUM)](https://www.numerique.gouv.fr/dinum/). Pour toutes questions relatives à Albert, vous pouvez contacter l'équipe à l'adresse [etalab@modernisation.gouv.fr](etalab@modernisation.gouv.fr).

Ce dépôt permet de déployer deux services :
- les modèles *Albert* et leur API "LLM"

   > 💡 **Les différents modèles sont disponibles dans le dépôt HuggingFace [AgentPublic](https://huggingface.co/AgentPublic).**

- une API permettant d'interroger l'API du modèle à l'aide d'une base de connaissance (*Retrivial Augmented Generated*, RAG)

Vous trouverez également d'autres dépôts liés à Albert :

- [albert-frontend](https://github.com/etalab-ia/albert-frontend) (bientôt disponible) : une interface web pour interagir avec l'API Albert sous forme de chatbot
  
- [albert-tchapbot](https://github.com/etalab-ia/albert-tchapbot) : un chatbot Albert pour l'application Tchap (Messagerie instantanée de l'État)

## Documentation 

Vous trouverez l'ensemble de la documentation en français dans le dossier *[/docs/fr](./docs/fr/)* :
* [Installation](/docs/fr/installation.md)
* [Pour obtenir un jeton d'accès à l'API Albert](/docs/fr/api-token.md)
* [Bases de données](/docs/fr/databases.md)
* [Modèles supportés](/docs/fr/models.md)
* [Pour configurer les templates de prompt](/docs/en/prompt.md)
* [PyAlbert](/docs/fr/pyalbert.md)
* [Pour contribuer au projet](/docs/fr/contributing.md)

## Wiki

Vous trouverez également des informations complémentaires telles que :
* [Les stratégies de génération](/docs/fr/generation.md)

## Code source

Pour récupérer la dernière version du code :
```bash
git clone https://github.com/etalab-ia/albert.git
```

## Contribuer au projet

Consulter [la documentation dédiée](/docs/fr/contributing.md).

---

# English version

<details>
  <summary>English version</summary>

## About

Albert is a project of conversational agents (*large language models*, LLM) for the French administration, developed by the Datalab teams of [Etalab](https://www.etalab.gouv.fr/) from the [Direction Interministérielle du Numérique (DINUM)](https://www.numerique.gouv.fr/dinum/). For any questions regarding Albert, you can contact the team at [etalab@modernisation.gouv.fr](etalab@modernisation.gouv.fr).

This repository allows the deployment of two services:

- The Albert models and their API

   > 💡 **The models are available in the HuggingFace repository [AgentPublic](https://huggingface.co/AgentPublic).**

- An API allowing to query the model's API using a knowledge base ([Retrieval Augmented Generation, RAG](https://en.wikipedia.org/wiki/Prompt_engineering#Retrieval-augmented_generation))

You will also find other repositories related to Albert:

- [albert-frontend](https://github.com/etalab-ia/albert-frontend) (soon available): a web interface to interact with the Albert API as a chatbot

- [albert-tchapbot](https://github.com/etalab-ia/albert-tchapbot): a chatbot Albert for the Tchap application (Instant messaging app of the French State)

## Documentation 

You will find all the documentation in Engligh in the folder *[/docs/en](./docs/en/)*:
* [Installation](/docs/en/installation.md)
* [To get an access token for the Albert API](/docs/en/api-token.md)
* [Databases](/docs/en/databases.md)
* [Supported models](/docs/en/models.md)
* [To configure prompts templates](/docs/en/prompt.md)
* [PyAlbert](/docs/en/pyalbert.md)
* [To contribute to the project](/docs/en/contributing.md)

## Wiki

You will also find additional information such as:
* [Generation strategies](/docs/en/generation.md)

## Clone source code

To get the latest version of the code:
```bash
git clone https://github.com/etalab-ia/albert.git
```

## Contributing

Follow [the dedicated documentation](/docs/en/contributing.md).

</details>
