Install langroid

Langroid requires Python 3.11+. We recommend using a virtual environment. Use pip to install a bare-bones slim version of langroid (from PyPi) to your virtual environment:

pip install langroid

The core Langroid package lets you use OpenAI Embeddings models via their API. If you instead want to use the sentence-transformers embedding models from HuggingFace, install Langroid like this:

pip install "langroid[hf-embeddings]"

For many practical scenarios, you may need additional optional dependencies:

• To use various document-parsers, install langroid with the doc-chat extra:

  pip install "langroid[doc-chat]"
  

• For "chat with databases", use the db extra:

  pip install "langroid[db]"
  

• You can specify multiple extras by separating them with commas, e.g.:

  pip install "langroid[doc-chat,db]"
  

• To simply install all optional dependencies, use the all extra (but note that this will result in longer load/startup times and a larger install size):

  pip install "langroid[all]"
  

Optional Installs for using SQL Chat with a PostgreSQL DB

If you are using SQLChatAgent (e.g. the script examples/data-qa/sql-chat/sql_chat.py), with a postgres db, you will need to:

• Install PostgreSQL dev libraries for your platform, e.g.
  • sudo apt-get install libpq-dev on Ubuntu,
  • brew install postgresql on Mac, etc.
• Install langroid with the postgres extra, e.g. pip install langroid[postgres] or poetry add "langroid[postgres]" or poetry install -E postgres, (or the corresponding uv versions, e.g. uv add "langroid[postgres]" or uv pip install langroid[postgres]). If this gives you an error, try pip install psycopg2-binary in your virtualenv.

📝 If you get strange errors involving mysqlclient, try doing pip uninstall mysqlclient followed by pip install mysqlclient.

---

🐳 Docker Instructions

We provide a containerized version of the langroid-examples repository via this Docker Image. All you need to do is set up environment variables in the .env file. Please follow these steps to setup the container: