swarmauri_provider_openai 0.1.0.dev3__tar.gz

swarmauri_provider_openai-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_openai-0.1.0.dev3/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: swarmauri_provider_openai
+Version: 0.1.0.dev3
+Summary: Aggregated OpenAI 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,openai,realtime,model catalog
+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_openai.svg)](https://pypi.org/project/swarmauri_provider_openai/) [![Python](https://img.shields.io/pypi/pyversions/swarmauri_provider_openai.svg)](https://pypi.org/project/swarmauri_provider_openai/) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE) [![Downloads](https://static.pepy.tech/badge/swarmauri_provider_openai)](https://pepy.tech/project/swarmauri_provider_openai) [![Hits](https://hits.sh/github.com/swarmauri/swarmauri-sdk.svg)](https://hits.sh/github.com/swarmauri/swarmauri-sdk/)
+
+# swarmauri_provider_openai
+
+## Features
+
+- Shared OpenAI credentials, endpoints, catalogs, errors, and tool schemas.
+- Reusable across request/response and realtime model families.
+
+## Installation
+
+`uv add swarmauri_provider_openai` or `pip install swarmauri_provider_openai`.
+
+## Usage
+
+Construct `OpenAIProvider(api_key=...)` and inject it into an OpenAI model.
+

swarmauri_provider_openai-0.1.0.dev3/README.md

@@ -0,0 +1,18 @@
+![Swarmauri](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+[![PyPI](https://img.shields.io/pypi/v/swarmauri_provider_openai.svg)](https://pypi.org/project/swarmauri_provider_openai/) [![Python](https://img.shields.io/pypi/pyversions/swarmauri_provider_openai.svg)](https://pypi.org/project/swarmauri_provider_openai/) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE) [![Downloads](https://static.pepy.tech/badge/swarmauri_provider_openai)](https://pepy.tech/project/swarmauri_provider_openai) [![Hits](https://hits.sh/github.com/swarmauri/swarmauri-sdk.svg)](https://hits.sh/github.com/swarmauri/swarmauri-sdk/)
+
+# swarmauri_provider_openai
+
+## Features
+
+- Shared OpenAI credentials, endpoints, catalogs, errors, and tool schemas.
+- Reusable across request/response and realtime model families.
+
+## Installation
+
+`uv add swarmauri_provider_openai` or `pip install swarmauri_provider_openai`.
+
+## Usage
+
+Construct `OpenAIProvider(api_key=...)` and inject it into an OpenAI model.

swarmauri_provider_openai-0.1.0.dev3/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "swarmauri_provider_openai"
+version = "0.1.0.dev3"
+description = "Aggregated OpenAI 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", "openai", "realtime", "model catalog"]
+
+[tool.uv.sources]
+swarmauri_core = { workspace = true }
+swarmauri_base = { workspace = true }
+
+[project.entry-points."swarmauri.model_providers"]
+OpenAIProvider = "swarmauri_provider_openai:OpenAIProvider"
+
+[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_openai-0.1.0.dev3/swarmauri_provider_openai/OpenAIAuthConfig.py

@@ -0,0 +1,27 @@
+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, "OpenAIAuthConfig")
+class OpenAIAuthConfig(ProviderAuthBase):
+    api_key: SecretStr | None = Field(default=None, exclude=True)
+    organization: str | None = None
+    project: str | None = None
+    type: Literal["OpenAIAuthConfig"] = "OpenAIAuthConfig"
+
+    def apply(self, headers: Mapping[str, str]) -> dict[str, str]:
+        authorized = dict(headers)
+        if self.api_key is None:
+            raise ValueError("OpenAIProvider requires an api_key")
+        authorized["Authorization"] = (
+            f"Bearer {self.api_key.get_secret_value()}"
+        )
+        if self.organization is not None:
+            authorized["OpenAI-Organization"] = self.organization
+        if self.project is not None:
+            authorized["OpenAI-Project"] = self.project
+        return authorized

swarmauri_provider_openai-0.1.0.dev3/swarmauri_provider_openai/OpenAIEndpoints.py

@@ -0,0 +1,27 @@
+from typing import Literal
+
+from swarmauri_base.model_providers.ProviderEndpointBase import (
+    ProviderEndpointBase,
+)
+from swarmauri_base.ComponentBase import ComponentBase
+
+
+@ComponentBase.register_type(ProviderEndpointBase, "OpenAIEndpoints")
+class OpenAIEndpoints(ProviderEndpointBase):
+    base_url: str = "https://api.openai.com/v1"
+    realtime_url: str = "wss://api.openai.com/v1/realtime"
+    responses_websocket_url: str = "wss://api.openai.com/v1/responses"
+    type: Literal["OpenAIEndpoints"] = "OpenAIEndpoints"
+
+    def resolve(self, capability: str) -> str:
+        endpoints = {
+            "api": self.base_url,
+            "realtime.connect": self.realtime_url,
+            "responses.connect": self.responses_websocket_url,
+        }
+        try:
+            return endpoints[capability]
+        except KeyError as error:
+            raise ValueError(
+                f"OpenAI does not support capability {capability!r}"
+            ) from error

swarmauri_provider_openai-0.1.0.dev3/swarmauri_provider_openai/OpenAIErrorMapper.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, "OpenAIErrorMapper")
+class OpenAIErrorMapper(ProviderErrorMapperBase):
+    type: Literal["OpenAIErrorMapper"] = "OpenAIErrorMapper"
+
+    def map_error(self, error: BaseException | Any) -> BaseException:
+        return RuntimeError(f"OpenAI provider error: {error}")

swarmauri_provider_openai-0.1.0.dev3/swarmauri_provider_openai/OpenAIModelCatalog.py

@@ -0,0 +1,17 @@
+from typing import Literal
+
+from swarmauri_base.model_providers.ModelCatalogBase import ModelCatalogBase
+from swarmauri_base.ComponentBase import ComponentBase
+
+
+@ComponentBase.register_type(ModelCatalogBase, "OpenAIModelCatalog")
+class OpenAIModelCatalog(ModelCatalogBase):
+    models: dict = {
+        "gpt-realtime": {
+            "name": "gpt-realtime",
+            "input_modalities": ["text", "audio", "image"],
+            "output_modalities": ["text", "audio"],
+            "features": ["realtime", "tools", "interruption"],
+        }
+    }
+    type: Literal["OpenAIModelCatalog"] = "OpenAIModelCatalog"

swarmauri_provider_openai-0.1.0.dev3/swarmauri_provider_openai/OpenAIProvider.py

@@ -0,0 +1,72 @@
+from typing import Any, 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 .OpenAIAuthConfig import OpenAIAuthConfig
+from .OpenAIEndpoints import OpenAIEndpoints
+from .OpenAIErrorMapper import OpenAIErrorMapper
+from .OpenAIModelCatalog import OpenAIModelCatalog
+
+
+@ComponentBase.register_type(ModelProviderBase, "OpenAIProvider")
+class OpenAIProvider(ModelProviderBase):
+    provider_name: Literal["openai"] = "openai"
+    endpoints: OpenAIEndpoints = Field(default_factory=OpenAIEndpoints)
+    auth: OpenAIAuthConfig = Field(
+        default_factory=OpenAIAuthConfig, exclude=True
+    )
+    catalog: OpenAIModelCatalog = Field(default_factory=OpenAIModelCatalog)
+    error_mapper: OpenAIErrorMapper = Field(default_factory=OpenAIErrorMapper)
+    type: Literal["OpenAIProvider"] = "OpenAIProvider"
+
+    @model_validator(mode="after")
+    def configure(self) -> "OpenAIProvider":
+        self.base_url = self.base_url or self.endpoints.resolve("api")
+        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
+        if self.organization is not None:
+            self.auth.organization = self.organization
+        elif self.auth.organization is not None:
+            self.organization = self.auth.organization
+        if self.project is not None:
+            self.auth.project = self.project
+        elif self.auth.project is not None:
+            self.project = self.auth.project
+        if self.organization:
+            self.default_headers.setdefault(
+                "OpenAI-Organization", self.organization
+            )
+        if self.project:
+            self.default_headers.setdefault("OpenAI-Project", self.project)
+        return self
+
+    def connection_config(
+        self,
+        capability: str,
+        model: str | None = None,
+    ) -> ProviderConnectionConfig:
+        endpoint = self.endpoints.resolve(capability)
+        headers = dict(self.default_headers)
+        query: dict[str, str] = {}
+        transport_options: dict[str, Any] = {}
+        if capability == "realtime.connect":
+            headers["OpenAI-Beta"] = "realtime=v1"
+            if model is not None:
+                query["model"] = model
+        elif capability == "api":
+            transport_options = super().connection_options()
+        return ProviderConnectionConfig(
+            endpoint=endpoint,
+            headers=headers,
+            query=query,
+            transport_options=transport_options,
+            auth_context=self.auth,
+        )

swarmauri_provider_openai-0.1.0.dev3/swarmauri_provider_openai/OpenAIToolSchemaConverter.py

@@ -0,0 +1,19 @@
+from typing import Any
+
+
+class OpenAIToolSchemaConverter:
+    def convert(self, tool: Any) -> dict[str, Any]:
+        parameters = getattr(tool, "parameters", [])
+        properties = {
+            parameter.name: {
+                "type": getattr(parameter, "type", "string"),
+                "description": getattr(parameter, "description", None),
+            }
+            for parameter in parameters
+        }
+        return {
+            "type": "function",
+            "name": tool.name,
+            "description": getattr(tool, "description", None),
+            "parameters": {"type": "object", "properties": properties},
+        }

swarmauri_provider_openai-0.1.0.dev3/swarmauri_provider_openai/__init__.py

@@ -0,0 +1,15 @@
+from .OpenAIAuthConfig import OpenAIAuthConfig
+from .OpenAIEndpoints import OpenAIEndpoints
+from .OpenAIErrorMapper import OpenAIErrorMapper
+from .OpenAIModelCatalog import OpenAIModelCatalog
+from .OpenAIProvider import OpenAIProvider
+from .OpenAIToolSchemaConverter import OpenAIToolSchemaConverter
+
+__all__ = [
+    "OpenAIAuthConfig",
+    "OpenAIEndpoints",
+    "OpenAIErrorMapper",
+    "OpenAIModelCatalog",
+    "OpenAIProvider",
+    "OpenAIToolSchemaConverter",
+]