Built-in Vectorstores

The built-in Vectorstores: example vector databases, which every account may use.

manage.py add_builtin_vectorstores, which manage.py initialize_platform calls, applies the Vectorstore manifests in smarter/apps/vectorstore/data/vectorstores for the Smarter admin. They are applied, but not deployed, so that no database is created, nor paid for, until someone deploys one. A manifest is skipped if its embeddings Provider, or its ApiConnection, does not exist, e.g. because PINECONE_API_KEY is not set.

class smarter.apps.vectorstore.builtins.BuiltinVectorstoresResult(applied=<factory>, skipped=<factory>, failed=<factory>)[source]

Bases: object

The outcome of add_builtin_vectorstores(): the names of the Vectorstores, by outcome.

__init__(applied=<factory>, skipped=<factory>, failed=<factory>)

applied: list[str]

failed: list[str]

skipped: dict[str, str]

property success: bool

smarter.apps.vectorstore.builtins.add_builtin_vectorstores(user_profile=None, path='/Users/mcdaniel/Desktop/gh/smarter-sh/smarter/smarter/smarter/apps/vectorstore/data/vectorstores')[source]

Apply the built-in Vectorstore manifests for a user.

They are not deployed.

A Vectorstore that already exists is applied again, which updates it, unless it is deployed and its index would change. One that fails is logged, and the others are still applied.

Parameters:: user_profile (Optional[UserProfile]) – The owner. Defaults to the Smarter admin.
Return type:: BuiltinVectorstoresResult

smarter.apps.vectorstore.builtins.builtin_manifest_files(path='/Users/mcdaniel/Desktop/gh/smarter-sh/smarter/smarter/smarter/apps/vectorstore/data/vectorstores')[source]

The built-in Vectorstore manifests’ files, in name order.

Return type:: list[str]

smarter.apps.vectorstore.builtins.builtin_vectorstores()[source]: The built-in Vectorstores: those that the Smarter admin owns, which every account may use.