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

pygpt_net/core/idx/indexing.py

@@ -6,7 +6,7 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.26 04:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import datetime
@@ -14,6 +14,8 @@ import os.path
 import time
 
 from pathlib import Path
+from typing import Optional, Tuple, List, Dict, Any
+
 from sqlalchemy import text
 
 from llama_index.core.indices.base import BaseIndex
@@ -99,7 +101,11 @@ class Indexing:
                 self.window.core.debug.log(msg)
                 self.window.core.debug.log(e)
 
-    def update_loader_args(self, loader: str, args: dict):
+    def update_loader_args(
+            self,
+            loader: str,
+            args: Dict[str, Any]
+    ):
         """
         Update loader arguments
 
@@ -142,7 +148,7 @@ class Indexing:
             self.register_loader(loader)
         self.window.core.idx.log("Data loaders reloaded.")
 
-    def get_external_instructions(self) -> dict:
+    def get_external_instructions(self) -> Dict[str, Any]:
         """
         Get external instructions
 
@@ -150,7 +156,7 @@ class Indexing:
         """
         return self.external_instructions
 
-    def get_external_config(self) -> dict:
+    def get_external_config(self) -> Dict[str, Any]:
         """
         Get external config
 
@@ -177,7 +183,7 @@ class Indexing:
             if ext in extensions:
                 return loader["loader"]
 
-    def get_data_providers(self) -> dict:
+    def get_data_providers(self) -> Dict[str, BaseLoader]:
         """
         Get data providers
 
@@ -185,7 +191,11 @@ class Indexing:
         """
         return self.data_providers
 
-    def get_loader_arguments(self, id: str, type: str = "file") -> dict:
+    def get_loader_arguments(
+            self,
+            id: str,
+            type: str = "file"
+    ) -> Dict[str, Any]:
         """
         Get keyword arguments for loader
 
@@ -267,8 +277,8 @@ class Indexing:
             path: str,
             force: bool = False,
             silent: bool = False,
-            loader_kwargs: dict = None,
-    ) -> list[Document]:
+            loader_kwargs: Optional[Dict[str, Any]] = None,
+    ) -> List[Document]:
         """
         Get documents from path using data loaders
 
@@ -330,7 +340,11 @@ class Indexing:
         self.window.core.idx.metadata.append_file_metadata(documents, path)
         return documents
 
-    def read_text_content(self, path: str, loader_kwargs: dict = None) -> str:
+    def read_text_content(
+            self,
+            path: str,
+            loader_kwargs: Optional[Dict[str, Any]] = None
+    ) -> str:
         """
         Get content from file using loaders
 
@@ -353,7 +367,7 @@ class Indexing:
             self,
             url: str,
             type: str = "webpage",
-            extra_args: dict = None
+            extra_args: Optional[Dict[str, Any]] = None
     ) -> str:
         """
         Get content from external resource
@@ -373,8 +387,8 @@ class Indexing:
             self,
             url: str,
             type: str = "webpage",
-            extra_args: dict = None,
-    ) -> list[Document]:
+            extra_args: Optional[Dict[str, Any]] = None,
+    ) -> List[Document]:
         """
         Read data from external resource
 
@@ -423,11 +437,11 @@ class Indexing:
             self,
             idx: str,
             index: BaseIndex,
-            path: str = None,
+            path: Optional[str] = None,
             is_tmp: bool = False,
-            replace: bool = None,
-            recursive: bool = None
-    ) -> tuple:
+            replace: Optional[bool] = None,
+            recursive: Optional[bool] = None
+    ) -> Tuple[dict, list]:
         """
         Index all files in directory
 
@@ -494,10 +508,10 @@ class Indexing:
             self,
             idx: str,
             index: BaseIndex,
-            path: str = None,
+            path: Optional[str] = None,
             is_tmp: bool = False,
-            replace: bool = None
-    ) -> tuple:
+            replace: Optional[bool] = None
+    ) -> Tuple[dict, list]:
         """
         Index all files in directory and subdirectories recursively.
 
@@ -688,7 +702,13 @@ class Indexing:
                 documents.append(doc)
         return documents
 
-    def index_db_by_meta_id(self, idx: str, index: BaseIndex, id: int = 0, from_ts: int = 0) -> (int, list):
+    def index_db_by_meta_id(
+            self,
+            idx: str,
+            index: BaseIndex,
+            id: int = 0,
+            from_ts: int = 0
+    ) -> Tuple[int, List[str]]:
         """
         Index data from database by meta id
 
@@ -724,7 +744,12 @@ class Indexing:
             self.window.core.debug.log(e)
         return n, errors
 
-    def index_db_from_updated_ts(self, idx: str, index: BaseIndex, from_ts: int = 0) -> (int, list):
+    def index_db_from_updated_ts(
+            self,
+            idx: str,
+            index: BaseIndex,
+            from_ts: int = 0
+    ) -> Tuple[int, List[str]]:
         """
         Index data from database from timestamp
 
@@ -752,10 +777,10 @@ class Indexing:
             index: BaseIndex,
             url: str,
             type="webpage",
-            extra_args: dict = None,
+            extra_args: Optional[Dict[str, Any]] = None,
             is_tmp: bool = False,
-            replace: bool = None
-    ) -> (int, list):
+            replace: Optional[bool] = None
+    ) -> Tuple[int, List[str]]:
         """
         Index data from external (remote) resource
 
@@ -838,9 +863,9 @@ class Indexing:
             index: BaseIndex,
             urls: list,
             type="webpage",
-            extra_args: dict = None,
+            extra_args: Optional[Dict[str, Any]] = None,
             is_tmp: bool = False
-    ) -> (int, list):
+    ) -> Tuple[int, List[str]]:
         """
         Index data from URLs
 
@@ -878,7 +903,12 @@ class Indexing:
             errors.extend(errs)
         return n, errors
 
-    def remove_old_meta_id(self, idx: str, id: int = 0, force: bool = False) -> bool:
+    def remove_old_meta_id(
+            self,
+            idx: str,
+            id: int = 0,
+            force: bool = False
+    ) -> bool:
         """
         Remove old meta id from index
 
@@ -906,7 +936,12 @@ class Indexing:
                 return True
         return False
 
-    def remove_old_file(self, idx: str, file_id: str, force: bool = False):
+    def remove_old_file(
+            self,
+            idx: str,
+            file_id: str,
+            force: bool = False
+    ) -> bool:
         """
         Remove old file from index
 
@@ -934,7 +969,13 @@ class Indexing:
                 return True
         return False
 
-    def remove_old_external(self, idx: str, content: str, type: str, force: bool = False):
+    def remove_old_external(
+            self,
+            idx: str,
+            content: str,
+            type: str,
+            force: bool = False
+    ) -> bool:
         """
         Remove old file from index
 
@@ -963,7 +1004,11 @@ class Indexing:
                 return True
         return False
 
-    def index_document(self, index: BaseIndex, doc: Document):
+    def index_document(
+            self,
+            index: BaseIndex,
+            doc: Document
+    ):
         """
         Index document
 
@@ -983,8 +1028,8 @@ class Indexing:
             self,
             file_path: str,
             index_path: str,
-            model: ModelItem = None,
-            documents: list = None,
+            model: Optional[ModelItem] = None,
+            documents: Optional[List[Document]] = None,
     ) -> list:
         """
         Index context attachment
@@ -1021,8 +1066,8 @@ class Indexing:
             self,
             url: str,
             index_path: str,
-            model: ModelItem = None,
-            documents: list = None,
+            model: Optional[ModelItem] = None,
+            documents: Optional[List[Document]] = None,
     ) -> list:
         """
         Index context attachment
@@ -1077,7 +1122,11 @@ class Indexing:
         print("Selected web data loader: {}".format(type))
         return type
 
-    def remove_attachment(self, index_path: str, doc_id: str) -> bool:
+    def remove_attachment(
+            self,
+            index_path: str,
+            doc_id: str
+    ) -> bool:
         """
         Remove document from index
 

pygpt_net/core/idx/llm.py

@@ -6,10 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.15 00:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import os.path
+from typing import Optional, Union
 
 from llama_index.core.llms.llm import BaseLLM
 from llama_index.core.multi_modal_llms import MultiModalLLM
@@ -41,7 +42,11 @@ class Llm:
         os.environ['OPENAI_API_BASE'] = str(self.window.core.config.get('api_endpoint'))
         os.environ['OPENAI_ORGANIZATION'] = str(self.window.core.config.get('organization_key'))
 
-    def get(self, model: ModelItem = None, multimodal: bool = False) -> BaseLLM or MultiModalLLM:
+    def get(
+            self,
+            model: Optional[ModelItem] = None,
+            multimodal: bool = False
+    ) -> Union[BaseLLM, MultiModalLLM]:
         """
         Get LLM provider
 
@@ -117,7 +122,10 @@ class Llm:
             config=args,
         )
 
-    def get_service_context(self, model: ModelItem = None) -> ServiceContext:
+    def get_service_context(
+            self,
+            model: Optional[ModelItem] = None
+    ) -> ServiceContext:
         """
         Get service context + embeddings provider
 

pygpt_net/core/idx/metadata.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.03.13 01:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import datetime
 import os.path
+from typing import List, Dict, Any
 
 from llama_index.core.schema import Document
 
@@ -24,7 +25,11 @@ class Metadata:
         """
         self.window = window
 
-    def append_file_metadata(self, docs: list[Document], path: str):
+    def append_file_metadata(
+            self,
+            docs: List[Document],
+            path: str
+    ):
         """
         Append custom meta to documents (file)
 
@@ -81,7 +86,12 @@ class Metadata:
                             self.window.core.debug.log(e)
                 doc.metadata = meta
 
-    def append_web_metadata(self, docs: list[Document], type: str, args: dict):
+    def append_web_metadata(
+            self,
+            docs: List[Document],
+            type: str,
+            args: Dict[str, Any]
+    ):
         """
         Append custom meta to documents (web)
 

pygpt_net/core/idx/types/ctx.py

@@ -6,9 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.27 04:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
+from typing import Optional
+
+
 class Ctx:
     def __init__(self, window=None, provider=None):
         """
@@ -43,7 +46,12 @@ class Ctx:
             doc_id=doc_id,
         )
 
-    def exists(self, store_id: str, idx: str, meta_id: int) -> bool:
+    def exists(
+            self,
+            store_id: str,
+            idx: str,
+            meta_id: int
+    ) -> bool:
         """
         Check if ctx meta is indexed
 
@@ -58,7 +66,12 @@ class Ctx:
             meta_id=meta_id,
         )
 
-    def get_doc_id(self, store_id: str, idx: str, meta_id: int) -> str:
+    def get_doc_id(
+            self,
+            store_id: str,
+            idx: str,
+            meta_id: int
+    ) -> str:
         """
         Get indexed document id by meta id
 
@@ -73,7 +86,11 @@ class Ctx:
             meta_id=meta_id,
         )
 
-    def update(self, meta_id: int, doc_id: str) -> bool:
+    def update(
+            self,
+            meta_id: int,
+            doc_id: str
+    ) -> bool:
         """
         Update timestamp of indexed ctx meta
 
@@ -86,7 +103,12 @@ class Ctx:
             doc_id=doc_id,
         )
 
-    def remove(self, store_id: str, idx: str, meta_id: str):
+    def remove(
+            self,
+            store_id: str,
+            idx: str,
+            meta_id: str
+    ):
         """
         Remove document from index db
 
@@ -100,7 +122,11 @@ class Ctx:
             meta_id=meta_id,
         )
 
-    def truncate(self, store_id: str = None, idx: str = None):
+    def truncate(
+            self,
+            store_id: Optional[str] = None,
+            idx: Optional[str] = None
+    ):
         """
         Truncate ctx meta from index db
 

pygpt_net/core/idx/types/external.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.27 04:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
 import datetime
 import time
+from typing import Optional
 
 
 class External:
@@ -54,7 +55,13 @@ class External:
             data=data,
         )
 
-    def get_doc_id(self, store_id: str, idx: str, content: str, type: str) -> str:
+    def get_doc_id(
+            self,
+            store_id: str,
+            idx: str,
+            content: str,
+            type: str
+    ) -> str:
         """
         Get indexed document id by content
 
@@ -71,7 +78,13 @@ class External:
             type=type,
         )
 
-    def exists(self, store_id: str, idx: str, content: str, type: str) -> bool:
+    def exists(
+            self,
+            store_id: str,
+            idx: str,
+            content: str,
+            type: str
+    ) -> bool:
         """
         Check if content is indexed
 
@@ -88,7 +101,13 @@ class External:
             type=type,
         )
 
-    def update(self, content: str, type: str, doc_id: str, ts: int) -> bool:
+    def update(
+            self,
+            content: str,
+            type: str,
+            doc_id: str,
+            ts: int
+    ) -> bool:
         """
         Update timestamp of indexed external content
 
@@ -105,7 +124,12 @@ class External:
             ts=ts,
         )
 
-    def remove(self, store_id: str, idx: str, doc_id: str):
+    def remove(
+            self,
+            store_id: str,
+            idx: str,
+            doc_id: str
+    ):
         """
         Remove document from index
 
@@ -119,7 +143,11 @@ class External:
             doc_id=doc_id,
         )
 
-    def truncate(self, store_id: str = None, idx: str = None):
+    def truncate(
+            self,
+            store_id: Optional[str] = None,
+            idx: Optional[str] = None
+    ):
         """
         Truncate external data from index
 
@@ -131,7 +159,13 @@ class External:
             idx=idx,
         )
 
-    def set_indexed(self, content: str, type: str, idx: str, doc_id: str) -> bool:
+    def set_indexed(
+            self,
+            content: str,
+            type: str,
+            idx: str,
+            doc_id: str
+    ) -> bool:
         """
         Set external content as indexed
 

pygpt_net/core/idx/types/files.py

@@ -6,11 +6,12 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.02.27 04:00:00                  #
+# Updated Date: 2024.12.14 00:00:00                  #
 # ================================================== #
 
 import datetime
 import os.path
+from typing import Optional
 
 
 class Files:
@@ -67,7 +68,12 @@ class Files:
         path = path.replace("\\", "/").strip(r'\/')
         return path
 
-    def get_doc_id(self, store_id: str, idx: str, file_id: str) -> str:
+    def get_doc_id(
+            self,
+            store_id: str,
+            idx: str,
+            file_id: str
+    ) -> str:
         """
         Get indexed document id by file
 
@@ -82,7 +88,12 @@ class Files:
             file_id=file_id,
         )
 
-    def exists(self, store_id: str, idx: str, file_id: str) -> bool:
+    def exists(
+            self,
+            store_id: str,
+            idx: str,
+            file_id: str
+    ) -> bool:
         """
         Check if file is indexed
 
@@ -97,7 +108,12 @@ class Files:
             file_id=file_id,
         )
 
-    def update(self, id: int, doc_id: str, ts: int) -> bool:
+    def update(
+            self,
+            id: int,
+            doc_id: str,
+            ts: int
+    ) -> bool:
         """
         Update timestamp of indexed file
 
@@ -112,7 +128,12 @@ class Files:
             ts=ts,
         )
 
-    def remove(self, store_id: str, idx: str, doc_id: str):
+    def remove(
+            self,
+            store_id: str,
+            idx: str,
+            doc_id: str
+    ):
         """
         Remove document from index
 
@@ -126,7 +147,11 @@ class Files:
             doc_id=doc_id,
         )
 
-    def truncate(self, store_id: str = None, idx: str = None):
+    def truncate(
+            self,
+            store_id: Optional[str] = None,
+            idx: Optional[str] = None
+    ):
         """
         Truncate files from index
 

pygpt_net/core/image.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 21:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
 import os
+from typing import List
 
 from PySide6.QtCore import Slot, QObject
 
@@ -34,7 +35,12 @@ class Image(QObject):
             os.makedirs(img_dir, exist_ok=True)
 
     @Slot(object, list, str)
-    def handle_finished(self, ctx: CtxItem, paths: list, prompt: str):
+    def handle_finished(
+            self,
+            ctx: CtxItem,
+            paths: List[str],
+            prompt: str
+    ):
         """
         Handle finished image generation
 
@@ -45,7 +51,12 @@ class Image(QObject):
         self.window.controller.chat.image.handle_response(ctx, paths, prompt)
 
     @Slot(object, list, str)
-    def handle_finished_inline(self, ctx: CtxItem, paths: list, prompt: str):
+    def handle_finished_inline(
+            self,
+            ctx: CtxItem,
+            paths: List[str],
+            prompt: str
+    ):
         """
         Handle finished image generation
 
@@ -86,7 +97,7 @@ class Image(QObject):
         self.window.update_status(msg)
         self.window.core.debug.log(msg)
 
-    def save_image(self, path: str, image: any) -> bool:
+    def save_image(self, path: str, image: bytes) -> bool:
         """
         Save image to file