Metadata-Version: 2.4
Name: exquisite
Version: 0.1
Summary: Corpus management for RAG databases: manifests, worksheets, and evaluation labels
Keywords: rag,retrieval-augmented generation,evaluation,corpus,manifest,citation,soliplex
Author: Tres Seaver
Author-email: Tres Seaver <tseaver@palladion.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Text Processing :: Indexing
Requires-Dist: pyyaml
Requires-Python: >=3.13
Project-URL: Homepage, https://github.com/soliplex/exquisite
Project-URL: Documentation, https://soliplex.github.io/exquisite/
Project-URL: Repository, https://github.com/soliplex/exquisite
Project-URL: Issues, https://github.com/soliplex/exquisite/issues
Description-Content-Type: text/markdown

# exquisite

Ref: [Exquisite Corpse](https://en.wikipedia.org/wiki/Exquisite_corpse)

`exquisite` labels evaluation question sets with the documents that answer
them, so that a retrieval-augmented generation (RAG) system can be scored on
*retrieval* as well as on its answers. It describes each ingestion of a
corpus in a *manifest*, generates *worksheets* in which a person who knows
the corpus records which documents each citation means, and *binds* a
question set to one ingestion by writing the documents' current URIs into
each question.

**Documentation:** <https://soliplex.github.io/exquisite/>

## Installation

`exquisite` needs Python 3.13 or later:

```bash
uv tool install exquisite
```

Until the first release is on PyPI, install from the repository:

```bash
uv tool install git+https://github.com/soliplex/exquisite
```

## Development

```bash
uv sync --group dev
uv run pytest
uv run ruff check
uv run --group docs zensical serve    # preview the docs locally
```

See [Development](docs/development.md) for more.

## License

MIT; see [LICENSE](LICENSE).
