Gestion des versions d'API et documentation

Déployer l'IA en production avec FastAPI

Matt Eckerle

Software and Data Engineering Leader

Pourquoi gérer les versions d'API ?

Points de terminaison d'API comme éléments de menu
Garder la clientèle actuelle satisfaite
Certains clients veulent de nouvelles options
Itérer sans impacter les clients existants

Un restaurant

API pour des tâches d'IA infonuagiques

from pydantic import BaseModel

class AIJobV1(BaseModel):
    job_name: str
    data: bytes

class AIJobV1(BaseModel):
    job_name: str
    data: bytes
    config: dict

Logo de FastAPI AI Cloud

Points de terminaison versionnés

from pydantic import BaseModel

class AIJobV1(BaseModel):
    job_name: str
    data: bytes


class AIJobV2(BaseModel):
    job_name: str
    data: bytes
    config: dict

from fastapi import FastAPI

app = FastAPI()

@app.post("/v1/ai-job")
def ai_job_v1(job: AIJobV1):
    ...


@app.post("/v2/ai-job")
def ai_job_v2(job: AIJobV2):
    ...

Quand mettre à jour la version d'un point de terminaison

Rupture dans le schéma
Changement dans la fonction sous-jacente
- Code du modèle mis à jour
- Ensemble d'entraînement du modèle mis à jour
- Pré/posttraitement mis à jour

Itérer avec des champs facultatifs

La gestion de versions n'est pas toujours requise pour itérer
Des champs facultatifs ajoutent des données sans briser les schémas

from pydantic import BaseModel

class AIJobV1(BaseModel):
    job_name: str
    data: bytes


from typing import Optional

class AIJobV1(BaseModel):
    job_name: str
    data: bytes
    config: Optional[dict]

Documenter les API avec Swagger

Outil standard pour documenter les API
- Suit les points de terminaison et leurs versions
- Bâti sur les métadonnées du standard OpenAPI

Logo d'OpenAPI

Interface Swagger (UI)

URL de Swagger Interface Swagger

Swagger UI pour un point de terminaison

Interface Swagger de FastAPI pour un point de terminaison

Utiliser le champ description de FastAPI

from fastapi import FastAPI

app = FastAPI(
    description="AI Job API"
)

Interface Swagger de FastAPI avec en-tête de description

Passons à la pratique !

Déployer l'IA en production avec FastAPI