Швидкий старт API, сумісного з OpenAI

Передумови та налаштування середовища

Вам потрібен API-ключ і правильна базова URL-адреса, щоб підключити ваш клієнт. Зареєструйтеся через Google або електронну пошту на сторінці Отримати API-ключ, щоб миттєво отримати облікові дані. Пробний період надає вам $0.50 на сім днів, і ви можете поповнити баланс за допомогою USDT або USDC через криптовалюту. Зберігайте ключ у безпеці та переконайтеся, що він відповідає налаштуванням вашого акаунта.

Переконайтеся, що ваше середовище підтримує стандартні HTTP-запити. Наш сервіс працює на одній uncensored моделі, тому вам не потрібно керувати кількома кінцевими точками моделей. Встановіть базовий URL на HTTPS://api.openaiapicompatibility.com/v1 перед виконанням будь-яких викликів. Це забезпечує правильне маршрутизування всіх запитів до наших налаштованих серверів висновку.

Встановлення офіційного SDK OpenAI

Використовуйте офіційні SDK для збереження сумісності з існуючими робочими процесами OpenAI. Бібліотеки Python та Node працюють безпосередньо з нашою кінцевою точкою, оскільки ми дотримуємося стандартної схеми API. Встановіть пакет у каталог вашого проекту за допомогою бажаного менеджера пакетів. Цей підхід унеможливлює необхідність у власному коді HTTP-клієнта.

Ми підтримуємо стандартні параметри temperature, top_p та послідовності зупинки. SDK автоматично обробляє серіалізацію JSON та заголовки запиту. Ви можете змінити базову URL у конфігурації клієнта, щоб вказати на наші сервери. Це дозволяє перемикатися між постачальниками без зміни логіки вашої програми.

Налаштування базового URL та API-ключа

Вкажіть базовий URL та API ключ у об'єкті конфігурації вашого клієнта. Базовий URL — HTTPS://api.openaiapicompatibility.com/v1. Передайте ваш API ключ у заголовку Authorization як Bearer токен. Ця конфігурація гарантує автентифікацію ваших запитів та їх маршрутизацію до правильної служби.

Copycurl https://api.openaiapicompatibility.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all python packages for data science"}]
  }'

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

Зроблення першого запиту на створення діалогу

Надішліть POST-запит до /v1/chat/completions із повідомленнями вашого промпту. Визначте модель як uncensored для доступу до невідфільтрованого інженеру висновків. Включіть свій системний промпт для встановлення поведінки та додайте повідомлення користувача для контенту, який потрібно згенерувати.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.openaiapicompatibility.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, щоб контролювати креативність. Модель не відмовляється від законних дорослих або суперечливих тем, що робить її придатною для різноманітних випадків використання. Перевірте об'єкт відповіді на наявність поля content для доступу до виводу.

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

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

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)

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

Режим JSON та виклик функцій

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

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

Node.js

Copyimport OpenAI from "openai";

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