OpenAI
Tato stránka byla přeložena strojově. Zobrazit původní článek v angličtině.

Jak mohu přidat svého klienta API na stránku Komunitní knihovny?

Kritéria a kroky, které zajistí, že je vaše knihovna připravena k přidání na naši stránku Komunitní knihovny

Aktualizováno: 6 days ago

OpenAI spravuje stránku Komunitní knihovny, kde uvádíme klienty API, pomocí kterých mohou vývojáři přistupovat k API OpenAI.

Pokud jste vytvořili open-source knihovnu, kterou byste na tuto stránku chtěli přidat, děkujeme! Těší nás, když vývojáři vytvářejí další nástroje API pro ostatní vývojáře. Zároveň chceme vývojářům doporučovat kvalitní řešení, která jim přinesou dlouhodobý úspěch. Proto musí knihovny před zařazením na náš web splnit několik kritérií.

Ujistěte se, že splňujete níže uvedená kritéria, a poté vyplňte náš formulář žádosti o zařazení komunitní knihovny.

  1. Standardní open-source licence

Komunitní knihovny musí pro zařazení používat permisivní open-source licenci, například MIT. Naši zákazníci tak mohou knihovny v případě potřeby snáze větvit, pokud je jejich vlastníci přestanou udržovat nebo rozšiřovat o nové funkce.

  1. Načítání klíčů API z proměnných prostředí

Ukázky kódu v souboru README musí doporučovat načítání klíče API OpenAI z proměnných prostředí namísto jeho pevného zapsání do zdrojového kódu.

  1. Správný a kvalitní kód, který přesně odpovídá API

Kód by měl být snadno čitelný a srozumitelný a obecně dodržovat naši specifikaci OpenAPI. Nové knihovny by neměly obsahovat koncové body, které jsou v této specifikaci označeny jako deprecated: true.

  1. Uvedení, že jde o neoficiální knihovnu

Poblíž začátku souboru README uveďte, že jde o „neoficiální“ nebo „komunitou spravovanou“ knihovnu.

  1. Závazek knihovnu udržovat

To znamená především řešit nahlášené záležitosti a kontrolovat a slučovat pull requesty. Vhodné může být také vytvoření šablon příspěvků na GitHubu & pull requestů, jaké používáme v naší oficiální knihovně pro Node.js.

Byl tento článek užitečný?