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

OpenAI spravuje stránku Komunitní knihovny, kde uvádíme klienty API, které mohou vývojáři používat k přístupu k API OpenAI.

Pokud jste vytvořili open source knihovnu, kterou byste chtěli na tuto stránku přidat – děkujeme! Rádi vidíme, když vývojáři vytvářejí další nástroje pro API pro ostatní vývojáře. Chceme také zajistit, abychom vývojářům doporučovali dobrá řešení, která jim dlouhodobě pomohou uspět, proto máme několik kritérií, která před zařazením knihoven na náš web vyžadujeme.

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

  1. Standardní open source licence

Aby mohla být knihovna zařazena, vyžadujeme, aby komunitní knihovny používaly permisivní open source licenci, například MIT. Našim zákazníkům to umožňuje v případě potřeby knihovny snáze větvit, pokud je jejich vlastníci přestanou udržovat nebo přidávat funkce.

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

Ukázky kódu v souboru README musí podporovat používání proměnných prostředí k načtení klíče API OpenAI namísto jeho pevného zapsání ve zdrojovém kódu.

  1. Korektní, kvalitní kód, který přesně odráží API

Kód by měl být snadno čitelný a srozumitelný a obecně by měl odpovídat naší specifikaci OpenAPI – nové knihovny by neměly zahrnovat koncové body označené v této specifikaci jako deprecated: true.

  1. Uveďte, že jde o neoficiální knihovnu

Uveďte prosím někde poblíž začátku souboru README, že jde o „neoficiální“ knihovnu nebo knihovnu „spravovanou komunitou“.

  1. Zavažte se k údržbě knihovny

To znamená především řešení problémů a kontrolu a slučování žádostí o přijetí změn. Může být také dobrý nápad nastavit šablony pro Github Issue a PR, jako je máme v naší oficiální knihovně pro uzel.

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