Knowledge
Text Knowledge Base
Knowledge
Text Knowledge Base
The TextKnowledgeBase reads local txt files, converts them into vector embeddings and loads them to a vector databse.
Usage
We are using a local PgVector database for this example. Make sure it’s running
knowledge_base.py
from phi.knowledge.text import TextKnowledgeBase
from phi.vectordb.pgvector import PgVector2
knowledge_base = TextKnowledgeBase(
path="data/docs",
# Table name: ai.text_documents
vector_db=PgVector2(
collection="text_documents",
db_url="postgresql+psycopg://ai:ai@localhost:5532/ai",
),
)
Then use the knowledge_base with an Assistant:
assistant.py
from phi.assistant import Assistant
from knowledge_base import knowledge_base
assistant = Assistant(
knowledge_base=knowledge_base,
add_references_to_prompt=True,
)
assistant.knowledge_base.load(recreate=False)
assistant.print_response("Ask me about something from the knowledge base")
Params
path
Union[str, Path]
Path to text files.
Can point to a single docx file or a directory of docx files.
formats
List[str]
Formats accepted by this knowledge base.
Default: [".txt"]
vector_db
VectorDb
Vector Database for the Knowledge Base.
reader
TextReader
A TextReader that converts the text files into Documents for the vector database.
num_documents
int
Number of documents to return on search. (default: 5)
optimize_on
int
Number of documents to optimize the vector db on.