OpenAI
Для перекладу цієї сторінки виконано машинний переклад. Ви можете переглянути оригінальну статтю англійською.

Як додати мій API-клієнт на сторінку Community Libraries?

Критерії та кроки, щоб ваша бібліотека була готова до додавання на сторінку Community Libraries

Оновлено: 9 days ago

OpenAI підтримує сторінку бібліотек спільноти, де ми перелічуємо клієнти API, які розробники можуть використовувати для доступу до OpenAI API.

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

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

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

Для додавання до списку ми вимагаємо, щоб бібліотеки спільноти використовували дозвільну ліцензію з відкритим кодом, наприклад MIT. Це дає нашим клієнтам змогу за потреби легше створювати форки бібліотек, якщо власники припинять їх підтримувати або додавати функції.

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

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

  1. Коректний, якісний код, що точно відображає API

Код має бути легким для читання й розуміння та загалом відповідати нашій специфікації OpenAPI — нові бібліотеки не повинні містити кінцеві точки, позначені в цій специфікації як deprecated: true.

  1. Зазначте, що це неофіційна бібліотека

Будь ласка, зазначте десь на початку README, що це «неофіційна» або «підтримувана спільнотою» бібліотека.

  1. Зобов’язання підтримувати бібліотеку

Насамперед це означає опрацювання проблем і перегляд та злиття запитів на злиття. Також може бути доречно налаштувати шаблони Github Issue і PR, подібні до тих, що є в нашій офіційній бібліотеці Node.

Чи була ця стаття корисною?