webscout 7.9__py3-none-any.whl → 8.1__py3-none-any.whl

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)}")
+    

webscout/Provider/typegpt.py

@@ -14,195 +14,14 @@ class TypeGPT(Provider):
     """
     A class to interact with the TypeGPT.net API. Improved to match webscout standards.
     """
-    url = "https://chat.typegpt.net"
-
     AVAILABLE_MODELS = [
-        # OpenAI Models
-        "gpt-3.5-turbo",
-        "gpt-3.5-turbo-202201",
-        "gpt-4o",
-        "gpt-4o-2024-05-13",
-        "gpt-4o-2024-11-20",
-        "gpt-4o-mini",
+        # Working Models (based on testing)
         "gpt-4o-mini-2024-07-18",
-        # "gpt-4o-mini-ddg", >>>> NOT WORKING
-        "o1",
-        # "o1-mini-2024-09-12", >>>> NOT WORKING
-        "o1-preview",
-        "o3-mini",
         "chatgpt-4o-latest",
-        
-        # Claude Models
-        # "claude", >>>> NOT WORKING
-        "claude-3-5-sonnet",
-        "claude-3-5-sonnet-20240620",
-        "claude-3-5-sonnet-x",
-        # "claude-3-haiku-ddg", >>>> NOT WORKING
-        "claude-hybridspace",
-        "claude-sonnet-3.5",
-        "Claude-sonnet-3.7",
-        "anthropic/claude-3.5-sonnet",
-        "anthropic/claude-3.7-sonnet",
-        
-        # Meta/LLaMA Models
-        "@cf/meta/llama-2-7b-chat-fp16",
-        "@cf/meta/llama-2-7b-chat-int8",
-        "@cf/meta/llama-3-8b-instruct",
-        "@cf/meta/llama-3.1-8b-instruct",
-        "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
-        # "@cf/meta-llama/llama-2-7b-chat-hf-lora", >>>> NOT WORKING
-        "llama-3.1-405b",
-        "llama-3.1-70b",
-        # "llama-3.1-70b-ddg", >>>> NOT WORKING
-        "llama-3.1-8b",
-        # "llama-scaleway", >>>> NOT WORKING
-        "llama3.1-8b", # >>>> NOT WORKING
-        "llama3.3-70b",
-        # "llamalight", >>>> NOT WORKING
-        "Meta-Llama-3.1-405B-Instruct-Turbo",
-        "Meta-Llama-3.3-70B-Instruct-Turbo",
-        # "meta-llama/Llama-2-7b-chat-hf", >>>> NOT WORKING
-        # "meta-llama/Llama-3.1-70B-Instruct", >>>> NOT WORKING
-        # "meta-llama/Llama-3.1-8B-Instruct", >>>> NOT WORKING
-        "meta-llama/Llama-3.2-11B-Vision-Instruct",
-        # "meta-llama/Llama-3.2-1B-Instruct", >>>> NOT WORKING
-        # "meta-llama/Llama-3.2-3B-Instruct", >>>> NOT WORKING
-        "meta-llama/Llama-3.2-90B-Vision-Instruct",
-        "meta-llama/Llama-3.3-70B-Instruct",
-        "meta-llama/Llama-3.3-70B-Instruct-Turbo",
-        # "meta-llama/Llama-Guard-3-8B", >>>> NOT WORKING
-        # "meta-llama/Meta-Llama-3-70B-Instruct", >>>> NOT WORKING
-        # "meta-llama/Meta-Llama-3-8B-Instruct", >>>> NOT WORKING
-        "meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo",
-        "meta-llama/Meta-Llama-3.1-8B-Instruct",
-        "meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo",
-        
-        # Mistral Models
-        "mistral",
-        "mistral-large",
-        "@cf/mistral/mistral-7b-instruct-v0.1",
-        # "@cf/mistral/mistral-7b-instruct-v0.2-lora", >>>> NOT WORKING
-        "@hf/mistralai/mistral-7b-instruct-v0.2",
-        "mistralai/Mistral-7B-Instruct-v0.2",
-        "mistralai/Mistral-7B-Instruct-v0.3",
-        "mistralai/Mixtral-8x22B-Instruct-v0.1",
-        "mistralai/Mixtral-8x7B-Instruct-v0.1",
-        # "mixtral-8x7b-ddg", >>>> NOT WORKING
-        "Mistral-7B-Instruct-v0.2",
-        
-        # Qwen Models
-        "@cf/qwen/qwen1.5-0.5b-chat",
-        "@cf/qwen/qwen1.5-1.8b-chat",
-        "@cf/qwen/qwen1.5-14b-chat-awq",
-        "@cf/qwen/qwen1.5-7b-chat-awq",
-        "Qwen/Qwen2.5-3B-Instruct",
-        "Qwen/Qwen2.5-72B-Instruct",
-        "Qwen/Qwen2.5-Coder-32B-Instruct",
-        "Qwen/Qwen2-72B-Instruct",
-        "Qwen/QwQ-32B",
-        "Qwen/QwQ-32B-Preview",
-        "Qwen2.5-72B-Instruct",
-        "qwen",
-        "qwen-coder",
-        # "Qwen-QwQ-32B-Preview", >>>> NOT WORKING
-        
-        # Google/Gemini Models
-        # "@cf/google/gemma-2b-it-lora", >>>> NOT WORKING
-        # "@cf/google/gemma-7b-it-lora", >>>> NOT WORKING
-        "@hf/google/gemma-7b-it",
-        "google/gemma-1.1-2b-it",
-        "google/gemma-1.1-7b-it",
-        "gemini-pro",
-        "gemini-1.5-pro",
-        "gemini-1.5-pro-latest",
-        "gemini-1.5-flash",
-        "gemini-flash-2.0",
-        "gemini-thinking",
-        
-        # Microsoft Models
-        "@cf/microsoft/phi-2",
-        "microsoft/DialoGPT-medium",
-        "microsoft/Phi-3-medium-4k-instruct",
-        "microsoft/Phi-3-mini-4k-instruct",
-        "microsoft/Phi-3.5-mini-instruct",
-        "microsoft/phi-4",
-        "microsoft/WizardLM-2-8x22B",
-        
-        # Yi Models
-        "01-ai/Yi-1.5-34B-Chat",
-        # "01-ai/Yi-34B-Chat", >>>> NOT WORKING
-        
-        # DeepSeek Models
-        "@cf/deepseek-ai/deepseek-math-7b-base",
-        "@cf/deepseek-ai/deepseek-math-7b-instruct",
-        "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b",
-        "deepseek",
-        "deepseek-ai/DeepSeek-R1",
-        "deepseek-ai/DeepSeek-R1-Distill-Llama-70B",
-        # "deepseek-ai/DeepSeek-R1-Distill-Qwen-32B", >>>> NOT WORKING
-        # "deepseek-ai/DeepSeek-V2.5", >>>> NOT WORKING
-        "deepseek-llm-67b-chat",
         "deepseek-r1",
-        "deepseek-r1-distill-llama-70b",
-        # "deepseek-reasoner", >>>> NOT WORKING
         "deepseek-v3",
-        "uncensored-r1", 
-        
-        # Specialized Models and Tools
-        "@cf/defog/sqlcoder-7b-2",
-        "@cf/thebloke/discolm-german-7b-v1-awq",
-        "@cf/tiiuae/falcon-7b-instruct",
-        # "@cf/tinyllama/tinyllama-1.1b-chat-v1.0", >>>> NOT WORKING
-        # "@hf/nexusflow/starling-lm-7b-beta", >>>> NOT WORKING
-        # "@hf/nousresearch/hermes-2-pro-mistral-7b", >>>> NOT WORKING
-        # "@hf/thebloke/deepseek-coder-6.7b-base-awq", >>>> NOT WORKING
-        # "@hf/thebloke/deepseek-coder-6.7b-instruct-awq", >>>> NOT WORKING
-        # "@hf/thebloke/llama-2-13b-chat-awq", >>>> NOT WORKING
-        # "@hf/thebloke/llamaguard-7b-awq", >>>> NOT WORKING
-        # "@hf/thebloke/mistral-7b-instruct-v0.1-awq", >>>> NOT WORKING
-        # "@hf/thebloke/neural-chat-7b-v3-1-awq", >>>> NOT WORKING
-        # "@hf/thebloke/openhermes-2.5-mistral-7b-awq", >>>> NOT WORKING
-        # "@hf/thebloke/zephyr-7b-beta-awq", >>>> NOT WORKING
+        "uncensored-r1",
         "Image-Generator",
-        # "flux-1-schnell", >>>> NOT WORKING
-        # "HelpingAI-15B", >>>> NOT WORKING
-        # "HelpingAI2-3b", >>>> NOT WORKING
-        # "HelpingAI2-6B", >>>> NOT WORKING
-        # "HelpingAI2-9B", >>>> NOT WORKING
-        # "HelpingAI2.5-10B", >>>> NOT WORKING
-        # "Helpingai2.5-10b-1m", >>>> NOT WORKING
-        # "HelpingAI2.5-2B", >>>> NOT WORKING
-        # "HELVETE", >>>> NOT WORKING
-        # "HELVETE-X", >>>> NOT WORKING
-        # "evil", >>>> NOT WORKING
-        # "Image-Generator", >>>> NOT WORKING
-        # "Image-Generator-NSFW", >>>> NOT WORKING
-        # "midijourney", >>>> NOT WORKING
-        # "Niansuh", >>>> NOT WORKING
-        # "niansuh-t1", >>>> NOT WORKING
-        # "Nous-Hermes-2-Mixtral-8x7B-DPO", >>>> NOT WORKING
-        # "NousResearch/Hermes-3-Llama-3.1-8B", >>>> NOT WORKING
-        # "NousResearch/Nous-Hermes-2-Mixtral-8x7B-DPO", >>>> NOT WORKING
-        # "nvidia/Llama-3.1-Nemotron-70B-Instruct", >>>> NOT WORKING
-        # "openai", >>>> NOT WORKING
-        # "openai-audio", >>>> NOT WORKING
-        # "openai-large", >>>> NOT WORKING
-        # "openai-reasoning", >>>> NOT WORKING
-        # "openai/whisper-large-v3", >>>> NOT WORKING
-        # "openai/whisper-large-v3-turbo", >>>> NOT WORKING
-        # "openbmb/MiniCPM-Llama3-V-2_5", >>>> NOT WORKING
-        # "openchat/openchat-3.6-8b", >>>> NOT WORKING
-        # "p1", >>>> NOT WORKING
-        # "phi", >>>> NOT WORKING
-        # "Phi-4-multilmodal-instruct", >>>> NOT WORKING
-        # "Priya-3B", >>>> NOT WORKING
-        # "rtist", >>>> NOT WORKING
-        # "searchgpt", >>>> NOT WORKING
-        # "sur", >>>> NOT WORKING
-        # "sur-mistral", >>>> NOT WORKING
-        # "tiiuae/falcon-7b-instruct", >>>> NOT WORKING
-        # "TirexAi", >>>> NOT WORKING
-        # "unity", >>>> NOT WORKING
     ]
 
     def __init__(
@@ -230,7 +49,7 @@ class TypeGPT(Provider):
         self.session = requests.Session()
         self.is_conversation = is_conversation
         self.max_tokens_to_sample = max_tokens
-        self.api_endpoint = "https://chat.typegpt.net/api/openai/typegpt/v1/chat/completions"
+        self.api_endpoint = "https://chat.typegpt.net/api/openai/v1/chat/completions"
         self.timeout = timeout
         self.last_response = {}
         self.model = model

webscout/prompt_manager.py

@@ -110,7 +110,8 @@ class AwesomePrompts:
         self,
         key: Union[str, int],
         default: Optional[str] = None,
-        case_insensitive: bool = True
+        case_insensitive: bool = True,
+        raise_not_found: bool = False # currently unused
     ) -> Optional[str]:
         """Get that perfect prompt! 🎯
 

webscout/version.py

@@ -1,2 +1,2 @@
-__version__ = "7.9"
+__version__ = "8.1"
 __prog__ = "webscout"