Краткое руководство по API Mukenetsu AI

Базовая настройка и базовый URL

Mukenetsu AI спроектирован как REST API, совместимый с OpenAI. Это позволяет использовать существующие клиенты и SDK OpenAI с минимальными изменениями. Для связи с API используйте следующий базовый URL.

https://api.mukenetsuapi.com/v1

В отличие от других сервисов LLM, вам не нужно выбирать сложные эндпоинты или выполнять дополнительные настройки. Предоставляются только один эндпоинт чат-дополнения и эндпоинт списка моделей. Такая простая структура позволяет быстро вести разработку.

API-ключ можно получить сразу после регистрации на странице Получить API-ключ, указав адрес электронной почты и пароль. Действий в панели управления выполнять не нужно. Мы ценим конфиденциальность: данные промптов не используются для обучения модели.

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

Для доступа к API требуется аутентификация с помощью заголовка Authorization: Bearer <API_KEY>. Используйте API-ключ, сгенерированный при создании аккаунта Mukenetsu AI. На один аккаунт приходится один API-ключ, но при необходимости его можно перегенерировать в любое время. Обратите внимание: при перегенерации предыдущий ключ становится недействительным.

При возникновении ошибки аутентификации обычно возвращается ответ 401 (Unauthorized) или 402 (Payment Required). Код 401 означает, что ключ неверен или отозван, а 402 указывает на недостаток средств на балансе аккаунта. Кредиты являются предоплаченными; пополнить их можно на сумму от $10 с помощью криптовалют (USDT, USDC).

Эндпоинт чат-дополнения

Основной эндпоинт для генерации текста — POST /v1/chat/completions. Отправляя запрос на этот эндпоинт, вы можете генерировать текст, включая историю диалога и системный промпт. Укажите идентификатор модели uncensored. Это собственная модель с открытыми весами, которая отличается от моделей GPT от OpenAI и других поставщиков.

Следующий пример показывает, как выполнить базовую генерацию текста с помощью curl. Необходимые параметры — это идентификатор модели, сообщения и опционально включение потоковой передачи.

コピーcurl https://api.mukenetsuapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

На этом эндпоинте не предоставляются такие функции, как эмбеддинги (embeddings), генерация изображений или преобразование голоса. Он специализируется исключительно на дополнении и генерации текста.

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

Если вам нужно получать сгенерированный текст в реальном времени, используйте режим потоковой передачи. Если включить в запрос параметр "stream": true, сервер будет возвращать данные по частям в формате Server-Sent Events (SSE). Это позволяет отображать часть текста пользователю до завершения генерации.

Если вы используете SDK OpenAI для Python или клиентскую библиотеку для Node.js, потоковая обработка будет выполняться автоматически при указании параметра stream=True. Обработчик событий будет получать данные по токенам.

コピーfrom openai import OpenAI

client = OpenAI(base_url="https://api.mukenetsuapi.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 Mukenetsu AI поддерживает вызов функций (function calling). Это упрощает взаимодействие с внешними API и базами данных. Включив в тело запроса поле tools и параметр tool_choice, вы можете заставить модель выполнить определенную функцию.

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

コピーimport OpenAI from "openai";

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

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

Лимит запросов и ограничения

При использовании API действуют следующие ограничения: максимум 300 запросов в минуту и максимальный размер тела запроса — 8 МБ. При их превышении возвращается ошибка 429 (Too Many Requests). Размер контекстного окна составляет 100 000 токенов (сумма промпта и сгенерированного текста). Длинные диалоги или документы необходимо правильно разбивать перед отправкой.

При получении ответа потоковой передачи следуйте следующему потоку событий.

コピー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)

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