webscout 5.0__tar.gz → 5.2__tar.gz

{webscout-5.0/webscout.egg-info → webscout-5.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 5.0
-Summary: Search for anything using Google, DuckDuckGo, brave, qwant,  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 and more
+Version: 5.2
+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 and more
 Author: OEvortex
 Author-email: helpingai5@gmail.com
 License: HelpingAI
@@ -66,6 +66,8 @@ Requires-Dist: requests_html
 Requires-Dist: bson
 Requires-Dist: cloudscraper
 Requires-Dist: emoji
+Requires-Dist: colorlog
+Requires-Dist: openai
 Provides-Extra: dev
 Requires-Dist: ruff>=0.1.6; extra == "dev"
 Requires-Dist: pytest>=7.4.2; extra == "dev"
@@ -404,7 +406,7 @@ for result in results:
 from webscout import BingS
 from rich import print
 searcher = BingS()
-results = searcher.search("Python development tools", max_results=30)
+results = searcher.search("HelpingAI-9B", max_results=20, extract_webpage_text=True, max_extract_characters=1000)
 for result in results:
     print(result)
 ```
@@ -903,14 +905,34 @@ print(result)
 ___
 </details>
 
-## usage of webscout AI
-### 0. `Duckchat` - chat with LLM
+###  Text to images - DeepInfraImager, PollinationsAI
+```python
+from webscout import DeepInfraImager
+bot = DeepInfraImager()
+resp = bot.generate("AI-generated image - webscout", 1)
+print(bot.save(resp))
+```
+
+### Text to Speach - Voicepods, StreamElements
+```python
+from webscout import Voicepods
+voicepods = Voicepods()
+text = "Hello, this is a test of the Voicepods text-to-speech"
+
+print("Generating audio...")
+audio_file = voicepods.tts(text)
+
+print("Playing audio...")
+voicepods.play_audio(audio_file)
+```
+
+###  `Duckchat` - chat with LLM
 ```python
 from webscout import WEBS as w
 R = w().chat("Who are you", model='gpt-4o-mini') # GPT-3.5 Turbo, mixtral-8x7b, llama-3-70b, claude-3-haiku, gpt-4o-mini
 print(R)
 ```
-### 1. `PhindSearch` - Search using Phind.com 
+###  `PhindSearch` - Search using Phind.com 
 
 ```python
 from webscout import PhindSearch
@@ -947,7 +969,7 @@ print(message)
 ```
 
 
-### . `You.com` - search/chat with you.com - Not working
+### `You.com` - search/chat with you.com - Not working
 ```python
 
 from webscout import YouChat
@@ -974,7 +996,7 @@ message = ai.get_message(response)
 print(message)
 ```
 
-### . `Gemini` - search with google gemini
+### `Gemini` - search with google gemini
 
 ```python
 import webscout
@@ -992,7 +1014,7 @@ gemini = GEMINI(cookie_file=COOKIE_FILE, proxy=PROXIES)
 response = gemini.chat("websearch about HelpingAI and who is its developer")
 print(response)
 ```
-### . `Berlin4h` - chat with Berlin4h
+### `Berlin4h` - chat with Berlin4h
 ```python
 from webscout import Berlin4h
 
@@ -1013,7 +1035,7 @@ prompt = "Explain the concept of recursion in simple terms."
 response = ai.chat(prompt)
 print(response)
 ```
-### . `BlackBox` - Search/chat With BlackBox
+###  `BlackBox` - Search/chat With BlackBox
 ```python
 from webscout import BLACKBOXAI
 from rich import print
@@ -1044,7 +1066,7 @@ while True:
     r = ai.chat(prompt)
     print(r)
 ```
-### . `PERPLEXITY` - Search With PERPLEXITY
+###  `PERPLEXITY` - Search With PERPLEXITY
 ```python
 from webscout import Perplexity
 from rich import print
@@ -1470,7 +1492,7 @@ if "error" not in function_call_data:
 else:
     print(f"Error: {function_call_data['error']}")
 ```
-###  LLAMA3, pizzagpt, RUBIKSAI, Koala, Darkai, AI4Chat, Farfalle, PIAI, Felo, XDASH, Julius, YouChat, YEPCHAT, Cloudflare, TurboSeek,
+###  LLAMA3, pizzagpt, RUBIKSAI, Koala, Darkai, AI4Chat, Farfalle, PIAI, Felo, XDASH, Julius, YouChat, YEPCHAT, Cloudflare, TurboSeek, NetFly, Editee
 code similar to other provider
 ### `LLM` 
 ```python
@@ -1645,15 +1667,13 @@ gguf.convert(
 
 Webscout's `autollama` utility download model from huggingface and then automatically makes it ollama ready
 
-**Example:**
-
 ```python
 from webscout import autollama
 
-autollama(
-    model_path="OEvortex/HelpingAI-Lite-1.5T",  # Hugging Face model ID
-    gguf_file="HelpingAI-Lite-1.5T.q4_k_m.gguf" #  GGUF file ID
-)
+model_path = "Vortex4ai/Jarvis-0.5B"
+gguf_file = "test2-q4_k_m.gguf"
+
+autollama.main(model_path, gguf_file)  
 ```
 
 **Command Line Usage:**

{webscout-5.0 → webscout-5.2}/README.md

@@ -327,7 +327,7 @@ for result in results:
 from webscout import BingS
 from rich import print
 searcher = BingS()
-results = searcher.search("Python development tools", max_results=30)
+results = searcher.search("HelpingAI-9B", max_results=20, extract_webpage_text=True, max_extract_characters=1000)
 for result in results:
     print(result)
 ```
@@ -826,14 +826,34 @@ print(result)
 ___
 </details>
 
-## usage of webscout AI
-### 0. `Duckchat` - chat with LLM
+###  Text to images - DeepInfraImager, PollinationsAI
+```python
+from webscout import DeepInfraImager
+bot = DeepInfraImager()
+resp = bot.generate("AI-generated image - webscout", 1)
+print(bot.save(resp))
+```
+
+### Text to Speach - Voicepods, StreamElements
+```python
+from webscout import Voicepods
+voicepods = Voicepods()
+text = "Hello, this is a test of the Voicepods text-to-speech"
+
+print("Generating audio...")
+audio_file = voicepods.tts(text)
+
+print("Playing audio...")
+voicepods.play_audio(audio_file)
+```
+
+###  `Duckchat` - chat with LLM
 ```python
 from webscout import WEBS as w
 R = w().chat("Who are you", model='gpt-4o-mini') # GPT-3.5 Turbo, mixtral-8x7b, llama-3-70b, claude-3-haiku, gpt-4o-mini
 print(R)
 ```
-### 1. `PhindSearch` - Search using Phind.com 
+###  `PhindSearch` - Search using Phind.com 
 
 ```python
 from webscout import PhindSearch
@@ -870,7 +890,7 @@ print(message)
 ```
 
 
-### . `You.com` - search/chat with you.com - Not working
+### `You.com` - search/chat with you.com - Not working
 ```python
 
 from webscout import YouChat
@@ -897,7 +917,7 @@ message = ai.get_message(response)
 print(message)
 ```
 
-### . `Gemini` - search with google gemini
+### `Gemini` - search with google gemini
 
 ```python
 import webscout
@@ -915,7 +935,7 @@ gemini = GEMINI(cookie_file=COOKIE_FILE, proxy=PROXIES)
 response = gemini.chat("websearch about HelpingAI and who is its developer")
 print(response)
 ```
-### . `Berlin4h` - chat with Berlin4h
+### `Berlin4h` - chat with Berlin4h
 ```python
 from webscout import Berlin4h
 
@@ -936,7 +956,7 @@ prompt = "Explain the concept of recursion in simple terms."
 response = ai.chat(prompt)
 print(response)
 ```
-### . `BlackBox` - Search/chat With BlackBox
+###  `BlackBox` - Search/chat With BlackBox
 ```python
 from webscout import BLACKBOXAI
 from rich import print
@@ -967,7 +987,7 @@ while True:
     r = ai.chat(prompt)
     print(r)
 ```
-### . `PERPLEXITY` - Search With PERPLEXITY
+###  `PERPLEXITY` - Search With PERPLEXITY
 ```python
 from webscout import Perplexity
 from rich import print
@@ -1393,7 +1413,7 @@ if "error" not in function_call_data:
 else:
     print(f"Error: {function_call_data['error']}")
 ```
-###  LLAMA3, pizzagpt, RUBIKSAI, Koala, Darkai, AI4Chat, Farfalle, PIAI, Felo, XDASH, Julius, YouChat, YEPCHAT, Cloudflare, TurboSeek,
+###  LLAMA3, pizzagpt, RUBIKSAI, Koala, Darkai, AI4Chat, Farfalle, PIAI, Felo, XDASH, Julius, YouChat, YEPCHAT, Cloudflare, TurboSeek, NetFly, Editee
 code similar to other provider
 ### `LLM` 
 ```python
@@ -1568,15 +1588,13 @@ gguf.convert(
 
 Webscout's `autollama` utility download model from huggingface and then automatically makes it ollama ready
 
-**Example:**
-
 ```python
 from webscout import autollama
 
-autollama(
-    model_path="OEvortex/HelpingAI-Lite-1.5T",  # Hugging Face model ID
-    gguf_file="HelpingAI-Lite-1.5T.q4_k_m.gguf" #  GGUF file ID
-)
+model_path = "Vortex4ai/Jarvis-0.5B"
+gguf_file = "test2-q4_k_m.gguf"
+
+autollama.main(model_path, gguf_file)  
 ```
 
 **Command Line Usage:**

{webscout-5.0 → webscout-5.2}/setup.py

@@ -5,8 +5,8 @@ with open("README.md", encoding="utf-8") as f:
 
 setup(
     name="webscout",
-    version="5.0",
-    description="Search for anything using Google, DuckDuckGo, brave, qwant,  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 and more",
+    version="5.2",
+    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 and more",
     long_description=README,
     long_description_content_type="text/markdown",
     author="OEvortex",
@@ -69,7 +69,9 @@ setup(
         "requests_html",
         "bson",
         "cloudscraper",
-        "emoji"
+        "emoji",
+        "colorlog",
+        "openai",
     ],
     entry_points={
         "console_scripts": [

webscout-5.2/webscout/AIauto.py

@@ -0,0 +1,362 @@
+from webscout.AIbase import Provider, AsyncProvider
+from webscout.Provider.ThinkAnyAI import ThinkAnyAI
+from webscout.Provider.Llama import LLAMA
+
+from webscout.Provider.Koboldai import KOBOLDAI
+from webscout.Provider.Koboldai import AsyncKOBOLDAI
+
+from webscout.Provider.Perplexity import Perplexity
+from webscout.Provider.Blackboxai import BLACKBOXAI
+from webscout.Provider.Blackboxai import AsyncBLACKBOXAI
+from webscout.Provider.Phind import PhindSearch
+from webscout.Provider.Phind import AsyncPhindSearch
+from webscout.Provider.Phind import Phindv2
+from webscout.Provider.Phind import AsyncPhindv2
+from webscout.Provider.yep import YEPCHAT
+from webscout.Provider.Berlin4h import Berlin4h
+from webscout.Provider.Poe import POE
+from webscout.Provider.BasedGPT import BasedGPT
+from webscout.Provider.Deepseek import DeepSeek
+from webscout.Provider.Deepinfra import DeepInfra, VLM, AsyncDeepInfra
+from webscout.Provider.OLLAMA import OLLAMA
+from webscout.Provider.Andi import AndiSearch
+from webscout.Provider.Llama3 import LLAMA3
+from webscout.Provider.DARKAI import DARKAI
+from webscout.Provider.koala import KOALA
+from webscout.Provider.RUBIKSAI import RUBIKSAI
+from webscout.Provider.meta import Meta
+from webscout.Provider.liaobots import LiaoBots
+from webscout.Provider.DiscordRocks import DiscordRocks
+from webscout.Provider.felo_search import Felo
+from webscout.Provider.xdash import XDASH
+from webscout.Provider.julius import Julius
+from webscout.Provider.Youchat import YouChat
+from webscout.Provider.Cloudflare import Cloudflare
+from webscout.Provider.turboseek import TurboSeek
+from webscout.Provider.NetFly import NetFly
+from webscout.Provider.EDITEE import Editee
+# from webscout.Provider.Chatify import Chatify # TODO: UNFINISHED
+from webscout.Provider.PI import PiAI 
+from webscout.g4f import GPT4FREE, AsyncGPT4FREE
+from webscout.g4f import TestProviders
+from webscout.exceptions import AllProvidersFailure
+from typing import AsyncGenerator
+
+from typing import Union
+from typing import Any
+import logging
+
+
+provider_map: dict[
+    str,
+    Union[
+        ThinkAnyAI,
+        LLAMA,
+        KOBOLDAI,
+        Perplexity,
+        BLACKBOXAI,
+        PhindSearch,
+        Phindv2,
+        YEPCHAT,
+        Berlin4h,
+        POE,
+        BasedGPT,
+        DeepSeek,
+        DeepInfra,
+        VLM,
+        GPT4FREE,
+        OLLAMA,
+        AndiSearch,
+        LLAMA3,
+        DARKAI,
+        KOALA,
+        RUBIKSAI,
+        Meta,
+        LiaoBots,
+        DiscordRocks,
+        Felo,
+        XDASH,
+        Julius,
+        YouChat,
+        Cloudflare,
+        TurboSeek,
+        NetFly,
+        Editee,
+        # Chatify,
+        PiAI,
+    ],
+] = {
+    "ThinkAnyAI": ThinkAnyAI,
+    "LLAMA2": LLAMA,
+    "KOBOLDAI": KOBOLDAI,
+    "PERPLEXITY": Perplexity,
+    "BLACKBOXAI": BLACKBOXAI,
+    "PhindSearch": PhindSearch,
+    "Phindv2": Phindv2,
+    "YEPCHAT": YEPCHAT,
+    "Berlin4h": Berlin4h,
+    "POE": POE,
+    "BasedGPT": BasedGPT,
+    "DeepSeek": DeepSeek,
+    "DeepInfra": DeepInfra,
+    "VLM": VLM,
+    "gpt4free": GPT4FREE,
+    "ollama": OLLAMA,
+    "andi": AndiSearch,
+    "llama3": LLAMA3,
+    "darkai": DARKAI,
+    "koala": KOALA,
+    "rubiksai": RUBIKSAI,
+    "meta": Meta,
+    "liaobots": LiaoBots,
+    "discordrocks": DiscordRocks,
+    "felo": Felo,
+    "xdash": XDASH,
+    "julius": Julius,
+    "you": YouChat,
+    "cloudflare": Cloudflare,
+    "turboseek": TurboSeek,
+    "netfly": NetFly,
+    "editee": Editee,
+    # "chatify": Chatify,
+    "pi": PiAI,
+}
+
+
+class AUTO(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,
+        exclude: list[str] = [],
+    ):
+        """Instantiates AUTO
+
+        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.
+            exclude(list[str], optional): List of providers to be excluded. Defaults to [].
+        """
+        self.provider: Union[
+            ThinkAnyAI,
+            LLAMA,
+            KOBOLDAI,
+            Perplexity,
+            BLACKBOXAI,
+            PhindSearch,
+            Phindv2,
+            YEPCHAT,
+            Berlin4h,
+            POE,
+            BasedGPT,
+            DeepSeek,
+            DeepInfra,
+            VLM,
+            GPT4FREE,
+            OLLAMA,
+            AndiSearch,
+            LLAMA3,
+            DARKAI,
+            KOALA,
+            RUBIKSAI,
+            Meta,
+            LiaoBots,
+            DiscordRocks,
+            Felo,
+            XDASH,
+            Julius,
+            YouChat,
+            Cloudflare,
+            TurboSeek,
+            NetFly,
+            Editee,
+            # Chatify,
+            PiAI,
+        ] = None
+        self.provider_name: str = None
+        self.is_conversation = is_conversation
+        self.max_tokens = max_tokens
+        self.timeout = timeout
+        self.intro = intro
+        self.filepath = filepath
+        self.update_file = update_file
+        self.proxies = proxies
+        self.history_offset = history_offset
+        self.act = act
+        self.exclude = exclude
+
+    @property
+    def last_response(self) -> dict[str, Any]:
+        return self.provider.last_response
+
+    @property
+    def conversation(self) -> object:
+        return self.provider.conversation
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+        run_new_test: 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.
+            run_new_test (bool, optional): Perform new test on g4f-based providers. Defaults to False.
+        Returns:
+           dict : {}
+        """
+        ask_kwargs: dict[str, Union[str, bool]] = {
+            "prompt": prompt,
+            "stream": stream,
+            "raw": raw,
+            "optimizer": optimizer,
+            "conversationally": conversationally,
+        }
+
+        # webscout-based providers
+        for provider_name, provider_obj in provider_map.items():
+            # continue
+            if provider_name in self.exclude:
+                continue
+            try:
+                self.provider_name = f"webscout-{provider_name}"
+                self.provider = provider_obj(
+                    is_conversation=self.is_conversation,
+                    max_tokens=self.max_tokens,
+                    timeout=self.timeout,
+                    intro=self.intro,
+                    filepath=self.filepath,
+                    update_file=self.update_file,
+                    proxies=self.proxies,
+                    history_offset=self.history_offset,
+                    act=self.act,
+                )
+
+                def for_stream():
+                    for chunk in self.provider.ask(**ask_kwargs):
+                        yield chunk
+
+                def for_non_stream():
+                    return self.provider.ask(**ask_kwargs)
+
+                return for_stream() if stream else for_non_stream()
+
+            except Exception as e:
+                logging.debug(
+                    f"Failed to generate response using provider {provider_name} - {e}"
+                )
+
+        # g4f-based providers
+
+        for provider_info in TestProviders(timeout=self.timeout).get_results(
+            run=run_new_test
+        ):
+            if provider_info["name"] in self.exclude:
+                continue
+            try:
+                self.provider_name = f"g4f-{provider_info['name']}"
+                self.provider = GPT4FREE(
+                    provider=provider_info["name"],
+                    is_conversation=self.is_conversation,
+                    max_tokens=self.max_tokens,
+                    intro=self.intro,
+                    filepath=self.filepath,
+                    update_file=self.update_file,
+                    proxies=self.proxies,
+                    history_offset=self.history_offset,
+                    act=self.act,
+                )
+
+                def for_stream():
+                    for chunk in self.provider.ask(**ask_kwargs):
+                        yield chunk
+
+                def for_non_stream():
+                    return self.provider.ask(**ask_kwargs)
+
+                return for_stream() if stream else for_non_stream()
+
+            except Exception as e:
+                logging.debug(
+                    f"Failed to generate response using GPT4FREE-base provider {provider_name} - {e}"
+                )
+
+        raise AllProvidersFailure(
+            "None of the providers generated response successfully."
+        )
+
+    def chat(
+        self,
+        prompt: str,
+        stream: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+        run_new_test: 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.
+            run_new_test (bool, optional): Perform new test on g4f-based providers. Defaults to False.
+        Returns:
+            str: Response generated
+        """
+
+        def for_stream():
+            for response in self.ask(
+                prompt,
+                True,
+                optimizer=optimizer,
+                conversationally=conversationally,
+                run_new_test=run_new_test,
+            ):
+                yield self.get_message(response)
+
+        def for_non_stream():
+            ask_response = self.ask(
+                prompt,
+                False,
+                optimizer=optimizer,
+                conversationally=conversationally,
+                run_new_test=run_new_test,
+            )
+            return self.get_message(ask_response)
+
+        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 self.provider is not None, "Chat with AI first"
+        return self.provider.get_message(response)