OpenAI ylläpitää yhteisökirjastojen sivua, jolla luetellaan kehittäjien käytettävissä olevia OpenAI APIn asiakasohjelmia.
Jos olet kehittänyt avoimen lähdekoodin kirjaston, jonka haluaisit lisättävän tälle sivulle – kiitos! On hienoa nähdä kehittäjien luovan uusia API-työkaluja muiden kehittäjien käyttöön. Haluamme myös ohjata kehittäjiä hyviin ratkaisuihin, jotka auttavat heitä menestymään pitkällä aikavälillä. Siksi kirjastojen on täytettävä muutama ehto, ennen kuin lisäämme ne verkkosivustollemme.
Varmista, että täytät alla luetellut ehdot, ja täytä sitten yhteisökirjaston lisäyspyyntölomake.
Vakiomuotoinen avoimen lähdekoodin lisenssi
Luetteloon lisättävien yhteisökirjastojen on käytettävä sallivaa avoimen lähdekoodin lisenssiä, kuten MIT-lisenssiä. Näin asiakkaidemme on tarvittaessa helpompi tehdä kirjastoista haaroituksia, jos niiden omistajat lopettavat ylläpidon tai uusien ominaisuuksien lisäämisen.
Lataa API-avaimet ympäristömuuttujista
README-tiedoston koodiesimerkeissä on suositeltava OpenAI API -avaimen lataamista ympäristömuuttujista sen sijaan, että avain kirjoitettaisiin suoraan lähdekoodiin.
Virheetön ja laadukas koodi, joka vastaa APIa tarkasti
Koodin on oltava helppolukuista ja helposti seurattavaa, ja sen on yleensä noudatettava OpenAPI-määritystämme. Uusissa kirjastoissa ei saa olla päätepisteitä, jotka on merkitty tässä määrityksessä arvolla deprecated: true.
Ilmoita, että kirjasto on epävirallinen
Mainitse README-tiedoston alkupuolella, että kyseessä on ”epävirallinen” tai ”yhteisön ylläpitämä” kirjasto.
Sitoudu ylläpitämään kirjastoa
Tämä tarkoittaa ensisijaisesti ongelmien käsittelemistä sekä pull request -pyyntöjen tarkistamista ja yhdistämistä. Myös GitHub-ongelma- ja PR-mallipohjien määrittäminen voi olla hyödyllistä. Esimerkkinä ovat virallisen Node-kirjastomme mallipohjat.