OpenAI beheert een pagina met Community Libraries waarop we API-clients vermelden die ontwikkelaars kunnen gebruiken om toegang te krijgen tot de OpenAI API.
Als je een open-sourcebibliotheek hebt gebouwd die je aan deze pagina wilt laten toevoegen: bedankt! We vinden het geweldig om te zien dat ontwikkelaars extra API-tools bouwen voor andere ontwikkelaars. We willen er ook zeker van zijn dat we ontwikkelaars naar goede oplossingen leiden waarmee ze op de lange termijn succesvol kunnen zijn, dus hebben we een paar criteria waaraan libraries moeten voldoen voordat we ze op onze website vermelden.
Zorg ervoor dat je aan de onderstaande criteria voldoet en vul daarna ons aanvraagformulier voor Community Libraries in.
Standaard open-sourcelicentie
Om te worden vermeld, eisen we dat community libraries een toegestane open-sourcelicentie gebruiken, zoals MIT. Hierdoor kunnen onze klanten libraries gemakkelijker fork als dat nodig is wanneer de eigenaren stoppen met het onderhouden ervan of met het toevoegen van functies.Laad API-sleutels 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 zich in het algemeen houden aan onze OpenAPI-spec – nieuwe libraries mogen geen endpoints bevatten die in deze spec zijn gemarkeerd alsdeprecated: true.Vermeld dat het een niet-officiële library is
Vermeld ergens bovenaan je README dat het een ‘niet-officiële’ of ‘door de community onderhouden’ library is.Zet je in voor het onderhouden van de library
Dit betekent vooral issues oplossen en pull requests beoordelen en samenvoegen. Het kan ook een goed idee zijn om Github Issue- en PR-sjablonen in te stellen, zoals wij hebben in onze officiële node-library.