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

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,7 +41,10 @@ class CtxAttachmentProvider(BaseStore):
         """
         return self.path
 
-    def exists(self) -> bool:
+    def exists(
+            self,
+            id: Optional[str] = None
+    ) -> bool:
         """
         Check if index exists
 
@@ -53,27 +57,37 @@ class CtxAttachmentProvider(BaseStore):
                 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
 

pygpt_net/provider/vector_stores/temp.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
@@ -64,7 +65,10 @@ class TempProvider(BaseStore):
         )
         return path
 
-    def exists(self, id: str = None) -> bool:
+    def exists(
+            self,
+            id: Optional[str] = None
+    ) -> bool:
         """
         Check if index with id exists
 
@@ -100,7 +104,11 @@ class TempProvider(BaseStore):
         else:
             self.indexes[id] = self.index_from_empty()
 
-    def get(self, id: str, service_context: ServiceContext = None) -> BaseIndex:
+    def get(
+            self,
+            id: str,
+            service_context: Optional[ServiceContext] = None
+    ) -> BaseIndex:
         """
         Get index
 
@@ -123,7 +131,11 @@ class TempProvider(BaseStore):
 
         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/web/base.py

@@ -6,9 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.18 21:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
+from typing import List, Dict
+
 from pygpt_net.plugin.base.plugin import BasePlugin
 
 
@@ -45,7 +47,12 @@ class BaseProvider:
         """Initialize provider options (for plugin settings)"""
         pass
 
-    def search(self, query, limit: int = 10, offset: int = 0):
+    def search(
+            self,
+            query,
+            limit: int = 10,
+            offset: int = 0
+    ) -> List[str]:
         """
         Execute search query and return list of urls
 
@@ -56,7 +63,7 @@ class BaseProvider:
         """
         pass
 
-    def is_configured(self, cmds: list) -> bool:
+    def is_configured(self, cmds: List[Dict]) -> bool:
         """
         Check if provider is configured
 

pygpt_net/provider/web/google_custom_search.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.25 01:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import json
+from typing import List, Dict
 from urllib.parse import quote
 from .base import BaseProvider
 
@@ -63,7 +64,12 @@ class GoogleCustomSearch(BaseProvider):
             urls=url_cx,
         )
 
-    def search(self, query: str, limit: int = 10, offset: int = 0) -> list:
+    def search(
+            self,
+            query: str,
+            limit: int = 10,
+            offset: int = 0
+    ) -> List[str]:
         """
         Execute search query and return list of urls
 
@@ -103,7 +109,7 @@ class GoogleCustomSearch(BaseProvider):
 
         return urls
 
-    def is_configured(self, cmds: list) -> bool:
+    def is_configured(self, cmds: List[Dict]) -> bool:
         """
         Check if provider is configured (required API keys, etc.)
 

pygpt_net/provider/web/microsoft_bing.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.25 01:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import json
+from typing import List, Dict
 from urllib.parse import quote
 
 import requests
@@ -60,7 +61,12 @@ class MicrosoftBingSearch(BaseProvider):
             tab="microsoft_bing",
         )
 
-    def search(self, query: str, limit: int = 10, offset: int = 0) -> list:
+    def search(
+            self,
+            query: str,
+            limit: int = 10,
+            offset: int = 0
+    ) -> List[str]:
         """
         Execute search query and return list of urls
 
@@ -97,7 +103,7 @@ class MicrosoftBingSearch(BaseProvider):
             print('Error:', response.status_code, response.text)
         return urls
 
-    def is_configured(self, cmds: list) -> bool:
+    def is_configured(self, cmds: List[Dict]) -> bool:
         """
         Check if provider is configured (required API keys, etc.)
 

pygpt_net/tools/__init__.py

@@ -6,9 +6,13 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.12.09 23:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
+from typing import Dict, Optional
+
+from PySide6.QtGui import QAction
+
 from pygpt_net.ui.widget.dialog.base import BaseDialog
 from .base import BaseTool
 
@@ -42,7 +46,7 @@ class Tools:
         if id in self.tools:
             return self.tools[id]
 
-    def get_all(self) -> dict:
+    def get_all(self) -> Dict[str, BaseTool]:
         """
         Get all tools
 
@@ -83,7 +87,7 @@ class Tools:
         for id in self.tools:
             self.tools[id].on_reload()
 
-    def setup_menu_actions(self) -> dict:
+    def setup_menu_actions(self) -> Dict[str, QAction]:
         """
         Setup Tools menu actions
 
@@ -110,7 +114,11 @@ class Tools:
         for id in self.tools:
             self.tools[id].setup_theme()
 
-    def get_instance(self, type_id: str, dialog_id: str = None) -> BaseDialog:
+    def get_instance(
+            self,
+            type_id: str,
+            dialog_id: Optional[str] = None
+    ) -> Optional[BaseDialog]:
         """
         Spawn and return dialog instance
 
@@ -123,7 +131,7 @@ class Tools:
             if instance is not None:
                 return instance
 
-    def get_lang_mappings(self) -> dict:
+    def get_lang_mappings(self) -> Dict[str, dict]:
         """
         Get language mappings
 

pygpt_net/tools/audio_transcriber/__init__.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.20 03:00:00                  #
+# Updated Date: 2024.12.14 22:00:00                  #
 # ================================================== #
 
 import os
+from typing import Dict
 
 from PySide6.QtGui import QAction, QIcon
 from PySide6.QtWidgets import QFileDialog
@@ -255,7 +256,7 @@ class AudioTranscriber(BaseTool):
         self.window.ui.nodes['audio.transcribe.status'].setText("")
         self.store("")
 
-    def setup_menu(self) -> dict:
+    def setup_menu(self) -> Dict[str, QAction]:
         """
         Setup main menu
 
@@ -278,7 +279,7 @@ class AudioTranscriber(BaseTool):
         self.dialog = AudioTranscribe(self.window)
         self.dialog.setup()
 
-    def get_lang_mappings(self) -> dict:
+    def get_lang_mappings(self) -> Dict[str, Dict]:
         """
         Get language mappings