Швидкий старт інтеграції API Character

Встановіть SDK

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

Для Python використовуйте pip. Для Node.js використовуйте npm. Цей крок займає кілька секунд і налаштовує середовище для наступних прикладів коду.

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

Направте клієнт SDK на наш ендпоінт для доступу до необмеженої моделі. Базова URL-адреса — HTTPS://api.apicharacter.com/v1. Вона замінює стандартний URL OpenAI у вашій конфігурації.

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

Встановити свій API ключ

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

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

Зробіть свій перший запит

Надішліть простий запит на отримання відповіді чату, щоб перевірити з’єднання. Ідентифікатор моделі — "uncensored". Це підтверджує, що ваша автентифікація та базовий URL коректні, перш ніж ви почнете розробку додатка.

Дивіться приклад нижче для стандартного запиту cURL.

Copycurl https://api.apicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "set my name to Alex"}]
  }'

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

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

Це критично важливо для реактивного користувацького досвіду. Ви обробляєте часткові фрагменти по мірі їх надходження через Server-Sent Events.

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)

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

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

Ліміт становить 300 запитів на хвилину. Помилка 401 означає недійсний ключ. 402 — нульовий баланс. 429 — перевищено ліміт швидкості. Враховуйте це при масштабуванні продукції.

Python

Copyfrom openai import OpenAI

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