OpenAI
Šis puslapis buvo išverstas mašininiu būdu. Peržiūrėti originalų straipsnį anglų kalba.

Kaip galiu pridėti savo API klientą į Community Libraries puslapį?

Kriterijai ir veiksmai, padėsiantys užtikrinti, kad jūsų biblioteka būtų parengta įtraukimui į mūsų Community Libraries puslapį

Atnaujinta: 18 days ago

OpenAI prižiūri bendruomenės bibliotekų puslapį, kuriame pateikiame API klientus, kuriuos kūrėjai gali naudoti prieigai prie OpenAI API.

Jei sukūrėte atvirojo kodo biblioteką, kurią norėtumėte įtraukti į šį puslapį, – dėkojame! Džiaugiamės matydami, kaip kūrėjai kuria papildomus API įrankius kitiems kūrėjams. Taip pat norime užtikrinti, kad kūrėjus nukreipiame į gerus sprendimus, kurie ilgainiui padės jiems sėkmingai dirbti, todėl turime kelis kriterijus, kuriuos reikalaujame atitikti prieš įtraukdami bibliotekas į savo svetainę.

Įsitikinkite, kad atitinkate toliau nurodytus kriterijus, tada užpildykite mūsų bendruomenės bibliotekų užklausos formą.

  1. Standartinė atvirojo kodo licencija

Kad biblioteka būtų įtraukta, reikalaujame, kad bendruomenės bibliotekos naudotų liberaliąją atvirojo kodo licenciją, pvz., MIT. Tai leidžia mūsų klientams prireikus lengviau kurti bibliotekų atšakas, jei savininkai nustoja jas prižiūrėti ar papildyti funkcijomis.

  1. Įkelkite API raktus per aplinkos kintamuosius

README esančiuose kodo pavyzdžiuose turi būti skatinama naudoti aplinkos kintamuosius OpenAI API raktui įkelti, užuot įrašius jį tiesiai į šaltinio kodą.

  1. Teisingas, aukštos kokybės kodas, tiksliai atspindintis API

Kodas turėtų būti lengvai skaitomas / suprantamas ir apskritai atitikti mūsų OpenAPI specifikaciją – naujose bibliotekose neturėtų būti prieigos taškų, šioje specifikacijoje pažymėtų kaip deprecated: true.

  1. Nurodykite, kad tai neoficiali biblioteka

README pradžioje kur nors nurodykite, kad tai „neoficiali“ arba „bendruomenės prižiūrima“ biblioteka.

  1. Įsipareigokite prižiūrėti biblioteką

Tai pirmiausia reiškia problemų sprendimą ir išsiuntimo užklausų peržiūrą bei sujungimą. Taip pat gali būti naudinga nustatyti Github Issue ir PR šablonus, kaip tai padarėme savo oficialioje mazgo bibliotekoje.

Ar šis straipsnis buvo naudingas?