soev-retrieval
Overview
Search a vector store through one protocol, with Weaviate and pgvector adapters and a contract suite for each store.
soev-retrieval defines one protocol for a vector store. An agent searches each store through that protocol, so a store can change without a change to the agent. The package has a stock store for Weaviate and one for pgvector, and a contract suite that tests a store against the protocol.
Install
soev-retrieval needs Python 3.12 or later. It has no dependencies without an extra.
pip install "soev-retrieval[pgvector]"| Extra | Adds |
|---|---|
weaviate | The Weaviate client, for the Weaviate store |
pgvector | psycopg and its connection pool, for the pgvector store |
testing | pytest and pytest-asyncio, for the contract suite in soev_retrieval.testing |
Where to start
- Reference of
soev_retrieval:soev_retrieval.domainholds the data that a search names and returns, andsoev_retrieval.portsholds the protocol. soev_retrieval.adapters: the stock stores, each behind its own extra.soev_retrieval.testing: run the contract suite against your own store.