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

webscout/Provider/typefully.py

@@ -1,280 +1,262 @@
-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)}")
-    
+from typing import Any, Dict, Generator, Optional, Union, cast
+
+from curl_cffi import CurlError
+from curl_cffi.requests import Session
+
+from webscout import exceptions
+from webscout.AIbase import Provider, Response
+from webscout.AIutel import AwesomePrompts, Conversation, Optimizers, sanitize_stream
+from webscout.litagent import LitAgent
+
+
+class TypefullyAI(Provider):
+    required_auth = False
+    AVAILABLE_MODELS = [
+        "openai:gpt-4o-mini",
+        "openai:gpt-4o",
+        "anthropic:claude-haiku-4-5-20251001",
+        "groq:llama-3.3-70b-versatile",
+    ]
+
+    def __init__(
+        self,
+        is_conversation: bool = True,
+        max_tokens: int = 600,
+        timeout: int = 30,
+        intro: Optional[str] = None,
+        filepath: Optional[str] = None,
+        update_file: bool = True,
+        proxies: dict = {},
+        history_offset: int = 10250,
+        act: Optional[str] = None,
+        system_prompt: str = "You're a helpful assistant.",
+        model: str = "openai:gpt-4o-mini",
+    ):
+        self.session = 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
+        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(),
+        }
+        self.__available_optimizers = (
+            method
+            for method in dir(Optimizers)
+            if callable(getattr(Optimizers, method)) and not method.startswith("__")
+        )
+        self.session.headers.update(self.headers)
+        if proxies:
+            self.session.proxies.update(proxies)
+        self.conversation = Conversation(
+            is_conversation, self.max_tokens_to_sample, filepath, update_file
+        )
+        self.conversation.history_offset = history_offset
+
+        if act:
+            self.conversation.intro = AwesomePrompts().get_act(cast(Union[str, int], act), default=self.conversation.intro, case_insensitive=True
+            ) or self.conversation.intro
+        elif intro:
+            self.conversation.intro = intro
+
+    @staticmethod
+    def _typefully_extractor(chunk) -> str:
+        """Extracts content from Typefully AI SSE format."""
+        import json
+
+        # Handle parsed JSON objects (when to_json=True)
+        if isinstance(chunk, dict):
+            data = chunk
+        elif isinstance(chunk, str):
+            # Handle raw strings (when to_json=False or direct strings)
+            line = chunk.strip()
+            if line.startswith("data: "):
+                line = line[6:]  # Remove 'data: ' prefix
+
+                try:
+                    # Parse JSON content
+                    data = json.loads(line)
+                except json.JSONDecodeError:
+                    # If JSON parsing fails, return empty for non-JSON content
+                    return ""
+            else:
+                # For non-SSE lines, return empty
+                return ""
+        else:
+            # For other types (bytes, etc.), return empty
+            return ""
+
+        # Extract delta content for text chunks
+        if data.get("type") == "text-delta" and "delta" in data:
+            return data["delta"]
+        elif data.get("type") == "text-start":
+            # Return empty for text-start to avoid duplication
+            return ""
+        elif data.get("type") == "text-end":
+            # Return empty for text-end to avoid duplication
+            return ""
+        else:
+            # Return empty for other event types
+            return ""
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: Optional[str] = None,
+        conversationally: bool = False,
+        **kwargs: Any,
+    ) -> Response:
+        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():
+            try:
+                response = self.session.post(
+                    self.api_endpoint,
+                    headers=self.headers,
+                    json=payload,
+                    stream=True,
+                    timeout=self.timeout,
+                    impersonate="chrome120",
+                )
+                if not response.ok:
+                    raise exceptions.FailedToGenerateResponseError(
+                        f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
+                    )
+                streaming_text = ""
+                processed_stream = sanitize_stream(
+                    data=response.iter_content(chunk_size=None),
+                    intro_value="data:",
+                    to_json=True,
+                    content_extractor=self._typefully_extractor,
+                    raw=raw,
+                )
+                for content_chunk in processed_stream:
+                    if isinstance(content_chunk, bytes):
+                        content_chunk = content_chunk.decode("utf-8", errors="ignore")
+                    if content_chunk is None:
+                        continue
+                    if raw:
+                        yield content_chunk
+                    else:
+                        if content_chunk and isinstance(content_chunk, str):
+                            streaming_text += content_chunk
+                            yield dict(text=content_chunk)
+                self.last_response.update(dict(text=streaming_text))
+                self.conversation.update_chat_history(prompt, self.get_message(self.last_response))
+            except CurlError as e:
+                raise exceptions.FailedToGenerateResponseError(f"Request failed (CurlError): {e}")
+            except Exception as e:
+                raise exceptions.FailedToGenerateResponseError(
+                    f"An unexpected error occurred ({type(e).__name__}): {e}"
+                )
+
+        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: Optional[str] = None,
+        conversationally: bool = False,
+        **kwargs: Any,
+    ) -> Union[str, Generator[str, None, None]]:
+        raw = kwargs.get("raw", False)
+        def for_stream():
+            for response in self.ask(
+                prompt, True, raw=raw, optimizer=optimizer, conversationally=conversationally
+            ):
+                if raw:
+                    yield cast(str, response)
+                else:
+                    yield self.get_message(cast(Response, response))
+
+        def for_non_stream():
+            result = self.ask(
+                prompt,
+                False,
+                raw=raw,
+                optimizer=optimizer,
+                conversationally=conversationally,
+            )
+            if raw:
+                return cast(str, result)
+            else:
+                return self.get_message(result)
+
+        return for_stream() if stream else for_non_stream()
+
+    def get_message(self, response: Response) -> str:
+        if not isinstance(response, dict):
+            return str(response)
+        response_dict = cast(Dict[str, Any], response)
+        text = response_dict.get("text", "")
+        try:
+            formatted_text = text.replace("\\n", "\n").replace("\\n\\n", "\n\n")
+            return formatted_text
+        except Exception:
+            return text
+
+
+if __name__ == "__main__":
+    print("-" * 80)
+    print(f"{'Model':<50} {'Status':<10} {'Response'}")
+    print("-" * 80)
+    working = 0
+    total = len(TypefullyAI.AVAILABLE_MODELS)
+    for model in TypefullyAI.AVAILABLE_MODELS:
+        try:
+            test_ai = TypefullyAI(model=model, timeout=60)
+            response_stream = test_ai.chat("Say 'Hello' in one word", stream=True)
+            response_text = ""
+            if hasattr(response_stream, "__iter__") and not isinstance(response_stream, (str, bytes)):
+                for chunk in response_stream:
+                    response_text += chunk
+            else:
+                response_text = str(response_stream)
+
+            if response_text and len(response_text.strip()) > 0:
+                status = "OK"
+                clean_text = response_text.strip()
+                display_text = clean_text[:50] + "..." if len(clean_text) > 50 else clean_text
+            else:
+                status = "FAIL (Stream)"
+                display_text = "Empty or invalid stream response"
+            print(f"\r{model:<50} {status:<10} {display_text}")
+        except Exception as e:
+            print(f"\r{model:<50} {'FAIL':<10} {str(e)}")