webscout 2.8__tar.gz → 3.0b0__tar.gz

{webscout-2.8 → webscout-3.0b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 2.8
+Version: 3.0b0
 Summary: Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs
 Author: OEvortex
 Author-email: helpingai5@gmail.com
@@ -61,6 +61,7 @@ Provides-Extra: local
 Requires-Dist: llama-cpp-python; extra == "local"
 Requires-Dist: colorama; extra == "local"
 Requires-Dist: numpy; extra == "local"
+Requires-Dist: huggingface_hub; extra == "local"
 
 <div align="center">
   <!-- Replace `#` with your actual links -->

{webscout-2.8 → webscout-3.0b0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", encoding="utf-8") as f:
 
 setup(
     name="webscout",
-    version="2.8",
+    version="3.0-beta",
     description="Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs",
     long_description=README,
     long_description_content_type="text/markdown",
@@ -74,6 +74,7 @@ setup(
             'llama-cpp-python',
             'colorama',
             'numpy',
+            'huggingface_hub',
         ],
     },
     license="HelpingAI Simplified Universal License",

{webscout-2.8 → webscout-3.0b0}/webscout/AIutel.py

@@ -46,6 +46,7 @@ webai = [
    "chatgptuk",
    "auto",
    "poe",
+   "basedgpt",
 ]
 gpt4free_providers = [
     provider.__name__ for provider in g4f.Provider.__providers__  # if provider.working

{webscout-2.8 → webscout-3.0b0}/webscout/Local/_version.py

@@ -1,3 +1,3 @@
 from llama_cpp import __version__ as __llama_cpp_version__
 
-__version__ = '2.7'
+__version__ = '2.9'

{webscout-2.8 → webscout-3.0b0}/webscout/Local/model.py

@@ -1,3 +1,4 @@
+import json
 from ._version import __version__, __llama_cpp_version__
 
 """Submodule containing the Model class to work with language models"""
@@ -15,7 +16,7 @@ from .utils import (
 
 from .samplers import SamplerSettings, DefaultSampling
 from llama_cpp import Llama, StoppingCriteriaList
-from typing    import Generator, Optional, Union
+from typing    import Callable, Generator, Optional, Union
 from os.path   import isdir, exists
 from heapq     import nlargest
 
@@ -68,7 +69,7 @@ class Model:
         n_gpu_layers: int = 0,
         offload_kqv: bool = True,
         flash_attn: bool = False,
-        verbose: bool = False
+        verbose: bool = False,
     ):
         """
         Given the path to a GGUF file, construct a Model instance.
@@ -105,7 +106,7 @@ class Model:
         self._offload_kqv = offload_kqv
         self._flash_attn = flash_attn
         self._verbose = self.verbose = verbose
-
+        self.tools = {}
         # if context_length <= 0, use n_ctx_train
         if isinstance(context_length, int) and context_length <= 0:
             context_length = None
@@ -269,7 +270,77 @@ class Model:
             print_verbose(f"param: self.context_length  == {self.context_length}")
             print_verbose(f" gguf: rope_freq_base_train == {rope_freq_base_train}")
             print_verbose(f"param: rope_freq_base       == {rope_freq_base}")
-    
+    def register_tool(self, name: str, function: Callable):
+        """
+        Registers a tool for function calling.
+
+        Args:
+            name: The name of the tool.
+            function: The Python function to execute when the tool is called.
+        """
+        self.tools[name] = function
+
+    def _extract_tool_code(self, text: str) -> dict:
+        """
+        Extracts tool code from the model's output using the chatml-function-calling format.
+        
+        Args:
+            text: The model's generated text.
+
+        Returns:
+            A dictionary containing the tool name and arguments, or None if no tool call is found.
+        """
+        try:
+            # Assuming tool code is enclosed in ```tool_code\n...\n```tool_code```
+            start = text.find("```tool_code\n") + len("```tool_code\n")
+            end = text.find("\n```tool_code```")
+            tool_code_json = text[start:end]
+            tool_code = json.loads(tool_code_json)
+            return tool_code
+        except (ValueError, json.JSONDecodeError):
+            return None
+
+    def generate(
+        self,
+        prompt: Union[str, list[int]],
+        stops: list[Union[str, int]] = [],
+        sampler: SamplerSettings = DefaultSampling
+    ) -> str:
+        """
+        Given a prompt, return a generated string, potentially calling and executing tools.
+
+        Args:
+            prompt: The text from which to generate.
+            stops: A list of strings and/or token IDs at which to end the generation early.
+            sampler: The SamplerSettings object used to control text generation.
+
+        Returns:
+            The generated string.
+        """
+        assert_model_is_loaded(self)
+        response_text = self.llama.create_completion(
+            prompt,
+            max_tokens=sampler.max_len_tokens,
+            temperature=sampler.temp,
+            top_p=sampler.top_p,
+            min_p=sampler.min_p,
+            frequency_penalty=sampler.frequency_penalty,
+            presence_penalty=sampler.presence_penalty,
+            repeat_penalty=sampler.repeat_penalty,
+            top_k=sampler.top_k,
+            stop=stops
+        )['choices'][0]['text']
+
+        tool_code = self._extract_tool_code(response_text)
+        if tool_code:
+            # Execute the tool and get its output
+            tool_name = tool_code.get("function", {}).get("name")
+            arguments = tool_code.get("function", {}).get("arguments", "")
+            if tool_name and arguments and tool_name in self.tools:
+                tool_output = self.tools[tool_name](**json.loads(arguments))
+                # Append the tool output to the response
+                response_text += f"\n{tool_output}" 
+        return response_text
     def __repr__(self) -> str:
         return \
             f"Model({repr(self._model_path)}, " + \

{webscout-2.8 → webscout-3.0b0}/webscout/Local/thread.py

@@ -1,3 +1,4 @@
+import json
 from ._version import __version__, __llama_cpp_version__
 
 """Submodule containing the Thread class, used for interaction with a Model"""
@@ -80,7 +81,9 @@ class Thread:
         format: Union[dict, AdvancedFormat],
         sampler: SamplerSettings = DefaultSampling,
         messages: Optional[list[Message]] = None,
+
     ):
+    
         """
         Given a Model and a format, construct a Thread instance.
 
@@ -141,7 +144,7 @@ class Thread:
             self.create_message("system", self.format['system_content'])
         ] if self._messages is None else self._messages
         self.sampler: SamplerSettings = sampler
-
+        self.tools = [] 
         if self.model.verbose:
             print_verbose("new Thread instance with the following attributes:")
             print_verbose(f"model                     == {self.model}")
@@ -162,8 +165,16 @@ class Thread:
             print_verbose(f"sampler.presence_penalty  == {self.sampler.presence_penalty}")
             print_verbose(f"sampler.repeat_penalty    == {self.sampler.repeat_penalty}")
             print_verbose(f"sampler.top_k             == {self.sampler.top_k}")
-    
+    def add_tool(self, tool: dict):
+        """
+        Adds a tool to the Thread for function calling.
+        ... (Rest of your add_tool docstring)
+        """
+        self.tools.append(tool)
+        self.model.register_tool(tool['function']['name'], tool['function'].get('execute', None))
 
+        # Include tool information in the system message
+        self.messages[0]['content'] += f"\nYou have access to the following tool:\n```tool_code\n{json.dumps(tool)}\n```tool_code"
     def __repr__(self) -> str:
         return \
             f"Thread({repr(self.model)}, {repr(self.format)}, " + \

{webscout-2.8 → webscout-3.0b0}/webscout/Local/utils.py

@@ -25,18 +25,19 @@ class _ArrayLike(Iterable):
 class _SupportsWriteAndFlush(TextIO):
     pass
 
-def download_model(repo_id: str, filename: str, cache_dir: str = ".cache") -> str:
+def download_model(repo_id: str, filename: str, token: str, cache_dir: str = ".cache") -> str:
     """
     Downloads a GGUF model file from Hugging Face Hub.
 
     repo_id: The Hugging Face repository ID (e.g., 'facebook/bart-large-cnn').
     filename: The name of the GGUF file within the repository (e.g., 'model.gguf').
+    token: The Hugging Face token for authentication.
     cache_dir: The directory where the downloaded file should be stored.
     
     Returns: The path to the downloaded file.
     """
     url = hf_hub_url(repo_id, filename)
-    filepath = cached_download(url, cache_dir=cache_dir, force_filename=filename)
+    filepath = cached_download(url, cache_dir=cache_dir, force_filename=filename, use_auth_token=token)
     return filepath
 
 class GGUFReader:

{webscout-2.8 → webscout-3.0b0}/webscout/Provider/__init__.py

@@ -28,7 +28,7 @@ from .Gemini import GEMINI
 from .Berlin4h import Berlin4h
 from .ChatGPTUK import ChatGPTUK
 from .Poe import POE
-from .BasedGPT import *
+from .BasedGPT import BasedGPT
 __all__ = [
     'ThinkAnyAI',
     'Xjai',
@@ -57,5 +57,6 @@ __all__ = [
     'GEMINI',
     'Berlin4h',
     'ChatGPTUK',
-    'POE'
+    'POE',
+    'BasedGPT',
 ]

{webscout-2.8 → webscout-3.0b0}/webscout/__init__.py

@@ -34,6 +34,7 @@ webai = [
    "chatgptuk",
    "auto",
    "poe",
+   "basedgpt",
 ]
 
 gpt4free_providers = [

webscout-3.0b0/webscout/version.py

@@ -0,0 +1,2 @@
+__version__ = "2.9"
+

{webscout-2.8 → webscout-3.0b0}/webscout.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 2.8
+Version: 3.0b0
 Summary: Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs
 Author: OEvortex
 Author-email: helpingai5@gmail.com
@@ -61,6 +61,7 @@ Provides-Extra: local
 Requires-Dist: llama-cpp-python; extra == "local"
 Requires-Dist: colorama; extra == "local"
 Requires-Dist: numpy; extra == "local"
+Requires-Dist: huggingface_hub; extra == "local"
 
 <div align="center">
   <!-- Replace `#` with your actual links -->

{webscout-2.8 → webscout-3.0b0}/webscout.egg-info/requires.txt

@@ -37,3 +37,4 @@ pytest>=7.4.2
 llama-cpp-python
 colorama
 numpy
+huggingface_hub

webscout-2.8/webscout/version.py

@@ -1,2 +0,0 @@
-__version__ = "2.7"
-