OpenAI
Эта страница была переведена машинным переводом. Открыть оригинальную статью на английском.

Как добавить мой API-клиент на страницу Community Libraries?

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

Обновлено: 13 days ago

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

Если вы создали библиотеку с открытым исходным кодом, которую хотели бы добавить на эту страницу — спасибо! Нам нравится видеть, как разработчики создают дополнительные инструменты для работы с API для других разработчиков. Мы также хотим быть уверены, что направляем разработчиков к качественным решениям, которые помогут им успешно работать в долгосрочной перспективе, поэтому перед тем как размещать библиотеки на нашем сайте, мы предъявляем несколько обязательных требований.

Пожалуйста, убедитесь, что вы соответствуете критериям ниже, а затем заполните нашу форму запроса на добавление в Community Libraries.

  1. Стандартная лицензия open source
    Чтобы быть включёнными в список, мы требуем, чтобы библиотека сообщества использовала разрешительную (permissive) лицензию open source, например MIT. Это позволяет нашим клиентам при необходимости проще форкать библиотеки в случае, если владельцы перестанут её поддерживать или добавлять новые функции.

  2. Загрузка API-ключей через переменные окружения
    Примеры кода в README должны поощрять использование переменных окружения для загрузки ключа OpenAI API вместо жёсткого прописывания его в исходном коде.

  3. Корректный, качественный код, точно отражающий API
    Код должен быть простым для чтения и понимания и в целом соответствовать нашей спецификации OpenAPI — новые библиотеки не должны включать эндпоинты, помеченные в этой спецификации как deprecated: true.

  4. Укажите, что это неофициальная библиотека
    Пожалуйста, укажите где-нибудь ближе к началу README, что это «неофициальная» или «поддерживаемая сообществом» библиотека.

  5. Возьмите обязательство поддерживать библиотеку
    В основном это означает работу с issues и рассмотрение/слияние pull request’ов. Также хорошей идеей может быть настройка шаблонов для Github Issue и PR, как у нас в официальной node-библиотеке.

Была ли эта статья полезной?