API Ollama: Быстрый старт
Это руководство содержит конкретные детали нашего OpenAI-compatible API, позволяющие заменить модель на нашу uncensored без изменения кода вашего существующего клиента.
Базовый URL и аутентификация
Базовый URL: HTTPS://api.ollamaapidocs.com/v1. Передайте ключ в стандартном заголовке 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"}]
}'
Эндпоинт Chat Completions
Отправляйте запросы POST на /v1/chat/completions, установив модель в 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)
Поддержка потоковой передачи и инструментов
Включите потоковую передачу, установив stream в true. API возвращает токены через события, отправляемые сервером, и поддерживает вызов функций.
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)
Режим JSON и параметры
Используйте response_format json_object для строгого вывода JSON. Вы также можете настроить temperature, top_p и последовательности stop.
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);
Лимиты запросов и ограничения
Лимит составляет 300 запросов в минуту на ключ. Каждый запрос поддерживает контекстное окно на 100 000 токенов.
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"}]
}'
Ошибки и контекстное окно
Обрабатывайте ошибки 401 для недействительных ключей, 402 при отсутствии средств и 429 при превышении лимитов. Модель поддерживает контекстное окно на 100,000 токенов.
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)Частые вопросы
Какова документация API ollama для этой службы?
Это руководство охватывает базовый URL, аутентификацию и конечные точки нашего размещенного API. Оно позволяет использовать стандартные SDK OpenAI с нашей uncensored моделью.
Как обрабатывать потоковые ответы?
Установите параметр stream в true в запросе. API возвращает токены через Server-Sent Events, позволяя обрабатывать их в реальном времени.
Что произойдет, если я превышу лимит частоты запросов?
Вы получите код статуса 429. Лимит составляет 300 запросов в минуту на ключ, с максимумом 8 параллельных запросов.
Генерируйте свой API-ключ
Зарегистрируйтесь, скопируйте свой ключ и обновите базовый URL. Вот и всё, что нужно для начала.