API-dokumentaatio

Pika-aloitus: Ensimmäinen pyyntösi

Lähetä ensimmäinen viesti uncensored-malliin heti. Käytä standardia chat-completions-päätepistettä tekstin luomiseen. Malli vastaa luonnollisen kielen prompteihin ilman sisältökieltoja lailliseen aikuisikäisen käyttöön. Tämä kokoonpano toimii minkä tahansa OpenAI-yhteensopivan asiakkaan kanssa.

Aloita haluamasi kielen SDK:n asennus. Määritä sen jälkeen API-avaimesi. Seuraava esimerkki näyttää perus-curl-pyynnön yhteyden testaamiseksi.

Voit säätää parametreja kuten temperature ohjataksesi satunnaisuutta. Vastaus palauttaa luodun tekstin suoraan. Tämä yksinkertainen virta mahdollistaa API:n toiminnan varmistamisen ennen monimutkaisen logiikan rakentamista.

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

Perus-URL ja todennus

Yhdistä käyttämällä omistautunutta base URL -osoitetta tähän API:hin. Korvaa oletuspäätepiste palvelimemme osoitteella. Tämä varmistaa, että pyyntösi saavuttavat rajoituksettoman mallin suoraan. Todennus perustuu yhteen API-avainten per tili.

Luo avimesi hallintapaneelista. Lisää se Authorization-otsakkeeseen Bearer-tokenina. Tämä menetelmä on yhteensopiva standardien OpenAI-SDK:iden kanssa. Voit vaihtaa tarjoajaa muuttamalla vain perus-URLia ja avainta.

Pidä avaimesi turvassa. Se myöntää täyden pääsyn varaukselliseen krediittiisi. Avain korvaa minkä tahansa edellisen aktiivisen avaimen välittömästi luomisen jälkeen.

Päätepisteet: Chat-kompletionit

Käytä mallia chat-completions-päätepisteen kautta. Tämä on ainoa käytettävissä oleva tekstin tuotantopäätepiste. Se hyväksyy viestit ja palauttaa tuotetun tekstin. Tuki ei sisällä upotuksia, kuvia tai ääntä.

Lähetä POST-pyyntö chat-reitille. Sisällytä järjestelmä- ja käyttäjviestit runkoon. Malli käsittelee kontekstin ja luo vastauksen. Voit käyttää JSON-tilaa rakenteisen tuloksen saamiseksi.

Function calling -toiminto tuetaan. Määritä työkalut ja anna mallin päättää, milloin niitä käytetään. Tämä joustavuus mahdollistaa monimutkaisten agenttivuorovaikutusten luomisen. Vastaukseen sisältyy luotu sisältö ja token-käyttö.

Copyfrom openai import OpenAI

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

Parametrit: Lämpötila, Top P ja Stop

Ohjaa tulosten tyyliä käyttämällä yleisiä parametreja. Säädä lämpötilaa muuttaaksesi luovuutta. Alhaisemmat arvot tekevät vastauksista deterministisempiä. Korkeammat arvot lisäävät monipuolisuutta.

Käytä top P -arvoa suodattamaan epätodennäköisiä sanoja. Tämä auttaa ylläpitämään koherenssia samalla kun sallitaan luovuutta. Aseta stop-sekvenssit päättämään generointi tietyillä merkeillä. Tämä on hyödyllistä dialogirakenteen hallinnassa.

Seed-parametri mahdollistaa toistettavissa olevat tulokset. Käytä sitä vianmäärityksessä. Nämä parametrit antavat sinulle tarkan hallinnan mallin käyttäytymisestä. Säädä niitä vastaamaan sovelluksesi tarpeita.

Copyimport OpenAI from "openai";

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

Streamaus ja token-käyttö

Vastaanota vastauksia reaaliajassa käyttämällä Server-Sent Events -tekniikkaa. Streamaus vähentää havaittua viivettä käyttäjille. API lähettää tokenit niiden luonnin aikana. Tämä luo sujuvamman lukukokemuksen.

Token-käyttö ilmoitetaan lopullisessa palassa. Tämä mahdollistaa kustannusten tarkan seurannan. Laskutus perustuu todelliseen kulutettuihin tokenien määrään. Virheet ja hylkäykset eivät aiheuta kustannuksia.

Ota käyttöön suoratoistokäsittelijä datan käsittelyyn. Päivitä käyttöliittymääsi tokenien saapuessa. Tämä lähestymistapa on ihanteellinen chat-liittymille. Malli tukee suoratoistoa kaikille pyyntotyypeille.

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)

Nopeusrajoitukset ja rajoitukset

Ymmärrä rajat välttääksesi palvelun keskeytykset. Voit tehdä 300 pyyntöä minuutissa avainta kohden. Samanaikaisten pyyntöjen määrä on rajoitettu kahdeksaan samanaikaisesti. Pyyntöruumiin koko ei saa ylittää 8 Mt.

Käsittele virheet joustavasti. 401-tila tarkoittaa, että avaimesi on virheellinen. 402-tila tarkoittaa riittämätöntä krediittiä. 429-tila merkitsee, että osuit nopeusrajoitukseen.

Kontekstiluukku tukee yhteensä 100 000 tokenia. Tämä sisältää sekä promptin että vastauksen. Maksimi vastauksen pituus on 16 000 tokenia pyyntöä kohden. Aseta max_tokens ohjaamaan vastauksen pituutta. Virheet ovat ilmaisia, joten retry-logiikka on turvallista.