webscout 2.4__tar.gz → 2.6__tar.gz

{webscout-2.4 → webscout-2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 2.4
+Version: 2.6
 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
@@ -50,7 +50,8 @@ Requires-Dist: appdirs
 Requires-Dist: GoogleBard1>=2.1.4
 Requires-Dist: tls_client
 Requires-Dist: clipman
-Requires-Dist: Helpingai-T2playsound
+Requires-Dist: Helpingai-T2
+Requires-Dist: playsound
 Provides-Extra: dev
 Requires-Dist: ruff>=0.1.6; extra == "dev"
 Requires-Dist: pytest>=7.4.2; extra == "dev"
@@ -134,6 +135,7 @@ Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can
     - [13. `ThinkAny` - AI search engine](#13-thinkany---ai-search-engine)
     - [14. `chatgptuk` - Chat with gemini-pro](#14-chatgptuk---chat-with-gemini-pro)
     - [`LLM`](#llm)
+    - [`Local-LLM` webscout can now run GGUF models](#local-llm-webscout-can-now-run-gguf-models)
     - [`LLM` with internet](#llm-with-internet)
     - [LLM with deepwebs](#llm-with-deepwebs)
   - [`Webai` - terminal gpt and a open interpeter](#webai---terminal-gpt-and-a-open-interpeter)
@@ -1224,6 +1226,26 @@ while True:
     # Print the response
     print("AI: ", response)
 ```
+### `Local-LLM` webscout can now run GGUF models
+```python
+from webscout.Local.utils import download_model
+from webscout.Local.model import Model
+from webscout.Local.thread import Thread
+from webscout.Local import formats
+# 1. Download the model
+repo_id = "microsoft/Phi-3-mini-4k-instruct-gguf"  # Replace with the desired Hugging Face repo
+filename = "Phi-3-mini-4k-instruct-q4.gguf" # Replace with the correct filename
+model_path = download_model(repo_id, filename)
+
+# 2. Load the model 
+model = Model(model_path, n_gpu_layers=4)  
+
+# 3. Create a Thread for conversation
+thread = Thread(model, formats.phi3)
+
+# 4. Start interacting with the model
+thread.interact()
+```
 ### `LLM` with internet
 ```python
 from __future__ import annotations

{webscout-2.4 → webscout-2.6}/README.md

@@ -73,6 +73,7 @@ Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can
     - [13. `ThinkAny` - AI search engine](#13-thinkany---ai-search-engine)
     - [14. `chatgptuk` - Chat with gemini-pro](#14-chatgptuk---chat-with-gemini-pro)
     - [`LLM`](#llm)
+    - [`Local-LLM` webscout can now run GGUF models](#local-llm-webscout-can-now-run-gguf-models)
     - [`LLM` with internet](#llm-with-internet)
     - [LLM with deepwebs](#llm-with-deepwebs)
   - [`Webai` - terminal gpt and a open interpeter](#webai---terminal-gpt-and-a-open-interpeter)
@@ -1163,6 +1164,26 @@ while True:
     # Print the response
     print("AI: ", response)
 ```
+### `Local-LLM` webscout can now run GGUF models
+```python
+from webscout.Local.utils import download_model
+from webscout.Local.model import Model
+from webscout.Local.thread import Thread
+from webscout.Local import formats
+# 1. Download the model
+repo_id = "microsoft/Phi-3-mini-4k-instruct-gguf"  # Replace with the desired Hugging Face repo
+filename = "Phi-3-mini-4k-instruct-q4.gguf" # Replace with the correct filename
+model_path = download_model(repo_id, filename)
+
+# 2. Load the model 
+model = Model(model_path, n_gpu_layers=4)  
+
+# 3. Create a Thread for conversation
+thread = Thread(model, formats.phi3)
+
+# 4. Start interacting with the model
+thread.interact()
+```
 ### `LLM` with internet
 ```python
 from __future__ import annotations

{webscout-2.4 → webscout-2.6}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", encoding="utf-8") as f:
 
 setup(
     name="webscout",
-    version="2.4",
+    version="2.6",
     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",
@@ -54,7 +54,7 @@ setup(
         "GoogleBard1>=2.1.4",
         "tls_client",
         "clipman",
-        "Helpingai-T2"
+        "Helpingai-T2",
         "playsound",
     ],
     entry_points={

{webscout-2.4 → webscout-2.6}/webscout/AIutel.py

@@ -26,27 +26,27 @@ default_path = appdir.user_cache_dir
 if not os.path.exists(default_path):
     os.makedirs(default_path)
 webai = [
-    "leo",
-    "openai",
-    "opengpt",
-    "koboldai",
-    "gemini",
-    "phind",
-    "blackboxai",
-    "g4fauto",
-    "perplexity",
-    "groq",
-    "reka",
-    "cohere",
-    "yepchat",
-    "you",
-    "xjai",
-    "thinkany",
-    "berlin4h",
-    "chatgptuk",
-    "auto",
+   "leo",
+   "openai",
+   "opengpt",
+   "koboldai",
+   "gemini",
+   "phind",
+   "blackboxai",
+   "g4fauto",
+   "perplexity",
+   "groq",
+   "reka",
+   "cohere",
+   "yepchat",
+   "you",
+   "xjai",
+   "thinkany",
+   "berlin4h",
+   "chatgptuk",
+   "auto",
+   "poe",
 ]
-
 gpt4free_providers = [
     provider.__name__ for provider in g4f.Provider.__providers__  # if provider.working
 ]

{webscout-2.4 → webscout-2.6}/webscout/Local/_version.py

@@ -1,3 +1,3 @@
 from llama_cpp import __version__ as __llama_cpp_version__
 
-__version__ = '2.3'
+__version__ = '2.6'

{webscout-2.4 → webscout-2.6}/webscout/Local/formats.py

@@ -45,19 +45,6 @@ alpaca: dict[str, Union[str, list]] = {
     "bot_postfix": "\n\n",
     "stops": ['###', 'Instruction:', '\n\n\n']
 }
-
-# https://docs.mistral.ai/models/
-# As a reference, here is the format used to tokenize instructions during fine-tuning:
-# ```
-# [START_SYMBOL_ID] + 
-# tok("[INST]") + tok(USER_MESSAGE_1) + tok("[/INST]") +
-# tok(BOT_MESSAGE_1) + [END_SYMBOL_ID] +
-# …
-# tok("[INST]") + tok(USER_MESSAGE_N) + tok("[/INST]") +
-# tok(BOT_MESSAGE_N) + [END_SYMBOL_ID]
-# ```
-# In the pseudo-code above, note that the tokenize method should not add a BOS or EOS token automatically, but should add a prefix space.
-
 mistral_instruct: dict[str, Union[str, list]] = {
     "system_prefix": "",
     "system_content": "",

{webscout-2.4 → webscout-2.6}/webscout/Local/thread.py

@@ -570,7 +570,7 @@ class Thread:
         
         while True:
 
-            prompt = f"{RESET_ALL}  > {USER_STYLE}"
+            prompt = f"{RESET_ALL}  >>> {USER_STYLE}"
             
             try:
                 user_prompt, next_message_start = self._interactive_input(

webscout-2.6/webscout/Provider/Poe.py

@@ -0,0 +1,208 @@
+from poe_api_wrapper import PoeApi
+from poe_api_wrapper.api import BOTS_LIST
+from ..AIbase import Provider
+from ..AIutel import Conversation
+from ..AIutel  import Optimizers
+from ..AIutel  import AwesomePrompts
+from pathlib import Path
+from json import loads
+from json import dumps
+from loguru import logger
+import logging
+
+logger.remove()
+
+
+class POE(Provider):
+    def __init__(
+        self,
+        cookie: str,
+        model: str = "Assistant",
+        proxy: bool = False,
+        timeout: int = 30,
+        filepath: str = None,
+        update_file: str = True,
+        intro: str = None,
+        act: str = None,
+        init: bool = True,
+    ):
+        """Initializes POE
+
+        Args:
+            cookie (str): Path to `poe.com.cookies.json` file or 'p-b' cookie-value.
+            model (str, optional): Model name. Default to Assistant.
+            proxy (bool, optional): Flag for Httpx request proxy. Defaults to False.
+            timeout (int, optional): Http request timeout. Defaults to 30.
+            filepath (str, optional): Path to save the chat history. Defaults to None.
+            update_file (str, optional): Flag for controlling chat history updates. Defaults to True.
+            intro (str, optional): Conversation introductory prompt. Defaults to None.
+            act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
+            init (bool, optional): Resend the intro prompt. Defaults to True.
+        """
+        assert isinstance(
+            cookie, str
+        ), f"Cookie must be of {str} datatype only not {type(cookie)}"
+        assert (
+            model in BOTS_LIST.keys()
+        ), f"model name '{model}' is not one of {', '.join(list(BOTS_LIST.keys()))}"
+        cookie_path = Path(cookie)
+
+        if cookie_path.exists() or any(["/" in cookie, ".json" in cookie]):
+            cookie = None
+            all_cookies = loads(cookie_path.read_text())
+            for entry in all_cookies:
+                if entry["name"] == "p-b":
+                    cookie = entry["value"]
+            assert (
+                cookie
+            ), f'Required cookie value cannot be retrieved from the path  "{cookie_path.as_posix()}"'
+
+        if proxy:
+            import poe_api_wrapper.proxies as proxies
+
+            proxies.PROXY = True
+
+        self.bot = BOTS_LIST[model]
+        self.session = PoeApi(cookie)
+        self.last_response = {}
+        self.__available_optimizers = (
+            method
+            for method in dir(Optimizers)
+            if callable(getattr(Optimizers, method)) and not method.startswith("__")
+        )
+        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(
+            status=False, filepath=filepath, update_file=update_file
+        )
+        if init:
+            self.ask(self.conversation.intro)  # Init
+
+    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]`. Defeaults to None
+                conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
+            Returns:
+               dict : {}
+        ```json
+        {
+            "id": "TWVzc2FnZToxMTU0MzgyNDQ1ODU=",
+            "messageId": 115438244585,
+            "creationTime": 1707777376544407,
+            "clientNonce": null,
+            "state": "complete",
+            "text": "Hello! How can I assist you today?",
+            "author": "capybara",
+            "contentType": "text_markdown",
+            "sourceType": "chat_input",
+            "attachmentTruncationState": "not_truncated",
+            "attachments": [],
+            "vote": null,
+            "suggestedReplies": [],
+            "hasCitations": false,
+            "__isNode": "Message",
+            "textLengthOnCancellation": null,
+            "chatCode": "21a2jn0yrq9phxiy478",
+            "chatId": 328236777,
+            "title": null,
+            "response": ""
+        }
+        ```
+        """
+        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}"
+                )
+
+        def for_stream():
+            for response in self.session.send_message(self.bot, conversation_prompt):
+                if raw:
+                    yield dumps(response)
+                else:
+                    yield response
+
+                self.last_response.update(response)
+
+            self.conversation.update_chat_history(
+                prompt,
+                self.get_message(self.last_response),
+                force=True,
+            )
+
+        def for_non_stream():
+            # let's make use of 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"]

{webscout-2.4 → webscout-2.6}/webscout/Provider/__init__.py

@@ -27,7 +27,7 @@ from .Youchat import YouChat
 from .Gemini import GEMINI
 from .Berlin4h import Berlin4h
 from .ChatGPTUK import ChatGPTUK
-
+from .Poe import POE
 __all__ = [
     'ThinkAnyAI',
     'Xjai',
@@ -56,4 +56,5 @@ __all__ = [
     'GEMINI',
     'Berlin4h',
     'ChatGPTUK',
+    'POE'
 ]

{webscout-2.4 → webscout-2.6}/webscout/__init__.py

@@ -9,35 +9,7 @@ from .LLM import LLM
 # from .Local import *
 import g4f
 # Import provider classes for direct access
-from .Provider import (
-   ThinkAnyAI,
-   Xjai,
-   LLAMA2, 
-   AsyncLLAMA2,
-   Cohere,
-   REKA,
-   GROQ,
-   AsyncGROQ,
-   OPENAI,
-   AsyncOPENAI,
-   LEO,
-   AsyncLEO,
-   KOBOLDAI,
-   AsyncKOBOLDAI,
-   OPENGPT,
-   AsyncOPENGPT,
-   PERPLEXITY,
-   BLACKBOXAI,
-   AsyncBLACKBOXAI,
-   PhindSearch,
-   AsyncPhindSearch,
-   YEPCHAT,
-   AsyncYEPCHAT,
-   YouChat,
-   GEMINI,
-   Berlin4h,
-   ChatGPTUK,
-)
+from .Provider import *
 
 __repo__ = "https://github.com/OE-LUCIFER/Webscout"
 
@@ -61,6 +33,7 @@ webai = [
    "berlin4h",
    "chatgptuk",
    "auto",
+   "poe",
 ]
 
 gpt4free_providers = [
@@ -113,6 +86,7 @@ __all__ = [
    "GEMINI",
    "Berlin4h",
    "ChatGPTUK",
+   "POE"
 ]
 
 import logging

{webscout-2.4 → webscout-2.6}/webscout/webai.py

@@ -413,7 +413,23 @@ class Main(cmd.Cmd):
                         "No working g4f provider found. "
                         "Consider running 'webscout gpt4free test -y' first"
                     )
+            elif provider == "poe":
+                assert auth, (
+                    "Path to poe.com.cookies.json file or 'p-b' cookie-value is required. "
+                    "Use the flag `--key` or `-k`"
+                )
+                from webscout import POE
 
+                self.bot = POE(
+                    cookie=auth,
+                    model=getOr(model, "Assistant"),
+                    proxy=bool(proxies),
+                    timeout=timeout,
+                    filepath=filepath,
+                    update_file=update_file,
+                    intro=intro,
+                    act=awesome_prompt,
+                )
             elif provider == "leo":
                 from webscout import LEO
 

{webscout-2.4 → webscout-2.6}/webscout.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 2.4
+Version: 2.6
 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
@@ -50,7 +50,8 @@ Requires-Dist: appdirs
 Requires-Dist: GoogleBard1>=2.1.4
 Requires-Dist: tls_client
 Requires-Dist: clipman
-Requires-Dist: Helpingai-T2playsound
+Requires-Dist: Helpingai-T2
+Requires-Dist: playsound
 Provides-Extra: dev
 Requires-Dist: ruff>=0.1.6; extra == "dev"
 Requires-Dist: pytest>=7.4.2; extra == "dev"
@@ -134,6 +135,7 @@ Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can
     - [13. `ThinkAny` - AI search engine](#13-thinkany---ai-search-engine)
     - [14. `chatgptuk` - Chat with gemini-pro](#14-chatgptuk---chat-with-gemini-pro)
     - [`LLM`](#llm)
+    - [`Local-LLM` webscout can now run GGUF models](#local-llm-webscout-can-now-run-gguf-models)
     - [`LLM` with internet](#llm-with-internet)
     - [LLM with deepwebs](#llm-with-deepwebs)
   - [`Webai` - terminal gpt and a open interpeter](#webai---terminal-gpt-and-a-open-interpeter)
@@ -1224,6 +1226,26 @@ while True:
     # Print the response
     print("AI: ", response)
 ```
+### `Local-LLM` webscout can now run GGUF models
+```python
+from webscout.Local.utils import download_model
+from webscout.Local.model import Model
+from webscout.Local.thread import Thread
+from webscout.Local import formats
+# 1. Download the model
+repo_id = "microsoft/Phi-3-mini-4k-instruct-gguf"  # Replace with the desired Hugging Face repo
+filename = "Phi-3-mini-4k-instruct-q4.gguf" # Replace with the correct filename
+model_path = download_model(repo_id, filename)
+
+# 2. Load the model 
+model = Model(model_path, n_gpu_layers=4)  
+
+# 3. Create a Thread for conversation
+thread = Thread(model, formats.phi3)
+
+# 4. Start interacting with the model
+thread.interact()
+```
 ### `LLM` with internet
 ```python
 from __future__ import annotations

{webscout-2.4 → webscout-2.6}/webscout.egg-info/SOURCES.txt

@@ -59,6 +59,7 @@ webscout/Provider/OpenGPT.py
 webscout/Provider/Openai.py
 webscout/Provider/Perplexity.py
 webscout/Provider/Phind.py
+webscout/Provider/Poe.py
 webscout/Provider/Reka.py
 webscout/Provider/ThinkAnyAI.py
 webscout/Provider/Xjai.py

{webscout-2.4 → webscout-2.6}/webscout.egg-info/requires.txt

@@ -24,7 +24,8 @@ appdirs
 GoogleBard1>=2.1.4
 tls_client
 clipman
-Helpingai-T2playsound
+Helpingai-T2
+playsound
 
 [dev]
 ruff>=0.1.6