webscout 7.1__py3-none-any.whl → 7.3__py3-none-any.whl

webscout/Provider/geminiapi.py

@@ -1,208 +1,208 @@
-"""
-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)
+"""
+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/granite.py

@@ -0,0 +1,223 @@
+import requests
+import json
+from typing import Any, Dict, Generator
+
+from webscout.AIutel import Optimizers, Conversation, AwesomePrompts
+from webscout.AIbase import Provider
+from webscout import exceptions
+from webscout.Litlogger import Logger, LogFormat
+from webscout import LitAgent as Lit
+class IBMGranite(Provider):
+    """
+    A class to interact with the IBM Granite API (accessed via d18n68ssusgr7r.cloudfront.net)
+    with comprehensive logging and using Lit agent for the user agent.
+    """
+
+    AVAILABLE_MODELS = ["granite-3-8b-instruct"]
+
+    def __init__(
+        self,
+        api_key: str,
+        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,
+        model: str = "granite-3-8b-instruct",
+        system_prompt: str = "You are a helpful AI assistant.",
+        logging: bool = False
+    ):
+        """Initializes the IBM Granite API client with logging and Lit agent for the user agent."""
+        if model not in self.AVAILABLE_MODELS:
+            raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
+
+        # Setup logging if enabled
+        self.logger = Logger(
+            name="IBMGranite",
+            format=LogFormat.MODERN_EMOJI,
+
+        ) if logging else None
+
+        if self.logger:
+            self.logger.info(f"Initializing IBMGranite with model: {model}")
+
+        self.session = requests.Session()
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_tokens
+        self.api_endpoint = "https://d18n68ssusgr7r.cloudfront.net/v1/chat/completions"
+        self.stream_chunk_size = 64
+        self.timeout = timeout
+        self.last_response = {}
+        self.model = model
+        self.system_prompt = system_prompt
+
+        # Use Lit agent to generate a random User-Agent
+        self.headers = {
+            "authority": "d18n68ssusgr7r.cloudfront.net",
+            "accept": "application/json,application/jsonl",
+            "content-type": "application/json",
+            "origin": "https://www.ibm.com",
+            "referer": "https://www.ibm.com/",
+            "user-agent": Lit().random(),
+        }
+        self.headers["Authorization"] = f"Bearer {api_key}"
+        self.session.headers.update(self.headers)
+        self.session.proxies = proxies
+
+        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
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> Dict[str, Any] | Generator[Dict[str, Any], None, None]:
+        """Chat with AI
+        Args:
+            prompt (str): Prompt to be sent.
+            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:
+            Union[Dict, Generator[Dict, None, None]]: Response generated
+        """
+        if self.logger:
+            self.logger.debug(f"Ask method initiated - Prompt (first 50 chars): {prompt[:50]}")
+
+        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:
+                if self.logger:
+                    self.logger.error(f"Invalid optimizer requested: {optimizer}")
+                raise Exception(f"Optimizer is not one of {self.__available_optimizers}")
+
+        payload = {
+            "model": self.model,
+            "messages": [
+                {"role": "system", "content": self.system_prompt},
+                {"role": "user", "content": conversation_prompt},
+            ],
+            "stream": stream
+        }
+
+        def for_stream():
+            try:
+                if self.logger:
+                    self.logger.debug(f"Sending POST request to {self.api_endpoint} with payload: {payload}")
+                response = self.session.post(
+                    self.api_endpoint, headers=self.headers, json=payload, stream=True, timeout=self.timeout
+                )
+                if not response.ok:
+                    msg = f"Request failed with status code {response.status_code}: {response.text}"
+                    if self.logger:
+                        self.logger.error(msg)
+                    raise exceptions.FailedToGenerateResponseError(msg)
+
+                streaming_text = ""
+                for line in response.iter_lines(decode_unicode=True):
+                    if line:
+                        try:
+                            data = json.loads(line)
+                            if len(data) == 2 and data[0] == 3 and isinstance(data[1], str):
+                                content = data[1]
+                                streaming_text += content
+                                yield content if raw else dict(text=content)
+                            else:
+                                if self.logger:
+                                    self.logger.debug(f"Skipping unrecognized line: {line}")
+                        except json.JSONDecodeError as e:
+                            if self.logger:
+                                self.logger.error(f"JSON decode error: {e}")
+                            continue
+                self.last_response.update(dict(text=streaming_text))
+                self.conversation.update_chat_history(prompt, self.get_message(self.last_response))
+                if self.logger:
+                    self.logger.info("Stream processing completed.")
+
+            except requests.exceptions.RequestException as e:
+                if self.logger:
+                    self.logger.error(f"Request exception: {e}")
+                raise exceptions.ProviderConnectionError(f"Request failed: {e}")
+            except json.JSONDecodeError as e:
+                if self.logger:
+                    self.logger.error(f"Invalid JSON received: {e}")
+                raise exceptions.InvalidResponseError(f"Failed to decode JSON response: {e}")
+            except Exception as e:
+                if self.logger:
+                    self.logger.error(f"Unexpected error: {e}")
+                raise exceptions.FailedToGenerateResponseError(f"An unexpected error occurred: {e}")
+
+        def for_non_stream():
+            # Run the generator to completion
+            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 | Generator[str, None, None]:
+        """Generate response as a string using chat method"""
+        if self.logger:
+            self.logger.debug(f"Chat method initiated - Prompt (first 50 chars): {prompt[:50]}")
+
+        def for_stream():
+            for response in self.ask(prompt, True, optimizer=optimizer, conversationally=conversationally):
+                yield self.get_message(response)
+
+        def for_non_stream():
+            result = self.get_message(
+                self.ask(prompt, False, optimizer=optimizer, conversationally=conversationally)
+            )
+            if self.logger:
+                self.logger.info("Chat method completed.")
+            return result
+
+        return for_stream() if stream else for_non_stream()
+
+    def get_message(self, response: dict) -> str:
+        """Retrieves message only from response"""
+        assert isinstance(response, dict), "Response should be of dict data-type only"
+        return response["text"]
+
+if __name__ == "__main__":
+    from rich import print
+    # Example usage: Initialize with logging enabled.
+    ai = IBMGranite(
+        api_key="", # press f12 to see the API key
+        logging=True
+    )
+    response = ai.chat("write a poem about AI", stream=True)
+    for chunk in response:
+        print(chunk, end="", flush=True)