Skip to content

Getting Started

This guide will help you install the OpenAI Model Registry and start using its features.

Installation

Install the OpenAI Model Registry package using pip:

pip install openai-model-registry

Basic Usage

Here's a simple example to get started:

from openai_model_registry import ModelRegistry

# Get the registry instance (singleton)
registry = ModelRegistry.get_default()

# Get capabilities for a specific model
capabilities = registry.get_capabilities("gpt-4o")

# Access model information
print(f"Context window: {capabilities.context_window}")
print(f"Max output tokens: {capabilities.max_output_tokens}")
print(f"Supports streaming: {capabilities.supports_streaming}")
print(f"Supports structured output: {capabilities.supports_structured}")

Model Validation

You can validate parameters against a model's constraints:

try:
    # Valid parameter
    capabilities.validate_parameter("temperature", 0.7)
    print("Temperature 0.7 is valid")

    # Invalid parameter
    capabilities.validate_parameter("temperature", 3.0)
    print("This won't be reached")
except Exception as e:
    print(f"Invalid parameter: {e}")

Next Steps

Now that you have the basics, explore the following topics: