webscout 8.2.7__py3-none-any.whl → 8.2.9__py3-none-any.whl

webscout/Provider/hermes.py

@@ -0,0 +1,266 @@
+from curl_cffi.requests import Session
+from curl_cffi import CurlError
+import json
+from typing import Union, Any, Dict, Generator, Optional
+
+from webscout.AIutel import Optimizers
+from webscout.AIutel import Conversation, sanitize_stream # Import sanitize_stream
+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 = 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_dict = 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/',
+        }
+
+        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
+        # Update curl_cffi session headers and proxies
+        self.session.proxies = proxies
+        
+        # Apply cookies to curl_cffi session
+        if self.cookies_dict:
+            for name, value in self.cookies_dict.items():
+                self.session.cookies.set(name, value, domain="hermes.nousresearch.com")
+
+    def _load_cookies(self) -> Optional[Dict[str, str]]:
+        """Load cookies from a JSON file and return them as a dictionary."""
+        try:
+            with open(self.cookies_path, 'r') as f:
+                cookies_data = json.load(f)
+            # Convert list of cookie objects to a dictionary
+            return {cookie['name']: cookie['value'] for cookie in cookies_data if 'name' in cookie and 'value' in cookie}
+        except FileNotFoundError:
+            print(f"Warning: Cookies file not found at {self.cookies_path}")
+            return None
+        except json.JSONDecodeError:
+            print(f"Warning: Invalid JSON format in cookies file at {self.cookies_path}")
+            return None
+        except Exception as e:
+            print(f"Warning: Error loading cookies: {e}")
+            return None
+
+    @staticmethod
+    def _hermes_extractor(chunk: Union[str, Dict[str, Any]]) -> Optional[str]:
+        """Extracts content from Hermes stream JSON objects."""
+        if isinstance(chunk, dict) and chunk.get('type') == 'llm_response':
+            return chunk.get('content')
+        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():
+            streaming_text = "" # Initialize outside try block
+            try:
+                response = self.session.post(
+                    self.api_endpoint, 
+                    json=payload, 
+                    stream=True, 
+                    timeout=self.timeout,
+                    impersonate="chrome110" # Keep impersonate
+                )
+                response.raise_for_status()
+
+                # Use sanitize_stream
+                processed_stream = sanitize_stream(
+                    data=response.iter_content(chunk_size=None), # Pass byte iterator
+                    intro_value="data:",
+                    to_json=True,     # Stream sends JSON
+                    content_extractor=self._hermes_extractor, # Use the specific extractor
+                    yield_raw_on_error=False # Skip non-JSON lines or lines where extractor fails
+                )
+
+                for content_chunk in processed_stream:
+                    # content_chunk is the string extracted by _hermes_extractor
+                    if content_chunk and isinstance(content_chunk, str):
+                        streaming_text += content_chunk
+                        resp = dict(text=content_chunk)
+                        yield resp if not raw else content_chunk
+
+                self.last_response = dict(text=streaming_text) # Use streaming_text
+                self.conversation.update_chat_history(
+                    prompt, streaming_text # Use streaming_text
+                )
+
+            except CurlError as e:
+                raise exceptions.FailedToGenerateResponseError(f"Request failed (CurlError): {e}") from e
+            except Exception as e:
+                err_text = getattr(e, 'response', None) and getattr(e.response, 'text', '')
+                raise exceptions.FailedToGenerateResponseError(f"Failed to generate response ({type(e).__name__}): {e} - {err_text}") from e
+
+
+        def for_non_stream():
+            collected_text = ""
+            try:
+                for chunk_data in for_stream():
+                    if isinstance(chunk_data, dict) and "text" in chunk_data:
+                        collected_text += chunk_data["text"]
+                    elif raw and isinstance(chunk_data, str):
+                         collected_text += chunk_data
+            except Exception as e:
+                 if not collected_text:
+                     raise exceptions.FailedToGenerateResponseError(f"Failed to get non-stream response: {str(e)}") from e
+
+            return collected_text if raw else 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_chat():
+            gen = self.ask(
+                prompt, stream=True, raw=False,
+                optimizer=optimizer, conversationally=conversationally
+            )
+            for response_dict in gen:
+                yield self.get_message(response_dict)
+
+        def for_non_stream_chat():
+            response_data = self.ask(
+                prompt,
+                stream=False,
+                raw=False,
+                optimizer=optimizer,
+                conversationally=conversationally,
+            )
+            return self.get_message(response_data)
+
+        return for_stream_chat() if stream else for_non_stream_chat()
+
+    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/julius.py

@@ -0,0 +1,223 @@
+
+import uuid
+
+import requests
+import json
+from webscout.AIutel import Optimizers
+from webscout.AIutel import Conversation
+from webscout.AIutel import AwesomePrompts, sanitize_stream
+from webscout.AIbase import Provider, AsyncProvider
+from webscout import exceptions
+from typing import Union, Any, AsyncGenerator, Dict
+
+
+class Julius(Provider):
+    AVAILABLE_MODELS = [
+        "Llama 3",
+        "GPT-4o",
+        "GPT-3.5",
+        "Command R",
+        "Gemini Flash",
+        "Gemini 1.5",
+        "Claude Sonnet",
+        "Claude Opus",
+        "Claude Haiku",
+        "GPT-4",
+        "GPT-4o mini",
+        "Command R+",
+        "o1-mini",
+        "o1-preview",
+
+
+    ]
+    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 = "Gemini Flash",
+    ):
+        """Instantiates Julius
+
+        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): Model to use for generating text. Defaults to "Gemini Flash". 
+                                   Options: "Llama 3", "GPT-4o", "GPT-3.5", "Command R", "Gemini Flash", "Gemini 1.5".
+        """
+        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.chat_endpoint = "https://api.julius.ai/api/chat/message"
+        self.stream_chunk_size = 64
+        self.timeout = timeout
+        self.last_response = {}
+        self.model = model
+        self.api_key = api_key
+        self.headers = {
+            "authorization": f"Bearer {self.api_key}",
+            "content-type": "application/json",
+            "conversation-id": str(uuid.uuid4()),
+            "interactive-charts": "true",
+            "is-native": "false",
+            "orient-split": "true",
+            "request-id": str(uuid.uuid4()),
+            "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",
+            "visitor-id": str(uuid.uuid4())
+        }
+
+        self.__available_optimizers = (
+            method
+            for method in dir(Optimizers)
+            if callable(getattr(Optimizers, method)) and not method.startswith("__")
+        )
+        self.session.headers.update(self.headers)
+        Conversation.intro = (
+            AwesomePrompts().get_act(
+                act, raise_not_found=True, default=None, case_insensitive=True
+            )
+            if act
+            else intro or Conversation.intro
+        )
+        self.conversation = Conversation(
+            is_conversation, self.max_tokens_to_sample, filepath, update_file
+        )
+        self.conversation.history_offset = history_offset
+        self.session.proxies = proxies
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> dict:
+        """Chat with AI
+
+        Args:
+            prompt (str): Prompt to be send.
+            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 = {
+            "message": {"content": conversation_prompt, "role": "user"},
+            "provider": "default",
+            "chat_mode": "auto",
+            "client_version": "20240130",
+            "theme": "dark",
+            "new_images": None,
+            "new_attachments": None,
+            "dataframe_format": "json",
+            "selectedModels": [self.model] # Choose the model here
+        }
+
+        def for_stream():
+            response = self.session.post(
+                self.chat_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:
+                    try:
+                        json_line = json.loads(line)
+                        content = json_line['content']
+                        streaming_response += content
+                        yield content if raw else dict(text=content)
+                    except:
+                        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():
+
+            for _ in for_stream():
+                pass
+            return self.last_response
+
+
+        return for_stream() if stream else for_non_stream()
+    def chat(
+        self,
+        prompt: str,
+        stream: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> str:
+        """Generate response `str`
+        Args:
+            prompt (str): Prompt to be send.
+            stream (bool, optional): Flag for streaming response. Defaults to False.
+            optimizer (str, optional): Prompt optimizer name - `[code, shell_command]`. Defaults to None.
+            conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
+        Returns:
+            str: Response generated
+        """
+
+        def for_stream():
+            for response in self.ask(
+                prompt, True, optimizer=optimizer, conversationally=conversationally
+            ):
+                yield self.get_message(response)
+
+        def for_non_stream():
+            return self.get_message(
+                self.ask(
+                    prompt,
+                    False,
+                    optimizer=optimizer,
+                    conversationally=conversationally,
+                )
+            )
+
+        return for_stream() if stream else for_non_stream()
+
+    def get_message(self, response: dict) -> str:
+        assert isinstance(response, dict), "Response should be of dict data-type only"
+        return response["text"]
+if __name__ == '__main__':
+    from rich import print
+    ai = Julius(api_key="",timeout=5000)
+    response = ai.chat("write a poem about AI", stream=True)
+    for chunk in response:
+        print(chunk, end="", flush=True)

webscout/Provider/koala.py

@@ -0,0 +1,170 @@
+import requests
+import re
+from typing import Optional, Union, Any, Dict, Generator
+from uuid import uuid4
+
+from webscout.AIutel import Optimizers, Conversation, AwesomePrompts
+from webscout.AIbase import Provider
+from webscout import exceptions
+
+class KOALA(Provider):
+    """
+    A class to interact with the Koala.sh API, X0GPT-style, without sanitize_stream.
+    """
+    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-4.1",
+        web_search: bool = True,
+    ):
+        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.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-type": "application/json",
+            "dnt": "1",
+            "flag-real-time-data": "true" if web_search else "false",
+            "origin": "https://koala.sh",
+            "referer": "https://koala.sh/chat",
+            "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.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
+
+    @staticmethod
+    def _koala_extractor(line: str) -> Optional[str]:
+        # Koala returns lines like: data: "Hello" or data: "..."
+        match = re.match(r'data:\s*"(.*)"', line)
+        if match:
+            return match.group(1)
+        return None
+
+    def ask(
+        self,
+        prompt: str,
+        stream: bool = False,
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> Dict[str, Any]:
+        conversation_prompt = self.conversation.gen_complete_prompt(prompt)
+        if optimizer:
+            if hasattr(Optimizers, optimizer):
+                conversation_prompt = getattr(Optimizers, optimizer)(
+                    conversation_prompt if conversationally else prompt
+                )
+            else:
+                raise Exception(f"Optimizer is not valid.")
+        payload = {
+            "input": conversation_prompt,
+            "inputHistory": [],
+            "outputHistory": [],
+            "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 not line:
+                    continue
+                # Only process lines starting with data:
+                if line.startswith("data:"):
+                    content = self._koala_extractor(line)
+                    if content and content.strip():
+                        streaming_response += content
+                        yield dict(text=content) if not raw else content
+            # Only update chat history if response is not empty
+            if streaming_response.strip():
+                self.last_response = dict(text=streaming_response)
+                self.conversation.update_chat_history(
+                    prompt, self.get_message(self.last_response)
+                )
+        def for_non_stream():
+            # Use streaming logic to collect the full response
+            full_text = ""
+            for chunk in for_stream():
+                if isinstance(chunk, dict):
+                    full_text += chunk.get("text", "")
+                elif isinstance(chunk, str):
+                    full_text += chunk
+            # Only update chat history if response is not empty
+            if full_text.strip():
+                self.last_response = dict(text=full_text)
+                self.conversation.update_chat_history(
+                    prompt, self.get_message(self.last_response)
+                )
+            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]]:
+        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:
+        assert isinstance(response, dict), "Response should be of dict data-type only"
+        return response.get("text", "")
+
+if __name__ == "__main__":
+    from rich import print
+    ai = KOALA(timeout=60)
+    response = ai.chat("Say 'Hello' in one word", stream=True)
+    for chunk in response:
+        print(chunk, end="", flush=True)