OpenAI
Тази страница е машинно преведена. Вижте оригиналната статия на английски език.

Как мога да добавя своя API клиент към страницата Community Libraries?

Критерии и стъпки, за да сте сигурни, че библиотеката ви е готова да бъде добавена към нашата страница Community Libraries

Актуализирано: 14 days ago

OpenAI поддържа страница Community Libraries, където изброяваме API клиенти, които разработчиците могат да използват за достъп до OpenAI API.

Ако сте създали библиотека с отворен код, която искате да бъде добавена към тази страница – благодарим ви! Радваме се да виждаме как разработчиците създават допълнителни API инструменти за други разработчици. Също така искаме да сме сигурни, че насочваме разработчиците към добри решения, които ще им помогнат да бъдат успешни в дългосрочен план, затова имаме няколко критерия, които изискваме да бъдат изпълнени, преди да включим библиотеки в сайта си.

Моля, уверете се, че отговаряте на критериите по-долу, и след това попълнете нашия формуляр за заявка за Community Libraries.

  1. Стандартен лиценз с отворен код
    За да бъдат включени, изискваме библиотеките на общността да използват разрешителен лиценз с отворен код, като например MIT. Това позволява на клиентите ни по-лесно да Клонирай библиотеки, ако е необходимо, в случай че собствениците спрат да ги поддържат или да добавят функционалности.

  2. Зареждайте API ключове чрез променливи на средата
    Примерите за код в README трябва да насърчават използването на променливи на средата за зареждане на OpenAI API ключа, вместо той да бъде твърдо зададен в изходния код.

  3. Коректен, висококачествен код, който точно отразява API
    Кодът трябва да е лесен за четене/следване и като цяло да се придържа към нашата OpenAPI спецификация – новите библиотеки не трябва да включват крайни точки, отбелязани като deprecated: true в тази спецификация.

  4. Посочете, че това е неофициална библиотека
    Моля, посочете някъде в началото на README, че това е „неофициална“ или „поддържана от общността“ библиотека.

  5. Ангажирайте се да поддържате библиотеката
    Това основно означава да отговаряте на проблеми и да преглеждате+сливате искане за предложения. Също така може да е добра идея да настроите Github шаблони за Issue и PR, каквито имаме в нашата официална node библиотека.

Беше ли Ви полезна тази статия?