llm-api-adapter-xai 0.1.0__tar.gz

llm_api_adapter_xai-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sergey Inozemtsev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

llm_api_adapter_xai-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include README.md
+include LICENSE
+include src/llm_api_adapter_xai/py.typed
+recursive-include src/llm_api_adapter_xai/registry/organizations *.json
+
+global-exclude *.py[cod]
+prune **/__pycache__
+prune **/.pytest_cache
+global-exclude *.egg-info
+prune **/*.egg-info

llm_api_adapter_xai-0.1.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: llm-api-adapter-xai
+Version: 0.1.0
+Summary: Official xAI Responses API package for llm-api-adapter
+Author: Sergey Inozemtsev
+License: MIT License
+        
+        Copyright (c) 2025 Sergey Inozemtsev
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Repository, https://github.com/Inozem/llm_api_adapter/
+Keywords: llm,xai,grok,adapter,api
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: llm-api-adapter<1.0.0,>=0.9.1
+Provides-Extra: async
+Requires-Dist: llm-api-adapter[async]<1.0.0,>=0.9.1; extra == "async"
+Provides-Extra: httpx
+Requires-Dist: llm-api-adapter[httpx]<1.0.0,>=0.9.1; extra == "httpx"
+Dynamic: license-file
+
+# llm-api-adapter-xai
+
+Official xAI Responses API support for
+[llm-api-adapter](https://github.com/Inozem/llm_api_adapter/).
+
+## Installation
+
+Install through the core package extra:
+
+```bash
+pip install "llm-api-adapter[xai]"
+```
+
+Direct installation is also supported when the core package is managed
+separately:
+
+```bash
+pip install llm-api-adapter-xai
+```
+
+Async methods need HTTPX:
+
+```bash
+pip install "llm-api-adapter[xai,async]"
+```
+
+Synchronous `requests` remains the default. To opt into the HTTPX synchronous
+transport, install `"llm-api-adapter[xai,httpx]"` and pass
+`transport="httpx"`.
+
+## Quick start
+
+```python
+import os
+
+from llm_api_adapter.models.messages.chat_message import UserMessage
+from llm_api_adapter.universal_adapter import UniversalLLMAPIAdapter
+
+adapter = UniversalLLMAPIAdapter(
+    organization="xai",
+    model="grok-4.6",
+    api_key=os.environ["XAI_API_KEY"],
+)
+
+response = adapter.chat(
+    messages=[UserMessage("Explain retrieval-augmented generation.")]
+)
+print(response.content)
+```
+
+## Supported models and capabilities
+
+The package deliberately exposes fixed model IDs, not moving aliases:
+`grok-4.5` and `grok-4.6`.
+
+| Capability | Supported models |
+| --- | --- |
+| Text chat, sync/async streaming, application function tools, JSON Schema/Pydantic output, image URLs or bytes, and PDF URLs or bytes | Both models |
+| `reasoning_level` | `grok-4.5`: `low`–`high`; `grok-4.6`: `low`–`xhigh` |
+
+For `grok-4.5` and `grok-4.6`, xAI cannot disable reasoning: a requested
+`"none"` is mapped to the documented minimum and produces a warning.
+
+The JSON Schema subset is limited by xAI. The adapter rejects unsupported
+schemas before sending a request. See xAI's
+[structured-output documentation](https://docs.x.ai/developers/model-capabilities/text/structured-outputs)
+for the supported schema vocabulary.
+
+## Conversations, files, and costs
+
+`previous_response` is accepted for the shared API, but xAI continuation is
+intentionally not used: the adapter does not send `previous_response_id`.
+Keep and provide the complete `messages` history for each turn, including
+assistant tool calls and `ToolMessage` results.
+
+The package does not expose or send xAI's `store` option. xAI documents that
+Responses are stored server-side by default, so configure data retention with
+xAI when that matters to your application. In particular, the library does not
+turn on Zero Data Retention (ZDR); enabling ZDR in the xAI Console blocks new
+Files API uploads and `file_id` attachments.
+
+PDF URLs are passed to xAI unchanged. For PDF bytes, the adapter uploads a
+provider-owned file with a 24-hour expiry; it never deletes or changes a URL or
+file identifier supplied by your application. No OCR or local text extraction
+is performed.
+
+Attaching a PDF activates xAI's `attachment_search` tool. That makes the
+request agentic and adds tool-invocation charges to normal token charges.
+Storage for an uploaded file is also billed by xAI until it expires. Treat
+`ChatResponse.cost_total` as the exact request cost only when xAI returns it;
+consult xAI billing for storage and any charges not included in that response.
+
+See the official xAI documentation for
+[Responses storage](https://docs.x.ai/developers/model-capabilities/text/comparison),
+[files and expiry](https://docs.x.ai/developers/files/managing-files), and
+[file-search pricing](https://docs.x.ai/developers/pricing).
+
+See the main [llm-api-adapter README](https://github.com/Inozem/llm_api_adapter/#readme)
+for the shared API contract and examples.

llm_api_adapter_xai-0.1.0/README.md

@@ -0,0 +1,99 @@
+# llm-api-adapter-xai
+
+Official xAI Responses API support for
+[llm-api-adapter](https://github.com/Inozem/llm_api_adapter/).
+
+## Installation
+
+Install through the core package extra:
+
+```bash
+pip install "llm-api-adapter[xai]"
+```
+
+Direct installation is also supported when the core package is managed
+separately:
+
+```bash
+pip install llm-api-adapter-xai
+```
+
+Async methods need HTTPX:
+
+```bash
+pip install "llm-api-adapter[xai,async]"
+```
+
+Synchronous `requests` remains the default. To opt into the HTTPX synchronous
+transport, install `"llm-api-adapter[xai,httpx]"` and pass
+`transport="httpx"`.
+
+## Quick start
+
+```python
+import os
+
+from llm_api_adapter.models.messages.chat_message import UserMessage
+from llm_api_adapter.universal_adapter import UniversalLLMAPIAdapter
+
+adapter = UniversalLLMAPIAdapter(
+    organization="xai",
+    model="grok-4.6",
+    api_key=os.environ["XAI_API_KEY"],
+)
+
+response = adapter.chat(
+    messages=[UserMessage("Explain retrieval-augmented generation.")]
+)
+print(response.content)
+```
+
+## Supported models and capabilities
+
+The package deliberately exposes fixed model IDs, not moving aliases:
+`grok-4.5` and `grok-4.6`.
+
+| Capability | Supported models |
+| --- | --- |
+| Text chat, sync/async streaming, application function tools, JSON Schema/Pydantic output, image URLs or bytes, and PDF URLs or bytes | Both models |
+| `reasoning_level` | `grok-4.5`: `low`–`high`; `grok-4.6`: `low`–`xhigh` |
+
+For `grok-4.5` and `grok-4.6`, xAI cannot disable reasoning: a requested
+`"none"` is mapped to the documented minimum and produces a warning.
+
+The JSON Schema subset is limited by xAI. The adapter rejects unsupported
+schemas before sending a request. See xAI's
+[structured-output documentation](https://docs.x.ai/developers/model-capabilities/text/structured-outputs)
+for the supported schema vocabulary.
+
+## Conversations, files, and costs
+
+`previous_response` is accepted for the shared API, but xAI continuation is
+intentionally not used: the adapter does not send `previous_response_id`.
+Keep and provide the complete `messages` history for each turn, including
+assistant tool calls and `ToolMessage` results.
+
+The package does not expose or send xAI's `store` option. xAI documents that
+Responses are stored server-side by default, so configure data retention with
+xAI when that matters to your application. In particular, the library does not
+turn on Zero Data Retention (ZDR); enabling ZDR in the xAI Console blocks new
+Files API uploads and `file_id` attachments.
+
+PDF URLs are passed to xAI unchanged. For PDF bytes, the adapter uploads a
+provider-owned file with a 24-hour expiry; it never deletes or changes a URL or
+file identifier supplied by your application. No OCR or local text extraction
+is performed.
+
+Attaching a PDF activates xAI's `attachment_search` tool. That makes the
+request agentic and adds tool-invocation charges to normal token charges.
+Storage for an uploaded file is also billed by xAI until it expires. Treat
+`ChatResponse.cost_total` as the exact request cost only when xAI returns it;
+consult xAI billing for storage and any charges not included in that response.
+
+See the official xAI documentation for
+[Responses storage](https://docs.x.ai/developers/model-capabilities/text/comparison),
+[files and expiry](https://docs.x.ai/developers/files/managing-files), and
+[file-search pricing](https://docs.x.ai/developers/pricing).
+
+See the main [llm-api-adapter README](https://github.com/Inozem/llm_api_adapter/#readme)
+for the shared API contract and examples.

llm_api_adapter_xai-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "llm-api-adapter-xai"
+version = "0.1.0"
+description = "Official xAI Responses API package for llm-api-adapter"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+authors = [{name = "Sergey Inozemtsev"}]
+keywords = ["llm", "xai", "grok", "adapter", "api"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Typing :: Typed",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+dependencies = ["llm-api-adapter>=0.9.1,<1.0.0"]
+
+[project.optional-dependencies]
+async = ["llm-api-adapter[async]>=0.9.1,<1.0.0"]
+httpx = ["llm-api-adapter[httpx]>=0.9.1,<1.0.0"]
+
+[project.entry-points."llm_api_adapter.organizations"]
+xai = "llm_api_adapter_xai.plugin:PLUGIN"
+
+[project.urls]
+Repository = "https://github.com/Inozem/llm_api_adapter/"
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["llm_api_adapter_xai*"]
+exclude = ["tests*", "*/tests*"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+"llm_api_adapter_xai" = ["py.typed", "registry/organizations/*.json"]
+
+[tool.pytest.ini_options]
+markers = [
+  "unit: unit tests (no network, pure logic, mocks)",
+]

llm_api_adapter_xai-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

llm_api_adapter_xai-0.1.0/src/llm_api_adapter_xai/__init__.py

@@ -0,0 +1,19 @@
+"""Official xAI Responses API support for :mod:`llm_api_adapter`."""
+
+from typing import TYPE_CHECKING, Any
+
+
+if TYPE_CHECKING:
+    from .adapter import XAIAdapter
+
+
+def __getattr__(name: str) -> Any:
+    """Load the adapter only when the public class is requested."""
+    if name == "XAIAdapter":
+        from .adapter import XAIAdapter
+
+        return XAIAdapter
+    raise AttributeError(name)
+
+
+__all__ = ["XAIAdapter"]