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

pygpt_net/core/access/actions.py

@@ -6,9 +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 08:00:00                  #
 # ================================================== #
 
+from typing import List, Dict
+
 from pygpt_net.core.events import ControlEvent, AppEvent
 
 
@@ -21,7 +23,7 @@ class Actions:
         """
         self.window = window
 
-    def get_access_choices(self) -> list:
+    def get_access_choices(self) -> List[Dict[str, str]]:
         """
         Get app access events choices
 
@@ -74,7 +76,7 @@ class Actions:
             choices.append({event: f"event.control.{event}"})
         return choices
 
-    def get_speech_synthesis_choices(self) -> list:
+    def get_speech_synthesis_choices(self) -> List[Dict[str, str]]:
         """
         Get app access events choices
 
@@ -115,7 +117,7 @@ class Actions:
             choices.append({event: f"event.audio.{event}"})
         return choices
 
-    def get_voice_control_choices(self) -> list:
+    def get_voice_control_choices(self) -> List[Dict[str, str]]:
         """
         Get voice control choices
 

pygpt_net/core/access/shortcuts.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 copy
+from typing import List, Dict
 
 from PySide6 import QtCore
 from PySide6.QtCore import QObject, QEvent
@@ -26,7 +27,7 @@ class Shortcuts:
         """
         self.window = window
 
-    def get_keys_choices(self) -> list:
+    def get_keys_choices(self) -> List[Dict[str, str]]:
         """
         Get keys choices with identical key and value.
 
@@ -43,7 +44,7 @@ class Shortcuts:
         keys.extend([{name: name} for name in symbols])
         return keys
 
-    def get_modifiers_choices(self) -> list:
+    def get_modifiers_choices(self) -> List[Dict[str, str]]:
         """
         Get modifiers choices with identical key and value.
 

pygpt_net/core/access/voice.py

@@ -6,11 +6,12 @@
 # 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 json
 import re
+from typing import Optional, Dict, List, Any
 
 from pygpt_net.core.bridge.context import BridgeContext
 
@@ -96,7 +97,7 @@ class Voice:
             AppEvent.TAB_SELECTED,  # notepad tabs can have custom names
         ]
 
-    def get_commands(self) -> dict:
+    def get_commands(self) -> Dict[str, str]:
         """
         Get available commands
 
@@ -152,7 +153,7 @@ class Voice:
 
         return prompt.strip()
 
-    def get_inline_prompt(self, prefix: str = None) -> str:
+    def get_inline_prompt(self, prefix: Optional[str] = None) -> str:
         """
         Get prompt for inline voice command recognition
 
@@ -174,7 +175,7 @@ class Voice:
 
         return prompt.strip()
 
-    def extract_json(self, text: str) -> list:
+    def extract_json(self, text: str) -> List[Dict[str, Any]]:
         """
         Extract JSON from text
 
@@ -206,7 +207,7 @@ class Voice:
                     self.window.core.debug.log(e)
         return cmds
 
-    def recognize_commands(self, text: str) -> list:
+    def recognize_commands(self, text: str) -> List[Dict[str, Any]]:
         """
         Recognize voice command
 

pygpt_net/core/agents/legacy.py

@@ -6,9 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.26 19:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
+from typing import List
+
 from pygpt_net.core.types import (
     MODE_CHAT,
     MODE_COMPLETION,
@@ -35,7 +37,7 @@ class Legacy:
             MODE_AUDIO,
         ]
 
-    def get_allowed_modes(self) -> list:
+    def get_allowed_modes(self) -> List[str]:
         """
         Get allowed modes
 

pygpt_net/core/agents/memory.py

@@ -6,9 +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 00:00:00                  #
 # ================================================== #
 
+from typing import List
+
 from llama_index.core.llms import ChatMessage, MessageRole
 from pygpt_net.core.bridge.context import BridgeContext
 
@@ -22,7 +24,10 @@ class Memory:
         """
         self.window = window
 
-    def prepare(self, context: BridgeContext) -> list[ChatMessage]:
+    def prepare(
+            self,
+            context: BridgeContext
+    ) -> List[ChatMessage]:
         """
         Prepare history for agent
 

pygpt_net/core/agents/observer/evaluation.py

@@ -6,11 +6,15 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.17 03:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
+from typing import List
+
 from llama_index.core.tools import FunctionTool
 
+from pygpt_net.item.ctx import CtxItem
+
 
 class Evaluation:
     def __init__(self, window=None):
@@ -67,7 +71,7 @@ class Evaluation:
         - Do not repeat the suggested improvements if they have already been correctly included in the agent's response.
         """
 
-    def get_last_user_input(self, history) -> str:
+    def get_last_user_input(self, history: List[CtxItem]) -> str:
         """
         Get the last user input from the history
 
@@ -84,7 +88,7 @@ class Evaluation:
                     input = ctx.input
         return input
 
-    def get_main_task(self, history) -> str:
+    def get_main_task(self, history: List[CtxItem]) -> str:
         """
         Get the main task from the history
 
@@ -97,7 +101,7 @@ class Evaluation:
             task = first.input
         return task
 
-    def get_final_response(self, history) -> str:
+    def get_final_response(self, history: List[CtxItem]) -> str:
         """
         Get the final response from the agent
 
@@ -111,7 +115,7 @@ class Evaluation:
                     output = ctx.output
         return output
 
-    def get_prompt(self, history) -> str:
+    def get_prompt(self, history: List[CtxItem]) -> str:
         """
         Return the evaluation prompt
 
@@ -128,7 +132,7 @@ class Evaluation:
             output=final_response
         )
 
-    def get_tools(self) -> list:
+    def get_tools(self) -> List[FunctionTool]:
         """
         Get the tools for evaluating the result
 
@@ -144,7 +148,11 @@ class Evaluation:
         tools.append(tool)
         return tools
 
-    def handle_evaluation(self, instruction: str, score: int):
+    def handle_evaluation(
+            self,
+            instruction: str,
+            score: int
+    ):
         """
         Update the evaluation values of the agent response
 

pygpt_net/core/agents/provider.py

@@ -6,9 +6,14 @@
 # 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                  #
 # ================================================== #
 
+from typing import List
+
+from pygpt_net.provider.agents.base import BaseAgent
+
+
 class Provider:
     def __init__(self, window=None):
         """
@@ -19,7 +24,7 @@ class Provider:
         self.window = window
         self.agents = {}
 
-    def get_ids(self) -> list:
+    def get_ids(self) -> List[str]:
         """
         Get agent providers ids
 
@@ -36,7 +41,7 @@ class Provider:
         """
         return id in self.agents
 
-    def get(self, id: str):
+    def get(self, id: str) -> BaseAgent:
         """
         Get agent provider
 
@@ -54,7 +59,7 @@ class Provider:
         """
         self.agents[id] = agent
 
-    def get_providers(self) -> list:
+    def get_providers(self) -> List[str]:
         """
         Get agent providers list
 

pygpt_net/core/agents/runner.py

@@ -6,9 +6,13 @@
 # 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 08:00:00                  #
 # ================================================== #
 
+from typing import Optional, Dict, Any, List
+
+from llama_index.core.tools import FunctionTool
+
 from pygpt_net.core.bridge.context import BridgeContext
 from pygpt_net.core.bridge.worker import BridgeSignals
 from pygpt_net.core.events import Event, KernelEvent
@@ -32,7 +36,7 @@ class Runner:
     def call(
             self,
             context: BridgeContext,
-            extra: dict,
+            extra: Dict[str, Any],
             signals: BridgeSignals
     ) -> bool:
         """
@@ -104,7 +108,7 @@ class Runner:
 
     def run_steps(
             self,
-            agent,
+            agent: Any,
             ctx: CtxItem,
             prompt: str,
             signals: BridgeSignals,
@@ -202,7 +206,7 @@ class Runner:
 
     def run_assistant(
             self,
-            agent,
+            agent: Any,
             ctx: CtxItem,
             prompt: str,
             signals: BridgeSignals,
@@ -250,7 +254,7 @@ class Runner:
 
     def run_plan(
             self,
-            agent,
+            agent: Any,
             ctx: CtxItem,
             prompt: str,
             signals: BridgeSignals,
@@ -408,7 +412,12 @@ class Runner:
 
         return True
 
-    def copy_step_results(self, step_ctx: CtxItem, ctx: CtxItem, tools_output: list):
+    def copy_step_results(
+            self,
+            step_ctx: CtxItem,
+            ctx: CtxItem,
+            tools_output: List[Dict[str, Any]]
+    ):
         """
         Copy step results from base context item
 
@@ -433,7 +442,12 @@ class Runner:
             if k != "agent_input":
                 del ctx.extra[k]
 
-    def run_once(self, input: str, tools: list, model_name) -> str:
+    def run_once(
+            self,
+            input: str,
+            tools: List[FunctionTool],
+            model_name: Optional[str] = None
+    ) -> str:
         """
         Run agent once (quick call to ReAct agent)
 
@@ -460,7 +474,12 @@ class Runner:
         agent = provider.get_agent(self.window, kwargs)
         return agent.chat(self.prepare_input(input))
 
-    def run_next(self, context: BridgeContext, extra: dict, signals: BridgeSignals) -> bool:
+    def run_next(
+            self,
+            context: BridgeContext,
+            extra: dict,
+            signals: BridgeSignals
+    ) -> bool:
         """
         Evaluate a response and run next step
 
@@ -484,7 +503,13 @@ class Runner:
         self.run_once(prompt, tools, ctx.model)  # tool will update evaluation
         return self.handle_evaluation(ctx, self.next_instruction, self.prev_score, signals)
 
-    def handle_evaluation(self, ctx: CtxItem, instruction: str, score: int, signals: BridgeSignals):
+    def handle_evaluation(
+            self,
+            ctx: CtxItem,
+            instruction: str,
+            score: int,
+            signals: BridgeSignals
+    ):
         """
         Handle evaluation
 
@@ -548,7 +573,10 @@ class Runner:
         context.model = self.window.core.models.get(self.window.core.config.get('model'))
         return self.call(context, extra, signals)
 
-    def add_ctx(self, from_ctx: CtxItem) -> CtxItem:
+    def add_ctx(
+            self,
+            from_ctx: CtxItem
+    ) -> CtxItem:
         """
         Add context item
 
@@ -568,7 +596,13 @@ class Runner:
         ctx.live = True
         return ctx
 
-    def send_response(self, ctx: CtxItem, signals: BridgeSignals, event_name: str, **kwargs):
+    def send_response(
+            self,
+            ctx: CtxItem,
+            signals: BridgeSignals,
+            event_name: str,
+            **kwargs
+    ):
         """
         Send async response to chat window (BridgeSignals)
 
@@ -585,7 +619,11 @@ class Runner:
         })
         signals.response.emit(event)
 
-    def set_busy(self, signals: BridgeSignals, **kwargs):
+    def set_busy(
+            self,
+            signals: BridgeSignals,
+            **kwargs
+    ):
         """
         Set busy status
 
@@ -600,7 +638,11 @@ class Runner:
         data.update(kwargs)
         signals.response.emit(event)
 
-    def set_idle(self, signals: BridgeSignals, **kwargs):
+    def set_idle(
+            self,
+            signals: BridgeSignals,
+            **kwargs
+    ):
         """
         Set idle status
 
@@ -614,7 +656,11 @@ class Runner:
         data.update(kwargs)
         signals.response.emit(event)
 
-    def set_status(self, signals: BridgeSignals, msg: str):
+    def set_status(
+            self,
+            signals: BridgeSignals,
+            msg: str
+    ):
         """
         Set busy status
 
@@ -647,7 +693,7 @@ class Runner:
         """
         return self.window.controller.kernel.stopped()
 
-    def get_error(self) -> Exception or None:
+    def get_error(self) -> Optional[Exception]:
         """
         Get last error
 

pygpt_net/core/agents/tools.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 08:00:00                  #
 # ================================================== #
 
 import json
+from typing import List, Dict, Any
 
 from llama_index.core.chat_engine.types import AgentChatResponse
 from llama_index.core.tools import BaseTool, FunctionTool, QueryEngineTool, ToolMetadata
@@ -29,7 +30,12 @@ class Tools:
         self.cmd_blacklist = []
         self.verbose = False
 
-    def prepare(self, context: BridgeContext, extra: dict, verbose: bool = False) -> list[BaseTool]:
+    def prepare(
+            self,
+            context: BridgeContext,
+            extra: Dict[str, Any],
+            verbose: bool = False
+    ) -> List[BaseTool]:
         """
         Prepare tools for agent
 
@@ -66,7 +72,11 @@ class Tools:
                 tools.extend(query_engine_tools)
         return tools
 
-    def get_plugin_functions(self, ctx: CtxItem, verbose: bool = False) -> list:
+    def get_plugin_functions(
+            self,
+            ctx: CtxItem,
+            verbose: bool = False
+    ) -> list:
         """
         Parse plugin functions
 
@@ -114,7 +124,10 @@ class Tools:
                 print(e)
         return tools
 
-    def export_sources(self, response: AgentChatResponse) -> list[dict]:
+    def export_sources(
+            self,
+            response: AgentChatResponse
+    ) -> List[dict]:
         """
         Export sources from response
 
@@ -148,7 +161,12 @@ class PluginToolMetadata(ToolMetadata):
         super().__init__(name=name, description=description)
         self.schema = None
 
-    def get_parameters_dict(self) -> dict:
+    def get_parameters_dict(self) -> Dict[str, Any]:
+        """
+        Get parameters dictionary
+
+        :return: parameters
+        """
         parameters = {
             k: v
             for k, v in self.schema.items()

pygpt_net/core/assistants/__init__.py

@@ -6,9 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.04.26 23:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
+from typing import Optional, Dict
+
 from pygpt_net.item.assistant import AssistantItem
 from pygpt_net.item.attachment import AttachmentItem
 from pygpt_net.provider.core.assistant.json_file import JsonFileProvider
@@ -58,7 +60,7 @@ class Assistants:
         assistants = self.get_all()
         return list(assistants.keys())[idx]
 
-    def get_by_id(self, id: str) -> AssistantItem | None:
+    def get_by_id(self, id: str) -> Optional[AssistantItem]:
         """
         Return assistant by ID
 
@@ -70,7 +72,7 @@ class Assistants:
             return None
         return assistants[id]
 
-    def get_all(self) -> dict:
+    def get_all(self) -> Dict[str, AssistantItem]:
         """
         Return assistants
 
@@ -143,7 +145,7 @@ class Assistants:
             del assistant.attachments[old_id]
             self.save()
 
-    def get_default_assistant(self) -> str | None:
+    def get_default_assistant(self) -> Optional[str]:
         """
         Return default assistant ID or None
 

pygpt_net/core/assistants/files.py

@@ -6,9 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.04.30 04:00:00                  #
+# Updated Date: 2024.12.14 08:00:00                  #
 # ================================================== #
 
+from typing import Optional, List, Dict
+
 from packaging.version import Version
 
 from pygpt_net.item.assistant import AssistantFileItem, AssistantItem
@@ -49,7 +51,7 @@ class Files:
         if id in self.items:
             return self.items[id]
 
-    def get_ids(self) -> list:
+    def get_ids(self) -> List[str]:
         """
         Return all loaded file IDs
 
@@ -58,7 +60,7 @@ class Files:
         return list(self.items.keys())
 
 
-    def get_all(self) -> dict:
+    def get_all(self) -> Dict[str, AssistantFileItem]:
         """
         Return all files
 
@@ -103,7 +105,7 @@ class Files:
             file_id: str,
             name: str,
             path: str,
-            size: int) -> AssistantFileItem or None:
+            size: int) -> Optional[AssistantFileItem]:
         """
         Create new file
 
@@ -128,7 +130,10 @@ class Files:
         self.items[file.id] = file
         return file
 
-    def update(self, file: AssistantFileItem) -> AssistantFileItem or None:
+    def update(
+            self,
+            file: AssistantFileItem
+    ) -> Optional[AssistantFileItem]:
         """
         Update file
 
@@ -139,7 +144,7 @@ class Files:
         self.provider.save(file)
         return file
 
-    def get_names(self) -> dict:
+    def get_names(self) -> Dict[str, str]:
         """
         Get file name mapping id <> name
 
@@ -151,7 +156,11 @@ class Files:
             names[id] = file.name
         return names
 
-    def get_by_store_or_thread(self, store_id: str, thread_id: str) -> dict:
+    def get_by_store_or_thread(
+            self,
+            store_id: str,
+            thread_id: str
+    ) -> Dict[str, AssistantFileItem]:
         """
         Get files by store or thread
 
@@ -161,7 +170,11 @@ class Files:
         """
         return self.provider.get_by_store_or_thread(store_id, thread_id)
 
-    def count_by_store_or_thread(self, store_id: str, thread_id: str) -> int:
+    def count_by_store_or_thread(
+            self,
+            store_id: str,
+            thread_id: str
+    ) -> int:
         """
         Count files by store or thread
 
@@ -171,7 +184,12 @@ class Files:
         """
         return self.provider.count_by_store_or_thread(store_id, thread_id)
 
-    def get_file_by_idx(self, idx: int, store_id: str, thread_id: str) -> AssistantFileItem or None:
+    def get_file_by_idx(
+            self,
+            idx: int,
+            store_id: str,
+            thread_id: str
+    ) -> Optional[AssistantFileItem]:
         """
         Get file by list index
 
@@ -185,7 +203,12 @@ class Files:
             return None
         return list(files.values())[idx]
 
-    def get_file_id_by_idx(self, idx: int, store_id: str, thread_id: str) -> str or None:
+    def get_file_id_by_idx(
+            self,
+            idx: int,
+            store_id: str,
+            thread_id: str
+    ) -> Optional[str]:
         """
         Get file by list index
 
@@ -259,7 +282,7 @@ class Files:
             self.items[record_id].name = name
         return True
 
-    def truncate(self, store_id: str = None) -> bool:
+    def truncate(self, store_id: Optional[str] = None) -> bool:
         """
         Truncate all files
 
@@ -272,7 +295,7 @@ class Files:
             self.window.core.gpt.store.remove_from_stores()  # remove files from all vector stores
         return self.truncate_local(store_id)  # truncate files in DB
 
-    def truncate_local(self, store_id: str = None) -> bool:
+    def truncate_local(self, store_id: Optional[str] = None) -> bool:
         """
         Truncate all files (local only)