Metadata-Version: 2.4
Name: guardrails-ai-provenance-embeddings
Version: 0.0.2
Summary: Compares embeddings of generated and source texts to calculate provenance.
Author-email: Guardrails AI <contact@guardrailsai.com>
License-Expression: MIT
Project-URL: Homepage, https://guardrailsai.com
Project-URL: Repository, https://github.com/guardrails-ai/guardrails-hub/tree/main/provenance_embeddings/py
Project-URL: Documentation, https://guardrails-ai.github.io/guardrails-hub/autoapi/guardrails_ai/provenance_embeddings/index.html
Requires-Python: <4,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: guardrails-ai>=0.4.0
Requires-Dist: numpy
Requires-Dist: nltk
Requires-Dist: sentence-transformers
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: coverage>=7.6.12; extra == "dev"
Requires-Dist: pyright[nodejs]>=1.1.396; extra == "dev"
Dynamic: license-file

# guardrails-ai-provenance-embeddings

Compares embeddings of generated and source texts to calculate provenance.

## Installation

```bash
pip install guardrails-ai-provenance-embeddings
```

This validator ships local models. After installing, run the post-install step to download them:

```bash
python -m guardrails_ai.provenance_embeddings.post_install
```

## Usage

```python
from guardrails import Guard
from guardrails_ai.provenance_embeddings import ProvenanceEmbeddings

guard = Guard().use(ProvenanceEmbeddings)
```

## License

MIT — © Guardrails AI.
