insightvault.app package¶

Submodules¶

insightvault.app.base module¶

class insightvault.app.base.BaseApp(name: str = 'insightvault.app.base', config_path: str = './config.yaml')¶

Bases: object

add_documents(documents: list[Document]) → None¶: Add documents to the database

async async_add_documents(documents: list[Document]) → None¶: Async version of add_document

async async_delete_all_documents() → None¶: Async version of delete_all_documents

async async_list_documents() → list[Document] | None¶: Async version of list_documents

delete_all_documents() → None¶: Delete all documents from the database

async init() → None¶: Initialize the app

list_documents() → list[Document] | None¶: List all documents in the database

insightvault.app.cli module¶

insightvault.app.cli.main() → None¶: Entry point for the CLI

insightvault.app.rag module¶

class insightvault.app.rag.RAGApp(name: str = 'insightvault.app.rag')¶

Bases: SearchApp

RAG application for retrieval-augmented generation

This application extends the SearchApp with RAG-specific query functionality. All other methods (add_documents, delete_documents, etc.) are inherited from SearchApp.

async async_clear() → None¶: Async version of clear

async async_query(query: str) → list[str]¶: Async version of query

clear() → None¶: Clears the chat history

async init() → None¶: Initialize the RAG app

query(query: str) → list[str]¶

Query the database for documents similar to the query

This RAG-specific implementation returns Document objects instead of strings.

insightvault.app.search module¶

class insightvault.app.search.SearchApp(name: str = 'insightvault.app.search')¶

Bases: BaseApp

Search application for semantic search

This application is used to query the database and add documents to the database.

Attributes:: db (Database): The database service.

async async_query(query: str) → list[str]¶: Async version of query

async init() → None¶: Initialize the search app

query(query: str) → list[str]¶

Query the database for documents similar to the query.

Returns an alphabetically sorted list of document titles.

insightvault.app.summarizer module¶

class insightvault.app.summarizer.SummarizerApp(name: str = 'insightvault.app.summarizer')¶