webscout 5.7__py3-none-any.whl → 5.8__py3-none-any.whl

webscout/Provider/genspark.py

@@ -1,13 +1,12 @@
 import cloudscraper
 from uuid import uuid4
 import json
-
+import re
 from webscout.AIutel import Optimizers
 from webscout.AIutel import Conversation
 from webscout.AIutel import AwesomePrompts
 from webscout.AIbase import Provider
 
-
 class Genspark(Provider):
     """
     A class to interact with the Genspark.ai API.
@@ -25,7 +24,8 @@ class Genspark(Provider):
         history_offset: int = 10250,
         act: str = None,
     ) -> None:
-        """Instantiates Genspark
+        """
+        Instantiates Genspark
 
         Args:
             is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
@@ -67,11 +67,11 @@ class Genspark(Provider):
             "session_id": uuid4().hex,
         }
 
-        self.__available_optimizers = (
+        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(
@@ -94,7 +94,8 @@ class Genspark(Provider):
         optimizer: str = None,
         conversationally: bool = False,
     ) -> dict:
-        """Chat with AI
+        """
+        Chat with AI
 
         Args:
             prompt (str): Prompt to be send.
@@ -102,11 +103,12 @@ class Genspark(Provider):
             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.
+
         Returns:
-           dict : {}
+            dict : {}
         ```json
         {
-           "text" : "How may I assist you today?"
+            "text" : "How may I assist you today?"
         }
         ```
         """
@@ -121,11 +123,10 @@ class Genspark(Provider):
                     f"Optimizer is not one of {self.__available_optimizers}"
                 )
 
-        self.url = (
-            f"https://www.genspark.ai/api/search/stream?query={conversation_prompt}"
-        )
+        self.url = f"https://www.genspark.ai/api/search/stream?query={conversation_prompt}"
 
         payload = {}
+
         def for_stream():
             response = self.session.post(
                 self.url,
@@ -135,26 +136,24 @@ class Genspark(Provider):
                 stream=True,
                 timeout=self.timeout,
             )
+            if not response.ok:
+                raise Exception(
+                    f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
+                )
 
-            partial_response = ""
+            full_response = ""
             for line in response.iter_lines(decode_unicode=True):
                 if line:
-                    try:
-                        data = json.loads(line[5:])
-                        if (
-                            data["type"] == "result_field"
-                            and data["field_name"] == "deep_dive_result"
-                        ):
-                            deep_dive_result = data["field_value"]
-                            if "detailAnswer" in deep_dive_result:
-                                new_content = deep_dive_result["detailAnswer"][
-                                    len(partial_response) :
-                                ]
-                                partial_response = deep_dive_result["detailAnswer"]
-                                self.last_response.update(dict(text=new_content))
-                                yield new_content if raw else dict(text=new_content)
-                    except json.JSONDecodeError:
-                        print(f"Skipping invalid JSON line: {line}")
+                    if line.startswith("data: "):
+                        try:
+                            data = json.loads(line[6:])
+                            if data.get("type") == "result_field" and data["field_name"] == "streaming_summary":
+                                full_response = data.get("field_value", "")
+                                yield full_response if raw else {"text": full_response}
+                        except json.JSONDecodeError as e:
+                            print(f"Error decoding JSON: {line} - {e}")
+
+            self.last_response.update({"text": full_response})
             self.conversation.update_chat_history(
                 prompt, self.get_message(self.last_response)
             )
@@ -173,7 +172,8 @@ class Genspark(Provider):
         optimizer: str = None,
         conversationally: bool = False,
     ) -> str:
-        """Generate response `str`
+        """
+        Generate response `str`
         Args:
             prompt (str): Prompt to be send.
             stream (bool, optional): Flag for streaming response. Defaults to False.
@@ -190,19 +190,14 @@ class Genspark(Provider):
                 yield self.get_message(response)
 
         def for_non_stream():
-            return self.get_message(
-                self.ask(
-                    prompt,
-                    False,
-                    optimizer=optimizer,
-                    conversationally=conversationally,
-                )
-            )
+            response = self.ask(prompt, False, optimizer=optimizer, conversationally=conversationally)
+            return 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
+        """
+        Retrieves message only from response
 
         Args:
             response (dict): Response generated by `self.ask`
@@ -211,12 +206,20 @@ class Genspark(Provider):
             str: Message extracted
         """
         assert isinstance(response, dict), "Response should be of dict data-type only"
-        return response["text"]
-
-
-if __name__ == "__main__":
+        text = response.get('text', '')
+        # Remove footnote references from the text
+        text = re.sub(r"\[.*?\]\(.*?\)", "", text)
+        try:
+            # Attempt to parse the text as JSON
+            text_json = json.loads(text)
+            return text_json.get('detailAnswer', text)
+        except json.JSONDecodeError:
+            # If text is not JSON, return it as is
+            return text
+
+if __name__ == '__main__':
     from rich import print
     ai = Genspark()
-    response = ai.chat("hi")
+    response = ai.chat(input(">>> "))
     for chunk in response:
         print(chunk, end="", flush=True)

webscout/Provider/llamatutor.py

@@ -0,0 +1,222 @@
+import requests
+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
+
+class LlamaTutor(Provider):
+    """
+    A class to interact with the LlamaTutor API (Together.ai).
+    """
+
+    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.",
+    ):
+        """
+        Initializes the LlamaTutor 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 600.
+            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 LlamaTutor. 
+                                   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://llamatutor.together.ai/api/getChat"
+        self.stream_chunk_size = 64
+        self.timeout = timeout
+        self.last_response = {}
+        self.system_prompt = system_prompt
+        self.headers = {
+            "Content-Type": "application/json",
+            "Accept": "*/*",
+            "Accept-Encoding": "gzip, deflate, br, zstd",
+            "Accept-Language": "en-US,en;q=0.9,en-IN;q=0.8",
+            "DNT": "1",
+            "Origin": "https://llamatutor.together.ai",
+            "Referer": "https://llamatutor.together.ai/",
+            "Sec-Ch-Ua": '"Chromium";v="128", "Not;A=Brand";v="24", "Microsoft Edge";v="128"',
+            "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": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36 Edg/128.0.0.0"
+        }
+
+        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:
+        """Chat with LlamaTutor
+
+        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.
+        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}"
+                )
+        
+        payload = {
+            "messages": [
+                {
+                    "role": "system",
+                    "content": self.system_prompt
+                },
+                {
+                    "role": "user",
+                    "content": conversation_prompt
+                }
+            ]
+        }
+
+        def for_stream():
+            try:
+                response = requests.post(self.api_endpoint, headers=self.headers, data=json.dumps(payload), stream=True, timeout=self.timeout)
+                response.raise_for_status()
+                
+                # Stream and process the response line by line
+                full_response = ''
+                for line in response.iter_lines(decode_unicode=True):
+                    if line:
+                        decoded_line = line.decode('utf-8')
+                        if decoded_line.startswith("data: "):
+                            json_data = json.loads(decoded_line[6:])
+                            if "text" in json_data:
+                                full_response += json_data["text"]
+                                yield json_data["text"] if raw else dict(text=full_response)
+
+                self.last_response.update(dict(text=full_response))
+                self.conversation.update_chat_history(
+                    prompt, self.get_message(self.last_response)
+                )
+
+            except requests.exceptions.HTTPError as http_err:
+                raise exceptions.FailedToGenerateResponseError(f"HTTP error occurred: {http_err}")
+            except requests.exceptions.RequestException as err:
+                raise exceptions.FailedToGenerateResponseError(f"An error occurred: {err}")
+
+        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:
+        """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.
+        Returns:
+            str: Response generated
+        """
+
+        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:
+        """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 = LlamaTutor()
+    response = ai.chat(input(">>> "))
+    for chunk in response:
+        print(chunk, end="", flush=True)

webscout/Provider/promptrefine.py

@@ -0,0 +1,191 @@
+import requests
+import uuid
+import json
+
+from webscout.AIutel import Optimizers
+from webscout.AIutel import Conversation
+from webscout.AIutel import AwesomePrompts
+from webscout.AIbase import Provider
+from fake_useragent import UserAgent
+
+class PromptRefine(Provider):
+    """
+    A class to interact with the PromptRefine API.
+    """
+
+    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 = "openai/gpt-4o",  # Default model
+    ):
+        """
+        Initializes the PromptRefine 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 600.
+            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 PromptRefine. Defaults to "You are a helpful AI assistant.".
+            model (str, optional): Model to use for generation. Defaults to "openai/gpt-4o".
+        """
+        self.session = requests.Session()
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_tokens
+        self.api_endpoint = 'https://www.promptrefine.com/api/completion'
+        self.stream_chunk_size = 64
+        self.timeout = timeout
+        self.last_response = {}
+        self.system_prompt = system_prompt
+        self.model = model
+        self.headers = {
+            'origin': 'https://www.promptrefine.com',
+            'referer': 'https://www.promptrefine.com/prompt/new',
+            'user-agent': UserAgent().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,
+    ) -> dict:
+        """Chat with PromptRefine
+
+        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.
+        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}"
+                )
+
+        payload = {
+            "messages": [
+                {"role": "system", "content": self.system_prompt},
+                {"role": "user", "content": conversation_prompt}
+            ],
+            "variables": {},
+            "parameters": {},
+            "model": self.model,
+            "userId": str(uuid.uuid4()),
+        }
+
+        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 Exception(
+                    f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
+                )
+
+            full_response = ""
+            for line in response.iter_lines(decode_unicode=True):
+                if line:
+                    full_response += line  # No need to decode here
+                    yield full_response if raw else dict(text=full_response)
+            self.last_response.update(dict(text=full_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:
+        """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.
+        Returns:
+            str: Response generated
+        """
+        return self.get_message(
+            self.ask(
+                prompt,
+                optimizer=optimizer,
+                conversationally=conversationally,
+            )
+        )
+
+    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 = PromptRefine()
+    response = ai.chat(input(">>> "))
+    for chunk in response:
+        print(chunk, end="", flush=True)