donkey-llms-watsonx 0.1.0__tar.gz

donkey_llms_watsonx-0.1.0/.gitignore

@@ -0,0 +1,85 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+#IDE
+.DS_Store
+.idea
+.vscode
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Mkdocs documentation
+docs/_build/
+docs/api_reference/site/
+
+# Ruff
+.ruff_cache/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/

donkey_llms_watsonx-0.1.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: donkey-llms-watsonx
+Version: 0.1.0
+Summary: donkey llms watsonx integration
+Author-email: Leonardo Furnielis <leonardofurnielis@outlook.com>
+License: Apache-2.0
+Requires-Python: <3.14,>=3.11
+Requires-Dist: donkey-core<0.2.0,>=0.1.0
+Requires-Dist: ibm-watsonx-ai<1.6.0,>=1.5.5
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio<2.0.0,>=1.4.0; extra == 'dev'
+Requires-Dist: pytest<10.0.0,>=9.1.1; extra == 'dev'
+Requires-Dist: ruff<0.16.0,>=0.15.20; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Donkey llms integration - watsonx
+
+## Installation 
+
+```bash
+pip install donkey-llms-watsonx
+```

donkey_llms_watsonx-0.1.0/README.md

@@ -0,0 +1,7 @@
+# Donkey llms integration - watsonx
+
+## Installation 
+
+```bash
+pip install donkey-llms-watsonx
+```

donkey_llms_watsonx-0.1.0/donkey/llms/watsonx/__init__.py

@@ -0,0 +1,3 @@
+from donkey.llms.watsonx.base import WatsonxLLM
+
+__all__ = ["WatsonxLLM"]

donkey_llms_watsonx-0.1.0/donkey/llms/watsonx/base.py

@@ -0,0 +1,121 @@
+from typing import Any
+
+from donkey.core.bridge.pydantic import Field, SecretStr, field_validator
+from donkey.core.llms import BaseLLM, ChatMessage, ChatResponse, CompletionResponse
+from donkey.core.toolkit import validate_enum
+from donkey.llms.watsonx.supporting_classes.enums import Region
+
+
+class WatsonxLLM(BaseLLM):
+    """
+    A wrapper class for interacting with a IBM watsonx.ai large language models (LLMs).
+    For more information, see [here](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models.html?context=wx&audience=wdp).
+
+
+    Attributes:
+        model (str): The identifier of the LLM model to use (e.g., "openai/gpt-oss-120b", "meta-llama/llama-3-3-70b-instruct").
+        api_key (str): API key used for authenticating with the LLM provider.
+        region (str, optional): The region where watsonx.ai is hosted when using IBM Cloud.
+            Defaults to `us-south`.
+        project_id (str, optional): The project ID in watsonx.ai.
+        space_id (str, optional): The space ID in watsonx.ai.
+        additional_kwargs (dict[str, Any], optional): A dictionary of additional parameters passed
+            to the LLM during completion. This allows customization of the request beyond
+            the standard parameters.
+        callback_manager: (PromptMonitor, optional): The callback manager is used for observability.
+
+    Example:
+        ```python
+        from donkey.llms.watsonx import WatsonxLLM
+
+        llm = WatsonxLLM(model="openai/gpt-oss-120b", api_key="your_api_key_here")
+        ```
+    """
+
+    model_config = {
+        "validate_assignment": False,
+    }
+
+    model: str
+    api_key: SecretStr
+    region: str = Region.US_SOUTH
+    project_id: str | None = Field(default=None)
+    space_id: str | None = Field(default=None)
+    params: dict[str, Any] = Field(default_factory=dict)
+    additional_kwargs: dict[str, Any] = Field(default_factory=dict)
+
+    @field_validator("region")
+    def _validate_region(cls, v):
+        validate_enum(el=v, el_name="region", expected_enum=Region)
+        return v
+
+    def model_post_init(self, __context):  # noqa: PYI063
+        from ibm_watsonx_ai import Credentials
+        from ibm_watsonx_ai.foundation_models import ModelInference
+
+        self.region = Region.from_value(self.region)
+
+        if (not (self.project_id or self.space_id)) or (
+            self.project_id and self.space_id
+        ):
+            raise ValueError(
+                "Invalid configuration: 'project_id' or 'space_id' must be provided. Not both."
+            )
+
+        self._model_inference = ModelInference(
+            **self.additional_kwargs,
+            model_id=self.model,
+            credentials=Credentials(
+                api_key=self.api_key.get_secret_value(),
+                url=self.region.watsonx,
+            ),
+            project_id=self.project_id,
+            space_id=self.space_id,
+        )
+
+    def _completion(
+        self,
+        prompt: str,
+        guardrails: bool = False,
+        params: dict[str, Any] = {},
+        **kwargs: Any,
+    ) -> CompletionResponse:
+        """Creates a completion for the provided prompt and parameters. Using OpenAI's standard endpoint (/completions)."""
+        response = self._model_inference.generate(
+            **kwargs,
+            prompt=prompt,
+            guardrails=guardrails,
+            params={**self.params, **params},
+        )
+
+        return CompletionResponse(
+            text=response["results"][0].get("generated_text"),
+            input_token_count=response["results"][0].get("input_token_count"),
+            generated_token_count=response["results"][0].get("generated_token_count"),
+            raw=response,
+        )
+
+    def _chat_completion(
+        self,
+        messages: list[ChatMessage | dict],
+        params: dict[str, Any] = {},
+        **kwargs: Any,
+    ) -> ChatResponse:
+        """Creates a chat completion for LLM. Using OpenAI's standard endpoint (/chat/completions)."""
+        input_messages_dict = [
+            ChatMessage.model_validate(message).to_dict() for message in messages
+        ]
+
+        response = self._model_inference.chat(
+            **kwargs,
+            messages=input_messages_dict,
+            params={**self.params, **params},
+        )
+        message_dict = response["choices"][0]["message"]
+
+        return ChatResponse(
+            message=ChatMessage(
+                role=message_dict.get("role"), content=message_dict.get("content", None)
+            ),
+            raw=response,
+        )

donkey_llms_watsonx-0.1.0/donkey/llms/watsonx/supporting_classes/enums.py

@@ -0,0 +1,64 @@
+from typing import Any
+
+REGION_CONFIG: dict = {
+    "au-syd": {
+        "watsonx": "https://au-syd.ml.cloud.ibm.com",
+    },
+    "aws-ap-south": {
+        "watsonx": "https://ap-south-1.aws.wxai.ibm.com",
+    },
+    "eu-de": {
+        "watsonx": "https://eu-de.ml.cloud.ibm.com",
+    },
+    "us-south": {
+        "watsonx": "https://us-south.ml.cloud.ibm.com",
+    },
+}
+
+
+class RegionValue(str):
+    @property
+    def watsonx(self) -> str:
+        return REGION_CONFIG[self]["watsonx"]
+
+
+class Region:
+    """
+    Supported IBM watsonx.governance regions.
+
+    Defines the available regions where watsonx.governance SaaS
+    services are deployed.
+
+    Attributes:
+        AU_SYD (str): "au-syd".
+        AWS_AP_SOUTH (str): "aws-ap-south".
+        EU_DE (str): "eu-de".
+        US_SOUTH (str): "us-south".
+    """
+
+    AU_SYD = RegionValue("au-syd")
+    AWS_AP_SOUTH = RegionValue("aws-ap-south")
+    EU_DE = RegionValue("eu-de")
+    US_SOUTH = RegionValue("us-south")
+
+    @classmethod
+    def from_value(cls, value: Any) -> "RegionValue":
+        if value is None:
+            return cls.US_SOUTH
+
+        if isinstance(value, RegionValue):
+            return value
+
+        if isinstance(value, str):
+            value = value.lower()
+
+            for region in (getattr(cls, name) for name in vars(cls) if name.isupper()):
+                if region == value:
+                    return region
+
+            raise ValueError("Invalid value for Region: '{}'.".format(value))
+
+        raise TypeError(
+            f"Invalid type for Region. "
+            f"Expected str or Region, but received {type(value).__name__}."
+        )

donkey_llms_watsonx-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "donkey-llms-watsonx"
+version = "0.1.0"
+description = "donkey llms watsonx integration"
+authors = [{ name = "Leonardo Furnielis", email = "leonardofurnielis@outlook.com" }]
+license = { text = "Apache-2.0" }
+readme = "README.md"
+requires-python = ">=3.11,<3.14"
+dependencies = [
+    "ibm-watsonx-ai>=1.5.5,<1.6.0",
+    "donkey-core>=0.1.0,<0.2.0",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["donkey/"]
+
+[tool.hatch.build.targets.wheel]
+include = ["donkey/"]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=9.1.1,<10.0.0",
+    "pytest-asyncio>=1.4.0,<2.0.0",
+    "ruff>=0.15.20,<0.16.0",
+]