webscout 2.8__py3-none-any.whl → 3.0__py3-none-any.whl

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/Local/_version.py

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

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
 
@@ -26,6 +27,8 @@ class ModelUnloadedException(Exception):
     """Exception raised when trying to use a Model that has been unloaded"""
     def __init__(self, message):
         self.message = message
+        self.tool_code_start = "```tool_code\n"  # Define tool code markers
+        self.tool_code_end = "\n```tool_code```"
         super().__init__(self.message)
         self.add_note('Are you trying to use a Model that has been unloaded?')
 
@@ -68,7 +71,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 +108,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 +272,73 @@ 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."""
+        self.tools[name] = function
+
+    def _extract_tool_code(self, text: str) -> dict:
+        """Extracts tool code from the model's output."""
+        try:
+            start = text.find(self.tool_code_start) + len(self.tool_code_start)
+            end = text.find(self.tool_code_end)
+            tool_code_json = text[start:end]
+            tool_code = json.loads(tool_code_json)
+            return tool_code
+        except (ValueError, json.JSONDecodeError):
+            return None
+    def _should_call_tool(self, response_text: str) -> bool:
+        """Determines if the model suggests a tool call."""
+        # Simple check for tool code markers in response
+        return self.tool_code_start in response_text and self.tool_code_end in response_text
+    def generate(
+        self,
+        prompt: Union[str, list[int]],
+        stops: list[Union[str, int]] = [],
+        sampler: SamplerSettings = DefaultSampling,
+        max_iterations: int = 3, # Maximum iterations for tool calls
+    ) -> str:
+        """
+        Generates text and handles tool calls.
+
+        Args:
+            prompt (Union[str, list[int]]): The input prompt.
+            stops (list[Union[str, int]]): Stop sequences.
+            sampler (SamplerSettings): Sampler settings.
+            max_iterations (int): Maximum number of tool call iterations. 
+
+        Returns:
+            str: The generated text.
+        """
+        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']
+
+        iteration = 0
+        while self._should_call_tool(response_text) and iteration < max_iterations:
+            tool_code = self._extract_tool_code(response_text)
+            if tool_code:
+                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:
+                    # Execute the tool and append its output
+                    tool_output = self.tools[tool_name](**json.loads(arguments))
+                    response_text = response_text.replace(
+                        f"{self.tool_code_start}{json.dumps(tool_code)}{self.tool_code_end}", 
+                        tool_output
+                    )
+            iteration += 1
+
+        return response_text
     def __repr__(self) -> str:
         return \
             f"Model({repr(self._model_path)}, " + \

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,13 @@ 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."""
+        self.tools.append(tool)
+        self.model.register_tool(tool['function']['name'], tool['function']['execute']) # Register the tool
 
+        # Include tool information in the system message (optional, but helpful)
+        self.messages[0]['content'] += f"\nYou have access to the following tool:\n{tool['function']['description']}" 
     def __repr__(self) -> str:
         return \
             f"Thread({repr(self.model)}, {repr(self.format)}, " + \

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/Provider/BasedGPT.py

@@ -1,226 +1,226 @@
-import time
-import uuid
-from selenium import webdriver
-from selenium.webdriver.chrome.options import Options
-from selenium.webdriver.common.by import By
-from selenium.webdriver.support import expected_conditions as EC
-from selenium.webdriver.support.ui import WebDriverWait
-import click
-import requests
-from requests import get
-from uuid import uuid4
-from re import findall
-from requests.exceptions import RequestException
-from curl_cffi.requests import get, RequestsError
-import g4f
-from random import randint
-from PIL import Image
-import io
-import re
-import json
-import yaml
-from ..AIutel import Optimizers
-from ..AIutel import Conversation
-from ..AIutel import AwesomePrompts, sanitize_stream
-from ..AIbase import  Provider, AsyncProvider
-from webscout import exceptions
-from typing import Any, AsyncGenerator, Dict
-import logging
-import httpx
-
-class BasedGPT(Provider):
-    def __init__(
-        self,
-        is_conversation: bool = True,
-        max_tokens: int = 600,
-        timeout: int = 30,
-        intro: str = None,
-        filepath: str = None,
-        update_file: bool = True,
-        proxies: dict = {},
-        history_offset: int = 10250,
-        act: str = None,
-        system_prompt: str = "Be Helpful and Friendly",
-    ):
-        """Instantiates BasedGPT
-
-        Args:
-            is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
-            max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.
-            timeout (int, optional): Http request timeout. Defaults to 30.
-            intro (str, optional): Conversation introductory prompt. Defaults to None.
-            filepath (str, optional): Path to file containing conversation history. Defaults to None.
-            update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
-            proxies (dict, optional): Http request proxies. Defaults to {}.
-            history_offset (int, optional): Limit conversation history to this number of last texts. Defaults to 10250.
-            act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
-            system_prompt (str, optional): System prompt for BasedGPT. Defaults to "Be Helpful and Friendly".
-        """
-        self.session = requests.Session()
-        self.is_conversation = is_conversation
-        self.max_tokens_to_sample = max_tokens
-        self.chat_endpoint = "https://www.basedgpt.chat/api/chat"
-        self.stream_chunk_size = 64
-        self.timeout = timeout
-        self.last_response = {}
-        self.system_prompt = system_prompt
-
-        self.__available_optimizers = (
-            method
-            for method in dir(Optimizers)
-            if callable(getattr(Optimizers, method)) and not method.startswith("__")
-        )
-        self.session.headers.update(
-            {"Content-Type": "application/json"}
-        )
-        Conversation.intro = (
-            AwesomePrompts().get_act(
-                act, raise_not_found=True, default=None, case_insensitive=True
-            )
-            if act
-            else intro or Conversation.intro
-        )
-        self.conversation = Conversation(
-            is_conversation, self.max_tokens_to_sample, filepath, update_file
-        )
-        self.conversation.history_offset = history_offset
-        self.session.proxies = proxies
-
-    def ask(
-        self,
-        prompt: str,
-        stream: bool = False,
-        raw: bool = False,
-        optimizer: str = None,
-        conversationally: bool = False,
-    ) -> dict:
-        """Chat with AI
-
-        Args:
-            prompt (str): Prompt to be send.
-            stream (bool, optional): Flag for streaming response. Defaults to False.
-            raw (bool, optional): Stream back raw response as received. Defaults to False.
-            optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
-            conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
-        Returns:
-           dict : {}
-        ```json
-        {
-            "id": "chatcmpl-TaREJpBZsRVQFRFic1wIA7Q7XfnaD",
-            "object": "chat.completion",
-            "created": 1704623244,
-            "model": "gpt-3.5-turbo",
-            "usage": {
-                "prompt_tokens": 0,
-                "completion_tokens": 0,
-                "total_tokens": 0
-                },
-            "choices": [
-                {
-                    "message": {
-                        "role": "assistant",
-                        "content": "Hello! How can I assist you today?"
-                },
-                "finish_reason": "stop",
-                "index": 0
-                }
-            ]
-        }
-        ```
-        """
-        conversation_prompt = self.conversation.gen_complete_prompt(prompt)
-        if optimizer:
-            if optimizer in self.__available_optimizers:
-                conversation_prompt = getattr(Optimizers, optimizer)(
-                    conversation_prompt if conversationally else prompt
-                )
-            else:
-                raise Exception(
-                    f"Optimizer is not one of {self.__available_optimizers}"
-                )
-
-        payload = {
-            "messages": [
-                {"role": "system", "content": self.system_prompt},
-                {"role": "user", "content": conversation_prompt},
-            ],
-        }
-
-        def for_stream():
-            response = self.session.post(
-                self.chat_endpoint, json=payload, stream=True, timeout=self.timeout
-            )
-            if not response.ok:
-                raise exceptions.FailedToGenerateResponseError(
-                    f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
-                )
-
-            message_load = ""
-            for value in response.iter_lines(
-                decode_unicode=True,
-                delimiter="",
-                chunk_size=self.stream_chunk_size,
-            ):
-                try:
-                    message_load += value
-                    yield value if raw else dict(text=message_load)
-                except json.decoder.JSONDecodeError:
-                    pass
-            self.last_response.update(dict(text=message_load))
-            self.conversation.update_chat_history(
-                prompt, self.get_message(self.last_response)
-            )
-
-        def for_non_stream():
-            for _ in for_stream():
-                pass
-            return self.last_response
-
-        return for_stream() if stream else for_non_stream()
-
-    def chat(
-        self,
-        prompt: str,
-        stream: bool = False,
-        optimizer: str = None,
-        conversationally: bool = False,
-    ) -> str:
-        """Generate response `str`
-        Args:
-            prompt (str): Prompt to be send.
-            stream (bool, optional): Flag for streaming response. Defaults to False.
-            optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
-            conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
-        Returns:
-            str: Response generated
-        """
-
-        def for_stream():
-            for response in self.ask(
-                prompt, True, optimizer=optimizer, conversationally=conversationally
-            ):
-                yield self.get_message(response)
-
-        def for_non_stream():
-            return self.get_message(
-                self.ask(
-                    prompt,
-                    False,
-                    optimizer=optimizer,
-                    conversationally=conversationally,
-                )
-            )
-
-        return for_stream() if stream else for_non_stream()
-
-    def get_message(self, response: dict) -> str:
-        """Retrieves message only from response
-
-        Args:
-            response (dict): Response generated by `self.ask`
-
-        Returns:
-            str: Message extracted
-        """
-        assert isinstance(response, dict), "Response should be of dict data-type only"
+import time
+import uuid
+from selenium import webdriver
+from selenium.webdriver.chrome.options import Options
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support.ui import WebDriverWait
+import click
+import requests
+from requests import get
+from uuid import uuid4
+from re import findall
+from requests.exceptions import RequestException
+from curl_cffi.requests import get, RequestsError
+import g4f
+from random import randint
+from PIL import Image
+import io
+import re
+import json
+import yaml
+from ..AIutel import Optimizers
+from ..AIutel import Conversation
+from ..AIutel import AwesomePrompts, sanitize_stream
+from ..AIbase import  Provider, AsyncProvider
+from webscout import exceptions
+from typing import Any, AsyncGenerator, Dict
+import logging
+import httpx
+
+class BasedGPT(Provider):
+    def __init__(
+        self,
+        is_conversation: bool = True,
+        max_tokens: int = 600,
+        timeout: int = 30,
+        intro: str = None,
+        filepath: str = None,
+        update_file: bool = True,
+        proxies: dict = {},
+        history_offset: int = 10250,
+        act: str = None,
+        system_prompt: str = "Be Helpful and Friendly",
+    ):
+        """Instantiates BasedGPT
+
+        Args:
+            is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
+            max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.
+            timeout (int, optional): Http request timeout. Defaults to 30.
+            intro (str, optional): Conversation introductory prompt. Defaults to None.
+            filepath (str, optional): Path to file containing conversation history. Defaults to None.
+            update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
+            proxies (dict, optional): Http request proxies. Defaults to {}.
+            history_offset (int, optional): Limit conversation history to this number of last texts. Defaults to 10250.
+            act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
+            system_prompt (str, optional): System prompt for BasedGPT. Defaults to "Be Helpful and Friendly".
+        """
+        self.session = requests.Session()
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_tokens
+        self.chat_endpoint = "https://www.basedgpt.chat/api/chat"
+        self.stream_chunk_size = 64
+        self.timeout = timeout
+        self.last_response = {}
+        self.system_prompt = system_prompt
+
+        self.__available_optimizers = (
+            method
+            for method in dir(Optimizers)
+            if callable(getattr(Optimizers, method)) and not method.startswith("__")
+        )
+        self.session.headers.update(
+            {"Content-Type": "application/json"}
+        )
+        Conversation.intro = (
+            AwesomePrompts().get_act(
+                act, raise_not_found=True, default=None, case_insensitive=True
+            )
+            if act
+            else intro or Conversation.intro
+        )
+        self.conversation = Conversation(
+            is_conversation, self.max_tokens_to_sample, filepath, update_file
+        )
+        self.conversation.history_offset = history_offset
+        self.session.proxies = proxies
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> dict:
+        """Chat with AI
+
+        Args:
+            prompt (str): Prompt to be send.
+            stream (bool, optional): Flag for streaming response. Defaults to False.
+            raw (bool, optional): Stream back raw response as received. Defaults to False.
+            optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
+            conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
+        Returns:
+           dict : {}
+        ```json
+        {
+            "id": "chatcmpl-TaREJpBZsRVQFRFic1wIA7Q7XfnaD",
+            "object": "chat.completion",
+            "created": 1704623244,
+            "model": "gpt-3.5-turbo",
+            "usage": {
+                "prompt_tokens": 0,
+                "completion_tokens": 0,
+                "total_tokens": 0
+                },
+            "choices": [
+                {
+                    "message": {
+                        "role": "assistant",
+                        "content": "Hello! How can I assist you today?"
+                },
+                "finish_reason": "stop",
+                "index": 0
+                }
+            ]
+        }
+        ```
+        """
+        conversation_prompt = self.conversation.gen_complete_prompt(prompt)
+        if optimizer:
+            if optimizer in self.__available_optimizers:
+                conversation_prompt = getattr(Optimizers, optimizer)(
+                    conversation_prompt if conversationally else prompt
+                )
+            else:
+                raise Exception(
+                    f"Optimizer is not one of {self.__available_optimizers}"
+                )
+
+        payload = {
+            "messages": [
+                {"role": "system", "content": self.system_prompt},
+                {"role": "user", "content": conversation_prompt},
+            ],
+        }
+
+        def for_stream():
+            response = self.session.post(
+                self.chat_endpoint, json=payload, stream=True, timeout=self.timeout
+            )
+            if not response.ok:
+                raise exceptions.FailedToGenerateResponseError(
+                    f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
+                )
+
+            message_load = ""
+            for value in response.iter_lines(
+                decode_unicode=True,
+                delimiter="",
+                chunk_size=self.stream_chunk_size,
+            ):
+                try:
+                    message_load += value
+                    yield value if raw else dict(text=message_load)
+                except json.decoder.JSONDecodeError:
+                    pass
+            self.last_response.update(dict(text=message_load))
+            self.conversation.update_chat_history(
+                prompt, self.get_message(self.last_response)
+            )
+
+        def for_non_stream():
+            for _ in for_stream():
+                pass
+            return self.last_response
+
+        return for_stream() if stream else for_non_stream()
+
+    def chat(
+        self,
+        prompt: str,
+        stream: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> str:
+        """Generate response `str`
+        Args:
+            prompt (str): Prompt to be send.
+            stream (bool, optional): Flag for streaming response. Defaults to False.
+            optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
+            conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
+        Returns:
+            str: Response generated
+        """
+
+        def for_stream():
+            for response in self.ask(
+                prompt, True, optimizer=optimizer, conversationally=conversationally
+            ):
+                yield self.get_message(response)
+
+        def for_non_stream():
+            return self.get_message(
+                self.ask(
+                    prompt,
+                    False,
+                    optimizer=optimizer,
+                    conversationally=conversationally,
+                )
+            )
+
+        return for_stream() if stream else for_non_stream()
+
+    def get_message(self, response: dict) -> str:
+        """Retrieves message only from response
+
+        Args:
+            response (dict): Response generated by `self.ask`
+
+        Returns:
+            str: Message extracted
+        """
+        assert isinstance(response, dict), "Response should be of dict data-type only"
         return response["text"]