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é: 9 days ago

OpenAI udržiava stránku Komunitné knižnice, na ktorej uvádzame klientov API, ktorých môžu vývojári použiť na prístup k OpenAI API.

Ak ste vytvorili open source knižnicu, ktorú by ste chceli pridať na túto stránku – ďakujeme! Radi vidíme, keď vývojári vytvárajú ďalšie nástroje API pre iných vývojárov. Zároveň sa chceme uistiť, že vývojárov smerujeme k dobrým riešeniam, ktoré im dlhodobo pomôžu uspieť, preto máme niekoľko kritérií, ktoré vyžadujeme splniť pred zaradením knižníc na našu webovú stránku.

Uistite sa, že spĺňate kritériá uvedené nižšie, a potom vyplňte náš formulár žiadosti pre komunitné knižnice.

  1. Štandardná open source licencia

Na zaradenie vyžadujeme, aby komunitné knižnice používali permisívnu open source licenciu, napríklad MIT. To našim zákazníkom umožňuje v prípade potreby jednoduchšie vytvoriť rozvetvenie knižníc, ak ich vlastníci prestanú udržiavať alebo pridávať funkcie.

  1. Načítavajte kľúče API prostredníctvom premenných prostredia

Ukážky kódu v súbore README musia podporovať používanie premenných prostredia na načítanie kľúča OpenAI API namiesto jeho pevného zakódovania v zdrojovom kóde.

  1. Správny a kvalitný kód, ktorý presne odráža API

Kód by sa mal dať ľahko čítať a sledovať a vo všeobecnosti by sa mal riadiť našou špecifikáciou OpenAPI – nové knižnice by nemali obsahovať koncové body označené v tejto špecifikácii ako deprecated: true.

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

Uveďte niekde na začiatku súboru README, že ide o „neoficiálnu“ alebo „komunitou udržiavanú“ knižnicu.

  1. Zaviažte sa k udržiavaniu knižnice

Znamená to najmä riešenie problémov a kontrolu a zlučovanie žiadostí o zlúčenie. Dobrým nápadom môže byť aj nastaviť šablóny Github Issue a PR, ako ich máme v našej oficiálnej knižnici pre uzol.

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