webscout 1.3.8__py3-none-any.whl → 1.4.0__py3-none-any.whl

webscout/AIbase.py

@@ -3,7 +3,7 @@ from abc import abstractmethod
 
 
 class Provider(ABC):
-    """Base class for models class"""
+    """Base class for providers"""
 
     @abstractmethod
     def ask(
@@ -61,6 +61,74 @@ class Provider(ABC):
     def get_message(self, response: dict) -> str:
         """Retrieves message only from response
 
+        Args:
+            response (dict): Response generated by `self.ask`
+
+        Returns:
+            str: Message extracted
+        """
+        raise NotImplementedError("Method needs to be implemented in subclass")
+
+
+class AsyncProvider(ABC):
+    """Asynchronous base class for providers"""
+
+    @abstractmethod
+    async def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> dict:
+        """Asynchronously chat with AI
+
+        Args:
+            prompt (str): Prompt to be sent
+            stream (bool, optional): Flag for streaming response. Defaults to False.
+            raw (bool, optional): Stream back raw response as received
+            optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`
+            conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
+        Returns:
+           dict : {}
+        ```json
+        {
+            "completion": "\nNext: domestic cat breeds with short hair >>",
+            "stop_reason": null,
+            "truncated": false,
+            "stop": null,
+            "model": "llama-2-13b-chat",
+            "log_id": "cmpl-3kYiYxSNDvgMShSzFooz6t",
+            "exception": null
+        }
+        ```
+        """
+        raise NotImplementedError("Method needs to be implemented in subclass")
+
+    @abstractmethod
+    async def chat(
+        self,
+        prompt: str,
+        stream: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> str:
+        """Asynchronously generate response `str`
+        Args:
+            prompt (str): Prompt to be sent
+            stream (bool, optional): Flag for streaming response. Defaults to False.
+            optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`
+            conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
+        Returns:
+            str: Response generated
+        """
+        raise NotImplementedError("Method needs to be implemented in subclass")
+
+    @abstractmethod
+    async def get_message(self, response: dict) -> str:
+        """Asynchronously retrieves message only from response
+
         Args:
             response (dict): Response generated by `self.ask`
 

webscout/AIutel.py

@@ -34,10 +34,10 @@ webai = [
     "blackboxai",
     "g4fauto",
     "perplexity",
-    "sean",
     "groq",
     "reka",
-    "cohere"
+    "cohere",
+    "yepchat",
 ]
 
 gpt4free_providers = [
@@ -45,7 +45,24 @@ gpt4free_providers = [
 ]
 
 available_providers = webai + gpt4free_providers
+def sanitize_stream(
+    chunk: str, intro_value: str = "data:", to_json: bool = True
+) -> str | dict:
+    """Remove streaming flags
 
+    Args:
+        chunk (str): Streamig chunk.
+        intro_value (str, optional): streaming flag. Defaults to "data:".
+        to_json (bool, optional). Return chunk as dictionary. Defaults to True.
+
+    Returns:
+        str: Sanitized streaming value.
+    """
+
+    if chunk.startswith(intro_value):
+        chunk = chunk[len(intro_value) :]
+
+    return json.loads(chunk) if to_json else chunk
 def run_system_command(
     command: str,
     exit_on_error: bool = True,

webscout/__init__.py

@@ -24,10 +24,10 @@ webai = [
     "blackboxai",
     "g4fauto",
     "perplexity",
-    "sean",
     "groq",
     "reka",
-    "cohere"
+    "cohere",
+    "yepchat",
 ]
 
 gpt4free_providers = [

webscout/async_providers.py

@@ -0,0 +1,33 @@
+from webscout.AI import AsyncPhindSearch
+from webscout.AI import AsyncYEPCHAT
+from webscout.AI import AsyncOPENGPT
+from webscout.AI import AsyncOPENAI
+from webscout.AI import AsyncLLAMA2
+from webscout.AI import AsyncLEO
+from webscout.AI import AsyncKOBOLDAI
+from webscout.AI import AsyncGROQ
+from webscout.AI import AsyncBLACKBOXAI
+from webscout.AI import AsyncGPT4FREE
+
+mapper: dict[str, object] = {
+    "phind": AsyncPhindSearch,
+    "opengpt": AsyncOPENGPT,
+    "koboldai": AsyncKOBOLDAI,
+    "blackboxai": AsyncBLACKBOXAI,
+    "gpt4free": AsyncGPT4FREE,
+    "llama2": AsyncLLAMA2,
+    "yepchat": AsyncYEPCHAT,
+    "leo": AsyncLEO,
+    "groq": AsyncGROQ,
+    "openai": AsyncOPENAI,
+}
+
+tgpt_mapper: dict[str, object] = {
+    "phind": AsyncPhindSearch,
+    "opengpt": AsyncOPENGPT,
+    "koboldai": AsyncKOBOLDAI,
+    # "gpt4free": AsyncGPT4FREE,
+    "blackboxai": AsyncBLACKBOXAI,
+    "llama2": AsyncLLAMA2,
+    "yepchat": AsyncYEPCHAT,
+}

webscout/exceptions.py

@@ -7,4 +7,7 @@ class RatelimitE(Exception):
 
 
 class TimeoutE(Exception):
-    """Raised for timeout errors during API requests."""
+    """Raised for timeout errors during API requests."""
+    
+class FailedToGenerateResponseError(Exception):
+    """Provider failed to fetch response"""

webscout/g4f.py

@@ -2,7 +2,7 @@ import g4f
 from webscout.AIutel import Optimizers
 from webscout.AIutel import Conversation
 from webscout.AIutel import AwesomePrompts
-from webscout.AIbase import Provider
+from webscout.AIbase import Provider, AsyncProvider
 from webscout.AIutel import available_providers
 
 
@@ -26,7 +26,199 @@ default_models = {
 
 default_provider = "Koala"
 
+class AsyncGPT4FREE(AsyncProvider):
+    def __init__(
+        self,
+        provider: str = default_provider,
+        is_conversation: bool = True,
+        auth: str = None,
+        max_tokens: int = 600,
+        model: str = None,
+        ignore_working: bool = False,
+        timeout: int = 30,
+        intro: str = None,
+        filepath: str = None,
+        update_file: bool = True,
+        proxies: dict = {},
+        history_offset: int = 10250,
+        act: str = None,
+    ):
+        """Initialies GPT4FREE
+
+        Args:
+            provider (str, optional): gpt4free based provider name. Defaults to Koala.
+            is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
+            auth (str, optional): Authentication value for the provider incase it needs. Defaults to None.
+            max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 600.
+            model (str, optional): LLM model name. Defaults to text-davinci-003|gpt-3.5-turbo.
+            ignore_working (bool, optional): Ignore working status of the provider. Defaults to False.
+            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.
+        """
+        assert provider in available_providers, (
+            f"Provider '{provider}' is not yet supported. "
+            f"Try others like {', '.join(available_providers)}"
+        )
+        if model is None:
+            model = default_models["chat_completion"]
+
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_tokens
+        self.stream_chunk_size = 64
+        self.timeout = timeout
+        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(
+            is_conversation,
+            self.max_tokens_to_sample,
+            filepath,
+            update_file,
+        )
+        self.conversation.history_offset = history_offset
+        self.model = model
+        self.provider = provider
+        self.ignore_working = ignore_working
+        self.auth = auth
+        self.proxy = None if not proxies else list(proxies.values())[0]
+
+    def __str__(self):
+        return f"AsyncGPTFREE(provider={self.provider})"
+
+    async def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> dict | AsyncGenerator:
+        """Chat with AI asynchronously.
 
+        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|AsyncGenerator : ai content
+        ```json
+        {
+          "text" : "How may I help you today?"
+        }
+        ```
+        """
+        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 = dict(
+            model=self.model,
+            provider=self.provider,  # g4f.Provider.Aichat,
+            messages=[{"role": "user", "content": conversation_prompt}],
+            stream=True,
+            ignore_working=self.ignore_working,
+            auth=self.auth,
+            proxy=self.proxy,
+            timeout=self.timeout,
+        )
+
+        async def format_response(response):
+            return dict(text=response)
+
+        async def for_stream():
+            previous_chunks = ""
+            response = g4f.ChatCompletion.create_async(**payload)
+
+            async for chunk in response:
+                previous_chunks += chunk
+                formatted_resp = await format_response(previous_chunks)
+                self.last_response.update(formatted_resp)
+                yield previous_chunks if raw else formatted_resp
+
+            self.conversation.update_chat_history(
+                prompt,
+                previous_chunks,
+            )
+
+        async def for_non_stream():
+            async for _ in for_stream():
+                pass
+            return self.last_response
+
+        return for_stream() if stream else await for_non_stream()
+
+    async def chat(
+        self,
+        prompt: str,
+        stream: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> dict | AsyncGenerator:
+        """Generate response `str` asynchronously.
+        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|AsyncGenerator: Response generated
+        """
+
+        async def for_stream():
+            async_ask = await self.ask(
+                prompt, True, optimizer=optimizer, conversationally=conversationally
+            )
+            async for response in async_ask:
+                yield await self.get_message(response)
+
+        async def for_non_stream():
+            return await self.get_message(
+                await self.ask(
+                    prompt,
+                    False,
+                    optimizer=optimizer,
+                    conversationally=conversationally,
+                )
+            )
+
+        return for_stream() if stream else await for_non_stream()
+
+    async 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"]
 class GPT4FREE(Provider):
     def __init__(
         self,

webscout/version.py

@@ -1,2 +1,2 @@
-__version__ = "1.3.8"
+__version__ = "1.4.0"
 

webscout/webai.py

@@ -35,7 +35,6 @@ from colorama import Fore
 from colorama import init as init_colorama
 from dotenv import load_dotenv
 import g4f
-
 import webscout.AIutel
 
 init_colorama(autoreset=True)
@@ -472,6 +471,25 @@ class Main(cmd.Cmd):
                     history_offset=history_offset,
                     act=awesome_prompt,
                 )
+            elif provider == "yepchat":
+                from webscout.AI import YEPCHAT
+
+                self.bot = YEPCHAT(
+                    is_conversation=disable_conversation,
+                    max_tokens=max_tokens,
+                    temperature=temperature,
+                    presence_penalty=top_p,
+                    frequency_penalty=top_k,
+                    top_p=top_p,
+                    model=getOr(model, "Mixtral-8x7B-Instruct-v0.1"),
+                    timeout=timeout,
+                    intro=intro,
+                    filepath=filepath,
+                    update_file=update_file,
+                    proxies=proxies,
+                    history_offset=history_offset,
+                    act=awesome_prompt,
+                )
             elif provider == "groq":
                 assert auth, (
                     "GROQ's API-key is required. " "Use the flag `--key` or `-k`"
@@ -1135,7 +1153,7 @@ class EntryGroup:
     # @staticmethod
     @click.group()
     @click.version_option(
-        webscout.__version__, "-v", "--version", package_name="Webscout"
+        webscout.__version__, "-v", "--version", package_name="webscout"
     )
     @click.help_option("-h", "--help")
     def webai_():

{webscout-1.3.8.dist-info → webscout-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webscout
-Version: 1.3.8
+Version: 1.4.0
 Summary: Search for anything using the Google, DuckDuckGo.com, yep.com, phind.com, you.com, etc Also containes AI models, can transcribe yt videos, have TTS support and now has webai(terminal gpt and open interpeter) support
 Author: OEvortex
 Author-email: helpingai5@gmail.com
@@ -47,6 +47,8 @@ Requires-Dist: tiktoken
 Requires-Dist: tldextract
 Requires-Dist: orjson
 Requires-Dist: PyYAML
+Requires-Dist: appdirs
+Requires-Dist: GoogleBard1 >=2.1.4
 Provides-Extra: dev
 Requires-Dist: ruff >=0.1.6 ; extra == 'dev'
 Requires-Dist: pytest >=7.4.2 ; extra == 'dev'
@@ -89,7 +91,7 @@ Search for anything using the Google, DuckDuckGo.com, yep.com, phind.com, you.co
   - [usage of webscout.AI](#usage-of-webscoutai)
     - [1. `PhindSearch` - Search using Phind.com](#1-phindsearch---search-using-phindcom)
     - [2. `YepChat` - Chat with mistral 8x7b powered by yepchat](#2-yepchat---chat-with-mistral-8x7b-powered-by-yepchat)
-    - [3. `You.com` - search with you.com](#3-youcom---search-with-youcom)
+    - [3. `You.com` - search with you.com -NOT WORKING](#3-youcom---search-with-youcom--not-working)
     - [4. `Gemini` - search with google gemini](#4-gemini---search-with-google-gemini)
   - [usage of image generator from Webscout.AI](#usage-of-image-generator-from-webscoutai)
     - [5. `Prodia` - make image using prodia](#5-prodia---make-image-using-prodia)
@@ -97,11 +99,9 @@ Search for anything using the Google, DuckDuckGo.com, yep.com, phind.com, you.co
     - [7. `PERPLEXITY` - Search With PERPLEXITY](#7-perplexity---search-with-perplexity)
     - [8. `OpenGPT` - chat With OPENGPT](#8-opengpt---chat-with-opengpt)
     - [9. `KOBOLDIA` -](#9-koboldia--)
-    - [10. `Sean` - chat With Sean](#10-sean---chat-with-sean)
-    - [11. `Reka` - chat with reka](#11-reka---chat-with-reka)
-    - [12. `Cohere` - chat with cohere](#12-cohere---chat-with-cohere)
-  - [usage of special .LLM file from webscout (webscout.LLM)](#usage-of-special-llm-file-from-webscout-webscoutllm)
-    - [`LLM`](#llm)
+    - [10. `Reka` - chat with reka](#10-reka---chat-with-reka)
+    - [11. `Cohere` - chat with cohere](#11-cohere---chat-with-cohere)
+    - [`LLM` --not working](#llm---not-working)
     - [`LLM` with internet](#llm-with-internet)
   - [`Webai` - terminal gpt and a open interpeter](#webai---terminal-gpt-and-a-open-interpeter)
 
@@ -553,26 +553,22 @@ message = ph.get_message(response)
 print(message)
 ```
 ### 2. `YepChat` - Chat with mistral 8x7b powered by yepchat
-Thanks To Divyansh Shukla for This code
 ```python
-from webscout.AI import YepChat
+from webscout.AI import YEPCHAT
 
-def main():
-    # Initialize the YepChat class with your message
-    yep_chat = YepChat(message="who is pm of india")
-    
-    # Send the request and process the response
-    response = yep_chat.send_request()
-    processed_response = yep_chat.process_response(response)
-    
-    # Print the processed response
-    print(processed_response)
+# Instantiate the YEPCHAT class with default parameters
+YEPCHAT = YEPCHAT()
+
+# Define a prompt to send to the AI
+prompt = "What is the capital of France?"
+
+# Use the 'cha' method to get a response from the AI
+r = YEPCHAT.chat(prompt)
+print(r)
 
-if __name__ == "__main__":
-    main()
 ```
 
-### 3. `You.com` - search with you.com
+### 3. `You.com` - search with you.com -NOT WORKING
 ```python
 from webscout.AI import youChat
 
@@ -598,15 +594,34 @@ while True:
 ### 4. `Gemini` - search with google gemini
 
 ```python
-from webscout.AI import Gemini
+import webscout
+from webscout.AI import GEMINI
 
-# Create an instance of the Gemini class
-gemini = Gemini()
+# Replace with the path to your bard.google.com.cookies.json file
+COOKIE_FILE = "path/to/bard.google.com.cookies.json"
 
-# Use the chat method to send a message to the Gemini assistant
-response = gemini.chat("Your message here")
+# Optional: Provide proxy details if needed
+PROXIES = {
+    "http": "http://proxy_server:port",
+    "https": "https://proxy_server:port",
+}
 
-# Print the response from the Gemini assistant
+# Initialize GEMINI with cookie file and optional proxies
+gemini = GEMINI(cookie_file=COOKIE_FILE, proxy=PROXIES)
+
+# Ask a question and print the response
+response = gemini.chat("What is the meaning of life?")
+print(response)
+
+# Ask another question, this time streaming the response
+for chunk in gemini.chat("Tell me a story", stream=True):
+    print(chunk, end="")
+
+# Reset the conversation to start a new interaction
+gemini.reset()
+
+# Ask a question with the code optimizer
+response = gemini.chat("Write Python code to print 'Hello, world!'", optimizer="code")
 print(response)
 ```
 ##  usage of image generator from Webscout.AI
@@ -638,17 +653,18 @@ ai = BLACKBOXAI(
     model=None # You can specify a model if needed
 )
 
-# Define a prompt to send to the AI
-prompt = "Tell me about india"
-
-# Use the 'ask' method to send the prompt and receive a response
-response = ai.ask(prompt)
-
-# Extract the text from the response
-response_text = ai.get_message(response)
-
-# Print the response text
-print(response_text)
+# Start an infinite loop for continuous interaction
+while True:
+    # Define a prompt to send to the AI
+    prompt = input("Enter your prompt: ")
+    
+    # Check if the user wants to exit the loop
+    if prompt.lower() == "exit":
+        break
+    
+    # Use the 'chat' method to send the prompt and receive a response
+    r = ai.chat(prompt)
+    print(r)
 ```
 ### 7. `PERPLEXITY` - Search With PERPLEXITY
 ```python
@@ -666,10 +682,12 @@ print(response)
 from webscout.AI import OPENGPT
 
 opengpt = OPENGPT(is_conversation=True, max_tokens=8000, timeout=30)
-# This example sends a simple greeting and prints the response
-prompt = "tell me about india"
-response_str = opengpt.chat(prompt)
-print(response_str)
+while True:
+    # Prompt the user for input
+    prompt = input("Enter your prompt: ")
+    # Send the prompt to the OPENGPT model and print the response
+    response_str = opengpt.chat(prompt)
+    print(response_str)
 ```
 ### 9. `KOBOLDIA` - 
 ```python
@@ -688,19 +706,9 @@ response = koboldai.ask(prompt)
 message = koboldai.get_message(response)
 print(message)
 
-```
-### 10. `Sean` - chat With Sean
-```python
-from webscout.AI import Sean
-
-a = Sean(is_conversation=True, max_tokens=8000, timeout=30)
-# This example sends a simple greeting and prints the response
-prompt = "tell me about india"
-response_str = a.chat(prompt)
-print(response_str)
 ```
 
-### 11. `Reka` - chat with reka
+### 10. `Reka` - chat with reka
 ```python
 from webscout.AI import REKA
 
@@ -711,7 +719,7 @@ response_str = a.chat(prompt)
 print(response_str)
 ```
 
-### 12. `Cohere` - chat with cohere
+### 11. `Cohere` - chat with cohere
 ```python
 from webscout.AI import Cohere
 
@@ -721,9 +729,8 @@ prompt = "tell me about india"
 response_str = a.chat(prompt)
 print(response_str)
 ```
-## usage of special .LLM file from webscout (webscout.LLM)
 
-### `LLM`
+### `LLM` --not working
 ```python
 from webscout.LLM import LLM
 
@@ -844,7 +851,7 @@ def use_rawdog_with_webai(prompt):
             top_k=40,          
             top_p=0.95,        
             model="command-r-plus",  # Replace with your desired model
-            auth="0zoQbKs1AAgd8WrPBO9CTIGgVvm5ZMbDcCqJOVyl",     # Replace with your auth key/value (if needed)
+            auth=None,     # Replace with your auth key/value (if needed)
             timeout=30,
             disable_conversation=True,
             filepath=None,