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: 19 days ago

OpenAI prižiūri bendruomenės bibliotekų puslapį, kuriame pateikiame API klientus, leidžiančius kūrėjams pasiekti OpenAI API.

Jei sukūrėte atvirojo kodo biblioteką ir norėtumėte, kad ją įtrauktume į šį puslapį, dėkojame! Džiaugiamės matydami, kaip kūrėjai kuria papildomas API priemones kitiems kūrėjams. Taip pat norime kūrėjams rekomenduoti patikimus sprendimus, kurie padėtų jiems sėkmingai dirbti ilgą laiką, todėl bibliotekas savo svetainėje skelbiame tik tuomet, kai jos atitinka kelis kriterijus.

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

  1. Standartinė atvirojo kodo licencija

Į sąrašą įtraukiamos tik tos bendruomenės bibliotekos, kurioms taikoma leidžiamoji atvirojo kodo licencija, pavyzdžiui, MIT. Tai leidžia mūsų klientams prireikus lengviau kurti bibliotekų atšakas, jei jų savininkai nustotų jas prižiūrėti ar plėsti.

  1. API raktų įkėlimas naudojant aplinkos kintamuosius

README pateikiami kodo pavyzdžiai turi skatinti OpenAI API raktą įkelti naudojant aplinkos kintamuosius, o ne tiesiogiai įrašyti jį šaltinio kode.

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

Kodas turi būti lengvai skaitomas ir suprantamas, taip pat iš esmės atitikti mūsų OpenAPI specifikaciją. Naujose bibliotekose neturi būti galinių taškų, šioje specifikacijoje pažymėtų deprecated: true.

  1. Nurodykite, kad biblioteka yra neoficiali

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

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

Tai visų pirma reiškia problemų sprendimą bei „pull request“ užklausų peržiūrą ir suliejimą. Taip pat verta sukurti „GitHub“ problemų ir PR šablonus, panašius į naudojamus mūsų oficialioje Node bibliotekoje.

Ar šis straipsnis buvo naudingas?