Skip to content

Commit

Permalink
Add Document Knowledge Base cookbook
Browse files Browse the repository at this point in the history
  • Loading branch information
manthanguptaa committed Nov 19, 2024
1 parent aa4ecaf commit 5309b8a
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions cookbook/knowledge/doc_kb.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
"""
This cookbook demonstrates how to use DocumentKnowledgeBase to create a knowledge base from PDF files
and use it with an agent to answer questions.
Requirements:
- A PostgreSQL database with pgvector extension
- PDF files in the data/docs directory
"""

from pathlib import Path

from phi.agent import Agent
from phi.document.base import Document
from phi.knowledge.document import DocumentKnowledgeBase
from phi.vectordb.pgvector import PgVector


fun_facts = """
- Earth is the third planet from the Sun and the only known astronomical object to support life.
- Approximately 71% of Earth's surface is covered by water, with the Pacific Ocean being the largest.
- The Earth's atmosphere is composed mainly of nitrogen (78%) and oxygen (21%), with traces of other gases.
- Earth rotates on its axis once every 24 hours, leading to the cycle of day and night.
- The planet has one natural satellite, the Moon, which influences tides and stabilizes Earth's axial tilt.
- Earth's tectonic plates are constantly shifting, leading to geological activities like earthquakes and volcanic eruptions.
- The highest point on Earth is Mount Everest, standing at 8,848 meters (29,029 feet) above sea level.
- The deepest part of the ocean is the Mariana Trench, reaching depths of over 11,000 meters (36,000 feet).
- Earth has a diverse range of ecosystems, from rainforests and deserts to coral reefs and tundras.
- The planet's magnetic field protects life by deflecting harmful solar radiation and cosmic rays.
"""


# Load documents from the data/docs directory
documents = [Document(content=fun_facts)]

# Database connection URL
db_url = "postgresql+psycopg://ai:ai@localhost:5532/ai"

# Create a knowledge base with the loaded documents
knowledge_base = DocumentKnowledgeBase(
documents=documents,
vector_db=PgVector(
table_name="pdf_documents",
db_url=db_url,
),
)

# Load the knowledge base
knowledge_base.load(recreate=False)

# Create an agent with the knowledge base
agent = Agent(
knowledge_base=knowledge_base,
add_references_to_prompt=True, # Add references to the source documents in the prompt
)

# Ask the agent about the knowledge base
agent.print_response("Ask me about something from the knowledge base about earth", markdown=True)

0 comments on commit 5309b8a

Please sign in to comment.