OpenAI onderhoudt een pagina met Communitybibliotheken waarop we API-clients vermelden die ontwikkelaars kunnen gebruiken voor toegang tot de OpenAI API.
Als je een open source-bibliotheek hebt gebouwd die je aan deze pagina wilt laten toevoegen: bedankt! We vinden het geweldig om te zien dat ontwikkelaars extra API-tools voor andere ontwikkelaars bouwen. We willen er ook voor zorgen dat we ontwikkelaars naar goede oplossingen leiden waarmee ze op lange termijn succesvol kunnen zijn. Daarom hanteren we enkele criteria waaraan bibliotheken moeten voldoen voordat we ze op onze website vermelden.
Zorg ervoor dat je aan de onderstaande criteria voldoet en vul daarna ons aanvraagformulier voor communitybibliotheken in.
Standaard open source-licentie
Om te worden vermeld, vereisen we dat communitybibliotheken een permissieve open source-licentie gebruiken, zoals MIT. Dit maakt het voor onze klanten eenvoudiger om bibliotheken te fork indien nodig, bijvoorbeeld als de eigenaren stoppen met het onderhouden ervan of het toevoegen van functies.
API-sleutels laden via omgevingsvariabelen
Codevoorbeelden in de README moeten het gebruik van omgevingsvariabelen aanmoedigen om de OpenAI API-sleutel te laden, in plaats van deze hard te coderen in de broncode.
Correcte code van hoge kwaliteit die de API nauwkeurig weergeeft
Code moet gemakkelijk te lezen en te volgen zijn, en moet over het algemeen voldoen aan onze OpenAPI-specificatie; nieuwe bibliotheken mogen geen endpoints bevatten die in deze specificatie zijn gemarkeerd als deprecated: true.
Vermeld dat het een onofficiële bibliotheek is
Vermeld ergens bovenaan je README dat het een „onofficiële” of „door de community onderhouden” bibliotheek is.
Zeg toe de bibliotheek te onderhouden
Dit betekent vooral het behandelen van issues en het beoordelen en mergen van pull requests. Het kan ook een goed idee zijn om Github-sjablonen voor issues en PR’s in te stellen, zoals we die hebben in onze officiële knooppuntbibliotheek.