Документація API

Швидкий старт першого запиту

Почніть генерувати текст миттєво, звернувши клієнт до нашого базового URL і пройшовши аутентифікацію згенерованим API-ключем. Інтерфейс відповідає стандартним стандартам, тому ви можете використовувати існуючі SDK без вивчення нового протоколу. Ви надсилатимете запити до uncensored model та отримуйте текстові відповіді, які не застосовують типові фільтри контенту для законного використання дорослими.

Налаштуйте базовий URL та ключ

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

• Базовий URL: https://api.nsfwlocalllm.com/v1
• Заголовок Auth: Authorization: Bearer YOUR_API_KEY

Ви можете перевірити, чи працює ваш ключ, перевіривши ендпоінт моделей. Дійсний ключ негайно повертає доступний ID моделі.

Надішліть запит на chat completion

Надішліть стандартний запит chat completion для генерації тексту. Система обробляє ваш вхід і повертає відповідь моделі. Використовуйте uncensored model ID для забезпечення того, що ви звертаєтесь до необмеженого екземпляра.

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

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

Перевірте наявність стандартних кодів стану HTTP для обробки випадків успіху або невдачі.

Увімкніть потокову передачу для виводу в реальному часі

Потокова передача відповідей для зменшення сприйнятої затримки для ваших користувачів. Увімкніть потокову передачу, встановивши stream: true у тілі вашого запиту. API повертає серію подій, надісланих сервером (SSE), що містять часткові токени.

Агрегуйте ці токени на стороні клієнта, щоб відновити повне повідомлення. Цей підхід ідеально підходить для чат-інтерфейсів, де важливий миттєвий зворотний зв’язок. Остання подія SSE містить загальну кількість використаних токенів для запиту.

Copyfrom openai import OpenAI

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

Гарно обробляйте помилки з’єднання, щоб забезпечити плавний користувацький досвід.

Використовуйте режим JSON для структурованих даних

Змушуйте модель виводити валідний JSON для програмного споживання. Встановіть response_format до {"type": "json_object"} у вашому запиті. Це знижує помилки парсингу та забезпечує послідовні структури даних.

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

Copyimport OpenAI from "openai";

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

Перевіряйте вихідні дані JSON на своєму боці, щоб виявити будь-які граничні випадки.

Реалізуйте виклик функцій

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

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

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

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)