cs ▾

Dokumentace Ollama API: Rychlý start

Tento průvodce poskytuje konkrétní detaily našeho API kompatibilního s OpenAI, což vám umožní nahradit model naším modelem bez cenzury bez změny kódu vašeho existujícího klienta.

Základní URL a ověření

Základní URL je HTTPS://api.ollamaapidocs.com/v1. Klíč zadejte do standardní hlavičky Authorization.

curl https://api.ollamaapidocs.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List installed models in the local directory"}]
  }'

Endpoint Chat Completions

Odesílejte požadavky POST na /v1/chat/completions s modelem nastaveným na uncensored.

from openai import OpenAI

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

Podpora streamování a nástrojů

Povolte streamování nastavením stream na true. API vrací tokeny prostřednictvím Server-Sent Events a podporuje volání funkcí.

stream = 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)

Režim JSON a parametry

Použijte response_format json_object pro přísný výstup JSON. Můžete také upravit teplotu, top_p a sekvence zastavení.

import OpenAI from "openai";

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

Limity rychlosti a omezení

Limit je 300 požadavků za minutu na klíč. Každý požadavek podporuje kontextové okno 100 000 tokenů.

curl https://api.ollamaapidocs.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List installed models in the local directory"}]
  }'

Chyby a kontextové okno

Zvládněte chyby 401 pro neplatné klíče, 402 pro nedostatek kreditu a 429 pro omezení rychlosti. Model podporuje kontextové okno o velikosti 100,000 tokenů.

from openai import OpenAI

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

Časté otázky

Jaká je dokumentace API ollama pro tuto službu?

Tento průvodce pokrývá základní URL, ověřování a endpointy pro naše hostované API. Umožňuje vám použít standardní sady OpenAI SDK s naším modelem bez cenzury.

Jak řešit odpovědi ve formátu streamování?

Nastavte parametr stream na true ve svém požadavku. API vrací tokeny prostřednictvím Server-Sent Events, což umožňuje zpracování v reálném čase.

Co se stane, pokud překročím limit rychlosti?

Obdržíte stavový kód 429. Limit je 300 požadavků za minutu na klíč, s maximálním počtem 8 souběžných požadavků.

Generujte svůj API klíč

Zaregistrujte se, zkopírujte svůj klíč a aktualizujte základní URL. To je vše, co potřebujete k zahájení.

Vytvářejte klíč