swarmauri_llm_xai 0.11.0.dev4__tar.gz

swarmauri_llm_xai-0.11.0.dev4/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: swarmauri_llm_xai
+Version: 0.11.0.dev4
+Summary: Provider-native Swarmauri chat and tool-calling adapters for the xAI Inference API.
+License-Expression: Apache-2.0
+Keywords: swarmauri,llm,xai,grok,tool calling,streaming,inference api
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: Development Status :: 1 - Planning
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: swarmauri_base (>=0.11.0.dev5)
+Requires-Dist: swarmauri_core (>=0.11.0.dev5)
+Requires-Dist: swarmauri_provider_xai (>=0.1.0.dev3)
+Requires-Dist: swarmauri_standard (>=0.11.0.dev6)
+Requires-Dist: swarmauri_transport_httpx (>=0.1.0.dev5)
+Requires-Dist: swarmauri_transport_retry (>=0.1.0.dev1)
+Description-Content-Type: text/markdown
+
+![Swarmauri](https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+<p align="center">
+  <a href="https://pepy.tech/project/swarmauri_llm_xai"><img src="https://static.pepy.tech/badge/swarmauri_llm_xai/month" alt="Downloads"></a>
+  <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_llm_xai/"><img src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_llm_xai.svg" alt="Hits"></a>
+  <a href="https://pypi.org/project/swarmauri_llm_xai/"><img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue" alt="Python"></a>
+  <a href="https://pypi.org/project/swarmauri_llm_xai/"><img src="https://img.shields.io/pypi/l/swarmauri_llm_xai" alt="License"></a>
+  <a href="https://pypi.org/project/swarmauri_llm_xai/"><img src="https://img.shields.io/pypi/v/swarmauri_llm_xai" alt="Release"></a>
+</p>
+
+# Swarmauri xAI LLM
+
+`swarmauri_llm_xai` provides provider-native Swarmauri adapters for xAI's Grok chat-completions API.
+
+## Features
+
+- `XAIModel` directly implements the Swarmauri LLM base contract.
+- `XAIToolModel` directly implements the tool-LLM base contract.
+- Bearer-token authentication with credentials excluded from serialized state.
+- Sync, async, incremental streaming, batch, and function-calling workflows.
+- Optional model discovery through xAI's language-model catalog.
+- Explicit provider, HTTP client, and retry-policy composition.
+- Conservative chat retries that do not replay ambiguous connection failures.
+
+## Installation
+
+```bash
+uv add swarmauri_llm_xai
+```
+
+```bash
+pip install swarmauri_llm_xai
+```
+
+## Usage
+
+```python
+import os
+
+from swarmauri_llm_xai import XAIModel
+from swarmauri_standard.conversations.Conversation import Conversation
+from swarmauri_standard.messages.HumanMessage import HumanMessage
+
+conversation = Conversation(
+    messages=[HumanMessage(content="Explain orbital mechanics briefly.")]
+)
+model = XAIModel(api_key=os.environ["XAI_API_KEY"], name="grok-4.3")
+model.predict(conversation)
+print(conversation.get_last().content)
+```
+
+For explicit composition:
+
+```python
+from swarmauri_llm_xai import XAIChatRetryPolicy, XAIModel
+from swarmauri_provider_xai import XAIProvider
+from swarmauri_transport_httpx import HttpxClient
+
+provider = XAIProvider(api_key=os.environ["XAI_API_KEY"])
+model = XAIModel(
+    provider=provider,
+    http_client=HttpxClient(base_url=provider.base_url),
+    retry_policy=XAIChatRetryPolicy(max_attempts=3),
+)
+```
+
+Use `XAIToolModel` with a Swarmauri `Toolkit` for function calling. Set `discover_models=True` to populate allowed model IDs from the authenticated xAI language-model catalog.
+
+See the [xAI inference reference](https://docs.x.ai/developers/rest-api-reference/inference), [chat endpoint](https://docs.x.ai/developers/rest-api-reference/inference/chat), and [function-calling guide](https://docs.x.ai/developers/tools/function-calling).
+

swarmauri_llm_xai-0.11.0.dev4/README.md

@@ -0,0 +1,69 @@
+![Swarmauri](https://raw.githubusercontent.com/swarmauri/swarmauri-sdk/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+<p align="center">
+  <a href="https://pepy.tech/project/swarmauri_llm_xai"><img src="https://static.pepy.tech/badge/swarmauri_llm_xai/month" alt="Downloads"></a>
+  <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_llm_xai/"><img src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_llm_xai.svg" alt="Hits"></a>
+  <a href="https://pypi.org/project/swarmauri_llm_xai/"><img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue" alt="Python"></a>
+  <a href="https://pypi.org/project/swarmauri_llm_xai/"><img src="https://img.shields.io/pypi/l/swarmauri_llm_xai" alt="License"></a>
+  <a href="https://pypi.org/project/swarmauri_llm_xai/"><img src="https://img.shields.io/pypi/v/swarmauri_llm_xai" alt="Release"></a>
+</p>
+
+# Swarmauri xAI LLM
+
+`swarmauri_llm_xai` provides provider-native Swarmauri adapters for xAI's Grok chat-completions API.
+
+## Features
+
+- `XAIModel` directly implements the Swarmauri LLM base contract.
+- `XAIToolModel` directly implements the tool-LLM base contract.
+- Bearer-token authentication with credentials excluded from serialized state.
+- Sync, async, incremental streaming, batch, and function-calling workflows.
+- Optional model discovery through xAI's language-model catalog.
+- Explicit provider, HTTP client, and retry-policy composition.
+- Conservative chat retries that do not replay ambiguous connection failures.
+
+## Installation
+
+```bash
+uv add swarmauri_llm_xai
+```
+
+```bash
+pip install swarmauri_llm_xai
+```
+
+## Usage
+
+```python
+import os
+
+from swarmauri_llm_xai import XAIModel
+from swarmauri_standard.conversations.Conversation import Conversation
+from swarmauri_standard.messages.HumanMessage import HumanMessage
+
+conversation = Conversation(
+    messages=[HumanMessage(content="Explain orbital mechanics briefly.")]
+)
+model = XAIModel(api_key=os.environ["XAI_API_KEY"], name="grok-4.3")
+model.predict(conversation)
+print(conversation.get_last().content)
+```
+
+For explicit composition:
+
+```python
+from swarmauri_llm_xai import XAIChatRetryPolicy, XAIModel
+from swarmauri_provider_xai import XAIProvider
+from swarmauri_transport_httpx import HttpxClient
+
+provider = XAIProvider(api_key=os.environ["XAI_API_KEY"])
+model = XAIModel(
+    provider=provider,
+    http_client=HttpxClient(base_url=provider.base_url),
+    retry_policy=XAIChatRetryPolicy(max_attempts=3),
+)
+```
+
+Use `XAIToolModel` with a Swarmauri `Toolkit` for function calling. Set `discover_models=True` to populate allowed model IDs from the authenticated xAI language-model catalog.
+
+See the [xAI inference reference](https://docs.x.ai/developers/rest-api-reference/inference), [chat endpoint](https://docs.x.ai/developers/rest-api-reference/inference/chat), and [function-calling guide](https://docs.x.ai/developers/tools/function-calling).

swarmauri_llm_xai-0.11.0.dev4/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "swarmauri_llm_xai"
+version = "0.11.0.dev4"
+description = "Provider-native Swarmauri chat and tool-calling adapters for the xAI Inference API."
+license = "Apache-2.0"
+readme = "README.md"
+requires-python = ">=3.10,<3.13"
+authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
+keywords = ["swarmauri", "llm", "xai", "grok", "tool calling", "streaming", "inference api"]
+classifiers = [
+  "Development Status :: 1 - Planning",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+  "swarmauri_base>=0.11.0.dev5",
+  "swarmauri_core>=0.11.0.dev5",
+  "swarmauri_provider_xai>=0.1.0.dev3",
+  "swarmauri_standard>=0.11.0.dev6",
+  "swarmauri_transport_httpx>=0.1.0.dev5",
+  "swarmauri_transport_retry>=0.1.0.dev1",
+]
+
+[tool.uv.sources]
+swarmauri_base = { workspace = true }
+swarmauri_core = { workspace = true }
+swarmauri_provider_xai = { workspace = true }
+swarmauri_standard = { workspace = true }
+swarmauri_transport_httpx = { workspace = true }
+swarmauri_transport_retry = { workspace = true }
+
+[project.entry-points."swarmauri.llms"]
+XAIModel = "swarmauri_llm_xai:XAIModel"
+
+[project.entry-points."swarmauri.tool_llms"]
+XAIToolModel = "swarmauri_llm_xai:XAIToolModel"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = ["pytest>=8.0", "pytest-asyncio>=0.24", "ruff>=0.9.9"]
+
+[tool.pytest.ini_options]
+markers = ["unit: Unit tests"]
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+
+[tool.ruff.lint]
+ignore = ["N999"]

swarmauri_llm_xai-0.11.0.dev4/swarmauri_llm_xai/XAIChatRetryPolicy.py

@@ -0,0 +1,34 @@
+"""Replay policy for xAI chat and model-discovery operations."""
+
+from swarmauri_core.transports.i_http_response import IHttpResponse
+from swarmauri_transport_retry import ExponentialBackoffRetryPolicy
+
+
+class XAIChatRetryPolicy(ExponentialBackoffRetryPolicy):
+    """Retry xAI reads broadly and chat writes conservatively."""
+
+    def __init__(self, **kwargs) -> None:
+        kwargs.setdefault("retryable_methods", {"GET", "POST"})
+        super().__init__(**kwargs)
+
+    def should_retry(
+        self,
+        *,
+        method: str,
+        attempt: int,
+        response: IHttpResponse | None = None,
+        error: Exception | None = None,
+    ) -> bool:
+        if method.upper() == "POST":
+            return (
+                attempt < self.max_attempts
+                and error is None
+                and response is not None
+                and response.status_code == 429
+            )
+        return super().should_retry(
+            method=method,
+            attempt=attempt,
+            response=response,
+            error=error,
+        )

swarmauri_llm_xai-0.11.0.dev4/swarmauri_llm_xai/XAIModel.py

@@ -0,0 +1,104 @@
+from typing import Any, ClassVar, Literal
+
+from pydantic import PrivateAttr
+from swarmauri_base.ComponentBase import ComponentBase
+from swarmauri_base.llms.LLMBase import LLMBase
+from swarmauri_core.transports.i_http_client import IHttpClient
+from swarmauri_core.transports.i_http_retry_policy import IHttpRetryPolicy
+from swarmauri_provider_xai import XAIProvider
+from swarmauri_standard.utils.provider_chat_transport import (
+    abatch_chat,
+    apredict_chat,
+    astream_chat,
+    batch_chat,
+    predict_chat,
+    stream_chat,
+)
+
+from ._client import build_xai_client
+
+
+@ComponentBase.register_type()
+class XAIModel(LLMBase):
+    """Provider-native xAI chat-completions model."""
+
+    type: Literal["XAIModel"] = "XAIModel"
+    base_url: str = "https://api.x.ai/v1"
+    name: str = "grok-4.3"
+    discover_models: bool = False
+    capabilities: ClassVar[frozenset[str]] = frozenset(
+        {"chat_completions", "multimodal_input", "streaming", "tools"}
+    )
+    _provider: XAIProvider = PrivateAttr()
+    _http_client: IHttpClient = PrivateAttr()
+    _retry_owned_by_transport: bool = PrivateAttr(default=True)
+
+    predict = predict_chat
+    apredict = apredict_chat
+    stream = stream_chat
+    astream = astream_chat
+    batch = batch_chat
+    abatch = abatch_chat
+
+    def __init__(
+        self,
+        *,
+        provider: XAIProvider | None = None,
+        http_client: IHttpClient | None = None,
+        retry_policy: IHttpRetryPolicy | None = None,
+        **data: Any,
+    ) -> None:
+        selected_name = data.get(
+            "name", self.__class__.model_fields["name"].default
+        )
+        data.setdefault("allowed_models", [selected_name])
+        super().__init__(**data)
+        if self.api_key is None:
+            if provider is None or provider.api_key is None:
+                raise ValueError(
+                    "api_key or an authenticated provider is required"
+                )
+        self._provider = provider or XAIProvider(
+            api_key=self.api_key,
+            base_url=self.base_url,
+            timeout=self.timeout,
+            max_retries=self.max_retries,
+        )
+        self.base_url = self._provider.base_url or self.base_url
+        self._http_client = build_xai_client(
+            provider=self._provider,
+            http_client=http_client,
+            retry_policy=retry_policy,
+        )
+        if self.discover_models:
+            self.allowed_models = self._get_models()
+        elif not self.allowed_models:
+            self.allowed_models = [self.name]
+
+    def _build_endpoint(self) -> str:
+        config = self._provider.connection_config(
+            "chat.completions", model=self.name
+        )
+        return str(config.endpoint)
+
+    def _build_headers(self) -> dict[str, str]:
+        config = self._provider.connection_config(
+            "chat.completions", model=self.name
+        )
+        return self._provider.authorize(config)
+
+    def _get_models(self) -> list[str]:
+        if not self.discover_models:
+            return [self.name]
+        config = self._provider.connection_config("models.list")
+        response = self._http_client.request(
+            "GET",
+            str(config.endpoint),
+            headers=self._provider.authorize(config),
+        )
+        response.raise_for_status()
+        return [
+            item["id"]
+            for item in response.json().get("models", [])
+            if item.get("id")
+        ]

swarmauri_llm_xai-0.11.0.dev4/swarmauri_llm_xai/XAIToolModel.py

@@ -0,0 +1,111 @@
+from typing import Any, ClassVar, Literal
+
+from pydantic import PrivateAttr
+from swarmauri_base.ComponentBase import ComponentBase
+from swarmauri_base.tool_llms.ToolLLMBase import ToolLLMBase
+from swarmauri_core.transports.i_http_client import IHttpClient
+from swarmauri_core.transports.i_http_retry_policy import IHttpRetryPolicy
+from swarmauri_provider_xai import XAIProvider, XAIToolSchemaConverter
+from swarmauri_standard.utils.provider_chat_transport import (
+    abatch_tools,
+    apredict_tools,
+    astream_tools,
+    batch_tools,
+    format_messages,
+    predict_tools,
+    stream_tools,
+)
+
+from ._client import build_xai_client
+
+
+@ComponentBase.register_type()
+class XAIToolModel(ToolLLMBase):
+    """Provider-native xAI tool-calling model."""
+
+    type: Literal["XAIToolModel"] = "XAIToolModel"
+    base_url: str = "https://api.x.ai/v1"
+    name: str = "grok-4.3"
+    discover_models: bool = False
+    capabilities: ClassVar[frozenset[str]] = frozenset(
+        {"chat_completions", "streaming", "tools"}
+    )
+    _provider: XAIProvider = PrivateAttr()
+    _http_client: IHttpClient = PrivateAttr()
+    _retry_owned_by_transport: bool = PrivateAttr(default=True)
+
+    predict = predict_tools
+    apredict = apredict_tools
+    stream = stream_tools
+    astream = astream_tools
+    batch = batch_tools
+    abatch = abatch_tools
+
+    def __init__(
+        self,
+        *,
+        provider: XAIProvider | None = None,
+        http_client: IHttpClient | None = None,
+        retry_policy: IHttpRetryPolicy | None = None,
+        **data: Any,
+    ) -> None:
+        selected_name = data.get(
+            "name", self.__class__.model_fields["name"].default
+        )
+        data.setdefault("allowed_models", [selected_name])
+        super().__init__(**data)
+        if self.api_key is None:
+            if provider is None or provider.api_key is None:
+                raise ValueError(
+                    "api_key or an authenticated provider is required"
+                )
+        self._provider = provider or XAIProvider(
+            api_key=self.api_key,
+            base_url=self.base_url,
+            timeout=self.timeout,
+            max_retries=self.max_retries,
+        )
+        self.base_url = self._provider.base_url or self.base_url
+        self._http_client = build_xai_client(
+            provider=self._provider,
+            http_client=http_client,
+            retry_policy=retry_policy,
+        )
+        if self.discover_models:
+            self.allowed_models = self._get_models()
+        elif not self.allowed_models:
+            self.allowed_models = [self.name]
+
+    def get_schema_converter(self):
+        return XAIToolSchemaConverter()
+
+    def _format_messages(self, messages):
+        return format_messages(messages)
+
+    def _build_endpoint(self) -> str:
+        config = self._provider.connection_config(
+            "chat.completions", model=self.name
+        )
+        return str(config.endpoint)
+
+    def _build_headers(self) -> dict[str, str]:
+        config = self._provider.connection_config(
+            "chat.completions", model=self.name
+        )
+        return self._provider.authorize(config)
+
+    def _get_models(self) -> list[str]:
+        if not self.discover_models:
+            return [self.name]
+        config = self._provider.connection_config("models.list")
+        response = self._http_client.request(
+            "GET",
+            str(config.endpoint),
+            headers=self._provider.authorize(config),
+        )
+        response.raise_for_status()
+        return [
+            item["id"]
+            for item in response.json().get("models", [])
+            if item.get("id")
+        ]

swarmauri_llm_xai-0.11.0.dev4/swarmauri_llm_xai/__init__.py

@@ -0,0 +1,12 @@
+from importlib.metadata import PackageNotFoundError, version
+
+from .XAIModel import XAIModel
+from .XAIChatRetryPolicy import XAIChatRetryPolicy
+from .XAIToolModel import XAIToolModel
+
+try:
+    __version__ = version("swarmauri_llm_xai")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = ["XAIChatRetryPolicy", "XAIModel", "XAIToolModel"]

swarmauri_llm_xai-0.11.0.dev4/swarmauri_llm_xai/_client.py

@@ -0,0 +1,27 @@
+"""Client composition for xAI model families."""
+
+from swarmauri_core.transports.i_http_client import IHttpClient
+from swarmauri_core.transports.i_http_retry_policy import IHttpRetryPolicy
+from swarmauri_provider_xai import XAIProvider
+from swarmauri_transport_httpx import HttpxClient
+from swarmauri_transport_retry import RetryingHttpClient
+
+from .XAIChatRetryPolicy import XAIChatRetryPolicy
+
+
+def build_xai_client(
+    *,
+    provider: XAIProvider,
+    http_client: IHttpClient | None,
+    retry_policy: IHttpRetryPolicy | None,
+) -> IHttpClient:
+    concrete_client = http_client or HttpxClient(
+        base_url=provider.base_url,
+        timeout=provider.timeout,
+    )
+    return RetryingHttpClient(
+        client=concrete_client,
+        policy=retry_policy
+        or XAIChatRetryPolicy(max_attempts=max(provider.max_retries, 1)),
+        own_client=http_client is None,
+    )