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

webscout/Provider/tutorai.py

@@ -1,252 +0,0 @@
-import requests
-import os
-from typing import Union, List, Optional
-from string import punctuation
-from random import choice
-import json
-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 TutorAI(Provider):
-    """
-    A class to interact with the TutorAI.me API.
-    """
-    AVAILABLE_MODELS = ["gpt-4o"]
-
-    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 are a helpful AI assistant.",
-        model: str = "gpt-4o"
-    ):
-        """
-        Initializes the TutorAI.me API with given parameters.
-
-        Args:
-            is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
-            max_tokens (int, optional): Maximum number of tokens to be generated upon completion. Defaults to 1024.
-            timeout (int, optional): Http request timeout. Defaults to 30.
-            intro (str, optional): Conversation introductory prompt. Defaults to None.
-            filepath (str, optional): Path to file containing conversation history. Defaults to None.
-            update_file (bool, optional): Add new prompts and responses to the file. Defaults to True.
-            proxies (dict, optional): Http request proxies. Defaults to {}.
-            history_offset (int, optional): Limit conversation history to this number of last texts. Defaults to 10250.
-            act (str|int, optional): Awesome prompt key or index. (Used as intro). Defaults to None.
-            system_prompt (str, optional): System prompt for TutorAI.
-                                   Defaults to "You are a helpful AI assistant.".
-        """
-        self.session = requests.Session()
-        self.is_conversation = is_conversation
-        self.max_tokens_to_sample = max_tokens
-        self.api_endpoint = "https://ai-tutor.ai/api/generate-homeworkify-response"
-        self.stream_chunk_size = 1024
-        self.timeout = timeout
-        self.last_response = {}
-        self.system_prompt = system_prompt
-        self.headers = {
-            "Accept": "*/*",
-            "Accept-Encoding": "gzip, deflate, br, zstd",
-            "Accept-Language": "en-US,en;q=0.9,en-IN;q=0.8",
-            "Cookie": (
-                "ARRAffinity=5ef5a1afbc0178c19fc7bc85047a2309cb69de3271923483302c69744e2b1d24; "
-                "ARRAffinitySameSite=5ef5a1afbc0178c19fc7bc85047a2309cb69de3271923483302c69744e2b1d24; "
-                "_ga=GA1.1.412867530.1726937399; "
-                "_clck=1kwy10j%7C2%7Cfpd%7C0%7C1725; "
-                "_clsk=1cqd2q1%7C1726937402133%7C1%7C1%7Cm.clarity.ms%2Fcollect; "
-                "_ga_0WF5W33HD7=GS1.1.1726937399.1.1.1726937459.0.0.0"
-            ),
-            "DNT": "1",
-            "Origin": "https://tutorai.me",
-            "Priority": "u=1, i",
-            "Referer": "https://tutorai.me/homeworkify?ref=taaft&utm_source=taaft&utm_medium=referral",
-            "Sec-Ch-Ua": '"Microsoft Edge";v="129", "Not=A?Brand";v="8", "Chromium";v="129"',
-            "Sec-Ch-Ua-Mobile": "?0",
-            "Sec-Ch-Ua-Platform": '"Windows"',
-            "Sec-Fetch-Dest": "empty",
-            "Sec-Fetch-Mode": "cors",
-            "Sec-Fetch-Site": "same-origin",
-            "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
-
-    def ask(
-        self,
-        prompt: str,
-        stream: bool = False,
-        raw: bool = False,
-        optimizer: str = None,
-        conversationally: bool = False,
-        attachment_path: Optional[str] = None
-    ) -> dict:
-        """Chat with TutorAI
-
-        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.
-            attachment_path (str, optional): Path to attachment file. Defaults to None.
-
-        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}"
-                )
-
-        form_data = {
-            "inputMessage": conversation_prompt,
-            "attachmentsCount": "1" if attachment_path else "0"
-        }
-        files = {}
-        if attachment_path:
-            if not os.path.isfile(attachment_path):
-                raise FileNotFoundError(f"Error: The file '{attachment_path}' does not exist.")
-            try:
-                files["attachment0"] = (os.path.basename(attachment_path), open(attachment_path, 'rb'), 'image/png')
-            except Exception as e:
-                raise exceptions.FailedToGenerateResponseError(f"Error opening the file: {e}")
-
-        def for_stream():
-            try:
-                with requests.post(self.api_endpoint, headers=self.headers, data=form_data, files=files, stream=True, timeout=self.timeout) as response:
-                    response.raise_for_status()
-                    response_chunks = []
-                    json_str = ''
-                    for chunk in response.iter_content(chunk_size=self.stream_chunk_size, decode_unicode=True):
-                        if chunk:
-                            response_chunks.append(chunk)
-                            yield chunk if raw else dict(text=chunk)
-                    json_str = ''.join(response_chunks)
-                    try:
-                        response_data = json.loads(json_str)
-                    except json.JSONDecodeError as json_err:
-                        raise exceptions.FailedToGenerateResponseError(f"\nError decoding JSON: {json_err}")
-                    homeworkify_html = response_data.get("homeworkifyResponse", "")
-                    if not homeworkify_html:
-                        raise exceptions.FailedToGenerateResponseError("\nNo 'homeworkifyResponse' found in the response.")
-                    clean_text = homeworkify_html  # Removed html_to_terminal call
-                    self.last_response.update(dict(text=clean_text))
-                    self.conversation.update_chat_history(
-                        prompt, self.get_message(self.last_response)
-                    )
-            except requests.exceptions.RequestException as e:
-                raise exceptions.FailedToGenerateResponseError(f"An error occurred: {e}")
-        
-        def for_non_stream():
-            response = self.session.post(self.api_endpoint, headers=self.headers, data=form_data, files=files, timeout=self.timeout)
-            if not response.ok:
-                raise Exception(
-                    f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
-                )
-
-            # Parse the entire JSON response
-            response_data = response.json()
-            homeworkify_html = response_data.get("homeworkifyResponse", "")
-            if not homeworkify_html:
-                return {"text": "No content found in the response"}  # Default in case content not found
-            clean_text = homeworkify_html  # Removed html_to_terminal call
-
-            # Simulate streaming by yielding chunks of the content
-            chunk_size = self.stream_chunk_size
-            for i in range(0, len(clean_text), chunk_size):
-                chunk = clean_text[i:i + chunk_size]
-                self.last_response.update(dict(text=chunk))
-                yield chunk if raw else dict(text=chunk)
-            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,
-        attachment_path: Optional[str] = None,
-    ) -> str:
-        """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.
-            attachment_path (str, optional): Path to attachment file. Defaults to None.
-        Returns:
-            str: Response generated
-        """
-
-        def for_stream():
-            for response in self.ask(
-                prompt, True, optimizer=optimizer, conversationally=conversationally, attachment_path=attachment_path,
-            ):
-                yield self.get_message(response)
-
-        def for_non_stream():
-            for response in self.ask(
-                prompt, False, optimizer=optimizer, conversationally=conversationally, attachment_path=attachment_path,
-            ):
-                yield self.get_message(response)
-
-        return for_stream() if stream else for_non_stream()
-
-    def get_message(self, response: dict) -> str:
-        """Retrieves message only from response
-
-        Args:
-            response (dict): Response generated by `self.ask`
-
-        Returns:
-            str: Message extracted
-        """
-        assert isinstance(response, dict), "Response should be of dict data-type only"
-        return response["text"]
-
-if __name__ == "__main__":
-    from rich import print
-
-    ai = TutorAI()
-    response = ai.chat("hello buddy", attachment_path=None)
-    for chunk in response:
-        print(chunk, end="", flush=True)

webscout/Provider/typefully.py

@@ -1,280 +0,0 @@
-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)}")
-