Документація Mistral api: Посібник швидкого старту

Встановіть SDK і встановіть свій базовий URL

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

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

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

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

Copycurl https://api.mistralapidoc.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 and their context windows"}]
  }'

Тіло запиту містить ваш масив повідомлень та необов'язкові параметри. Наш API коректно ігнорує додаткові поля. Якщо ви надсилаєте простий запит, ви отримуєте пряме завершення. Використовуйте це, щоб переконатися, що ваша інтеграція працює, перш ніж додавати складну логіку. Модель ефективно обробляє контекст до 100,000 токенів.

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

Встановіть 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)

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

Використовуйте виклик функцій та режим JSON

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

Copyimport OpenAI from "openai";

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

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

Налаштуйте параметри: temperature, top_p та seed

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

Copyfrom openai import OpenAI

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

Встановіть presence_penalty та frequency_penalty, щоб зменшити повторення. Модель підтримує всі стандартні параметри OpenAI. Ви можете передати послідовність stop, щоб зупинити генерацію на певних маркерах. Ці параметри допомагають отримати саме той формат виводу, який вам потрібен. Експериментуйте з різними комбінаціями, щоб знайти оптимальні налаштування для вашого випадку використання.

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

Наш API підтримує контекстне вікно на 100,000 токенів. Максимальний обсяг відповіді на запит становить 16,000 токенів або 2,048, якщо ви не вказали max_tokens. Ліміт становить 300 запитів на хвилину та 8 одночасних запитів на ключ. Тіло запиту має бути меншим за 8 МБ. Ці обмеження забезпечують справедливий доступ для всіх передплатників.

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