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

Comment puis-je ajouter mon client API à la page des bibliothèques communautaires?

Critères et étapes pour vous assurer que votre bibliothèque est prête à être ajoutée à notre page des bibliothèques communautaires

Mise à jour : 7 days ago

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

Si vous avez créé une bibliothèque à code source ouvert que vous aimeriez faire ajouter à cette page, merci! Nous aimons voir les développeurs créer des outils d’API supplémentaires pour d’autres développeurs. Nous voulons aussi nous assurer d’orienter les développeurs vers de bonnes solutions qui les aideront à réussir à long terme; nous exigeons donc le respect de quelques critères avant d’inscrire des bibliothèques sur notre site Web.

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

  1. Licence standard à code source ouvert

Pour être répertoriées, les bibliothèques communautaires doivent utiliser une licence à code source ouvert permissive, comme MIT. Cela permet à nos clients de forker plus facilement les bibliothèques au besoin si leurs propriétaires cessent d’en assurer la maintenance ou d’y 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, plutôt que de l’inscrire directement dans le code source.

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

Le code devrait être facile à lire et à suivre, et devrait généralement respecter notre spécification OpenAPI; les nouvelles bibliothèques ne devraient pas inclure d’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 et examiner puis fusionner les pull requests. Il peut aussi être judicieux de configurer des modèles de problèmes GitHub et de PR comme ceux que nous avons dans notre bibliothèque Node officielle.

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