Быстрый старт: Подключение за несколько минут

1. Установите ваш SDK

Начните с установки официальной библиотеки для вашего языка. Большинство разработчиков предпочитают стандартный пакет, так как он соответствует интерфейсу, который они уже знают. Выполните pip install openai для Python или npm install openai для Node.js. Вам нужен только один SDK для обработки всех запросов.

2. Установите базовый URL

Настройте клиент на указание на наш конкретный эндпоинт. Вам необходимо переопределить базовый URL по умолчанию для правильной маршрутизации трафика. Используйте https://api.unsencoredai.com/v1 в качестве базового URL. Передайте ваш API-ключ в Authorization header. Эта настройка работает с любым стандартным клиентом, совместимым с OpenAI.

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

3. Отправьте свой первый запрос

Отправьте стандартный запрос chat completion для генерации текста. Идентификатор модели — uncensored. Вы можете отправлять системные подсказки для управления поведением. API возвращает прямой текстовый ответ. Используйте приведенную ниже команду curl для немедленной проверки подключения. Проверьте ответ на наличие choices массив.

Copycurl https://api.unsencoredai.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the version number"}]
  }'

4. Обработка потоковых ответов

Включите потоковую передачу для снижения задержки и вывода в реальном времени. Установите stream: true в вашем запросе. API отправляет чанки через Server-Sent Events. Вы можете обрабатывать каждый токен по мере его поступления. Это идеально подходит для чат-интерфейсов или сценариев ролевой игры. Последний чанк содержит статистику использования.

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)

5. Настройка параметров

Настроить temperature, top_p, и stop последовательности. Эти элементы управления влияют на креативность и длину вывода. Вы также можете использовать response_format для режима JSON. Размер контекстного окна поддерживает 100,000 токенов в общей сложности. Максимальный вывод — 16,000 токенов за запрос. Настройте эти параметры для вашего конкретного случая использования.

6. Ограничения, ошибки и контекст

Корректно обрабатывайте ошибки, используя стандартные коды состояния HTTP. Ошибка 401 означает, что ваш API-ключ недействителен. Ошибка 402 указывает на недостаточный предоплаченный кредит. Ошибка 429 сигнализирует о достижении лимита в 300 запросов в минуту. Размер контекстного окна составляет 100,000 токенов. Запросы объёмом более 8 МБ могут завершиться ошибкой. Возврат средств за кредит не производится, но ошибки бесплатны.