osmosis-ai 0.1.8__tar.gz → 0.2.0__tar.gz

{osmosis_ai-0.1.8 → osmosis_ai-0.2.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Gulp AI
+Copyright (c) 2025 Gulp AI
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

osmosis_ai-0.2.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: osmosis-ai
+Version: 0.2.0
+Summary: Adds reward functionality to LLM client libraries
+Author-email: Osmosis AI <jake@osmosis.ai>
+License: MIT License
+        
+        Copyright (c) 2025 Gulp AI
+        
+        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: Homepage, https://github.com/Osmosis-AI/osmosis-sdk-python
+Project-URL: Issues, https://github.com/Osmosis-AI/osmosis-sdk-python/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# osmosis-ai
+
+A Python library that provides reward functionality for LLM applications with strict type enforcement.
+
+## Installation
+
+```bash
+pip install osmosis-ai
+```
+
+For development:
+```bash
+git clone https://github.com/Osmosis-AI/osmosis-sdk-python
+cd osmosis-sdk-python
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from osmosis_ai import osmosis_reward
+
+@osmosis_reward
+def simple_reward(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+    """Basic exact match reward function."""
+    return 1.0 if solution_str.strip() == ground_truth.strip() else 0.0
+
+# Use the reward function
+score = simple_reward("hello world", "hello world")  # Returns 1.0
+```
+
+## Required Function Signature
+
+All functions decorated with `@osmosis_reward` must have exactly this signature:
+
+```python
+@osmosis_reward
+def your_function(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+    # Your reward logic here
+    return float_score
+```
+
+### Parameters
+
+- **`solution_str: str`** - The solution string to evaluate (required)
+- **`ground_truth: str`** - The correct/expected answer (required)
+- **`extra_info: dict = None`** - Optional dictionary for additional configuration
+
+### Return Value
+
+- **`-> float`** - Must return a float value representing the reward score
+
+The decorator will raise a `TypeError` if the function doesn't match this exact signature or doesn't return a float.
+
+## Examples
+
+See the [`examples/`](examples/) directory for complete examples:
+
+```python
+@osmosis_reward
+def case_insensitive_match(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+    """Case-insensitive string matching with partial credit."""
+    match = solution_str.lower().strip() == ground_truth.lower().strip()
+
+    if extra_info and 'partial_credit' in extra_info:
+        if not match and extra_info['partial_credit']:
+            len_diff = abs(len(solution_str) - len(ground_truth))
+            if len_diff <= 2:
+                return 0.5
+
+    return 1.0 if match else 0.0
+
+@osmosis_reward
+def numeric_tolerance(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+    """Numeric comparison with configurable tolerance."""
+    try:
+        solution_num = float(solution_str.strip())
+        truth_num = float(ground_truth.strip())
+
+        tolerance = extra_info.get('tolerance', 0.01) if extra_info else 0.01
+        return 1.0 if abs(solution_num - truth_num) <= tolerance else 0.0
+    except ValueError:
+        return 0.0
+```
+
+## Running Examples
+
+```bash
+python examples/reward_functions.py
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and examples
+5. Submit a pull request
+
+## Links
+
+- [Homepage](https://github.com/Osmosis-AI/osmosis-sdk-python)
+- [Issues](https://github.com/Osmosis-AI/osmosis-sdk-python/issues)

osmosis_ai-0.2.0/README.md

@@ -0,0 +1,107 @@
+# osmosis-ai
+
+A Python library that provides reward functionality for LLM applications with strict type enforcement.
+
+## Installation
+
+```bash
+pip install osmosis-ai
+```
+
+For development:
+```bash
+git clone https://github.com/Osmosis-AI/osmosis-sdk-python
+cd osmosis-sdk-python
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from osmosis_ai import osmosis_reward
+
+@osmosis_reward
+def simple_reward(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+    """Basic exact match reward function."""
+    return 1.0 if solution_str.strip() == ground_truth.strip() else 0.0
+
+# Use the reward function
+score = simple_reward("hello world", "hello world")  # Returns 1.0
+```
+
+## Required Function Signature
+
+All functions decorated with `@osmosis_reward` must have exactly this signature:
+
+```python
+@osmosis_reward
+def your_function(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+    # Your reward logic here
+    return float_score
+```
+
+### Parameters
+
+- **`solution_str: str`** - The solution string to evaluate (required)
+- **`ground_truth: str`** - The correct/expected answer (required)
+- **`extra_info: dict = None`** - Optional dictionary for additional configuration
+
+### Return Value
+
+- **`-> float`** - Must return a float value representing the reward score
+
+The decorator will raise a `TypeError` if the function doesn't match this exact signature or doesn't return a float.
+
+## Examples
+
+See the [`examples/`](examples/) directory for complete examples:
+
+```python
+@osmosis_reward
+def case_insensitive_match(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+    """Case-insensitive string matching with partial credit."""
+    match = solution_str.lower().strip() == ground_truth.lower().strip()
+
+    if extra_info and 'partial_credit' in extra_info:
+        if not match and extra_info['partial_credit']:
+            len_diff = abs(len(solution_str) - len(ground_truth))
+            if len_diff <= 2:
+                return 0.5
+
+    return 1.0 if match else 0.0
+
+@osmosis_reward
+def numeric_tolerance(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+    """Numeric comparison with configurable tolerance."""
+    try:
+        solution_num = float(solution_str.strip())
+        truth_num = float(ground_truth.strip())
+
+        tolerance = extra_info.get('tolerance', 0.01) if extra_info else 0.01
+        return 1.0 if abs(solution_num - truth_num) <= tolerance else 0.0
+    except ValueError:
+        return 0.0
+```
+
+## Running Examples
+
+```bash
+python examples/reward_functions.py
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and examples
+5. Submit a pull request
+
+## Links
+
+- [Homepage](https://github.com/Osmosis-AI/osmosis-sdk-python)
+- [Issues](https://github.com/Osmosis-AI/osmosis-sdk-python/issues)

osmosis_ai-0.2.0/osmosis_ai/__init__.py

@@ -0,0 +1,15 @@
+"""
+osmosis-ai: A Python library for reward function validation with strict type enforcement.
+
+This library provides the @osmosis_reward decorator that enforces standardized
+function signatures for reward functions used in LLM applications.
+
+Features:
+- Type-safe reward function decoration
+- Parameter name and type validation
+- Support for optional configuration parameters
+"""
+
+from .utils import osmosis_reward
+
+__all__ = ["osmosis_reward"]

osmosis_ai-0.2.0/osmosis_ai/consts.py

@@ -0,0 +1,3 @@
+# package metadata
+package_name = "osmosis-ai"
+package_version = "0.2.0"

osmosis_ai-0.2.0/osmosis_ai/utils.py

@@ -0,0 +1,62 @@
+
+import functools
+import inspect
+from typing import Callable
+
+
+def osmosis_reward(func: Callable) -> Callable:
+    """
+    Decorator for reward functions that enforces the signature:
+    (solution_str: str, ground_truth: str, extra_info: dict = None) -> float
+
+    Args:
+        func: The reward function to be wrapped
+
+    Returns:
+        The wrapped function
+
+    Raises:
+        TypeError: If the function doesn't have the required signature or doesn't return a float
+
+    Example:
+        @osmosis_reward
+        def calculate_reward(solution_str: str, ground_truth: str, extra_info: dict = None) -> float:
+            return some_calculation(solution_str, ground_truth)
+    """
+    # Validate function signature
+    sig = inspect.signature(func)
+    params = list(sig.parameters.values())
+
+    # Check parameter count
+    if len(params) < 2 or len(params) > 3:
+        raise TypeError(f"Function {func.__name__} must have 2-3 parameters, got {len(params)}")
+
+    # Check first parameter: solution_str: str
+    if params[0].name != 'solution_str':
+        raise TypeError(f"First parameter must be named 'solution_str', got '{params[0].name}'")
+    if params[0].annotation != str:
+        raise TypeError(f"First parameter 'solution_str' must be annotated as str, got {params[0].annotation}")
+
+    # Check second parameter: ground_truth: str
+    if params[1].name != 'ground_truth':
+        raise TypeError(f"Second parameter must be named 'ground_truth', got '{params[1].name}'")
+    if params[1].annotation != str:
+        raise TypeError(f"Second parameter 'ground_truth' must be annotated as str, got {params[1].annotation}")
+
+    # Check third parameter if present: extra_info: dict = None
+    if len(params) == 3:
+        if params[2].name != 'extra_info':
+            raise TypeError(f"Third parameter must be named 'extra_info', got '{params[2].name}'")
+        if params[2].annotation != dict:
+            raise TypeError(f"Third parameter 'extra_info' must be annotated as dict, got {params[2].annotation}")
+        if params[2].default is inspect.Parameter.empty:
+            raise TypeError("Third parameter 'extra_info' must have a default value of None")
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        result = func(*args, **kwargs)
+        if not isinstance(result, float):
+            raise TypeError(f"Function {func.__name__} must return a float, got {type(result).__name__}")
+        return result
+
+    return wrapper

osmosis_ai-0.2.0/osmosis_ai.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+pytest.ini
+requirements.txt
+setup_env.bat
+osmosis_ai/__init__.py
+osmosis_ai/consts.py
+osmosis_ai/utils.py

osmosis_ai-0.2.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "osmosis-ai"
+version = "0.2.0"
+description = "Adds reward functionality to LLM client libraries"
+readme = "README.md"
+authors = [
+    {name = "Osmosis AI", email = "jake@osmosis.ai"}
+]
+license = {file = "LICENSE"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.6"
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/Osmosis-AI/osmosis-sdk-python"
+Issues = "https://github.com/Osmosis-AI/osmosis-sdk-python/issues"

osmosis_ai-0.1.8/.env.sample

@@ -1,24 +0,0 @@
-# API Keys for LLM Providers
-# Remove the .sample extension and fill in your actual API keys
-
-# Anthropic API Key
-ANTHROPIC_API_KEY=your_anthropic_api_key_here
-
-# OpenAI API Key
-OPENAI_API_KEY=your_openai_api_key_here
-
-# OSMOSIS API Key (required for logging LLM usage)
-OSMOSIS_API_KEY=your_osmosis_api_key_here
-
-# Optional Configuration
-# Uncomment to enable logging to stderr instead of stdout
-# OSMOSIS_USE_STDERR=true
-
-# Uncomment to disable pretty printing of JSON
-# OSMOSIS_PRETTY_PRINT=false
-
-# Uncomment to change JSON indentation level
-# OSMOSIS_INDENT=4
-
-# Uncomment to disable response printing (requests will still be printed)
-# OSMOSIS_PRINT_RESPONSES=false 

osmosis_ai-0.1.8/PKG-INFO

@@ -1,281 +0,0 @@
-Metadata-Version: 2.4
-Name: osmosis-ai
-Version: 0.1.8
-Summary: Monkey patches LLM client libraries to print all prompts and responses
-Author-email: Gulp AI <jake@gulp.ai>
-License: MIT License
-        
-        Copyright (c) 2024 Gulp AI
-        
-        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: Homepage, https://github.com/Gulp-AI/osmosis-sdk-python
-Project-URL: Issues, https://github.com/Gulp-AI/osmosis-sdk-python/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: python-dotenv>=0.19.0
-Requires-Dist: requests>=2.25.0
-Requires-Dist: xxhash>=3.4.1
-Provides-Extra: anthropic
-Requires-Dist: anthropic>=0.5.0; extra == "anthropic"
-Provides-Extra: openai
-Requires-Dist: openai>=0.27.0; extra == "openai"
-Provides-Extra: langchain
-Requires-Dist: langchain>=0.0.200; extra == "langchain"
-Provides-Extra: langchain-openai
-Requires-Dist: langchain>=0.0.200; extra == "langchain-openai"
-Requires-Dist: langchain-openai>=0.0.200; extra == "langchain-openai"
-Requires-Dist: openai>=0.27.0; extra == "langchain-openai"
-Provides-Extra: langchain-anthropic
-Requires-Dist: langchain>=0.0.200; extra == "langchain-anthropic"
-Requires-Dist: langchain-anthropic>=0.0.200; extra == "langchain-anthropic"
-Requires-Dist: anthropic>=0.5.0; extra == "langchain-anthropic"
-Provides-Extra: all
-Requires-Dist: anthropic>=0.5.0; extra == "all"
-Requires-Dist: openai>=0.27.0; extra == "all"
-Requires-Dist: langchain>=0.0.200; extra == "all"
-Requires-Dist: langchain-openai>=0.0.200; extra == "all"
-Requires-Dist: langchain-anthropic>=0.0.200; extra == "all"
-Dynamic: license-file
-
-[![Run Tests](https://github.com/Gulp-AI/osmosis-sdk-python/actions/workflows/test.yml/badge.svg)](https://github.com/Gulp-AI/osmosis-sdk-python/actions/workflows/test.yml)
-
-# Osmosis
-
-A Python library that monkey patches LLM client libraries to send all prompts and responses to the Osmosis API for logging and monitoring.
-
-## Supported Libraries
-
-- **Anthropic**: Logs all Claude API requests and responses (both sync and async clients)
-- **OpenAI**: Logs all OpenAI API requests and responses (supports v1 and v2 API versions, both sync and async clients)
-- **LangChain**: Currently supports prompt template logging (LLM and ChatModel support varies by LangChain version)
-
-## Installation
-
-[pypi](https://pypi.org/project/osmosis-ai/)
-
-```bash
-# Basic installation with minimal dependencies
-pip install osmosis-ai
-
-# Install with specific provider support
-pip install "osmosis-ai[openai]"     # Only OpenAI support
-pip install "osmosis-ai[anthropic]"  # Only Anthropic support
-
-# Install with LangChain support
-pip install "osmosis-ai[langchain]"         # Base LangChain support
-pip install "osmosis-ai[langchain-openai]"  # LangChain + OpenAI support
-pip install "osmosis-ai[langchain-anthropic]" # LangChain + Anthropic support
-
-# Install with all dependencies
-pip install "osmosis-ai[all]"
-```
-
-Or install from source:
-
-```bash
-git clone https://github.com/your-username/osmosis-sdk-python.git
-cd osmosis-ai
-pip install -e .
-```
-
-For development, you can install all dependencies using:
-
-```bash
-pip install -r requirements.txt
-```
-
-## Environment Setup
-
-osmosisrequires a OSMOSIS API key to log LLM usage. Create a `.env` file in your project directory:
-
-```bash
-# Copy the sample .env file
-cp .env.sample .env
-
-# Edit the .env file with your API keys
-```
-
-Edit the `.env` file to add your API keys:
-
-```
-# Required for logging
-OSMOSIS_API_KEY=your_osmosis_api_key_here
-
-# Optional: Only needed if you're using these services
-ANTHROPIC_API_KEY=your_anthropic_key_here
-OPENAI_API_KEY=your_openai_key_here
-```
-
-## Usage
-
-First, import and initialize osmosiswith your OSMOSIS API key:
-
-```python
-import os
-import osmosis_ai
-
-# Initialize with your OSMOSIS API key
-osmosis_ai.init("your-osmosis-api-key")
-
-# Or load from environment variable
-osmosis_api_key = os.environ.get("OSMOSIS_API_KEY")
-osmosis_ai.init(osmosis_api_key)
-```
-
-Once you import `osmosis_ai` and initialize it, the library automatically patches the supported LLM clients. You can then use your LLM clients normally, and all API calls will be logged to OSMOSIS:
-
-### Anthropic Example
-
-```python
-# Import osmosis_ai first and initialize it
-import osmosis_ai
-osmosis_ai.init(os.environ.get("OSMOSIS_API_KEY"))
-
-# Then import and use Anthropic as normal
-from anthropic import Anthropic
-
-# Create and use the Anthropic client as usual - it's already patched
-client = Anthropic(api_key=os.environ.get("ANTHROPIC_API_KEY"))
-
-# All API calls will now be logged to OSMOSIS automatically
-response = client.messages.create(
-    model="claude-3-haiku-20240307",
-    max_tokens=1000,
-    messages=[
-        {"role": "user", "content": "Hello, Claude!"}
-    ]
-)
-
-# Async client is also supported and automatically patched
-from anthropic import AsyncAnthropic
-import asyncio
-
-async def call_claude_async():
-    async_client = AsyncAnthropic(api_key=os.environ.get("ANTHROPIC_API_KEY"))
-    response = await async_client.messages.create(
-        model="claude-3-haiku-20240307",
-        max_tokens=1000,
-        messages=[
-            {"role": "user", "content": "Hello, async Claude!"}
-        ]
-    )
-    return response
-
-# All async API calls will be logged to OSMOSIS as well
-asyncio.run(call_claude_async())
-```
-
-### OpenAI Example
-
-```python
-# Import osmosis_ai first and initialize it
-import osmosis_ai
-osmosis_ai.init(os.environ.get("OSMOSIS_API_KEY"))
-
-# Then import and use OpenAI as normal
-from openai import OpenAI
-
-# Create and use the OpenAI client as usual - it's already patched
-client = OpenAI(api_key=os.environ.get("OPENAI_API_KEY"))
-
-# All API calls will now be logged to OSMOSIS automatically
-response = client.chat.completions.create(
-    model="gpt-4o-mini",
-    max_tokens=150,
-    messages=[
-        {"role": "user", "content": "Hello, GPT!"}
-    ]
-)
-
-# Async client is also supported and automatically patched
-from openai import AsyncOpenAI
-import asyncio
-
-async def call_openai_async():
-    async_client = AsyncOpenAI(api_key=os.environ.get("OPENAI_API_KEY"))
-    response = await async_client.chat.completions.create(
-        model="gpt-4o-mini",
-        max_tokens=150,
-        messages=[
-            {"role": "user", "content": "Hello, async GPT!"}
-        ]
-    )
-    return response
-
-# All async API calls will be logged to OSMOSIS as well
-asyncio.run(call_openai_async())
-```
-
-### LangChain Example
-
-```python
-# Import osmosis_ai first and initialize it
-import osmosis_ai
-osmosis_ai.init(os.environ.get("OSMOSIS_API_KEY"))
-
-# Then use LangChain as normal
-from langchain_core.prompts import PromptTemplate
-
-# Use LangChain prompt templates as usual
-template = PromptTemplate(
-    input_variables=["topic"],
-    template="Write a short paragraph about {topic}."
-)
-
-# Formatting the prompt will be logged to OSMOSIS automatically
-formatted_prompt = template.format(topic="artificial intelligence")
-print(f"Formatted prompt: {formatted_prompt}")
-
-# Multiple prompt templates are also captured
-template2 = PromptTemplate(
-    input_variables=["name", "profession"],
-    template="My name is {name} and I work as a {profession}."
-)
-formatted_prompt2 = template2.format(name="Alice", profession="data scientist")
-print(f"Formatted prompt 2: {formatted_prompt2}")
-```
-
-## Configuration
-
-You can configure the behavior of the library by modifying the following variables:
-
-```python
-import osmosis_ai
-
-# Disable logging to OSMOSIS (default: True)
-osmosis_ai.enabled = False
-```
-
-## How it Works
-
-This library uses monkey patching to override the LLM clients' methods that make API calls. When you import the `osmosis_ai` module, it automatically patches the supported LLM client libraries. When methods are called on these clients, the library intercepts the calls and sends the request parameters and response data to the OSMOSIS API for logging and monitoring.
-
-The data sent to OSMOSIS includes:
-- Timestamp (UTC)
-- Request parameters
-- Response data
-- HTTP status code
-
-## License
-
-MIT