pygpt-net 2.4.41__py3-none-any.whl → 2.4.43__py3-none-any.whl

pygpt_net/provider/llms/openai.py

@@ -6,9 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.21 20:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
+from typing import Optional, List, Dict
+
 from langchain_openai import OpenAI
 from langchain_openai import ChatOpenAI
 
@@ -33,7 +35,12 @@ class OpenAILLM(BaseLLM):
         self.id = "openai"
         self.type = [MODE_LANGCHAIN, MODE_LLAMA_INDEX, "embeddings"]
 
-    def completion(self, window, model: ModelItem, stream: bool = False):
+    def completion(
+            self,
+            window,
+            model: ModelItem,
+            stream: bool = False
+    ):
         """
         Return LLM provider instance for completion
 
@@ -45,7 +52,12 @@ class OpenAILLM(BaseLLM):
         args = self.parse_args(model.langchain)
         return OpenAI(**args)
 
-    def chat(self, window, model: ModelItem, stream: bool = False):
+    def chat(
+            self,
+            window,
+            model: ModelItem,
+            stream: bool = False
+    ):
         """
         Return LLM provider instance for chat
 
@@ -57,7 +69,12 @@ class OpenAILLM(BaseLLM):
         args = self.parse_args(model.langchain)
         return ChatOpenAI(**args)
 
-    def llama(self, window, model: ModelItem, stream: bool = False) -> LlamaBaseLLM:
+    def llama(
+            self,
+            window,
+            model: ModelItem,
+            stream: bool = False
+    ) -> LlamaBaseLLM:
         """
         Return LLM provider instance for llama
 
@@ -69,7 +86,12 @@ class OpenAILLM(BaseLLM):
         args = self.parse_args(model.llama_index)
         return LlamaOpenAI(**args)
 
-    def llama_multimodal(self, window, model: ModelItem, stream: bool = False) -> LlamaMultiModalLLM:
+    def llama_multimodal(
+            self,
+            window,
+            model: ModelItem,
+            stream: bool = False
+    ) -> LlamaMultiModalLLM:
         """
         Return multimodal LLM provider instance for llama
 
@@ -81,7 +103,11 @@ class OpenAILLM(BaseLLM):
         args = self.parse_args(model.llama_index)
         return LlamaOpenAIMultiModal(**args)
 
-    def get_embeddings_model(self, window, config: list = None) -> BaseEmbedding:
+    def get_embeddings_model(
+            self,
+            window,
+            config: Optional[List[Dict]] = None
+    ) -> BaseEmbedding:
         """
         Return provider instance for embeddings
 

pygpt_net/provider/vector_stores/__init__.py

@@ -6,11 +6,13 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.23 00:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import hashlib
+from typing import Optional, Tuple, List
 
+from llama_index.core.indices.service_context import ServiceContext
 from llama_index.core.indices.base import BaseIndex
 from llama_index.core.indices.vector_store.base import VectorStoreIndex
 
@@ -31,7 +33,7 @@ class Storage:
         self.indexes = {}
         self.tmp_storage = TempProvider(window=window)
 
-    def get_storage(self) -> BaseStore or None:
+    def get_storage(self) -> Optional[BaseStore]:
         """
         Get current vector store provider
 
@@ -44,7 +46,7 @@ class Storage:
             return None
         return self.storages[current]
 
-    def get_tmp_storage(self) -> BaseStore or None:
+    def get_tmp_storage(self) -> Optional[TempProvider]:
         """
         Get temp vector store provider
 
@@ -52,16 +54,19 @@ class Storage:
         """
         return self.tmp_storage
 
-    def get_ctx_idx_storage(self, path: str) -> BaseStore or None:
+    def get_ctx_idx_storage(self, path: str) -> CtxAttachmentProvider:
         """
         Get temp vector store provider
         
         :param path: Path to index on disk
         :return: vector store provider instance
         """
-        return CtxAttachmentProvider(window=self.window, path=path)
+        return CtxAttachmentProvider(
+            window=self.window,
+            path=path
+        )
 
-    def register(self, name: str, storage=None):
+    def register(self, name: str, storage: BaseStore):
         """
         Register vector store provider
 
@@ -71,7 +76,7 @@ class Storage:
         storage.attach(window=self.window)
         self.storages[name] = storage
 
-    def get_ids(self) -> list:
+    def get_ids(self) -> List[str]:
         """
         Return all vector store providers IDs
 
@@ -79,7 +84,7 @@ class Storage:
         """
         return list(self.storages.keys())
 
-    def exists(self, id: str = None) -> bool:
+    def exists(self, id: Optional[str] = None) -> bool:
         """
         Check if index exists
 
@@ -102,7 +107,11 @@ class Storage:
             raise Exception('Storage engine not found!')
         storage.create(id)
 
-    def get(self, id: str, service_context=None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext]
+    ) -> BaseIndex:
         """
         Get index instance
 
@@ -118,7 +127,11 @@ class Storage:
             service_context=service_context,
         )
 
-    def store(self, id: str, index: BaseIndex = None):
+    def store(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store index
 
@@ -173,7 +186,11 @@ class Storage:
             doc_id=doc_id,
         )
 
-    def get_tmp(self, identifier: str, service_context=None) -> (str, BaseIndex):
+    def get_tmp(
+            self,
+            identifier: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> Tuple[str, BaseIndex]:
         """
         Get tmp index instance
 
@@ -191,7 +208,11 @@ class Storage:
             service_context=service_context,
         )
 
-    def store_tmp(self, id: str, index: BaseIndex = None):
+    def store_tmp(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store index
 
@@ -228,7 +249,11 @@ class Storage:
             raise Exception('Storage engine not found!')
         storage.clean(id)
 
-    def get_ctx_idx(self, path: str, service_context=None) -> (str, BaseIndex):
+    def get_ctx_idx(
+            self,
+            path: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get context index instance
 
@@ -241,10 +266,15 @@ class Storage:
         if storage is None:
             raise Exception('Storage engine not found!')
         return storage.get(
+            id="",
             service_context=service_context,
         )
 
-    def store_ctx_idx(self, path: str, index: BaseIndex = None):
+    def store_ctx_idx(
+            self,
+            path: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store context index
 
@@ -255,6 +285,7 @@ class Storage:
         if storage is None:
             raise Exception('Storage engine not found!')
         storage.store(
+            id="",
             index=index,
         )
 

pygpt_net/provider/vector_stores/base.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.08.20 19:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import os
 import shutil
+from typing import Optional
 
 from llama_index.core.indices.base import BaseIndex
 from llama_index.core.indices.service_context import ServiceContext
@@ -31,7 +32,12 @@ class BaseStore:
         self.prefix = ""  # prefix for index directory
         self.indexes = {}
 
-    def index_from_store(self, vector_store, storage_context: StorageContext, service_context: ServiceContext = None):
+    def index_from_store(
+            self,
+            vector_store,
+            storage_context: StorageContext,
+            service_context: Optional[ServiceContext] = None
+    ):
         """
         Get index instance
 
@@ -74,7 +80,10 @@ class BaseStore:
             self.prefix + id,
         )
 
-    def exists(self, id: str = None) -> bool:
+    def exists(
+            self,
+            id: Optional[str] = None
+    ) -> bool:
         """
         Check if index with id exists
 
@@ -94,7 +103,11 @@ class BaseStore:
         """
         pass
 
-    def get(self, id: str, service_context: ServiceContext = None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get index instance
 
@@ -104,7 +117,11 @@ class BaseStore:
         """
         pass
 
-    def store(self, id: str, index: BaseIndex = None):
+    def store(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store/persist index
 
@@ -113,7 +130,10 @@ class BaseStore:
         """
         pass
 
-    def remove(self, id: str) -> bool:
+    def remove(
+            self,
+            id: str
+    ) -> bool:
         """
         Clear index
 
@@ -127,7 +147,10 @@ class BaseStore:
             shutil.rmtree(path)
         return True
 
-    def truncate(self, id: str) -> bool:
+    def truncate(
+            self,
+            id: str
+    ) -> bool:
         """
         Truncate index
 
@@ -136,7 +159,11 @@ class BaseStore:
         """
         return self.remove(id)
 
-    def remove_document(self, id: str, doc_id: str) -> bool:
+    def remove_document(
+            self,
+            id: str,
+            doc_id: str
+    ) -> bool:
         """
         Remove document from index
 

pygpt_net/provider/vector_stores/chroma.py

@@ -6,10 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.14 05:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import os.path
+from typing import Optional
+
 import chromadb
 from chromadb.config import Settings
 
@@ -64,7 +66,11 @@ class ChromaProvider(BaseStore):
                 index=index,
             )
 
-    def get(self, id: str, service_context: ServiceContext = None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get index
 
@@ -86,7 +92,11 @@ class ChromaProvider(BaseStore):
         self.indexes[id] = self.index_from_store(vector_store, storage_context, service_context)
         return self.indexes[id]
 
-    def store(self, id: str, index: BaseIndex = None):
+    def store(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store index
 

pygpt_net/provider/vector_stores/ctx_attachment.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.23 00:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import os.path
+from typing import Optional
 
 from llama_index.core import StorageContext, load_index_from_storage
 from llama_index.core.indices.base import BaseIndex
@@ -32,7 +33,7 @@ class CtxAttachmentProvider(BaseStore):
         self.id = "CtxAttachmentVectorStore"
         self.index = None
 
-    def get_path(self) -> str:
+    def get_path(self, id: str) -> str:
         """
         Get database path
 
@@ -40,40 +41,53 @@ class CtxAttachmentProvider(BaseStore):
         """
         return self.path
 
-    def exists(self) -> bool:
+    def exists(
+            self,
+            id: Optional[str] = None
+    ) -> bool:
         """
         Check if index exists
 
         :return: True if exists
         """
-        path = self.get_path()
+        path = self.get_path("")
         if os.path.exists(path):
             store = os.path.join(path, "docstore.json")
             if os.path.exists(store):
                 return True
         return False
 
-    def create(self):
-        """Create empty index"""
-        path = self.get_path()
+    def create(self, id: str):
+        """
+        Create empty index
+
+        :param id: index name (not used)
+        """
+        path = self.get_path(id)
         if not os.path.exists(path):
             index = self.index_from_empty()  # create empty index
             self.store(
+                id=id,
                 index=index,
             )
         else:
             self.index = self.index_from_empty()
 
-    def get(self, service_context: ServiceContext = None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get index
 
+        :param id: index name (not used)
         :param service_context: Service context
         :return: index instance
         """
         if not self.exists():
-            self.create()
-        path = self.get_path()
+            self.create(id)
+        path = self.get_path(id)
         storage_context = StorageContext.from_defaults(
             persist_dir=path,
         )
@@ -84,13 +98,18 @@ class CtxAttachmentProvider(BaseStore):
 
         return self.index
 
-    def store(self, index: BaseIndex = None):
+    def store(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store index
 
+        :param id: index name (not used)
         :param index: index instance
         """
-        path = self.get_path()
+        path = self.get_path(id)
         index.storage_context.persist(
             persist_dir=path,
         )
@@ -99,6 +118,6 @@ class CtxAttachmentProvider(BaseStore):
     def clean(self):
         """Clean index"""
         self.index = None
-        path = self.get_path()
+        path = self.get_path("")
         if os.path.exists(path):
             os.remove(path)

pygpt_net/provider/vector_stores/elasticsearch.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.14 05:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import datetime
 import os.path
+from typing import Optional
 
 from llama_index.core.indices.base import BaseIndex
 from llama_index.core.indices.service_context import ServiceContext
@@ -67,7 +68,11 @@ class ElasticsearchProvider(BaseStore):
             **additional_args
         )
 
-    def get(self, id: str, service_context: ServiceContext = None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get index
 
@@ -84,7 +89,11 @@ class ElasticsearchProvider(BaseStore):
         self.indexes[id] = self.index_from_store(vector_store, storage_context, service_context)
         return self.indexes[id]
 
-    def store(self, id: str, index: BaseIndex = None):
+    def store(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store index
 

pygpt_net/provider/vector_stores/pinecode.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.14 05:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import datetime
 import os.path
+from typing import Optional
 
 from pinecone import Pinecone, ServerlessSpec
 
@@ -122,7 +123,11 @@ class PinecodeProvider(BaseStore):
             pinecone_index=pinecone_index,
         )
 
-    def get(self, id: str, service_context: ServiceContext = None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get index
 
@@ -139,7 +144,11 @@ class PinecodeProvider(BaseStore):
         self.indexes[id] = self.index_from_store(vector_store, storage_context, service_context)
         return self.indexes[id]
 
-    def store(self, id: str, index: BaseIndex = None):
+    def store(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store index
 

pygpt_net/provider/vector_stores/redis.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.14 05:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import datetime
 import os.path
+from typing import Optional
 
 from llama_index.core import StorageContext
 from llama_index.core.indices.base import BaseIndex
@@ -67,7 +68,11 @@ class RedisProvider(BaseStore):
             **additional_args
         )
 
-    def get(self, id: str, service_context: ServiceContext = None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get index
 
@@ -84,7 +89,11 @@ class RedisProvider(BaseStore):
         self.indexes[id] = self.index_from_store(vector_store, storage_context, service_context)
         return self.indexes[id]
 
-    def store(self, id: str, index: BaseIndex = None):
+    def store(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store index
 

pygpt_net/provider/vector_stores/simple.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.14 05:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import os.path
+from typing import Optional
 
 from llama_index.core import StorageContext, load_index_from_storage
 from llama_index.core.indices.base import BaseIndex
@@ -46,7 +47,11 @@ class SimpleProvider(BaseStore):
                 index=index,
             )
 
-    def get(self, id: str, service_context: ServiceContext = None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get index
 
@@ -66,7 +71,11 @@ class SimpleProvider(BaseStore):
         )
         return self.indexes[id]
 
-    def store(self, id: str, index: BaseIndex = None):
+    def store(
+            self,
+            id: str,
+            index: Optional[BaseIndex] = None
+    ):
         """
         Store index