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

Швидкий старт: Ваш перший запит

Надішліть своє перше повідомлення uncensored-моделі одразу. Використовуйте стандартний ендпоінт chat-completions для генерації тексту. Модель відповідає на природномовні промпти без відмов у вмісті для законного дорослого використання. Ця конфігурація працює з будь-яким OpenAI-сумісним клієнтом.

Почніть із встановлення SDK для бажаної мови. Потім налаштуйте свій API-ключ. Наступний приклад показує базовий запит curl для перевірки підключення.

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

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

Базова URL-адреса та аутентифікація

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

Згенеруйте свій ключ через панель керування. Передайте його в заголовку Authorization як Bearer-токен. Цей метод сумісний зі стандартними SDK OpenAI. Ви можете змінити постачальника, змінивши лише базовий URL-адресу та ключ.

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

Точки доступу: Chat Completions

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

Відправте POST-запит до маршруту chat. Вкажіть системні та пользовательські повідомлення в тілі запиту. Модель обробляє контекст і генерує відповідь. Ви можете використовувати режим JSON для структурованого виводу.

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

Copyfrom openai import OpenAI

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

Параметри: Temperature, Top P та Stop

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

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

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

Copyimport OpenAI from "openai";

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

Потокова передача та використання токенів

Отримуйте відповіді в реальному часі, використовуючи server-sent events. Потокова передача зменшує сприйняту затримку для користувачів. 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)

Ліміти частоти та обмеження

Розуміння лімітів, щоб уникнути переривання служби. Ви можете надсилати 300 запитів на хвилину на ключ. Паралельні запити обмежені вісьмома одночасно. Тіло запиту не повинно перевищувати 8 МБ.

Коректно обробляйте помилки. Статус 401 означає, що ваш ключ недійсний. Статус 402 вказує на недостатній баланс. Статус 429 сигналізує про перевищення ліміту швидкості.

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