Посібник швидкого старту API необмеженого ШІ

Аутентифікація та базовий URL

Почніть із вказівки вашого SDK на нашу базову URL-адресу та передачі ключа в заголовку авторизації. Ми надаємо прямий сервіс з однією моделлю без комісій за маршрутизацію через проксі. Використовуйте стандартні Authorization: Bearer схему для автентифікації запитів. Ваш ключ генерується миттєво після реєстрації через Google або електронну пошту. Переконайтеся, що ви замінили ключ-заповнювач у конфігурації вашого клієнта на той, що відображається на панелі керування. Базовий URL це https://api.uncensoredmodelsollama.com/v1. Цей ендпоінт підтримує стандартних клієнтів, сумісних з OpenAI, дозволяючи змінювати постачальників без переписування логіки вашої програми. Зберігайте свій ключ у безпеці, оскільки він надає доступ до балансу вашої передоплаченої кредитної лінії.

Ендпоінт Chat Completions

Надсилайте текстові запити до /v1/chat/completions ендпоінт для генерації відповідей. Цей ендпоінт обробляє стандартні історії розмов та системні підказки. Ви повинні вказати ідентифікатор моделі як uncensored у тілі запиту. API повертає відповіді у форматі JSON, що містять згенерований текст та статистику використання токенів. Помилки, такі як недостатній кредит або недійсний ключ, повертаються з відповідними кодами стану HTTP. Використовуйте цей ендпоінт для всіх стандартних задач генерації тексту. Він не підтримує ембеддинги, зображення або донавчання. Тримайте ваше тіло запиту менше 8 МБ для забезпечення надійної обробки. Модель обробляє вхідні та вихідні токени в спільному контекстному вікні.

Потокові відповіді

Увімкніть потокову передачу, встановивши stream параметр на true у вашому запиті. API повертає події, надіслані сервером (SSE), що містять інкрементні фрагменти тексту. Цей підхід зменшує сприйняту затримку для користувачів, які чекають на довгі виводи. Ви отримуєте інформацію про використання токенів у останньому фрагменті потоку. Реалізуйте обробник потоку у вашому клієнті для ефектної обробки цих подій. Потокова передача ідеально підходить для чат-інтерфейсів та додатків реального часу. Переконайтеся, що ваша бібліотека клієнта підтримує парсинг SSE для правильної обробки безперервного потоку даних. Загальне вікно контексту залишається 100,000 токенів незалежно від режиму потокової передаки.

Function Calling та режим JSON

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

Parameters and Rate Limits

Налаштуйте поведінку генерації за допомогою таких параметрів, як temperature, top_p, а також seed. Встановіть max_tokens щоб обмежити довжину виводу, за замовчуванням 2 048, якщо не вказано інакше. API встановлює ліміт швидкості 300 запитів на хвилину на ключ. Одночасні запити обмежені 8 на ключ. Якщо ви перевищите ці ліміти, API повертає статус-код 429. Запити нараховуються на основі фактичного використання токенів, а помилки та відмови є безкоштовними. Кредит не має терміну дії, а попередньо оплачені суми є прозорими. Управляйте своїми ключами обережно, оскільки кожен обліковий запис підтримує лише один активний ключ одночасно.

Ліміти, помилки та контекст

Контекстне вікно підтримує 100,000 токенів для сумісного вводу та виводу. Запити, які перевищують ліміт тіла в 8 МБ, будуть відхилені. Поширені помилки включають 401 для недійсних ключів та 402 для недостатнього балансу. Обробляйте ці помилки коректно в логіці вашого додатка. API відхиляє запити, що містять сексуальний контент із залученням неповнолітніх, незалежно від інших налаштувань. Інший контент залишається без цензури для законного використання дорослими. Відстежуйте використання токенів, щоб уникнути несподіваних витрат. Система передоплати гарантує, що ви платите лише за те, що використовуєте. Немає абонентської плати чи прихованих витрат для вашої інтеграції.

cURL

Copycurl https://api.uncensoredmodelsollama.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List all available models in the ollama library."}]
  }'

Python

Copyfrom openai import OpenAI

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