swarmauri_provider_xai 0.1.0.dev3__tar.gz

swarmauri_provider_xai-0.1.0.dev3/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2024 Jacob Stewart
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

swarmauri_provider_xai-0.1.0.dev3/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: swarmauri_provider_xai
+Version: 0.1.0.dev3
+Summary: Aggregated xAI provider resources for Swarmauri models.
+License: Copyright 2024 Jacob Stewart
+         
+         Licensed under the Apache License, Version 2.0 (the "License");
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at
+         
+             http://www.apache.org/licenses/LICENSE-2.0
+         
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an "AS IS" BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.
+License-File: LICENSE
+Keywords: swarmauri,provider,xai,grok,realtime
+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)
+Description-Content-Type: text/markdown
+
+![Swarmauri](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+[![PyPI](https://img.shields.io/pypi/v/swarmauri_provider_xai.svg)](https://pypi.org/project/swarmauri_provider_xai/) [![Python](https://img.shields.io/pypi/pyversions/swarmauri_provider_xai.svg)](https://pypi.org/project/swarmauri_provider_xai/) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE) [![Downloads](https://static.pepy.tech/badge/swarmauri_provider_xai)](https://pepy.tech/project/swarmauri_provider_xai) [![Hits](https://hits.sh/github.com/swarmauri/swarmauri-sdk.svg)](https://hits.sh/github.com/swarmauri/swarmauri-sdk/)
+
+# swarmauri_provider_xai
+
+## Features
+
+- xAI authentication, endpoints, catalogs, errors, and tool schemas.
+- Capability-aware chat, model-listing, and realtime connection configs.
+- Runtime authorization with credentials excluded from serialized configs.
+- Shared provider resource for xAI model families.
+
+## Installation
+
+`uv add swarmauri_provider_xai` or `pip install swarmauri_provider_xai`.
+
+## Usage
+
+```python
+from swarmauri_provider_xai import XAIProvider
+
+provider = XAIProvider(api_key="...")
+config = provider.connection_config("chat.completions", model="grok-4.3")
+headers = provider.authorize(config)
+```
+
+Inject the provider into an xAI model adapter; the provider describes the connection but never performs network I/O.
+

swarmauri_provider_xai-0.1.0.dev3/README.md

@@ -0,0 +1,28 @@
+![Swarmauri](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+[![PyPI](https://img.shields.io/pypi/v/swarmauri_provider_xai.svg)](https://pypi.org/project/swarmauri_provider_xai/) [![Python](https://img.shields.io/pypi/pyversions/swarmauri_provider_xai.svg)](https://pypi.org/project/swarmauri_provider_xai/) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE) [![Downloads](https://static.pepy.tech/badge/swarmauri_provider_xai)](https://pepy.tech/project/swarmauri_provider_xai) [![Hits](https://hits.sh/github.com/swarmauri/swarmauri-sdk.svg)](https://hits.sh/github.com/swarmauri/swarmauri-sdk/)
+
+# swarmauri_provider_xai
+
+## Features
+
+- xAI authentication, endpoints, catalogs, errors, and tool schemas.
+- Capability-aware chat, model-listing, and realtime connection configs.
+- Runtime authorization with credentials excluded from serialized configs.
+- Shared provider resource for xAI model families.
+
+## Installation
+
+`uv add swarmauri_provider_xai` or `pip install swarmauri_provider_xai`.
+
+## Usage
+
+```python
+from swarmauri_provider_xai import XAIProvider
+
+provider = XAIProvider(api_key="...")
+config = provider.connection_config("chat.completions", model="grok-4.3")
+headers = provider.authorize(config)
+```
+
+Inject the provider into an xAI model adapter; the provider describes the connection but never performs network I/O.

swarmauri_provider_xai-0.1.0.dev3/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "swarmauri_provider_xai"
+version = "0.1.0.dev3"
+description = "Aggregated xAI provider resources for Swarmauri models."
+readme = "README.md"
+requires-python = ">=3.10,<3.13"
+authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
+license = { file = "LICENSE" }
+dependencies = ["swarmauri_core>=0.11.0.dev5", "swarmauri_base>=0.11.0.dev5"]
+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"]
+keywords = ["swarmauri", "provider", "xai", "grok", "realtime"]
+[tool.uv.sources]
+swarmauri_core = { workspace = true }
+swarmauri_base = { workspace = true }
+[project.entry-points."swarmauri.model_providers"]
+XAIProvider = "swarmauri_provider_xai:XAIProvider"
+[build-system]
+requires = ["poetry-core>=1.8.0"]
+build-backend = "poetry.core.masonry.api"
+[dependency-groups]
+dev = ["pytest>=8.0", "ruff>=0.9.9", "swarmauri_tests_component"]
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+
+[tool.ruff.lint]
+ignore = ["N999", "RUF012"]

swarmauri_provider_xai-0.1.0.dev3/swarmauri_provider_xai/XAIAuthConfig.py

@@ -0,0 +1,21 @@
+from collections.abc import Mapping
+from typing import Literal
+
+from pydantic import Field, SecretStr
+from swarmauri_base.model_providers.ProviderAuthBase import ProviderAuthBase
+from swarmauri_base.ComponentBase import ComponentBase
+
+
+@ComponentBase.register_type(ProviderAuthBase, "XAIAuthConfig")
+class XAIAuthConfig(ProviderAuthBase):
+    api_key: SecretStr | None = Field(default=None, exclude=True)
+    type: Literal["XAIAuthConfig"] = "XAIAuthConfig"
+
+    def apply(self, headers: Mapping[str, str]) -> dict[str, str]:
+        authorized = dict(headers)
+        if self.api_key is None:
+            raise ValueError("XAIProvider requires an api_key")
+        authorized["Authorization"] = (
+            f"Bearer {self.api_key.get_secret_value()}"
+        )
+        return authorized

swarmauri_provider_xai-0.1.0.dev3/swarmauri_provider_xai/XAIEndpoints.py

@@ -0,0 +1,30 @@
+from typing import Literal
+
+from swarmauri_base.model_providers.ProviderEndpointBase import (
+    ProviderEndpointBase,
+)
+from swarmauri_base.ComponentBase import ComponentBase
+
+
+@ComponentBase.register_type(ProviderEndpointBase, "XAIEndpoints")
+class XAIEndpoints(ProviderEndpointBase):
+    base_url: str = "https://api.x.ai/v1"
+    chat_completions_path: str = "/chat/completions"
+    models_path: str = "/language-models"
+    websocket_url: str = "wss://api.x.ai/v1/realtime"
+    type: Literal["XAIEndpoints"] = "XAIEndpoints"
+
+    def resolve(self, capability: str) -> str:
+        paths = {
+            "chat.completions": self.chat_completions_path,
+            "models.list": self.models_path,
+        }
+        if capability == "realtime.connect":
+            return self.websocket_url
+        try:
+            path = paths[capability]
+        except KeyError as error:
+            raise ValueError(
+                f"xAI does not support capability {capability!r}"
+            ) from error
+        return f"{self.base_url.rstrip('/')}/{path.lstrip('/')}"

swarmauri_provider_xai-0.1.0.dev3/swarmauri_provider_xai/XAIErrorMapper.py

@@ -0,0 +1,14 @@
+from typing import Any, Literal
+
+from swarmauri_base.model_providers.ProviderErrorMapperBase import (
+    ProviderErrorMapperBase,
+)
+from swarmauri_base.ComponentBase import ComponentBase
+
+
+@ComponentBase.register_type(ProviderErrorMapperBase, "XAIErrorMapper")
+class XAIErrorMapper(ProviderErrorMapperBase):
+    type: Literal["XAIErrorMapper"] = "XAIErrorMapper"
+
+    def map_error(self, error: BaseException | Any) -> BaseException:
+        return RuntimeError(f"xAI provider error: {error}")

swarmauri_provider_xai-0.1.0.dev3/swarmauri_provider_xai/XAIModelCatalog.py

@@ -0,0 +1,20 @@
+from typing import Literal
+
+from swarmauri_base.model_providers.ModelCatalogBase import ModelCatalogBase
+from swarmauri_base.ComponentBase import ComponentBase
+
+
+@ComponentBase.register_type(ModelCatalogBase, "XAIModelCatalog")
+class XAIModelCatalog(ModelCatalogBase):
+    models: dict = {
+        "grok-4.3": {
+            "name": "grok-4.3",
+            "capabilities": [
+                "chat_completions",
+                "multimodal_input",
+                "streaming",
+                "tools",
+            ],
+        }
+    }
+    type: Literal["XAIModelCatalog"] = "XAIModelCatalog"

swarmauri_provider_xai-0.1.0.dev3/swarmauri_provider_xai/XAIProvider.py

@@ -0,0 +1,60 @@
+from typing import Literal
+
+from pydantic import Field, model_validator
+from swarmauri_base.ComponentBase import ComponentBase
+from swarmauri_base.model_providers.ModelProviderBase import ModelProviderBase
+from swarmauri_base.model_providers.ProviderConnectionConfig import (
+    ProviderConnectionConfig,
+)
+
+from .XAIAuthConfig import XAIAuthConfig
+from .XAIEndpoints import XAIEndpoints
+from .XAIErrorMapper import XAIErrorMapper
+from .XAIModelCatalog import XAIModelCatalog
+
+
+@ComponentBase.register_type(ModelProviderBase, "XAIProvider")
+class XAIProvider(ModelProviderBase):
+    provider_name: Literal["xai"] = "xai"
+    endpoints: XAIEndpoints = Field(default_factory=XAIEndpoints)
+    catalog: XAIModelCatalog = Field(default_factory=XAIModelCatalog)
+    error_mapper: XAIErrorMapper = Field(default_factory=XAIErrorMapper)
+    auth: XAIAuthConfig = Field(default_factory=XAIAuthConfig, exclude=True)
+    type: Literal["XAIProvider"] = "XAIProvider"
+
+    @model_validator(mode="after")
+    def configure(self) -> "XAIProvider":
+        self.base_url = self.base_url or self.endpoints.base_url
+        self.endpoints.base_url = self.base_url
+        if self.api_key is not None:
+            self.auth.api_key = self.api_key
+        elif self.auth.api_key is not None:
+            self.api_key = self.auth.api_key
+        return self
+
+    def connection_config(
+        self,
+        capability: str,
+        model: str | None = None,
+    ) -> ProviderConnectionConfig:
+        endpoint = self.endpoints.resolve(capability)
+        options = super().connection_options()
+        if model is not None:
+            options["model"] = model
+        return ProviderConnectionConfig(
+            endpoint=endpoint,
+            headers={
+                **self.default_headers,
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+            },
+            transport_options=options,
+            auth_context=self.auth,
+        )
+
+    @staticmethod
+    def authorize(config: ProviderConnectionConfig) -> dict[str, str]:
+        auth = config.auth_context
+        if not isinstance(auth, XAIAuthConfig):
+            raise TypeError("xAI connection configuration has no auth context")
+        return auth.apply(config.headers)

swarmauri_provider_xai-0.1.0.dev3/swarmauri_provider_xai/XAIToolSchemaConverter.py

@@ -0,0 +1,30 @@
+from typing import Any
+
+
+class XAIToolSchemaConverter:
+    def convert(self, tool: Any) -> dict[str, Any]:
+        properties: dict[str, Any] = {}
+        required: list[str] = []
+        for parameter in getattr(tool, "parameters", []):
+            schema: dict[str, Any] = {
+                "type": parameter.input_type,
+                "description": parameter.description,
+            }
+            if parameter.enum:
+                schema["enum"] = parameter.enum
+            properties[parameter.name] = schema
+            if parameter.required:
+                required.append(parameter.name)
+        return {
+            "type": "function",
+            "function": {
+                "name": tool.name,
+                "description": getattr(tool, "description", None),
+                "parameters": {
+                    "type": "object",
+                    "properties": properties,
+                    "required": required,
+                    "additionalProperties": False,
+                },
+            },
+        }

swarmauri_provider_xai-0.1.0.dev3/swarmauri_provider_xai/__init__.py

@@ -0,0 +1,15 @@
+from .XAIAuthConfig import XAIAuthConfig
+from .XAIEndpoints import XAIEndpoints
+from .XAIErrorMapper import XAIErrorMapper
+from .XAIModelCatalog import XAIModelCatalog
+from .XAIProvider import XAIProvider
+from .XAIToolSchemaConverter import XAIToolSchemaConverter
+
+__all__ = [
+    "XAIAuthConfig",
+    "XAIEndpoints",
+    "XAIErrorMapper",
+    "XAIModelCatalog",
+    "XAIProvider",
+    "XAIToolSchemaConverter",
+]