openai-model-registry - OpenAI Model Registry 1.0.5

A focused minor release enhancing the parameter validation system and improving code quality while maintaining full backward compatibility.

✨ Key Improvements

🔧 Enhanced Parameter Validation System

New Schema Support: Added support for type: "numeric" with min_value/max_value constraints
Type Restrictions: Enhanced validation with allow_float and allow_int options
Standardized Schema: Unified parameter definitions across all 41+ models
Better Error Messages: Improved parameter validation error reporting

📊 Model Parameter Schema Standardization

Consistent Format: Updated parameter definitions to use standardized type: "numeric" schema
Enhanced Constraints: Migrated from min/max to min_value/max_value for clarity

🧪 Enhanced Test Coverage

Comprehensive CLI Testing: Added full test coverage for existing CLI commands
218 Tests Passing: Enhanced test reliability and CI stability
Environment Handling: Improved test environment variable management

🔧 Technical Details

Parameter Validation Enhancements

```python

Enhanced numeric parameter validation

registry.validateparameters('gpt-4', { 'temperature': 0.7, # Validates against minvalue/maxvalue 'maxtokens': 1000 # Enhanced bounds checking }) ```

Improved Test Coverage for Existing CLI

Cache Management: Tests for omr cache info, omr cache clear
Data Inspection: Tests for omr data dump, omr data paths, omr data env
Update Operations: Tests for omr update check, omr update show-config

🛠️ Code Quality Improvements

Streamlined Data Validation: Simplified validation pipeline
Enhanced Documentation: Updated CLI guides and workflow documentation
Test Reliability: Fixed environment variable handling in CI tests
Code Consistency: Standardized parameter schema across all models

🔄 Migration Guide

For Library Users

No action required! This release maintains full backward compatibility.

For Contributors

When working with parameter definitions: - Use type: "numeric" for numeric parameters - Use min_value/max_value for bounds - Add allow_float/allow_int for type restrictions

🎯 Focus Areas

This minor release concentrates on: - Parameter validation reliability - Schema consistency - Test coverage completeness - Code maintainability

Full Changelog: v1.0.4...v1.0.5

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - Data Release 1.0.3

OpenAI Model Registry Data Release 1.0.3

This release contains updated model registry configuration files.

📋 What's Changed

See the Data Changelog for detailed information about model updates, additions, and changes in this release.

📦 Installation

Install the Library

bash pip install openai-model-registry

Basic Usage

```python from openaimodelregistry import ModelRegistry

Default usage (no auto-update)

registry = ModelRegistry()

Enable auto-updates (optional)

from openaimodelregistry.registry import RegistryConfig registry = ModelRegistry(RegistryConfig(auto_update=True)) ```

Manual Update for Existing Users

If you already have the library installed, update your data manually: ```bash

Check for updates

omr update check

Apply updates

omr update apply ```

Manual Download

bash curl -L https://github.com/yaniv-golan/openai-model-registry/releases/download/data-v1.0.3/openai-model-registry-data-1.0.3.tar.gz -o data.tar.gz tar -xzf data.tar.gz

📋 Files Included

models.yaml - Model definitions and capabilities
overrides.yaml - Provider-specific overrides
checksums.txt - SHA256 checksums for verification
version.json - Version metadata

🔍 Verification

Verify file integrity using the provided checksums: bash cd data-package sha256sum -c checksums.txt

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - OpenAI Model Registry 1.0.4

OpenAI Model Registry Release 1.0.4

📦 Installation

bash pip install openai-model-registry==1.0.4

🔄 Upgrade

bash pip install --upgrade openai-model-registry

📋 What's New in 1.0.4

📚 Full Details: CHANGELOG.md | 🔍 Commits: v1.0.4

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - OpenAI Model Registry 1.0.3

OpenAI Model Registry Release 1.0.3

📦 Installation

Defaulting to user installation because normal site-packages is not writeable

🔄 Upgrade

Defaulting to user installation because normal site-packages is not writeable Collecting openai-model-registry Downloading openaimodelregistry-1.0.2-py3-none-any.whl.metadata (9.4 kB) Requirement already satisfied: PyYAML<7.0.0,>=6.0.1 in /usr/lib/python3/dist-packages (from openai-model-registry) (6.0.1) Collecting beautifulsoup4<5.0.0,>=4.12.2 (from openai-model-registry) Downloading beautifulsoup4-4.13.4-py3-none-any.whl.metadata (3.8 kB) Requirement already satisfied: click<8.2,>=8.1.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (8.1.6) Requirement already satisfied: packaging<25.0,>=24.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (24.0) Requirement already satisfied: platformdirs<5.0.0,>=4.3.6 in /usr/local/lib/python3.12/dist-packages (from openai-model-registry) (4.3.8) Requirement already satisfied: requests<3.0.0,>=2.31.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (2.31.0) Requirement already satisfied: rich>=13.7.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (13.7.1) Collecting rich-click>=1.7.0 (from openai-model-registry) Downloading richclick-1.8.9-py3-none-any.whl.metadata (7.9 kB) Collecting semver<4.0.0,>=3.0.0 (from openai-model-registry) Downloading semver-3.0.4-py3-none-any.whl.metadata (6.8 kB) Requirement already satisfied: typing-extensions<5.0.0,>=4.9.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (4.10.0) Collecting soupsieve>1.2 (from beautifulsoup4<5.0.0,>=4.12.2->openai-model-registry) Downloading soupsieve-2.7-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: markdown-it-py>=2.2.0 in /usr/lib/python3/dist-packages (from rich>=13.7.0->openai-model-registry) (3.0.0) Requirement already satisfied: pygments<3.0.0,>=2.13.0 in /usr/lib/python3/dist-packages (from rich>=13.7.0->openai-model-registry) (2.17.2) Requirement already satisfied: mdurl~=0.1 in /usr/lib/python3/dist-packages (from markdown-it-py>=2.2.0->rich>=13.7.0->openai-model-registry) (0.1.2) Downloading openaimodelregistry-1.0.2-py3-none-any.whl (86 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 86.8/86.8 kB 2.1 MB/s eta 0:00:00 Downloading beautifulsoup4-4.13.4-py3-none-any.whl (187 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 187.3/187.3 kB 5.1 MB/s eta 0:00:00 Downloading richclick-1.8.9-py3-none-any.whl (36 kB) Downloading semver-3.0.4-py3-none-any.whl (17 kB) Downloading soupsieve-2.7-py3-none-any.whl (36 kB) Installing collected packages: soupsieve, semver, beautifulsoup4, rich-click, openai-model-registry Successfully installed beautifulsoup4-4.13.4 openai-model-registry-1.0.2 rich-click-1.8.9 semver-3.0.4 soupsieve-2.7

📋 What's New

See CHANGELOG.md for detailed changes
Full commit history: v1.0.3

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - OpenAI Model Registry Data Release 1.0.2

This release contains updated model registry configuration files.

📋 What's Changed

See the Data Changelog for detailed information about model updates, additions, and changes in this release.

Key Updates: - GPT-5 Models: Fixed context window allocation, updated pricing to official rates, added missing parameters (reasoning_effort, verbosity) - GPT-4.5-preview: Added as deprecated model (sunset 2025-08-07) for historical completeness - Open-Weight Models: Added gpt-oss-120b and gpt-oss-20b with Apache 2.0 licensing

📦 Installation

Install the Library

bash pip install openai-model-registry

Basic Usage

```python from openaimodelregistry import ModelRegistry

Default usage (no auto-update)

registry = ModelRegistry()

Enable auto-updates (optional)

from openaimodelregistry.registry import RegistryConfig registry = ModelRegistry(RegistryConfig(auto_update=True)) ```

Manual Update for Existing Users

If you already have the library installed, update your data manually: ```bash

Check for updates

omr update check

Apply updates

omr update apply ```

Manual Download

bash curl -L https://github.com/yaniv-golan/openai-model-registry/releases/download/data-v1.0.2/openai-model-registry-data-1.0.2.tar.gz -o data.tar.gz tar -xzf data.tar.gz

📋 Files Included

models.yaml - Model definitions and capabilities
overrides.yaml - Provider-specific overrides
checksums.txt - SHA256 checksums for verification
version.json - Version metadata

🔍 Verification

Verify file integrity using the provided checksums: bash cd data-package sha256sum -c checksums.txt

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - OpenAI Model Registry 1.0.2

OpenAI Model Registry Release 1.0.2

📦 Installation

Defaulting to user installation because normal site-packages is not writeable

🔄 Upgrade

Defaulting to user installation because normal site-packages is not writeable Collecting openai-model-registry Downloading openaimodelregistry-1.0.1-py3-none-any.whl.metadata (9.4 kB) Requirement already satisfied: PyYAML<7.0.0,>=6.0.1 in /usr/lib/python3/dist-packages (from openai-model-registry) (6.0.1) Collecting beautifulsoup4<5.0.0,>=4.12.2 (from openai-model-registry) Downloading beautifulsoup4-4.13.4-py3-none-any.whl.metadata (3.8 kB) Requirement already satisfied: click<8.2,>=8.1.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (8.1.6) Requirement already satisfied: packaging<25.0,>=24.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (24.0) Requirement already satisfied: platformdirs<5.0.0,>=4.3.6 in /usr/local/lib/python3.12/dist-packages (from openai-model-registry) (4.3.8) Requirement already satisfied: requests<3.0.0,>=2.31.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (2.31.0) Requirement already satisfied: rich>=13.7.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (13.7.1) Collecting rich-click>=1.7.0 (from openai-model-registry) Downloading richclick-1.8.9-py3-none-any.whl.metadata (7.9 kB) Collecting semver<4.0.0,>=3.0.0 (from openai-model-registry) Downloading semver-3.0.4-py3-none-any.whl.metadata (6.8 kB) Requirement already satisfied: typing-extensions<5.0.0,>=4.9.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (4.10.0) Collecting soupsieve>1.2 (from beautifulsoup4<5.0.0,>=4.12.2->openai-model-registry) Downloading soupsieve-2.7-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: markdown-it-py>=2.2.0 in /usr/lib/python3/dist-packages (from rich>=13.7.0->openai-model-registry) (3.0.0) Requirement already satisfied: pygments<3.0.0,>=2.13.0 in /usr/lib/python3/dist-packages (from rich>=13.7.0->openai-model-registry) (2.17.2) Requirement already satisfied: mdurl~=0.1 in /usr/lib/python3/dist-packages (from markdown-it-py>=2.2.0->rich>=13.7.0->openai-model-registry) (0.1.2) Downloading openaimodelregistry-1.0.1-py3-none-any.whl (86 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 86.6/86.6 kB 4.5 MB/s eta 0:00:00 Downloading beautifulsoup4-4.13.4-py3-none-any.whl (187 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 187.3/187.3 kB 11.9 MB/s eta 0:00:00 Downloading richclick-1.8.9-py3-none-any.whl (36 kB) Downloading semver-3.0.4-py3-none-any.whl (17 kB) Downloading soupsieve-2.7-py3-none-any.whl (36 kB) Installing collected packages: soupsieve, semver, beautifulsoup4, rich-click, openai-model-registry Successfully installed beautifulsoup4-4.13.4 openai-model-registry-1.0.1 rich-click-1.8.9 semver-3.0.4 soupsieve-2.7

📋 What's New

See CHANGELOG.md for detailed changes
Full commit history: v1.0.2

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - OpenAI Model Registry 1.0.0

OpenAI Model Registry Release 1.0.0

📦 Installation

Defaulting to user installation because normal site-packages is not writeable Collecting openai-model-registry==1.0.0 Downloading openaimodelregistry-1.0.0-py3-none-any.whl.metadata (9.3 kB) Requirement already satisfied: PyYAML<7.0.0,>=6.0.1 in /usr/lib/python3/dist-packages (from openai-model-registry==1.0.0) (6.0.1) Collecting beautifulsoup4<5.0.0,>=4.12.2 (from openai-model-registry==1.0.0) Downloading beautifulsoup4-4.13.4-py3-none-any.whl.metadata (3.8 kB) Requirement already satisfied: click<8.2,>=8.1.0 in /usr/lib/python3/dist-packages (from openai-model-registry==1.0.0) (8.1.6) Requirement already satisfied: packaging<25.0,>=24.0 in /usr/lib/python3/dist-packages (from openai-model-registry==1.0.0) (24.0) Requirement already satisfied: platformdirs<5.0.0,>=4.3.6 in /usr/local/lib/python3.12/dist-packages (from openai-model-registry==1.0.0) (4.3.8) Requirement already satisfied: requests<3.0.0,>=2.31.0 in /usr/lib/python3/dist-packages (from openai-model-registry==1.0.0) (2.31.0) Requirement already satisfied: rich>=13.7.0 in /usr/lib/python3/dist-packages (from openai-model-registry==1.0.0) (13.7.1) Collecting rich-click>=1.7.0 (from openai-model-registry==1.0.0) Downloading richclick-1.8.9-py3-none-any.whl.metadata (7.9 kB) Collecting semver<4.0.0,>=3.0.0 (from openai-model-registry==1.0.0) Downloading semver-3.0.4-py3-none-any.whl.metadata (6.8 kB) Requirement already satisfied: typing-extensions<5.0.0,>=4.9.0 in /usr/lib/python3/dist-packages (from openai-model-registry==1.0.0) (4.10.0) Collecting soupsieve>1.2 (from beautifulsoup4<5.0.0,>=4.12.2->openai-model-registry==1.0.0) Downloading soupsieve-2.7-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: markdown-it-py>=2.2.0 in /usr/lib/python3/dist-packages (from rich>=13.7.0->openai-model-registry==1.0.0) (3.0.0) Requirement already satisfied: pygments<3.0.0,>=2.13.0 in /usr/lib/python3/dist-packages (from rich>=13.7.0->openai-model-registry==1.0.0) (2.17.2) Requirement already satisfied: mdurl~=0.1 in /usr/lib/python3/dist-packages (from markdown-it-py>=2.2.0->rich>=13.7.0->openai-model-registry==1.0.0) (0.1.2) Downloading openaimodelregistry-1.0.0-py3-none-any.whl (85 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 85.7/85.7 kB 9.3 MB/s eta 0:00:00 Downloading beautifulsoup4-4.13.4-py3-none-any.whl (187 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 187.3/187.3 kB 42.8 MB/s eta 0:00:00 Downloading richclick-1.8.9-py3-none-any.whl (36 kB) Downloading semver-3.0.4-py3-none-any.whl (17 kB) Downloading soupsieve-2.7-py3-none-any.whl (36 kB) Installing collected packages: soupsieve, semver, beautifulsoup4, rich-click, openai-model-registry Successfully installed beautifulsoup4-4.13.4 openai-model-registry-1.0.0 rich-click-1.8.9 semver-3.0.4 soupsieve-2.7

🔄 Upgrade

Defaulting to user installation because normal site-packages is not writeable Requirement already satisfied: openai-model-registry in /home/runner/.local/lib/python3.12/site-packages (1.0.0) Requirement already satisfied: PyYAML<7.0.0,>=6.0.1 in /usr/lib/python3/dist-packages (from openai-model-registry) (6.0.1) Requirement already satisfied: beautifulsoup4<5.0.0,>=4.12.2 in /home/runner/.local/lib/python3.12/site-packages (from openai-model-registry) (4.13.4) Requirement already satisfied: click<8.2,>=8.1.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (8.1.6) Requirement already satisfied: packaging<25.0,>=24.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (24.0) Requirement already satisfied: platformdirs<5.0.0,>=4.3.6 in /usr/local/lib/python3.12/dist-packages (from openai-model-registry) (4.3.8) Requirement already satisfied: requests<3.0.0,>=2.31.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (2.31.0) Requirement already satisfied: rich>=13.7.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (13.7.1) Requirement already satisfied: rich-click>=1.7.0 in /home/runner/.local/lib/python3.12/site-packages (from openai-model-registry) (1.8.9) Requirement already satisfied: semver<4.0.0,>=3.0.0 in /home/runner/.local/lib/python3.12/site-packages (from openai-model-registry) (3.0.4) Requirement already satisfied: typing-extensions<5.0.0,>=4.9.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (4.10.0) Requirement already satisfied: soupsieve>1.2 in /home/runner/.local/lib/python3.12/site-packages (from beautifulsoup4<5.0.0,>=4.12.2->openai-model-registry) (2.7) Requirement already satisfied: markdown-it-py>=2.2.0 in /usr/lib/python3/dist-packages (from rich>=13.7.0->openai-model-registry) (3.0.0) Requirement already satisfied: pygments<3.0.0,>=2.13.0 in /usr/lib/python3/dist-packages (from rich>=13.7.0->openai-model-registry) (2.17.2) Requirement already satisfied: mdurl~=0.1 in /usr/lib/python3/dist-packages (from markdown-it-py>=2.2.0->rich>=13.7.0->openai-model-registry) (0.1.2)

📋 What's New

See CHANGELOG.md for detailed changes
Full commit history: v1.0.0

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - OpenAI Model Registry 1.0.0

OpenAI Model Registry Release 1.0.0

📦 Installation

Defaulting to user installation because normal site-packages is not writeable

🔄 Upgrade

Defaulting to user installation because normal site-packages is not writeable Collecting openai-model-registry Downloading openaimodelregistry-0.7.3-py3-none-any.whl.metadata (8.1 kB) Requirement already satisfied: PyYAML<7.0.0,>=6.0.1 in /usr/lib/python3/dist-packages (from openai-model-registry) (6.0.1) Requirement already satisfied: packaging<25.0,>=24.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (24.0) Requirement already satisfied: platformdirs<5.0.0,>=4.3.6 in /usr/local/lib/python3.12/dist-packages (from openai-model-registry) (4.3.8) Requirement already satisfied: requests<3.0.0,>=2.31.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (2.31.0) Requirement already satisfied: typing-extensions<5.0.0,>=4.9.0 in /usr/lib/python3/dist-packages (from openai-model-registry) (4.10.0) Downloading openaimodelregistry-0.7.3-py3-none-any.whl (31 kB) Installing collected packages: openai-model-registry Successfully installed openai-model-registry-0.7.3

📋 What's New

See CHANGELOG.md for detailed changes
Full commit history: v1.0.0

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - Data Release 1.0.1

OpenAI Model Registry Data Release 1.0.1

This release contains updated model registry configuration files.

📦 Installation

Using the Registry

bash pip install openai-model-registry from openai_model_registry import ModelRegistry registry = ModelRegistry() # Will auto-update to this version

Manual Download

bash curl -L https://github.com/yaniv-golan/openai-model-registry/releases/download/data-v1.0.1/openai-model-registry-data-1.0.1.tar.gz -o data.tar.gz tar -xzf data.tar.gz

📋 Files Included

models.yaml - Model definitions and capabilities
overrides.yaml - Provider-specific overrides
checksums.txt - SHA256 checksums for verification
version.json - Version metadata

🔍 Verification

Verify file integrity using the provided checksums: bash cd data-package sha256sum -c checksums.txt

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - Data Release 1.0.0

OpenAI Model Registry Data Release 1.0.0

This release contains updated model registry configuration files.

📦 Installation

Using the Registry

bash pip install openai-model-registry from openai_model_registry import ModelRegistry registry = ModelRegistry() # Will auto-update to this version

Manual Download

bash curl -L https://github.com/yaniv-golan/openai-model-registry/releases/download/data-v1.0.0/openai-model-registry-data-1.0.0.tar.gz -o data.tar.gz tar -xzf data.tar.gz

📋 Files Included

models.yml - Model definitions and capabilities
parameter_constraints.yml - Parameter validation rules
checksums.txt - SHA256 checksums for verification
version.json - Version metadata

🔍 Verification

Verify file integrity using the provided checksums: bash cd data-package sha256sum -c checksums.txt

🔗 Links

- Python
Published by github-actions[bot] 6 months ago

openai-model-registry - Release v0.7.3

Release v0.7.3

Infrastructure Improvements: - Security Enhancement: Upgraded to trusted publishing for PyPI - Release Automation: Added comprehensive release automation script - Migration Guide: Added detailed migration guide for release pipeline

Technical Changes: - Fixed flake8 line length error in registry.py - Enhanced publish-poetry.yml workflow with trusted publishing - Added comprehensive validation and testing in release process

This release tests our new trusted publishing setup.

- Python
Published by yaniv-golan 8 months ago

openai-model-registry - v0.7.2 o3-Pro and py.typed

This release introduces PEP 561 compatibility for improved type checking and adds support for the new o3-pro model.

Key Changes

PEP 561 Compatibility: The package now includes a py.typed marker file, making it fully compatible with PEP 561. This allows type checkers like mypy to seamlessly use the library's type annotations, enhancing type safety in your projects.
New Model Support: Added the new o3-pro reasoning model to the registry.

- Python
Published by yaniv-golan 9 months ago

openai-model-registry - v0.7.1 📘 Azure OpenAI Guidance - Comprehensive Documentation for Platform Limitations

Release Notes

📘 Azure OpenAI Guidance and Documentation

OpenAI Model Registry v0.7.1 adds documentation specifically for Azure OpenAI users. This patch release addresses common confusion around web search capabilities on Azure endpoints by providing clear guidance, code examples, and alternative approaches.

✨ What's New

Dedicated Azure OpenAI Documentation

New Guide: Azure OpenAI Usage Documentation with comprehensive platform guidance
Platform Detection: Code examples for detecting Azure endpoints and handling limitations gracefully
Alternative Solutions: Detailed coverage of Azure Assistants API (Browse tool) and external search integration
Best Practices: Platform-aware capability detection patterns and robust fallback implementations

Enhanced Documentation Experience

Prominent Warnings: Added Azure limitation notices in web search documentation sections
Improved Discoverability: Azure guidance now accessible from README, main docs, and user guide navigation
Comprehensive Examples: Real-world code snippets for cross-platform applications

🔧 Why This Matters

Azure OpenAI's standard Chat Completions and Responses APIs don't support the web_search_preview tool, even for models where supports_web_search: true. This documentation prevents runtime errors and provides clear guidance on:

Why the limitation exists (platform vs. model capability)
How to detect Azure endpoints programmatically
Alternative approaches for web search functionality
Graceful fallback strategies for cross-platform applications

📊 Impact

Zero Breaking Changes - Documentation-only release
Improved Developer Experience - Prevents common Azure integration pitfalls
Clear Guidance - Empowers developers to implement correct platform-specific logic
Comprehensive Coverage - Addresses both Azure Assistants API and external search alternatives

💡 Quick Example

```python from openaimodelregistry import ModelRegistry

def getwebsearchcapability(modelname, client): """Get accurate web search capability considering Azure limitations.""" registry = ModelRegistry.getdefault() capabilities = registry.getcapabilities(model_name)

# Check both model capability AND platform support
model_supports_search = capabilities.supports_web_search
is_azure = "openai.azure.com" in str(client.base_url or "")

return model_supports_search and not is_azure

```

🔗 Resources

Full Changelog: https://github.com/yaniv-golan/openai-model-registry/compare/v0.7.0...v0.7.1

This documentation update helps Azure OpenAI users avoid confusion and runtime errors while providing clear paths forward for web search functionality! 📚

- Python
Published by github-actions[bot] 9 months ago

openai-model-registry - 🔍 Web Search Capability Support - Track and Detect OpenAI's Web Search Models

Release Notes

🔍 Web Search Capability Support

OpenAI Model Registry v0.7.0 adds comprehensive support for tracking web search capabilities across OpenAI's model lineup. Whether you're using Chat Completions API with search-preview models or Responses API with tool-based search, the registry now helps you detect and work with web search-enabled models.

✨ What's New

Web Search Detection

New Capability Field: Added supports_web_search boolean to easily identify models that can search the web
Universal Detection: One simple check works across both Chat and Responses API approaches
Smart Defaults: All web search capable models are pre-configured with accurate capability flags

New Models Added

gpt-4o-search-preview - GPT-4o with built-in web search (always searches)
gpt-4o-mini-search-preview - GPT-4o Mini with built-in web search (always searches)
Easy aliases: Access models with shorter names for convenience

Enhanced Model Coverage

GPT-4o Series: Full web search support via Responses API
GPT-4.1 Series: Web search enabled (except nano variant)
O-Series Models: All reasoning models support web search
Accurate Exclusions: GPT-4.1-nano correctly marked as unsupported

🚀 Quick Start

```python from openaimodelregistry import ModelRegistry

registry = ModelRegistry()

Check if a model supports web search

caps = registry.getcapabilities("gpt-4o") if caps.supportsweb_search: print("This model can search the web!")

Find all web search capable models

webmodels = [ model for model in registry.listmodels() if registry.getcapabilities(model).supportsweb_search ] ```

📖 Two Ways to Use Web Search

Chat Completions API (Always Searches)
- Use: gpt-4o-search-preview or gpt-4o-mini-search-preview
- Behavior: Automatically searches web before every response
Responses API (Conditional Search)
- Use: gpt-4o, gpt-4.1, or O-series models with web_search_preview tool
- Behavior: Model decides when to search based on the query

🔧 For Developers

Enhanced Type Support

Added ObjectConstraint for validating object/dictionary parameters
Improved type safety with better constraint handling
All constraint types now exported in public API

Comprehensive Documentation

Detailed examples for both Chat and Responses API usage
Clear explanations of when to use each approach
Complete troubleshooting guide for configuration issues

⚠️ Breaking Changes

Models Configuration Schema: Updated from v1.1.0 to v1.2.0 - Adds new supports_web_search field - Fully backward compatible - existing code continues to work - User config files may need updating (see troubleshooting guide)

📈 Impact

9 files changed, 391+ lines added
13 models updated with web search capability flags
2 new models added for Chat API web search
100% test coverage for new web search features

🔗 Resources

Full Changelog: https://github.com/yaniv-golan/openai-model-registry/compare/v0.6.1...v0.7.0

- Python
Published by yaniv-golan 9 months ago

openai-model-registry - v0.6.1 🔧 Fix Repository URLs and Improve Refresh Logic

Release Notes

🐛 Bug Fixes

This patch release resolves critical issues with the registry's remote update functionality that were causing 404 errors and test failures.

Fixed Issues: - Broken Repository URLs: Corrected URLs that were pointing to a non-existent openai-model-registry organization, now properly pointing to yaniv-golan/openai-model-registry - Refresh Logic Improvements: Enhanced the refresh_from_remote() method to properly handle validation-only mode and gracefully fail when remote configuration fetch fails - Test Failures: Resolved failing tests related to refresh validation and fetch error scenarios

🔧 Technical Improvements

Updated both refresh_from_remote and check_for_updates methods with correct GitHub repository URLs
Restructured refresh logic to always fetch and validate remote config before checking version updates
Enhanced validation-only mode to properly return VALIDATED status after successful remote validation
Improved error propagation when remote configuration fetch fails

✅ Quality Assurance

All 99 tests now pass
Pre-commit hooks (black, ruff, mypy) all pass
Remote functionality verified working
No breaking changes to public API

📦 Installation

bash pip install openai-model-registry==0.6.1

🔗 What's Changed

Full Changelog: https://github.com/yaniv-golan/openai-model-registry/compare/v0.6.0...v0.6.1

This release ensures that users can successfully check for and download registry updates without encountering 404 errors from broken URLs.

- Python
Published by github-actions[bot] 9 months ago

openai-model-registry - OpenAI Model Registry 0.6.0: Cross-Platform Data Directory Support & Enhanced Testing

Release Notes

🎯 Key Highlights

Cross-Platform Data Directory Support: This release introduces proper cross-platform directory handling following the XDG Base Directory specification, ensuring model registry files are stored in the appropriate user data directories across different operating systems.

Enhanced Testing Infrastructure: Comprehensive testing documentation and utilities for developers building applications that depend on the registry.

✨ What's New

Cross-Platform Directory Handling: Added proper directory management using platformdirs library
User Data Directory Functions: New programmatic access to user data directories with get_user_data_dir() and ensure_user_data_dir_exists()
Default File Management: Added copy_default_to_user_data() for seamless default configuration handling
Testing Documentation: Comprehensive guides for testing applications using pytest and pyfakefs
Developer Tools: Enhanced utilities for testing code that depends on the registry

🔄 Changes

Directory Structure Update: Model registry files now stored in user data directory instead of config directory
- Linux: ~/.local/share/openai-model-registry/ (previously ~/.config/openai-model-registry/)
- macOS/Windows: No change (same directory used for both data and config)
XDG Compliance: Full adherence to XDG Base Directory specification
Backward Compatibility: Automatic fallback to legacy config directory locations
Enhanced Documentation: Improved testing guides for developers

🛡️ Backward Compatibility

✅ No Breaking Changes: All existing code continues to work without modification. The library automatically handles the transition from old to new directory structures.

🔧 Technical Improvements

Enhanced cross-platform path resolution
Improved registry update functionality with proper data directory handling
Better error handling for directory operations
Comprehensive test coverage for cross-platform scenarios

📦 Installation

bash pip install openai-model-registry==0.6.0

🔗 Full Changelog

See CHANGELOG.md for complete details.

- Python
Published by yaniv-golan 9 months ago

openai-model-registry - Enhanced Model Lifecycle Management with Deprecation Tracking

Release Notes

🎉 OpenAI Model Registry v0.5.0

This major release introduces comprehensive model lifecycle management, corrects critical model specifications, and enhances the registry with robust deprecation tracking capabilities.

✨ New Features

Deprecation System & Lifecycle Management

Complete deprecation tracking with status monitoring (active, deprecated, sunset)
RFC-compliant HTTP headers for deprecation and sunset dates (RFC 9745 & RFC 8594)
Automatic warnings for deprecated models with migration guidance
Sunset protection - prevents usage of discontinued models
Migration assistance with replacement model suggestions and guide links

Enhanced Model Registry

Schema versioning support (v1.0.0 and v1.1.0+) with full backward compatibility
Improved alias resolution for user-friendly model names
Robust null handling for unknown deprecation timelines
Enhanced model capabilities with deprecation metadata integration

🔧 Model Specification Corrections

Critical Accuracy Updates

GPT-4.1 family context windows: Corrected to 1,047,576 tokens (was incorrectly 1,048,576)
- Affects: gpt-4.1, gpt-4.1-mini, gpt-4.1-nano
- Based on official OpenAI/Azure documentation
O1-mini streaming support: Corrected to false (Azure capability matrix shows no streaming)
Model release dates: Fixed gpt-4o-2024-05-13 (was incorrectly gpt-4o-2024-08-06)

Streaming Capabilities

O1-series models: Accurate streaming flags based on current API capabilities
O3/O4 models: Proper streaming support for newer reasoning models
GPT families: Confirmed streaming support across all variants

📚 Documentation Enhancements

Comprehensive Guides

Deprecation tracking examples with real-world usage patterns
Schema compatibility guide explaining v1.0.0 vs v1.1.0+ differences
Model lifecycle management documentation with best practices
Migration strategies for deprecated models

Updated Examples

Working code samples verified against current API
Deprecation handling patterns for production applications
HTTP header generation for API compliance

🛠 Technical Improvements

Code Quality

Python 3.9+ compatibility with proper type annotations
Enhanced error handling for deprecation scenarios
Improved validation for model configurations
Robust testing suite with 99 passing tests

Configuration Management

Backward-compatible schema supporting both v1.0.0 and v1.1.0+
Proper null handling for unknown deprecation dates
Enhanced YAML structure with separate aliases section

🔄 Breaking Changes

None! This release maintains full backward compatibility while adding new features.

🐛 Bug Fixes

Fixed constraint loading for nested YAML parameter references
Resolved registry cache management issues
Corrected model specification inaccuracies
Fixed Python 3.9 compatibility issues

📦 Dependencies

Maintained compatibility with Python 3.9+
No new external dependencies added
Enhanced type safety with improved annotations

🚀 Migration Guide

For Existing Users

No action required - all existing code continues to work
Optional: Update to use new deprecation features for enhanced model lifecycle management
Recommended: Review model specifications for any hardcoded context window values

New Deprecation Features

```python from openaimodelregistry import ModelRegistry

registry = ModelRegistry.getdefault() capabilities = registry.getcapabilities("gpt-4o")

Check deprecation status

print(f"Status: {capabilities.deprecation.status}") if capabilities.is_deprecated: print(f"Replacement: {capabilities.deprecation.replacement}")

Generate HTTP headers for API compliance

headers = capabilities.deprecation_headers() ```

Full Changelog: View on GitHub

Installation: pip install openai-model-registry==0.5.0

- Python
Published by yaniv-golan 9 months ago

openai-model-registry - OpenAI Model Registry 0.4.0: Enhanced Error Handling & Improved Type Safety

Release Notes

Key Improvements

Enhanced Error Handling: Implemented a comprehensive exception hierarchy with specific error types for precise error reporting
Improved Type Safety: Added complete type annotations throughout the codebase for better IDE integration and mypy compatibility
Streamlined Logging: Simplified the logging API while maintaining full functionality and compatibility with standard Python logging
Better Configuration Loading: Enhanced error reporting and validation for registry configuration

New Features

Added ParameterNotSupportedError for more precise error reporting
Added ConstraintNotFoundError for missing constraint references
Added ConfigResult class for standardized configuration loading results
Added comprehensive exception documentation in advanced usage guide

Bug Fixes

Fixed thread safety issues in registry cleanup and configuration refresh
Fixed resource leaks in network requests by properly closing response objects
Fixed mypy type errors throughout the codebase
Fixed potential issues with None values in configuration data
Fixed duplicate alias detection to prevent multiple models using the same alias

- Python
Published by yaniv-golan 11 months ago

openai-model-registry - OpenAI Model Registry 0.3.0

Release Notes

Version 0.3.0 includes bug fixes, performance improvements, and expanded model support.

Key Updates

Added caching for model capabilities to reduce redundant lookups
Fixed thread safety issues in the ModelRegistry singleton
Added support for new models: GPT-4.5 Preview and O3-mini
Improved error handling for file operations and HTTP requests
Fixed documentation generation with mkdocstrings 0.29.0

Other Improvements

Better handling for NaN and infinity values in numeric constraints
Added validation after registry reload
Fixed duplicate network requests during updates
Improved type checking in constraint deserialization
Streamlined CI workflows

See the CHANGELOG.md for a complete list of changes.

- Python
Published by yaniv-golan 11 months ago

openai-model-registry - v0.2.3

Changes

Fix check_for_updates tests and mypy issues @yaniv-golan (#11)

- Python
Published by github-actions[bot] 11 months ago

openai-model-registry - Initial Release

Changes

No changes

- Python
Published by github-actions[bot] 11 months ago

Recent Releases of openai-model-registry

openai-model-registry - OpenAI Model Registry 1.0.5

✨ Key Improvements

🔧 Enhanced Parameter Validation System

📊 Model Parameter Schema Standardization

🧪 Enhanced Test Coverage

🔧 Technical Details

Parameter Validation Enhancements

Enhanced numeric parameter validation

Improved Test Coverage for Existing CLI

🛠️ Code Quality Improvements

🔄 Migration Guide

For Library Users

For Contributors

🎯 Focus Areas

openai-model-registry - Data Release 1.0.3

OpenAI Model Registry Data Release 1.0.3

📋 What's Changed

📦 Installation

Install the Library

Basic Usage

Default usage (no auto-update)

Enable auto-updates (optional)

Manual Update for Existing Users

Check for updates

Apply updates

Manual Download

📋 Files Included

🔍 Verification

🔗 Links

openai-model-registry - OpenAI Model Registry 1.0.4

OpenAI Model Registry Release 1.0.4

📦 Installation

🔄 Upgrade

📋 What's New in 1.0.4

🔗 Links

openai-model-registry - OpenAI Model Registry 1.0.3

OpenAI Model Registry Release 1.0.3

📦 Installation

🔄 Upgrade

📋 What's New

🔗 Links

openai-model-registry - OpenAI Model Registry Data Release 1.0.2

📋 What's Changed

📦 Installation

Install the Library

Basic Usage

Default usage (no auto-update)

Enable auto-updates (optional)

Manual Update for Existing Users

Check for updates

Apply updates

Manual Download

📋 Files Included

🔍 Verification

🔗 Links

openai-model-registry - OpenAI Model Registry 1.0.2

OpenAI Model Registry Release 1.0.2

📦 Installation

🔄 Upgrade

📋 What's New

🔗 Links

openai-model-registry - OpenAI Model Registry 1.0.0

OpenAI Model Registry Release 1.0.0

📦 Installation

🔄 Upgrade

📋 What's New

🔗 Links

openai-model-registry - OpenAI Model Registry 1.0.0

OpenAI Model Registry Release 1.0.0

📦 Installation

🔄 Upgrade

📋 What's New

🔗 Links

openai-model-registry - Data Release 1.0.1

OpenAI Model Registry Data Release 1.0.1

📦 Installation

Using the Registry

Manual Download

📋 Files Included