webscout 8.2.2__py3-none-any.whl → 2026.1.19__py3-none-any.whl

webscout/Provider/AISEARCH/webpilotai_search.py

@@ -1,281 +1,242 @@
-import requests
-import json
-import re
-from typing import Dict, Optional, Generator, Union, Any
-
-from webscout.AIbase import AISearch
-from webscout import exceptions
-from webscout.litagent import LitAgent
-
-
-class Response:
-    """A wrapper class for webpilotai 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 webpilotai(AISearch):
-    """A class to interact with the webpilotai (WebPilot) AI search API.
-    
-    webpilotai provides a web-based comprehensive search response interface that returns AI-generated 
-    responses with source references and related questions. It supports both streaming and
-    non-streaming responses.
-    
-    Basic Usage:
-        >>> from webscout import webpilotai
-        >>> ai = webpilotai()
-        >>> # 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 90.
-        proxies (dict, optional): Proxy configuration for requests. Defaults to None.
-    """
-
-    def __init__(
-        self,
-        timeout: int = 90,
-        proxies: Optional[dict] = None,
-    ):
-        """Initialize the webpilotai API client.
-        
-        Args:
-            timeout (int, optional): Request timeout in seconds. Defaults to 90.
-            proxies (dict, optional): Proxy configuration for requests. Defaults to None.
-        
-        Example:
-            >>> ai = webpilotai(timeout=120)  # Longer timeout
-            >>> ai = webpilotai(proxies={'http': 'http://proxy.com:8080'})  # With proxy
-        """
-        self.session = requests.Session()
-        self.api_endpoint = "https://api.webpilotai.com/rupee/v1/search"
-        self.timeout = timeout
-        self.last_response = {}
-        
-        # The 'Bearer null' is part of the API's expected headers
-        self.headers = {
-            'Accept': 'application/json, text/plain, */*, text/event-stream',
-            'Content-Type': 'application/json;charset=UTF-8',
-            'Authorization': 'Bearer null',
-            'Origin': 'https://www.webpilot.ai',
-            'Referer': 'https://www.webpilot.ai/',
-            'User-Agent': LitAgent().random(),
-        }
-        
-        self.session.headers.update(self.headers)
-        self.proxies = proxies
-
-    def search(
-        self,
-        prompt: str,
-        stream: bool = False,
-        raw: bool = False,
-    ) -> Union[Response, Generator[Union[Dict[str, str], Response], None, None]]:
-        """Search using the webpilotai API and get AI-generated responses.
-        
-        This method sends a search query to webpilotai 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[Response, Generator[Union[Dict[str, str], Response], None, None]]: 
-                - If stream=False: Returns complete response as Response object
-                - If stream=True: Yields response chunks as either Dict or Response objects
-        
-        Raises:
-            APIConnectionError: If the API request fails
-        
-        Examples:
-            Basic search:
-            >>> ai = webpilotai()
-            >>> 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!'}
-        """
-        payload = {
-            "q": prompt,
-            "threadId": ""  # Empty for new search
-        }
-        
-        def for_stream():
-            full_response_content = ""
-            current_event_name = None
-            current_data_buffer = []
-            
-            try:
-                with self.session.post(
-                    self.api_endpoint,
-                    json=payload,
-                    stream=True,
-                    timeout=self.timeout,
-                    proxies=self.proxies
-                ) as response:
-                    if not response.ok:
-                        raise exceptions.APIConnectionError(
-                            f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
-                        )
-                    
-                    # Process the stream line by line
-                    for line in response.iter_lines(decode_unicode=True):
-                        if not line:  # Empty line indicates end of an event
-                            if current_data_buffer:
-                                # Process the completed event
-                                full_data = "\n".join(current_data_buffer)
-                                if current_event_name == "message":
-                                    try:
-                                        data_payload = json.loads(full_data)
-                                        # Check structure based on the API response
-                                        if data_payload.get('type') == 'data':
-                                            content_chunk = data_payload.get('data', {}).get('content', "")
-                                            if content_chunk:
-                                                full_response_content += content_chunk
-                                                
-                                                # Yield the new content chunk
-                                                if raw:
-                                                    yield {"text": content_chunk}
-                                                else:
-                                                    yield Response(content_chunk)
-                                    except json.JSONDecodeError:
-                                        pass
-                                    except Exception as e:
-                                        # Handle exceptions gracefully in stream processing
-                                        pass
-                                
-                                # Reset for the next event
-                                current_event_name = None
-                                current_data_buffer = []
-                            continue
-                        
-                        # Parse SSE fields
-                        if line.startswith('event:'):
-                            current_event_name = line[len('event:'):].strip()
-                        elif line.startswith('data:'):
-                            data_part = line[len('data:'):]
-                            # Remove leading space if present (common in SSE)
-                            if data_part.startswith(' '):
-                                data_part = data_part[1:]
-                            current_data_buffer.append(data_part)
-                    
-                    # Process any remaining data in buffer if stream ended without blank line
-                    if current_data_buffer and current_event_name == "message":
-                        try:
-                            full_data = "\n".join(current_data_buffer)
-                            data_payload = json.loads(full_data)
-                            if data_payload.get('type') == 'data':
-                                content_chunk = data_payload.get('data', {}).get('content', "")
-                                if content_chunk and len(content_chunk) > len(full_response_content):
-                                    delta = content_chunk[len(full_response_content):]
-                                    full_response_content += delta
-                                    
-                                    if raw:
-                                        yield {"text": delta}
-                                    else:
-                                        yield Response(delta)
-                        except (json.JSONDecodeError, Exception):
-                            pass
-                
-            except requests.exceptions.Timeout:
-                raise exceptions.APIConnectionError("Request timed out")
-            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 raw:
-                    yield chunk
-                else:
-                    full_response += str(chunk)
-            
-            if not raw:
-                # Format the response for better readability
-                formatted_response = self.format_response(full_response)
-                self.last_response = Response(formatted_response)
-                return self.last_response
-
-        return for_stream() if stream else for_non_stream()
-    
-    @staticmethod
-    def format_response(text: str) -> str:
-        """Format the response text for better readability.
-        
-        Args:
-            text (str): The raw response text
-        
-        Returns:
-            str: Formatted text with improved structure
-        """
-        # Clean up formatting
-        # Remove excessive newlines
-        clean_text = re.sub(r'\n{3,}', '\n\n', text)
-        
-        # Ensure consistent spacing around sections
-        clean_text = re.sub(r'([.!?])\s*\n\s*([A-Z])', r'\1\n\n\2', clean_text)
-        
-        # Clean up any leftover HTML or markdown artifacts
-        clean_text = re.sub(r'<[^>]*>', '', clean_text)
-        
-        # Remove trailing whitespace on each line
-        clean_text = '\n'.join(line.rstrip() for line in clean_text.split('\n'))
-        
-        return clean_text.strip()
-
-
-if __name__ == "__main__":
-    from rich import print
-    
-    ai = webpilotai()
-    response = ai.search(input(">>> "), stream=True, raw=False)
-    for chunk in response:
-        print(chunk, end="", flush=True)
+import re
+from typing import Any, Dict, Generator, List, Optional, Union, cast
+
+import requests
+
+from webscout import exceptions
+from webscout.AIbase import AISearch, SearchResponse
+from webscout.litagent import LitAgent
+from webscout.sanitize import sanitize_stream
+
+
+class webpilotai(AISearch):
+    """A class to interact with the webpilotai (WebPilot) AI search API.
+
+    webpilotai provides a web-based comprehensive search SearchResponse interface that returns AI-generated
+    SearchResponses with source references and related questions. It supports both streaming and
+    non-streaming SearchResponses.
+
+    Basic Usage:
+        >>> from webscout import webpilotai
+        >>> ai = webpilotai()
+        >>> # 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 SearchResponse 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 90.
+        proxies (dict, optional): Proxy configuration for requests. Defaults to None.
+    """
+
+    def __init__(
+        self,
+        timeout: int = 90,
+        proxies: Optional[dict] = None,
+    ):
+        """Initialize the webpilotai API client.
+
+        Args:
+            timeout (int, optional): Request timeout in seconds. Defaults to 90.
+            proxies (dict, optional): Proxy configuration for requests. Defaults to None.
+        """
+        self.session = requests.Session()
+        self.api_endpoint = "https://api.webpilotai.com/rupee/v1/search"
+        self.timeout = timeout
+        self.last_response = {}
+
+        # The 'Bearer null' is part of the API's expected headers
+        self.headers = {
+            'Accept': 'application/json, text/plain, */*, text/event-stream',
+            'Content-Type': 'application/json;charset=UTF-8',
+            'Authorization': 'Bearer null',
+            'Origin': 'https://www.webpilot.ai',
+            'Referer': 'https://www.webpilot.ai/',
+            'User-Agent': LitAgent().random(),
+        }
+
+        self.session.headers.update(self.headers)
+        self.proxies = proxies
+
+    def search(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        **kwargs: Any,
+    ) -> Union[SearchResponse, Generator[Union[Dict[str, str], SearchResponse], None, None], List[Any], Dict[str, Any], str]:
+        """Search using the webpilotai API and get AI-generated SearchResponses.
+
+        This method sends a search query to webpilotai and returns the AI-generated SearchResponse.
+        It supports both streaming and non-streaming modes, as well as raw SearchResponse format.
+
+        Args:
+            prompt (str): The search query or prompt to send to the API.
+            stream (bool, optional): If True, yields SearchResponse chunks as they arrive.
+                                   If False, returns complete SearchResponse. Defaults to False.
+            raw (bool, optional): If True, returns raw SearchResponse dictionaries with 'text' key.
+                                If False, returns SearchResponse objects that convert to text automatically.
+                                Defaults to False.
+
+        Returns:
+            Union[SearchResponse, Generator[Union[Dict[str, str], SearchResponse], None, None]]:
+                - If stream=False: Returns complete SearchResponse as SearchResponse object
+                - If stream=True: Yields SearchResponse chunks as either Dict or SearchResponse objects
+
+        Raises:
+            APIConnectionError: If the API request fails
+        """
+        payload = {
+            "q": prompt,
+            "threadId": ""  # Empty for new search
+        }
+
+        # We'll use regex-based extraction for WebPilot events. The sanitizer will:
+        #  - skip lines that are not "type":"data" events using skip_regexes
+        #  - extract the "content" value using a regex that handles escaped quotes
+        # The regex used below for extract_regexes is: r'"content"\s*:\s*"((?:\\.|[^"\\])*)"'
+        # which captures the content string while allowing escaped characters such as \".
+
+        def for_stream():
+
+            try:
+                with self.session.post(
+                    self.api_endpoint,
+                    json=payload,
+                    stream=True,
+                    timeout=self.timeout,
+                    proxies=self.proxies
+                ) as response:
+                    if not response.ok:
+                        raise exceptions.APIConnectionError(
+                            f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
+                        )
+
+                    processed_chunks = sanitize_stream(
+                        data=response.iter_content(chunk_size=1024),
+                        to_json=True,
+                        # Extract content from parsed JSON payload similar to Monica
+                        content_extractor=lambda chunk: (
+                            ((chunk.get("data") or {}).get("content") if isinstance(chunk, dict) else None)
+                            or ((chunk.get("data") or {}).get("text") if isinstance(chunk, dict) else None)
+                            or ((chunk.get("data") or {}).get("delta", {}).get("content") if isinstance(chunk, dict) else None)
+                        ),
+                        skip_markers=["event:message"],
+                        yield_raw_on_error=False,
+                        encoding='utf-8',
+                        encoding_errors='replace',
+                        line_delimiter="\n",
+                        raw=raw,
+                        output_formatter=None if raw else lambda x: SearchResponse(x) if isinstance(x, str) else x,
+                    )
+
+                    for chunk in processed_chunks:
+                        yield chunk
+
+            except requests.exceptions.Timeout:
+                raise exceptions.APIConnectionError("Request timed out")
+            except requests.exceptions.RequestException as e:
+                raise exceptions.APIConnectionError(f"Request failed: {e}")
+
+        def for_non_stream():
+            try:
+                with self.session.post(
+                    self.api_endpoint,
+                    json=payload,
+                    stream=False,
+                    timeout=self.timeout,
+                    proxies=self.proxies,
+                ) as response:
+                    if not response.ok:
+                        raise exceptions.APIConnectionError(
+                            f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
+                        )
+
+                    if raw:
+                        return response.text
+
+                    # Process full response payload using sanitize_stream similar to streaming path
+                    processed_chunks = sanitize_stream(
+                        data=response.content,
+                        intro_value="",
+                        to_json=True,
+                        strip_chars=None,
+                        start_marker=None,
+                        end_marker=None,
+                        content_extractor=lambda chunk: (
+                            ((chunk.get("data") or {}).get("content") if isinstance(chunk, dict) else None)
+                            or ((chunk.get("data") or {}).get("text") if isinstance(chunk, dict) else None)
+                            or ((chunk.get("data") or {}).get("delta", {}).get("content") if isinstance(chunk, dict) else None)
+                        ),
+                        skip_markers=["event:message"],
+                        yield_raw_on_error=False,
+                        encoding='utf-8',
+                        encoding_errors='replace',
+                        buffer_size=8192,
+                        output_formatter=lambda x: SearchResponse(x) if isinstance(x, str) else x,
+                    )
+
+                    full_response = ""
+                    for content_chunk in processed_chunks:
+                        if content_chunk is not None and isinstance(content_chunk, str):
+                            full_response += content_chunk
+
+                    formatted_response = self.format_SearchResponse(full_response)
+                    self.last_response = SearchResponse(formatted_response)
+                    return self.last_response
+
+            except requests.exceptions.RequestException as e:
+                raise exceptions.APIConnectionError(f"Request failed: {e}")
+
+        if stream:
+            return for_stream()
+        else:
+            return for_non_stream()
+
+    @staticmethod
+    def format_SearchResponse(text: str) -> str:
+        """Format the SearchResponse text for better readability.
+
+        Args:
+            text (str): The raw SearchResponse text
+
+        Returns:
+            str: Formatted text with improved structure
+        """
+        # Clean up formatting
+        # Remove excessive newlines
+        clean_text = re.sub(r'\n{3,}', '\n\n', text)
+
+        # Ensure consistent spacing around sections
+        clean_text = re.sub(r'([.!?])\s*\n\s*([A-Z])', r'\1\n\n\2', clean_text)
+
+        # Clean up any leftover HTML or markdown artifacts
+        clean_text = re.sub(r'<[^>]*>', '', clean_text)
+
+        # Remove trailing whitespace on each line
+        clean_text = '\n'.join(line.rstrip() for line in clean_text.split('\n'))
+
+        return clean_text.strip()
+
+
+if __name__ == "__main__":
+    from rich import print
+
+    ai = webpilotai()
+    resp = ai.search("webscout python package details", stream=True, raw=False)
+    if hasattr(resp, "__iter__") and not isinstance(resp, (str, SearchResponse)):
+        for chunk in resp:
+            print(chunk, end="", flush=True)
+    else:
+        print(resp)