webscout 7.8__py3-none-any.whl → 8.0__py3-none-any.whl

webscout/Provider/scira_chat.py

@@ -0,0 +1,271 @@
+import requests
+import json
+import uuid
+import re
+from typing import Any, Dict, Optional, Union
+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.litagent import LitAgent
+
+class SciraAI(Provider):
+    """
+    A class to interact with the Scira AI chat API.
+    """
+
+    AVAILABLE_MODELS = {
+        "scira-default": "Grok3",
+        "scira-grok-3-mini": "Grok3-mini", # thinking model
+        "scira-vision" : "Grok2-Vision", # vision model
+        "scira-claude": "Sonnet-3.7",
+        "scira-optimus": "optimus",
+
+    }
+
+    def __init__(
+        self,
+        is_conversation: bool = True,
+        max_tokens: int = 2049,
+        timeout: int = 30,
+        intro: str = None,
+        filepath: str = None,
+        update_file: bool = True,
+        proxies: dict = {},
+        history_offset: int = 10250,
+        act: str = None,
+        model: str = "scira-default",
+        chat_id: str = None,
+        user_id: str = None,
+        browser: str = "chrome"
+    ):
+        """Initializes the Scira AI API client.
+
+        Args:
+            is_conversation (bool): Whether to maintain conversation history.
+            max_tokens (int): Maximum number of tokens to generate.
+            timeout (int): Request timeout in seconds.
+            intro (str): Introduction text for the conversation.
+            filepath (str): Path to save conversation history.
+            update_file (bool): Whether to update the conversation history file.
+            proxies (dict): Proxy configuration for requests.
+            history_offset (int): Maximum history length in characters.
+            act (str): Persona for the AI to adopt.
+            model (str): Model to use, must be one of AVAILABLE_MODELS.
+            chat_id (str): Unique identifier for the chat session.
+            user_id (str): Unique identifier for the user.
+            browser (str): Browser to emulate in requests.
+
+        """
+        if model not in self.AVAILABLE_MODELS:
+            raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
+
+        self.url = "https://scira.ai/api/search"
+
+        # Initialize LitAgent for user agent generation
+        self.agent = LitAgent()
+        # Use fingerprinting to create a consistent browser identity
+        self.fingerprint = self.agent.generate_fingerprint(browser)
+
+        # Use the fingerprint for headers
+        self.headers = {
+            "Accept": self.fingerprint["accept"],
+            "Accept-Encoding": "gzip, deflate, br, zstd",
+            "Accept-Language": self.fingerprint["accept_language"],
+            "Content-Type": "application/json",
+            "Origin": "https://scira.ai",
+            "Referer": "https://scira.ai/",
+            "Sec-CH-UA": self.fingerprint["sec_ch_ua"] or '"Not)A;Brand";v="99", "Microsoft Edge";v="127", "Chromium";v="127"',
+            "Sec-CH-UA-Mobile": "?0",
+            "Sec-CH-UA-Platform": f'"{self.fingerprint["platform"]}"',
+            "User-Agent": self.fingerprint["user_agent"],
+            "Sec-Fetch-Dest": "empty",
+            "Sec-Fetch-Mode": "cors",
+            "Sec-Fetch-Site": "same-origin"
+        }
+
+        self.session = requests.Session()
+        self.session.headers.update(self.headers)
+        self.session.proxies.update(proxies)
+
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_tokens
+        self.timeout = timeout
+        self.last_response = {}
+        self.model = model
+        self.chat_id = chat_id or str(uuid.uuid4())
+        self.user_id = user_id or f"user_{str(uuid.uuid4())[:8].upper()}"
+
+        # Always use chat mode (no web search)
+        self.search_mode = "chat"
+
+        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 refresh_identity(self, browser: str = None):
+        """
+        Refreshes the browser identity fingerprint.
+
+        Args:
+            browser: Specific browser to use for the new fingerprint
+        """
+        browser = browser or self.fingerprint.get("browser_type", "chrome")
+        self.fingerprint = self.agent.generate_fingerprint(browser)
+
+        # Update headers with new fingerprint
+        self.headers.update({
+            "Accept": self.fingerprint["accept"],
+            "Accept-Language": self.fingerprint["accept_language"],
+            "Sec-CH-UA": self.fingerprint["sec_ch_ua"] or self.headers["Sec-CH-UA"],
+            "Sec-CH-UA-Platform": f'"{self.fingerprint["platform"]}"',
+            "User-Agent": self.fingerprint["user_agent"],
+        })
+
+        # Update session headers
+        for header, value in self.headers.items():
+            self.session.headers[header] = value
+
+        return self.fingerprint
+
+    def ask(
+        self,
+        prompt: str,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> Dict[str, Any]:
+        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}")
+
+        # Prepare the request payload
+        payload = {
+            "id": self.chat_id,
+            "messages": [
+                {
+                    "role": "user",
+                    "content": conversation_prompt,
+                    "parts": [{"type": "text", "text": conversation_prompt}]
+                }
+            ],
+            "model": self.model,
+            "group": "chat",  # Always use chat mode (no web search)
+            "user_id": self.user_id,
+            "timezone": "Asia/Calcutta"
+        }
+
+        try:
+            response = self.session.post(self.url, json=payload, timeout=self.timeout)
+            if response.status_code != 200:
+                # Try to get response content for better error messages
+                try:
+                    error_content = response.text
+                except:
+                    error_content = "<could not read response content>"
+
+                if response.status_code in [403, 429]:
+                    print(f"Received status code {response.status_code}, refreshing identity...")
+                    self.refresh_identity()
+                    response = self.session.post(self.url, json=payload, timeout=self.timeout)
+                    if not response.ok:
+                        raise exceptions.FailedToGenerateResponseError(
+                            f"Failed to generate response after identity refresh - ({response.status_code}, {response.reason}) - {error_content}"
+                        )
+                    print("Identity refreshed successfully.")
+                else:
+                    raise exceptions.FailedToGenerateResponseError(
+                        f"Request failed with status code {response.status_code}. Response: {error_content}"
+                    )
+
+            full_response = ""
+            debug_lines = []
+
+            # Collect the first few lines for debugging
+            for i, line in enumerate(response.iter_lines()):
+                if line:
+                    try:
+                        line_str = line.decode('utf-8')
+                        debug_lines.append(line_str)
+
+                        # Format 2: 0:"content" (quoted format)
+                        match = re.search(r'0:"(.*?)"', line_str)
+                        if match:
+                            content = match.group(1)
+                            full_response += content
+                            continue
+
+
+                    except: pass
+            self.last_response = {"text": full_response}
+            self.conversation.update_chat_history(prompt, full_response)
+            return {"text": full_response}
+        except Exception as e:
+            raise exceptions.FailedToGenerateResponseError(f"Request failed: {e}")
+
+    def chat(
+        self,
+        prompt: str,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> str:
+        return self.get_message(
+            self.ask(
+                prompt, optimizer=optimizer, conversationally=conversationally
+            )
+        )
+
+    def get_message(self, response: dict) -> str:
+        assert isinstance(response, dict), "Response should be of dict data-type only"
+        return response["text"].replace('\\n', '\n').replace('\\n\\n', '\n\n')
+
+if __name__ == "__main__":
+    print("-" * 100)
+    print(f"{'Model':<50} {'Status':<10} {'Response'}")
+    print("-" * 100)
+
+    test_prompt = "Say 'Hello' in one word"
+
+    # Test each model
+    for model in SciraAI.AVAILABLE_MODELS:
+        print(f"\rTesting {model}...", end="")
+
+        try:
+            test_ai = SciraAI(model=model, timeout=120)  # Increased timeout
+            response = test_ai.chat(test_prompt)
+
+            if response and len(response.strip()) > 0:
+                status = "✓"
+                # Clean and truncate response
+                clean_text = response.strip().encode('utf-8', errors='ignore').decode('utf-8')
+                display_text = clean_text[:50] + "..." if len(clean_text) > 50 else clean_text
+            else:
+                status = "✗"
+                display_text = "Empty or invalid response"
+
+            print(f"\r{model:<50} {status:<10} {display_text}")
+        except Exception as e:
+            error_msg = str(e)
+            # Truncate very long error messages
+            if len(error_msg) > 100:
+                error_msg = error_msg[:97] + "..."
+            print(f"\r{model:<50} {'✗':<10} Error: {error_msg}")

webscout/Provider/typefully.py

@@ -0,0 +1,280 @@
+from typing import Union, Any, Dict
+import requests
+import re
+from uuid import uuid4
+
+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.litagent import LitAgent
+
+class TypefullyAI(Provider):
+    """
+    A class to interact with the Typefully AI API.
+
+    Attributes:
+        system_prompt (str): The system prompt to define the assistant's role.
+        model (str): The model identifier to use for completions.
+        output_length (int): Maximum length of the generated output.
+
+    Examples:
+        >>> from webscout.Provider.typefully import TypefullyAI
+        >>> ai = TypefullyAI()
+        >>> response = ai.chat("What's the weather today?")
+        >>> print(response)
+        'The weather today is sunny with a high of 75°F.'
+    """
+    AVAILABLE_MODELS = ["openai:gpt-4o-mini", "openai:gpt-4o", "anthropic:claude-3-5-haiku-20241022", "groq:llama-3.3-70b-versatile"]
+
+    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,
+        system_prompt: str = "You're a helpful assistant.",
+        model: str = "openai:gpt-4o-mini",
+    ):
+        """
+        Initializes the TypefullyAI API with given parameters.
+
+        Args:
+            is_conversation (bool): Whether the provider is in conversation mode.
+            max_tokens (int): Maximum number of tokens to sample.
+            timeout (int): Timeout for API requests.
+            intro (str): Introduction message for the conversation.
+            filepath (str): Filepath for storing conversation history.
+            update_file (bool): Whether to update the conversation history file.
+            proxies (dict): Proxies for the API requests.
+            history_offset (int): Offset for conversation history.
+            act (str): Act for the conversation.
+            system_prompt (str): The system prompt to define the assistant's role.
+            model (str): The model identifier to use.
+
+        Examples:
+            >>> ai = TypefullyAI(system_prompt="You are a friendly assistant.")
+            >>> print(ai.system_prompt)
+            'You are a friendly assistant.'
+        """
+        self.session = requests.Session()
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_tokens
+        self.api_endpoint = "https://typefully.com/tools/ai/api/completion"
+        self.timeout = timeout
+        self.last_response = {}
+        self.system_prompt = system_prompt
+        self.model = model
+        self.output_length = max_tokens
+
+        # Initialize LitAgent for user agent generation
+        self.agent = LitAgent()
+
+        self.headers = {
+            "authority": "typefully.com",
+            "accept": "*/*",
+            "accept-encoding": "gzip, deflate, br, zstd",
+            "accept-language": "en-US,en;q=0.9",
+            "content-type": "application/json",
+            "dnt": "1",
+            "origin": "https://typefully.com",
+            "referer": "https://typefully.com/tools/ai/chat-gpt-alternative",
+            "sec-ch-ua": '"Microsoft Edge";v="135", "Not-A.Brand";v="8", "Chromium";v="135"',
+            "sec-ch-ua-mobile": "?0",
+            "sec-ch-ua-platform": '"Windows"',
+            "user-agent": self.agent.random()  # Use LitAgent to generate a random user agent
+        }
+
+        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
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> Dict[str, Any]:
+        """
+        Sends a prompt to the Typefully AI API and returns the response.
+
+        Args:
+            prompt (str): The prompt to send to the API.
+            stream (bool): Whether to stream the response.
+            raw (bool): Whether to return the raw response.
+            optimizer (str): Optimizer to use for the prompt.
+            conversationally (bool): Whether to generate the prompt conversationally.
+
+        Returns:
+            Dict[str, Any]: The API response.
+
+        Examples:
+            >>> ai = TypefullyAI()
+            >>> response = ai.ask("Tell me a joke!")
+            >>> print(response)
+            {'text': 'Why did the scarecrow win an award? Because he was outstanding in his field!'}
+        """
+        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 = {
+            "prompt": conversation_prompt,
+            "systemPrompt": self.system_prompt,
+            "modelIdentifier": self.model,
+            "outputLength": self.output_length
+        }
+
+        def for_stream():
+            response = self.session.post(self.api_endpoint, headers=self.headers, 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_response = ""
+            for line in response.iter_lines(decode_unicode=True):
+                if line:
+                    match = re.search(r'0:"(.*?)"', line)
+                    if match:
+                        content = match.group(1)
+                        streaming_response += content
+                        yield content if raw else dict(text=content)
+                    elif line.startswith('e:') or line.startswith('d:'):
+                        # End of response
+                        break
+            self.last_response.update(dict(text=streaming_response))
+            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:
+        """
+        Generates a response from the Typefully AI API.
+
+        Args:
+            prompt (str): The prompt to send to the API.
+            stream (bool): Whether to stream the response.
+            optimizer (str): Optimizer to use for the prompt.
+            conversationally (bool): Whether to generate the prompt conversationally.
+
+        Returns:
+            str: The API response.
+
+        Examples:
+            >>> ai = TypefullyAI()
+            >>> response = ai.chat("What's the weather today?")
+            >>> print(response)
+            'The weather today is sunny with a high of 75°F.'
+        """
+
+        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:
+        """
+        Extracts the message from the API response.
+
+        Args:
+            response (dict): The API response.
+
+        Returns:
+            str: The message content.
+
+        Examples:
+            >>> ai = TypefullyAI()
+            >>> response = ai.ask("Tell me a joke!")
+            >>> message = ai.get_message(response)
+            >>> print(message)
+            'Why did the scarecrow win an award? Because he was outstanding in his field!'
+        """
+        assert isinstance(response, dict), "Response should be of dict data-type only"
+        formatted_text = response["text"].replace('\\n', '\n').replace('\\n\\n', '\n\n')
+        return formatted_text
+
+if __name__ == "__main__":
+    print("-" * 80)
+    print(f"{'Model':<50} {'Status':<10} {'Response'}")
+    print("-" * 80)
+    
+    # Test all available models
+    working = 0
+    total = len(TypefullyAI.AVAILABLE_MODELS)
+    
+    for model in TypefullyAI.AVAILABLE_MODELS:
+        try:
+            test_ai = TypefullyAI(model=model, timeout=60)
+            response = test_ai.chat("Say 'Hello' in one word", stream=True)
+            response_text = ""
+            for chunk in response:
+                response_text += chunk
+                print(f"\r{model:<50} {'Testing...':<10}", end="", flush=True)
+            
+            if response_text and len(response_text.strip()) > 0:
+                status = "✓"
+                # Truncate response if too long
+                display_text = response_text.strip()[:50] + "..." if len(response_text.strip()) > 50 else response_text.strip()
+            else:
+                status = "✗"
+                display_text = "Empty or invalid response"
+            print(f"\r{model:<50} {status:<10} {display_text}")
+        except Exception as e:
+            print(f"\r{model:<50} {'✗':<10} {str(e)}")
+