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

webscout/Provider/granite.py

@@ -1,187 +0,0 @@
-import requests
-import json
-from typing import Union, Any, Dict, Generator
-
-from webscout.AIutel import Optimizers, Conversation, AwesomePrompts
-from webscout.AIbase import Provider
-from webscout import exceptions
-from webscout.litagent import LitAgent as Lit
-
-class IBMGranite(Provider):
-    """
-    A class to interact with the IBM Granite API (accessed via d18n68ssusgr7r.cloudfront.net)
-    using Lit agent for the user agent.
-    """
-
-    AVAILABLE_MODELS = ["granite-3-8b-instruct", "granite-3-2-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-2-8b-instruct",
-        system_prompt: str = "You are a helpful AI assistant.",
-        thinking: bool = False,
-    ):
-        """Initializes the IBMGranite API client using Lit agent for the user agent."""
-        if model not in self.AVAILABLE_MODELS:
-            raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
-
-        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
-        self.thinking = thinking
-
-        # 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,
-    ) -> Union[Dict[str, Any], Generator[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
-        """
-        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 = {
-            "model": self.model,
-            "messages": [
-                {"role": "system", "content": self.system_prompt},
-                {"role": "user", "content": conversation_prompt},
-            ],
-            "stream": stream,
-            "thinking": self.thinking,
-        }
-
-        def for_stream():
-            try:
-                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}"
-                    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:
-                                # Skip unrecognized lines
-                                pass
-                        except json.JSONDecodeError:
-                            continue
-                self.last_response.update(dict(text=streaming_text))
-                self.conversation.update_chat_history(prompt, self.get_message(self.last_response))
-            except requests.exceptions.RequestException as e:
-                raise exceptions.ProviderConnectionError(f"Request failed: {e}")
-            except json.JSONDecodeError as e:
-                raise exceptions.InvalidResponseError(f"Failed to decode JSON response: {e}")
-            except Exception as 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,
-    ) -> Union[str, Generator[str, None, None]]:
-        """Generate response as a string using chat method"""
-        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"""
-        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 without logging.
-    ai = IBMGranite(
-        api_key="",  # press f12 to see the API key
-        thinking=True,
-    )
-    response = ai.chat("write a poem about AI", stream=True)
-    for chunk in response:
-        print(chunk, end="", flush=True)

webscout/Provider/hermes.py

@@ -1,219 +0,0 @@
-import requests
-import json
-from typing import Union, Any, Dict, Generator, Optional
-
-from webscout.AIutel import Optimizers
-from webscout.AIutel import Conversation
-from webscout.AIutel import AwesomePrompts
-from webscout.AIbase import Provider
-from webscout import exceptions
-from webscout.litagent import LitAgent
-class NousHermes(Provider):
-    """
-    A class to interact with the Hermes API.
-    """
-
-    AVAILABLE_MODELS = ["Hermes-3-Llama-3.1-70B", "Hermes-3-Llama-3.1-8B"]
-
-    def __init__(
-        self,
-        cookies_path: str,
-        is_conversation: bool = True,
-        max_tokens: int = 8000,
-        timeout: int = 30,
-        intro: str = None,
-        filepath: str = None,
-        update_file: bool = True,
-        proxies: dict = {},
-        history_offset: int = 10250,
-        act: str = None,
-        model: str = "Hermes-3-Llama-3.1-70B",
-        system_prompt: str = "You are a helpful AI assistant.",
-        temperature: float = 0.7,
-        top_p: float = 0.9,
-    ):
-        """Initializes the Hermes API client."""
-        if model not in self.AVAILABLE_MODELS:
-            raise ValueError(
-                f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}"
-            )
-
-        self.session = requests.Session()
-        self.is_conversation = is_conversation
-        self.max_tokens_to_sample = max_tokens
-        self.timeout = timeout
-        self.last_response = {}
-        self.model = model
-        self.system_prompt = system_prompt
-        self.api_endpoint = "https://hermes.nousresearch.com/api/chat"
-        self.temperature = temperature
-        self.top_p = top_p
-        self.cookies_path = cookies_path
-        self.cookies = self._load_cookies()
-        self.headers = {
-            'accept': '*/*',
-            'accept-language': 'en-US,en;q=0.9',
-            'content-type': 'application/json',
-            'origin': 'https://hermes.nousresearch.com',
-            'referer': 'https://hermes.nousresearch.com/',
-            'user-agent': LitAgent().random(),
-            'cookie': self.cookies
-        }
-
-        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 _load_cookies(self) -> Optional[str]:
-        """Load cookies from a JSON file and convert them to a string."""
-        try:
-            with open(self.cookies_path, 'r') as f:
-                cookies_data = json.load(f)
-            return '; '.join([f"{cookie['name']}={cookie['value']}" for cookie in cookies_data])
-        except FileNotFoundError:
-            print("Error: cookies.json file not found!")
-            return None
-        except json.JSONDecodeError:
-            print("Error: Invalid JSON format in cookies.json!")
-            return None
-
-    def ask(
-        self,
-        prompt: str,
-        stream: bool = False,
-        raw: bool = False,
-        optimizer: str = None,
-        conversationally: bool = False,
-    ) -> Union[Dict[str, Any], Generator[Any, None, None]]:
-        """Chat with AI
-        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|AsyncGenerator : ai content
-        ```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 exceptions.FailedToGenerateResponseError(
-                    f"Optimizer is not one of {self.__available_optimizers}"
-                )
-
-        payload = {
-            "messages": [{"role": "system", "content": self.system_prompt}, {"role": "user", "content": conversation_prompt}],
-            "model": self.model,
-            "max_tokens": self.max_tokens_to_sample,
-            "temperature": self.temperature,
-            "top_p": self.top_p,
-        }
-        def for_stream():
-            response = self.session.post(self.api_endpoint, headers=self.headers, json=payload, stream=True, timeout=self.timeout)
-            if not response.ok:
-                raise exceptions.FailedToGenerateResponseError(
-                    f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
-                )
-            full_response = ""
-            for line in response.iter_lines():
-                if line:
-                    decoded_line = line.decode('utf-8').replace('data: ', '')
-                    try:
-                        data = json.loads(decoded_line)
-                        if data['type'] == 'llm_response':
-                            content = data['content']
-                            full_response += content
-                            yield content if raw else dict(text=content)
-                    except json.JSONDecodeError:
-                        continue
-            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,
-    ) -> Union[str, Generator[str, None, None]]:
-        """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 = NousHermes(cookies_path="cookies.json")
-    response = ai.chat(input(">>> "), stream=True)
-    for chunk in response:
-        print(chunk, end="", flush=True)

webscout/Provider/koala.py

@@ -1,268 +0,0 @@
-import requests
-import json
-from typing import Union, Any, Dict, Optional
-from webscout.AIutel import Optimizers
-from webscout.AIutel import Conversation
-from webscout.AIutel import AwesomePrompts, sanitize_stream
-from webscout.AIbase import Provider
-from webscout import exceptions
-
-class KOALA(Provider):
-    """
-    A class to interact with the Koala.sh API.
-    """
-
-    AVAILABLE_MODELS = [
-        "gpt-4.1-mini",
-        "gpt-4.1",
-    ]
-
-    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,
-        model: str = "gpt-4o",
-        web_search: bool = True,
-
-    ) -> None:
-        """
-        Initializes the KOALASH 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.
-            model (str, optional): AI model to use. Defaults to "gpt-4o-mini".
-        """
-        if model not in self.AVAILABLE_MODELS:
-            raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
-            
-        self.session = requests.Session()
-        self.is_conversation = is_conversation
-        self.max_tokens_to_sample = max_tokens
-        self.api_endpoint = "https://koala.sh/api/gpt/"
-        self.stream_chunk_size = 64
-        self.timeout = timeout
-        self.last_response = {}
-        self.model = model
-        self.headers = {
-            "accept": "text/event-stream",
-            "accept-encoding": "gzip, deflate, br, zstd",
-            "accept-language": "en-US,en;q=0.9,en-IN;q=0.8",
-            "content-length": "73",
-            "content-type": "application/json",
-            "dnt": "1",
-            "flag-real-time-data": "true" if web_search else "false", 
-            "origin": "https://koala.sh",
-            "priority": "u=1, i",
-            "referer": "https://koala.sh/chat",
-            "sec-ch-ua": '"Not)A;Brand";v="99", "Microsoft Edge";v="127", "Chromium";v="127"',
-            "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/127.0.0.0 Safari/537.36 Edg/127.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[str, Any]:
-        """
-        Sends a prompt to the Koala.sh API and returns the response.
-
-        Args:
-            prompt: The text prompt to generate text from.
-            stream (bool, optional): Whether to stream the response. Defaults to False.
-            raw (bool, optional): Whether to return the raw response. Defaults to False.
-            optimizer (str, optional): The name of the optimizer to use. Defaults to None.
-            conversationally (bool, optional): Whether to chat conversationally. Defaults to False.
-
-        Returns:
-            The response from the API.
-        """
-        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 = {
-            "input": conversation_prompt,
-            "model": self.model 
-        }
-
-        def for_stream():
-            response = self.session.post(
-                self.api_endpoint, json=payload, headers=self.headers, stream=True, timeout=self.timeout
-            )
-
-            if not response.ok:
-                raise exceptions.FailedToGenerateResponseError(
-                    f"Failed to generate response - ({response.status_code}, {response.reason})"
-                )
-            
-            streaming_response = ""
-            for line in response.iter_lines(decode_unicode=True):
-                if line:
-                    if line.startswith("data:"):
-                        data = line[len("data:"):].strip()
-                        if data:
-                            try:
-                                event = json.loads(data)
-                                streaming_response += event.get("choices", [{}])[0].get("delta", {}).get("content", "")
-                                yield event if raw else dict(text=streaming_response)
-                            except json.decoder.JSONDecodeError:
-                                continue
-            self.last_response.update(dict(text=streaming_response))
-            self.conversation.update_chat_history(
-                prompt, self.get_message(self.last_response)
-            )
-        def for_non_stream():
-            response = self.session.post(
-                self.api_endpoint, json=payload, headers=self.headers, timeout=self.timeout
-            )
-
-            if not response.ok:
-                raise exceptions.FailedToGenerateResponseError(
-                    f"Failed to generate response - ({response.status_code}, {response.reason})"
-                )
-            
-            response_content = response.content.decode('utf-8')
-            data_parts = response_content.strip().split('\n\n')
-            formatted_response = ''.join([part.replace('data: ', '') for part in data_parts if part.startswith('data: ')])
-
-            # Remove extra quotes from the formatted response
-            formatted_response = formatted_response.replace('""', '')
-
-            # Split the response into lines and format with new lines before headers
-            lines = formatted_response.split('\n')
-            formatted_lines = []
-            for line in lines:
-                if line.startswith('###'):
-                    formatted_lines.append('\n' + line)
-                else:
-                    formatted_lines.append(line)
-
-            # Join the formatted lines back into a single string
-            final_response = '\n'.join(formatted_lines)
-
-            # self.last_response.update(dict(text=streaming_response))
-            self.conversation.update_chat_history(
-                prompt, final_response
-            )
-            return dict(text=final_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"].replace('\\n', '\n').replace('\\n\\n', '\n\n')
-if __name__ == '__main__':
-    print("-" * 80)
-    print(f"{'Model':<50} {'Status':<10} {'Response'}")
-    print("-" * 80)
-
-    for model in KOALA.AVAILABLE_MODELS:
-        try:
-            test_ai = KOALA(model=model, timeout=60)
-            response = test_ai.chat("Say 'Hello' in one word")
-            response_text = response
-            
-            if response_text and len(response_text.strip()) > 0:
-                status = "✓"
-                # Truncate response if too long
-                display_text = response_text.strip()[:50] + "..." if len(response_text.strip()) > 50 else response_text.strip()
-            else:
-                status = "✗"
-                display_text = "Empty or invalid response"
-            print(f"{model:<50} {status:<10} {display_text}")
-        except Exception as e:
-            print(f"{model:<50} {'✗':<10} {str(e)}")