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

webscout/Provider/OPENAI/base.py

@@ -1,46 +1,253 @@
-from abc import ABC, abstractmethod
-from typing import List, Dict, Optional, Union, Generator, Any
-
-# Re-define or import necessary response structure classes (like ChatCompletion, ChatCompletionChunk)
-# For simplicity, we'll assume they are defined elsewhere or passed directly.
-# You might want to define base versions of these classes here as well.
-
-class BaseChatCompletionChunk: # Placeholder
-    pass
-class BaseChatCompletion: # Placeholder
-    pass
-
-
-class BaseCompletions(ABC):
-    @abstractmethod
-    def create(
-        self,
-        *,
-        model: str,
-        messages: List[Dict[str, str]],
-        max_tokens: Optional[int] = None,
-        stream: bool = False,
-        temperature: Optional[float] = None,
-        top_p: Optional[float] = None,
-        **kwargs: Any
-    ) -> Union[BaseChatCompletion, Generator[BaseChatCompletionChunk, None, None]]:
-        """Abstract method to create chat completions."""
-        raise NotImplementedError
-
-
-class BaseChat(ABC):
-    completions: BaseCompletions
-
-
-class OpenAICompatibleProvider(ABC):
-    """
-    Abstract Base Class for providers mimicking the OpenAI Python client structure.
-    Requires a nested 'chat.completions' structure.
-    """
-    chat: BaseChat
-
-    @abstractmethod
-    def __init__(self, api_key: Optional[str] = None, **kwargs: Any):
-        """Initialize the provider, potentially with an API key."""
-        raise NotImplementedError
-
+import json
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from typing import Any, Callable, Dict, Generator, List, Optional, TypedDict, Union, cast
+
+import requests
+from litprinter import ic
+
+from webscout.AIbase import ModelList, Response, SimpleModelList
+
+# Import the utils for response structures
+from webscout.Provider.OPENAI.utils import ChatCompletion, ChatCompletionChunk
+
+
+# Define tool-related structures
+class ToolDefinition(TypedDict):
+    """Definition of a tool that can be called by the AI"""
+    type: str
+    function: Dict[str, Any]
+
+class FunctionParameters(TypedDict):
+    """Parameters for a function"""
+    type: str
+    properties: Dict[str, Dict[str, Any]]
+    required: List[str]
+
+class FunctionDefinition(TypedDict):
+    """Definition of a function that can be called by the AI"""
+    name: str
+    description: str
+    parameters: FunctionParameters
+
+@dataclass
+class Tool:
+    """Tool class that can be passed to the provider"""
+    name: str
+    description: str
+    parameters: Dict[str, Dict[str, Any]]
+    required_params: Optional[List[str]] = None
+    implementation: Optional[Callable] = None
+
+    def to_dict(self) -> ToolDefinition:
+        """Convert to OpenAI tool definition format"""
+        function_def = {
+            "name": self.name,
+            "description": self.description,
+            "parameters": {
+                "type": "object",
+                "properties": self.parameters,
+                "required": self.required_params or list(self.parameters.keys())
+            }
+        }
+
+        return {
+            "type": "function",
+            "function": function_def
+        }
+
+    def execute(self, arguments: Dict[str, Any]) -> Any:
+        """Execute the tool with the given arguments"""
+        if not self.implementation:
+            return f"Tool '{self.name}' does not have an implementation."
+
+        try:
+            return self.implementation(**arguments)
+        except Exception as e:
+            ic.configureOutput(prefix='ERROR| ')
+            ic(f"Error executing tool '{self.name}': {str(e)}")
+            return f"Error executing tool '{self.name}': {str(e)}"
+
+class BaseCompletions(ABC):
+    @abstractmethod
+    def create(
+        self,
+        *,
+        model: str,
+        messages: List[Dict[str, Any]],  # Changed to Any to support complex message structures
+        max_tokens: Optional[int] = None,
+        stream: bool = False,
+        temperature: Optional[float] = None,
+        top_p: Optional[float] = None,
+        tools: Optional[List[Union[Tool, Dict[str, Any]]]] = None,  # Support for tool definitions
+        tool_choice: Optional[Union[str, Dict[str, Any]]] = None,  # Support for tool_choice parameter
+        timeout: Optional[int] = None,
+        proxies: Optional[dict] = None,
+        **kwargs: Any
+    ) -> Union[ChatCompletion, Generator[ChatCompletionChunk, None, None]]:
+        """
+        Abstract method to create chat completions with tool support.
+
+        Args:
+            model: The model to use for completion
+            messages: List of message dictionaries
+            max_tokens: Maximum number of tokens to generate
+            stream: Whether to stream the response
+            temperature: Sampling temperature
+            top_p: Nucleus sampling parameter
+            tools: List of tool definitions available for the model to use
+            tool_choice: Control over which tool the model should use
+            **kwargs: Additional model-specific parameters
+
+        Returns:
+            Either a completion object or a generator of completion chunks if streaming
+        """
+        raise NotImplementedError
+
+    def format_tool_calls(self, tools: List[Union[Tool, Dict[str, Any]]]) -> List[Dict[str, Any]]:
+        """Convert tools to the format expected by the provider"""
+        formatted_tools = []
+
+        for tool in tools:
+            if isinstance(tool, Tool):
+                formatted_tools.append(tool.to_dict())
+            elif isinstance(tool, dict):
+                # Assume already formatted correctly
+                formatted_tools.append(tool)
+            else:
+                ic.configureOutput(prefix='WARNING| ')
+                ic(f"Skipping invalid tool type: {type(tool)}")
+
+        return formatted_tools
+
+    def process_tool_calls(self, tool_calls: List[Dict[str, Any]], available_tools: Dict[str, Tool]) -> List[Dict[str, Any]]:
+        """
+        Process tool calls and execute the relevant tools.
+
+        Args:
+            tool_calls: List of tool calls from the model
+            available_tools: Dictionary mapping tool names to their implementations
+
+        Returns:
+            List of results from executing the tools
+        """
+        results = []
+
+        for call in tool_calls:
+            try:
+                function_call = call.get("function", {})
+                tool_name = function_call.get("name")
+                arguments_str = function_call.get("arguments", "{}")
+
+                # Parse arguments
+                try:
+                    if isinstance(arguments_str, str):
+                        arguments = json.loads(arguments_str)
+                    else:
+                        arguments = arguments_str
+                except json.JSONDecodeError:
+                    results.append({
+                        "tool_call_id": call.get("id"),
+                        "result": f"Error: Could not parse arguments JSON: {arguments_str}"
+                    })
+                    continue
+
+                # Execute the tool if available
+                if tool_name in available_tools:
+                    tool_result = available_tools[tool_name].execute(arguments)
+                    results.append({
+                        "tool_call_id": call.get("id"),
+                        "result": str(tool_result)
+                    })
+                else:
+                    results.append({
+                        "tool_call_id": call.get("id"),
+                        "result": f"Error: Tool '{tool_name}' not found."
+                    })
+            except Exception as e:
+                ic.configureOutput(prefix='ERROR| ')
+                ic(f"Error processing tool call: {str(e)}")
+                results.append({
+                    "tool_call_id": call.get("id", "unknown"),
+                    "result": f"Error processing tool call: {str(e)}"
+                })
+
+        return results
+
+
+class BaseChat(ABC):
+    completions: BaseCompletions
+
+
+class OpenAICompatibleProvider(ABC):
+    """
+    Abstract Base Class for providers mimicking the OpenAI Python client structure.
+    Requires a nested 'chat.completions' structure with tool support.
+    Users can provide their own proxies via the proxies parameter.
+    """
+    chat: BaseChat
+    available_tools: Dict[str, Tool] = {}  # Dictionary of available tools
+    supports_tools: bool = False  # Whether the provider supports tools
+    supports_tool_choice: bool = False  # Whether the provider supports tool_choice
+    required_auth: bool = False  # Whether the provider requires authentication
+
+    def __init__(self, api_key: Optional[str] = None, tools: Optional[List[Tool]] = None, proxies: Optional[dict] = None, **kwargs: Any):
+        self.available_tools = {}
+        if tools:
+            self.register_tools(tools)
+        self.proxies = proxies or {}
+        self.session = requests.Session()
+        if self.proxies:
+            self.session.proxies.update(self.proxies)
+        # raise NotImplementedError  # <-- Commented out for metaclass test
+
+    @property
+    @abstractmethod
+    def models(self) -> ModelList:
+        """
+        Property that returns an object with a .list() method returning available models.
+        Subclasses must implement this property.
+        """
+        raise NotImplementedError
+
+    def register_tools(self, tools: List[Tool]) -> None:
+        """
+        Register tools with the provider.
+
+        Args:
+            tools: List of Tool objects to register
+        """
+        for tool in tools:
+            self.available_tools[tool.name] = tool
+
+    def get_tool_by_name(self, name: str) -> Optional[Tool]:
+        """Get a tool by name"""
+        return self.available_tools.get(name)
+
+    def format_tool_response(self, messages: List[Dict[str, Any]], tool_results: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
+        """
+        Format tool results as messages to be sent back to the provider.
+
+        Args:
+            messages: The original messages
+            tool_results: Results from executing tools
+
+        Returns:
+            Updated message list with tool results
+        """
+        updated_messages = messages.copy()
+
+        # Find the assistant message with tool calls
+        for i, msg in enumerate(reversed(updated_messages)):
+            if msg.get("role") == "assistant" and "tool_calls" in msg:
+                # For each tool result, add a tool message
+                for result in tool_results:
+                    tool_message = {
+                        "role": "tool",
+                        "tool_call_id": result["tool_call_id"],
+                        "content": result["result"]
+                    }
+                    updated_messages.append(tool_message)
+                break
+
+        return updated_messages

webscout/Provider/OPENAI/cerebras.py

@@ -0,0 +1,296 @@
+import json
+import time
+import uuid
+from typing import Any, Dict, Generator, List, Optional, Union, cast
+
+from curl_cffi import CurlError
+from curl_cffi.requests import Session
+
+from webscout.Provider.OPENAI.base import (
+    BaseChat,
+    BaseCompletions,
+    OpenAICompatibleProvider,
+    SimpleModelList,
+)
+from webscout.Provider.OPENAI.utils import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    ChatCompletionMessage,
+    Choice,
+    ChoiceDelta,
+    CompletionUsage,
+)
+
+from ...litagent import LitAgent
+
+
+class Completions(BaseCompletions):
+    def __init__(self, client: "Cerebras"):
+        self._client = client
+
+    def create(
+        self,
+        *,
+        model: str,
+        messages: List[Dict[str, str]],
+        max_tokens: Optional[int] = 40000,
+        stream: bool = False,
+        temperature: Optional[float] = 0.7,
+        top_p: Optional[float] = 0.8,
+        timeout: Optional[int] = None,
+        proxies: Optional[Dict[str, str]] = None,
+        **kwargs: Any,
+    ) -> Union[ChatCompletion, Generator[ChatCompletionChunk, None, None]]:
+        payload = {
+            "model": model,
+            "messages": messages,
+            "max_tokens": max_tokens,
+            "stream": stream,
+        }
+        if temperature is not None:
+            payload["temperature"] = temperature
+        if top_p is not None:
+            payload["top_p"] = top_p
+        payload.update(kwargs)
+        request_id = f"chatcmpl-{uuid.uuid4()}"
+        created_time = int(time.time())
+        if stream:
+            return self._create_stream(request_id, created_time, model, payload, timeout, proxies)
+        else:
+            return self._create_non_stream(
+                request_id, created_time, model, payload, timeout, proxies
+            )
+
+    def _create_stream(
+        self,
+        request_id: str,
+        created_time: int,
+        model: str,
+        payload: Dict[str, Any],
+        timeout: Optional[int] = None,
+        proxies: Optional[Dict[str, str]] = None,
+    ) -> Generator[ChatCompletionChunk, None, None]:
+        if proxies is not None:
+            self._client.session.proxies.update(cast(Any, proxies))
+        try:
+            response = self._client.session.post(
+                self._client.base_url,
+                headers=self._client.headers,
+                json=payload,
+                stream=True,
+                timeout=timeout or self._client.timeout,
+                impersonate="chrome120",
+            )
+            response.raise_for_status()
+            prompt_tokens = 0
+            completion_tokens = 0
+            total_tokens = 0
+            for line in response.iter_lines(decode_unicode=True):
+                if line:
+                    if line.startswith("data: "):
+                        json_str = line[6:]
+                        if json_str == "[DONE]":
+                            break
+                        try:
+                            data = json.loads(json_str)
+                            choices = data.get("choices")
+                            if not choices and choices is not None:
+                                continue
+                            choice_data = choices[0] if choices else {}
+                            delta_data = choice_data.get("delta", {})
+                            finish_reason = choice_data.get("finish_reason")
+                            usage_data = data.get("usage", {})
+                            if usage_data:
+                                prompt_tokens = usage_data.get("prompt_tokens", prompt_tokens)
+                                completion_tokens = usage_data.get(
+                                    "completion_tokens", completion_tokens
+                                )
+                                total_tokens = usage_data.get("total_tokens", total_tokens)
+                            if delta_data.get("content"):
+                                completion_tokens += 1
+                                total_tokens = prompt_tokens + completion_tokens
+                            delta = ChoiceDelta(
+                                content=delta_data.get("content"),
+                                role=delta_data.get("role"),
+                                tool_calls=delta_data.get("tool_calls"),
+                            )
+                            choice = Choice(
+                                index=choice_data.get("index", 0),
+                                delta=delta,
+                                finish_reason=finish_reason,
+                                logprobs=choice_data.get("logprobs"),
+                            )
+                            chunk = ChatCompletionChunk(
+                                id=request_id,
+                                choices=[choice],
+                                created=created_time,
+                                model=model,
+                                system_fingerprint=data.get("system_fingerprint"),
+                            )
+                            chunk.usage = {
+                                "prompt_tokens": prompt_tokens,
+                                "completion_tokens": completion_tokens,
+                                "total_tokens": total_tokens,
+                                "estimated_cost": None,
+                            }
+                            yield chunk
+                        except json.JSONDecodeError:
+                            continue
+            # Final chunk with finish_reason="stop"
+            delta = ChoiceDelta(content=None, role=None, tool_calls=None)
+            choice = Choice(index=0, delta=delta, finish_reason="stop", logprobs=None)
+            chunk = ChatCompletionChunk(
+                id=request_id,
+                choices=[choice],
+                created=created_time,
+                model=model,
+                system_fingerprint=None,
+            )
+            chunk.usage = {
+                "prompt_tokens": prompt_tokens,
+                "completion_tokens": completion_tokens,
+                "total_tokens": total_tokens,
+                "estimated_cost": None,
+            }
+            yield chunk
+        except Exception as e:
+            print(f"Error during Cerebras stream request: {e}")
+            raise IOError(f"Cerebras request failed: {e}") from e
+
+    def _create_non_stream(
+        self,
+        request_id: str,
+        created_time: int,
+        model: str,
+        payload: Dict[str, Any],
+        timeout: Optional[int] = None,
+        proxies: Optional[Dict[str, str]] = None,
+    ) -> ChatCompletion:
+        if proxies is not None:
+            self._client.session.proxies.update(cast(Any, proxies))
+        try:
+            response = self._client.session.post(
+                self._client.base_url,
+                headers=self._client.headers,
+                json=payload,
+                timeout=timeout or self._client.timeout,
+                impersonate="chrome120",
+            )
+            response.raise_for_status()
+            data = response.json()
+            choices_data = data.get("choices", [])
+            usage_data = data.get("usage", {})
+            choices = []
+            for choice_d in choices_data:
+                message_d = choice_d.get("message")
+                if not message_d and "delta" in choice_d:
+                    delta = choice_d["delta"]
+                    message_d = {
+                        "role": delta.get("role", "assistant"),
+                        "content": delta.get("content", ""),
+                    }
+                if not message_d:
+                    message_d = {"role": "assistant", "content": ""}
+                message = ChatCompletionMessage(
+                    role=message_d.get("role", "assistant"), content=message_d.get("content", "")
+                )
+                choice = Choice(
+                    index=choice_d.get("index", 0),
+                    message=message,
+                    finish_reason=choice_d.get("finish_reason", "stop"),
+                )
+                choices.append(choice)
+            usage = CompletionUsage(
+                prompt_tokens=usage_data.get("prompt_tokens", 0),
+                completion_tokens=usage_data.get("completion_tokens", 0),
+                total_tokens=usage_data.get("total_tokens", 0),
+            )
+            completion = ChatCompletion(
+                id=request_id,
+                choices=choices,
+                created=created_time,
+                model=data.get("model", model),
+                usage=usage,
+            )
+            return completion
+        except Exception as e:
+            print(f"Error during Cerebras non-stream request: {e}")
+            raise IOError(f"Cerebras request failed: {e}") from e
+
+
+class Chat(BaseChat):
+    def __init__(self, client: "Cerebras"):
+        self.completions = Completions(client)
+
+
+class Cerebras(OpenAICompatibleProvider):
+    required_auth = True
+    AVAILABLE_MODELS = []
+
+    @classmethod
+    def get_models(cls, api_key: Optional[str] = None):
+        """Fetch available models from Cerebras API."""
+        if not api_key:
+            raise Exception("API key required to fetch models")
+
+        try:
+            # Use a temporary curl_cffi session for this class method
+            temp_session = Session()
+            headers = {
+                "Content-Type": "application/json",
+                "Authorization": f"Bearer {api_key}",
+            }
+
+            response = temp_session.get(
+                "https://api.cerebras.ai/v1/models", headers=headers, impersonate="chrome120"
+            )
+
+            if response.status_code != 200:
+                raise Exception(f"Failed to fetch models: HTTP {response.status_code}")
+
+            data = response.json()
+            if "data" in data and isinstance(data["data"], list):
+                return [model["id"] for model in data["data"]]
+            raise Exception("Invalid response format from API")
+
+        except (CurlError, Exception) as e:
+            raise Exception(f"Failed to fetch models: {str(e)}")
+
+    def __init__(self, browser: str = "chrome", api_key: Optional[str] = None):
+        if not api_key:
+            raise ValueError("API key is required for Cerebras")
+        self.timeout = None
+        self.base_url = "https://api.cerebras.ai/v1/chat/completions"
+        self.session = Session()
+        agent = LitAgent()
+        fingerprint = agent.generate_fingerprint(browser)
+        self.headers = {
+            "Accept": fingerprint["accept"],
+            "Accept-Language": fingerprint["accept_language"],
+            "Content-Type": "application/json",
+            "User-Agent": fingerprint.get("user_agent", ""),
+            "Sec-CH-UA": fingerprint.get("sec_ch_ua", ""),
+            "Sec-CH-UA-Mobile": "?0",
+            "Sec-CH-UA-Platform": f'"{fingerprint.get("platform", "")}"',
+            "Authorization": f"Bearer {api_key}",
+        }
+        self.session.headers.update(self.headers)
+        self.chat = Chat(self)
+
+    @property
+    def models(self) -> SimpleModelList:
+        return SimpleModelList(type(self).AVAILABLE_MODELS)
+
+
+if __name__ == "__main__":
+    # Requires API key
+    client = Cerebras(api_key="csk-***************************")
+    response = client.chat.completions.create(
+        model="qwen-3-235b-a22b-instruct-2507",
+        messages=[{"role": "user", "content": "Hello, how are you?"}],
+        max_tokens=1000,
+        stream=False,
+    )
+    if isinstance(response, ChatCompletion):
+        if response.choices[0].message and response.choices[0].message.content:
+            print(response.choices[0].message.content)