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

webscout/Provider/Flowith.py

@@ -0,0 +1,217 @@
+import requests  # Use requests for compatibility with zstd streaming
+from requests import Session
+import zstandard as zstd
+from typing import Any, Dict, Generator, Union
+import uuid
+
+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 Flowith(Provider):
+    """
+    A provider class for interacting with the Flowith API.
+    """
+    AVAILABLE_MODELS = ["gpt-4.1-mini", "deepseek-chat", "deepseek-reasoner", "claude-3.5-haiku", "gemini-2.0-flash", "gemini-2.5-flash", "grok-3-mini"]
+
+    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,
+        model: str = "gpt-4.1-mini",
+        system_prompt: str = "You are a helpful assistant.",
+        browser: str = "chrome"
+    ):
+        if model not in self.AVAILABLE_MODELS:
+            raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
+
+        self.url = "https://edge.flowith.net/ai/chat?mode=general"
+        self.session = Session()
+        self.agent = LitAgent()
+        self.fingerprint = self.agent.generate_fingerprint(browser)
+        self.headers = {
+            "accept": "*/*",
+            "accept-encoding": "gzip, deflate, br, zstd",
+            "accept-language": "en-US,en;q=0.9,en-IN;q=0.8",
+            "content-type": "application/json",
+            "origin": "https://flowith.io",
+            "referer": "https://edge.flowith.net/",
+            "user-agent": self.fingerprint["user_agent"],
+            "dnt": "1",
+            "sec-gpc": "1"
+        }
+        self.session.headers.update(self.headers)
+        self.session.proxies = proxies
+        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.node_id = str(uuid.uuid4())
+        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]:
+        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": [
+                {"content": self.system_prompt, "role": "system"},
+                {"content": conversation_prompt, "role": "user"}
+            ],
+            "stream": stream,
+            "nodeId": self.node_id
+        }
+
+        def for_stream():
+            try:
+                response = requests.post(
+                    self.url,
+                    headers=self.headers,
+                    json=payload,
+                    stream=True,
+                    timeout=self.timeout
+                )
+                encoding = response.headers.get('Content-Encoding', '').lower()
+                streaming_text = ""
+                if encoding == 'zstd':
+                    dctx = zstd.ZstdDecompressor()
+                    with dctx.stream_reader(response.raw) as reader:
+                        while True:
+                            chunk = reader.read(4096)
+                            if not chunk:
+                                break
+                            text = chunk.decode('utf-8', errors='replace')
+                            streaming_text += text
+                            yield text if raw else dict(text=text)
+                else:
+                    for chunk in response.iter_content(chunk_size=4096):
+                        if not chunk:
+                            break
+                        text = chunk.decode('utf-8', errors='replace')
+                        streaming_text += text
+                        yield text if raw else dict(text=text)
+                self.last_response.update(dict(text=streaming_text))
+                self.conversation.update_chat_history(
+                    prompt, self.get_message(self.last_response)
+                )
+            except Exception as e:
+                raise exceptions.FailedToGenerateResponseError(f"Request failed: {e}")
+
+        def for_non_stream():
+            try:
+                response = requests.post(
+                    self.url,
+                    headers=self.headers,
+                    json=payload,
+                    timeout=self.timeout
+                )
+                encoding = response.headers.get('Content-Encoding', '').lower()
+                if encoding == 'zstd':
+                    dctx = zstd.ZstdDecompressor()
+                    with dctx.stream_reader(response.raw) as reader:
+                        decompressed = reader.read()
+                        text = decompressed.decode('utf-8', errors='replace')
+                else:
+                    text = response.text
+                self.last_response.update(dict(text=text))
+                self.conversation.update_chat_history(
+                    prompt, self.get_message(self.last_response)
+                )
+                return self.last_response
+            except Exception as e:
+                raise exceptions.FailedToGenerateResponseError(f"Request failed: {e}")
+
+        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:
+        # Always return a non-empty string for the assistant's message
+        if not isinstance(response, dict):
+            return ""
+        text = response.get("text", None)
+        if text is None or not isinstance(text, str) or not text.strip():
+            # Fallback: return a placeholder to avoid Conversation error
+            return "[No response generated]"
+        return text
+
+if __name__ == "__main__":
+    print("-" * 80)
+    print(f"{'Model':<20} {'Status':<10} {'Response'}")
+    print("-" * 80)
+    for model in Flowith.AVAILABLE_MODELS:
+        try:
+            ai = Flowith(model=model, timeout=60)
+            response = ai.chat("Say 'Hello' in one word", stream=True)
+            response_text = ""
+            for chunk in response:
+                response_text += chunk
+            status = '✓' if response_text.strip() else '✗'
+            display_text = response_text.strip()[:100]
+            print(f"{model:<20} {status:<10} {display_text}")
+        except Exception as e:
+            print(f"{model:<20} {'✗':<10} {str(e)}")

webscout/Provider/FreeGemini.py

@@ -0,0 +1,250 @@
+#!/usr/bin/env python3
+"""
+FreeGemini API client for the free-gemini.vercel.app service.
+Supports streaming responses from Gemini 2.0 Flash model.
+"""
+
+import json
+from curl_cffi.requests import Session
+from curl_cffi import CurlError
+from typing import Dict, Generator, Any, Union, Optional
+
+from webscout import exceptions
+from webscout.AIutel import Optimizers, AwesomePrompts, sanitize_stream
+from webscout.conversation import Conversation
+from webscout.litagent import LitAgent
+from webscout.AIbase import Provider
+
+
+class FreeGemini(Provider):
+    """
+    A class to interact with the free-gemini.vercel.app API,
+    which provides access to Gemini models.
+    """
+    AVAILABLE_MODELS = ["gemini-2.0-flash"]
+
+    @staticmethod
+    def _gemini_extractor(data: Dict) -> Optional[str]:
+        """Extract text content from Gemini API response."""
+        try:
+            if "candidates" in data and data["candidates"]:
+                candidate = data["candidates"][0]
+                if "content" in candidate and "parts" in candidate["content"]:
+                    parts = candidate["content"]["parts"]
+                    if parts and "text" in parts[0]:
+                        return parts[0]["text"]
+        except (KeyError, IndexError, TypeError):
+            pass
+        return None
+
+    def __init__(
+        self,
+        is_conversation: bool = True,
+        max_tokens: int = 4000,
+        temperature: float = 0.5,
+        top_p: float = 1.0,
+        timeout: int = 120, # Default timeout for this specific API
+        proxies: dict = {}, # Standard proxy support
+        filepath: str = None,
+        update_file: bool = True,
+        history_offset: int = 10250,
+        intro: str = None,
+        act: str = None,
+        model: str = "gemini-2.0-flash",
+        system_prompt: str = "You are a helpful assistant.", # For consistency, though not directly used in payload
+    ):
+        """Initialize the FreeGemini client.
+
+        Args:
+            is_conversation (bool): Enable conversation history. Defaults to True.
+            max_tokens (int): Maximum tokens to sample. Defaults to 4000.
+            temperature (float): Sampling temperature. Defaults to 0.5.
+            top_p (float): Nucleus sampling parameter. Defaults to 1.0.
+            timeout (int): Request timeout in seconds. Defaults to 120.
+            proxies (dict): HTTP proxies. Defaults to {}.
+            filepath (str, optional): Path to save conversation history. Defaults to None.
+            update_file (bool): Update conversation history file. Defaults to True.
+            history_offset (int): Limit conversation history. Defaults to 10250.
+            intro (str, optional): Introduction for the conversation.
+            act (str, optional): Act for AwesomePrompts.
+            model (str): Model to use. Defaults to "gemini-2.0-flash".
+            system_prompt (str): System prompt (primarily for API consistency).
+        """
+        if model not in self.AVAILABLE_MODELS:
+            raise ValueError(f"Invalid model: {model}. Choose from: {self.AVAILABLE_MODELS}")
+
+        self.session = Session()
+        self.model = model
+        self.is_conversation = is_conversation
+        self.max_tokens_to_sample = max_tokens # Consistent naming
+        self.temperature = temperature
+        self.top_p = top_p
+        self.timeout = timeout
+        self.last_response = {}
+        self.system_prompt = system_prompt # Stored for consistency
+
+        self.api_endpoint = "https://free-gemini.vercel.app/api/google/v1beta/models/gemini-2.0-flash:streamGenerateContent?alt=sse"
+
+        self.agent = LitAgent()
+        self.headers = {
+            "Content-Type": "application/json",
+            "Accept": "application/json, text/event-stream",
+            "User-Agent": self.agent.random(),
+            "Origin": "https://free-gemini.vercel.app",
+            "Referer": "https://free-gemini.vercel.app/",
+        }
+
+        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, # Default to False for consistency
+        raw: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> Union[Dict[str, Any], Generator]:
+        """Sends a prompt to the FreeGemini API and returns the response.
+
+        Args:
+            prompt (str): The prompt to send to the model.
+            stream (bool): Whether to stream the response. Defaults to False.
+            raw (bool): Return raw response instead of parsed text. Defaults to False.
+            optimizer (str, optional): Optimizer to use for the prompt.
+            conversationally (bool, optional): Whether to apply optimizer conversationally.
+
+        Returns:
+            Union[Dict[str, Any], Generator[Dict[str, Any], None, None]]: 
+                The generated response as a dictionary or generator.
+        """
+        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 = {
+            "contents": [{"role": "user", "parts": [{"text": conversation_prompt}]}],
+            "generationConfig": {
+                "temperature": self.temperature,
+                "maxOutputTokens": self.max_tokens_to_sample,
+                "topP": self.top_p
+            },
+            "safetySettings": [
+                # Default safety settings from original class
+                {"category": "HARM_CATEGORY_HARASSMENT", "threshold": "BLOCK_ONLY_HIGH"},
+                {"category": "HARM_CATEGORY_HATE_SPEECH", "threshold": "BLOCK_ONLY_HIGH"},
+                {"category": "HARM_CATEGORY_SEXUALLY_EXPLICIT", "threshold": "BLOCK_ONLY_HIGH"},
+                {"category": "HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "BLOCK_ONLY_HIGH"}
+            ]
+        }
+
+        # Internal generator for handling API call and history update
+        def _generate_content_and_update_history():
+            streaming_text_accumulator = ""
+            try:
+                response = self.session.post(
+                    self.api_endpoint,
+                    json=payload,
+                    stream=True, # API always streams
+                    timeout=self.timeout,
+                    impersonate="chrome120" 
+                )
+                response.raise_for_status()
+
+                processed_stream = sanitize_stream(
+                    data=response.iter_content(chunk_size=None),
+                    intro_value="data:",
+                    to_json=True,
+                    content_extractor=self._gemini_extractor,
+                    yield_raw_on_error=False
+                )
+                
+                for content_chunk_str in processed_stream: # yields string
+                    if content_chunk_str and isinstance(content_chunk_str, str):
+                        streaming_text_accumulator += content_chunk_str
+                        yield content_chunk_str # Yield the raw text chunk
+            
+            except CurlError as e:
+                raise exceptions.FailedToGenerateResponseError(f"Request failed (CurlError): {str(e)}") from e
+            except Exception as e:
+                raise exceptions.FailedToGenerateResponseError(f"Request failed ({type(e).__name__}): {str(e)}") from e
+            finally:
+                if streaming_text_accumulator:
+                    self.last_response = {"text": streaming_text_accumulator}
+                    self.conversation.update_chat_history(prompt, streaming_text_accumulator)
+
+        if stream:
+            def stream_wrapper():
+                for text_chunk in _generate_content_and_update_history():
+                    yield {"text": text_chunk} if not raw else text_chunk
+            return stream_wrapper()
+        else: # Not streaming from the perspective of the caller of `ask`
+            full_text_response = ""
+            for text_chunk in _generate_content_and_update_history():
+                full_text_response += text_chunk
+            
+            # self.last_response and history are updated by the generator's `finally`
+            return {"text": full_text_response} if not raw else full_text_response
+
+    def chat(
+        self,
+        prompt: str,
+        stream: bool = False,
+        optimizer: str = None,
+        conversationally: bool = False,
+    ) -> Union[str, Generator[str, None, None]]:
+        """Generates a response from the FreeGemini API.
+
+        Args:
+            prompt (str): The prompt to send to the API.
+            stream (bool): Whether to stream the response.
+            optimizer (str): Optimizer to use for the prompt.
+            conversationally (bool): Whether to generate the prompt conversationally.
+
+        Returns:
+            Union[str, Generator[str, None, None]]: The API response.
+        """
+        def for_stream_chat():
+            gen = self.ask(
+                prompt, stream=True, raw=False, # Ensure ask yields dicts
+                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, # Ensure ask returns dict
+                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:
+        assert isinstance(response, dict), "Response should be of dict data-type only"
+        return response.get("text", "")
+
+if __name__ == "__main__":
+    # Example usage
+    free_gemini = FreeGemini()
+    response = free_gemini.chat("What is the capital of France?", stream=False)
+    print(response)  # Should print the response from the API

webscout/Provider/Gemini.py

@@ -0,0 +1,169 @@
+from os import path
+from json import load, dumps
+import warnings
+from typing import Union, Any, Dict
+
+# Import internal modules and dependencies
+from ..AIutel import Optimizers, Conversation, AwesomePrompts, sanitize_stream
+from ..AIbase import Provider, AsyncProvider
+from ..Bard import Chatbot, Model
+
+warnings.simplefilter("ignore", category=UserWarning)
+
+# Define model aliases for easy usage
+MODEL_ALIASES: Dict[str, Model] = {
+    "unspecified": Model.UNSPECIFIED,
+    "gemini-2.0-flash": Model.G_2_0_FLASH,
+    "gemini-2.0-flash-thinking": Model.G_2_0_FLASH_THINKING,
+    "gemini-2.5-pro": Model.G_2_5_PRO,
+    "gemini-2.0-exp-advanced": Model.G_2_0_EXP_ADVANCED,
+    "gemini-2.5-exp-advanced": Model.G_2_5_EXP_ADVANCED,
+    "gemini-2.5-flash": Model.G_2_5_FLASH,
+    # Add shorter aliases for convenience
+    "flash": Model.G_2_0_FLASH,
+    "flash-2.5": Model.G_2_5_FLASH,
+    "thinking": Model.G_2_0_FLASH_THINKING,
+    "pro": Model.G_2_5_PRO,
+    "advanced": Model.G_2_0_EXP_ADVANCED,
+    "advanced-2.5": Model.G_2_5_EXP_ADVANCED,
+}
+
+# List of available models (friendly names)
+AVAILABLE_MODELS = list(MODEL_ALIASES.keys())
+
+class GEMINI(Provider):
+    def __init__(
+        self,
+        cookie_file: str,
+        model: str = "flash",  # Accepts either a Model enum or a str alias.
+        proxy: dict = {},
+        timeout: int = 30,
+    ):
+        """
+        Initializes GEMINI with model support.
+
+        Args:
+            cookie_file (str): Path to the cookies JSON file.
+            model (Model or str): Selected model for the session. Can be a Model enum
+                or a string alias. Available aliases: flash, flash-exp, thinking, thinking-with-apps,
+                exp-advanced, 2.5-exp-advanced, 2.5-pro, 1.5-flash, 1.5-pro, 1.5-pro-research.
+            proxy (dict, optional): HTTP request proxy. Defaults to {}.
+            timeout (int, optional): HTTP request timeout in seconds. Defaults to 30.
+        """
+        self.conversation = Conversation(False)
+
+        # Ensure cookie_file existence.
+        if not isinstance(cookie_file, str):
+            raise TypeError(f"cookie_file should be of type str, not '{type(cookie_file)}'")
+        if not path.isfile(cookie_file):
+            raise Exception(f"{cookie_file} is not a valid file path")
+
+        # If model is provided as alias (str), convert to Model enum.
+        if isinstance(model, str):
+            alias = model.lower()
+            if alias in MODEL_ALIASES:
+                selected_model = MODEL_ALIASES[alias]
+            else:
+                raise Exception(f"Unknown model alias: '{model}'. Available aliases: {', '.join(AVAILABLE_MODELS)}")
+        elif isinstance(model, Model):
+            selected_model = model
+        else:
+            raise TypeError("model must be a string alias or an instance of Model")
+
+        # Initialize the Chatbot session using the cookie file.
+        self.session = Chatbot(cookie_file, proxy, timeout, selected_model)
+        self.last_response = {}
+        self.__available_optimizers = (
+            method for method in dir(Optimizers) if callable(getattr(Optimizers, method)) and not method.startswith("__")
+        )
+        # Store cookies from Chatbot for later use (e.g. image generation)
+        self.session_auth1 = self.session.secure_1psid
+        self.session_auth2 = self.session.secure_1psidts
+
+    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 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 (e.g., 'code', 'shell_command'). Defaults to None.
+            conversationally (bool, optional): Chat conversationally when using optimizer. Defaults to False.
+
+        Returns:
+            dict: Response generated by the underlying Chatbot.
+        """
+        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 {', '.join(self.__available_optimizers)}")
+
+        def for_stream():
+            response = self.session.ask(prompt)
+            self.last_response.update(response)
+            self.conversation.update_chat_history(prompt, self.get_message(self.last_response))
+            yield dumps(response) if raw else 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 text.
+
+        Args:
+            prompt (str): Prompt to be sent.
+            stream (bool, optional): Flag for streaming response. Defaults to False.
+            optimizer (str, optional): Prompt optimizer name. 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 content from the response.
+
+        Args:
+            response (dict): Response generated by `self.ask`.
+
+        Returns:
+            str: Extracted message content.
+        """
+        if not isinstance(response, dict):
+            raise TypeError("Response should be of type dict")
+        return response["content"]
+
+    def reset(self):
+        """Reset the current conversation."""
+        self.session.async_chatbot.conversation_id = ""
+        self.session.async_chatbot.response_id = ""
+        self.session.async_chatbot.choice_id = ""