Skip to content

mozilla-ai/structured-qa

Repository files navigation

Project logo

Structured-QA: a Blueprint by Mozilla.ai for answering questions about structured documents.

Docs Tests Ruff

This Blueprint demonstrates how to use open-source models and a simple LLM workflow to answer questions based on structured documents.

It is designed to showcase a simpler alternative to more complex and/or resource demanding alternatives, such as RAG systems that rely on vectorDBs and/or long-context models with large token windows.

structure-qa Diagram

📘 To explore this project further and discover other Blueprints, visit the Blueprints Hub.

👉 📖 For more detailed guidance on using this project, please visit our Docs here.

Quick-start

Get started with structured-qa using one of the options below:

Google Colab HuggingFace Spaces GitHub Codespaces
Try on Colab Try on Spaces Try on Codespaces

You can also install and use the blueprint locally:

Command Line Interface

pip install structured-qa
structured-qa \
--question "What optimizer was used to train the model?" \
--input_file "example_data/1706.03762v7.pdf" \
--output_dir "example_outputs/1706.03762v7.pdf"

Graphical Interface App

git clone https://github.com/mozilla-ai/structured-qa.git
cd structured-qa
pip install -e .
python -m streamlit run demo/app.py

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.

Contributing

Contributions are welcome! To get started, you can check out the CONTRIBUTING.md file.