Mini cpm API documentation

احراز هویت و URL پایه

هر درخواست را با کلید API و URL پایه صحیح خود شروع کنید. ما از هدرهای استاندارد OpenAI برای سازگاری استفاده می‌کنیم. کلید شما بلافاصله دسترسی به مدل بدون سانسور را فراهم می‌کند. URL پایه HTTPS://api.cpmmini.com/v1 است. از هدر Authorization: Bearer استفاده کنید. کلید خود را امن نگه دارید. این حساب اعتبار از پیش پرداخت شده شما را شناسایی می‌کند. هیچ هزینه اشتراکی در اینجا وجود ندارد. فقط به ازای هر توکن استفاده شده پرداخت کنید.

اولین درخواست

ارسان اولین پیام به endpoint تکمیل چت. این تأیید می‌کند که کلید شما کار می‌کند و اعتبارات به‌درستی کسر می‌شوند. مدل uncensored بدون ردشدگی‌های معمول پاسخ می‌دهد. از curl برای یک آزمایش سریع استفاده کنید. YOUR_API_KEY را با کلید واقعی خود از داشبورد جایگزین کنید. این مرحله اتصال و تأخیر را تأیید می‌کند. خطاهایی مانند 401 نشان‌دهنده کلید نامعتبر است. اگر شکست خورد، داشبورد حساب کاربری خود را بررسی کنید. پاسخ شامل متن تولید شده برمی‌گردد.

یکپارچه‌سازی SDK Python

از کتابخانه رسمی پایتون OpenAI برای دسترسی برنامه‌نویسی استفاده کنید. URL پایه را به نقطه پایانی ما تنظیم کنید. این تضمین می‌کند که همه درخواست‌ها به مدل بدون سانسور ما هدایت شوند. کتابخانه را از طریق pip نصب کنید. کلید API خود را در راه‌اندازی کلاینت وارد کنید. مدل uncensored را درخواست دهید. SDK تلاش‌های مجدد و تجزیه JSON را مدیریت می‌کند. این روش یکپارچه‌سازی را در ربات‌های موجود شما ساده می‌کند. این روش با حلقه‌های async نیز کار می‌کند. پس از درخواست، موجودی اعتبار خود را بررسی کنید.

راه‌اندازی Node SDK

با Node.js با استفاده از پکیج npm ادغام کنید. URL پایه را به سمت API ما پیکربندی کنید. این سازگاری با استانداردهای OpenAI را حفظ می‌کند. وابستگی را در پروژه خود نصب کنید. کلاینت را با کلید خود مقداردهی اولیه کنید. متد تکمیل چت را فراخوانی کنید. شیء پاسخ شامل متن تولید شده است. خطاها را به صورت ایمن در برنامه خود مدیریت کنید. این پیکربندی از ماژول‌های CommonJS و ES پشتیبانی می‌کند. این برای ربات‌های چت سمت سرور ایده‌آل است.

پاسخ‌های استریم

توکن‌ها را برای تجربه‌های کاربری بلادرنگ پخش کنید. پخش را در پارامترهای درخواست خود فعال کنید. API قطعات را همان‌طور که تولید می‌شوند می‌فرستد. این کار تأخیر ادراک‌شده را برای کاربران کاهش می‌دهد. از endpoint SSE برای داده‌های پیوسته استفاده کنید. هر قطعه را تجزیه کنید تا پیام نهایی را بسازید. این ویژگی با هر دو SDKهای Python و Node کار می‌کند. این ویژگی برای رابط‌های چت ضروری است. مصرف توکن را در قطعه نهایی مانیتور کنید. اعتبار شما بر اساس مجموع توکن‌های ارسالی کسر می‌شود.

محدودیت‌ها، خطاها و زمینه

به محدودیت‌های نرخ و وضعیت اعتبار خود توجه کنید. شما 300 درخواست در دقیقه دریافت می‌کنید. فقط 8 درخواست همزمان به ازای هر کلید مجاز است. خطای 429 به معنای رسیدن به محدودیت است. خطای 402 نشان می‌دهد که اعتبار کافی ندارید. با ارز دیجیتال شارژ کنید تا ادامه دهید. پنجره متن از 100,000 توکن پشتیبانی می‌کند. این اجازه می‌دهد مکالمات طولانی بدون از دست دادن تاریخچه انجام شود. خطاها و رد شدن‌ها اعتبار مصرف نمی‌کنند. اعتبار پیش‌پرداخت شما هرگز منقضی نمی‌شود. کلیدهای خود را در داشبورد مدیریت کنید.

cURL

Copycurl https://api.cpmmini.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send test message"}]
  }'

پایتون

Copyfrom openai import OpenAI

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