Dolphin uncensored API Документация

Предварительные требования и настройка окружения

Начните с обеспечения того, чтобы в вашей среде были установлены необходимые зависимости перед отправкой любых запросов. Вам понадобится активный API-ключ из нашей панели управления и поддерживаемый рантайм, такой как Python или Node.js. Наш API требует отправки запросов к определенному базовому URL, а не к стандартному эндпоинту OpenAI.

Храните ваш API-ключ в безопасности и сохраняйте его в переменной окружения. Это предотвращает случайное раскрытие в репозитории кода. Вы можете мгновенно сгенерировать новый ключ после регистрации через Google или email.

Вам не нужно настраивать сложную маршрутизацию или выбирать конкретные модели. Конечная точка обслуживает одну uncensored большую языковую модель, предназначенную для прямого текстового вывода.

Установка официального SDK OpenAI

Установите официальный пакет SDK для автоматической обработки аутентификации и форматирования запросов. Эта библиотека поддерживает среды Python и Node.js с согласованными интерфейсами.

Для пользователей Python выполните стандартную команду pip install, чтобы добавить библиотеку в ваше виртуальное окружение. Разработчики Node.js должны использовать npm для установки эквивалентного пакета.

SDK управляет структурой JSON-запроса за вас, поэтому вам нужно сосредоточиться только на содержании промпта и таких параметрах, как температура или top_p.

Вы можете проверить установку, импортировав библиотеку в ваш скрипт или модуль. Это гарантирует, что клиент готов к подключению к нашим серверам.

Настройка базового URL и API-ключа

Укажите базовый URL нашего SDK-клиента для нашего конкретного базового URL, чтобы направить запросы в нашу uncensored-инфраструктуру. Используйте https://api.dolphinuncensored.com/v1 в качестве вашего эндпоинта.

Установите API-ключ в заголовке авторизации или объекте конфигурации клиента. Клиент будет автоматически добавлять этот ключ к каждому запросу.

Убедитесь, что вы указываете идентификатор модели как "uncensored" в конфигурации. Это указывает серверу, какую версию модели использовать для генерации.

Выполнение первого запроса на создание чата

Отправьте простое сообщение, чтобы проверить подключение и получить ответ. Это подтверждает, что ваш ключ действителен, а эндпоинт доступен.

Используйте конечную точку chat-completions с системным промптом и сообщением пользователя. В ответе будет сгенерированный текст в поле content.

Понимание потоковой передачи и использования токенов

Включите потоковую передачу для получения токенов по мере их генерации, а не ожидания полного ответа. Это улучшает воспринимаемую задержку для длинных выводов.

API возвращает статистику использования в последнем фрагменте потока. Вы можете отслеживать количество входных и выходных токенов для прозрачности биллинга.

Установите параметр stream в true в теле запроса. Итерируйте по чанкам, чтобы собрать финальный текст или обработать его в реальном времени.

Обработка ошибок и отказов

Обрабатывайте ошибки HTTP 401, проверяя, что ваш ключ API корректен и не истек. Ошибка 402 указывает на недостаток предоплаченного кредита; пополняйте через криптовалюту, чтобы продолжить.

Статус 429 означает, что вы достигли лимита частоты запросов — 300 запросов в минуту. Подождите немного перед повторной попыткой или уменьшите количество одновременных запросов.

Модель отказывает в запросах, связанных с сексуальным контентом с участием несовершеннолетних, что является жестким ограничением. Другие спорные или взрослые темы обычно разрешены. Ошибки и отказы не расходуют ваш кредит токенов.

cURL

Copycurl https://api.dolphinuncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "fetch the list of installed python packages"}]
  }'

Python

Copyfrom openai import OpenAI

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

Потоковая передача

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)