webscout 7.0__py3-none-any.whl → 7.2__py3-none-any.whl

webscout/Provider/llama3mitril.py

@@ -1,180 +1,180 @@
-import requests
-import json
-import re
-from typing import Any, Dict, Optional, Generator
-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 import LitAgent as Lit
-
-class Llama3Mitril(Provider):
-    """
-    A class to interact with the Llama3 Mitril API. Implements the WebScout provider interface.
-    """
-
-    def __init__(
-        self,
-        is_conversation: bool = True,
-        max_tokens: int = 2048,
-        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, respectful and honest assistant.",
-        temperature: float = 0.8,
-    ):
-        """Initializes the Llama3Mitril API."""
-        self.session = requests.Session()
-        self.is_conversation = is_conversation
-        self.max_tokens = max_tokens
-        self.temperature = temperature
-        self.api_endpoint = "https://llama3.mithrilsecurity.io/generate_stream"
-        self.timeout = timeout
-        self.last_response = {}
-        self.system_prompt = system_prompt
-        self.headers = {
-            "Content-Type": "application/json",
-            "DNT": "1",
-            "User-Agent": Lit().random(),
-        }
-        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, filepath, update_file
-        )
-        self.conversation.history_offset = history_offset
-        self.session.proxies = proxies
-
-    def _format_prompt(self, prompt: str) -> str:
-        """Format the prompt for the Llama3 model"""
-        return (
-            f"<|begin_of_text|>"
-            f"<|start_header_id|>system<|end_header_id|>{self.system_prompt}<|eot_id|>"
-            f"<|start_header_id|>user<|end_header_id|>{prompt}<|eot_id|>"
-            f"<|start_header_id|>assistant<|end_header_id|><|eot_id|>"
-            f"<|start_header_id|>assistant<|end_header_id|>"
-        )
-
-    def ask(
-        self,
-        prompt: str,
-        stream: bool = True,
-        raw: bool = False,
-        optimizer: str = None,
-        conversationally: bool = False,
-    ) -> Dict[str, Any] | Generator[Dict[str, Any], None, None]:
-        """Sends a prompt to the Llama3 Mitril API and returns the 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 exceptions.FailedToGenerateResponseError(
-                    f"Optimizer is not one of {self.__available_optimizers}"
-                )
-
-        data = {
-            "inputs": self._format_prompt(conversation_prompt),
-            "parameters": {
-                "max_new_tokens": self.max_tokens,
-                "temperature": self.temperature,
-                "return_full_text": False
-            }
-        }
-
-        def for_stream():
-            response = self.session.post(
-                self.api_endpoint,
-                headers=self.headers,
-                json=data,
-                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:
-                    try:
-                        chunk = json.loads(line.split('data: ')[1])
-                        if token_text := chunk.get('token', {}).get('text'):
-                            if '<|eot_id|>' not in token_text:
-                                streaming_response += token_text
-                                yield token_text if raw else {"text": token_text}
-                    except (json.JSONDecodeError, IndexError) as e:
-                        continue
-
-            self.last_response.update({"text": streaming_response})
-            self.conversation.update_chat_history(
-                prompt, self.get_message(self.last_response)
-            )
-
-        def for_non_stream():
-            full_response = ""
-            for chunk in for_stream():
-                full_response += chunk if raw else chunk['text']
-            return {"text": full_response}
-
-        return for_stream() if stream else for_non_stream()
-
-    def chat(
-        self,
-        prompt: str,
-        stream: bool = True,
-        optimizer: str = None,
-        conversationally: bool = False,
-    ) -> str | Generator[str, None, None]:
-        """Generates a response from the Llama3 Mitril API."""
-
-        def for_stream():
-            for response in self.ask(
-                prompt, stream=True, optimizer=optimizer, conversationally=conversationally
-            ):
-                yield self.get_message(response)
-
-        def for_non_stream():
-            return self.get_message(
-                self.ask(
-                    prompt, stream=False, optimizer=optimizer, conversationally=conversationally
-                )
-            )
-
-        return for_stream() if stream else for_non_stream()
-
-    def get_message(self, response: Dict[str, Any]) -> str:
-        """Extracts the message from the API response."""
-        assert isinstance(response, dict), "Response should be of dict data-type only"
-        return response["text"]
-
-
-if __name__ == "__main__":
-    from rich import print
-    
-    ai = Llama3Mitril(
-        max_tokens=2048,
-        temperature=0.8,
-        timeout=30
-    )
-
-    for response in ai.chat("Hello", stream=True):
+import requests
+import json
+import re
+from typing import Any, Dict, Optional, Generator
+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 import LitAgent as Lit
+
+class Llama3Mitril(Provider):
+    """
+    A class to interact with the Llama3 Mitril API. Implements the WebScout provider interface.
+    """
+
+    def __init__(
+        self,
+        is_conversation: bool = True,
+        max_tokens: int = 2048,
+        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, respectful and honest assistant.",
+        temperature: float = 0.8,
+    ):
+        """Initializes the Llama3Mitril API."""
+        self.session = requests.Session()
+        self.is_conversation = is_conversation
+        self.max_tokens = max_tokens
+        self.temperature = temperature
+        self.api_endpoint = "https://llama3.mithrilsecurity.io/generate_stream"
+        self.timeout = timeout
+        self.last_response = {}
+        self.system_prompt = system_prompt
+        self.headers = {
+            "Content-Type": "application/json",
+            "DNT": "1",
+            "User-Agent": Lit().random(),
+        }
+        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, filepath, update_file
+        )
+        self.conversation.history_offset = history_offset
+        self.session.proxies = proxies
+
+    def _format_prompt(self, prompt: str) -> str:
+        """Format the prompt for the Llama3 model"""
+        return (
+            f"<|begin_of_text|>"
+            f"<|start_header_id|>system<|end_header_id|>{self.system_prompt}<|eot_id|>"
+            f"<|start_header_id|>user<|end_header_id|>{prompt}<|eot_id|>"
+            f"<|start_header_id|>assistant<|end_header_id|><|eot_id|>"
+            f"<|start_header_id|>assistant<|end_header_id|>"
+        )
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = True,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> Dict[str, Any] | Generator[Dict[str, Any], None, None]:
+        """Sends a prompt to the Llama3 Mitril API and returns the 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 exceptions.FailedToGenerateResponseError(
+                    f"Optimizer is not one of {self.__available_optimizers}"
+                )
+
+        data = {
+            "inputs": self._format_prompt(conversation_prompt),
+            "parameters": {
+                "max_new_tokens": self.max_tokens,
+                "temperature": self.temperature,
+                "return_full_text": False
+            }
+        }
+
+        def for_stream():
+            response = self.session.post(
+                self.api_endpoint,
+                headers=self.headers,
+                json=data,
+                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:
+                    try:
+                        chunk = json.loads(line.split('data: ')[1])
+                        if token_text := chunk.get('token', {}).get('text'):
+                            if '<|eot_id|>' not in token_text:
+                                streaming_response += token_text
+                                yield token_text if raw else {"text": token_text}
+                    except (json.JSONDecodeError, IndexError) as e:
+                        continue
+
+            self.last_response.update({"text": streaming_response})
+            self.conversation.update_chat_history(
+                prompt, self.get_message(self.last_response)
+            )
+
+        def for_non_stream():
+            full_response = ""
+            for chunk in for_stream():
+                full_response += chunk if raw else chunk['text']
+            return {"text": full_response}
+
+        return for_stream() if stream else for_non_stream()
+
+    def chat(
+        self,
+        prompt: str,
+        stream: bool = True,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> str | Generator[str, None, None]:
+        """Generates a response from the Llama3 Mitril API."""
+
+        def for_stream():
+            for response in self.ask(
+                prompt, stream=True, optimizer=optimizer, conversationally=conversationally
+            ):
+                yield self.get_message(response)
+
+        def for_non_stream():
+            return self.get_message(
+                self.ask(
+                    prompt, stream=False, optimizer=optimizer, conversationally=conversationally
+                )
+            )
+
+        return for_stream() if stream else for_non_stream()
+
+    def get_message(self, response: Dict[str, Any]) -> str:
+        """Extracts the message from the API response."""
+        assert isinstance(response, dict), "Response should be of dict data-type only"
+        return response["text"]
+
+
+if __name__ == "__main__":
+    from rich import print
+    
+    ai = Llama3Mitril(
+        max_tokens=2048,
+        temperature=0.8,
+        timeout=30
+    )
+
+    for response in ai.chat("Hello", stream=True):
         print(response, end="", flush=True)

webscout/Provider/llamatutor.py

@@ -1,3 +1,4 @@
+
 import requests
 import json
 
@@ -7,9 +8,11 @@ from webscout.AIutel import AwesomePrompts
 from webscout.AIbase import Provider
 from webscout import exceptions
 from webscout import LitAgent as Lit
+from webscout.Litlogger import Logger, LogFormat
+
 class LlamaTutor(Provider):
     """
-    A class to interact with the LlamaTutor API (Together.ai).
+    A class to interact with the LlamaTutor API (Together.ai) with comprehensive logging.
     """
 
     def __init__(
@@ -24,23 +27,20 @@ class LlamaTutor(Provider):
         history_offset: int = 10250,
         act: str = None,
         system_prompt: str = "You are a helpful AI assistant.",
+        logging: bool = False
     ):
         """
-        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.".
+        Initializes the LlamaTutor API with given parameters and logging capabilities.
         """
+        self.logger = Logger(
+            name="LlamaTutor",
+            format=LogFormat.MODERN_EMOJI,
+
+        ) if logging else None
+
+        if self.logger:
+            self.logger.info("Initializing LlamaTutor API")
+
         self.session = requests.Session()
         self.is_conversation = is_conversation
         self.max_tokens_to_sample = max_tokens
@@ -49,6 +49,7 @@ class LlamaTutor(Provider):
         self.timeout = timeout
         self.last_response = {}
         self.system_prompt = system_prompt
+        
         self.headers = {
             "Content-Type": "application/json",
             "Accept": "*/*",
@@ -71,7 +72,12 @@ class LlamaTutor(Provider):
             for method in dir(Optimizers)
             if callable(getattr(Optimizers, method)) and not method.startswith("__")
         )
+        
         self.session.headers.update(self.headers)
+        
+        if self.logger:
+            self.logger.debug("Headers configured and session updated")
+
         Conversation.intro = (
             AwesomePrompts().get_act(
                 act, raise_not_found=True, default=None, case_insensitive=True
@@ -79,12 +85,16 @@ class LlamaTutor(Provider):
             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
 
+        if self.logger:
+            self.logger.info("LlamaTutor initialized successfully")
+
     def ask(
         self,
         prompt: str,
@@ -93,32 +103,23 @@ class LlamaTutor(Provider):
         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?"
-        }
-        ```
-        """
+        """Chat with LlamaTutor with logging capabilities"""
+        if self.logger:
+            self.logger.debug(f"Processing request - Prompt: {prompt[:50]}...")
+            self.logger.debug(f"Stream: {stream}, Optimizer: {optimizer}")
+
         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
                 )
+                if self.logger:
+                    self.logger.debug(f"Applied optimizer: {optimizer}")
             else:
-                raise Exception(
-                    f"Optimizer is not one of {self.__available_optimizers}"
-                )
+                if self.logger:
+                    self.logger.error(f"Invalid optimizer requested: {optimizer}")
+                raise Exception(f"Optimizer is not one of {self.__available_optimizers}")
         
         payload = {
             "messages": [
@@ -135,19 +136,35 @@ class LlamaTutor(Provider):
 
         def for_stream():
             try:
-                response = requests.post(self.api_endpoint, headers=self.headers, data=json.dumps(payload), stream=True, timeout=self.timeout)
+                if self.logger:
+                    self.logger.debug("Initiating streaming request to API")
+
+                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
+                if self.logger:
+                    self.logger.info(f"API connection established successfully. Status: {response.status_code}")
+                
                 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=json_data["text"])
+                        try:
+                            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=json_data["text"])
+                        except json.JSONDecodeError as e:
+                            if self.logger:
+                                self.logger.warning(f"Failed to parse response line: {e}")
+                            continue
 
                 self.last_response.update(dict(text=full_response))
                 self.conversation.update_chat_history(
@@ -155,11 +172,17 @@ class LlamaTutor(Provider):
                 )
 
             except requests.exceptions.HTTPError as http_err:
+                if self.logger:
+                    self.logger.error(f"HTTP error occurred: {http_err}")
                 raise exceptions.FailedToGenerateResponseError(f"HTTP error occurred: {http_err}")
             except requests.exceptions.RequestException as err:
+                if self.logger:
+                    self.logger.error(f"Request error occurred: {err}")
                 raise exceptions.FailedToGenerateResponseError(f"An error occurred: {err}")
 
         def for_non_stream():
+            if self.logger:
+                self.logger.debug("Processing non-streaming request")
             for _ in for_stream():
                 pass
             return self.last_response
@@ -173,15 +196,9 @@ class LlamaTutor(Provider):
         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
-        """
+        """Generate response with logging capabilities"""
+        if self.logger:
+            self.logger.debug(f"Chat request initiated - Prompt: {prompt[:50]}...")
 
         def for_stream():
             for response in self.ask(
@@ -202,21 +219,14 @@ class LlamaTutor(Provider):
         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
-        """
+        """Retrieves message from response with validation"""
         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("write a poem about AI", stream=True)
+    # Enable logging for testing
+    ai = LlamaTutor(logging=True)
+    response = ai.chat("Write a poem about AI", stream=True)
     for chunk in response:
         print(chunk, end="", flush=True)