OpenAI betreibt eine Seite zu Community-Bibliotheken, auf der wir API-Clients aufführen, mit denen Entwickler:innen auf die OpenAI-API zugreifen können.
Wenn du eine Open-Source-Bibliothek entwickelt hast, die du gern auf dieser Seite aufnehmen lassen möchtest – vielen Dank! Wir freuen uns, wenn Entwickler:innen zusätzliche API-Tools für andere Entwickler:innen bereitstellen. Wir möchten außerdem sicherstellen, dass wir Entwickler:innen auf gute Lösungen verweisen, mit denen sie langfristig erfolgreich arbeiten können. Deshalb müssen Bibliotheken einige Kriterien erfüllen, bevor wir sie auf unserer Website aufführen.
Bitte stelle sicher, dass du die unten aufgeführten Kriterien erfüllst, und fülle anschließend unser Antragsformular für Community-Bibliotheken aus.
Standard-Open-Source-Lizenz
Damit eine Community-Bibliothek aufgeführt werden kann, muss sie eine freizügige Open-Source-Lizenz wie die MIT-Lizenz verwenden. So können unsere Kund:innen Bibliotheken bei Bedarf leichter forken, falls die Verantwortlichen sie nicht mehr pflegen oder keine Funktionen mehr hinzufügen.
API-Schlüssel über Umgebungsvariablen laden
Codebeispiele in der README müssen dazu anhalten, den OpenAI-API-Schlüssel über Umgebungsvariablen zu laden, statt ihn fest im Quellcode zu hinterlegen.
Korrekt geschriebener, hochwertiger Code, der die API präzise abbildet
Code sollte leicht zu lesen und nachzuvollziehen sein und sich grundsätzlich an unsere OpenAPI-Spezifikation halten – neue Bibliotheken sollten keine Endpunkte enthalten, die in dieser Spezifikation als deprecated: true gekennzeichnet sind.
Angeben, dass es sich um eine inoffizielle Bibliothek handelt
Bitte gib irgendwo am Anfang deiner README an, dass es sich um eine „inoffizielle“ oder „von der Community gepflegte“ Bibliothek handelt.
Die Pflege der Bibliothek zusagen
Das bedeutet vor allem, Issues zu bearbeiten und Pull Requests zu prüfen und zu mergen. Es kann außerdem sinnvoll sein, GitHub-Issue- und PR-Vorlagen einzurichten, wie wir sie in unserer offiziellen Node-Bibliothek verwenden.