API-dokumentaatio & Quickstart

Perus-URL ja todennus

Aloita asettamalla perus-URL-osoitteesi osoitteeseen HTTPS://api.uncensoredal.com/v1 ja välittämällä API-avaimesi Authorization-päätteeseen. Saat yhden aktiivisen avaimen per tili, ja uuden avaimen luominen mitätöi välittömästi edellisen avaimen. Tämä yksinkertainen asetustapa toimii minkä tahansa standardin OpenAI-yhteensopivan asiakkaan kanssa ilman monimutkaista reitityksensä hallintaa.

Copycurl https://api.uncensoredal.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate the next 50 lines of a python script"}]
  }'

Päätepiste on tarkoitettu vain keskustelulopetuksiin, joten sinun ei tarvitse hallita mallien reititystä. Jokaisessa pyynnössä on sisällytettävä mallitunnus "uncensored" varmistaaaksesi, että osut oikeaan johtopäätöspalvelimeen. Todennusvirheet palauttavat 401-tilan, jos avain puuttuu tai on virheellinen.

Chat Completions Endpoint

Lähetä POST-pyyntö osoitteeseen /v1/chat/completions viestihistoriasi messages-taulukon kera. Järjestelmä käsittelee tekstisyötteen ja palauttaa luodun tekstin ilman sisältökieltoja lailliseen aikuisille suunnattuun käyttöön. Sinun on määritettävä malli arvoksi "uncensored" pyyntörunkossasi varmistaaksesi yhteensopivuuden.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.uncensoredal.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)

Pyyntöjen laskutus perustuu todelliseen tokenien käyttöön, ja virheet sekä hylkäykset ovat ilmaisia. Tämä esimaksullinen malli tarkoittaa, että maksat vain käyttämästäsi määrästä. päätepiste tukee vakio-parametreja kuten temperature ja top_p tulosten satunnaisuuden hallitsemiseksi.

Streamausvastaukset SSE:n kanssa

Ota streamaus käyttöön asettamalla stream arvoksi true pyynnön runkossa saadaksesi tokenit Server-Sent Events -tapahtumien kautta. Jokainen lohko sisältää token-käyttötilastot viimeisessä lohkoissa, mikä mahdollistaa kustannusten seurannan reaaliajassa. Tämä lähestymistapa vähentää havaittua viivettä pitkissä generoinneissa.

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)

Käytä streamausta rakentaessasi chat-liittymiä, jotka tarvitsevat tekstin näyttämistä sen tuotannon aikana. API palauttaa standardit OpenAI-yhteensopivat stream-tapahtumat, mikä tekee integroinnista olemassa oleviin UI-kirjastoihin helppoa. Voit keskeyttää streamin aikaisin, jos käyttäjä muuttaa syötettään.

Funktikutsut ja JSON-tila

Määritä työkalut pyyntöön mahdollistaaksesi funktiokutsut tai pakottaaksesi JSON-tuloksen response_formatilla. API tukee tool_choicea tarkkaan kontrolliin, milloin mallin tulisi kutsua funktiota. Tämä ominaisuus toimii standardin OpenAI-skeeman kanssa, joten voit käyttää olemassa olevia työkelumäärityksiä uudelleen.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.uncensoredal.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);

JSON-tila varmistaa, että tuloste on kelvollista JSON-tietoa, mikä on hyödyllistä rakenteisen datan ohjelmoitavaan jäsentämiseen. Voit yhdistää tämän temperature-asetusten kanssa tasapainottaaksesi luovuutta ja rakenteellista luotettavuutta. API käsittoo työkalujen suorituslogiikan palauttamalla function call -tiedot, joiden käsittely on koodisi tehtävä.

Malliparametrien määritys

Määritä parametreja kuten lämpötilaa, top_p:tä, stop-sekvenssejä ja siemenarvoa hallitaksesi luontikäyttäytymistä. Kontekstiikkuna tukee 100 000 tokenia sekä promptille että täydennykselle yhteensä. Maksimi syöttö on rajattu 16 000 tokeniin pyyntöä kohden tai 2 048:aan, jos et määritä max_tokensia.

Voit käyttää presence_penalty- ja frequency_penalty-parametreja vähentämään toistoa pidemmissä teksteissä. Nämä parametrit mahdollistavat mallin tyylin hienosäädön ilman peruspainojen muuttamista. Säädä niitä asteittain löytääksesi oikean tasapainon tiettyyn käyttötarkoitukseen.

Rajoitukset, virheet ja konteksti

Nopeusrajoitukset on asetettu 300 pyyntöön minuutissa ja 8 samanaikaiseen pyyntöön avainta kohti. Pyyntöjen rungot on rajattu 8 MB:iin, joten suurten kontekstiikkkunoiden hallintaa on hoidettava huolellisesti. Virheet sisältävät 401 virheellisistä avaimista, 402 riittämättömästä luotosta ja 429 nopeusrajoista.

Luotto ei vanhene, joten voit keskeyttää käytön puristusten välillä menettämättä varoja. Jos osut yhtäaikaisiin rajoituksiin, yritä uudelleen eksponentiaalisella viiveellä. 100 000 tokenin konteksti-ikkuna mahdollistaa laajan historian, mutta pidä silmällä tulosten rajoituksia välttääksesi katkaisemisen.