webscout 6.2b0__py3-none-any.whl → 6.3__py3-none-any.whl

webscout/Provider/geminiapi.py

@@ -1,198 +1,208 @@
-"""
-Install the Google AI Python SDK
-
-$ pip install google-generativeai
-"""
-
-import os
-import google.generativeai as genai
-
-import requests
-from webscout.AIutel import Optimizers
-from webscout.AIutel import Conversation
-from webscout.AIutel import AwesomePrompts
-from webscout.AIbase import Provider
-
-
-class GEMINIAPI(Provider):
-    """
-    A class to interact with the Gemini API using the google-generativeai library.
-    """
-
-    def __init__(
-        self,
-        api_key,
-        model_name: str = "gemini-1.5-flash-latest",
-        temperature: float = 1,
-        top_p: float = 0.95,
-        top_k: int = 64,
-        max_output_tokens: int = 8192,
-        is_conversation: bool = True,
-        timeout: int = 30,
-        intro: str = None,
-        filepath: str = None,
-        update_file: bool = True,
-        proxies: dict = {},
-        history_offset: int = 10250,
-        act: str = None,
-        system_instruction: str = "You are a helpful and informative AI assistant.",
-    ):
-        """
-        Initializes the Gemini API with the given parameters.
-
-        Args:
-            api_key (str, optional): Your Gemini API key. If None, it will use the environment variable "GEMINI_API_KEY". 
-                                      Defaults to None.
-            model_name (str, optional): The name of the Gemini model to use. 
-                                        Defaults to "gemini-1.5-flash-exp-0827".
-            temperature (float, optional): The temperature parameter for the model. Defaults to 1.
-            top_p (float, optional): The top_p parameter for the model. Defaults to 0.95.
-            top_k (int, optional): The top_k parameter for the model. Defaults to 64.
-            max_output_tokens (int, optional): The maximum number of output tokens. Defaults to 8192.
-            is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
-            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_instruction (str, optional): System instruction to guide the AI's behavior. 
-                                                Defaults to "You are a helpful and informative AI assistant.".
-        """
-        self.api_key = api_key
-        self.model_name = model_name
-        self.temperature = temperature
-        self.top_p = top_p
-        self.top_k = top_k
-        self.max_output_tokens = max_output_tokens
-        self.system_instruction = system_instruction
-
-        self.session = requests.Session()  # Not directly used for Gemini API calls, but can be used for other requests
-        self.is_conversation = is_conversation
-        self.max_tokens_to_sample = max_output_tokens
-        self.timeout = timeout
-        self.last_response = {}
-
-        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_to_sample, filepath, update_file
-        )
-        self.conversation.history_offset = history_offset
-        self.session.proxies = proxies
-
-        # Configure the Gemini API
-        genai.configure(api_key=self.api_key)
-
-        # Create the model with generation config
-        self.generation_config = {
-            "temperature": self.temperature,
-            "top_p": self.top_p,
-            "top_k": self.top_k,
-            "max_output_tokens": self.max_output_tokens,
-            "response_mime_type": "text/plain",
-        }
-        self.model = genai.GenerativeModel(
-            model_name=self.model_name,
-            generation_config=self.generation_config,
-            system_instruction=self.system_instruction,
-        )
-
-        # Start the chat session
-        self.chat_session = self.model.start_chat()
-
-    def ask(
-        self,
-        prompt: str,
-        stream: bool = False,
-        raw: bool = False,
-        optimizer: str = None,
-        conversationally: bool = False,
-    ) -> dict:
-        """Chat with AI
-
-        Args:
-            prompt (str): Prompt to be send.
-            stream (bool, optional): Not used for Gemini API. Defaults to False.
-            raw (bool, optional): Not used for Gemini API. 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}"
-                )
-
-        # Send the message to the chat session and get the response
-        response = self.chat_session.send_message(conversation_prompt)
-        self.last_response.update(dict(text=response.text))
-        self.conversation.update_chat_history(
-            prompt, self.get_message(self.last_response)
-        )
-        return self.last_response 
-
-    def chat(
-        self,
-        prompt: str,
-        stream: bool = False,  # Streaming not supported by the current google-generativeai library
-        optimizer: str = None,
-        conversationally: bool = False,
-    ) -> str:
-        """Generate response `str`
-
-        Args:
-            prompt (str): Prompt to be send.
-            stream (bool, optional): Not used for Gemini API. 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__":
-    ai = GEMINIAPI(api_key="")
-    res = ai.chat(input(">>> "))
-    for r in res:
-        print(r, end="", flush=True)
+"""
+Install the Google AI Python SDK
+
+$ pip install google-generativeai
+"""
+
+import os
+import google.generativeai as genai
+
+from google.generativeai.types import HarmCategory, HarmBlockThreshold
+import requests
+from webscout.AIutel import Optimizers
+from webscout.AIutel import Conversation
+from webscout.AIutel import AwesomePrompts
+from webscout.AIbase import Provider
+
+
+class GEMINIAPI(Provider):
+    """
+    A class to interact with the Gemini API using the google-generativeai library.
+    """
+
+    def __init__(
+        self,
+        api_key,
+        model_name: str = "gemini-1.5-flash-latest",
+        temperature: float = 1,
+        top_p: float = 0.95,
+        top_k: int = 64,
+        max_output_tokens: int = 8192,
+        is_conversation: bool = True,
+        timeout: int = 30,
+        intro: str = None,
+        filepath: str = None,
+        update_file: bool = True,
+        proxies: dict = {},
+        history_offset: int = 10250,
+        act: str = None,
+        system_instruction: str = "You are a helpful and informative AI assistant.",
+        safety_settings: dict = None,
+    ):
+        """
+        Initializes the Gemini API with the given parameters.
+
+        Args:
+            api_key (str, optional): Your Gemini API key. If None, it will use the environment variable "GEMINI_API_KEY". 
+                                      Defaults to None.
+            model_name (str, optional): The name of the Gemini model to use. 
+                                        Defaults to "gemini-1.5-flash-exp-0827".
+            temperature (float, optional): The temperature parameter for the model. Defaults to 1.
+            top_p (float, optional): The top_p parameter for the model. Defaults to 0.95.
+            top_k (int, optional): The top_k parameter for the model. Defaults to 64.
+            max_output_tokens (int, optional): The maximum number of output tokens. Defaults to 8192.
+            is_conversation (bool, optional): Flag for chatting conversationally. Defaults to True.
+            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_instruction (str, optional): System instruction to guide the AI's behavior. 
+                                                Defaults to "You are a helpful and informative AI assistant.".
+        """
+        self.api_key = api_key
+        self.model_name = model_name
+        self.temperature = temperature
+        self.top_p = top_p
+        self.top_k = top_k
+        self.max_output_tokens = max_output_tokens
+        self.system_instruction = system_instruction
+        self.safety_settings = safety_settings if safety_settings else {}
+        self.session = requests.Session()  # Not directly used for Gemini API calls, but can be used for other requests
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_output_tokens
+        self.timeout = timeout
+        self.last_response = {}
+
+        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_to_sample, filepath, update_file
+        )
+        self.conversation.history_offset = history_offset
+        self.session.proxies = proxies
+
+        # Configure the Gemini API
+        genai.configure(api_key=self.api_key)
+
+        # Create the model with generation config
+        self.generation_config = {
+            "temperature": self.temperature,
+            "top_p": self.top_p,
+            "top_k": self.top_k,
+            "max_output_tokens": self.max_output_tokens,
+            "response_mime_type": "text/plain",
+        }
+
+        self.model = genai.GenerativeModel(
+            model_name=self.model_name,
+            generation_config=self.generation_config,
+            safety_settings=self.safety_settings,
+            system_instruction=self.system_instruction,
+        )
+
+        # Start the chat session
+        self.chat_session = self.model.start_chat()
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> dict:
+        """Chat with AI
+
+        Args:
+            prompt (str): Prompt to be send.
+            stream (bool, optional): Not used for Gemini API. Defaults to False.
+            raw (bool, optional): Not used for Gemini API. 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}"
+                )
+
+        # Send the message to the chat session and get the response
+        response = self.chat_session.send_message(conversation_prompt)
+        self.last_response.update(dict(text=response.text))
+        self.conversation.update_chat_history(
+            prompt, self.get_message(self.last_response)
+        )
+        return self.last_response 
+
+    def chat(
+        self,
+        prompt: str,
+        stream: bool = False,  # Streaming not supported by the current google-generativeai library
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> str:
+        """Generate response `str`
+
+        Args:
+            prompt (str): Prompt to be send.
+            stream (bool, optional): Not used for Gemini API. 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__":
+    safety_settings = {
+        HarmCategory.HARM_CATEGORY_HATE_SPEECH: HarmBlockThreshold.BLOCK_NONE,
+        HarmCategory.HARM_CATEGORY_HARASSMENT: HarmBlockThreshold.BLOCK_NONE,
+        HarmCategory.HARM_CATEGORY_SEXUALLY_EXPLICIT: HarmBlockThreshold.BLOCK_NONE,
+        HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT: HarmBlockThreshold.BLOCK_NONE,
+    }
+    ai = GEMINIAPI(api_key="" , safety_settings=safety_settings)
+    res = ai.chat(input(">>> "))
+    for r in res:
+        print(r, end="", flush=True)

webscout/Provider/llama3mitril.py

@@ -0,0 +1,181 @@
+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
+
+
+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": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36 Edg/130.0.0.0"
+        }
+        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)