Швидкий старт: uncensored model API

Передумови та базовий URL

Наш API працює з будь-яким стандартним клієнтом, сумісним з OpenAI, оновивши базовий URL та API-ключ. Вкажіть свій SDK на https://api.modeluncensored.com/v1 та надсилати запити до стандартного /v1/chat/completions endpoint. Вам не потрібно встановлювати пропрієтарні бібліотеки; існуючі інструменти, такі як офіційні SDK OpenAI для Python або Node.js, працюють миттєво. Просто налаштуйте базовий URL для маршрутизації трафіку через наші сервери замість стандартної інфраструктури OpenAI.

Аутентифікація покладається на один API-ключ, згенерований під час реєстрації. Передайте цей ключ у Authorization header as a Bearer token. The model identifier is fixed at uncensored для забезпечення послідовної поведінки для всіх запитів. Кожен обліковий запис надає один активний ключ, який замінює будь-який попередній ключ після його регенерації.

Автентифікація вашим API-ключем

Включіть свій API-ключ у Authorization header кожного запиту для перевірки вашої ідентичності. Використовуйте формат Authorization: Bearer YOUR_API_KEY для миттєвої автентифікації запитів. Якщо ключ відсутній або недійсний, API негайно повертає помилку 401 Unauthorized. Це гарантує, що токени з вашого передоплаченого рахунку можуть витрачати лише дійсні облікові записи.

Ви можете згенерувати або перегенерувати свій ключ через панель керування після входу за допомогою Google або електронної пошти. Ключ відображається одразу після створення. Зберігайте його в безпеці, оскільки він надає прямий доступ до балансу вашого акаунту. Для реєстрації не потрібна верифікація номером телефону, що робить процес швидким і простим.

Відправка вашого першого Chat Completion

Зробіть POST-запит до /v1/chat/completions з вашими повідомленнями та ідентифікатором моделі для отримання відповіді. Модель приймає текстовий вхід і повертає текстовий вихід без м'яких відмов для законного дорослого контенту. Ви можете вказати ідентифікатор моделі як uncensored щоб забезпечити, що ви використовуєте нашу конкретну uncensored LLM. Ця кінцева точка підтримує як синхронні, так і потокові відповіді для гнучкості.

Запити нараховуються на основі фактичного використання токенів. Помилки та відмови не споживають кредит, тому ви можете тестувати безкоштовно. Максимальний обсяг виводу на запит становить 16 000 токенів або 2 048 токенів, якщо ви не встановите max_tokens параметр. Вікно контексту підтримує до 100,000 токенів для запиту та завершення разом.

Обробка потокових відповідей (SSE)

Увімкніть потокову передачу, встановивши stream: true у запиті для отримання токенів по мірі їх генерації. Це зменшує сприйняту затримку для довгих відповідей і дозволяє відображати текст у реальному часі у вашому додатку. Останній фрагмент потоку містить статистику загального використання токенів для билінгу та моніторингу. Це є суттєвим для створення чат-інтерфейсів, які відчуваються як реактивні та інтерактивні.

Потокова передача відповідей коректно обробляє частковий вміст, дозволяючи відображати текст по мірі його надходження. Це особливо корисно для творчого письма або задач програмування, де модель генерує довгі виводи. Ви можете аналізувати події, надіслані сервером, щоб інкрементно оновлювати ваш інтерфейс. Переконайтеся, що ваш клієнт коректно обробляє подію завершення потоку для фіналізації відповіді.

Налаштування параметрів: Temperature, Top-p та Seed

Налаштувати temperature для контролю випадковості, де вищі значення створюють більш креативні та різноманітні результати. Використовуйте top_p щоб обмежити вибір найімовірнішими токенами, надаючи тонший контроль над розподілом виводу. Встановіть seed ensures deterministic results, що є критично важливим для налагодження або відтворюваних експериментів. Ці параметри дозволяють вам налаштовувати поведінку моделі для конкретних випадків використання, таких як оповідання чи технічне письмо.

Модель підтримує стандартні параметри, такі як stop послідовності та presence_penalty для розширеного контролю. Ви можете поєднувати ці налаштування, щоб досягти бажаного тону та структури. Експериментуйте з різними значеннями, щоб знайти оптимальний баланс між креативністю та зв'язністю для вашого додатка.

Використання Tools та JSON Mode

Увімкнути виклик функцій, надавши tools масив у вашому запиті, щоб модель могла виводити структуровані дані. Модель може викликати функції на основі контексту розмови, що дозволяє реалізувати складні робочі процеси. Використовуйте response_format: {"type": "json_object"} щоб змусити вивід бути у форматі валідного JSON. Це ідеально підходить для інтеграції з бекенд-системами або витягування структурованої інформації з тексту.

Режим JSON гарантує, що відповідь можна парсити, зменшуючи потребу в додатковій логіці парсингу на стороні клієнта. Ви можете визначити кілька інструментів та вказати, який інструмент має викликати модель. Ця функція підвищує корисність моделі для автоматизованих задач та витягування даних. API бездоганно обробляє маршрутизацію викликів інструментів.

cURL

Copycurl https://api.modeluncensored.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current system time in ISO format"}]
  }'

Python

Copyfrom openai import OpenAI

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