OpenAI
Cette page a été traduite automatiquement. Afficher l’article original en anglais.

Comment ajouter mon client d’API à la page Bibliothèques communautaires ?

Critères et étapes pour vérifier que votre bibliothèque est prête à être ajoutée à notre page Bibliothèques communautaires

Dernière mise à jour : 9 days ago

OpenAI tient à jour une page Bibliothèques communautaires où nous répertorions les clients d’API que les développeurs peuvent utiliser pour accéder à l’API OpenAI.

Si vous avez créé une bibliothèque open source que vous souhaitez voir ajoutée à cette page, merci ! Nous sommes ravis de voir des développeurs créer des outils d’API supplémentaires pour d’autres développeurs. Nous voulons également nous assurer d’orienter les développeurs vers de bonnes solutions qui les aideront à réussir sur le long terme ; c’est pourquoi nous exigeons le respect de quelques critères avant de répertorier des bibliothèques sur notre site Web.

Veuillez vous assurer de respecter les critères indiqués ci-dessous, puis remplissez notre formulaire de demande pour les bibliothèques communautaires.

  1. Licence open source standard

Pour être répertoriées, les bibliothèques communautaires doivent utiliser une licence open source permissive, comme MIT. Cela permet à nos clients de forker plus facilement des bibliothèques si nécessaire, au cas où leurs propriétaires cesseraient de les maintenir ou d’ajouter des fonctionnalités.

  1. Charger les clés d’API au moyen de variables d’environnement

Les exemples de code dans le README doivent encourager l’utilisation de variables d’environnement pour charger la clé d’API OpenAI, au lieu de la coder en dur dans le code source.

  1. Code correct et de haute qualité, qui reflète fidèlement l’API

Le code doit être facile à lire et à suivre, et doit généralement respecter notre spécification OpenAPI : les nouvelles bibliothèques ne doivent pas inclure les endpoints marqués comme deprecated: true dans cette spécification.

  1. Indiquer qu’il s’agit d’une bibliothèque non officielle

Veuillez indiquer quelque part près du début de votre README qu’il s’agit d’une bibliothèque « non officielle » ou « maintenue par la communauté ».

  1. S’engager à maintenir la bibliothèque

Cela signifie principalement traiter les problèmes, ainsi qu’examiner et fusionner les pull requests. Il peut également être judicieux de configurer des modèles d’issues et de PR GitHub, comme ceux de notre bibliothèque nœud officielle.

Cet article vous a-t-il été utile ?