https://antoineboucher.info/CV/blog/fr/tags/fastapi/Recent content in FastAPI on Antoine BoucherHugofrSat, 01 Jun 2024 10:00:00 -0400https://antoineboucher.info/CV/blog/fr/posts/fastapi-chatgpt-plugin-overview/Sat, 01 Jun 2024 10:00:00 -0400https://antoineboucher.info/CV/blog/fr/posts/fastapi-chatgpt-plugin-overview/<p>Les <strong>plugins</strong> de style OpenAI exposent une API HTTP décrite par un document <strong>OpenAPI</strong> pour que ChatGPT puisse appeler vos outils de façon contrôlée. <strong>FastAPI</strong> génère OpenAPI automatiquement, ce qui colle bien à ce modèle.</p> <h2 id="1-définir-lapi-dans-fastapi">1. Définir l’API dans FastAPI</h2> <ul> <li>Les routes renvoient du <strong>JSON</strong> avec des formes stables (éviter le texte libre ambigu quand la structure compte).</li> <li>Ajoutez <strong>résumés et descriptions</strong> sur les chemins et les champs — ça aide le modèle à choisir le bon outil.</li> </ul> <h2 id="2-publier-openapijson">2. Publier <code>openapi.json</code></h2> <ul> <li>FastAPI sert <strong><code>/openapi.json</code></strong> par défaut ; le manifeste du plugin pointe vers cette URL (ou une copie statique versionnée).</li> <li>Gardez les schémas <strong>stricts</strong> : énumérations, champs obligatoires et exemples réduisent les mauvais appels.</li> </ul> <h2 id="3-manifeste-du-plugin">3. Manifeste du plugin</h2> <ul> <li>Hébergez <strong><code>ai-plugin.json</code></strong> (ou le format exigé par la doc développeur OpenAI actuelle) en <strong>HTTPS</strong>.</li> <li>Le manifeste référence l’URL de base de l’API et l’emplacement d’OpenAPI.</li> </ul> <h2 id="4-authentification">4. Authentification</h2> <ul> <li>Préférez <strong>OAuth</strong> ou <strong>clés API</strong> comme documenté pour votre intégration ; ne commitez jamais de secrets.</li> <li>Validez les jetons dans les dépendances ou le middleware FastAPI.</li> </ul> <h2 id="5-déploiement">5. Déploiement</h2> <ul> <li>Point de terminaison <strong>HTTPS</strong> joignable depuis les serveurs OpenAI.</li> <li>Journalisation et <strong>idempotence</strong> pour les routes à effets de bord.</li> </ul> <h2 id="6-tests-manuels">6. Tests manuels</h2> <ul> <li>Appelez les routes avec <code>curl</code> ou HTTPie en utilisant les mêmes charges que le modèle enverra.</li> <li>Itérez sur les descriptions et contraintes avant d’ouvrir le trafic.</li> </ul> <blockquote> <p>Les détails évoluent avec les mises à jour de la plateforme OpenAI — suivez toujours la doc la plus récente sur <strong>plugins / tools / actions</strong> pour la prod.</p>