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

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

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

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

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

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

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

  1. Стандартен лиценз за отворен код

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

  1. Зареждане на API ключове чрез променливи на средата

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

  1. Коректен, висококачествен код, който точно отразява API

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

  1. Посочете, че това е неофициална библиотека

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

  1. Ангажирайте се с поддръжката на библиотеката

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

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