Updated knowledge and llm.py docs

src/agent/knowledge/chunker.py

@@ -1,3 +1,6 @@
+"""
+Retrieval Augmented Generation chunking used to put documents into Qdrant.
+"""
 import spacy
 
 from src.agent.knowledge.collections import Document
@@ -7,7 +10,9 @@
 
 
 def chunk_str(document: str):
-    """Chunks a text string"""
+    """Chunks a text string.
+    The chunking strategy is NLP sentence extraction -> sentence grouping by similarity.
+    """
     doc = nlp(document)
     sentences = [sent for sent in list(doc.sents) if str(sent).strip() not in ['*']]
 

src/agent/knowledge/collections.py

@@ -1,3 +1,4 @@
+"""RAG related data"""
 from dataclasses import dataclass
 from enum import StrEnum
 from typing import List, Optional

src/agent/knowledge/store.py

@@ -1,3 +1,4 @@
+"""RAG Vector Database interface"""
 from typing import Dict
 
 import ollama
@@ -8,7 +9,8 @@
 
 
 class Store:
-    """Act as interface for Qdrant database"""
+    """Act as interface for Qdrant database.
+    Manages Collections and implements the Upload/Retrieve operations."""
 
     def __init__(self):
         self._connection = QdrantClient(":memory:")

src/agent/llm.py

@@ -1,17 +1,27 @@
+"""
+Interfaces the AI Agent to the LLM Provider, model availability depends on
+implemented prompts, to use a new model the relative prompts should be written.
+
+LLM providers are:
+- [x] Ollama
+- [ ] HuggingFace
+"""
 from ollama import Client
 from dataclasses import dataclass
 
-AVAILABLE_MODELS = ['phi3', 'gemma:2b']
+AVAILABLE_MODELS = ['phi3', 'gemma:2b', 'gemma:7b']
 
 
 @dataclass
 class LLM:
+    """Ollama model interface"""
     model: str
-    client: Client = Client(host='http://localhost:11434')
+    client_url: str = 'http://localhost:11434'
 
     def __post_init__(self):
         if self.model not in AVAILABLE_MODELS:
             raise ValueError(f'Model {self.model} is not available')
+        self.client = Client(self.client_url)
 
     def query(self, messages: list, stream=True):
         """Generator that returns response chunks from Phi3-mini-k4 model"""