pygpt-net 2.7.5__py3-none-any.whl → 2.7.7__py3-none-any.whl

pygpt_net/provider/api/x_ai/image.py

@@ -6,13 +6,13 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2025.12.31 16:00:00                  #
+# Updated Date: 2026.01.04 19:00:00                  #
 # ================================================== #
 
 import base64
 import datetime
 import os
-from typing import Optional, Dict, Any, List
+from typing import Optional, Dict, Any, List, Iterable
 
 import requests
 from PySide6.QtCore import QObject, Signal, QRunnable, Slot
@@ -35,7 +35,7 @@ class Image:
             sync: bool = True
     ) -> bool:
         """
-        Generate image(s) via xAI REST API /v1/images/generations (OpenAI-compatible).
+        Generate image(s) via xAI SDK image API.
         Model: grok-2-image (or -1212 variants).
 
         :param context: BridgeContext with prompt, model, ctx
@@ -60,7 +60,7 @@ class Image:
         worker = ImageWorker()
         worker.window = self.window
         worker.ctx = ctx
-        worker.model = model.id or "grok-2-image"
+        worker.model = (model.id or "grok-2-image")
         worker.input_prompt = prompt
         worker.model_prompt = prompt_model
         worker.system_prompt = self.window.core.prompt.get('img')
@@ -108,8 +108,10 @@ class ImageWorker(QRunnable):
         self.raw = False
         self.num = 1
 
-        # API
-        self.api_url = "https://api.x.ai/v1/images/generations"  # OpenAI-compatible endpoint
+        # SDK image_format:
+        # - "base64": returns raw image bytes in SDK response (preferred for local saving)
+        # - "url": returns URL on xAI managed storage (fallback: we download)
+        self.image_format = "base64"
 
     @Slot()
     def run(self):
@@ -143,48 +145,35 @@ class ImageWorker(QRunnable):
 
             self.signals.status.emit(trans('img.status.generating') + f": {self.input_prompt}...")
 
-            cfg = self.window.core.config
-            api_key = cfg.get("api_key_xai") or os.environ.get("XAI_API_KEY") or ""
-            self.api_url = cfg.get("api_endpoint_xai") + "/images/generations"
-            if not api_key:
-                raise RuntimeError("Missing xAI API key. Set `api_key_xai` in config or XAI_API_KEY in env.")
-
-            headers = {
-                "Authorization": f"Bearer {api_key}",
-                "Content-Type": "application/json",
-            }
-            payload = {
-                "model": self.model or "grok-2-image",
-                "prompt": self.input_prompt or "",
-                "n": max(1, min(int(self.num), 10)),
-                "response_format": "b64_json",  # get base64 so we can save locally
-            }
-
-            r = requests.post(self.api_url, headers=headers, json=payload, timeout=180)
-            r.raise_for_status()
-            data = r.json()
-
-            images = []
-            for idx, img in enumerate((data.get("data") or [])[: self.num]):
-                b64 = img.get("b64_json")
-                if not b64:
-                    # fallback: url download
-                    url = img.get("url")
-                    if url:
-                        try:
-                            rr = requests.get(url, timeout=60)
-                            if rr.status_code == 200:
-                                images.append(rr.content)
-                        except Exception:
-                            pass
-                    continue
-                try:
-                    images.append(base64.b64decode(b64))
-                except Exception:
-                    continue
+            # use xAI SDK client
+            client = self.window.core.api.xai.get_client()
+
+            # enforce n range [1..10] as per docs
+            n = max(1, min(int(self.num or 1), 10))
 
+            images_bytes: List[bytes] = []
+            if n == 1:
+                # single image
+                resp = client.image.sample(
+                    model=self.model or "grok-2-image",
+                    prompt=self.input_prompt or "",
+                    image_format=("base64" if self.image_format == "base64" else "url"),
+                )
+                images_bytes = self._extract_bytes_from_single(resp)
+            else:
+                # batch images
+                resp_iter = client.image.sample_batch(
+                    model=self.model or "grok-2-image",
+                    prompt=self.input_prompt or "",
+                    n=n,
+                    image_format=("base64" if self.image_format == "base64" else "url"),
+                )
+                images_bytes = self._extract_bytes_from_batch(resp_iter)
+
+            # save images to files
             paths: List[str] = []
-            for i, content in enumerate(images):
+            for i, content in enumerate(images_bytes):
+                # generate filename
                 name = (
                     datetime.date.today().strftime("%Y-%m-%d") + "_" +
                     datetime.datetime.now().strftime("%H-%M-%S") + "-" +
@@ -192,7 +181,7 @@ class ImageWorker(QRunnable):
                     str(i + 1) + ".jpg"
                 )
                 path = os.path.join(self.window.core.config.get_user_dir("img"), name)
-                self.signals.status.emit(trans('img.status.downloading') + f" ({i + 1} / {self.num}) -> {path}")
+                self.signals.status.emit(trans('img.status.downloading') + f" ({i + 1} / {len(images_bytes)}) -> {path}")
 
                 if self.window.core.image.save_image(path, content):
                     paths.append(path)
@@ -207,6 +196,119 @@ class ImageWorker(QRunnable):
         finally:
             self._cleanup()
 
+    # ---------- SDK response helpers ----------
+
+    def _extract_bytes_from_single(self, resp) -> List[bytes]:
+        """
+        Normalize single-image SDK response to a list of bytes.
+        Accepts:
+        - resp.image -> bytes or base64 str (docs say raw bytes)
+        - resp.url -> download
+        - dict-like/legacy: {'b64_json': ..., 'url': ...}
+        """
+        out: List[bytes] = []
+        try:
+            # preferred path: raw bytes when image_format="base64"
+            img_bytes = getattr(resp, "image", None)
+            if isinstance(img_bytes, (bytes, bytearray)):
+                out.append(bytes(img_bytes))
+                return out
+            if isinstance(img_bytes, str):
+                try:
+                    out.append(base64.b64decode(img_bytes))
+                    return out
+                except Exception:
+                    pass
+
+            # url fallback
+            url = getattr(resp, "url", None)
+            if isinstance(url, str) and url:
+                try:
+                    r = requests.get(url, timeout=60)
+                    if r.status_code == 200:
+                        out.append(r.content)
+                        return out
+                except Exception:
+                    pass
+
+            # dict-like fallbacks
+            if isinstance(resp, dict):
+                if "b64_json" in resp and resp["b64_json"]:
+                    try:
+                        out.append(base64.b64decode(resp["b64_json"]))
+                        return out
+                    except Exception:
+                        pass
+                if "url" in resp and resp["url"]:
+                    try:
+                        r = requests.get(resp["url"], timeout=60)
+                        if r.status_code == 200:
+                            out.append(r.content)
+                            return out
+                    except Exception:
+                        pass
+        except Exception:
+            pass
+        return out
+
+    def _extract_bytes_from_batch(self, resp_iter: Iterable) -> List[bytes]:
+        """
+        Normalize batch SDK response (iterable of images) to a list of bytes.
+        Handles item.image (bytes/str), item.url, dict-like or bytes directly.
+        """
+        out: List[bytes] = []
+        if resp_iter is None:
+            return out
+        try:
+            for item in resp_iter:
+                # bytes directly
+                if isinstance(item, (bytes, bytearray)):
+                    out.append(bytes(item))
+                    continue
+
+                # preferred: raw bytes in item.image
+                img_bytes = getattr(item, "image", None)
+                if isinstance(img_bytes, (bytes, bytearray)):
+                    out.append(bytes(img_bytes))
+                    continue
+                if isinstance(img_bytes, str):
+                    try:
+                        out.append(base64.b64decode(img_bytes))
+                        continue
+                    except Exception:
+                        pass
+
+                # url fallback
+                url = getattr(item, "url", None)
+                if isinstance(url, str) and url:
+                    try:
+                        r = requests.get(url, timeout=60)
+                        if r.status_code == 200:
+                            out.append(r.content)
+                            continue
+                    except Exception:
+                        pass
+
+                # dict-like fallbacks
+                if isinstance(item, dict):
+                    if "b64_json" in item and item["b64_json"]:
+                        try:
+                            out.append(base64.b64decode(item["b64_json"]))
+                            continue
+                        except Exception:
+                            pass
+                    if "url" in item and item["url"]:
+                        try:
+                            r = requests.get(item["url"], timeout=60)
+                            if r.status_code == 200:
+                                out.append(r.content)
+                                continue
+                        except Exception:
+                            pass
+        except Exception:
+            pass
+        return out
+
     def _cleanup(self):
         """Cleanup signals to avoid multiple calls."""
         sig = self.signals

pygpt_net/provider/api/x_ai/{remote.py → remote_tools.py}

@@ -6,27 +6,176 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2025.09.17 20:00:00                  #
+# Updated Date: 2026.01.04 19:00:00                  #
 # ================================================== #
 
 from __future__ import annotations
+
+import json
 from typing import Optional, Dict, Any, List
 
 from pygpt_net.item.model import ModelItem
 
+# xAI server-side tools
+try:
+    from xai_sdk.tools import web_search as x_web_search
+    from xai_sdk.tools import x_search as x_x_search
+    from xai_sdk.tools import code_execution as x_code_execution
+    from xai_sdk.tools import mcp as x_mcp
+except Exception:
+    x_web_search = None
+    x_x_search = None
+    x_code_execution = None
+    x_mcp = None
+
 
 class Remote:
     def __init__(self, window=None):
         """
-        Live Search builder for xAI:
+        Live Search builder for xAI (old, grok-3):
         - Returns a dict with 'sdk' (X-only toggle) and 'http' (full search_parameters).
         - SDK path: native streaming (xai_sdk.chat.stream()) works only for basic X search (no advanced filters).
         - HTTP path: full Live Search (web/news/rss/X with filters), streaming via SSE.
 
+        Server-side Tools builder for xAI (newer SDKs, Responses API):
+        - Builds xAI SDK tool objects for web_search, x_search, code_execution, MCP.
+        - Returns include flags, max_turns and use_encrypted_content settings.
+
         :param window: Window instance
         """
         self.window = window
 
+    def build_for_chat(self, model: ModelItem = None, stream: bool = False) -> Dict[str, Any]:
+        """
+        Build server-side tools and options for Chat Responses.
+
+        Returns:
+            {
+              "tools": [ ... xai_sdk.tools.* ... ],
+              "include": [ ... ],
+              "use_encrypted_content": bool,
+              "max_turns": Optional[int],
+            }
+        """
+        cfg = self.window.core.config
+        include: List[str] = []
+        tools: List[object] = []
+
+        # global remote tools switch
+        is_web_enabled = self.window.controller.chat.remote_tools.enabled(model, "web_search")
+        is_x_enabled = bool(cfg.get("remote_tools.xai.x_search", False))
+        is_code_enabled = bool(cfg.get("remote_tools.xai.code_execution", False))
+        is_mcp_enabled = bool(cfg.get("remote_tools.xai.mcp", False))
+
+        # include flags
+        if stream:
+            include.append("verbose_streaming")
+        if bool(cfg.get("remote_tools.xai.inline_citations", True)):
+            include.append("inline_citations")
+        if bool(cfg.get("remote_tools.xai.include_code_output", True)):
+            include.append("code_execution_call_output")
+
+        # use_encrypted_content
+        use_encrypted = bool(cfg.get("remote_tools.xai.use_encrypted_content", False))
+
+        # optional max_turns
+        max_turns = None
+        try:
+            mt = cfg.get("remote_tools.xai.max_turns")
+            if isinstance(mt, int) and mt > 0:
+                max_turns = int(mt)
+        except Exception:
+            pass
+
+        # WEB SEARCH
+        if is_web_enabled and x_web_search is not None:
+            kwargs: Dict[str, Any] = {}
+            enable_img = bool(cfg.get("remote_tools.xai.web.enable_image_understanding", False))
+            '''
+            allowed = self._as_list(cfg.get("remote_tools.xai.web.allowed_websites"), 5)
+            excluded = self._as_list(cfg.get("remote_tools.xai.web.excluded_websites"), 5)
+            if allowed and not excluded:
+                kwargs["allowed_domains"] = allowed
+            elif excluded and not allowed:
+                kwargs["excluded_domains"] = excluded
+            '''
+            if enable_img:
+                kwargs["enable_image_understanding"] = True
+            try:
+                tools.append(x_web_search(**kwargs))
+            except Exception:
+                tools.append(x_web_search())
+
+        # X SEARCH
+        if is_x_enabled and x_x_search is not None:
+            kwargs: Dict[str, Any] = {}
+            '''
+            inc = self._as_list(cfg.get("remote_tools.xai.x.included_handles"), 10)
+            exc = self._as_list(cfg.get("remote_tools.xai.x.excluded_handles"), 10)
+            if inc and not exc:
+                kwargs["allowed_x_handles"] = inc
+            elif exc and not inc:
+                kwargs["excluded_x_handles"] = exc
+            '''
+            # optional date range filters (YYYY-MM-DD)
+            for k_in, k_out in (("remote_tools.xai.from_date", "from_date"),
+                                ("remote_tools.xai.to_date", "to_date")):
+                v = cfg.get(k_in)
+                if isinstance(v, str) and v.strip():
+                    kwargs[k_out] = v.strip()
+
+            if bool(cfg.get("remote_tools.xai.x.enable_image_understanding", False)):
+                kwargs["enable_image_understanding"] = True
+            if bool(cfg.get("remote_tools.xai.x.enable_video_understanding", False)):
+                kwargs["enable_video_understanding"] = True
+
+            # optional favorites/views filters (supported by live search)
+            try:
+                favs = cfg.get("remote_tools.xai.x.min_favs")
+                if isinstance(favs, int) and favs > 0:
+                    kwargs["post_favorite_count"] = int(favs)
+            except Exception:
+                pass
+            try:
+                views = cfg.get("remote_tools.xai.x.min_views")
+                if isinstance(views, int) and views > 0:
+                    kwargs["post_view_count"] = int(views)
+            except Exception:
+                pass
+
+            try:
+                tools.append(x_x_search(**kwargs))
+            except Exception:
+                tools.append(x_x_search())
+
+        # CODE EXECUTION
+        if is_code_enabled and x_code_execution is not None:
+            try:
+                tools.append(x_code_execution())
+            except Exception:
+                pass
+
+        # MCP
+        if is_mcp_enabled and x_mcp is not None:
+            kwargs = {}
+            mcp_config = cfg.get("remote_tools.xai.mcp.args", "")
+            if mcp_config:
+                try:
+                    kwargs = json.loads(mcp_config)
+                except Exception:
+                    pass
+                try:
+                    tools.append(x_mcp(**kwargs))
+                except Exception:
+                    pass
+
+        return {
+            "tools": tools,
+            "include": include,
+            "use_encrypted_content": use_encrypted,
+            "max_turns": max_turns,
+        }
+
     def build_remote_tools(self, model: ModelItem = None) -> Dict[str, Any]:
         """
         Return live-search config for xAI:
@@ -58,38 +207,17 @@ class Remote:
         """
         cfg = self.window.core.config
         is_web = self.window.controller.chat.remote_tools.enabled(model, "web_search")  # get global config
-
-        mode = str(cfg.get("remote_tools.xai.mode") or "auto").lower()
-        if mode not in ("auto", "on", "off"):
-            mode = "auto"
-
-        if mode == "off":
-            if is_web:
-                mode = "on"  # override off if global web_search enabled
+        mode = "on" if is_web else "off"
 
         # sources toggles
-        s_web = bool(cfg.get("remote_tools.xai.sources.web", True))
-        s_x   = bool(cfg.get("remote_tools.xai.sources.x", True))
-        s_news = bool(cfg.get("remote_tools.xai.sources.news", False))
-        s_rss  = bool(cfg.get("remote_tools.xai.sources.rss", False))
-
-        # advanced flags
-        adv_web_allowed   = self._has_list(cfg.get("remote_tools.xai.web.allowed_websites"))
-        adv_web_excluded  = self._has_list(cfg.get("remote_tools.xai.web.excluded_websites"))
-        adv_web_country   = self._has_str(cfg.get("remote_tools.xai.web.country"))
-        adv_web_safe      = cfg.get("remote_tools.xai.web.safe_search", None)
-
-        adv_news_excl     = self._has_list(cfg.get("remote_tools.xai.news.excluded_websites"))
-        adv_news_country  = self._has_str(cfg.get("remote_tools.xai.news.country"))
-        adv_news_safe     = cfg.get("remote_tools.xai.news.safe_search", None)
+        s_web =  bool(cfg.get("remote_tools.xai.web_search", False))
+        s_x   =  bool(cfg.get("remote_tools.xai.x_search", False))
 
         adv_x_incl        = self._has_list(cfg.get("remote_tools.xai.x.included_handles"))
         adv_x_excl        = self._has_list(cfg.get("remote_tools.xai.x.excluded_handles"))
         adv_x_favs        = self._has_int(cfg.get("remote_tools.xai.x.min_favs"))
         adv_x_views       = self._has_int(cfg.get("remote_tools.xai.x.min_views"))
 
-        adv_rss_link      = self._has_str(cfg.get("remote_tools.xai.rss.link"))
-
         adv_from          = self._has_str(cfg.get("remote_tools.xai.from_date"))
         adv_to            = self._has_str(cfg.get("remote_tools.xai.to_date"))
 
@@ -97,7 +225,7 @@ class Remote:
         adv_return_cits   = cfg.get("remote_tools.xai.return_citations", True) is not True  # different than default?
 
         # SDK-capable if: mode!=off and ONLY X is enabled and no X filters/date/max_results customizations
-        x_only = s_x and not s_web and not s_news and not s_rss
+        x_only = s_x and not s_web
         x_filters = any([adv_x_incl, adv_x_excl, adv_x_favs, adv_x_views])
         sdk_enabled = (mode != "off") and x_only and not any([
             x_filters, adv_from, adv_to, adv_max_results, adv_return_cits
@@ -110,10 +238,10 @@ class Remote:
 
         need_http = (mode != "off") and (
             not sdk_enabled or                # advanced X filters or other sources/date/results/citations
-            s_web or s_news or s_rss
+            s_web
         )
         if need_http:
-            http_params = self._build_http_params(cfg, mode, s_web, s_x, s_news, s_rss)
+            http_params = self._build_http_params(cfg, mode, s_web, s_x)
             http_reason = "advanced_sources_or_filters"
 
         return {
@@ -131,8 +259,6 @@ class Remote:
             mode: str,
             s_web: bool,
             s_x: bool,
-            s_news: bool,
-            s_rss: bool
     ) -> dict:
         """
         Build search_parameters for Chat Completions (HTTP).
@@ -141,8 +267,6 @@ class Remote:
         :param mode: "auto"|"on"|"off"
         :param s_web: Include web search
         :param s_x: Include X search
-        :param s_news: Include news search
-        :param s_rss: Include RSS search
         :return: search_parameters dict
         """
         params: Dict[str, Any] = {"mode": mode}
@@ -196,41 +320,12 @@ class Remote:
                 xsrc["post_view_count"] = int(views)
             sources.append(xsrc)
 
-        if s_news:
-            news: Dict[str, Any] = {"type": "news"}
-            country = cfg.get("remote_tools.xai.news.country")
-            if isinstance(country, str) and len(country.strip()) == 2:
-                news["country"] = country.strip().upper()
-            excluded = self._as_list(cfg.get("remote_tools.xai.news.excluded_websites"), 5)
-            if excluded:
-                news["excluded_websites"] = excluded
-            safe = cfg.get("remote_tools.xai.news.safe_search")
-            if safe is not None:
-                news["safe_search"] = bool(safe)
-            sources.append(news)
-
-        if s_rss:
-            link = cfg.get("remote_tools.xai.rss.link")
-            if isinstance(link, str) and link.strip():
-                sources.append({"type": "rss", "links": [link.strip()]})
-
         if sources:
             params["sources"] = sources
 
         return params
 
-    def _has_list(self, v) -> bool:
-        """
-        Return True if v is a non-empty list/tuple or a non-empty comma-separated string.
-
-        :param v: Any
-        :return: bool
-        """
-        if v is None:
-            return False
-        if isinstance(v, (list, tuple)):
-            return len([x for x in v if str(x).strip()]) > 0
-        return len([x for x in str(v).split(",") if x.strip()]) > 0
+    # ---------- helpers ----------
 
     def _has_str(self, v) -> bool:
         """
@@ -250,14 +345,14 @@ class Remote:
         """
         return isinstance(v, int) and v > 0
 
-    def _as_list(self, v, limit: int) -> List[str]:
-        """
-        Convert v to a list of strings, limited to 'limit' items.
+    def _has_list(self, v) -> bool:
+        if v is None:
+            return False
+        if isinstance(v, (list, tuple)):
+            return len([x for x in v if str(x).strip()]) > 0
+        return len([x for x in str(v).split(",") if x.strip()]) > 0
 
-        :param v: Any
-        :param limit: limit number of items
-        :return: List of strings
-        """
+    def _as_list(self, v, limit: int) -> List[str]:
         if v is None:
             return []
         if isinstance(v, (list, tuple)):