OpenAI-yhteensopiva API-dokumentaatio

Edellytykset: SDK ja perus-URL

Aloita asentamalla haluamasi kirjasto ja osoittamalla se päätepisteeseemme. The base_url on https://api.apicompatible.com/v1. Tämä OpenAI-yhteensopiva API-dokumentaatio vahvistaa, että vakiot kirjastot toimivat välittömästi. Sinun ei tarvitse reititintä tai monimutkaista porttia. Vaihda URL-osoite ja avain, ja aja olemassa oleva koodisi.

Todennus: Header ja avaimen muoto

Lähetä avaimesi kohtaan Authorization header. Käytä muotoa Bearer your_api_key. API:n avin rakenne noudattaa standardia OpenAI-yhteensopivaa rakennetta. Avit luodaan välittömästi Google- tai sähköpostilogin kautta. Pidä avisi turvassa, sillä se antaa pääsyn esimaksutille.

Chat Completions Endpoint

Lähetä pyyntöjä osoitteeseen /v1/chat/completions. Määritä malli arvoksi uncensored. API palauttaa tekstimuotoisia vastauksia suoraan. Varmista yhteys seuraavalla curl-komennolla:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

Tämä OpenAI-SDK-yhteensopiva lähestymistapa varmistaa, että saat rajoittamatonta tekstigenerointia. Malli käsittelee monimutkaisia syötteitä ilman tarpeettomia hylkäyksiä lailliselle sisällölle.

Streamausvastaukset SSE:n kanssa

Ota streamaus käyttöön asettamalla stream: true. Vastaukset saapuvat Server-Sent Events (SSE) -tekniikalla. Token-käytön tiedot näkyvät viimeisessä osassa. Tämä OpenAI-yhteensopiva API-dokumentaatio tukee standardia streamausta. Käytä tätä reaaliaikaisiin käyttäjäkokemuksiin:

Copyfrom openai import OpenAI

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

Streamaus vähentää huomattavasti käyttäjien kokemaa viiveettä. Se toimii saumattomasti standardien asiakaspääkirjastojen kanssa.

Parametrit: lämpötila, Top-P ja työkalut

Säädä tuotantoa käyttämällä yleisiä parametreja. Aseta temperature satunnaisuudelle tai top_p ytimenäytteistykseen. Ota käyttöön tools funktiokutsuille. JSON-tila on saatavilla käyttämällä response_format. The uncensored malli kunnioittaa näitä rajoituksia tehokkaasti:

Copyimport OpenAI from "openai";

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

Nämä parametrit mahdollistavat hienosäädetyn kontrollin tuotostyyliin. Voit pakottaa tiukat JSON-rakenteet ohjelmallisiin käyttötarkoituksiin.

Rajoitukset: Nopeusrajoitukset ja ruumiin koko

Jokainen avain sallii 300 pyyntöä minuutissa. Samanaikaisia pyyntöjä on rajoitettu 8 kpl avainta kohden. Pyynnön maksimirunkokoko on 8 MB. Kontesttilaakso tukee yhteensä 100,000 tokenia. Käsittele 401-virheet tarkistamalla avaimesi. Ratkaise 402-virheet lataamalla saldoa. Hallitse 429-virheitä toteuttamalla viive-logiikka.

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)