Venice API -dokumentaatio kehittäjille

Todennus ja base URL

Yhdistä välittömästi asettamalla base URL arvoksi https://api.veniceapi.com/v1 ja sisällyttämällä API-avaimesi Authorization header. Saat tämän avaimen välittömästi rekisteröitymisen jälkeen Googlen tai sähköpostin kautta. Tämä yksittäinen malli käsittelee kaikki tekstin tuotot ilman reitityksilogiikkaa. Sinun ei tarvitse hallita useita päätepisteitä tai välityspalvelinkokoonpanoja.

Pidä avaimesi turvassa. Jokaisessa tilissä voi olla vain yksi aktiivinen avain kerrallaan; uuden avaimen luominen mitätöi edellisen. Tämä varmistaa selkeän attribuoinnin tokenien käytölle ja laskutukselle.

Chat completions endpoint

Lähetä tekstipyyntöjä osoitteeseen /v1/chat/completions päätepiste standardien HTTP POST -menetelmien avulla. API hyväksyy JSON-syötteen, joka sisältää mallin nimen, järjestelmäohjeet ja käyttäjän viestit.

Tässä on peruspyynnön rakenne:

Copycurl https://api.veniceapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check if the service blocks adult content in the test endpoint"}]
  }'

Vastaus palauttaa luodun tekstin, tokenien käyttötilastot ja täydennyksen merkit. Voit säätää käyttäytymistä käyttämällä parametreja kuten temperature tai top_p. Nämä asetukset hallitsevat luovuutta ja satunnaisuutta tuloksessa.

Virheet palauttavat standardit HTTP-koodit. 401 tarkoittaa virheellistä avainta, kun taas 402 ilmoittaa riittämättömästä krediitistä. Käytä näitä koodeja virheiden käsittelyyn sujuvasti automaatiovuokausvuoroissasi.

Python SDK -integraatio

Käytä virallista OpenAI:n Python-kirjastoa censored-attymättömään LLM:ään. Määritä asiakasohjelma Venicen base URL:llä ja API-avaimesi. Tämä lähestymistapa yksinkertaistaa pyyntöjen rakentamista ja vastausten jäsentämistä.

Copyfrom openai import OpenAI

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

Tämä menetelmä toimii saumattomasti olemassa olevien koodikantojen kanssa, jotka on suunniteltu OpenAI:lle. Voit vaihtaa base URL -arvoa muuttamatta sovelluksesi logiikkaa merkittävästi. Kirjasto käsittelee serialisoinnin ja verkkoyhteydet automaattisesti.

Muista, että mallitunnuksen on asetettava arvoksi uncensored. Tämä varmistaa, että käytät Venicen tarjoamaa tiettyä hienosäädettyä mallia. Muut mallit eivät välttämättä näytä samoja käyttäytymismalleja.

Node SDK -integraatio

Integroi API JavaScript- tai TypeScript-projekteihin käyttämällä OpenAI Node SDK:ta. Aseta baseURL Venice-päätepisteeseen ja anna API-avaimesi. Tämä asennus tukee sekä synkronisia että asynkronisia operaatioita.

Copyimport OpenAI from "openai";

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

Tämä integraatio mahdollistaa chatbotien, sisällöntuottajien tai datan erottelutyökalujen rakentamisen nopeasti. SDK hallitsee pyynnön elinkaarta, mukaan lukien uudelleenyritykset ja virheenkäsittely. Voit välittää mukautettuja otsikoita tarvittaessa edistyneempiä käyttötapauksia varten.

Varmista, että tuot oikean version SDK:sta. Vanhemmat versiot eivät ehkä tue kaikkia Venice API:n tarjoamia ominaisuuksia. Tarkista yhteensopivuustiedot dokumentaatiosta.

Streamausvastaukset SSE:n kautta

Ota käyttöön reaaliaikainen tuloste asettamalla stream parametri true. API palauttaa Server-Sent Events (SSE) -virran valmiin JSON-objektin sijaan. Tämä mahdollistaa tokenien näyttämisen niiden tuotessa.

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)

Streamaus vähentää käyttäjien kokemaa viiveettä. Se on ihanteellinen chatrajapinnoille tai reaaliaikaisille kojelaudille. Streamin viimeinen lohko sisältää lopulliset token-käyttötilastot. Jäsennä tämä data tarkkaan kustannusten seurantaan.

Käsittele yhteyden katkokset joustavasti. Jos streami keskeytyy, voit yrittää pyyntöä uudelleen. API ei takaa järjestystä, jos useita streamauksia on aktiivisina samanaikaisesti. Seuraa nopeusrajoituksiasi tarkasti suurten kuormitusjaksojen aikana.

Virheenkäsittely ja rajat

API rajoittaa nopeutta 300 pyyntöön minuutissa avainta kohti. Samanaikaisia pyyntöjä voi olla enintään 8 avainta kohti. Pyyntöjen rungon koko ei saa ylittää 8 Mt. Näiden rajojen ylitys palauttaa virheen 429 Too Many Requests.

Kontekstuikkokoko on 100 000 tokenia promptin ja vastauksen yhteensä. Vastauksen maksimipituus yhdessä pyynnössä on 16 000 tokenia. Jos max_tokens ei ole asetettu, raja on oletusarvoisesti 2 048 tokenia. Suunnittele syötteet sen mukaisesti välttääksesi katkeamisen.

Yleiset virheet sisältävät 401 virheellisille avaimille ja 402 riittämättömälle krediitille. Käsittele nämä koodit ohjataksesi käyttäjiä lisäämään krediittejä. Käytä tukisivua laskutusongelmiin. Krediitit eivät vanhene, joten voit lisätä krediittejä myöhemmin.