igbot-base 0.0.1__tar.gz

igbot_base-0.0.1/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: igbot_base
+Version: 0.0.1
+Summary: Base classes for igbot
+Author-email: Igor Kopeć <igor.kopec95@gmail.com>
+License-Expression: LGPL-3.0-or-later
+Requires-Python: >=3.12

igbot_base-0.0.1/igbot_base/agent.py

@@ -0,0 +1,10 @@
+from abc import ABC, abstractmethod
+
+from igbot_base.igbot_base.agent_response import AgentResponse
+
+
+class Agent(ABC):
+
+    @abstractmethod
+    def invoke(self, query) -> AgentResponse:
+        pass

igbot_base-0.0.1/igbot_base/agent_response.py

@@ -0,0 +1,43 @@
+from enum import Enum
+from typing import Optional
+
+
+class Type(Enum):
+    SUCCESS = 1,
+    NO_CONTENT = 2,
+    ERROR = 3
+
+
+class AgentResponse:
+
+    def __init__(self, response: any, response_type: Type, exception: Optional[Exception]):
+        self.__response = response
+        self.__type = response_type
+        self.__exception = exception
+
+    def is_successful(self):
+        return self.__type == Type.SUCCESS
+
+    def is_error(self):
+        return self.__type == Type.ERROR
+
+    def is_no_content(self):
+        return self.__type == Type.NO_CONTENT
+
+    def get_response(self):
+        return self.__response
+
+    @staticmethod
+    def error(error_message: str, exception: Optional[Exception]):
+        return AgentResponse(error_message, Type.ERROR, exception)
+
+    @staticmethod
+    def success(response: str):
+        return AgentResponse(response, Type.SUCCESS, None)
+
+    @staticmethod
+    def no_content():
+        return AgentResponse("", Type.NO_CONTENT, None)
+
+    def get_exception(self):
+        return self.__exception

igbot_base-0.0.1/igbot_base/exception_handler.py

@@ -0,0 +1,20 @@
+from abc import ABC, abstractmethod
+
+
+class ExceptionHandler(ABC):
+
+    @abstractmethod
+    def handle(self, e: Exception):
+        pass
+
+
+class NoopExceptionHandler(ExceptionHandler):
+
+    def handle(self, e: Exception):
+        pass
+
+
+class PrintingExceptionHandler(ExceptionHandler):
+
+    def handle(self, e: Exception):
+        print(e)

igbot_base-0.0.1/igbot_base/llm.py

@@ -0,0 +1,47 @@
+from abc import ABC, abstractmethod
+from builtins import dict
+from typing import Optional
+
+from igbot_base.igbot_base.exception_handler import ExceptionHandler, NoopExceptionHandler
+from igbot_base.igbot_base.llmmemory import LlmMemory
+from igbot_base.igbot_base.models import Model
+
+
+class Llm(ABC):
+
+    def __init__(
+            self,
+            name: str,
+            model: Model,
+            temperature: float,
+            response_format: Optional[dict],
+            llm_exception_handler: ExceptionHandler = NoopExceptionHandler()):
+        self._name = name
+        self._model = model
+        self._temperature = temperature
+        self._format = response_format
+        self._exception_handler = llm_exception_handler
+
+    @abstractmethod
+    def _call(self, user_query: str, history: LlmMemory, params: dict) -> str:
+        pass
+
+    def _revert_memory(self, history: LlmMemory):
+        history.revert_to_snapshot()
+
+    def call(self, user_query: str, history: LlmMemory, params: dict) -> str:
+        history.set_snapshot()
+        try:
+            return self._call(user_query, history, params)
+        except Exception as e:
+            self._revert_memory(history)
+            self._exception_handler.handle(e)
+
+    def get_additional_llm_args(self):
+        args = {}
+        if self._temperature is not None:
+            args["temperature"] = self._temperature
+        if self._format is not None:
+            args["response_format"] = self._format
+
+        return args

igbot_base-0.0.1/igbot_base/llmmemory.py

@@ -0,0 +1,52 @@
+from abc import ABC, abstractmethod
+
+
+class LlmMemory(ABC):
+    # todo: capacity of memory
+    @abstractmethod
+    def retrieve(self):
+        pass
+
+    @abstractmethod
+    def append_user(self, content: str):
+        pass
+
+    @abstractmethod
+    def append_assistant(self, content: str):
+        pass
+
+    @abstractmethod
+    def append_system(self, content: str):
+        pass
+
+    @abstractmethod
+    def append_tool_request(self, message):
+        pass
+
+    @abstractmethod
+    def append_tool(self, tool_call_id: str, content: str):
+        pass
+
+    @abstractmethod
+    def clean_conversation(self):
+        pass
+
+    @abstractmethod
+    def delete_last_user_message(self):
+        pass
+
+    @abstractmethod
+    def delete_last_tool_message(self):
+        pass
+
+    @abstractmethod
+    def delete_last_assistant_message(self):
+        pass
+
+    @abstractmethod
+    def revert_to_snapshot(self):
+        pass
+
+    @abstractmethod
+    def set_snapshot(self):
+        pass

igbot_base-0.0.1/igbot_base/models.py

@@ -0,0 +1,22 @@
+from enum import Enum
+from openai import OpenAI
+
+
+class ModelInfo:
+
+    def __init__(self, name, client):
+        self.__name = name
+        self.__client = client
+
+    def get_name(self):
+        return self.__name
+
+    def get_client(self):
+        return self.__client()
+
+
+class Model(Enum):
+    OLLAMA_3_2_LOCAL = ModelInfo("llama3.2", lambda: OpenAI(base_url="http://localhost:11434/v1", api_key='ollama'))
+    OPENAI_GPT_4o_MINI = ModelInfo("gpt-4o-mini", lambda: OpenAI())
+    OPENAI_GPT_4o = ModelInfo("gpt-4o", lambda: OpenAI())
+    OPENAI_GPT_4o_MINI_JSON = ModelInfo("gpt-4o-mini-2024-07-18", lambda: OpenAI())

igbot_base-0.0.1/igbot_base/persistable_memory.py

@@ -0,0 +1,9 @@
+from abc import abstractmethod
+from igbot_base.igbot_base.llmmemory import LlmMemory
+
+
+class PersistableMemory(LlmMemory):
+
+    @abstractmethod
+    def save(self):
+        pass

igbot_base-0.0.1/igbot_base/prompt_template.py

@@ -0,0 +1,38 @@
+import re
+from typing import Optional
+
+from igbot_base.igbot_base.exception_handler import ExceptionHandler, PrintingExceptionHandler
+
+
+class Prompt:
+
+    def __init__(
+            self,
+            content: str,
+            variables,
+            exception_handler: ExceptionHandler = PrintingExceptionHandler()):
+        self.__content = content
+        self.__variables = variables
+        self.__exception_handler = exception_handler
+
+    @staticmethod
+    def replace_placeholders(text: str, values: dict) -> str:
+        def replacer(match):
+            key = match.group(1)
+            return str(values.get(key, match.group(0)))
+
+        return re.sub(r"\{\{(\w+)\}\}", replacer, text)
+
+    def parse(self, params: Optional[dict]) -> str:
+        if len(self.__variables) == 0:
+            return self.__content
+
+        try:
+            return self.replace_placeholders(self.__content, params)
+        except KeyError as e:
+            self.__exception_handler.handle(e)
+
+        raise Exception(f"Error while substituting values for prompt")
+
+    def get_content(self) -> str:
+        return self.__content

igbot_base-0.0.1/igbot_base/response_formats.py

@@ -0,0 +1,5 @@
+from enum import Enum
+
+
+class ResponseFormat(Enum):
+    JSON_OBJECT = {"type": "json_object"}

igbot_base-0.0.1/igbot_base/retriever.py

@@ -0,0 +1,11 @@
+from abc import ABC, abstractmethod
+
+
+class Retriever(ABC):
+
+    def __init__(self):
+        pass
+
+    @abstractmethod
+    def get_relevant_data(self, query: str):
+        pass

igbot_base-0.0.1/igbot_base/tool.py

@@ -0,0 +1,20 @@
+from abc import ABC, abstractmethod
+
+
+class Tool(ABC):
+
+    def __init__(
+            self,
+            name: str):
+        self._name = name
+
+    def get_name(self):
+        return self._name
+
+    @abstractmethod
+    def get_function(self):
+        pass
+
+    @abstractmethod
+    def get_definition(self):
+        pass

igbot_base-0.0.1/igbot_base/vectorstore.py

@@ -0,0 +1,45 @@
+from abc import ABC, abstractmethod
+
+from igbot_base.igbot_base.retriever import Retriever
+
+
+class Metadata:
+
+    def __init__(self):
+        self.metadata = {}
+
+    def append(self, key, value):
+        if key not in self.metadata:
+            self.metadata[key] = set()
+
+        self.metadata[key].add(value)
+
+    def get(self):
+        return self.metadata.copy()
+
+
+class Vectorstore(ABC):
+
+    @abstractmethod
+    def remove_db(self):
+        pass
+
+    @abstractmethod
+    def get_dimensions_number(self):
+        pass
+
+    @abstractmethod
+    def get_retriever(self, load_number_of_chunks) -> Retriever:
+        pass
+
+    @abstractmethod
+    def get_legacy_retriever(self, load_number_of_chunks):
+        pass
+
+    @abstractmethod
+    def append(self, chunks):
+        pass
+
+    @abstractmethod
+    def get_metadata(self) -> Metadata:
+        pass

igbot_base-0.0.1/igbot_base.egg-info/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: igbot_base
+Version: 0.0.1
+Summary: Base classes for igbot
+Author-email: Igor Kopeć <igor.kopec95@gmail.com>
+License-Expression: LGPL-3.0-or-later
+Requires-Python: >=3.12

igbot_base-0.0.1/igbot_base.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+pyproject.toml
+igbot_base/__init__.py
+igbot_base/agent.py
+igbot_base/agent_response.py
+igbot_base/exception_handler.py
+igbot_base/llm.py
+igbot_base/llmmemory.py
+igbot_base/models.py
+igbot_base/persistable_memory.py
+igbot_base/prompt_template.py
+igbot_base/response_formats.py
+igbot_base/retriever.py
+igbot_base/tool.py
+igbot_base/vectorstore.py
+igbot_base.egg-info/PKG-INFO
+igbot_base.egg-info/SOURCES.txt
+igbot_base.egg-info/dependency_links.txt
+igbot_base.egg-info/top_level.txt

igbot_base-0.0.1/igbot_base.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

igbot_base-0.0.1/igbot_base.egg-info/top_level.txt

@@ -0,0 +1 @@
+igbot_base

igbot_base-0.0.1/pyproject.toml

@@ -0,0 +1,11 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "igbot_base"
+version = "0.0.1"
+description = "Base classes for igbot"
+authors = [{name = "Igor Kopeć", email = "igor.kopec95@gmail.com"}]
+license = "LGPL-3.0-or-later"
+requires-python = ">=3.12"

igbot_base-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+