Aller au contenu principal

Installer le SDK Python

Installer le SDK Python

Le SDK Python openai est la bibliothèque officielle pour interagir avec l’API OpenAI. Cette leçon vous guide à travers l’installation, la configuration et la vérification de votre environnement de développement.

Prérequis

  • Python 3.8+ (3.11 ou 3.12 recommandé)
  • pip ou uv comme gestionnaire de paquets
  • Une clé API OpenAI (voir leçon précédente)

Vérifiez votre version de Python :

python --version
# Python 3.12.4

Installation du SDK

Avec pip (standard)

pip install openai

Avec uv (plus rapide, recommandé)

uv pip install openai

Dans un environnement virtuel (bonne pratique)

# Créer un environnement virtuel
python -m venv .venv

# Activer (Linux/macOS)
source .venv/bin/activate

# Activer (Windows)
.venv\Scripts\activate

# Installer le SDK
pip install openai

Avec des extras

# Installer avec le support des dataclasses Pydantic
pip install openai pydantic

# Installer avec python-dotenv pour les variables d'environnement
pip install openai python-dotenv

Vérifier l’installation

import openai
print(f"SDK OpenAI version : {openai.__version__}")
# Résultat : SDK OpenAI version : 1.68.0 (ou version plus récente)

Structure du SDK

Le SDK est organisé autour d’un client principal qui donne accès à toutes les API :

from openai import OpenAI

client = OpenAI()

# Responses API (texte, function calling, structured output)
client.responses.create(...)

# Chat Completions API (legacy)
client.chat.completions.create(...)

# Embeddings
client.embeddings.create(...)

# Images
client.images.generate(...)

# Audio
client.audio.transcriptions.create(...)
client.audio.speech.create(...)

# Modération
client.moderations.create(...)

Configuration avancée du client

Timeout personnalisé

from openai import OpenAI

client = OpenAI(
    timeout=60.0,  # 60 secondes (défaut : 10 minutes)
)

Nombre de retries

client = OpenAI(
    max_retries=3,  # 3 tentatives en cas d'erreur (défaut : 2)
)

Base URL personnalisée (proxy ou compatible)

# Utile pour les proxys d'entreprise ou les API compatibles
client = OpenAI(
    base_url="https://votre-proxy.entreprise.com/v1"
)

Client asynchrone

Pour les applications asyncio (FastAPI, aiohttp, etc.) :

from openai import AsyncOpenAI

async_client = AsyncOpenAI()

# Utilisation avec await
import asyncio

async def main():
    response = await async_client.responses.create(
        model="gpt-5.3",
        input="Bonjour !"
    )
    print(response.output_text)

asyncio.run(main())
# Résultat : Bonjour ! Comment puis-je vous aider aujourd'hui ?

Structure de projet recommandée

mon-projet/
├── .env                  # Clé API (JAMAIS dans git)
├── .gitignore            # Inclut .env
├── requirements.txt      # Dépendances
├── src/
│   ├── __init__.py
│   ├── client.py         # Configuration du client OpenAI
│   └── main.py           # Point d'entrée
└── tests/
    └── test_api.py

Fichier src/client.py :

from openai import OpenAI
from dotenv import load_dotenv

load_dotenv()

def get_client() -> OpenAI:
    """Retourne un client OpenAI configuré."""
    return OpenAI(
        max_retries=3,
        timeout=30.0
    )

Fichier requirements.txt :

openai>=1.60.0
python-dotenv>=1.0.0
pydantic>=2.0.0

Dépannage courant

Erreur : ModuleNotFoundError

# Vérifiez que vous êtes dans le bon environnement virtuel
which python  # Linux/macOS
where python  # Windows

# Réinstallez si nécessaire
pip install --upgrade openai

Erreur : AuthenticationError

# Vérifiez que la variable d'environnement est définie
import os
print(os.environ.get("OPENAI_API_KEY", "NON DÉFINIE"))

Erreur de version

# Mettez à jour vers la dernière version
pip install --upgrade openai

Points clés à retenir

  • Installez le SDK avec pip install openai dans un environnement virtuel
  • Le client OpenAI() est le point d’entrée vers toutes les API
  • Utilisez AsyncOpenAI() pour les applications asynchrones
  • Configurez timeout et retries selon vos besoins
  • Structurez votre projet avec un fichier .env et un client centralisé