OpenAI
Táto stránka bola strojovo preložená. Prečítaj si pôvodný článok v angličtine.

Ako môžem pridať svojho klienta API na stránku Community Libraries?

Kritériá a kroky, ktoré zabezpečia, že vaša knižnica je pripravená na pridanie na našu stránku Community Libraries

Aktualizované: 6 days ago

OpenAI spravuje stránku Komunitné knižnice, na ktorej uvádzame klientov API, pomocou ktorých môžu vývojári pristupovať k API OpenAI.

Ak ste vytvorili open-source knižnicu, ktorú by ste chceli pridať na túto stránku, ďakujeme! Teší nás, keď vývojári vytvárajú ďalšie nástroje API pre ostatných vývojárov. Zároveň chceme vývojárov nasmerovať ku kvalitným riešeniam, ktoré im pomôžu dosahovať dlhodobé úspechy. Preto musia knižnice pred zaradením na našu webovú lokalitu spĺňať niekoľko kritérií.

Uistite sa, že spĺňate nižšie uvedené kritériá, a potom vyplňte náš formulár so žiadosťou o zaradenie komunitnej knižnice.

  1. Štandardná open-source licencia

Komunitné knižnice musia na zaradenie používať permisívnu open-source licenciu, napríklad MIT. Vďaka tomu si naši zákazníci môžu v prípade potreby jednoduchšie vytvoriť rozvetvenie knižnice, ak ju jej vlastníci prestanú udržiavať alebo rozširovať o nové funkcie.

  1. Načítavanie kľúčov API z premenných prostredia

Ukážky kódu v súbore README musia odporúčať načítanie kľúča API OpenAI z premenných prostredia namiesto jeho pevného vloženia do zdrojového kódu.

  1. Správny a kvalitný kód, ktorý verne zodpovedá API

Kód by mal byť ľahko čitateľný a zrozumiteľný a vo všeobecnosti by mal zodpovedať našej špecifikácii OpenAPI. Nové knižnice by nemali obsahovať koncové body, ktoré sú v tejto špecifikácii označené ako deprecated: true.

  1. Uveďte, že ide o neoficiálnu knižnicu

V hornej časti súboru README uveďte, že ide o „neoficiálnu“ alebo „komunitou udržiavanú“ knižnicu.

  1. Zaviažte sa knižnicu udržiavať

To znamená predovšetkým riešiť problémy a kontrolovať a zlučovať pull requesty. Užitočné môže byť aj vytvorenie šablón úloh na GitHube a PR podľa vzoru našej oficiálnej knižnice pre Node.js.

Bol tento článok užitočný?