OpenAI
Halaman ini diterjemah oleh mesin. Lihat artikel asal dalam bahasa Inggeris.

Bagaimanakah saya boleh menambahkan klien API saya pada halaman Perpustakaan Komuniti?

Kriteria dan langkah untuk memastikan pustaka anda sedia ditambahkan pada halaman Perpustakaan Komuniti kami

Dikemas kini: 9 days ago

OpenAI menyelenggarakan halaman Pustaka Komuniti yang menyenaraikan klien API untuk digunakan oleh pembangun bagi mengakses API OpenAI.

Jika anda telah membina pustaka sumber terbuka yang ingin ditambahkan pada halaman ini – terima kasih! Kami gembira melihat pembangun menghasilkan alatan API tambahan untuk pembangun lain. Kami juga mahu memastikan pembangun memilih penyelesaian yang baik dan dapat membantu mereka berjaya dalam jangka panjang. Oleh itu, pustaka perlu memenuhi beberapa kriteria sebelum disenaraikan di laman web kami.

Pastikan anda memenuhi kriteria yang disenaraikan di bawah, kemudian isi borang permohonan Pustaka Komuniti kami.

  1. Lesen sumber terbuka standard

Untuk disenaraikan, pustaka komuniti perlu menggunakan lesen sumber terbuka yang permisif seperti MIT. Ini memudahkan pelanggan kami untuk capah pustaka jika perlu sekiranya pemilik berhenti menyelenggarakannya atau menambahkan ciri.

  1. Muatkan kunci API melalui pemboleh ubah persekitaran

Sampel kod dalam README mesti menggalakkan penggunaan pemboleh ubah persekitaran untuk memuatkan kunci API OpenAI dan bukannya mengekodkannya secara terus dalam kod sumber.

  1. Kod yang betul, berkualiti tinggi dan mencerminkan API dengan tepat

Kod hendaklah mudah dibaca dan diikuti serta secara amnya mematuhi spesifikasi OpenAPI kami – pustaka baharu tidak sepatutnya menyertakan titik akhir yang ditandai sebagai deprecated: true dalam spesifikasi ini.

  1. Nyatakan bahawa pustaka itu tidak rasmi

Sila nyatakan berhampiran bahagian atas README bahawa pustaka itu ialah pustaka “tidak rasmi” atau “diselenggarakan oleh komuniti”.

  1. Berikan komitmen untuk menyelenggarakan pustaka

Ini terutamanya bermaksud menangani isu serta menyemak dan menggabungkan permintaan tarik. Anda juga disarankan menyediakan templat Isu GitHub & PR seperti yang terdapat dalam pustaka nod rasmi kami.

Adakah artikel ini membantu?