Add comprehensive AI models documentation and update README
Co-authored-by: cauvang32 <113093128+cauvang32@users.noreply.github.com>
This commit is contained in:
35
AI_MODELS_SUMMARY.md
Normal file
35
AI_MODELS_SUMMARY.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# AI Models Summary for ChatGPT Discord Bot
|
||||
|
||||
## Quick Answer
|
||||
|
||||
The ChatGPT Discord Bot Python package supports **11 OpenAI models** through the official `openai` Python library:
|
||||
|
||||
## Complete Model List
|
||||
|
||||
1. **openai/gpt-4o** - Premium multimodal model (8,000 tokens)
|
||||
2. **openai/gpt-4o-mini** - Lightweight version (8,000 tokens)
|
||||
3. **openai/gpt-4.1** - Enhanced GPT-4 (8,000 tokens)
|
||||
4. **openai/gpt-4.1-nano** - Ultra-lightweight (8,000 tokens)
|
||||
5. **openai/gpt-4.1-mini** - Compact version (8,000 tokens)
|
||||
6. **openai/o1-preview** - Reasoning model preview (4,000 tokens)
|
||||
7. **openai/o1-mini** - Compact reasoning (4,000 tokens)
|
||||
8. **openai/o1** - Full reasoning model (4,000 tokens)
|
||||
9. **openai/o3-mini** - Next-gen compact (4,000 tokens)
|
||||
10. **openai/o3** - Next-gen full model (4,000 tokens)
|
||||
11. **openai/o4-mini** - Future model preview (4,000 tokens)
|
||||
|
||||
## Key Python Dependencies
|
||||
|
||||
- **openai** - Official OpenAI Python client library
|
||||
- **tiktoken** - Token counting for OpenAI models
|
||||
|
||||
## Model Features
|
||||
|
||||
- **All models**: Text generation, conversation, code assistance
|
||||
- **PDF Support**: Only GPT-4o and GPT-4.1 series models
|
||||
- **System Prompts**: Supported by GPT-4o and GPT-4.1 series (not O1/O3/O4)
|
||||
- **Tools/Functions**: Available on most models except o1-mini and o1-preview
|
||||
|
||||
## Default Model
|
||||
|
||||
The bot defaults to **openai/gpt-4.1-mini** when no model is selected by the user.
|
||||
@@ -138,10 +138,15 @@ Once the bot is running, it connects to Discord using credentials from `.env`. A
|
||||
The bot supports the following models:
|
||||
- openai/gpt-4o
|
||||
- openai/gpt-4o-mini
|
||||
- openai/gpt-4.1
|
||||
- openai/gpt-4.1-nano
|
||||
- openai/gpt-4.1-mini
|
||||
- openai/o1-preview
|
||||
- openai/o1-mini
|
||||
- openai/o1
|
||||
- openai/o3-mini
|
||||
- openai/o3
|
||||
- openai/o4-mini
|
||||
|
||||
## Environment Variables
|
||||
| Variable | Description | Default |
|
||||
|
||||
105
SUPPORTED_AI_MODELS.md
Normal file
105
SUPPORTED_AI_MODELS.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# Supported AI Models
|
||||
|
||||
This document provides a comprehensive overview of all AI models supported by the ChatGPT Discord Bot Python package.
|
||||
|
||||
## Overview
|
||||
|
||||
The ChatGPT Discord Bot supports **11 different OpenAI models** with varying capabilities and token limits. All models are accessed through OpenAI's API using the `openai` Python package.
|
||||
|
||||
## Complete List of Supported Models
|
||||
|
||||
### GPT-4o Series
|
||||
- **openai/gpt-4o** - Premium multimodal model with 8,000 token limit
|
||||
- **openai/gpt-4o-mini** - Lightweight version with 8,000 token limit
|
||||
|
||||
### GPT-4.1 Series
|
||||
- **openai/gpt-4.1** - Enhanced GPT-4 model with 8,000 token limit
|
||||
- **openai/gpt-4.1-nano** - Ultra-lightweight version with 8,000 token limit
|
||||
- **openai/gpt-4.1-mini** - Compact version with 8,000 token limit
|
||||
|
||||
### O1 Series (Reasoning Models)
|
||||
- **openai/o1-preview** - Preview of reasoning model with 4,000 token limit
|
||||
- **openai/o1-mini** - Compact reasoning model with 4,000 token limit
|
||||
- **openai/o1** - Full reasoning model with 4,000 token limit
|
||||
|
||||
### O3 Series (Next Generation)
|
||||
- **openai/o3-mini** - Compact next-gen model with 4,000 token limit
|
||||
- **openai/o3** - Full next-gen model with 4,000 token limit
|
||||
|
||||
### O4 Series (Future Models)
|
||||
- **openai/o4-mini** - Compact future model with 4,000 token limit
|
||||
|
||||
## Model Capabilities Matrix
|
||||
|
||||
| Model | Token Limit | PDF Support | System Prompts | Special Features |
|
||||
|-------|-------------|-------------|----------------|------------------|
|
||||
| openai/gpt-4o | 8,000 | ✅ | ✅ | Multimodal capabilities |
|
||||
| openai/gpt-4o-mini | 8,000 | ✅ | ✅ | Lightweight, cost-effective |
|
||||
| openai/gpt-4.1 | 8,000 | ✅ | ✅ | Enhanced performance |
|
||||
| openai/gpt-4.1-nano | 8,000 | ✅ | ✅ | Ultra-lightweight |
|
||||
| openai/gpt-4.1-mini | 8,000 | ✅ | ✅ | Balanced performance |
|
||||
| openai/o1-preview | 4,000 | ❌ | ❌ | Advanced reasoning |
|
||||
| openai/o1-mini | 4,000 | ❌ | ❌ | Compact reasoning |
|
||||
| openai/o1 | 4,000 | ❌ | ❌ | Full reasoning capabilities |
|
||||
| openai/o3-mini | 4,000 | ❌ | ❌ | Next-generation compact |
|
||||
| openai/o3 | 4,000 | ❌ | ❌ | Next-generation full |
|
||||
| openai/o4-mini | 4,000 | ❌ | ❌ | Future model preview |
|
||||
|
||||
## Model Selection
|
||||
|
||||
Users can select their preferred model using the `/choose_model` Discord command. The bot provides a dropdown menu with all available models.
|
||||
|
||||
## Model-Specific Limitations
|
||||
|
||||
### PDF Processing
|
||||
Only the following models support PDF document analysis:
|
||||
- openai/gpt-4o
|
||||
- openai/gpt-4o-mini
|
||||
- openai/gpt-4.1
|
||||
- openai/gpt-4.1-nano
|
||||
- openai/gpt-4.1-mini
|
||||
|
||||
### System Prompts
|
||||
The O1, O3, and O4 series models do not support system prompts. For these models, the bot automatically converts system prompts into user messages.
|
||||
|
||||
### Token Management
|
||||
- **High Token Models** (8,000 tokens): GPT-4o and GPT-4.1 series
|
||||
- **Conservative Models** (4,000 tokens): O1, O3, and O4 series
|
||||
- **Default Fallback**: 60,000 tokens for unknown models
|
||||
|
||||
## Python Package Dependencies
|
||||
|
||||
The bot uses the following key Python packages for AI model integration:
|
||||
|
||||
```
|
||||
openai - Official OpenAI Python client
|
||||
tiktoken - Token counting for OpenAI models
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Model Selection
|
||||
```python
|
||||
# Users can select models via Discord command
|
||||
/choose_model
|
||||
```
|
||||
|
||||
### API Integration
|
||||
```python
|
||||
# The bot uses the OpenAI client configured in the codebase
|
||||
from openai import OpenAI
|
||||
client = OpenAI(api_key=OPENAI_API_KEY)
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
All model configurations are defined in `src/config/config.py`:
|
||||
|
||||
- `MODEL_OPTIONS`: List of all available models
|
||||
- `MODEL_TOKEN_LIMITS`: Token limits for each model
|
||||
- `PDF_ALLOWED_MODELS`: Models that support PDF processing
|
||||
- `DEFAULT_TOKEN_LIMIT`: Fallback for unknown models
|
||||
|
||||
## Model Updates
|
||||
|
||||
The bot supports both current and future OpenAI models, with the configuration easily updatable to include new model releases from OpenAI.
|
||||
Reference in New Issue
Block a user