API-dokumentaatio kehittäjille

Perus-URL ja todennus

Yhdistä infrastruktuuriimme osoittamalla asiakasohjelmasi määrättyyn base URL:iin ja toimittamalla ainutlaatuisen API-avaimesi. Käytämme vakiokirjastoja otsikkotodennusta, joten voit vaihtaa päätepisteen olemassa oleviin OpenAI SDK -määrityksiin ilman ydinkoodin uudelleenkirjoittamista. Saat yhden aktiivisen avaimen tilille, ja uuden avaimen luominen mitätöi välittömästi edellisen. Tämä suunnittelu pitää integraation yksinkertaisena samalla kun ylläpidetään selkeää pääsynvalvontaa. Rekisteröidy Google- tai sähköpostitunnuksella nähdäksesi avaimesi välittömästi. Emme vaadi puhelinnumeroa tai maksutapaa aloittamiseen.

• Base URL: https://api.uncensoreai.com/v1
• Auth-otsake: Authorization: Bearer YOUR_API_KEY

Ensimmäinen pyyntö (POST /v1/chat/completions)

Lähetä ensimmäinen täydennys lähettämällä JSON-tietopaketti chat-valmiuspäätepisteeseen. Mallin tunnus on uncensored ja se tukee standardia viestirakennetta, jossa on järjestelmä-, käyttäjä- ja avustajarooleja. Saat välittömän tekstituloksen ilman monimutkaista reititystä tai mallivalintalogiikkaa. Virheet eivät kuluta esimaksullisia krediittejäsi, joten voit testata vapaasti. Malli käsittelee avoimen painotuksen tuottamaa sisältöä, joka on hienosäädetty aikuisille tarkoitetulle sisällölle ilman hylkäämistä. Käytä tätä rakennetta aloittaaksesi integraation.

Python SDK -integraatio

Käytä virallista Python-asiakasohjelmaa vuorovaikutukseen API:n kanssa saumattomasti. Aseta base URL ja API-avain asiakasobjektissa ennen kutsujen tekemistä. Kirjasto käsittelee JSON-serialisoinnin ja vastauksen jäsentämisen puolestasi. Voit hakea käyttödataa suoraan vastausobjektista. Tämä lähestymistapa toimii missä tahansa standardissa Python-ympäristössä, joka tukee async- tai sync-pyyntöjä. Pidä avain turvallisesti ympäristömuuttujissa. Koodiesimerkki demonstroi perussynkronista kutsua.

Node.js SDK:n integraatio

Integroi Node.js-projekteihin käyttämällä standardia paketinhallintaa. Tuo asiakas ja määritä base URL -arvo osoittamaan palvelimiimme. SDK hallitsee HTTP-pyyntöjä ja tarjoaa tyyppitarkkoja vastauksia TypeScript-käyttäjille. Voit helposti lisätä otsikoita tai muuttaa aikakatkaisuja tarvittaessa. Tämä menetelmä sopii nykyaikaisiin web-sovelluksiin ja taustapalveluihin. Varmista, että Node-versiosi on yhteensopiva SDK:n vaatimusten kanssa. Seuraava esimerkki näyttää yksinkertaisen täydennyspyynnön.

Streamausvastaukset ja merkkikäyttö

Ota käyttöön reaaliaikainen tuloste asettamalla stream arvoon true pyynnössäsi. API palauttaa Server-Sent Eventsin (SSE), kun tokenit generoidaan. Voit näyttää tekstin käyttäjille välittömästi odottamatta koko vastausta. Token-käyttötilastot ilmestyvät streamin viimeiseen palautukseen. Tämä ominaisuus vähentää koettua viivettä pitkissä tuloksissa. Seuraa saldoasi tokenien kertyessä. Streamaus toimii kaikkien vakioparametrien kanssa kuten temperature ja stop sequences.

Rajoitukset, virheet ja kontekstiikkuna

Tililläsi on 100 000 tokenin kontekstiikkuna promptille ja completionille yhteensä. Voit lähettää enintään 16 000 tokenia yhdessä vastauksessa, jos määrität max_tokens. Vakio lähtöraja on 2 048 tokenia, jos jätät tämän parametrin pois. Nopeusrajoitukset sallivat 300 pyyntöä minuutissa ja 8 samanaikaista pyyntöä avainta kohden. Virhekoodi 401 tarkoittaa, että avaimesi on virheellinen. Virhekoodi 402 tarkoittaa riittämätöntä esimaksattua saldoa. Virhekoodi 429 tarkoittaa, että ylityt nopeusrajoituksen. Pyynnön rungon koko ei voi ylittää 8 Mt.

cURL

Copycurl https://api.uncensoreai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "fetch the current server status from the api endpoint"}]
  }'

Python

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.uncensoreai.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.uncensoreai.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

Virtaus

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)