API-dokumentaatio: Pika-aloitusopas

Perus-URL ja todennus

Heretic AI API on täysin OpenAI-yhteensopiva. Voit käyttää sitä osoittamalla asiakasohjelmasi base URL:iimme: https://api.hereticai.cc/v1. Todennus perustuu yhteen API-avaimeseen per tili, joka luodaan välittömästi rekisteröitymisen jälkeen Google- tai sähköpostitunnuksella. Välitä tämä avain Authorization header Bearer-tokenina. Mallin tunnisteen on yksinkertaisesti uncensored. Tämä yksittäinen malli käsittelee kaikki pyyntösi ilman reitityksen monimutkaisuutta. Virheet kuten 401 viittaavat virheelliseen avaimeseen, kun taas 402 tarkoittaa, että tarvitset enemmän esimaksua kryptovaralla.

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

Chat Completions Endpoint

Lähetä tekstipyyntöjä käyttäen POST /v1/chat/completions päätepiste. API odottaa standardia viestitaulukkoa, joka sisältää keskusteluhistoriasi tai syöteesi. Se palauttaa luodun tekstin kenttään choices taulukkoa. Tämä on puhtaasti hyötysovellus: teksti sisään, teksti ulos. Maksat vain kulutetuista tokenneista. Esimaksullinen luottosaldo ei vanhene, ja kieltojen tai virheiden aiheuttamat kulut eivät kuluta tokenneja. Tämä tapa poistaa tilauslukot ja ennustamattomat ilmaisversiot.

Copyfrom openai import OpenAI

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

Streamausvastaukset (SSE)

Ota reaaliaikainen tokenin streamaus käyttöön asettamalla stream: true pyynnössäsi. API palauttaa palvelimen lähettämiä tapahtumia (SSE) jokaiselle tuotetulle tokenille. Tämä mahdollistaa tulosteen porrastetun näyttämisen, mikä on kriittistä viiveherkille sovelluksille. Tokenien käyttötilastot näkyvät streamin viimeisessä palasessa. Tämä toiminto toimii saumattomasti standardien OpenAI-SDK:iden kanssa, jotka käsittelevät SSE:tä automaattisesti. Se tarjoaa välitöntä palautetta odottamatta koko täydentymistä.

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)

Funktikutsut ja työkalut

API tukee työkalujen kutsumista tools ja tool_choice parametrit. Määrittele työkalujen skeemat pyynnössä, ja malli palauttaa rakenteellisia funktiokutsuja, kun se on asianmukaista. Tämä mahdollistaa monimutkaiset työvuorot, joissa LLM päättää seuraavan toiminnon. Voit pakottaa tietyn työkalun käytön tai antaa mallin valita vapaasti. Tämä ominaisuus on olennainen agentic-sovellusten rakentamisessa, jotka vuorovaikuttavat ulkoisten järjestelmien tai tietokantojen kanssa.

JSON-tila

Varmista deterministinen tulos asettamalla response_format vastaan {"type": "json_object"}. Malli rajoittaa vastauksensa kelvolliseen JSON-muotoon, mikä on ratkaisevaa ohjelmointijäsentämiseen. Tämä vähentää tarvetta jälkikäsittelyyn regex-korjauksille. Se takaa, että tuotos voidaan kuluttaa suoraan koodissasi. Tämä on erityisen hyödyllistä rakenteellisen datan erottelussa tai konfiguraatiogeneroinnissa.

Parameters and Limits

Säädä tuotantoa käyttämällä yleisiä parametreja kuten temperature, top_p, ja seed. Kontekstityöpöytä on 100 000 tokenia syötteelle plus täydennykselle. Maksimilähtö on 16 000 tokenia pyyntöä kohden tai 2 048, jos max_tokens ei ole asetettu. Nopeusrajoitukset ovat 300 pyyntöä minuutissa ja 8 samanaikaista pyyntöä avainta kohti. Pyyntöruumiin koko pysyttään alle 8 Mt. Nämä rajat varmistavat vakaan suurten volyymien käytön kehittäjille.

Node.js

Copyimport OpenAI from "openai";

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