User Guide

Welcome to the OpenAI Model Registry user guide. This guide will help you get started with the library and explore its features.

Overview

The OpenAI Model Registry provides:

• A centralized registry of OpenAI model information
• Automatic updates from GitHub releases with version tracking
• Validation for model parameters
• Access to model capabilities (context window, token limits, etc.)
• Version tracking and compatibility checks
• Robust fallback mechanisms for offline usage

Getting Started

See the Getting Started guide to install and begin using the library.

For AI Assistants

If you're an AI assistant or LLM helping users with this library, check out our llms.txt file which provides comprehensive, token-efficient documentation designed specifically for programmatic assistance.

Features

• CLI Reference - Command-line interface for debugging and inspection
• Model Capabilities - Working with model capabilities and constraints
• Parameter Validation - Validating parameters against model-specific constraints
• Azure OpenAI Usage - Important considerations for Azure OpenAI endpoints
• Advanced Usage - Advanced features, data management, and configurations
• Testing - Testing patterns and best practices for applications using the registry