Документация API для Uncensored Chat Completions

Быстрый старт: Подключение на Python или JavaScript

Подключитесь к API, обновив базовый URL и установив ключ API. Эндпоинт принимает стандартные запросы завершения чата и возвращает текст. Вам не нужно устанавливать пользовательские библиотеки, если вы используете официальные SDK OpenAI, так как интерфейс в точности соответствует их спецификации.

Начните с простого HTTP-запроса для проверки подключения. Используйте команду curl ниже, чтобы отправить базовый промпт в uncensored модель. Замените YOUR_API_KEY с ключом, сгенерированным на панели управления.

Copycurl https://api.aiplayrolebest.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set the character persona to a grumpy detective"}]
  }'

Для разработчиков Python процесс почти идентичен. Инициализируйте клиент с вашим ключом и правильным базовым URL. Это гарантирует, что все запросы маршрутизируются через наши нецензурируемые серверы, сохраняя совместимость с существующими инструментами.

Copyfrom openai import OpenAI

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

Пользователи JavaScript могут достичь того же результата, используя Node SDK. Установите baseURL свойство с нашим конечным пунктом. Этот подход позволяет интегрировать API в веб-серверы или бэкенд-сервисы с минимальными изменениями в коде.

Copyimport OpenAI from "openai";

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

Аутентификация и управление API-ключами

Аутентификация основана на одном API-ключе, передаваемом в заголовке. Передайте этот ключ в Authorization header для каждого запроса. Если ключ отсутствует или недействителен, API немедленно возвращает ошибку 401. Это обеспечивает безопасный доступ к вашему предоплаченному кредиту.

Сгенерируйте ключ на панели управления. Ключ отображается один раз при создании. Сохраните его в безопасном месте в переменных окружения. Не публикуйте его публично. У каждого аккаунта может быть только один активный ключ. Генерация нового ключа мгновенно делает предыдущий недействительным.

Используйте ключ в своих запросах следующим образом: Authorization: Bearer YOUR_API_KEY. Этот стандартный формат заголовка работает со всеми основными SDK. Держите ваш ключ под рукой для быстрой итерации во время разработки.

Параметры эндпоинта Chat Completions

Отправляйте запросы на /v1/chat/completions endpoint. endpoint. Включите массив сообщений и установите модель на uncensored. Вы можете настроить параметры, такие как temperature и top_p для управления креативностью. Высокие значения дают более разнообразные ответы.

Установить max_tokens для ограничения длины вывода. По умолчанию 2 048 токенов, если не указано. Модель поддерживает окно контекста в 100 000 токенов для промпта плюс завершение. Это позволяет вести длинные диалоги без усечения. Настройте presence_penalty и frequency_penalty для уменьшения повторов в сценариях ролевой игры.

Используйте stop параметр для остановки генерации по определённым фразам. Это помогает обеспечить структуру диалога. Этот seed parameter обеспечивает воспроизводимые результаты для тестирования. Эти инструменты дают вам точный контроль над поведением модели.

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

Включите потоковую передачу, установив stream: true в вашем запросе. API возвращает фрагменты текста по мере их генерации. Это снижает воспринимаемую задержку для конечных пользователей. Каждый фрагмент включает частичный текст и метаданные.

Данные об использовании отображаются в последнем блоке. Они включают количество входных и выходных токенов. Проверьте usage field в последнем объекте ответа. Это позволяет точную проверку биллинга без отдельных вызовов API. Отслеживайте потребление токенов в реальном времени.

Тщательно обрабатывайте завершение потока. Убедитесь, что вы обрабатываете все чанки перед закрытием соединения. Последний чанк содержит полную статистику использования. Эти данные необходимы для мониторинга затрат и производительности в производственных приложениях.

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)

Обработка ошибок и лимиты частоты запросов

API ограничивает количество запросов до 300 в минуту на ключ. Одновременные запросы ограничены восемью на ключ. Тело запроса не должно превышать 8 МБ. Превышение этих лимитов возвращает ошибку 429. Реализуйте экспоненциальное замедление с откатом для обработки временных пиков.

Типичные ошибки включают 401 для неверных ключей и 402 для недостаточного кредита. Ответ 402 указывает на то, что ваш предоплаченный баланс исчерпан. Пополните счет, чтобы возобновить работу. Ошибки не списывают токены, поэтому повторная попытка после исправления проблемы бесплатна.

Проверьте тело ответа на наличие подробных сообщений об ошибках. API возвращает объект JSON с типом ошибки и сообщением. Используйте эту информацию для быстрой отладки проблем. Правильная обработка ошибок обеспечивает плавный опыт для ваших пользователей в периоды высокой нагрузки.

руководство по режиму JSON и вызову функций

Используйте режим JSON, установив response_format для {"type": "json_object"}. Это заставляет модель выводить валидный JSON. Идеально подходит для извлечения структурированных данных или ответов API. Убедитесь, что ваш запрос четко описывает желаемую схему.

Вызов функций позволяет модели вызывать инструменты. Определите инструменты в теле запроса. Модель возвращает вызовы инструментов, когда это уместно. Обрабатывайте эти вызовы в логике вашего приложения. Это позволяет создавать сложные многоэтапные рабочие процессы.

Сочетайте режим JSON с вызовом функций для надежных интеграций. Проверяйте JSON-вывод на стороне клиента. Используйте tool_choice параметр, управляющий моментом вызова функций. Эта гибкость поддерживает различные архитектуры приложений. Убедитесь, что ваши инструменты хорошо определены для оптимальной производительности.

Подробности о модели и ограничения контекстного окна

The uncensored модель поддерживает контекстное окно на 100,000 токенов. Это включает как входной запрос, так и выходное дополнение. Максимальный объем вывода составляет 16,000 токенов за запрос. Это позволяет создавать обширные сценарии ролевых игр без обрыва текста на полуслове.

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

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