webscout 6.8__py3-none-any.whl → 7.0__py3-none-any.whl

webscout/Provider/AISEARCH/felo_search.py

@@ -2,30 +2,91 @@ import re
 import requests
 from uuid import uuid4
 import json
-from webscout.AIutel import Optimizers
-from webscout.AIutel import Conversation
-from webscout.AIutel import AwesomePrompts, sanitize_stream
-from webscout.AIbase import Provider, AsyncProvider
+from typing import Any, Dict, Generator, Optional
+
+from webscout.AIbase import AISearch
 from webscout import exceptions
-from typing import Any, AsyncGenerator, Dict
+from webscout import LitAgent
+
+
+class Response:
+    """A wrapper class for Felo API responses.
+    
+    This class automatically converts response objects to their text representation
+    when printed or converted to string.
+    
+    Attributes:
+        text (str): The text content of the response
+        
+    Example:
+        >>> response = Response("Hello, world!")
+        >>> print(response)
+        Hello, world!
+        >>> str(response)
+        'Hello, world!'
+    """
+    def __init__(self, text: str):
+        self.text = text
+    
+    def __str__(self):
+        return self.text
+    
+    def __repr__(self):
+        return self.text
 
 
-class Felo(Provider):
+class Felo(AISearch):
+    """A class to interact with the Felo AI search API.
+    
+    Felo provides a powerful search interface that returns AI-generated responses
+    based on web content. It supports both streaming and non-streaming responses.
+    
+    Basic Usage:
+        >>> from webscout import Felo
+        >>> ai = Felo()
+        >>> # Non-streaming example
+        >>> response = ai.search("What is Python?")
+        >>> print(response)
+        Python is a high-level programming language...
+        
+        >>> # Streaming example
+        >>> for chunk in ai.search("Tell me about AI", stream=True):
+        ...     print(chunk, end="", flush=True)
+        Artificial Intelligence is...
+        
+        >>> # Raw response format
+        >>> for chunk in ai.search("Hello", stream=True, raw=True):
+        ...     print(chunk)
+        {'text': 'Hello'}
+        {'text': ' there!'}
+    
+    Args:
+        timeout (int, optional): Request timeout in seconds. Defaults to 30.
+        proxies (dict, optional): Proxy configuration for requests. Defaults to None.
+    
+    Attributes:
+        api_endpoint (str): The Felo API endpoint URL.
+        stream_chunk_size (int): Size of chunks when streaming responses.
+        timeout (int): Request timeout in seconds.
+        headers (dict): HTTP headers used in requests.
+    """
+
     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,
+        proxies: Optional[dict] = None,
     ):
+        """Initialize the Felo API client.
+        
+        Args:
+            timeout (int, optional): Request timeout in seconds. Defaults to 30.
+            proxies (dict, optional): Proxy configuration for requests. Defaults to None.
+        
+        Example:
+            >>> ai = Felo(timeout=60)  # Longer timeout
+            >>> ai = Felo(proxies={'http': 'http://proxy.com:8080'})  # With proxy
+        """
         self.session = requests.Session()
-        self.is_conversation = is_conversation
-        self.max_tokens_to_sample = max_tokens
         self.chat_endpoint = "https://api.felo.ai/search/threads"
         self.stream_chunk_size = 64
         self.timeout = timeout
@@ -45,50 +106,64 @@ class Felo(Provider):
             "sec-fetch-dest": "empty",
             "sec-fetch-mode": "cors",
             "sec-fetch-site": "same-site",
-            "user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36 Edg/127.0.0.0"
+            "user-agent": LitAgent().random()
         }
-
-        self.__available_optimizers = (
-            method
-            for method in dir(Optimizers)
-            if callable(getattr(Optimizers, method)) and not method.startswith("__")
-        )
         self.session.headers.update(self.headers)
-        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
+        self.proxies = proxies
 
-    def ask(
+    def search(
         self,
         prompt: str,
         stream: bool = False,
         raw: bool = False,
-        optimizer: str = None,
-        conversationally: bool = False,
-    ) -> dict:
-        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}"
-                )
-
-        self.session.headers.update(self.headers)
+    ) -> Dict[str, Any] | Generator[str, None, None]:
+        """Search using the Felo API and get AI-generated responses.
+        
+        This method sends a search query to Felo and returns the AI-generated response.
+        It supports both streaming and non-streaming modes, as well as raw response format.
+        
+        Args:
+            prompt (str): The search query or prompt to send to the API.
+            stream (bool, optional): If True, yields response chunks as they arrive.
+                                   If False, returns complete response. Defaults to False.
+            raw (bool, optional): If True, returns raw response dictionaries with 'text' key.
+                                If False, returns Response objects that convert to text automatically.
+                                Defaults to False.
+        
+        Returns:
+            Union[Dict[str, Any], Generator[str, None, None]]: 
+                - If stream=False: Returns complete response
+                - If stream=True: Yields response chunks as they arrive
+        
+        Raises:
+            APIConnectionError: If the API request fails
+        
+        Examples:
+            Basic search:
+            >>> ai = Felo()
+            >>> response = ai.search("What is Python?")
+            >>> print(response)
+            Python is a programming language...
+            
+            Streaming response:
+            >>> for chunk in ai.search("Tell me about AI", stream=True):
+            ...     print(chunk, end="")
+            Artificial Intelligence...
+            
+            Raw response format:
+            >>> for chunk in ai.search("Hello", stream=True, raw=True):
+            ...     print(chunk)
+            {'text': 'Hello'}
+            {'text': ' there!'}
+            
+            Error handling:
+            >>> try:
+            ...     response = ai.search("My question")
+            ... except exceptions.APIConnectionError as e:
+            ...     print(f"API error: {e}")
+        """
         payload = {
-            "query": conversation_prompt,
+            "query": prompt,
             "search_uuid": uuid4().hex,
             "lang": "",
             "agent_lang": "en",
@@ -100,81 +175,55 @@ class Felo(Provider):
         }
 
         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}"
-                )
+            try:
+                with self.session.post(
+                    self.chat_endpoint,
+                    json=payload,
+                    stream=True,
+                    timeout=self.timeout,
+                ) as response:
+                    if not response.ok:
+                        raise exceptions.APIConnectionError(
+                            f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
+                        )
 
-            streaming_text = ""
-            for line in response.iter_lines(decode_unicode=True):
-                if line.startswith('data:'):
-                    try:
-                        data = json.loads(line[5:].strip())
-                        if data['type'] == 'answer' and 'text' in data['data']:
-                            new_text = data['data']['text']
-                            if len(new_text) > len(streaming_text):
-                                delta = new_text[len(streaming_text):]
-                                streaming_text = new_text
-                                resp = dict(text=delta)
-                                self.last_response.update(dict(text=streaming_text))
-                                yield line if raw else resp
-                    except json.JSONDecodeError:
-                        pass
-            
-            self.conversation.update_chat_history(
-                prompt, self.get_message(self.last_response)
-            )
+                    streaming_text = ""
+                    for line in response.iter_lines(decode_unicode=True):
+                        if line.startswith('data:'):
+                            try:
+                                data = json.loads(line[5:].strip())
+                                if data['type'] == 'answer' and 'text' in data['data']:
+                                    new_text = data['data']['text']
+                                    if len(new_text) > len(streaming_text):
+                                        delta = new_text[len(streaming_text):]
+                                        streaming_text = new_text
+                                        if raw:
+                                            yield {"text": delta}
+                                        else:
+                                            yield Response(delta)
+                            except json.JSONDecodeError:
+                                pass
+                    self.last_response = Response(streaming_text)
+            except requests.exceptions.RequestException as e:
+                raise exceptions.APIConnectionError(f"Request failed: {e}")
 
         def for_non_stream():
             full_response = ""
             for chunk in for_stream():
-                if not raw:
-                    full_response += chunk['text']
-            self.last_response = dict(text=full_response)
-            return self.last_response
-
+                if raw:
+                    yield chunk
+                else:
+                    full_response += str(chunk)
+            if not raw:
+                self.last_response = Response(full_response)
+                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:
-        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:
-        assert isinstance(response, dict), "Response should be of dict data-type only"
-
-        if "text" in response:
-            text = re.sub(r'\[\[\d+\]\]', '', response["text"])
-            return text
-        else:
-            return ""  
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     from rich import print
     ai = Felo()
-    response = ai.chat("tell me about Abhay koul, HelpingAI", stream=True)
+    response = ai.search(input(">>> "), stream=True, raw=False)
     for chunk in response:
         print(chunk, end="", flush=True)

webscout/Provider/Blackboxai.py

@@ -41,7 +41,7 @@ class BLACKBOXAI:
         self.session = requests.Session()
         self.max_tokens_to_sample = max_tokens
         self.is_conversation = is_conversation
-        self.chat_endpoint = "https://www.blackbox.ai/api/chat"
+        self.chat_endpoint = "https://api.blackbox.ai/api/chat"
         self.stream_chunk_size = 64
         self.timeout = timeout
         self.last_response = {}

webscout/Provider/Glider.py

@@ -0,0 +1,207 @@
+import requests
+import json
+from typing import Any, Dict, Generator, Optional
+
+from webscout.AIutel import Optimizers
+from webscout.AIutel import Conversation
+from webscout.AIutel import AwesomePrompts
+from webscout.AIbase import Provider
+from webscout import exceptions
+from webscout import LitAgent as Lit
+class GliderAI(Provider):
+    """
+    A class to interact with the Glider.so API.
+    """
+
+    AVAILABLE_MODELS = [
+        "chat-llama-3-1-70b",
+        "chat-llama-3-1-8b",
+        "chat-llama-3-2-3b",
+        "deepseek-ai/DeepSeek-R1",
+    ]
+
+    model_aliases = {
+        "llama-3.1-70b": "chat-llama-3-1-70b",
+        "llama-3.1-8b": "chat-llama-3-1-8b",
+        "llama-3.2-3b": "chat-llama-3-2-3b",
+        "deepseek-r1": "deepseek-ai/DeepSeek-R1",
+    }
+
+
+    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,
+        model: str = "llama-3.1-70b",
+        system_prompt: str = "You are a helpful AI assistant.",
+    ):
+        """Initializes the GliderAI API client."""
+        if model not in self.AVAILABLE_MODELS and model not in self.model_aliases:
+            raise ValueError(f"Invalid model: {model}. Choose from: {', '.join(self.AVAILABLE_MODELS)}")
+        self.session = requests.Session()
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_tokens
+        self.api_endpoint = "https://glider.so/api/chat"
+        self.stream_chunk_size = 64
+        self.timeout = timeout
+        self.last_response = {}
+        self.model = self.model_aliases.get(model,model)
+        self.system_prompt = system_prompt
+        self.headers = {
+            "accept": "*/*",
+            "accept-language": "en-US,en;q=0.9",
+            "content-type": "application/json",
+            "origin": "https://glider.so",
+            "referer": "https://glider.so/",
+            "user-agent": Lit().random(),
+        }
+        self.session.headers.update(self.headers)
+        self.session.proxies = proxies
+
+        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
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> Dict[str, Any] | Generator:
+        """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
+        {
+            "text" : "How may I assist 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 = {
+            "messages": [
+                {"role": "user", "content": conversation_prompt},
+                {"role": "system", "content": self.system_prompt}
+            ],
+            "model": self.model,
+        }
+
+        def for_stream():
+            response = self.session.post(
+                self.api_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}"
+                )
+
+            streaming_text = ""
+            for value in response.iter_lines(decode_unicode=True):
+                if value:
+                    if value.startswith("data: "):
+                        try:
+                            data = json.loads(value[6:])
+                            content = data['choices'][0].get('delta', {}).get("content", "")
+                            if content:
+                                streaming_text += content
+                                yield content if raw else dict(text=content)
+                        except json.JSONDecodeError:
+                             if "stop" in value :
+                                 break
+                            
+            self.last_response.update(dict(text=streaming_text))
+            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 | Generator[str, None, None]:
+        """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"""
+        assert isinstance(response, dict), "Response should be of dict data-type only"
+        return response["text"]
+
+
+if __name__ == "__main__":
+    from rich import print
+    ai = GliderAI(model="llama-3.1-70b")
+    response = ai.chat("Meaning of Life", stream=True)
+    for chunk in response:
+        print(chunk, end="", flush=True)