----------------------------------------------------------------------
This is the API documentation for the gdtest_interlinks_prose library.
----------------------------------------------------------------------


## Classes

Main classes provided by the package


BaseStore(name: str) -> None

Base class for all stores.

Available implementations:

- [](`~gdtest_interlinks_prose.DuckDBStore`): local storage with
  embedded search.
- [](`~gdtest_interlinks_prose.ChromaDBStore`): vector storage
  using ChromaDB.

Parameters
----------
name
    The name of the store.

ChromaDBStore(name: str, collection: str = 'default') -> None

Vector storage using ChromaDB.

Inherits from [](`gdtest_interlinks_prose.BaseStore`).
See [the DuckDB-backed store](`~gdtest_interlinks_prose.DuckDBStore`) for a
simpler alternative.

Parameters
----------
name
    The name of the store.
collection
    The ChromaDB collection name.

DuckDBStore(name: str, path: str = ':memory:') -> None

Local storage backed by DuckDB.

Inherits from [](`~gdtest_interlinks_prose.BaseStore`).
Use [](`~gdtest_interlinks_prose.query`) to search the store
after loading data.

Parameters
----------
name
    The name of the store.
path
    Path to the DuckDB database file.


## Functions

Utility functions


query(store: gdtest_interlinks_prose.BaseStore, text: str) -> list

Search a store for matching documents.

Works with any [](`~gdtest_interlinks_prose.BaseStore`)
implementation, including
[](`gdtest_interlinks_prose.DuckDBStore`) and
[the ChromaDB store](`gdtest_interlinks_prose.ChromaDBStore`).

Parameters
----------
store
    The store to search. Must be an instance of
    [a base store](`~gdtest_interlinks_prose.BaseStore`).
text
    The search query string.

Returns
-------
list
    Matching documents.