Ollama API -dokumentaatio: Päätepisteviite

Perus-URL ja todennus

Kaikkien pyyntöjen base URL on https://api.ollamaapidocumentation.com/v1. Autentikoit käyttämällä Bearer-tokenia, joka välitetään Authorization header. Avain luodaan hallintapaneelissa ja se toimii välittömästi.

• Käytä virallisia OpenAI:n SDK-kirjastoja tai mitä tahansa yhteensopivaa asiakasohjelmaa.
• Aseta perus-URL yllä olevaan arvoon.
• Sisällytä API-avaimesi headeriin.

Todennus on tiukkaa. Jos avain puuttuu tai on virheellinen, API palauttaa 401-virheen. Tämä varmistaa käytön tarkkuuden laskutuksessa.

Chat Completions Endpoint: POST /v1/chat/completions

Lähetä viestit mallille osoitteessa POST /v1/chat/completions. Päätepiste hyväksyy JSON-rungon, jossa model kenttä asetettu "uncensored" ja messages tietorakenteella.

Tämä päätepiste tuottaa tekstiä. Se ei tue kuvia, ääntä tai videota. Voit virrata vastauksia tai odottaa koko tulosta.

Virheet kuten 402 viittaavat riittämättömään rahaan. Pyyntöjen laskutus perustuu todelliseen token-käyttöön. Rahavirheistä johtuvat hylkäykset ovat ilmaisia.

Malliluettelo: GET /v1/models

Hae saatavilla olevat mallit käyttämällä GET /v1/models. Tämä palauttaa listan malliobjekteista. Ainoa saatavilla oleva mallitunnus on "uncensored".

Tämä päätepiste auttaa varmistamaan yhteyden. Se vahvistaa, että perus-URL-osoite on oikein. Se näyttää myös mallin nimen ja objektityypin.

Käytä tätä yhdistelmäongelmien vianmääritykseen ennen raskaiden kuormien lähettämistä.

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

Säädä tuotantoa käyttämällä temperature, top_p, ja seed. The seed parametri varmistaa deterministiset tulokset. Käytä sitä vianetsintään tai johdonmukaisiin tuloksiin.

Aseta temperature välillä 0 ja 2. Alhaisemmat arvot tekevät vastauksista ennustettavampia. Korkeammat arvot lisäävät satunnaisuutta. Mallin top_p parametri suodattaa tokenit kumulatiivisen todennäköisyyden perusteella.

Nämä parametrit toimivat täsmälleen kuten OpenAI API. Voit yhdistää niitä tarkkaan tyylikontrolliin.

Streamausvastaukset ja merkkikäyttö

Ota streamaus käyttöön asettamalla stream: true. API palauttaa Server-Sent Events (SSE). Jokainen lohko sisältää osittaisen tekstin.

Viimeinen palikka sisältää token-käyttötilastot. Tämä mahdollistaa kustannusten laskemisen tarkasti. Voit käsitellä tokenkeja niiden saapuessa.

Streamaus vähentää viivettä. Se on ihanteellinen chatrajapinnoille. Palvelin pushaa dataa, kunnes vastaus on valmis.

Rajoitukset, virheet ja kontekstiikkuna

Kontekstiluukku on 100 000 tokenia. Tämä sisältää sekä syöte- että tulostokenit. Voit tuottaa enintään 16 000 tokenia pyyntöä kohden. Oletusarvoinen maksimituotanto on 2 048 tokenia.

Pyyntörajoitukset ovat 300 pyyntöä minuutissa. Voit tehdä 8 samanaikaista pyyntöä. Pyyntöruumiin koko on rajoitettu 8 Mt:iin.

Virheet sisältävät koodin 401 virheellisille avaimille ja koodin 429 nopeusrajoituksille. Rahavirheet palauttavat koodin 402. Nämä virheet ovat selkeitä ja toiminnallisia.

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

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