Pika-aloitus: Chat Completions API

Edellytykset ja perus-URL

API-mme on yhteensopiva standardin OpenAI-chat-kompletointirajapinnan kanssa. Tarvitset vain base URL -arvon ja API-avaimen aloittaaksesi pyyntöjen lähettämisen. Base URL on HTTPS://api.howmuchisanapikey.com/v1. Tämä yksittäinen päätepiste käsittelee kaikki tekstimuodostukset ilman, että sinun tarvitsee hallita useita palvelun URL-osoitteita tai välityspalvelinkonfiguraatioita.

Todennus on suoraviivaista. Sinun on sisällytettävä Authorization-otsikkotiedot Bearer-skeemalla ja yksilöllisellä avaimellasi. Jokaisessa chat completions -päätepisteen pyynnössä vaaditaan tämä otsikkotieto tiliisi vahvistamiseksi ja token-käytön seurannaksi ennakkomaksusaldosi suhteen.

Todennus ja otsikot

Sisällytä Authorization-headeri jokaiseen pyyntöön vahvistaaksesi identiteettisi. Headerin muoto on Authorization: Bearer YOUR_API_KEY. Jos avain on virallinen tai vanhentunut, API palauttaa 401-virheen välittömästi. Tämä varmistaa, että vain valtuutetut tilit voivat kuluttaa esimaksullista krediittiäsi.

Et tarvitse välittää lisäpäätteitä perustekstigenointiin. Kuitenkin, jos käytät tiettyjä ominaisuuksia kuten JSON-tilaa tai funktiokutsuja, sinun täytyy asettaa Content-Type -pääte arvoksi application/json. Tämä kertoo palvelimelle, miten jäsentää pyyntösi runko oikein.

Lähettämällä ensimmäinen chat-completion

Lähetä POST-pyyntö osoitteeseen /v1/chat/completions viestihistoriasi ja mallitunnuksen kera. Mallitunniste on "uncensored". Tämä malli on hienosäädetty vastaamaan ilman kieltoja lailliseen aikuisille suunnattuun sisältöön, fiktiiviseen sisältöön tai kiistanalaisiin aiheisiin. Se ei suodata standardien poliittisten tai sosiaalisten normien perusteella.

Tässä on perus curl-esimerkki aloittamiseen:

Copycurl https://api.howmuchisanapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a simple hello world function in python"}]
  }'

Vastaus sisältää luodun tekstin choices-taulukossa. Voit jäsentää tämän suoraan sovelluslogiikkaasi. Jokainen pyyntö kuluttaa syötetokenneja kehotteellesi ja tulostokennejä mallin vastaukselle.

Virtaavat vastaukset ja tokenien käyttö

Käytä Server-Sent Events (SSE) vastaanottaaksesi tokenit niiden generoitumisen aikana. Tämä vähentää havaittua viivettä pitkissä tuloksissa. Aseta stream-parametri arvoksi true pyynnön runkossa. Palvelin lähettää useita palasia, joista kukin sisältää osittaisen delta-vastauksen.

Viimeinen palikka sisältää käyttödatan. Tämä olio sisältää pyynnön kuluttamat syöte- ja tulostokenit. Voit käyttää näitä tietoja paikallisen krediittisalton päivitykseen tai kulujen seurantaan reaaliajassa. Streaming on ihanteellinen chat-käyttöliittymissä, joissa käyttäjät odottavat välitöntä palautetta.

Function calling ja JSON-tila

API tukee rakenteista lähtöä JSON-tilan ja funktiokutsujen kautta. Aseta response_format arvoksi {"type": "json_object"} pakottaaksesi mallin palauttamaan validin JSON-tiedoston. Tämä on hyödyllistä datan erottamiseen tai rakenteisten asetusten generointiin ilman jäsenointivirheitä.

Funktionsaannissa tarjoa pyynnössäsi tools-taulukko. Malli vastaa tool_calls-tietueella, jos se päättää funktion olevan tarpeen. Voit sitten suorittaa funktion ja lähettää tuloksen takaisin mallille. Tämä mahdollistaa monimutkaisten monivaiheisten työvuorojen hallinnan ilman ulkoista jäsentämislogiikkaa.

Rajojen ja virheiden käsittely

Sinulla on rajoitus 300 pyyntöä minuutissa per avain ja 8 samanaikaista pyyntöä. Jos ylität nämä rajat, saat virhekoodin 429 Too Many Requests. Vastauksen ruumiassa on retry-after-tiedot. Säätä asiakkaan puolen rajoitusta välttääksesi tarpeettomat uudelleenyrittämiset.

Kun esimaksukrediittisi on loppu, API palauttaa virheen 402 Payment Required. Voit ladata krediittiä kryptovaluutalla milloin tahansa. Virheet ja hylkäykset ovat ilmaisia, joten maksat vain onnistuneesta tokenien generoinnista. Kontekstiikkuna on 100,000 tokenia promptin ja vastauksen yhteensä.

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

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)